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

Author: sigmachirality

.release-please-manifest.json

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

.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-75d55a2bdbad9dd66f295dbd8559f2bf6264e40b8c4afe69f2b74c206d96aabd.yml
-openapi_spec_hash: 4754d7b3a8a098a220650c410b3b79cd
-config_hash: 0bc0755073b9c5efee39395b9d08b3a3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/the-san-francisco-compute-company%2Fsfc-nodes-a77e44712c1fc082086539b82229b887a6eb9d4a3f677e6827d2eea9341fa08b.yml
+openapi_spec_hash: df8daea0f36c6c13f13ac2658d306083
+config_hash: ada4ea3670884e51d3b5b4f3b5a6e76d

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.1.0-alpha.8 (2025-08-13)
+
+Full Changelog: [v0.1.0-alpha.7...v0.1.0-alpha.8](https://github.com/sfcompute/nodes-typescript/compare/v0.1.0-alpha.7...v0.1.0-alpha.8)
+
+### Features
+
+* **api:** revert custom ErrorConfig ([186cb52](https://github.com/sfcompute/nodes-typescript/commit/186cb5225a5de532914c1fd24f8e34688294ad51))
+
+
+### Chores
+
+* **internal:** codegen related update ([4a8ba72](https://github.com/sfcompute/nodes-typescript/commit/4a8ba72e22d870c79ea30dcc90de37cf20fe1dd5))
+* **internal:** move publish config ([42810dd](https://github.com/sfcompute/nodes-typescript/commit/42810ddb26d3d78aeddf9d0b9419a8166c33ad61))
+* **internal:** update comment in script ([51e1934](https://github.com/sfcompute/nodes-typescript/commit/51e193432b8af198a91381c4d55350aa271b91ff))
+* update @stainless-api/prism-cli to v5.15.0 ([2c66260](https://github.com/sfcompute/nodes-typescript/commit/2c6626033c3ec5ab5109ea290b0bfec58a6afbf5))
+
 ## 0.1.0-alpha.7 (2025-08-05)
 
 Full Changelog: [v0.1.0-alpha.6...v0.1.0-alpha.7](https://github.com/sfcompute/nodes-typescript/compare/v0.1.0-alpha.6...v0.1.0-alpha.7)

README.md

@@ -23,7 +23,7 @@ The full API of this library can be found in [api.md](api.md).
 import SFCNodes from '@sfcompute/nodes-sdk-alpha';
 
 const client = new SFCNodes({
-  apiKey: process.env['SFC_API_KEY'], // This is the default and can be omitted
+  bearerToken: process.env['SFC_NODES_BEARER_TOKEN'], // This is the default and can be omitted
 });
 
 const listResponseNode = await client.nodes.list();
@@ -40,7 +40,7 @@ This library includes TypeScript definitions for all request params and response
 import SFCNodes from '@sfcompute/nodes-sdk-alpha';
 
 const client = new SFCNodes({
-  apiKey: process.env['SFC_API_KEY'], // This is the default and can be omitted
+  bearerToken: process.env['SFC_NODES_BEARER_TOKEN'], // This is the default and can be omitted
 });
 
 const listResponseNode: SFCNodes.ListResponseNode = await client.nodes.list();

bin/publish-npm

@@ -58,4 +58,4 @@ else
 fi
 
 # Publish with the appropriate tag
-yarn publish --access public --tag "$TAG"
+yarn publish --tag "$TAG"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sfcompute/nodes-sdk-alpha",
-  "version": "0.1.0-alpha.7",
+  "version": "0.1.0-alpha.8",
   "description": "The official TypeScript library for the SFC Nodes API",
   "author": "SFC Nodes <hello@sfcompute.com>",
   "types": "dist/index.d.ts",
@@ -13,6 +13,9 @@
     "**/*"
   ],
   "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "test": "./scripts/test",
     "build": "./scripts/build",

scripts/mock

@@ -21,7 +21,7 @@ echo "==> Starting mock server with URL ${URL}"
 
 # Run prism mock on the given spec
 if [ "$1" == "--daemon" ]; then
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL" &> .prism.log &
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL" &> .prism.log &
 
   # Wait for server to come online
   echo -n "Waiting for server"
@@ -37,5 +37,5 @@ if [ "$1" == "--daemon" ]; then
 
   echo
 else
-  npm exec --package=@stainless-api/prism-cli@5.8.5 -- prism mock "$URL"
+  npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock "$URL"
 fi

scripts/test

@@ -43,7 +43,7 @@ elif ! prism_is_running ; then
   echo -e "To run the server, pass in the path or url of your OpenAPI"
   echo -e "spec to the prism command:"
   echo
-  echo -e "  \$ ${YELLOW}npm exec --package=@stoplight/prism-cli@~5.3.2 -- prism mock path/to/your.openapi.yml${NC}"
+  echo -e "  \$ ${YELLOW}npm exec --package=@stainless-api/prism-cli@5.15.0 -- prism mock path/to/your.openapi.yml${NC}"
   echo
 
   exit 1

src/client.ts

@@ -49,9 +49,9 @@ import { isEmptyObj } from './internal/utils/values';
 
 export interface ClientOptions {
   /**
-   * Defaults to process.env['SFC_API_KEY'].
+   * Defaults to process.env['SFC_NODES_BEARER_TOKEN'].
    */
-  apiKey?: string | null | undefined;
+  bearerToken?: string | null | undefined;
 
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
@@ -126,7 +126,7 @@ export interface ClientOptions {
  * API Client for interfacing with the SFC Nodes API.
  */
 export class SFCNodes {
-  apiKey: string | null;
+  bearerToken: string | null;
 
   baseURL: string;
   maxRetries: number;
@@ -143,7 +143,7 @@ export class SFCNodes {
   /**
    * API Client for interfacing with the SFC Nodes API.
    *
-   * @param {string | null | undefined} [opts.apiKey=process.env['SFC_API_KEY'] ?? null]
+   * @param {string | null | undefined} [opts.bearerToken=process.env['SFC_NODES_BEARER_TOKEN'] ?? null]
    * @param {string} [opts.baseURL=process.env['SFC_NODES_BASE_URL'] ?? https://api.sfcompute.com] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
@@ -154,11 +154,11 @@ export class SFCNodes {
    */
   constructor({
     baseURL = readEnv('SFC_NODES_BASE_URL'),
-    apiKey = readEnv('SFC_API_KEY') ?? null,
+    bearerToken = readEnv('SFC_NODES_BEARER_TOKEN') ?? null,
     ...opts
   }: ClientOptions = {}) {
     const options: ClientOptions = {
-      apiKey,
+      bearerToken,
       ...opts,
       baseURL: baseURL || `https://api.sfcompute.com`,
     };
@@ -180,7 +180,7 @@ export class SFCNodes {
 
     this._options = options;
 
-    this.apiKey = apiKey;
+    this.bearerToken = bearerToken;
   }
 
   /**
@@ -196,7 +196,7 @@ export class SFCNodes {
       logLevel: this.logLevel,
       fetch: this.fetch,
       fetchOptions: this.fetchOptions,
-      apiKey: this.apiKey,
+      bearerToken: this.bearerToken,
       ...options,
     });
     return client;
@@ -214,23 +214,23 @@ export class SFCNodes {
   }
 
   protected validateHeaders({ values, nulls }: NullableHeaders) {
-    if (this.apiKey && values.get('authorization')) {
+    if (this.bearerToken && values.get('authorization')) {
       return;
     }
     if (nulls.has('authorization')) {
       return;
     }
 
     throw new Error(
-      'Could not resolve authentication method. Expected the apiKey to be set. Or for the "Authorization" headers to be explicitly omitted',
+      'Could not resolve authentication method. Expected the bearerToken to be set. Or for the "Authorization" headers to be explicitly omitted',
     );
   }
 
   protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    if (this.apiKey == null) {
+    if (this.bearerToken == null) {
       return undefined;
     }
-    return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
+    return buildHeaders([{ Authorization: `Bearer ${this.bearerToken}` }]);
   }
 
   /**

src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.7'; // x-release-please-version
+export const VERSION = '0.1.0-alpha.8'; // x-release-please-version