@atlasauth/backend 0.17.0 → 0.19.0

package/dist/client/policies.d.ts

@@ -0,0 +1,316 @@
+import { type RequestFn } from './request';
+/**
+ * Policy acceptance: the policies (Terms of Service, privacy policy, any key)
+ * your users accept at sign-up — and, per policy, again at sign-in when a new
+ * version takes effect. A policy's versions go draft → published (with an
+ * `effective_at`) → retired; a published version is immutable, and its
+ * `content_sha256` is the SHA-256 of the sanitised HTML users are shown.
+ * Acceptances are consent records carrying that hash and the reading evidence.
+ *
+ * Content can also come from any external system through the Atlas policy
+ * source protocol (`policySource`): Atlas fetches `GET {endpoint_url}/policies`
+ * signed like an Atlas webhook, and your system tells Atlas about a new
+ * version with a signed `policy.published` event.
+ */
+export type PolicyDisplay = 'checkbox' | 'scroll' | 'link';
+export type PolicyAppliesTo = 'sign_up' | 'sign_in_and_sign_up';
+export type PolicyReaccept = 'none' | 'next_sign_in' | 'grace';
+export interface PolicyVersionRef {
+    id: string;
+    version: string;
+    status: 'draft' | 'published' | 'retired' | (string & {});
+    content_sha256: string;
+    published_at: number | null;
+    effective_at: number | null;
+}
+export interface Policy {
+    object: 'policy';
+    id: string;
+    key: string;
+    title: string;
+    display: PolicyDisplay;
+    required: boolean;
+    applies_to: PolicyAppliesTo;
+    reaccept: PolicyReaccept;
+    grace_days: number | null;
+    source: 'atlas' | 'external';
+    position: number;
+    status: 'active' | 'retired';
+    /** External policies: fields changed in Atlas that a sync keeps. */
+    overrides: string[];
+    /** The version in effect now. */
+    current_version: PolicyVersionRef | null;
+    /** A newer published version that is not in effect yet. */
+    upcoming_version: PolicyVersionRef | null;
+    /** The newest version of any status (drafts included). */
+    latest_version: PolicyVersionRef | null;
+    retired_at: number | null;
+    created_at: number;
+    updated_at: number;
+}
+export interface PolicyVersion {
+    object: 'policy_version';
+    id: string;
+    policy_id: string;
+    policy: string;
+    version: string;
+    status: 'draft' | 'published' | 'retired';
+    content_markdown: string | null;
+    /** The sanitised HTML clients render. */
+    content_html: string;
+    content_url: string | null;
+    /** Hex SHA-256 of `content_html`. */
+    content_sha256: string;
+    summary_of_changes: string | null;
+    locale: string | null;
+    published_at: number | null;
+    effective_at: number | null;
+    retired_at: number | null;
+    created_at: number;
+    updated_at: number;
+    /** On list: how many users accepted this version. */
+    acceptance_count?: number;
+}
+export interface PolicyAcceptance {
+    object: 'policy_acceptance';
+    id: string;
+    user_id: string;
+    policy: string;
+    version: string;
+    policy_version_id: string | null;
+    status: 'accepted' | 'withdrawn';
+    source: 'signup' | 'signin' | 'reaccept' | 'api' | 'import' | (string & {}) | null;
+    content_sha256: string | null;
+    display: PolicyDisplay | null;
+    scrolled_to_end: boolean | null;
+    view_ms: number | null;
+    locale: string | null;
+    ip: string | null;
+    user_agent: string | null;
+    accepted_at: number;
+}
+export interface PolicyStanding {
+    object: 'policy_standing';
+    policy: string;
+    policy_id: string;
+    title: string;
+    display: PolicyDisplay;
+    required: boolean;
+    applies_to: PolicyAppliesTo;
+    reaccept: PolicyReaccept;
+    current_version_id: string | null;
+    current_version: string | null;
+    content_sha256: string | null;
+    summary_of_changes: string | null;
+    accepted_version_id: string | null;
+    accepted_version: string | null;
+    accepted_at: number | null;
+    needs_reaccept: boolean;
+    /** Accepting is required before the user's next sign-in completes. */
+    blocking: boolean;
+    grace_ends_at: number | null;
+}
+export interface CreatePolicyBody {
+    /** Slug, unique per instance (e.g. `tos`, `privacy`). Becomes the consent record's `policy`. */
+    key: string;
+    title: string;
+    display?: PolicyDisplay;
+    required?: boolean;
+    applies_to?: PolicyAppliesTo;
+    reaccept?: PolicyReaccept;
+    /** Required with `reaccept: 'grace'` (1–365). */
+    grace_days?: number | null;
+    position?: number;
+}
+export type UpdatePolicyBody = Partial<Omit<CreatePolicyBody, 'key'>> & {
+    status?: 'active' | 'retired';
+};
+export interface CreatePolicyVersionBody {
+    /** A label such as `2026-10-24` or `1.2.0`, unique per policy. */
+    version: string;
+    /** Markdown (rendered and sanitised by Atlas) — or `content_html`. */
+    content_markdown?: string;
+    content_html?: string;
+    content_url?: string | null;
+    summary_of_changes?: string | null;
+    locale?: string | null;
+    /** Publish immediately instead of saving a draft. */
+    publish?: boolean;
+    /** With `publish`: when the gate starts asking for it (epoch ms or ISO; default now). */
+    effective_at?: number | string;
+}
+export type UpdatePolicyVersionBody = Partial<Omit<CreatePolicyVersionBody, 'publish' | 'effective_at'>>;
+export interface ListPolicyAcceptancesParams {
+    /** A version id or label. */
+    version?: string;
+    /** `accepted` (default), `withdrawn` or `all`. */
+    status?: 'accepted' | 'withdrawn' | 'all';
+    limit?: number;
+    starting_after?: string;
+}
+export interface PolicyAcceptancePage {
+    object: 'list';
+    data: PolicyAcceptance[];
+    has_more: boolean;
+    next_cursor: string | null;
+}
+export interface PolicySettings {
+    object: 'policy_settings';
+    /** Put `pol` (accepted versions of required policies) on session tokens. */
+    session_claim: boolean;
+}
+export interface PolicySource {
+    object: 'policy_source';
+    enabled: boolean;
+    endpoint_url: string | null;
+    signing_secret_set: boolean;
+    sync: 'webhook' | 'poll';
+    poll_interval_minutes: number;
+    /** Where your source sends `policy.published` / `policy.retired` events. */
+    webhook_url: string | null;
+    protocol_version: string;
+    last_synced_at: number | null;
+    last_sync_ok: boolean | null;
+    last_sync_error: string | null;
+    next_poll_at: number | null;
+}
+export interface UpdatePolicySourceBody {
+    enabled?: boolean;
+    /** Base URL; Atlas calls `GET {endpoint_url}/policies`. */
+    endpoint_url?: string | null;
+    /** Write-only (a `whsec_` secret works). */
+    signing_secret?: string | null;
+    sync?: 'webhook' | 'poll';
+    /** Poll mode: 5–1440. */
+    poll_interval_minutes?: number;
+}
+export interface PolicySourceDelivery {
+    object: 'policy_source_delivery';
+    id: string;
+    direction: 'outbound' | 'inbound';
+    kind: 'fetch' | 'test' | 'poll' | 'webhook';
+    status: 'ok' | 'failed' | 'rejected';
+    http_status: number | null;
+    error: string | null;
+    event_type: string | null;
+    policy: string | null;
+    version: string | null;
+    url: string | null;
+    changes: Record<string, unknown> | null;
+    latency_ms: number | null;
+    created_at: number;
+}
+export interface PolicySourceTest {
+    object: 'policy_source_test';
+    ok: boolean;
+    http_status: number | null;
+    latency_ms: number | null;
+    error: string | null;
+    warnings: string[];
+    policies: Array<{
+        key: string;
+        title: string;
+        versions: string[];
+    }>;
+    delivery: PolicySourceDelivery;
+}
+export interface PolicySourceSync {
+    object: 'policy_source_sync';
+    ok: boolean;
+    error: string | null;
+    warnings: string[];
+    changes: {
+        created: string[];
+        updated: string[];
+        published: string[];
+        unchanged: string[];
+        rejected: string[];
+        retired: string[];
+    } | null;
+    delivery: PolicySourceDelivery;
+}
+export declare function policiesResource(request: RequestFn): {
+    /** `GET /v1/policies` — active policies (`include_retired` for all). */
+    list(params?: {
+        include_retired?: boolean;
+    }): Promise<{
+        object: "list";
+        data: Policy[];
+    }>;
+    /** `POST /v1/policies`. */
+    create(body: CreatePolicyBody): Promise<Policy>;
+    /** `GET /v1/policies/:id` — by id or key. */
+    get(idOrKey: string): Promise<Policy>;
+    /** `PATCH /v1/policies/:id`. */
+    update(idOrKey: string, body: UpdatePolicyBody): Promise<Policy>;
+    /** `DELETE /v1/policies/:id` — deletes a never-published policy, retires one with history. */
+    delete(idOrKey: string): Promise<{
+        object: "policy";
+        id: string;
+        key: string;
+        deleted: boolean;
+        retired: boolean;
+        policy?: Policy;
+    }>;
+    versions: {
+        list(idOrKey: string): Promise<{
+            object: "list";
+            data: PolicyVersion[];
+        }>;
+        /** `POST /v1/policies/:id/versions` — a draft (or published at once with `publish: true`). */
+        create(idOrKey: string, body: CreatePolicyVersionBody): Promise<PolicyVersion>;
+        get(idOrKey: string, versionIdOrLabel: string): Promise<PolicyVersion>;
+        /** Drafts only. */
+        update(idOrKey: string, versionIdOrLabel: string, body: UpdatePolicyVersionBody): Promise<PolicyVersion>;
+        /** Drafts only. */
+        delete(idOrKey: string, versionIdOrLabel: string): Promise<{
+            object: "policy_version";
+            id: string;
+            deleted: true;
+        }>;
+        /** `POST …/publish` — `effective_at` (epoch ms or ISO; default now) is when the gate starts asking for it. */
+        publish(idOrKey: string, versionIdOrLabel: string, body?: {
+            effective_at?: number | string;
+        }): Promise<PolicyVersion>;
+        retire(idOrKey: string, versionIdOrLabel: string): Promise<PolicyVersion>;
+    };
+    /** `GET /v1/policies/:id/acceptances` — who accepted, newest first. */
+    listAcceptances(idOrKey: string, params?: ListPolicyAcceptancesParams): Promise<PolicyAcceptancePage>;
+    /** The same as CSV (`format=csv`, up to 100,000 rows). */
+    exportAcceptancesCsv(idOrKey: string, params?: Omit<ListPolicyAcceptancesParams, "limit" | "starting_after">): Promise<string>;
+    /** `GET /v1/users/:id/policies` — a user's standing on every policy. */
+    forUser(userId: string): Promise<{
+        object: "list";
+        user_id: string;
+        data: PolicyStanding[];
+        needs_acceptance: boolean;
+    }>;
+    settings: {
+        get(): Promise<PolicySettings>;
+        update(body: {
+            session_claim?: boolean;
+        }): Promise<PolicySettings>;
+    };
+};
+export declare function policySourceResource(request: RequestFn): {
+    get(): Promise<PolicySource>;
+    /** `PUT /v1/instance/policy_source` — partial; `signing_secret` is write-only. */
+    update(body: UpdatePolicySourceBody): Promise<PolicySource>;
+    /** Disconnect the source (its policies and history stay). */
+    delete(): Promise<PolicySource>;
+    /** A signed fetch of the feed, validated but not stored. */
+    test(): Promise<PolicySourceTest>;
+    /** Fetch and store now. */
+    sync(): Promise<PolicySourceSync>;
+    listDeliveries(params?: {
+        limit?: number;
+        starting_after?: string;
+        kind?: string;
+        status?: string;
+    }): Promise<{
+        object: "list";
+        data: PolicySourceDelivery[];
+        has_more: boolean;
+        next_cursor: string | null;
+    }>;
+};

package/dist/client/policies.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.policiesResource = policiesResource;
+exports.policySourceResource = policySourceResource;
+const request_1 = require("./request");
+function policiesResource(request) {
+    return {
+        /** `GET /v1/policies` — active policies (`include_retired` for all). */
+        list(params = {}) {
+            return request({ method: 'GET', path: '/v1/policies', query: { ...params } });
+        },
+        /** `POST /v1/policies`. */
+        create(body) {
+            return request({ method: 'POST', path: '/v1/policies', body });
+        },
+        /** `GET /v1/policies/:id` — by id or key. */
+        get(idOrKey) {
+            return request({ method: 'GET', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}` });
+        },
+        /** `PATCH /v1/policies/:id`. */
+        update(idOrKey, body) {
+            return request({ method: 'PATCH', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}`, body });
+        },
+        /** `DELETE /v1/policies/:id` — deletes a never-published policy, retires one with history. */
+        delete(idOrKey) {
+            return request({ method: 'DELETE', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}` });
+        },
+        versions: {
+            list(idOrKey) {
+                return request({ method: 'GET', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/versions` });
+            },
+            /** `POST /v1/policies/:id/versions` — a draft (or published at once with `publish: true`). */
+            create(idOrKey, body) {
+                return request({ method: 'POST', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/versions`, body });
+            },
+            get(idOrKey, versionIdOrLabel) {
+                return request({ method: 'GET', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/versions/${(0, request_1.enc)(versionIdOrLabel)}` });
+            },
+            /** Drafts only. */
+            update(idOrKey, versionIdOrLabel, body) {
+                return request({ method: 'PATCH', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/versions/${(0, request_1.enc)(versionIdOrLabel)}`, body });
+            },
+            /** Drafts only. */
+            delete(idOrKey, versionIdOrLabel) {
+                return request({ method: 'DELETE', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/versions/${(0, request_1.enc)(versionIdOrLabel)}` });
+            },
+            /** `POST …/publish` — `effective_at` (epoch ms or ISO; default now) is when the gate starts asking for it. */
+            publish(idOrKey, versionIdOrLabel, body = {}) {
+                return request({ method: 'POST', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/versions/${(0, request_1.enc)(versionIdOrLabel)}/publish`, body });
+            },
+            retire(idOrKey, versionIdOrLabel) {
+                return request({ method: 'POST', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/versions/${(0, request_1.enc)(versionIdOrLabel)}/retire` });
+            },
+        },
+        /** `GET /v1/policies/:id/acceptances` — who accepted, newest first. */
+        listAcceptances(idOrKey, params = {}) {
+            return request({ method: 'GET', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/acceptances`, query: { ...params } });
+        },
+        /** The same as CSV (`format=csv`, up to 100,000 rows). */
+        exportAcceptancesCsv(idOrKey, params = {}) {
+            return request({ method: 'GET', path: `/v1/policies/${(0, request_1.enc)(idOrKey)}/acceptances`, query: { ...params, format: 'csv' }, raw: true });
+        },
+        /** `GET /v1/users/:id/policies` — a user's standing on every policy. */
+        forUser(userId) {
+            return request({ method: 'GET', path: `/v1/users/${(0, request_1.enc)(userId)}/policies` });
+        },
+        settings: {
+            get() {
+                return request({ method: 'GET', path: '/v1/instance/policy_settings' });
+            },
+            update(body) {
+                return request({ method: 'PATCH', path: '/v1/instance/policy_settings', body });
+            },
+        },
+    };
+}
+function policySourceResource(request) {
+    return {
+        get() {
+            return request({ method: 'GET', path: '/v1/instance/policy_source' });
+        },
+        /** `PUT /v1/instance/policy_source` — partial; `signing_secret` is write-only. */
+        update(body) {
+            return request({ method: 'PUT', path: '/v1/instance/policy_source', body });
+        },
+        /** Disconnect the source (its policies and history stay). */
+        delete() {
+            return request({ method: 'DELETE', path: '/v1/instance/policy_source' });
+        },
+        /** A signed fetch of the feed, validated but not stored. */
+        test() {
+            return request({ method: 'POST', path: '/v1/instance/policy_source/test' });
+        },
+        /** Fetch and store now. */
+        sync() {
+            return request({ method: 'POST', path: '/v1/instance/policy_source/sync' });
+        },
+        listDeliveries(params = {}) {
+            return request({ method: 'GET', path: '/v1/instance/policy_source/deliveries', query: { ...params } });
+        },
+    };
+}
+//# sourceMappingURL=policies.js.map

package/dist/client/policies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"policies.js","sourceRoot":"","sources":["../../src/client/policies.ts"],"names":[],"mappings":";;AA8OA,4CAsEC;AAED,oDA8BC;AApVD,uCAAgD;AA8OhD,SAAgB,gBAAgB,CAAC,OAAkB;IACjD,OAAO;QACL,wEAAwE;QACxE,IAAI,CAAC,SAAwC,EAAE;YAC7C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QAChF,CAAC;QACD,2BAA2B;QAC3B,MAAM,CAAC,IAAsB;YAC3B,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC;QACjE,CAAC;QACD,6CAA6C;QAC7C,GAAG,CAAC,OAAe;YACjB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1E,CAAC;QACD,gCAAgC;QAChC,MAAM,CAAC,OAAe,EAAE,IAAsB;YAC5C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAClF,CAAC;QACD,8FAA8F;QAC9F,MAAM,CAAC,OAAe;YACpB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,QAAQ,EAAE;YACR,IAAI,CAAC,OAAe;gBAClB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;YACnF,CAAC;YACD,8FAA8F;YAC9F,MAAM,CAAC,OAAe,EAAE,IAA6B;gBACnD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;YAC1F,CAAC;YACD,GAAG,CAAC,OAAe,EAAE,gBAAwB;gBAC3C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,aAAa,IAAA,aAAG,EAAC,gBAAgB,CAAC,EAAE,EAAE,CAAC,CAAC;YAC5G,CAAC;YACD,mBAAmB;YACnB,MAAM,CAAC,OAAe,EAAE,gBAAwB,EAAE,IAA6B;gBAC7E,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,aAAa,IAAA,aAAG,EAAC,gBAAgB,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YACpH,CAAC;YACD,mBAAmB;YACnB,MAAM,CAAC,OAAe,EAAE,gBAAwB;gBAC9C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,aAAa,IAAA,aAAG,EAAC,gBAAgB,CAAC,EAAE,EAAE,CAAC,CAAC;YAC/G,CAAC;YACD,8GAA8G;YAC9G,OAAO,CAAC,OAAe,EAAE,gBAAwB,EAAE,OAA2C,EAAE;gBAC9F,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,aAAa,IAAA,aAAG,EAAC,gBAAgB,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3H,CAAC;YACD,MAAM,CAAC,OAAe,EAAE,gBAAwB;gBAC9C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,aAAa,IAAA,aAAG,EAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC;YACpH,CAAC;SACF;QACD,uEAAuE;QACvE,eAAe,CAAC,OAAe,EAAE,SAAsC,EAAE;YACvE,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,cAAc,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QAC5G,CAAC;QACD,0DAA0D;QAC1D,oBAAoB,CAAC,OAAe,EAAE,SAAwE,EAAE;YAC9G,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,gBAAgB,IAAA,aAAG,EAAC,OAAO,CAAC,cAAc,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QACtI,CAAC;QACD,wEAAwE;QACxE,OAAO,CAAC,MAAc;YACpB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,IAAA,aAAG,EAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAC/E,CAAC;QACD,QAAQ,EAAE;YACR,GAAG;gBACD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,8BAA8B,EAAE,CAAC,CAAC;YAC1E,CAAC;YACD,MAAM,CAAC,IAAiC;gBACtC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,8BAA8B,EAAE,IAAI,EAAE,CAAC,CAAC;YAClF,CAAC;SACF;KACF,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAAC,OAAkB;IACrD,OAAO;QACL,GAAG;YACD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC,CAAC;QACxE,CAAC;QACD,kFAAkF;QAClF,MAAM,CAAC,IAA4B;YACjC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,4BAA4B,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,6DAA6D;QAC7D,MAAM;YACJ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,4BAA4B,EAAE,CAAC,CAAC;QAC3E,CAAC;QACD,4DAA4D;QAC5D,IAAI;YACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,iCAAiC,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,2BAA2B;QAC3B,IAAI;YACF,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,iCAAiC,EAAE,CAAC,CAAC;QAC9E,CAAC;QACD,cAAc,CAAC,SAAsF,EAAE;YAMrG,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,uCAAuC,EAAE,KAAK,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC;QACzG,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/client/privacy.d.ts

@@ -0,0 +1,127 @@
+import { type RequestFn } from './request';
+/**
+ * The data-rights executor protocol (v2) — the routes any DSAR orchestrator
+ * calls to find a person and carry out a request against their identity data
+ * (needs a key with `privacy:execute`) — and the instance's own data-rights
+ * orchestrator, where Atlas opens a case when an account deletion is scheduled
+ * (needs `instance:read` / `instance:write`).
+ */
+export type PrivacyCanonicalType = 'access' | 'deletion' | 'closure' | 'restriction' | 'rectification';
+export type PrivacyRequestStatus = 'pending' | 'scheduled' | 'processing' | 'completed' | 'completed_with_retention' | 'rejected' | 'no_match' | 'cancelled';
+export interface PrivacySubject {
+    iss?: string;
+    sub?: string;
+    ext?: string;
+    principal?: string;
+}
+export interface PrivacyLookupResult {
+    object: 'privacy_lookup';
+    status: 'found' | 'no_match';
+    subjectId: string | null;
+    matchedBy: 'atlas.sub' | 'atlas.ext' | 'email' | 'email_unverified' | null;
+    detail: string | null;
+    principal?: string;
+}
+export interface PrivacyRequest {
+    object: 'privacy_request';
+    id: string;
+    type: PrivacyCanonicalType;
+    canonicalType: PrivacyCanonicalType;
+    requestedType: string;
+    status: PrivacyRequestStatus;
+    subjectId: string;
+    caseId: string | null;
+    executeAfter: string | null;
+    eta: string | null;
+    detail: string | null;
+    retention: Array<{
+        category: string;
+        basis: string;
+        until: string;
+    }>;
+    steps: Array<{
+        name: string;
+        status: string;
+        reason?: string;
+        at?: number;
+    }>;
+    trace: string | null;
+    createdAt: string;
+    updatedAt: string;
+    completedAt: string | null;
+    /** On `getRequest` once done. */
+    result?: unknown;
+}
+export interface CreatePrivacyRequestBody {
+    subjectId: string;
+    type: PrivacyCanonicalType | 'export' | 'erasure' | 'erase';
+    caseId: string;
+    /** ISO 8601 or epoch ms: nothing is erased before it. */
+    executeAfter?: string | number;
+    reason?: string;
+}
+export interface PrivacyOrchestrator {
+    object: 'privacy_orchestrator';
+    configured: boolean;
+    enabled: boolean;
+    provider: string | null;
+    name: string | null;
+    case_url: string | null;
+    cancel_url: string | null;
+    auth_header: string;
+    auth_scheme: string;
+    api_key_set: boolean;
+    signing_secret_set: boolean;
+    use_partner_link: boolean;
+    open_closure_cases: boolean;
+    completion_webhook: Record<string, unknown> | null;
+    last_case_at: number | null;
+    last_error: string | null;
+    last_error_at: number | null;
+    presets: Array<Record<string, unknown>>;
+    /** Only on the write that minted it. */
+    signing_secret?: string;
+    /** Only on the write that created the completion endpoint. */
+    completion_webhook_secret?: string;
+}
+export interface PrivacyOrchestratorInput {
+    /** A preset id (`cookiemunch`, `custom`) or your own lower-case id. */
+    provider?: string;
+    name?: string;
+    enabled?: boolean;
+    case_url?: string | null;
+    /** Must contain `{id}`. */
+    cancel_url?: string | null;
+    auth_header?: string;
+    auth_scheme?: 'bearer' | 'raw';
+    api_key?: string | null;
+    /** Call through the partner link the orchestrator granted Atlas (partner id = provider). */
+    use_partner_link?: boolean;
+    open_closure_cases?: boolean;
+    sign_requests?: boolean;
+    completion_webhook_url?: string | null;
+}
+export declare function privacyResource(request: RequestFn): {
+    /** What this executor speaks (public). */
+    discover(): Promise<Record<string, unknown>>;
+    /** A ready-made orchestrator connection profile, e.g. `cookiemunch` (public). */
+    preset(id: string): Promise<Record<string, unknown>>;
+    /** Find a person: `atlas.sub` alone when present, then `atlas.ext`, then emails. */
+    lookup(body: {
+        emails?: string[];
+        atlas?: PrivacySubject;
+    }): Promise<PrivacyLookupResult>;
+    /** Open a request (or get the existing one for the same case). */
+    createRequest(body: CreatePrivacyRequestBody, idempotencyKey?: string): Promise<PrivacyRequest>;
+    getRequest(id: string): Promise<PrivacyRequest>;
+    /** Cancel before it runs: nothing is erased, the account stays. */
+    cancelRequest(id: string, idempotencyKey?: string): Promise<PrivacyRequest>;
+    orchestrator: {
+        get(): Promise<PrivacyOrchestrator>;
+        /** Connect or update; new secrets come back once. */
+        set(body: PrivacyOrchestratorInput): Promise<PrivacyOrchestrator>;
+        delete(): Promise<PrivacyOrchestrator & {
+            deleted: boolean;
+        }>;
+    };
+};

package/dist/client/privacy.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.privacyResource = privacyResource;
+const request_1 = require("./request");
+function privacyResource(request) {
+    return {
+        /** What this executor speaks (public). */
+        discover() {
+            return request({ method: 'GET', path: '/v1/privacy' });
+        },
+        /** A ready-made orchestrator connection profile, e.g. `cookiemunch` (public). */
+        preset(id) {
+            return request({ method: 'GET', path: `/v1/privacy/presets/${(0, request_1.enc)(id)}` });
+        },
+        /** Find a person: `atlas.sub` alone when present, then `atlas.ext`, then emails. */
+        lookup(body) {
+            return request({ method: 'POST', path: '/v1/privacy/lookup', body });
+        },
+        /** Open a request (or get the existing one for the same case). */
+        createRequest(body, idempotencyKey) {
+            return request({ method: 'POST', path: '/v1/privacy/requests', body, idempotencyKey });
+        },
+        getRequest(id) {
+            return request({ method: 'GET', path: `/v1/privacy/requests/${(0, request_1.enc)(id)}` });
+        },
+        /** Cancel before it runs: nothing is erased, the account stays. */
+        cancelRequest(id, idempotencyKey) {
+            return request({ method: 'POST', path: `/v1/privacy/requests/${(0, request_1.enc)(id)}/cancel`, idempotencyKey });
+        },
+        orchestrator: {
+            get() {
+                return request({ method: 'GET', path: '/v1/instance/privacy_orchestrator' });
+            },
+            /** Connect or update; new secrets come back once. */
+            set(body) {
+                return request({ method: 'PUT', path: '/v1/instance/privacy_orchestrator', body });
+            },
+            delete() {
+                return request({ method: 'DELETE', path: '/v1/instance/privacy_orchestrator' });
+            },
+        },
+    };
+}
+//# sourceMappingURL=privacy.js.map

package/dist/client/privacy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"privacy.js","sourceRoot":"","sources":["../../src/client/privacy.ts"],"names":[],"mappings":";;AA8GA,0CAsCC;AApJD,uCAAgD;AA8GhD,SAAgB,eAAe,CAAC,OAAkB;IAChD,OAAO;QACL,0CAA0C;QAC1C,QAAQ;YACN,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;QACzD,CAAC;QACD,iFAAiF;QACjF,MAAM,CAAC,EAAU;YACf,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,uBAAuB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC5E,CAAC;QACD,oFAAoF;QACpF,MAAM,CAAC,IAAmD;YACxD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;QACvE,CAAC;QACD,kEAAkE;QAClE,aAAa,CAAC,IAA8B,EAAE,cAAuB;YACnE,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,CAAC;QACzF,CAAC;QACD,UAAU,CAAC,EAAU;YACnB,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,wBAAwB,IAAA,aAAG,EAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC7E,CAAC;QACD,mEAAmE;QACnE,aAAa,CAAC,EAAU,EAAE,cAAuB;YAC/C,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,IAAA,aAAG,EAAC,EAAE,CAAC,SAAS,EAAE,cAAc,EAAE,CAAC,CAAC;QACrG,CAAC;QACD,YAAY,EAAE;YACZ,GAAG;gBACD,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAC,CAAC;YAC/E,CAAC;YACD,qDAAqD;YACrD,GAAG,CAAC,IAA8B;gBAChC,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,mCAAmC,EAAE,IAAI,EAAE,CAAC,CAAC;YACrF,CAAC;YACD,MAAM;gBACJ,OAAO,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,mCAAmC,EAAE,CAAC,CAAC;YAClF,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}