@atlasauth/backend 0.17.0 → 0.19.0

package/dist/client/design.d.ts

@@ -189,6 +189,44 @@ export interface DesignSettings {
     legacy: boolean;
     /** When `legacy`: the design derived from the older branding settings. */
     legacy_design?: AtlasDesign | null;
+    /** Instance designs: the imported brand document layer (null when none). */
+    brand?: BrandImport | null;
+    /** Instance designs: the layers, lowest first (preset < brand < design < audience). */
+    precedence?: {
+        layer: 'preset' | 'brand' | 'design' | 'audience';
+        source: string | null;
+    }[];
+    /** Instance designs: which layer each field set by the brand or the design comes from. */
+    sources?: Record<string, 'brand' | 'design'>;
+    /** After a brand import: the tokens that were not applied, with the reason. */
+    ignored?: BrandIgnoredToken[];
+}
+export interface BrandIgnoredToken {
+    /** The token path in the brand document, e.g. `color.sparkle`. */
+    token: string;
+    reason: string;
+}
+/** An imported brand document (design tokens), as its own layer under the instance design. */
+export interface BrandImport {
+    source: 'url' | 'inline';
+    url: string | null;
+    /** Epoch ms. */
+    imported_at: number;
+    document_sha256: string;
+    /** The design overrides the document mapped to. */
+    design: AtlasDesign;
+    mapping: {
+        token: string;
+        to: string;
+        value: string | number;
+    }[];
+    ignored: BrandIgnoredToken[];
+    meta: {
+        name: string | null;
+        legalName: string | null;
+        supportEmail: string | null;
+        favicon: string | null;
+    };
 }
 /** A compiled, unsaved design. Nothing is stored. */
 export interface DesignPreview {
@@ -266,6 +304,16 @@ export declare function designResource(request: RequestFn): {
     get(): Promise<DesignSettings>;
     /** Replace the whole instance design. */
     replace(design: AtlasDesign): Promise<DesignSettings>;
+    /**
+     * Import a brand document (W3C design tokens) as its own layer under the
+     * instance design: `{ brandUrl }` fetches it (https), `{ brand }` sends it,
+     * `{ brand: null }` removes it. The result lists `brand.mapping` and `ignored`.
+     */
+    importBrand(input: {
+        brandUrl: string;
+    } | {
+        brand: Record<string, unknown> | null;
+    }): Promise<DesignSettings>;
     /** Change part of the instance design; `null` removes a setting. */
     update(design: AtlasDesignPatch): Promise<DesignSettings>;
     /** Compile an unsaved design (CSS, attributes, fonts, rendered page). Nothing is saved. */

package/dist/client/design.js

@@ -12,6 +12,15 @@ function designResource(request) {
         replace(design) {
             return request({ method: 'PUT', path: '/v1/instance/design', body: { design } });
         },
+        /**
+         * Import a brand document (W3C design tokens) as its own layer under the
+         * instance design: `{ brandUrl }` fetches it (https), `{ brand }` sends it,
+         * `{ brand: null }` removes it. The result lists `brand.mapping` and `ignored`.
+         */
+        importBrand(input) {
+            const body = 'brandUrl' in input ? { brand_url: input.brandUrl } : { brand: input.brand };
+            return request({ method: 'PUT', path: '/v1/instance/design', body });
+        },
         /** Change part of the instance design; `null` removes a setting. */
         update(design) {
             return request({ method: 'PATCH', path: '/v1/instance/design', body: { design } });

package/dist/client/design.js.map

@@ -1 +1 @@
-{"version":3,"file":"design.js","sourceRoot":"","sources":["../../src/client/design.ts"],"names":[],"mappings":";;AAoUA,wCAsEC;AA1YD,uCAAgD;AAoUhD,SAAgB,cAAc,CAAC,OAAkB;IAC/C,OAAO;QACL,uFAAuF;QACvF,GAAG;YACD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,CAAC;QACjE,CAAC;QACD,yCAAyC;QACzC,OAAO,CAAC,MAAmB;YACzB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACnF,CAAC;QACD,oEAAoE;QACpE,MAAM,CAAC,MAAwB;YAC7B,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACrF,CAAC;QACD,2FAA2F;QAC3F,OAAO,CAAC,MAAmB;YACzB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC5F,CAAC;QACD,2EAA2E;QAC3E,aAAa,EAAE;YACb,GAAG,CAAC,cAAsB;gBACxB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,cAAc,CAAC,SAAS;iBACxD,CAAC,CAAC;YACL,CAAC;YACD,6CAA6C;YAC7C,OAAO,CAAC,cAAsB,EAAE,MAAmB;gBACjD,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,cAAc,CAAC,SAAS;oBACvD,IAAI,EAAE,EAAE,MAAM,EAAE;iBACjB,CAAC,CAAC;YACL,CAAC;YACD,MAAM,CAAC,cAAsB,EAAE,MAAwB;gBACrD,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,cAAc,CAAC,SAAS;oBACvD,IAAI,EAAE,EAAE,MAAM,EAAE;iBACjB,CAAC,CAAC;YACL,CAAC;SACF;QACD,6CAA6C;QAC7C,MAAM,EAAE;YACN;;;eAGG;YACH,MAAM,CAAC,IAAqB,EAAE,UAAoC,EAAE;gBAClE,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,mBAAmB;oBACzB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;oBAC7B,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE;iBACpD,CAAC,CAAC;YACL,CAAC;YACD,gCAAgC;YAChC,IAAI;gBACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAC;YAC/D,CAAC;YACD,4EAA4E;YAC5E,MAAM,CAAC,OAAe;gBACpB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YAClF,CAAC;SACF;QACD,mFAAmF;QACnF,OAAO;YACL,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAChE,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"design.js","sourceRoot":"","sources":["../../src/client/design.ts"],"names":[],"mappings":";;AAgWA,wCA+EC;AA/aD,uCAAgD;AAgWhD,SAAgB,cAAc,CAAC,OAAkB;IAC/C,OAAO;QACL,uFAAuF;QACvF,GAAG;YACD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,CAAC;QACjE,CAAC;QACD,yCAAyC;QACzC,OAAO,CAAC,MAAmB;YACzB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACnF,CAAC;QACD;;;;WAIG;QACH,WAAW,CAAC,KAAuE;YACjF,MAAM,IAAI,GAAG,UAAU,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;YAC1F,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,CAAC;QACD,oEAAoE;QACpE,MAAM,CAAC,MAAwB;YAC7B,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACrF,CAAC;QACD,2FAA2F;QAC3F,OAAO,CAAC,MAAmB;YACzB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC5F,CAAC;QACD,2EAA2E;QAC3E,aAAa,EAAE;YACb,GAAG,CAAC,cAAsB;gBACxB,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,cAAc,CAAC,SAAS;iBACxD,CAAC,CAAC;YACL,CAAC;YACD,6CAA6C;YAC7C,OAAO,CAAC,cAAsB,EAAE,MAAmB;gBACjD,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,KAAK;oBACb,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,cAAc,CAAC,SAAS;oBACvD,IAAI,EAAE,EAAE,MAAM,EAAE;iBACjB,CAAC,CAAC;YACL,CAAC;YACD,MAAM,CAAC,cAAsB,EAAE,MAAwB;gBACrD,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,OAAO;oBACf,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,cAAc,CAAC,SAAS;oBACvD,IAAI,EAAE,EAAE,MAAM,EAAE;iBACjB,CAAC,CAAC;YACL,CAAC;SACF;QACD,6CAA6C;QAC7C,MAAM,EAAE;YACN;;;eAGG;YACH,MAAM,CAAC,IAAqB,EAAE,UAAoC,EAAE;gBAClE,OAAO,OAAO,CAAC;oBACb,MAAM,EAAE,MAAM;oBACd,IAAI,EAAE,mBAAmB;oBACzB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;oBAC7B,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE;iBACpD,CAAC,CAAC;YACL,CAAC;YACD,gCAAgC;YAChC,IAAI;gBACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAAC,CAAC;YAC/D,CAAC;YACD,4EAA4E;YAC5E,MAAM,CAAC,OAAe;gBACpB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,qBAAqB,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;YAClF,CAAC;SACF;QACD,mFAAmF;QACnF,OAAO;YACL,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAChE,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/client/entitlement-overrides.d.ts

@@ -18,6 +18,8 @@ export interface EntitlementOverride {
     limits: Record<string, unknown> | null;
     /** Epoch ms when the override lapses, or null for open-ended. */
     expires_at: number | null;
+    /** For an account of the owner's own products: reads back as `planSource: "internal"` and never counts as revenue. */
+    internal?: boolean;
     created_by: string | null;
     created_at: number;
 }
@@ -32,6 +34,8 @@ export interface CreateEntitlementOverrideBody {
     limits?: Record<string, unknown> | null;
     /** Epoch ms; omit or null for open-ended. */
     expires_at?: number | null;
+    /** The grant is for an account of the owner's own products (reported as `internal`). */
+    internal?: boolean;
 }
 export interface ListEntitlementOverridesParams {
     subject_type?: EntitlementOverrideSubjectType;
@@ -48,3 +52,29 @@ export declare function entitlementOverridesResource(request: RequestFn): {
         deleted: true;
     }>;
 };
+/** The standard entitlements document: one shape any product can serve (JSON Schema `https://atlasauth.net/schemas/entitlements-v1.json`). */
+export interface Entitlements {
+    object: 'entitlements';
+    $schema?: string;
+    subject: {
+        type: EntitlementOverrideSubjectType;
+        id: string;
+    };
+    plan: string | null;
+    /** `plan` (a subscription), `override` (a sales-led grant), `internal` (an owner account, never revenue) or `none`. */
+    planSource: 'plan' | 'override' | 'internal' | 'none';
+    entitlements: Array<{
+        key: string;
+        enabled: boolean;
+        limit?: number;
+        used?: number;
+        source: 'plan' | 'override' | 'internal';
+    }>;
+}
+export declare function entitlementsResource(request: RequestFn): {
+    /** `GET /v1/entitlements`: gate a feature the same way against any product that serves this shape. */
+    get(params: {
+        subject_type: EntitlementOverrideSubjectType;
+        subject_id: string;
+    }): Promise<Entitlements>;
+};

package/dist/client/entitlement-overrides.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.entitlementOverridesResource = entitlementOverridesResource;
+exports.entitlementsResource = entitlementsResource;
 const request_1 = require("./request");
 function entitlementOverridesResource(request) {
     return {
@@ -17,4 +18,12 @@ function entitlementOverridesResource(request) {
         },
     };
 }
+function entitlementsResource(request) {
+    return {
+        /** `GET /v1/entitlements`: gate a feature the same way against any product that serves this shape. */
+        get(params) {
+            return request({ method: 'GET', path: '/v1/entitlements', query: { ...params } });
+        },
+    };
+}
 //# sourceMappingURL=entitlement-overrides.js.map

package/dist/client/entitlement-overrides.js.map

@@ -1 +1 @@
-{"version":3,"file":"entitlement-overrides.js","sourceRoot":"","sources":["../../src/client/entitlement-overrides.ts"],"names":[],"mappings":";;AA4CA,oEAmBC;AA/DD,uCAAgD;AA4ChD,SAAgB,4BAA4B,CAAC,OAAkB;IAC7D,OAAO;QACL,MAAM,CACJ,IAAmC,EACnC,cAAuB;YAEvB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QAC9F,CAAC;QACD,yEAAyE;QACzE,IAAI,CACF,SAAyC,EAAE;YAE3C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,2BAA2B,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,yFAAyF;QACzF,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACrF,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"entitlement-overrides.js","sourceRoot":"","sources":["../../src/client/entitlement-overrides.ts"],"names":[],"mappings":";;AAgDA,oEAmBC;AAmBD,oDAOC;AA7FD,uCAAgD;AAgDhD,SAAgB,4BAA4B,CAAC,OAAkB;IAC7D,OAAO;QACL,MAAM,CACJ,IAAmC,EACnC,cAAuB;YAEvB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QAC9F,CAAC;QACD,yEAAyE;QACzE,IAAI,CACF,SAAyC,EAAE;YAE3C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,2BAA2B,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,yFAAyF;QACzF,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACrF,CAAC;KACF,CAAC;AACJ,CAAC;AAmBD,SAAgB,oBAAoB,CAAC,OAAkB;IACrD,OAAO;QACL,sGAAsG;QACtG,GAAG,CAAC,MAA4E;YAC9E,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QACpF,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/client/env.d.ts

@@ -0,0 +1,16 @@
+import { type AtlasClient } from './index';
+import { type AtlasClientConfig } from './request';
+/** The environment names the SDK, the CLI and the generated env files all accept for the API base URL. */
+export declare const API_BASE_ENV_NAMES: readonly ["ATLAS_API_BASE", "ATLAS_API_URL"];
+type Env = Record<string, string | undefined>;
+/**
+ * The Backend API base URL from the environment. `ATLAS_API_BASE` and
+ * `ATLAS_API_URL` are both accepted (the first one set wins; blank values are
+ * ignored), so code written against either name keeps working.
+ */
+export declare function apiBaseFromEnv(env?: Env): string | undefined;
+/** A client config from `ATLAS_SECRET_KEY` plus the optional API base (`ATLAS_API_BASE` or `ATLAS_API_URL`). */
+export declare function atlasConfigFromEnv(env?: Env, overrides?: Partial<AtlasClientConfig>): AtlasClientConfig;
+/** `createAtlasClient(atlasConfigFromEnv(env))`: the one-liner for server code that configures itself from the environment. */
+export declare function createAtlasClientFromEnv(env?: Env, overrides?: Partial<AtlasClientConfig>): AtlasClient;
+export {};

package/dist/client/env.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.API_BASE_ENV_NAMES = void 0;
+exports.apiBaseFromEnv = apiBaseFromEnv;
+exports.atlasConfigFromEnv = atlasConfigFromEnv;
+exports.createAtlasClientFromEnv = createAtlasClientFromEnv;
+const index_1 = require("./index");
+const request_1 = require("./request");
+/** The environment names the SDK, the CLI and the generated env files all accept for the API base URL. */
+exports.API_BASE_ENV_NAMES = ['ATLAS_API_BASE', 'ATLAS_API_URL'];
+function processEnv() {
+    return globalThis.process?.env ?? {};
+}
+/**
+ * The Backend API base URL from the environment. `ATLAS_API_BASE` and
+ * `ATLAS_API_URL` are both accepted (the first one set wins; blank values are
+ * ignored), so code written against either name keeps working.
+ */
+function apiBaseFromEnv(env = processEnv()) {
+    for (const name of exports.API_BASE_ENV_NAMES) {
+        const value = env[name]?.trim();
+        if (value)
+            return value;
+    }
+    return undefined;
+}
+/** A client config from `ATLAS_SECRET_KEY` plus the optional API base (`ATLAS_API_BASE` or `ATLAS_API_URL`). */
+function atlasConfigFromEnv(env = processEnv(), overrides = {}) {
+    const secretKey = overrides.secretKey ?? env.ATLAS_SECRET_KEY?.trim();
+    if (!secretKey)
+        throw new Error('@atlasauth/backend: missing ATLAS_SECRET_KEY.');
+    return { ...overrides, secretKey, apiUrl: overrides.apiUrl ?? apiBaseFromEnv(env) ?? request_1.DEFAULT_API_URL };
+}
+/** `createAtlasClient(atlasConfigFromEnv(env))`: the one-liner for server code that configures itself from the environment. */
+function createAtlasClientFromEnv(env = processEnv(), overrides = {}) {
+    return (0, index_1.createAtlasClient)(atlasConfigFromEnv(env, overrides));
+}
+//# sourceMappingURL=env.js.map

package/dist/client/env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.js","sourceRoot":"","sources":["../../src/client/env.ts"],"names":[],"mappings":";;;AAiBA,wCAMC;AAGD,gDAIC;AAGD,4DAEC;AAnCD,mCAA8D;AAC9D,uCAAoE;AAEpE,0GAA0G;AAC7F,QAAA,kBAAkB,GAAG,CAAC,gBAAgB,EAAE,eAAe,CAAU,CAAC;AAI/E,SAAS,UAAU;IACjB,OAAQ,UAA0C,CAAC,OAAO,EAAE,GAAG,IAAI,EAAE,CAAC;AACxE,CAAC;AAED;;;;GAIG;AACH,SAAgB,cAAc,CAAC,MAAW,UAAU,EAAE;IACpD,KAAK,MAAM,IAAI,IAAI,0BAAkB,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;QAChC,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC;IAC1B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,gHAAgH;AAChH,SAAgB,kBAAkB,CAAC,MAAW,UAAU,EAAE,EAAE,YAAwC,EAAE;IACpG,MAAM,SAAS,GAAG,SAAS,CAAC,SAAS,IAAI,GAAG,CAAC,gBAAgB,EAAE,IAAI,EAAE,CAAC;IACtE,IAAI,CAAC,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACjF,OAAO,EAAE,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,MAAM,IAAI,cAAc,CAAC,GAAG,CAAC,IAAI,yBAAe,EAAE,CAAC;AACzG,CAAC;AAED,+HAA+H;AAC/H,SAAgB,wBAAwB,CAAC,MAAW,UAAU,EAAE,EAAE,YAAwC,EAAE;IAC1G,OAAO,IAAA,yBAAiB,EAAC,kBAAkB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;AAC/D,CAAC"}

package/dist/client/error.d.ts

@@ -16,6 +16,12 @@ export interface AtlasErrorItem {
     message: string;
     param?: string;
     meta?: Record<string, unknown>;
+    /** The code's page in the error reference (https://atlasauth.net/errors/<code>). */
+    docs_url?: string;
+    /** `ROUTE_NOT_FOUND` only: the closest documented paths. */
+    did_you_mean?: string[];
+    /** `ROUTE_NOT_FOUND` only: the methods the path does support. */
+    allowed_methods?: string[];
 }
 export declare class AtlasApiError extends Error {
     readonly name = "AtlasApiError";
@@ -68,6 +74,8 @@ export declare const AtlasErrorCodes: {
     /** The key is unknown, revoked or malformed. */
     readonly INVALID_KEY: "INVALID_KEY";
     readonly NOT_FOUND: "NOT_FOUND";
+    /** No endpoint matches the method and path (a typo or a guessed route); see `did_you_mean`. */
+    readonly ROUTE_NOT_FOUND: "ROUTE_NOT_FOUND";
     readonly VALIDATION_FAILED: "VALIDATION_FAILED";
     readonly RATE_LIMITED: "RATE_LIMITED";
     /** An idempotency key was reused with a different request (e.g. another unit or amount). */
@@ -78,6 +86,8 @@ export declare const AtlasErrorCodes: {
     readonly SESSION_IDLE_EXPIRED: "SESSION_IDLE_EXPIRED";
     readonly SESSION_EXPIRED: "SESSION_EXPIRED";
     readonly SCOPE_MISSING: "SCOPE_MISSING";
+    readonly INSUFFICIENT_SCOPE: "INSUFFICIENT_SCOPE";
+    readonly STEP_UP_REQUIRED: "STEP_UP_REQUIRED";
     readonly FORBIDDEN: "FORBIDDEN";
     readonly CONFLICT: "CONFLICT";
 };

package/dist/client/error.js

@@ -64,6 +64,8 @@ exports.AtlasErrorCodes = {
     /** The key is unknown, revoked or malformed. */
     INVALID_KEY: 'INVALID_KEY',
     NOT_FOUND: 'NOT_FOUND',
+    /** No endpoint matches the method and path (a typo or a guessed route); see `did_you_mean`. */
+    ROUTE_NOT_FOUND: 'ROUTE_NOT_FOUND',
     VALIDATION_FAILED: 'VALIDATION_FAILED',
     RATE_LIMITED: 'RATE_LIMITED',
     /** An idempotency key was reused with a different request (e.g. another unit or amount). */
@@ -74,6 +76,8 @@ exports.AtlasErrorCodes = {
     SESSION_IDLE_EXPIRED: 'SESSION_IDLE_EXPIRED',
     SESSION_EXPIRED: 'SESSION_EXPIRED',
     SCOPE_MISSING: 'SCOPE_MISSING',
+    INSUFFICIENT_SCOPE: 'INSUFFICIENT_SCOPE',
+    STEP_UP_REQUIRED: 'STEP_UP_REQUIRED',
     FORBIDDEN: 'FORBIDDEN',
     CONFLICT: 'CONFLICT',
 };

package/dist/client/error.js.map

@@ -1 +1 @@
-{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/client/error.ts"],"names":[],"mappings":";;;AAoBA,MAAa,aAAc,SAAQ,KAAK;IACpB,IAAI,GAAG,eAAe,CAAC;IACzC,0CAA0C;IACjC,MAAM,CAAS;IACxB,8CAA8C;IACrC,MAAM,CAAmB;IAElC,YAAY,MAAc,EAAE,MAAwB,EAAE,OAAgB;QACpE,KAAK,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,IAAI,wCAAwC,MAAM,EAAE,CAAC,CAAC;QACzF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,uEAAuE;QACvE,sEAAsE;QACtE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IAED,uEAAuE;IACvE,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IAC9B,CAAC;IAED,yEAAyE;IACzE,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAClD,CAAC;CACF;AAzBD,sCAyBC;AAED;;;;GAIG;AACU,QAAA,eAAe,GAAG;IAC7B,+EAA+E;IAC/E,6BAA6B,EAAE,+BAA+B;IAC9D,mEAAmE;IACnE,uBAAuB,EAAE,yBAAyB;IAClD,oGAAoG;IACpG,qBAAqB,EAAE,uBAAuB;IAC9C,oGAAoG;IACpG,qBAAqB,EAAE,uBAAuB;IAC9C,wGAAwG;IACxG,cAAc,EAAE,gBAAgB;IAChC,0FAA0F;IAC1F,aAAa,EAAE,eAAe;IAC9B,uIAAuI;IACvI,eAAe,EAAE,iBAAiB;IAClC,oFAAoF;IACpF,6BAA6B,EAAE,+BAA+B;IAC9D,8EAA8E;IAC9E,6BAA6B,EAAE,+BAA+B;IAC9D,6HAA6H;IAC7H,+BAA+B,EAAE,iCAAiC;IAClE,kGAAkG;IAClG,sCAAsC,EAAE,wCAAwC;IAChF,2GAA2G;IAC3G,wBAAwB,EAAE,0BAA0B;IACpD,2EAA2E;IAC3E,mBAAmB,EAAE,qBAAqB;IAC1C,oEAAoE;IACpE,WAAW,EAAE,aAAa;IAC1B,6FAA6F;IAC7F,iBAAiB,EAAE,mBAAmB;IACtC,gDAAgD;IAChD,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,iBAAiB,EAAE,mBAAmB;IACtC,YAAY,EAAE,cAAc;IAC5B,4FAA4F;IAC5F,oBAAoB,EAAE,sBAAsB;IAC5C,yFAAyF;IACzF,cAAc,EAAE,gBAAgB;IAChC,eAAe,EAAE,iBAAiB;IAClC,oBAAoB,EAAE,sBAAsB;IAC5C,eAAe,EAAE,iBAAiB;IAClC,aAAa,EAAE,eAAe;IAC9B,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;CACZ,CAAC"}
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../src/client/error.ts"],"names":[],"mappings":";;;AA0BA,MAAa,aAAc,SAAQ,KAAK;IACpB,IAAI,GAAG,eAAe,CAAC;IACzC,0CAA0C;IACjC,MAAM,CAAS;IACxB,8CAA8C;IACrC,MAAM,CAAmB;IAElC,YAAY,MAAc,EAAE,MAAwB,EAAE,OAAgB;QACpE,KAAK,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,IAAI,wCAAwC,MAAM,EAAE,CAAC,CAAC;QACzF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,uEAAuE;QACvE,sEAAsE;QACtE,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IAED,uEAAuE;IACvE,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC;IAC9B,CAAC;IAED,yEAAyE;IACzE,OAAO,CAAC,IAAY;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAClD,CAAC;CACF;AAzBD,sCAyBC;AAED;;;;GAIG;AACU,QAAA,eAAe,GAAG;IAC7B,+EAA+E;IAC/E,6BAA6B,EAAE,+BAA+B;IAC9D,mEAAmE;IACnE,uBAAuB,EAAE,yBAAyB;IAClD,oGAAoG;IACpG,qBAAqB,EAAE,uBAAuB;IAC9C,oGAAoG;IACpG,qBAAqB,EAAE,uBAAuB;IAC9C,wGAAwG;IACxG,cAAc,EAAE,gBAAgB;IAChC,0FAA0F;IAC1F,aAAa,EAAE,eAAe;IAC9B,uIAAuI;IACvI,eAAe,EAAE,iBAAiB;IAClC,oFAAoF;IACpF,6BAA6B,EAAE,+BAA+B;IAC9D,8EAA8E;IAC9E,6BAA6B,EAAE,+BAA+B;IAC9D,6HAA6H;IAC7H,+BAA+B,EAAE,iCAAiC;IAClE,kGAAkG;IAClG,sCAAsC,EAAE,wCAAwC;IAChF,2GAA2G;IAC3G,wBAAwB,EAAE,0BAA0B;IACpD,2EAA2E;IAC3E,mBAAmB,EAAE,qBAAqB;IAC1C,oEAAoE;IACpE,WAAW,EAAE,aAAa;IAC1B,6FAA6F;IAC7F,iBAAiB,EAAE,mBAAmB;IACtC,gDAAgD;IAChD,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,+FAA+F;IAC/F,eAAe,EAAE,iBAAiB;IAClC,iBAAiB,EAAE,mBAAmB;IACtC,YAAY,EAAE,cAAc;IAC5B,4FAA4F;IAC5F,oBAAoB,EAAE,sBAAsB;IAC5C,yFAAyF;IACzF,cAAc,EAAE,gBAAgB;IAChC,eAAe,EAAE,iBAAiB;IAClC,oBAAoB,EAAE,sBAAsB;IAC5C,eAAe,EAAE,iBAAiB;IAClC,aAAa,EAAE,eAAe;IAC9B,kBAAkB,EAAE,oBAAoB;IACxC,gBAAgB,EAAE,kBAAkB;IACpC,SAAS,EAAE,WAAW;IACtB,QAAQ,EAAE,UAAU;CACZ,CAAC"}