feat: scalar-typescript-sdk-cli@0.2.7

scalarbot · scalarbot · commit f8d0aaebd260 · 2026-07-11T06:21:48.000Z
diff --git a/.github/workflows/sdk-ci.yml b/.github/workflows/sdk-ci.yml
@@ -0,0 +1,16 @@
+name: CLI SDK CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        with:
+          node-version: "20"
+      - run: npm install
+      - run: npm run build
diff --git a/.scalar/sdk-sync.json b/.scalar/sdk-sync.json
@@ -1,5 +1,5 @@
 {
-  "build": "fsFsD0KdObN6oquV3KEHQ",
+  "build": "qHulKPu8st12EXA7HYoJ9",
   "slug": "scalar-typescript-sdk-cli",
   "version": "0.2.7"
 }
diff --git a/README.md b/README.md
@@ -171,11 +171,3 @@ Generated clients support request timeouts and retry temporary failures such as
 - Node.js 20 or newer
 
 Powered by Scalar.
-
-
-## Contributions
-
-This SDK is generated programmatically. Manual edits to generated files will be
-overwritten on the next build.
-
-### SDK created by [Scalar](https://www.scalar.com/?utm_source=scalar-typescript-sdk-cli&utm_campaign=sdk)
diff --git a/VERSIONING.md b/VERSIONING.md
@@ -0,0 +1,7 @@
+# Versioning
+
+This SDK is configured with the `manual` versioning policy.
+
+- `manual`: package versions are set explicitly before release.
+- `semver`: releases should follow semantic versioning based on API and SDK surface changes.
+- `calendar`: releases should use a calendar-derived version chosen by the release workflow or maintainer.
diff --git a/openapi.augmented.json b/openapi.augmented.json
@@ -1406,9 +1406,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst createAPIDocument = await client.registry.createAPIDocument(\"namespace\", {\n  title: \"\",\n  version: \"\",\n  slug: \"\",\n  document: \"\",\n});\nconsole.log(createAPIDocument);"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst createAPIDocument = await client.registry.createAPIDocument(\"namespace\", {\n  title: \"\",\n  version: \"x\",\n  slug: \"\",\n  document: \"\",\n});\nconsole.log(createAPIDocument);"
           },
           {
             "label": "Shell",
@@ -2519,9 +2519,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst createAPIDocumentVersion = await client.registry.createAPIDocumentVersion(\"namespace\", \"slug\", {\n  version: \"\",\n  document: \"\",\n});\nconsole.log(createAPIDocumentVersion);"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst createAPIDocumentVersion = await client.registry.createAPIDocumentVersion(\"namespace\", \"slug\", {\n  version: \"x\",\n  document: \"\",\n});\nconsole.log(createAPIDocumentVersion);"
           },
           {
             "label": "Shell",
@@ -2671,9 +2671,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.registry.createAPIDocumentAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"\",\n});"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.registry.createAPIDocumentAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"xxx\",\n});"
           },
           {
             "label": "Shell",
@@ -2821,9 +2821,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.registry.deleteAPIDocumentAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"\",\n});"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.registry.deleteAPIDocumentAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"xxx\",\n});"
           },
           {
             "label": "Shell",
@@ -3127,9 +3127,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst create = await client.schemas.create(\"namespace\", {\n  title: \"\",\n  version: \"\",\n  slug: \"\",\n  document: \"\",\n});\nconsole.log(create);"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst create = await client.schemas.create(\"namespace\", {\n  title: \"\",\n  version: \"x\",\n  slug: \"\",\n  document: \"\",\n});\nconsole.log(create);"
           },
           {
             "label": "Shell",
@@ -3894,9 +3894,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst createVersion = await client.schemas.createVersion(\"namespace\", \"slug\", {\n  version: \"\",\n  document: \"\",\n});\nconsole.log(createVersion);"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nconst createVersion = await client.schemas.createVersion(\"namespace\", \"slug\", {\n  version: \"x\",\n  document: \"\",\n});\nconsole.log(createVersion);"
           },
           {
             "label": "Shell",
@@ -4046,9 +4046,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.schemas.createAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"\",\n});"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.schemas.createAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"xxx\",\n});"
           },
           {
             "label": "Shell",
@@ -4196,9 +4196,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.schemas.deleteAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"\",\n});"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.schemas.deleteAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"xxx\",\n});"
           },
           {
             "label": "Shell",
@@ -5819,9 +5819,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.rules.createRulesetAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"\",\n});"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.rules.createRulesetAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"xxx\",\n});"
           },
           {
             "label": "Shell",
@@ -5969,9 +5969,9 @@
         ],
         "x-codeSamples": [
           {
-            "label": "TypeScript",
             "lang": "TypeScript",
-            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.rules.deleteRulesetAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"\",\n});"
+            "label": "TypeScript",
+            "source": "import Scalar from \"@scalar/sdk\";\n\nconst client = new Scalar({\n  bearerAuth: process.env[\"BEARER_AUTH\"], // defaults to the BEARER_AUTH env var\n  environment: \"production\",\n});\n\nawait client.rules.deleteRulesetAccessGroup(\"namespace\", \"slug\", {\n  accessGroupSlug: \"xxx\",\n});"
           },
           {
             "label": "Shell",
diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json
@@ -2,7 +2,7 @@
   "name": "ScalarApi",
   "slug": "scalarApi",
   "version": "0.2.6",
-  "generatorVersion": "0.15.2",
+  "generatorVersion": "0.16.5",
   "servers": [
     "https://access.scalar.com"
   ],
diff --git a/src/sdk/core/api-promise.ts b/src/sdk/core/api-promise.ts
@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+
+export { APIPromise, defaultParseResponse } from '../api-promise';
+export type { APIResponseProps, ParseResponse } from '../api-promise';
diff --git a/src/sdk/core/resource.ts b/src/sdk/core/resource.ts
@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+
+export { APIResource } from '../resource';
diff --git a/src/sdk/internal/parse.ts b/src/sdk/internal/parse.ts
@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+
+export { defaultParseResponse } from '../api-promise';
+export type { APIResponseProps, ParseResponse } from '../api-promise';
diff --git a/src/sdk/internal/utils.ts b/src/sdk/internal/utils.ts
@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+
+export * from './utils/values';
+export * from './utils/base64';
+export * from './utils/env';
+export * from './utils/log';
+export * from './utils/uuid';
+export * from './utils/sleep';
+export * from './utils/query';
diff --git a/src/sdk/internal/utils/base64.ts b/src/sdk/internal/utils/base64.ts
@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+
+import { ScalarError } from '../../core/error';
+import { encodeUTF8 } from './bytes';
+
+export const toBase64 = (data: string | Uint8Array | null | undefined): string => {
+  if (!data) return '';
+
+  if (typeof (globalThis as any).Buffer !== 'undefined') {
+    return (globalThis as any).Buffer.from(data).toString('base64');
+  }
+
+  if (typeof data === 'string') {
+    data = encodeUTF8(data);
+  }
+
+  if (typeof btoa !== 'undefined') {
+    return btoa(String.fromCharCode.apply(null, data as any));
+  }
+
+  throw new ScalarError('Cannot generate base64 string; Expected `Buffer` or `btoa` to be defined');
+};
+
+export const fromBase64 = (str: string): Uint8Array => {
+  if (typeof (globalThis as any).Buffer !== 'undefined') {
+    const buf = (globalThis as any).Buffer.from(str, 'base64');
+    return new Uint8Array(buf.buffer, buf.byteOffset, buf.byteLength);
+  }
+
+  if (typeof atob !== 'undefined') {
+    const bstr = atob(str);
+    const buf = new Uint8Array(bstr.length);
+    for (let i = 0; i < bstr.length; i++) {
+      buf[i] = bstr.charCodeAt(i);
+    }
+    return buf;
+  }
+
+  throw new ScalarError('Cannot decode base64 string; Expected `Buffer` or `atob` to be defined');
+};
diff --git a/src/sdk/internal/utils/bytes.ts b/src/sdk/internal/utils/bytes.ts
@@ -0,0 +1,32 @@
+export function concatBytes(buffers: Uint8Array[]): Uint8Array {
+  let length = 0;
+  for (const buffer of buffers) {
+    length += buffer.length;
+  }
+  const output = new Uint8Array(length);
+  let index = 0;
+  for (const buffer of buffers) {
+    output.set(buffer, index);
+    index += buffer.length;
+  }
+
+  return output;
+}
+
+let encodeUTF8_: (str: string) => Uint8Array;
+export function encodeUTF8(str: string) {
+  let encoder;
+  return (
+    encodeUTF8_ ??
+    ((encoder = new (globalThis as any).TextEncoder()), (encodeUTF8_ = encoder.encode.bind(encoder)))
+  )(str);
+}
+
+let decodeUTF8_: (bytes: Uint8Array) => string;
+export function decodeUTF8(bytes: Uint8Array) {
+  let decoder;
+  return (
+    decodeUTF8_ ??
+    ((decoder = new (globalThis as any).TextDecoder()), (decodeUTF8_ = decoder.decode.bind(decoder)))
+  )(bytes);
+}
diff --git a/src/sdk/internal/utils/query.ts b/src/sdk/internal/utils/query.ts
@@ -0,0 +1,7 @@
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+
+import * as qs from '../qs/stringify';
+
+export function stringifyQuery(query: object | Record<string, unknown>): string {
+  return qs.stringify(query, { arrayFormat: 'repeat' });
+}
diff --git a/src/sdk/resource.ts b/src/sdk/resource.ts
@@ -2,7 +2,7 @@
 
 import type { Scalar } from './client';
 
-export class APIResource {
+export abstract class APIResource {
   protected _client: Scalar;
 
   constructor(client: Scalar) {
diff --git a/src/sdk/resources.ts b/src/sdk/resources.ts
@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+
+export { Registry, Schemas, LoginPortals, Rules, Themes, Teams, ScalarDocs, Namespaces, Authentication } from './resources/index';
+export type { Version, AccessGroup, RegistryListAllAPIDocumentsResponse, RegistryListAPIDocumentsResponse, RegistryCreateAPIDocumentParams, RegistryCreateAPIDocumentResponse, RegistryUpdateAPIDocumentParams, RegistryUpdateAPIDocumentResponse, RegistryDeleteAPIDocumentResponse, RegistryRetrieveAPIDocumentVersionResponse, RegistryUpdateAPIDocumentVersionParams, RegistryUpdateAPIDocumentVersionResponse, RegistryDeleteAPIDocumentVersionResponse, RegistryListAPIDocumentVersionMetadataResponse, RegistryCreateAPIDocumentVersionParams, RegistryCreateAPIDocumentVersionResponse, RegistryCreateAPIDocumentAccessGroupParams, RegistryCreateAPIDocumentAccessGroupResponse, RegistryDeleteAPIDocumentAccessGroupParams, RegistryDeleteAPIDocumentAccessGroupResponse, SchemaListResponse, SchemaCreateParams, SchemaCreateResponse, SchemaUpdateParams, SchemaUpdateResponse, SchemaDeleteResponse, SchemaRetrieveVersionResponse, SchemaDeleteVersionResponse, SchemaCreateVersionParams, SchemaCreateVersionResponse, SchemaCreateAccessGroupParams, SchemaCreateAccessGroupResponse, SchemaDeleteAccessGroupParams, SchemaDeleteAccessGroupResponse, LoginPortalEmail, LoginPortalPage, LoginPortalRetrieveResponse, LoginPortalUpdateParams, LoginPortalUpdateResponse, LoginPortalDeleteResponse, LoginPortalCreateParams, LoginPortalCreateResponse, LoginPortalListResponse, RuleListRulesetsResponse, RuleCreateRulesetParams, RuleCreateRulesetResponse, RuleUpdateRulesetParams, RuleUpdateRulesetResponse, RuleDeleteRulesetResponse, RuleRetrieveRulesetDocumentResponse, RuleCreateRulesetAccessGroupParams, RuleCreateRulesetAccessGroupResponse, RuleDeleteRulesetAccessGroupParams, RuleDeleteRulesetAccessGroupResponse, ThemeListResponse, ThemeCreateParams, ThemeCreateResponse, ThemeUpdateParams, ThemeUpdateResponse, ThemeReplaceDocumentParams, ThemeReplaceDocumentResponse, ThemeDeleteResponse, ThemeRetrieveResponse, TeamListResponse, Slug, ScalarDocListGuidesResponse, ScalarDocCreateGuideParams, ScalarDocCreateGuideResponse, ScalarDocPublishGuideResponse, NamespaceListResponse, AuthenticationExchangePersonalTokenParams, AuthenticationExchangePersonalTokenResponse, AuthenticationListCurrentUserResponse } from './resources/index';
diff --git a/src/sdk/resources/registry.ts b/src/sdk/resources/registry.ts
@@ -51,7 +51,7 @@ export class Registry extends APIResource {
    * ```ts
    * const createAPIDocument = await client.registry.createAPIDocument("namespace", {
    *   title: "",
-   *   version: "",
+   *   version: "x",
    *   slug: "",
    *   document: "",
    * });
@@ -183,7 +183,7 @@ export class Registry extends APIResource {
    * @example
    * ```ts
    * const createAPIDocumentVersion = await client.registry.createAPIDocumentVersion("namespace", "slug", {
-   *   version: "",
+   *   version: "x",
    *   document: "",
    * });
    * ```
@@ -204,7 +204,7 @@ export class Registry extends APIResource {
    * @example
    * ```ts
    * await client.registry.createAPIDocumentAccessGroup("namespace", "slug", {
-   *   accessGroupSlug: "",
+   *   accessGroupSlug: "xxx",
    * });
    * ```
    */
@@ -224,7 +224,7 @@ export class Registry extends APIResource {
    * @example
    * ```ts
    * await client.registry.deleteAPIDocumentAccessGroup("namespace", "slug", {
-   *   accessGroupSlug: "",
+   *   accessGroupSlug: "xxx",
    * });
    * ```
    */
diff --git a/src/sdk/resources/rules.ts b/src/sdk/resources/rules.ts
@@ -110,7 +110,7 @@ export class Rules extends APIResource {
    * @example
    * ```ts
    * await client.rules.createRulesetAccessGroup("namespace", "slug", {
-   *   accessGroupSlug: "",
+   *   accessGroupSlug: "xxx",
    * });
    * ```
    */
@@ -130,7 +130,7 @@ export class Rules extends APIResource {
    * @example
    * ```ts
    * await client.rules.deleteRulesetAccessGroup("namespace", "slug", {
-   *   accessGroupSlug: "",
+   *   accessGroupSlug: "xxx",
    * });
    * ```
    */
diff --git a/src/sdk/resources/schemas.ts b/src/sdk/resources/schemas.ts
@@ -37,7 +37,7 @@ export class Schemas extends APIResource {
    * ```ts
    * const create = await client.schemas.create("namespace", {
    *   title: "",
-   *   version: "",
+   *   version: "x",
    *   slug: "",
    *   document: "",
    * });
@@ -130,7 +130,7 @@ export class Schemas extends APIResource {
    * @example
    * ```ts
    * const createVersion = await client.schemas.createVersion("namespace", "slug", {
-   *   version: "",
+   *   version: "x",
    *   document: "",
    * });
    * ```
@@ -151,7 +151,7 @@ export class Schemas extends APIResource {
    * @example
    * ```ts
    * await client.schemas.createAccessGroup("namespace", "slug", {
-   *   accessGroupSlug: "",
+   *   accessGroupSlug: "xxx",
    * });
    * ```
    */
@@ -171,7 +171,7 @@ export class Schemas extends APIResource {
    * @example
    * ```ts
    * await client.schemas.deleteAccessGroup("namespace", "slug", {
-   *   accessGroupSlug: "",
+   *   accessGroupSlug: "xxx",
    * });
    * ```
    */

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "build": "fsFsD0KdObN6oquV3KEHQ",`
	`2`	`+ "build": "qHulKPu8st12EXA7HYoJ9",`
`3`	`3`	`"slug": "scalar-typescript-sdk-cli",`
`4`	`4`	`"version": "0.2.7"`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+// File generated from our OpenAPI spec by Scalar. See README.md for details.`
	`2`	`+`
	`3`	`+export { APIResource } from '../resource';`