@noirstack/cascades-sdk (npm)

Scoped noirstack package on the public npm registry. This tarball ships the mirrored HTTP contract (contracts/api.yaml) plus LICENSE and a small ESM entry for path resolution — aligned with the cascades-sdk Python package on PyPI.

The platform source of truth is no1rstack/cascades → contracts/api.yaml. Sync the mirror in this repo before cutting a release (see the repo root README.md / RELEASE.md).

Bump version in this directory’s package.json for each npm release (npm does not allow re-publishing the same version). Prefer npm version patch|minor|major from packages/cascades-sdk (see RELEASE.md).

Entry points

ESM consumers:

import { apiYamlPath, packageRoot } from "@noirstack/cascades-sdk";
// apiYamlPath → absolute path to bundled contracts/api.yaml

Subpath @noirstack/cascades-sdk/api.yaml is declared in exports for tools that resolve the YAML path (behavior depends on your bundler / Node version — when in doubt, use apiYamlPath and fs.readFile).

The published tarball only includes paths listed in package.json → files (plus package.json itself). npm run build copies contracts/api.yaml and LICENSE from the repo root; prepack and prepublishOnly run build so npm pack and npm publish never ship stale or extra source files.

Pack from repo root

After npm install at the SDK repo root:

npm run pack:npm -- --dry-run
# equivalent: npm pack -w @noirstack/cascades-sdk --dry-run

Bare npm pack at the repo root will not work — the root package.json is private and only wires workspaces.

Publish

Maintainers: RELEASE.md (npm section). Local:

.\scripts\publish_npm.ps1

Requires npm login (or NPM_TOKEN) with permission to publish @noirstack/cascades-sdk (publishConfig.access is public).

After the first successful publish, confirm org visibility and team access, for example:

npm access ls-packages noirstack

Then in the npm UI, ensure @noirstack/cascades-sdk appears under the noirstack org and grant the developers team read/write as needed.