pulumi/sdk/nodejs
Justin Van Patten 81847fedf3
Prepare for v3.132.0 release (#17233)
Tentative changelog:

### Features

- [cli/state] Show the full set of delete commands necessary to remove
resources from the source stack, if writing to it fails
  [#17205](https://github.com/pulumi/pulumi/pull/17205)

- [cli/state] Try to revert changes to destination stack if we are
unable to save the source stack in state move
  [#17208](https://github.com/pulumi/pulumi/pull/17208)

- [engine] Send resource names and types in provider requests from the
engine, in addition to the combined URN
  [#17177](https://github.com/pulumi/pulumi/pull/17177)

- [pkg] Add support for ESC Projects

- [sdkgen/go] Allow output-versioned invokes to resolve and maintain
secrets
  [#17132](https://github.com/pulumi/pulumi/pull/17132)


### Bug Fixes

- [cli] Recover from zero-byte `credentials.json` files
  [#17186](https://github.com/pulumi/pulumi/pull/17186)

- [cli] Using PULUMI_BACKEND_URL no longer updates credentials.json
  [#17199](https://github.com/pulumi/pulumi/pull/17199)

- [engine] Fix parameterized providers not downloading correctly when
found from state
  [#17218](https://github.com/pulumi/pulumi/pull/17218)

- [cli/about] Fix language plugins always having unknown version in
about
  [#17216](https://github.com/pulumi/pulumi/pull/17216)

- [cli/display] Fix deletes not being show in `refresh` when using json
output
  [#16851](https://github.com/pulumi/pulumi/pull/16851)

- [cli/display] Hide unnecessary rows in non-interactive mode
  [#17188](https://github.com/pulumi/pulumi/pull/17188)

- [sdkgen/python] Correctly case Python package names in `package add`
link instructions
  [#17178](https://github.com/pulumi/pulumi/pull/17178)
2024-09-11 07:30:05 +00:00
..
asset Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
automation add the attach-debugger flag to automation API (#17175) 2024-09-05 11:19:01 +00:00
cmd Merge ESC Projects feature branch (#17226) 2024-09-10 23:08:09 +00:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
iterable Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
log Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
npm Enable goheader rule and add missing license headers (#15473) 2024-09-09 12:05:45 +00:00
proto Send resource name and type as well as URN to providers (#17177) 2024-09-06 09:29:37 +00:00
provider Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
queryable Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
runtime Pass through pluginDownloadURL in invokes (#16917) 2024-08-09 14:43:48 +00:00
tests Use @types/node matching the ts version for integration tests (#17185) 2024-09-06 09:21:47 +00:00
tests_with_mocks Fix NodeJS SDK mocking of custom resource reads (#16542) 2024-07-01 16:05:30 +00:00
types Replace deprecated read-package-tree with @npmcli/arborist (#15503) 2024-02-26 18:40:28 +00:00
vendor Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
.eslintrc.js Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
.gitignore Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
Makefile Replace Rome with Biome in the NodeJS SDK (#16456) 2024-06-24 11:14:56 +00:00
README.md fix some links 2023-05-19 19:39:26 -07:00
biome.json Replace Rome with Biome in the NodeJS SDK (#16456) 2024-06-24 11:14:56 +00:00
config.ts Replace Rome with Biome in the NodeJS SDK (#16456) 2024-06-24 11:14:56 +00:00
errors.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
index.ts Removing x namespace from go/python/nodejs automation packages (#6518) 2021-04-14 19:32:18 +01:00
invoke.ts implement invoke transforms for NodeJS (#16688) 2024-07-18 08:41:39 +00:00
metadata.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
output.ts Updated nodejs and python sdk docs on outputs (#16885) 2024-09-09 08:11:25 +00:00
package.json Prepare for v3.132.0 release (#17233) 2024-09-11 07:30:05 +00:00
resource.ts Add parameterization support for read in nodejs (#16913) 2024-08-09 11:55:13 +00:00
stackReference.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
tsconfig.json Revert "Implement `dependsOn` for invokes in the NodeJS SDK (#16560)" (#16642) 2024-07-12 10:16:55 +00:00
tsutils.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
typescript-shim.ts Vendor TypeScript and ts-node (#15622) 2024-04-10 15:26:37 +00:00
utils.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
version.ts Prepare for v3.132.0 release (#17233) 2024-09-11 07:30:05 +00:00
yarn.lock Bump NodeJS SDK dependencies (#17214) 2024-09-10 09:23:20 +00:00

README.md

Pulumi Node.js SDK

The Pulumi Node.js SDK lets you write cloud programs in JavaScript.

Installation

Using npm:

$ npm install --save @pulumi/pulumi

Using yarn:

$ yarn add @pulumi/pulumi

This SDK is meant for use with the Pulumi CLI. Visit Pulumi's Download & Install to install the CLI.

Building and Testing

For anybody who wants to build from source, here is how you do it.

Prerequisites

This SDK uses Node.js and we support any of the Current, Active and Maintenance LTS versions. We support both NPM and Yarn for package management.

At the moment, we only support building on macOS and Linux, where standard GNU tools like make are available.

Make Targets

To build the SDK, simply run make from the root directory (where this README lives, at sdk/nodejs/ from the repo's root). This will build the code, run tests, and install the package and its supporting artifacts.

At the moment, for local development, we install everything into $HOME/.dev-pulumi. You will want this on your $PATH.

The tests will verify that everything works, but feel free to try running pulumi preview and/or pulumi up from the examples/minimal/ directory. Remember to run tsc first, since pulumi expects JavaScript, not TypeScript.