@atlasauth/backend 0.4.0 → 0.6.0

package/dist/client/connectors.d.ts

@@ -0,0 +1,174 @@
+import { type RequestFn } from './request';
+/** How an installing instance gets OAuth credentials for a connector. */
+export type ConnectorShareMode = 'prefill' | 'full_shared' | 'full_idp';
+/**
+ * A community connector profile you publish to the connector directory: its
+ * public listing, OAuth config and share modes. The shared client secret is
+ * never returned.
+ */
+export interface CommunityConnector {
+    object: 'connector';
+    id: string;
+    slug: string;
+    display_name: string;
+    logo_url?: string | null;
+    tagline?: string | null;
+    description?: string | null;
+    category: string;
+    tags: unknown[];
+    website_url?: string | null;
+    docs_url?: string | null;
+    support_url?: string | null;
+    setup_guide?: string | null;
+    protocol: string;
+    authorization_endpoint?: string | null;
+    token_endpoint?: string | null;
+    userinfo_endpoint?: string | null;
+    issuer?: string | null;
+    default_scopes: string[];
+    api_scopes?: unknown[];
+    credential_fields?: unknown[];
+    share_modes: ConnectorShareMode[];
+    shared_client_id?: string | null;
+    shared_revoked: boolean;
+    idp_issuer?: string | null;
+    idp_auto_register: boolean;
+    status: 'draft' | 'published' | 'unlisted' | 'banned';
+    verified: boolean;
+    featured: boolean;
+    install_count: number;
+    view_count: number;
+    rating_avg: number;
+    rating_count: number;
+    /** Epoch ms. */
+    created_at: number;
+    /** Epoch ms. */
+    updated_at: number;
+}
+/** Fields of a connector profile you can set on create or update. */
+export interface UpdateCommunityConnectorBody {
+    slug?: string;
+    display_name?: string;
+    logo_url?: string;
+    tagline?: string;
+    description?: string;
+    category?: string;
+    tags?: string[];
+    website_url?: string;
+    docs_url?: string;
+    support_url?: string;
+    screenshots?: unknown[];
+    setup_guide?: string;
+    protocol?: string;
+    authorization_endpoint?: string;
+    token_endpoint?: string;
+    userinfo_endpoint?: string;
+    issuer?: string;
+    default_scopes?: string[];
+    api_scopes?: unknown[];
+    credential_fields?: unknown[];
+    authorization_params?: Record<string, unknown>;
+    quirks?: Record<string, unknown>;
+    share_modes?: ConnectorShareMode[];
+    idp_instance_id?: string;
+    idp_issuer?: string;
+    idp_auto_register?: boolean;
+}
+/** `slug` is globally unique and may not shadow a built-in provider. */
+export interface CreateCommunityConnectorBody extends UpdateCommunityConnectorBody {
+    slug: string;
+    display_name: string;
+}
+/** Set or rotate (`client_id` + `client_secret`) or revoke (`revoke: true`) the full_shared credentials. */
+export interface ConnectorSharedCredentialsBody {
+    client_id?: string;
+    client_secret?: string;
+    revoke?: boolean;
+}
+export interface InstallConnectorBody {
+    share_mode: ConnectorShareMode;
+    /** Your own credentials (prefill mode). */
+    client_id?: string;
+    client_secret?: string;
+    scopes?: string[];
+}
+export interface ConnectorInstall {
+    object: 'connector_install';
+    connector: string;
+    share_mode: string;
+    provider_key?: string;
+    /** True when the install still needs your own client credentials. */
+    needs_credentials?: boolean;
+}
+export interface ConnectorReview {
+    object: 'connector_review';
+    connector: string;
+    rating: number;
+}
+/** A directory entry (built-in provider or community connector). Keys are camelCase. */
+export interface ConnectorDirectoryEntry {
+    source: 'builtin' | 'community';
+    key: string;
+    slug: string;
+    displayName: string;
+    category: string;
+    tagline?: string | null;
+    description?: string | null;
+    logoUrl?: string | null;
+    websiteUrl?: string | null;
+    docsUrl?: string | null;
+    verified?: boolean;
+    featured?: boolean;
+    installCount?: number;
+    ratingAvg?: number;
+    ratingCount?: number;
+    rankScore?: number;
+    defaultScopes?: string[];
+    apiScopes?: unknown[];
+    credentialFields?: unknown[];
+    shareModes?: string[];
+}
+export interface ConnectorDirectoryParams {
+    category?: string;
+    /** Only verified community connectors. */
+    verified?: boolean;
+    /** Free-text search. */
+    q?: string;
+    limit?: number;
+    offset?: number;
+}
+export declare function connectorsResource(request: RequestFn): {
+    /** Your own connector profiles (draft and published). */
+    list(): Promise<{
+        object: "list";
+        data: CommunityConnector[];
+        has_more: false;
+    }>;
+    create(body: CreateCommunityConnectorBody, idempotencyKey?: string): Promise<CommunityConnector>;
+    get(id: string): Promise<CommunityConnector>;
+    update(id: string, body: UpdateCommunityConnectorBody): Promise<CommunityConnector>;
+    /** Deletes the profile and its installs, reviews and reports. */
+    delete(id: string): Promise<{
+        object: "connector";
+        id: string;
+        deleted: true;
+    }>;
+    /** List it in the public directory (unverified until reviewed). */
+    publish(id: string): Promise<CommunityConnector>;
+    /** Take it out of the directory without deleting it. */
+    unlist(id: string): Promise<CommunityConnector>;
+    /** Set, rotate or revoke the full_shared credentials. Revoking stops every install. */
+    setSharedCredentials(id: string, body: ConnectorSharedCredentialsBody): Promise<CommunityConnector>;
+    /** Enable a published connector (by slug) on this instance. */
+    install(slug: string, body: InstallConnectorBody): Promise<ConnectorInstall>;
+    /** Rate a connector you installed, 1–5, with optional text. */
+    review(slug: string, body: {
+        rating: number;
+        body?: string;
+    }): Promise<ConnectorReview>;
+    /** Browse built-in providers plus published community connectors, popular first. */
+    directory(params?: ConnectorDirectoryParams): Promise<{
+        object: "list";
+        data: ConnectorDirectoryEntry[];
+    }>;
+};

package/dist/client/connectors.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connectorsResource = connectorsResource;
+const request_1 = require("./request");
+function connectorsResource(request) {
+    return {
+        /** Your own connector profiles (draft and published). */
+        list() {
+            return request({ method: 'GET', path: '/v1/connectors' });
+        },
+        create(body, idempotencyKey) {
+            return request({ method: 'POST', path: '/v1/connectors', body, idempotencyKey });
+        },
+        get(id) {
+            return request({ method: 'GET', path: `/v1/connectors/${(0, request_1.enc)(id)}` });
+        },
+        update(id, body) {
+            return request({ method: 'PATCH', path: `/v1/connectors/${(0, request_1.enc)(id)}`, body });
+        },
+        /** Deletes the profile and its installs, reviews and reports. */
+        delete(id) {
+            return request({ method: 'DELETE', path: `/v1/connectors/${(0, request_1.enc)(id)}` });
+        },
+        /** List it in the public directory (unverified until reviewed). */
+        publish(id) {
+            return request({ method: 'POST', path: `/v1/connectors/${(0, request_1.enc)(id)}/publish` });
+        },
+        /** Take it out of the directory without deleting it. */
+        unlist(id) {
+            return request({ method: 'POST', path: `/v1/connectors/${(0, request_1.enc)(id)}/unlist` });
+        },
+        /** Set, rotate or revoke the full_shared credentials. Revoking stops every install. */
+        setSharedCredentials(id, body) {
+            return request({
+                method: 'POST',
+                path: `/v1/connectors/${(0, request_1.enc)(id)}/shared_credentials`,
+                body,
+            });
+        },
+        /** Enable a published connector (by slug) on this instance. */
+        install(slug, body) {
+            return request({ method: 'POST', path: `/v1/connectors/${(0, request_1.enc)(slug)}/install`, body });
+        },
+        /** Rate a connector you installed, 1–5, with optional text. */
+        review(slug, body) {
+            return request({ method: 'POST', path: `/v1/connectors/${(0, request_1.enc)(slug)}/reviews`, body });
+        },
+        /** Browse built-in providers plus published community connectors, popular first. */
+        directory(params = {}) {
+            return request({ method: 'GET', path: '/v1/directory', query: { ...params } });
+        },
+    };
+}
+//# sourceMappingURL=connectors.js.map

package/dist/client/connectors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectors.js","sourceRoot":"","sources":["../../src/client/connectors.ts"],"names":[],"mappings":";;AAsJA,gDAwDC;AA9MD,uCAAgD;AAsJhD,SAAgB,kBAAkB,CAAC,OAAkB;IACnD,OAAO;QACL,yDAAyD;QACzD,IAAI;YACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAC5D,CAAC;QACD,MAAM,CACJ,IAAkC,EAClC,cAAuB;YAEvB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QACnF,CAAC;QACD,GAAG,CAAC,EAAU;YACZ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,kBAAkB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,CAAC,EAAU,EAAE,IAAkC;YACnD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,kBAAkB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,iEAAiE;QACjE,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,kBAAkB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1E,CAAC;QACD,mEAAmE;QACnE,OAAO,CAAC,EAAU;YAChB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,IAAA,aAAG,EAAC,EAAE,CAAC,UAAU,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,wDAAwD;QACxD,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,IAAA,aAAG,EAAC,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,uFAAuF;QACvF,oBAAoB,CAClB,EAAU,EACV,IAAoC;YAEpC,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,kBAAkB,IAAA,aAAG,EAAC,EAAE,CAAC,qBAAqB;gBACpD,IAAI;aACL,CAAC,CAAC;QACL,CAAC;QACD,+DAA+D;QAC/D,OAAO,CAAC,IAAY,EAAE,IAA0B;YAC9C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,IAAA,aAAG,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QACxF,CAAC;QACD,+DAA+D;QAC/D,MAAM,CAAC,IAAY,EAAE,IAAuC;YAC1D,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,IAAA,aAAG,EAAC,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;QACxF,CAAC;QACD,oFAAoF;QACpF,SAAS,CACP,SAAmC,EAAE;YAErC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QACjF,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/client/data-subject-requests.d.ts

@@ -17,6 +17,8 @@ export interface DataSubjectRequest {
     requested_by_id: string | null;
     reason: string | null;
     scheduled_for: number | null;
+    /** Estimated completion (epoch ms): an erasure's grace deadline; null for an export. */
+    eta?: number | null;
     requested_at: number;
     updated_at: number;
     completed_at: number | null;
@@ -28,7 +30,26 @@ export interface ListDataSubjectRequestsParams extends CursorParams {
     status?: string;
     user_id?: string;
 }
+/** Identify the subject by `user_id` OR `subject_email` (`user_id` wins if both are given). */
+export interface CreateDataSubjectRequestBody {
+    type: 'export' | 'erasure';
+    user_id?: string;
+    /** The subject's email (verified, else unverified), resolved to the user. */
+    subject_email?: string;
+    reason?: string;
+}
 export declare function dataSubjectRequestsResource(request: RequestFn): {
+    /**
+     * Open an export or erasure request for a user from the backend. Same worker,
+     * grace window and webhooks as the self-service flow; idempotent on an
+     * in-flight request.
+     */
+    create(body: CreateDataSubjectRequestBody, idempotencyKey?: string): Promise<DataSubjectRequest>;
+    /**
+     * Cancel a scheduled erasure inside its grace window. Once processing or
+     * terminal it is a 409; exports are not cancellable.
+     */
+    cancel(id: string): Promise<DataSubjectRequest>;
     list(params?: ListDataSubjectRequestsParams): Promise<CursorPage<DataSubjectRequest>>;
     get(id: string): Promise<DataSubjectRequest>;
     /** Fulfil a request now — build the export package, or run the erasure — ahead of schedule. */

package/dist/client/data-subject-requests.js

@@ -4,6 +4,21 @@ exports.dataSubjectRequestsResource = dataSubjectRequestsResource;
 const request_1 = require("./request");
 function dataSubjectRequestsResource(request) {
     return {
+        /**
+         * Open an export or erasure request for a user from the backend. Same worker,
+         * grace window and webhooks as the self-service flow; idempotent on an
+         * in-flight request.
+         */
+        create(body, idempotencyKey) {
+            return request({ method: 'POST', path: '/v1/data_subject_requests', body, idempotencyKey });
+        },
+        /**
+         * Cancel a scheduled erasure inside its grace window. Once processing or
+         * terminal it is a 409; exports are not cancellable.
+         */
+        cancel(id) {
+            return request({ method: 'POST', path: `/v1/data_subject_requests/${(0, request_1.enc)(id)}/cancel` });
+        },
         list(params = {}) {
             return request({ method: 'GET', path: '/v1/data_subject_requests', query: { ...params } });
         },

package/dist/client/data-subject-requests.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-subject-requests.js","sourceRoot":"","sources":["../../src/client/data-subject-requests.ts"],"names":[],"mappings":";;AAiCA,kEAgCC;AAjED,uCAAgD;AAiChD,SAAgB,2BAA2B,CAAC,OAAkB;IAC5D,OAAO;QACL,IAAI,CACF,SAAwC,EAAE;YAE1C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,2BAA2B,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,GAAG,CAAC,EAAU;YACZ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,+FAA+F;QAC/F,OAAO,CAAC,EAAU,EAAE,cAAuB;YACzC,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,UAAU;gBACpD,cAAc;aACf,CAAC,CAAC;QACL,CAAC;QACD,oFAAoF;QACpF,MAAM,CACJ,EAAU,EACV,OAA4B,EAAE,EAC9B,cAAuB;YAEvB,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,SAAS;gBACnD,IAAI;gBACJ,cAAc;aACf,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"data-subject-requests.js","sourceRoot":"","sources":["../../src/client/data-subject-requests.ts"],"names":[],"mappings":";;AA4CA,kEAkDC;AA9FD,uCAAgD;AA4ChD,SAAgB,2BAA2B,CAAC,OAAkB;IAC5D,OAAO;QACL;;;;WAIG;QACH,MAAM,CACJ,IAAkC,EAClC,cAAuB;YAEvB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,2BAA2B,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QAC9F,CAAC;QACD;;;WAGG;QACH,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,CACF,SAAwC,EAAE;YAE1C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,2BAA2B,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QAC7F,CAAC;QACD,GAAG,CAAC,EAAU;YACZ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,+FAA+F;QAC/F,OAAO,CAAC,EAAU,EAAE,cAAuB;YACzC,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,UAAU;gBACpD,cAAc;aACf,CAAC,CAAC;QACL,CAAC;QACD,oFAAoF;QACpF,MAAM,CACJ,EAAU,EACV,OAA4B,EAAE,EAC9B,cAAuB;YAEvB,OAAO,OAAO,CAAC;gBACb,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,6BAA6B,IAAA,aAAG,EAAC,EAAE,CAAC,SAAS;gBACnD,IAAI;gBACJ,cAAc;aACf,CAAC,CAAC;QACL,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/client/design.d.ts

@@ -0,0 +1,295 @@
+import { type RequestFn } from './request';
+import type { ListPage } from './types';
+/**
+ * The structured sign-in page design, shared by the instance's hosted pages,
+ * per-organization overrides and Sign in with Atlas app pages.
+ *
+ * Every leaf is a closed set of values, a bounded number, a `#RRGGBB` hex colour,
+ * a catalog id (preset, font) or an uploaded image id (`dasset_…`) — there is no
+ * field for CSS, HTML or arbitrary URLs. A stored design is a set of OVERRIDES:
+ * every section and field is optional and falls back to the chosen preset, then
+ * the defaults. Unknown keys are refused by the API with their full path.
+ */
+export type DesignHexColor = string;
+export type DesignPresetId = 'minimal' | 'atlas' | 'glass' | 'midnight' | 'editorial' | 'terminal' | 'sunrise' | 'forest' | 'grape' | 'slate' | 'split-photo' | 'bold';
+export type DesignColorScheme = 'auto' | 'light' | 'dark';
+export type DesignTypeScale = 'minor-second' | 'major-second' | 'minor-third' | 'major-third' | 'perfect-fourth' | 'augmented-fourth' | 'perfect-fifth' | 'golden' | 'minor-seventh' | 'octave';
+export type DesignImagePosition = 'top-left' | 'top' | 'top-right' | 'left' | 'center' | 'right' | 'bottom-left' | 'bottom' | 'bottom-right';
+/** Colour slots, each a `#RRGGBB` hex. */
+export interface DesignPalette {
+    primary?: DesignHexColor;
+    /** Text/icon colour on a primary fill (button label). */
+    primaryInk?: DesignHexColor;
+    accent?: DesignHexColor;
+    background?: DesignHexColor;
+    surface?: DesignHexColor;
+    text?: DesignHexColor;
+    muted?: DesignHexColor;
+    border?: DesignHexColor;
+    danger?: DesignHexColor;
+    success?: DesignHexColor;
+    inputBackground?: DesignHexColor;
+    inputText?: DesignHexColor;
+}
+export interface DesignTypography {
+    /** A font id from the design catalog (`design.catalog().fonts`). */
+    font?: string;
+    headingFont?: string;
+    /** Body text size in px (12–20). */
+    baseSize?: number;
+    /** 400–800, in steps of 100. */
+    headingWeight?: number;
+    /** 300–600, in steps of 100. */
+    bodyWeight?: number;
+    /** Letter case of button labels. */
+    letterCase?: 'none' | 'uppercase';
+    scale?: DesignTypeScale;
+}
+export interface DesignShape {
+    /** Card corner radius, px (0–32). */
+    radius?: number;
+    /** Button + input corner radius, px (0–999; 999 = pill). */
+    controlRadius?: number;
+    /** 0–3 px. */
+    borderWidth?: number;
+}
+export interface DesignElevation {
+    cardShadow?: 'none' | 'sm' | 'md' | 'lg' | 'xl';
+}
+export interface DesignSpacing {
+    density?: 'compact' | 'comfortable' | 'spacious';
+}
+export interface DesignCard {
+    style?: 'solid' | 'glass' | 'outline' | 'none';
+    /** Backdrop blur, px (0–40). Only applied when `style` is `glass`. */
+    blur?: number;
+    width?: 'narrow' | 'normal' | 'wide';
+}
+export interface DesignLayout {
+    position?: 'center' | 'left' | 'right' | 'split';
+    /** Which side the image panel sits on. Only applied when `position` is `split`. */
+    splitImageSide?: 'left' | 'right';
+    /** `hidden` is refused on Sign in with Atlas app pages. */
+    logoPlacement?: 'card' | 'page' | 'hidden';
+    logoSize?: 'sm' | 'md' | 'lg';
+}
+export interface DesignButtons {
+    style?: 'solid' | 'outline' | 'soft' | 'gradient';
+    socialLayout?: 'list' | 'grid' | 'icons';
+}
+export interface DesignInputs {
+    style?: 'outline' | 'filled' | 'underline';
+}
+export interface DesignGradient {
+    type: 'linear' | 'radial';
+    /** Degrees (0–360); linear only. */
+    angle?: number;
+    /** 2–4 stops; `at` is a percentage (0–100). */
+    stops: Array<{
+        color: DesignHexColor;
+        at: number;
+    }>;
+}
+export interface DesignBackgroundImage {
+    /** An uploaded background image (`dasset_…`). */
+    assetId: string;
+    fit?: 'cover' | 'contain';
+    position?: DesignImagePosition;
+    /** `opacity` is 0–1. */
+    overlay?: {
+        color: DesignHexColor;
+        opacity: number;
+    };
+    /** 0–20 px. */
+    blur?: number;
+}
+/**
+ * A page background: a colour, a gradient, an uploaded image and a pattern,
+ * painted bottom to top. Setting `background` replaces the preset's background
+ * as a whole.
+ */
+export interface DesignBackground {
+    color?: DesignHexColor;
+    gradient?: DesignGradient;
+    image?: DesignBackgroundImage;
+    pattern?: 'none' | 'dots' | 'grid' | 'noise';
+}
+export interface DesignLogo {
+    /** Uploaded logo for light mode (`dasset_…`). */
+    assetId?: string;
+    /** Uploaded logo for dark mode; falls back to `assetId`. */
+    darkAssetId?: string;
+}
+/** A stored design: overrides on top of a preset. Every field is optional. */
+export interface AtlasDesign {
+    version?: 1;
+    preset?: DesignPresetId;
+    colorScheme?: DesignColorScheme;
+    palette?: DesignPalette;
+    paletteDark?: DesignPalette;
+    typography?: DesignTypography;
+    shape?: DesignShape;
+    elevation?: DesignElevation;
+    spacing?: DesignSpacing;
+    card?: DesignCard;
+    layout?: DesignLayout;
+    buttons?: DesignButtons;
+    inputs?: DesignInputs;
+    background?: DesignBackground;
+    backgroundDark?: DesignBackground;
+    logo?: DesignLogo;
+}
+type DeepPatch<T> = {
+    [K in keyof T]?: NonNullable<T[K]> extends readonly unknown[] ? T[K] | null : NonNullable<T[K]> extends object ? DeepPatch<NonNullable<T[K]>> | null : T[K] | null;
+};
+/**
+ * A partial design update: nested objects merge, arrays (gradient stops) and
+ * values replace, and `null` removes a setting (falling back to the preset).
+ */
+export type AtlasDesignPatch = DeepPatch<AtlasDesign>;
+/** The fully resolved design every surface renders (defaults ← preset ← overrides). */
+export interface ResolvedAtlasDesign {
+    version: 1;
+    preset: DesignPresetId;
+    colorScheme: DesignColorScheme;
+    palette: Required<DesignPalette>;
+    paletteDark: Required<DesignPalette>;
+    typography: Required<DesignTypography>;
+    shape: Required<DesignShape>;
+    elevation: Required<DesignElevation>;
+    spacing: Required<DesignSpacing>;
+    card: Required<DesignCard>;
+    layout: Required<DesignLayout>;
+    buttons: Required<DesignButtons>;
+    inputs: Required<DesignInputs>;
+    background: DesignBackground;
+    backgroundDark: DesignBackground;
+    logo: DesignLogo;
+}
+/** A colour pair that fails its contrast target. */
+export interface DesignWarning {
+    code: 'low_contrast';
+    mode: 'light' | 'dark';
+    pair: string[];
+    ratio: number;
+    required: number;
+    /** The setting to change, e.g. `palette.primaryInk`. */
+    path: string;
+    message: string;
+}
+/** A stored design (instance or organization) with its resolved result. */
+export interface DesignSettings {
+    object: 'design' | 'organization_design';
+    /** Organization designs only. */
+    organization_id?: string;
+    design: AtlasDesign;
+    resolved: ResolvedAtlasDesign;
+    warnings: DesignWarning[];
+    /** True when nothing is stored and the page is drawn from the older branding settings. */
+    legacy: boolean;
+    /** When `legacy`: the design derived from the older branding settings. */
+    legacy_design?: AtlasDesign | null;
+}
+/** A compiled, unsaved design. Nothing is stored. */
+export interface DesignPreview {
+    object: 'design_preview';
+    /** The selector the CSS is scoped to: `.atlas-root`. */
+    scope: string;
+    /** CSS custom properties (`--atlas-*`) for the scope, including light/dark blocks. */
+    css: string;
+    /** Attributes to set on the scoped element (`data-atlas-layout`, …). */
+    data_attributes: Record<string, string>;
+    /** Absolute URLs of the self-hosted font stylesheets to link. */
+    font_stylesheets: string[];
+    resolved: ResolvedAtlasDesign;
+    warnings: DesignWarning[];
+    /** The sign-in page rendered with the draft design (inert, for a sandboxed frame). */
+    html: string;
+}
+export type DesignAssetKind = 'background' | 'logo';
+/** An uploaded design image. Use `asset_id` in a design (`logo.assetId`, …). */
+export interface DesignAsset {
+    object: 'design_asset';
+    /** `dasset_…` */
+    asset_id: string;
+    kind: DesignAssetKind;
+    /** Where Atlas serves the stored image. */
+    url: string;
+    width: number;
+    height: number;
+    /** `#rrggbb` for an opaque image, else null. */
+    dominant_color: string | null;
+    /** Size of the stored (WebP) image. */
+    bytes: number;
+    created_at: string;
+}
+export interface DeletedDesignAsset {
+    object: 'design_asset';
+    asset_id: string;
+    deleted: true;
+}
+/** Image bytes to upload: PNG, JPEG, GIF or WebP, up to 8 MB and 40 megapixels. */
+export type DesignAssetData = Blob | ArrayBuffer | ArrayBufferView;
+export interface UploadDesignAssetOptions {
+    /** What the image is for (default `background`). */
+    kind?: DesignAssetKind;
+    /** e.g. `image/png`. Required unless `data` is a Blob with a type. */
+    contentType?: string;
+}
+/** The public design-system catalog: presets, curated fonts and CSS variables. */
+export interface DesignCatalog {
+    object: 'design_catalog';
+    version: 1;
+    presets: Array<{
+        id: DesignPresetId;
+        label: string;
+        description: string;
+        resolved: ResolvedAtlasDesign;
+    }>;
+    fonts: Array<{
+        id: string;
+        label: string;
+        family: string | null;
+        category: string;
+        web_font: boolean;
+        stylesheet: string | null;
+    }>;
+    css_variables: Array<{
+        name: string;
+        type: string;
+        perMode?: boolean;
+        description: string;
+    }>;
+}
+export declare function designResource(request: RequestFn): {
+    /** The instance's sign-in page design: stored overrides, resolved design, warnings. */
+    get(): Promise<DesignSettings>;
+    /** Replace the whole instance design. */
+    replace(design: AtlasDesign): 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. */
+    preview(design: AtlasDesign): Promise<DesignPreview>;
+    /** Per-organization design overrides, layered over the instance design. */
+    organizations: {
+        get(organizationId: string): Promise<DesignSettings>;
+        /** Replace the override; `{}` removes it. */
+        replace(organizationId: string, design: AtlasDesign): Promise<DesignSettings>;
+        update(organizationId: string, design: AtlasDesignPatch): Promise<DesignSettings>;
+    };
+    /** The instance's uploaded design images. */
+    assets: {
+        /**
+         * Upload a background or logo image as raw bytes. Atlas checks it,
+         * re-encodes it as WebP and serves it.
+         */
+        upload(data: DesignAssetData, options?: UploadDesignAssetOptions): Promise<DesignAsset>;
+        /** Newest first (up to 100). */
+        list(): Promise<ListPage<DesignAsset>>;
+        /** Refused with 409 (`meta.used_by`) while a saved design still uses it. */
+        delete(assetId: string): Promise<DeletedDesignAsset>;
+    };
+    /** The public catalog: presets (resolved), curated fonts, the CSS variable set. */
+    catalog(): Promise<DesignCatalog>;
+};
+export {};

package/dist/client/design.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.designResource = designResource;
+const request_1 = require("./request");
+function designResource(request) {
+    return {
+        /** The instance's sign-in page design: stored overrides, resolved design, warnings. */
+        get() {
+            return request({ method: 'GET', path: '/v1/instance/design' });
+        },
+        /** Replace the whole instance design. */
+        replace(design) {
+            return request({ method: 'PUT', path: '/v1/instance/design', body: { design } });
+        },
+        /** Change part of the instance design; `null` removes a setting. */
+        update(design) {
+            return request({ method: 'PATCH', path: '/v1/instance/design', body: { design } });
+        },
+        /** Compile an unsaved design (CSS, attributes, fonts, rendered page). Nothing is saved. */
+        preview(design) {
+            return request({ method: 'POST', path: '/v1/instance/design/preview', body: { design } });
+        },
+        /** Per-organization design overrides, layered over the instance design. */
+        organizations: {
+            get(organizationId) {
+                return request({
+                    method: 'GET',
+                    path: `/v1/organizations/${(0, request_1.enc)(organizationId)}/design`,
+                });
+            },
+            /** Replace the override; `{}` removes it. */
+            replace(organizationId, design) {
+                return request({
+                    method: 'PUT',
+                    path: `/v1/organizations/${(0, request_1.enc)(organizationId)}/design`,
+                    body: { design },
+                });
+            },
+            update(organizationId, design) {
+                return request({
+                    method: 'PATCH',
+                    path: `/v1/organizations/${(0, request_1.enc)(organizationId)}/design`,
+                    body: { design },
+                });
+            },
+        },
+        /** The instance's uploaded design images. */
+        assets: {
+            /**
+             * Upload a background or logo image as raw bytes. Atlas checks it,
+             * re-encodes it as WebP and serves it.
+             */
+            upload(data, options = {}) {
+                return request({
+                    method: 'POST',
+                    path: '/v1/design/assets',
+                    query: { kind: options.kind },
+                    rawBody: { data, contentType: options.contentType },
+                });
+            },
+            /** Newest first (up to 100). */
+            list() {
+                return request({ method: 'GET', path: '/v1/design/assets' });
+            },
+            /** Refused with 409 (`meta.used_by`) while a saved design still uses it. */
+            delete(assetId) {
+                return request({ method: 'DELETE', path: `/v1/design/assets/${(0, request_1.enc)(assetId)}` });
+            },
+        },
+        /** The public catalog: presets (resolved), curated fonts, the CSS variable set. */
+        catalog() {
+            return request({ method: 'GET', path: '/v1/design/catalog' });
+        },
+    };
+}
+//# sourceMappingURL=design.js.map

package/dist/client/design.js.map

@@ -0,0 +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"}