pulumi/sdk/nodejs
Zaid Ajaj aa9ca8a4ed
[sdk/nodejs] Maintain secretness and input dependencies of output invokes (#17479)
### Description 

Addresses the nodejs part of #17474, it does the following
 - Keeping track of secretness of inputs
- Unwraps the inputs such that they are sent as plain values to the
engine
 - Marks the invoke result as secret if any of the inputs is a secret
- Marks the dependencies of the output invoke response being the list of
all dependencies of the inputs
- Enables conformance tests `l2-invoke-secrets` and
`l2-invoke-dependencies`
 - Adds unit tests for newly added function `unwrapSecretValues`
2024-10-05 00:40:19 +00:00
..
asset Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
automation [nodejs] cancelation support for auto api (#16783) 2024-09-17 13:23:58 +00:00
cmd [sdk/nodejs] Maintain secretness and input dependencies of output invokes (#17479) 2024-10-05 00:40:19 +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 Fix dependency installation for nodejs projects with a main property (#17391) 2024-09-26 15:22:28 +00:00
proto change name of InvalidInputPropertiesError to InputPropertiesError (#17412) 2024-09-30 08:19:40 +00:00
provider allow better grpc error messages from NodeJS component providers (#17325) 2024-10-03 10:06:37 +00:00
queryable Improve TypeDocs for `sdk/nodejs` (#16622) 2024-07-15 09:05:28 +00:00
runtime [sdk/nodejs] Maintain secretness and input dependencies of output invokes (#17479) 2024-10-05 00:40:19 +00:00
tests [sdk/nodejs] Maintain secretness and input dependencies of output invokes (#17479) 2024-10-05 00:40:19 +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 allow better grpc error messages from NodeJS component providers (#17325) 2024-10-03 10:06:37 +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 [sdk/nodejs] Short-circuit output invokes if inputs contains unknowns (#17353) 2024-09-25 20:03:13 +00:00
package.json Freeze v3.135.1 (#17469) 2024-10-04 04:45:56 +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 [sdk/nodejs] Maintain secretness and input dependencies of output invokes (#17479) 2024-10-05 00:40:19 +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.135.1 (#17469) 2024-10-04 04:45:56 +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.