Merge pull request #8 from sfcompute/release-please--branches--main--changes--next--components--nodes-sdk-alpha

Author: sigmachirality

.github/workflows/publish-npm.yml

@@ -0,0 +1,32 @@
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to NPM in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/sfcompute/nodes-typescript/actions/workflows/publish-npm.yml
+name: Publish NPM
+on:
+  workflow_dispatch:
+
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20'
+
+      - name: Install dependencies
+        run: |
+          yarn install
+
+      - name: Publish to NPM
+        run: |
+          bash ./bin/publish-npm
+        env:
+          NPM_TOKEN: ${{ secrets.SFC_NODES_NPM_TOKEN || secrets.NPM_TOKEN }}

.github/workflows/release-doctor.yml

@@ -18,3 +18,4 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
+          NPM_TOKEN: ${{ secrets.SFC_NODES_NPM_TOKEN || secrets.NPM_TOKEN }}

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.1"
+  ".": "0.1.0-alpha.2"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 8
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/the-san-francisco-compute-company%2Fsfc-nodes-b800806859333bacc88fa4236eae35c8cdbec62970b7fb9ad440a330f24a1622.yml
 openapi_spec_hash: fa672b6ca8953a8059961a7559a607a9
-config_hash: e089259785c0c81187a2b25ae04b8459
+config_hash: e310f0f1f4275f17d4a3872005f33a90

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.2 (2025-07-22)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/sfcompute/nodes-typescript/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### Chores
+
+* update SDK settings ([8db0e2d](https://github.com/sfcompute/nodes-typescript/commit/8db0e2dbb16e522c0e6e8970b5e2f1ddf5ee7f6f))
+
 ## 0.1.0-alpha.1 (2025-07-17)
 
 Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/sfcompute/nodes-typescript/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)

CONTRIBUTING.md

@@ -55,12 +55,12 @@ $ cd nodes-typescript
 # With yarn
 $ yarn link
 $ cd ../my-package
-$ yarn link sfc-nodes
+$ yarn link @sfc/nodes-sdk-alpha
 
 # With pnpm
 $ pnpm link --global
 $ cd ../my-package
-$ pnpm link -—global sfc-nodes
+$ pnpm link -—global @sfc/nodes-sdk-alpha
 ```
 
 ## Running tests
@@ -91,3 +91,17 @@ To format and fix all lint issues automatically:
 ```sh
 $ yarn fix
 ```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/sfcompute/nodes-typescript/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+the environment.

README.md

@@ -1,6 +1,6 @@
 # SFC Nodes TypeScript API Library
 
-[![NPM version](<https://img.shields.io/npm/v/sfc-nodes.svg?label=npm%20(stable)>)](https://npmjs.org/package/sfc-nodes) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/sfc-nodes)
+[![NPM version](<https://img.shields.io/npm/v/@sfc/nodes-sdk-alpha.svg?label=npm%20(stable)>)](https://npmjs.org/package/@sfc/nodes-sdk-alpha) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@sfc/nodes-sdk-alpha)
 
 This library provides convenient access to the SFC Nodes REST API from server-side TypeScript or JavaScript.
 
@@ -11,19 +11,16 @@ It is generated with [Stainless](https://www.stainless.com/).
 ## Installation
 
 ```sh
-npm install git+ssh://[email protected]:sfcompute/nodes-typescript.git
+npm install @sfc/nodes-sdk-alpha
 ```
 
-> [!NOTE]
-> Once this package is [published to npm](https://www.stainless.com/docs/guides/publish), this will become: `npm install sfc-nodes`
-
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
-import SFCNodes from 'sfc-nodes';
+import SFCNodes from '@sfc/nodes-sdk-alpha';
 
 const client = new SFCNodes({
   apiKey: process.env['SFC_API_KEY'], // This is the default and can be omitted
@@ -38,7 +35,7 @@ This library includes TypeScript definitions for all request params and response
 
 <!-- prettier-ignore -->
 ```ts
-import SFCNodes from 'sfc-nodes';
+import SFCNodes from '@sfc/nodes-sdk-alpha';
 
 const client = new SFCNodes({
   apiKey: process.env['SFC_API_KEY'], // This is the default and can be omitted
@@ -160,7 +157,7 @@ The log level can be configured in two ways:
 2. Using the `logLevel` client option (overrides the environment variable if set)
 
 ```ts
-import SFCNodes from 'sfc-nodes';
+import SFCNodes from '@sfc/nodes-sdk-alpha';
 
 const client = new SFCNodes({
   logLevel: 'debug', // Show all log messages
@@ -188,7 +185,7 @@ When providing a custom logger, the `logLevel` option still controls which messa
 below the configured level will not be sent to your logger.
 
 ```ts
-import SFCNodes from 'sfc-nodes';
+import SFCNodes from '@sfc/nodes-sdk-alpha';
 import pino from 'pino';
 
 const logger = pino();
@@ -257,7 +254,7 @@ globalThis.fetch = fetch;
 Or pass it to the client:
 
 ```ts
-import SFCNodes from 'sfc-nodes';
+import SFCNodes from '@sfc/nodes-sdk-alpha';
 import fetch from 'my-fetch';
 
 const client = new SFCNodes({ fetch });
@@ -268,7 +265,7 @@ const client = new SFCNodes({ fetch });
 If you want to set custom `fetch` options without overriding the `fetch` function, you can provide a `fetchOptions` object when instantiating the client or making a request. (Request-specific options override client options.)
 
 ```ts
-import SFCNodes from 'sfc-nodes';
+import SFCNodes from '@sfc/nodes-sdk-alpha';
 
 const client = new SFCNodes({
   fetchOptions: {
@@ -285,7 +282,7 @@ options to requests:
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/node.svg" align="top" width="18" height="21"> **Node** <sup>[[docs](https://github.com/nodejs/undici/blob/main/docs/docs/api/ProxyAgent.md#example---proxyagent-with-fetch)]</sup>
 
 ```ts
-import SFCNodes from 'sfc-nodes';
+import SFCNodes from '@sfc/nodes-sdk-alpha';
 import * as undici from 'undici';
 
 const proxyAgent = new undici.ProxyAgent('http://localhost:8888');
@@ -299,7 +296,7 @@ const client = new SFCNodes({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/bun.svg" align="top" width="18" height="21"> **Bun** <sup>[[docs](https://bun.sh/guides/http/proxy)]</sup>
 
 ```ts
-import SFCNodes from 'sfc-nodes';
+import SFCNodes from '@sfc/nodes-sdk-alpha';
 
 const client = new SFCNodes({
   fetchOptions: {
@@ -311,7 +308,7 @@ const client = new SFCNodes({
 <img src="https://raw.githubusercontent.com/stainless-api/sdk-assets/refs/heads/main/deno.svg" align="top" width="18" height="21"> **Deno** <sup>[[docs](https://docs.deno.com/api/deno/~/Deno.createHttpClient)]</sup>
 
 ```ts
-import SFCNodes from 'npm:sfc-nodes';
+import SFCNodes from 'npm:@sfc/nodes-sdk-alpha';
 
 const httpClient = Deno.createHttpClient({ proxy: { url: 'http://localhost:8888' } });
 const client = new SFCNodes({

bin/check-release-environment

@@ -2,6 +2,10 @@
 
 errors=()
 
+if [ -z "${NPM_TOKEN}" ]; then
+  errors+=("The NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
+fi
+
 lenErrors=${#errors[@]}
 
 if [[ lenErrors -gt 0 ]]; then

eslint.config.mjs

@@ -25,7 +25,7 @@ export default tseslint.config(
         {
           patterns: [
             {
-              regex: '^sfc-nodes(/.*)?',
+              regex: '^@sfc/nodes-sdk-alpha(/.*)?',
               message: 'Use a relative import, not a package import.',
             },
           ],

jest.config.ts

@@ -7,8 +7,8 @@ const config: JestConfigWithTsJest = {
     '^.+\\.(t|j)sx?$': ['@swc/jest', { sourceMaps: 'inline' }],
   },
   moduleNameMapper: {
-    '^sfc-nodes$': '<rootDir>/src/index.ts',
-    '^sfc-nodes/(.*)$': '<rootDir>/src/$1',
+    '^@sfc/nodes-sdk-alpha$': '<rootDir>/src/index.ts',
+    '^@sfc/nodes-sdk-alpha/(.*)$': '<rootDir>/src/$1',
   },
   modulePathIgnorePatterns: [
     '<rootDir>/ecosystem-tests/',