@superartifacts/sdk 0.1.1 → 0.1.2

package/README.md

@@ -74,8 +74,8 @@ Per request: `{ idempotencyKey, timeout, signal, headers }`.
 ## Errors
 
 Every failure is a `SuperArtifactsError` with `status`, `code`, `message` and, when the API asked
-you to wait, `retryAfter` in seconds. Anything else the API said is in `details`. A missing key
-throws before any request, so that `AuthenticationError` has no `status` or `code`.
+you to wait, `retryAfter` in seconds. Anything else the API said is in `details`. A client-side
+failure has `status` 0 and its own `code`: a missing key is an `AuthenticationError` with `missing_api_key`.
 
 | Class | When |
 | --- | --- |

package/dist/index.cjs

@@ -53,8 +53,8 @@ var SuperArtifactsError = class extends Error {
   constructor(status, code, message, retryAfter, details = {}, options) {
     super(message, options);
     this.name = new.target.name;
-    if (status !== void 0) this.status = status;
-    if (code !== void 0) this.code = code;
+    this.status = status;
+    this.code = code;
     if (retryAfter !== void 0) this.retryAfter = retryAfter;
     this.details = details;
   }
@@ -121,7 +121,7 @@ function errorFor(status, text, retryAfterHeader) {
 }
 
 // src/core.ts
-var VERSION = "0.1.1";
+var VERSION = "0.1.2";
 var DEFAULT_BASE_URL = "https://superartifacts.app";
 var API_KEY_ENV = "SUPERARTIFACTS_API_KEY";
 var MAX_RETRY_AFTER_SECONDS = 60;
@@ -161,8 +161,8 @@ var Core = class {
     const apiKey = options.apiKey ?? globalThis.process?.env?.[API_KEY_ENV];
     if (!apiKey) {
       throw new AuthenticationError(
-        void 0,
-        void 0,
+        0,
+        "missing_api_key",
         `No API key. Pass { apiKey } or set ${API_KEY_ENV}. Create one at https://superartifacts.app/settings/api-keys.`
       );
     }
@@ -237,8 +237,7 @@ var Core = class {
         const text = await response.text();
         if (response.ok) return parseAnswer(text, response.status);
         failure = errorFor(response.status, text, response.headers.get("retry-after"));
-        const { status } = response;
-        const { retryAfter } = failure;
+        const { status, retryAfter } = failure;
         if (status === 429 || retry && [502, 503, 504].includes(status)) {
           if (retryAfter !== void 0) delay = retryAfter * 1e3;
           retry = left && (retryAfter ?? 0) <= MAX_RETRY_AFTER_SECONDS;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-declare const VERSION = "0.1.1";
+declare const VERSION = "0.1.2";
 interface ClientOptions {
     /** Defaults to the SUPERARTIFACTS_API_KEY environment variable. */
     apiKey?: string;
@@ -77,19 +77,16 @@ declare class Core {
     protected send(url: URL | string, init: RequestInit, repeatable: boolean, options?: RequestOptions): Promise<Record<string, unknown>>;
 }
 
-/**
- * Anything this SDK throws for a failed call. `status` is 0 when no answer arrived, and it
- * and `code` are absent when no request was made: an `AuthenticationError` for a missing key.
- */
+/** Anything this SDK throws for a failed call. `status` is 0 when no answer arrived. */
 declare class SuperArtifactsError extends Error {
-    readonly status?: number;
+    readonly status: number;
     /** Stable and machine-readable; `message` is for a person. */
-    readonly code?: string;
+    readonly code: string;
     /** Seconds the API asked to wait. */
     readonly retryAfter?: number;
     /** Everything else the API said, e.g. `fix` or `approvalUrl`. */
     readonly details: Record<string, unknown>;
-    constructor(status: number | undefined, code: string | undefined, message: string, retryAfter?: number, details?: Record<string, unknown>, options?: ErrorOptions);
+    constructor(status: number, code: string, message: string, retryAfter?: number, details?: Record<string, unknown>, options?: ErrorOptions);
 }
 declare class InvalidArgumentsError extends SuperArtifactsError {
 }

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-declare const VERSION = "0.1.1";
+declare const VERSION = "0.1.2";
 interface ClientOptions {
     /** Defaults to the SUPERARTIFACTS_API_KEY environment variable. */
     apiKey?: string;
@@ -77,19 +77,16 @@ declare class Core {
     protected send(url: URL | string, init: RequestInit, repeatable: boolean, options?: RequestOptions): Promise<Record<string, unknown>>;
 }
 
-/**
- * Anything this SDK throws for a failed call. `status` is 0 when no answer arrived, and it
- * and `code` are absent when no request was made: an `AuthenticationError` for a missing key.
- */
+/** Anything this SDK throws for a failed call. `status` is 0 when no answer arrived. */
 declare class SuperArtifactsError extends Error {
-    readonly status?: number;
+    readonly status: number;
     /** Stable and machine-readable; `message` is for a person. */
-    readonly code?: string;
+    readonly code: string;
     /** Seconds the API asked to wait. */
     readonly retryAfter?: number;
     /** Everything else the API said, e.g. `fix` or `approvalUrl`. */
     readonly details: Record<string, unknown>;
-    constructor(status: number | undefined, code: string | undefined, message: string, retryAfter?: number, details?: Record<string, unknown>, options?: ErrorOptions);
+    constructor(status: number, code: string, message: string, retryAfter?: number, details?: Record<string, unknown>, options?: ErrorOptions);
 }
 declare class InvalidArgumentsError extends SuperArtifactsError {
 }

package/dist/index.js

@@ -10,8 +10,8 @@ var SuperArtifactsError = class extends Error {
   constructor(status, code, message, retryAfter, details = {}, options) {
     super(message, options);
     this.name = new.target.name;
-    if (status !== void 0) this.status = status;
-    if (code !== void 0) this.code = code;
+    this.status = status;
+    this.code = code;
     if (retryAfter !== void 0) this.retryAfter = retryAfter;
     this.details = details;
   }
@@ -78,7 +78,7 @@ function errorFor(status, text, retryAfterHeader) {
 }
 
 // src/core.ts
-var VERSION = "0.1.1";
+var VERSION = "0.1.2";
 var DEFAULT_BASE_URL = "https://superartifacts.app";
 var API_KEY_ENV = "SUPERARTIFACTS_API_KEY";
 var MAX_RETRY_AFTER_SECONDS = 60;
@@ -118,8 +118,8 @@ var Core = class {
     const apiKey = options.apiKey ?? globalThis.process?.env?.[API_KEY_ENV];
     if (!apiKey) {
       throw new AuthenticationError(
-        void 0,
-        void 0,
+        0,
+        "missing_api_key",
         `No API key. Pass { apiKey } or set ${API_KEY_ENV}. Create one at https://superartifacts.app/settings/api-keys.`
       );
     }
@@ -194,8 +194,7 @@ var Core = class {
         const text = await response.text();
         if (response.ok) return parseAnswer(text, response.status);
         failure = errorFor(response.status, text, response.headers.get("retry-after"));
-        const { status } = response;
-        const { retryAfter } = failure;
+        const { status, retryAfter } = failure;
         if (status === 429 || retry && [502, 503, 504].includes(status)) {
           if (retryAfter !== void 0) delay = retryAfter * 1e3;
           retry = left && (retryAfter ?? 0) <= MAX_RETRY_AFTER_SECONDS;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superartifacts/sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "The TypeScript SDK for the Super Artifacts REST API: publish artifacts, read their data, and manage projects, shares and templates from a server.",
   "license": "MIT",
   "type": "module",