pulumi/sdk/nodejs
Justin Van Patten 5b3d00d313
Prepare for v3.127.0 release (#16788)
We did a release earlier this week, but have some additional
improvements we could get out, including improvements to the `pulumi
state move` command that would be nice to release ahead of blogging
about it.

Aiming to release early Thursday and then publish the blog after.

Tentative changelog:

### Features

- [cli/new] Make prompt capitalization consistent
  [#16747](https://github.com/pulumi/pulumi/pull/16747)

- [auto/nodejs] Implement Stack.import() in automation API to specify
and import resources into a stack
  [#16615](https://github.com/pulumi/pulumi/pull/16615)

- [auto/python] Implement Stack.import_resources() for batch importing
resources into a stack
  [#16668](https://github.com/pulumi/pulumi/pull/16668)

- [sdk/python] Provide stricter types for config.get_XXX when a default
is provided
  [#16768](https://github.com/pulumi/pulumi/pull/16768)

- [sdkgen/python] Generate TypedDict input types by default
  [#16704](https://github.com/pulumi/pulumi/pull/16704)


### Bug Fixes

- [cli/state] Always show the fully qualified stack name when moving
resources
  [#16767](https://github.com/pulumi/pulumi/pull/16767)

- [cli/state] Fix calculation of the resources that are remaining in the
source stack
  [#16774](https://github.com/pulumi/pulumi/pull/16774)

- [cli/state] Fix the dependency information in the state move command
  [#16765](https://github.com/pulumi/pulumi/pull/16765)

- [cli/state] Improve how moving the root stack is handled in `pulumi
state move`
  [#16779](https://github.com/pulumi/pulumi/pull/16779)

- [sdk/nodejs] Detect possible OOM errors when nodejs crashes
  [#16700](https://github.com/pulumi/pulumi/pull/16700)

- [sdk/nodejs] Ensure no output is lost for nodejs commands when stdout
is slow
  [#16700](https://github.com/pulumi/pulumi/pull/16700)
2024-07-25 15:01:15 +00:00
..
asset Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
automation [autmation/nodejs] Implement Stack.import() to specify and import resources into a stack (#16615) 2024-07-24 14:58:12 +00:00
cmd [cli/import] Fix undefined variable errors in code generation when imported resources use a parent or provider (#16786) 2024-07-25 13:53:44 +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 Display an actionable error message when dependency installation fails (#16489) 2024-06-28 23:22:17 +00:00
proto [cli/import] Fix undefined variable errors in code generation when imported resources use a parent or provider (#16786) 2024-07-25 13:53:44 +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 implement invoke transforms for NodeJS (#16688) 2024-07-18 08:41:39 +00:00
tests [autmation/nodejs] Implement Stack.import() to specify and import resources into a stack (#16615) 2024-07-24 14:58:12 +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 Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
package.json Prepare for v3.127.0 release (#16788) 2024-07-25 15:01:15 +00:00
resource.ts implement invoke transforms for NodeJS (#16688) 2024-07-18 08:41:39 +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.127.0 release (#16788) 2024-07-25 15:01:15 +00:00
yarn.lock Bump @opentelemetry packages in NodeJS SDK (#16558) 2024-07-08 09:10:53 +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.