pulumi/sdk/nodejs
Justin Van Patten ecbbacf3be
Freeze v3.145.0 (#18143)
This PR is stacked on top of https://github.com/pulumi/pulumi/pull/18142

---

Tentative changelog:

## 3.145.0 (2025-01-06)


### Features

- [auto/go] Support --clear-pending-creates for refresh command in Go
Automation API for preview refresh and refresh operations.
  [#18101](https://github.com/pulumi/pulumi/pull/18101)

- [programgen/{java,sdkgen/java}] Only use gRPC to communicate with the
Java host
  [#18138](https://github.com/pulumi/pulumi/pull/18138)

- [cli/package] Support bridging to terraform providers automatically in
pulumi convert
  [#17992](https://github.com/pulumi/pulumi/pull/17992)

- [sdk/go] Implement deferred output for the Go SDK and program-gen
  [#17885](https://github.com/pulumi/pulumi/pull/17885)


### Bug Fixes

- [cli] Fix TestPackageAddGoParameterized to utilize version path
  [#18150](https://github.com/pulumi/pulumi/pull/18150)

- [cli/engine] Clarify the usage string for the --expect-no-changes flag
  [#18105](https://github.com/pulumi/pulumi/pull/18105)

- [auto/go] Return error if no inline program specified
  [#18086](https://github.com/pulumi/pulumi/pull/18086)

- [auto/go] Interrupt programs gracefully when the context is canceled
  [#18124](https://github.com/pulumi/pulumi/pull/18124)

- [cli/new] Provide a better error message when pulumi new --ai
generates a program with errors
  [#18091](https://github.com/pulumi/pulumi/pull/18091)

- [cli/new] Provide a more meaningful message for the --language flag
  [#18092](https://github.com/pulumi/pulumi/pull/18092)

- [engine] Enable `pulumi:pulumi:getResource` to hydrate `Read`
resources
  [#18070](https://github.com/pulumi/pulumi/pull/18070)

- [programgen] Allow for case-insensitive terraform convert source
  [#18111](https://github.com/pulumi/pulumi/pull/18111)

- [programgen/go] Fix importing module names in Go programs that aren't
lower-case
  [#18113](https://github.com/pulumi/pulumi/pull/18113)

- [sdk/go] Fix panic when diffing computed property values
  [#18104](https://github.com/pulumi/pulumi/pull/18104)

- [sdk/go] Avoid calling invokes with dependencies on unknown resources
  [#18133](https://github.com/pulumi/pulumi/pull/18133)

- [sdk/nodejs] Fix source maps when using jest
  [#18108](https://github.com/pulumi/pulumi/pull/18108)

- [sdk/python] Fix reading pulumi-plugin.json when using the uv
toolchain
  [#18107](https://github.com/pulumi/pulumi/pull/18107)

- [sdk/python] Fix ListPackages when using uv
  [#18121](https://github.com/pulumi/pulumi/pull/18121)

- [sdk/python] Fix dynamic providers when using Poetry or uv
  [#18126](https://github.com/pulumi/pulumi/pull/18126)

- [sdk/python] Fix prerelease version
  [#18125](https://github.com/pulumi/pulumi/pull/18125)

- [sdk/python] Avoid calling invokes with dependencies on unknown
resources
  [#18141](https://github.com/pulumi/pulumi/pull/18141)


### Miscellaneous

- [programgen/java] Bump Java SDK dependency version so that `package
gen-sdk` emits buildable code
  [#18130](https://github.com/pulumi/pulumi/pull/18130)

- [sdk/python] Switch to pyproject.toml + uv
  [#18081](https://github.com/pulumi/pulumi/pull/18081)

- [sdk/python] Move mypy configuration into pyproject.toml
  [#18118](https://github.com/pulumi/pulumi/pull/18118)

- [sdk/python] Move pyright configuration into pyproject.toml
  [#18116](https://github.com/pulumi/pulumi/pull/18116)

- [sdk/python] Move ruff configuration into pyproject.toml
  [#18117](https://github.com/pulumi/pulumi/pull/18117)
2025-01-07 13:03:36 +00:00
..
asset Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
automation Fixed a bug where token information was not present in types (#17735) 2024-12-01 07:39:51 +00:00
cmd Add a conformance test for component-hydrated resource references (#18153) 2025-01-06 13:40:53 +00:00
dist Fix typo in PP script 2019-08-06 17:35:52 -07:00
dynamic Allow accessing configuration in Node.js dynamic providers (#17697) 2024-11-07 14:34:11 +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 Fix pnpm pack for pnpm@9.13 (#17766) 2024-11-13 15:56:22 +00:00
proto Document provider Diff response requirements (#18032) 2024-12-16 11:10:28 +00:00
provider Fix source maps when using jest (#18108) 2024-12-24 10:25:28 +00:00
queryable Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
runtime Avoid calling invokes with dependencies on unknown resources (#18152) 2025-01-07 09:55:27 +00:00
tests Avoid calling invokes with dependencies on unknown resources (#18152) 2025-01-07 09:55:27 +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
.npmignore Exclude tests from the nodejs npm package (#17488) 2024-10-07 08:31:28 +00:00
Makefile add lint_fix Makefile targets (#17767) 2024-11-15 09:58:20 +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 allow better grpc error messages from NodeJS component providers (#17325) 2024-10-03 10:06:37 +00:00
index.ts Fix source maps when using jest (#18108) 2024-12-24 10:25:28 +00:00
invoke.ts [Node.js] Allow specifiying dependencies for output invokes (#17632) 2024-11-20 16:03:11 +00:00
metadata.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
output.ts [sdk/nodejs] Throw from output() on circular structures (#17852) 2024-11-27 18:40:29 +00:00
package.json Freeze v3.145.0 (#18143) 2025-01-07 13:03:36 +00:00
resource.ts Try and avoid serializing `runtime/resource.js` (#17247) 2024-09-12 16:27:53 +00:00
stackReference.ts Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
tsconfig.json Gracefully handle errors that don't implement toString (#18080) 2024-12-20 14:29:09 +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 Freeze v3.145.0 (#18143) 2025-01-07 13:03:36 +00:00
yarn.lock Upgrade opentelemetry packages (#17922) 2024-12-04 17:34:42 +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.