@cubist-labs/cubesigner-sdk 0.2.28 → 0.3.8

package/dist/cjs/src/org.d.ts

@@ -0,0 +1,99 @@
+import { CubeSignerClient } from "./client";
+import { OrgInfo, SignerSessionManager, SignerSessionStorage } from ".";
+/** Organization id */
+export type OrgId = string;
+/** Org-wide policy */
+export type OrgPolicy = SourceIpAllowlistPolicy | OidcAuthSourcesPolicy | OriginAllowlistPolicy | MaxDailyUnstakePolicy;
+/**
+ * Provides an allowlist of OIDC Issuers and audiences that are allowed to authenticate into this org.
+ * @example {"OidcAuthSources": { "https://accounts.google.com": [ "1234.apps.googleusercontent.com" ]}}
+ */
+export interface OidcAuthSourcesPolicy {
+    OidcAuthSources: Record<string, string[]>;
+}
+/**
+ * Only allow requests from the specified origins.
+ * @example {"OriginAllowlist": "*"}
+ */
+export interface OriginAllowlistPolicy {
+    OriginAllowlist: string[] | "*";
+}
+/**
+ * Restrict signing to specific source IP addresses.
+ * @example {"SourceIpAllowlist": ["10.1.2.3/8", "169.254.17.1/16"]}
+ */
+export interface SourceIpAllowlistPolicy {
+    SourceIpAllowlist: string[];
+}
+/**
+ * Restrict the number of unstakes per day.
+ * @example {"MaxDailyUnstake": 5 }
+ */
+export interface MaxDailyUnstakePolicy {
+    MaxDailyUnstake: number;
+}
+/**
+ * An organization.
+ *
+ * Extends {@link CubeSignerClient} and provides a few org-specific methods on top.
+ */
+export declare class Org extends CubeSignerClient {
+    /**
+     * @description The org id
+     * @example Org#c3b9379c-4e8c-4216-bd0a-65ace53cf98f
+     */
+    get id(): OrgId;
+    /**
+     * Obtain information about the current organization.
+     *
+     * Same as {@link orgGet}.
+     */
+    get info(): () => Promise<{
+        enabled: boolean;
+        key_import_key?: string | null | undefined;
+        kwk_id: string;
+        last_unstake: string;
+        last_unstake_day_count: number;
+        name?: string | null | undefined;
+        org_id: string;
+        policy?: Record<string, never>[] | undefined;
+        totp_failure_limit: number;
+        user_export_delay: number;
+        user_export_window: number;
+    }>;
+    /** Human-readable name for the org */
+    name(): Promise<string | undefined>;
+    /** Get all keys in the org. */
+    get keys(): (type?: import("./key").KeyType | undefined, page?: import("./paginator").PageOpts | undefined) => Promise<import("./key").Key[]>;
+    /**
+     * Set the human-readable name for the org.
+     * @param {string} name The new human-readable name for the org (must be alphanumeric).
+     * @example my_org_name
+     */
+    setName(name: string): Promise<void>;
+    /** Is the org enabled? */
+    enabled(): Promise<boolean>;
+    /** Enable the org. */
+    enable(): Promise<void>;
+    /** Disable the org. */
+    disable(): Promise<void>;
+    /** Get the policy for the org. */
+    policy(): Promise<OrgPolicy[]>;
+    /**
+     * Set the policy for the org.
+     * @param {OrgPolicy[]} policy The new policy for the org.
+     */
+    setPolicy(policy: OrgPolicy[]): Promise<void>;
+    /**
+     * Retrieve the org associated with a session.
+     * @param {SessionStorage} storage The session
+     * @return {Org} An {@link Org} instance for the org associated with this session.
+     */
+    static retrieveFromStorage(storage: SignerSessionStorage): Promise<Org>;
+    /**
+     * Constructor.
+     * @param {CubeSignerClient | SignerSessionManager} csc The CubeSigner instance.
+     * @param {OrgInfo| string} data Either org id or name or {@link OrgInfo}.
+     */
+    constructor(csc: CubeSignerClient | SignerSessionManager, data?: OrgInfo | string);
+}

package/dist/cjs/src/org.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Org = void 0;
+const client_1 = require("./client");
+const _1 = require(".");
+/**
+ * An organization.
+ *
+ * Extends {@link CubeSignerClient} and provides a few org-specific methods on top.
+ */
+class Org extends client_1.CubeSignerClient {
+    /**
+     * @description The org id
+     * @example Org#c3b9379c-4e8c-4216-bd0a-65ace53cf98f
+     */
+    get id() {
+        return this.orgId;
+    }
+    /**
+     * Obtain information about the current organization.
+     *
+     * Same as {@link orgGet}.
+     */
+    get info() {
+        return this.orgGet.bind(this);
+    }
+    /** Human-readable name for the org */
+    async name() {
+        const org = await this.orgGet();
+        return org.name ?? undefined;
+    }
+    /** Get all keys in the org. */
+    get keys() {
+        return this.orgKeys.bind(this);
+    }
+    /**
+     * Set the human-readable name for the org.
+     * @param {string} name The new human-readable name for the org (must be alphanumeric).
+     * @example my_org_name
+     */
+    async setName(name) {
+        if (!/^[a-zA-Z0-9_]{3,30}$/.test(name)) {
+            throw new Error("Org name must be alphanumeric and between 3 and 30 characters");
+        }
+        await this.orgUpdate({ name });
+    }
+    /** Is the org enabled? */
+    async enabled() {
+        const org = await this.orgGet();
+        return org.enabled;
+    }
+    /** Enable the org. */
+    async enable() {
+        await this.orgUpdate({ enabled: true });
+    }
+    /** Disable the org. */
+    async disable() {
+        await this.orgUpdate({ enabled: false });
+    }
+    /** Get the policy for the org. */
+    async policy() {
+        const org = await this.orgGet();
+        return (org.policy ?? []);
+    }
+    /**
+     * Set the policy for the org.
+     * @param {OrgPolicy[]} policy The new policy for the org.
+     */
+    async setPolicy(policy) {
+        const p = policy;
+        await this.orgUpdate({ policy: p });
+    }
+    /**
+     * Retrieve the org associated with a session.
+     * @param {SessionStorage} storage The session
+     * @return {Org} An {@link Org} instance for the org associated with this session.
+     */
+    static async retrieveFromStorage(storage) {
+        const sessionMgr = await _1.SignerSessionManager.loadFromStorage(storage);
+        return new Org(new client_1.CubeSignerClient(sessionMgr), sessionMgr.orgId);
+    }
+    /**
+     * Constructor.
+     * @param {CubeSignerClient | SignerSessionManager} csc The CubeSigner instance.
+     * @param {OrgInfo| string} data Either org id or name or {@link OrgInfo}.
+     */
+    constructor(csc, data) {
+        const mgr = csc instanceof client_1.CubeSignerClient ? csc.sessionMgr : csc;
+        // NOTE: data can be OrgInfo for backward compatibility reasons
+        const orgId = typeof data === "string" ? data : data?.org_id;
+        super(mgr, orgId);
+    }
+}
+exports.Org = Org;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"org.js","sourceRoot":"","sources":["../../../src/org.ts"],"names":[],"mappings":";;;AAAA,qCAA4C;AAC5C,wBAAwE;AA4CxE;;;;GAIG;AACH,MAAa,GAAI,SAAQ,yBAAgB;IACvC;;;OAGG;IACH,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,sCAAsC;IACtC,KAAK,CAAC,IAAI;QACR,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,OAAO,GAAG,CAAC,IAAI,IAAI,SAAS,CAAC;IAC/B,CAAC;IAED,+BAA+B;IAC/B,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,IAAY;QACxB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACnF,CAAC;QACD,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAED,0BAA0B;IAC1B,KAAK,CAAC,OAAO;QACX,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,OAAO,GAAG,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,sBAAsB;IACtB,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,uBAAuB;IACvB,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,kCAAkC;IAClC,KAAK,CAAC,MAAM;QACV,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAA2B,CAAC;IACtD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS,CAAC,MAAmB;QACjC,MAAM,CAAC,GAAG,MAA4C,CAAC;QACvD,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAA6B;QAC5D,MAAM,UAAU,GAAG,MAAM,uBAAoB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACvE,OAAO,IAAI,GAAG,CAAC,IAAI,yBAAgB,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,YAAY,GAA4C,EAAE,IAAuB;QAC/E,MAAM,GAAG,GAAG,GAAG,YAAY,yBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAE,GAA4B,CAAC;QAE7F,+DAA+D;QAC/D,MAAM,KAAK,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC;QAC7D,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACpB,CAAC;CACF;AA9FD,kBA8FC","sourcesContent":["import { CubeSignerClient } from \"./client\";\nimport { OrgInfo, SignerSessionManager, SignerSessionStorage } from \".\";\n\n/** Organization id */\nexport type OrgId = string;\n\n/** Org-wide policy */\nexport type OrgPolicy =\n  | SourceIpAllowlistPolicy\n  | OidcAuthSourcesPolicy\n  | OriginAllowlistPolicy\n  | MaxDailyUnstakePolicy;\n\n/**\n * Provides an allowlist of OIDC Issuers and audiences that are allowed to authenticate into this org.\n * @example {\"OidcAuthSources\": { \"https://accounts.google.com\": [ \"1234.apps.googleusercontent.com\" ]}}\n */\nexport interface OidcAuthSourcesPolicy {\n  OidcAuthSources: Record<string, string[]>;\n}\n\n/**\n * Only allow requests from the specified origins.\n * @example {\"OriginAllowlist\": \"*\"}\n */\nexport interface OriginAllowlistPolicy {\n  OriginAllowlist: string[] | \"*\";\n}\n\n/**\n * Restrict signing to specific source IP addresses.\n * @example {\"SourceIpAllowlist\": [\"10.1.2.3/8\", \"169.254.17.1/16\"]}\n */\nexport interface SourceIpAllowlistPolicy {\n  SourceIpAllowlist: string[];\n}\n\n/**\n * Restrict the number of unstakes per day.\n * @example {\"MaxDailyUnstake\": 5 }\n */\nexport interface MaxDailyUnstakePolicy {\n  MaxDailyUnstake: number;\n}\n\n/**\n * An organization.\n *\n * Extends {@link CubeSignerClient} and provides a few org-specific methods on top.\n */\nexport class Org extends CubeSignerClient {\n  /**\n   * @description The org id\n   * @example Org#c3b9379c-4e8c-4216-bd0a-65ace53cf98f\n   */\n  get id(): OrgId {\n    return this.orgId;\n  }\n\n  /**\n   * Obtain information about the current organization.\n   *\n   * Same as {@link orgGet}.\n   */\n  get info() {\n    return this.orgGet.bind(this);\n  }\n\n  /** Human-readable name for the org */\n  async name(): Promise<string | undefined> {\n    const org = await this.orgGet();\n    return org.name ?? undefined;\n  }\n\n  /** Get all keys in the org. */\n  get keys() {\n    return this.orgKeys.bind(this);\n  }\n\n  /**\n   * Set the human-readable name for the org.\n   * @param {string} name The new human-readable name for the org (must be alphanumeric).\n   * @example my_org_name\n   */\n  async setName(name: string) {\n    if (!/^[a-zA-Z0-9_]{3,30}$/.test(name)) {\n      throw new Error(\"Org name must be alphanumeric and between 3 and 30 characters\");\n    }\n    await this.orgUpdate({ name });\n  }\n\n  /** Is the org enabled? */\n  async enabled(): Promise<boolean> {\n    const org = await this.orgGet();\n    return org.enabled;\n  }\n\n  /** Enable the org. */\n  async enable() {\n    await this.orgUpdate({ enabled: true });\n  }\n\n  /** Disable the org. */\n  async disable() {\n    await this.orgUpdate({ enabled: false });\n  }\n\n  /** Get the policy for the org. */\n  async policy(): Promise<OrgPolicy[]> {\n    const org = await this.orgGet();\n    return (org.policy ?? []) as unknown as OrgPolicy[];\n  }\n\n  /**\n   * Set the policy for the org.\n   * @param {OrgPolicy[]} policy The new policy for the org.\n   */\n  async setPolicy(policy: OrgPolicy[]) {\n    const p = policy as unknown as Record<string, never>[];\n    await this.orgUpdate({ policy: p });\n  }\n\n  /**\n   * Retrieve the org associated with a session.\n   * @param {SessionStorage} storage The session\n   * @return {Org} An {@link Org} instance for the org associated with this session.\n   */\n  static async retrieveFromStorage(storage: SignerSessionStorage): Promise<Org> {\n    const sessionMgr = await SignerSessionManager.loadFromStorage(storage);\n    return new Org(new CubeSignerClient(sessionMgr), sessionMgr.orgId);\n  }\n\n  /**\n   * Constructor.\n   * @param {CubeSignerClient | SignerSessionManager} csc The CubeSigner instance.\n   * @param {OrgInfo| string} data Either org id or name or {@link OrgInfo}.\n   */\n  constructor(csc: CubeSignerClient | SignerSessionManager, data?: OrgInfo | string) {\n    const mgr = csc instanceof CubeSignerClient ? csc.sessionMgr : (csc as SignerSessionManager);\n\n    // NOTE: data can be OrgInfo for backward compatibility reasons\n    const orgId = typeof data === \"string\" ? data : data?.org_id;\n    super(mgr, orgId);\n  }\n}\n"]}

package/dist/cjs/src/paginator.d.ts

@@ -0,0 +1,76 @@
+/** Pagination options. */
+export interface PageOpts {
+    /** Max number of items per page. */
+    size?: number;
+    /**
+     * Starting point (i.e., 'last_evaluated_key' from the previous page).
+     * Omit to start from the beginning.
+     */
+    start?: string;
+    /** Iterate until retrieving the entire result set. */
+    all: boolean;
+}
+/** Static constructors for `IPage` */
+export declare class Page {
+    /**
+     * The default is to fetch the entire result set
+     * (by repeatedly calling the remote endpoint until all pages are retrieved).
+     *
+     * @return {PageOpts} Pagination options.
+     */
+    static default(): PageOpts;
+}
+export interface PageQueryArgs {
+    /**
+     * Max number of items to return per page.
+     *
+     * The actual number of returned items may be less that this, even if there exist more
+     * data in the result set. To reliably determine if more data is left in the result set,
+     * inspect the [UnencryptedLastEvalKey] value in the response object.
+     */
+    "page.size"?: number;
+    /**
+     * The start of the page.
+     *
+     * Omit to start from the beginning; otherwise, only specify the exact
+     * value previously returned as 'last_evaluated_key' from the same endpoint.
+     */
+    "page.start"?: string | null;
+}
+export type ListFn<U> = (pageQueryArgs: PageQueryArgs) => Promise<U>;
+export type ItemsFn<U, T> = (resp: U) => T[];
+export type LastFn<U> = (resp: U) => string | null | undefined;
+/**
+ * Helper class for fetching paginated results.
+ */
+export declare class Paginator<U, T> {
+    #private;
+    /**
+     * @param {PageOpts} pageOpts Pagination options
+     * @param {ListFn<U>} listFn Calls a remote endpoint that returns a paginated response
+     * @param {ItemsFn<U, T>} itemsFn Extracts items from the paginated response
+     * @param {LastFn<U>} lastFn Extracts the last evaluated key from the paginated response
+     */
+    constructor(pageOpts: PageOpts, listFn: ListFn<U>, itemsFn: ItemsFn<U, T>, lastFn: LastFn<U>);
+    /**
+     * Fetches either a single page or the entire result set, depending on
+     * the `all` property of the pagination options.
+     *
+     * @return {Promise<T[]>} A single page or the entire result set.
+     */
+    fetch(): Promise<T[]>;
+    /**
+     * Fetches a single page of the result set from where it previously left off.
+     * Mutates self to remember where it left off.
+     *
+     * @return {Promise<T[]>} The next page of the result set.
+     */
+    fetchPage(): Promise<T[]>;
+    /**
+     * Fetches the entire result set starting from where it previously left off
+     * by iterating through the pages returned by the remote end.
+     *
+     * @return {Promise<T[]>} The entire result set.
+     */
+    fetchAll(): Promise<T[]>;
+}

package/dist/cjs/src/paginator.js

@@ -0,0 +1,99 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _Paginator_listFn, _Paginator_itemsFn, _Paginator_lastFn, _Paginator_opts, _Paginator_last, _Paginator_done;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Paginator = exports.Page = void 0;
+/** Static constructors for `IPage` */
+class Page {
+    /**
+     * The default is to fetch the entire result set
+     * (by repeatedly calling the remote endpoint until all pages are retrieved).
+     *
+     * @return {PageOpts} Pagination options.
+     */
+    static default() {
+        return {
+            all: true,
+        };
+    }
+}
+exports.Page = Page;
+/**
+ * Helper class for fetching paginated results.
+ */
+class Paginator {
+    /**
+     * @param {PageOpts} pageOpts Pagination options
+     * @param {ListFn<U>} listFn Calls a remote endpoint that returns a paginated response
+     * @param {ItemsFn<U, T>} itemsFn Extracts items from the paginated response
+     * @param {LastFn<U>} lastFn Extracts the last evaluated key from the paginated response
+     */
+    constructor(pageOpts, listFn, itemsFn, lastFn) {
+        _Paginator_listFn.set(this, void 0);
+        _Paginator_itemsFn.set(this, void 0);
+        _Paginator_lastFn.set(this, void 0);
+        _Paginator_opts.set(this, void 0);
+        _Paginator_last.set(this, void 0);
+        _Paginator_done.set(this, void 0);
+        __classPrivateFieldSet(this, _Paginator_listFn, listFn, "f");
+        __classPrivateFieldSet(this, _Paginator_itemsFn, itemsFn, "f");
+        __classPrivateFieldSet(this, _Paginator_lastFn, lastFn, "f");
+        __classPrivateFieldSet(this, _Paginator_opts, pageOpts, "f");
+        __classPrivateFieldSet(this, _Paginator_last, pageOpts.start, "f");
+        __classPrivateFieldSet(this, _Paginator_done, false, "f");
+    }
+    /**
+     * Fetches either a single page or the entire result set, depending on
+     * the `all` property of the pagination options.
+     *
+     * @return {Promise<T[]>} A single page or the entire result set.
+     */
+    async fetch() {
+        return __classPrivateFieldGet(this, _Paginator_opts, "f").all ? await this.fetchAll() : await this.fetchPage();
+    }
+    /**
+     * Fetches a single page of the result set from where it previously left off.
+     * Mutates self to remember where it left off.
+     *
+     * @return {Promise<T[]>} The next page of the result set.
+     */
+    async fetchPage() {
+        if (__classPrivateFieldGet(this, _Paginator_done, "f")) {
+            return [];
+        }
+        const resp = await __classPrivateFieldGet(this, _Paginator_listFn, "f").call(this, {
+            "page.size": __classPrivateFieldGet(this, _Paginator_opts, "f").size,
+            "page.start": __classPrivateFieldGet(this, _Paginator_last, "f"),
+        });
+        __classPrivateFieldSet(this, _Paginator_last, __classPrivateFieldGet(this, _Paginator_lastFn, "f").call(this, resp), "f");
+        __classPrivateFieldSet(this, _Paginator_done, !__classPrivateFieldGet(this, _Paginator_last, "f"), "f");
+        return __classPrivateFieldGet(this, _Paginator_itemsFn, "f").call(this, resp);
+    }
+    /**
+     * Fetches the entire result set starting from where it previously left off
+     * by iterating through the pages returned by the remote end.
+     *
+     * @return {Promise<T[]>} The entire result set.
+     */
+    async fetchAll() {
+        const result = [];
+        while (!__classPrivateFieldGet(this, _Paginator_done, "f")) {
+            const items = await this.fetchPage();
+            result.push(...items);
+        }
+        return result;
+    }
+}
+exports.Paginator = Paginator;
+_Paginator_listFn = new WeakMap(), _Paginator_itemsFn = new WeakMap(), _Paginator_lastFn = new WeakMap(), _Paginator_opts = new WeakMap(), _Paginator_last = new WeakMap(), _Paginator_done = new WeakMap();
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicGFnaW5hdG9yLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL3BhZ2luYXRvci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7QUFhQSxzQ0FBc0M7QUFDdEMsTUFBYSxJQUFJO0lBQ2Y7Ozs7O09BS0c7SUFDSCxNQUFNLENBQUMsT0FBTztRQUNaLE9BQWlCO1lBQ2YsR0FBRyxFQUFFLElBQUk7U0FDVixDQUFDO0lBQ0osQ0FBQztDQUNGO0FBWkQsb0JBWUM7QUF5QkQ7O0dBRUc7QUFDSCxNQUFhLFNBQVM7SUFRcEI7Ozs7O09BS0c7SUFDSCxZQUFZLFFBQWtCLEVBQUUsTUFBaUIsRUFBRSxPQUFzQixFQUFFLE1BQWlCO1FBYm5GLG9DQUFtQjtRQUNuQixxQ0FBd0I7UUFDeEIsb0NBQW1CO1FBQzVCLGtDQUFnQjtRQUNoQixrQ0FBaUM7UUFDakMsa0NBQWU7UUFTYix1QkFBQSxJQUFJLHFCQUFXLE1BQU0sTUFBQSxDQUFDO1FBQ3RCLHVCQUFBLElBQUksc0JBQVksT0FBTyxNQUFBLENBQUM7UUFDeEIsdUJBQUEsSUFBSSxxQkFBVyxNQUFNLE1BQUEsQ0FBQztRQUN0Qix1QkFBQSxJQUFJLG1CQUFTLFFBQVEsTUFBQSxDQUFDO1FBQ3RCLHVCQUFBLElBQUksbUJBQVMsUUFBUSxDQUFDLEtBQUssTUFBQSxDQUFDO1FBQzVCLHVCQUFBLElBQUksbUJBQVMsS0FBSyxNQUFBLENBQUM7SUFDckIsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsS0FBSyxDQUFDLEtBQUs7UUFDVCxPQUFPLHVCQUFBLElBQUksdUJBQU0sQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLE1BQU0sSUFBSSxDQUFDLFFBQVEsRUFBRSxDQUFDLENBQUMsQ0FBQyxNQUFNLElBQUksQ0FBQyxTQUFTLEVBQUUsQ0FBQztJQUN6RSxDQUFDO0lBRUQ7Ozs7O09BS0c7SUFDSCxLQUFLLENBQUMsU0FBUztRQUNiLElBQUksdUJBQUEsSUFBSSx1QkFBTSxFQUFFLENBQUM7WUFDZixPQUFPLEVBQUUsQ0FBQztRQUNaLENBQUM7UUFFRCxNQUFNLElBQUksR0FBRyxNQUFNLHVCQUFBLElBQUkseUJBQVEsTUFBWixJQUFJLEVBQVM7WUFDOUIsV0FBVyxFQUFFLHVCQUFBLElBQUksdUJBQU0sQ0FBQyxJQUFJO1lBQzVCLFlBQVksRUFBRSx1QkFBQSxJQUFJLHVCQUFNO1NBQ3pCLENBQUMsQ0FBQztRQUNILHVCQUFBLElBQUksbUJBQVMsdUJBQUEsSUFBSSx5QkFBUSxNQUFaLElBQUksRUFBUyxJQUFJLENBQUMsTUFBQSxDQUFDO1FBQ2hDLHVCQUFBLElBQUksbUJBQVMsQ0FBQyx1QkFBQSxJQUFJLHVCQUFNLE1BQUEsQ0FBQztRQUN6QixPQUFPLHVCQUFBLElBQUksMEJBQVMsTUFBYixJQUFJLEVBQVUsSUFBSSxDQUFDLENBQUM7SUFDN0IsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0gsS0FBSyxDQUFDLFFBQVE7UUFDWixNQUFNLE1BQU0sR0FBRyxFQUFFLENBQUM7UUFDbEIsT0FBTyxDQUFDLHVCQUFBLElBQUksdUJBQU0sRUFBRSxDQUFDO1lBQ25CLE1BQU0sS0FBSyxHQUFHLE1BQU0sSUFBSSxDQUFDLFNBQVMsRUFBRSxDQUFDO1lBQ3JDLE1BQU0sQ0FBQyxJQUFJLENBQUMsR0FBRyxLQUFLLENBQUMsQ0FBQztRQUN4QixDQUFDO1FBQ0QsT0FBTyxNQUFNLENBQUM7SUFDaEIsQ0FBQztDQUNGO0FBbkVELDhCQW1FQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKiBQYWdpbmF0aW9uIG9wdGlvbnMuICovXG5leHBvcnQgaW50ZXJmYWNlIFBhZ2VPcHRzIHtcbiAgLyoqIE1heCBudW1iZXIgb2YgaXRlbXMgcGVyIHBhZ2UuICovXG4gIHNpemU/OiBudW1iZXI7XG4gIC8qKlxuICAgKiBTdGFydGluZyBwb2ludCAoaS5lLiwgJ2xhc3RfZXZhbHVhdGVkX2tleScgZnJvbSB0aGUgcHJldmlvdXMgcGFnZSkuXG4gICAqIE9taXQgdG8gc3RhcnQgZnJvbSB0aGUgYmVnaW5uaW5nLlxuICAgKi9cbiAgc3RhcnQ/OiBzdHJpbmc7XG4gIC8qKiBJdGVyYXRlIHVudGlsIHJldHJpZXZpbmcgdGhlIGVudGlyZSByZXN1bHQgc2V0LiAqL1xuICBhbGw6IGJvb2xlYW47XG59XG5cbi8qKiBTdGF0aWMgY29uc3RydWN0b3JzIGZvciBgSVBhZ2VgICovXG5leHBvcnQgY2xhc3MgUGFnZSB7XG4gIC8qKlxuICAgKiBUaGUgZGVmYXVsdCBpcyB0byBmZXRjaCB0aGUgZW50aXJlIHJlc3VsdCBzZXRcbiAgICogKGJ5IHJlcGVhdGVkbHkgY2FsbGluZyB0aGUgcmVtb3RlIGVuZHBvaW50IHVudGlsIGFsbCBwYWdlcyBhcmUgcmV0cmlldmVkKS5cbiAgICpcbiAgICogQHJldHVybiB7UGFnZU9wdHN9IFBhZ2luYXRpb24gb3B0aW9ucy5cbiAgICovXG4gIHN0YXRpYyBkZWZhdWx0KCk6IFBhZ2VPcHRzIHtcbiAgICByZXR1cm4gPFBhZ2VPcHRzPntcbiAgICAgIGFsbDogdHJ1ZSxcbiAgICB9O1xuICB9XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgUGFnZVF1ZXJ5QXJncyB7XG4gIC8qKlxuICAgKiBNYXggbnVtYmVyIG9mIGl0ZW1zIHRvIHJldHVybiBwZXIgcGFnZS5cbiAgICpcbiAgICogVGhlIGFjdHVhbCBudW1iZXIgb2YgcmV0dXJuZWQgaXRlbXMgbWF5IGJlIGxlc3MgdGhhdCB0aGlzLCBldmVuIGlmIHRoZXJlIGV4aXN0IG1vcmVcbiAgICogZGF0YSBpbiB0aGUgcmVzdWx0IHNldC4gVG8gcmVsaWFibHkgZGV0ZXJtaW5lIGlmIG1vcmUgZGF0YSBpcyBsZWZ0IGluIHRoZSByZXN1bHQgc2V0LFxuICAgKiBpbnNwZWN0IHRoZSBbVW5lbmNyeXB0ZWRMYXN0RXZhbEtleV0gdmFsdWUgaW4gdGhlIHJlc3BvbnNlIG9iamVjdC5cbiAgICovXG4gIFwicGFnZS5zaXplXCI/OiBudW1iZXI7XG5cbiAgLyoqXG4gICAqIFRoZSBzdGFydCBvZiB0aGUgcGFnZS5cbiAgICpcbiAgICogT21pdCB0byBzdGFydCBmcm9tIHRoZSBiZWdpbm5pbmc7IG90aGVyd2lzZSwgb25seSBzcGVjaWZ5IHRoZSBleGFjdFxuICAgKiB2YWx1ZSBwcmV2aW91c2x5IHJldHVybmVkIGFzICdsYXN0X2V2YWx1YXRlZF9rZXknIGZyb20gdGhlIHNhbWUgZW5kcG9pbnQuXG4gICAqL1xuICBcInBhZ2Uuc3RhcnRcIj86IHN0cmluZyB8IG51bGw7XG59XG5cbmV4cG9ydCB0eXBlIExpc3RGbjxVPiA9IChwYWdlUXVlcnlBcmdzOiBQYWdlUXVlcnlBcmdzKSA9PiBQcm9taXNlPFU+O1xuZXhwb3J0IHR5cGUgSXRlbXNGbjxVLCBUPiA9IChyZXNwOiBVKSA9PiBUW107XG5leHBvcnQgdHlwZSBMYXN0Rm48VT4gPSAocmVzcDogVSkgPT4gc3RyaW5nIHwgbnVsbCB8IHVuZGVmaW5lZDtcblxuLyoqXG4gKiBIZWxwZXIgY2xhc3MgZm9yIGZldGNoaW5nIHBhZ2luYXRlZCByZXN1bHRzLlxuICovXG5leHBvcnQgY2xhc3MgUGFnaW5hdG9yPFUsIFQ+IHtcbiAgcmVhZG9ubHkgI2xpc3RGbjogTGlzdEZuPFU+O1xuICByZWFkb25seSAjaXRlbXNGbjogSXRlbXNGbjxVLCBUPjtcbiAgcmVhZG9ubHkgI2xhc3RGbjogTGFzdEZuPFU+O1xuICAjb3B0czogUGFnZU9wdHM7XG4gICNsYXN0OiBzdHJpbmcgfCBudWxsIHwgdW5kZWZpbmVkO1xuICAjZG9uZTogYm9vbGVhbjtcblxuICAvKipcbiAgICogQHBhcmFtIHtQYWdlT3B0c30gcGFnZU9wdHMgUGFnaW5hdGlvbiBvcHRpb25zXG4gICAqIEBwYXJhbSB7TGlzdEZuPFU+fSBsaXN0Rm4gQ2FsbHMgYSByZW1vdGUgZW5kcG9pbnQgdGhhdCByZXR1cm5zIGEgcGFnaW5hdGVkIHJlc3BvbnNlXG4gICAqIEBwYXJhbSB7SXRlbXNGbjxVLCBUPn0gaXRlbXNGbiBFeHRyYWN0cyBpdGVtcyBmcm9tIHRoZSBwYWdpbmF0ZWQgcmVzcG9uc2VcbiAgICogQHBhcmFtIHtMYXN0Rm48VT59IGxhc3RGbiBFeHRyYWN0cyB0aGUgbGFzdCBldmFsdWF0ZWQga2V5IGZyb20gdGhlIHBhZ2luYXRlZCByZXNwb25zZVxuICAgKi9cbiAgY29uc3RydWN0b3IocGFnZU9wdHM6IFBhZ2VPcHRzLCBsaXN0Rm46IExpc3RGbjxVPiwgaXRlbXNGbjogSXRlbXNGbjxVLCBUPiwgbGFzdEZuOiBMYXN0Rm48VT4pIHtcbiAgICB0aGlzLiNsaXN0Rm4gPSBsaXN0Rm47XG4gICAgdGhpcy4jaXRlbXNGbiA9IGl0ZW1zRm47XG4gICAgdGhpcy4jbGFzdEZuID0gbGFzdEZuO1xuICAgIHRoaXMuI29wdHMgPSBwYWdlT3B0cztcbiAgICB0aGlzLiNsYXN0ID0gcGFnZU9wdHMuc3RhcnQ7XG4gICAgdGhpcy4jZG9uZSA9IGZhbHNlO1xuICB9XG5cbiAgLyoqXG4gICAqIEZldGNoZXMgZWl0aGVyIGEgc2luZ2xlIHBhZ2Ugb3IgdGhlIGVudGlyZSByZXN1bHQgc2V0LCBkZXBlbmRpbmcgb25cbiAgICogdGhlIGBhbGxgIHByb3BlcnR5IG9mIHRoZSBwYWdpbmF0aW9uIG9wdGlvbnMuXG4gICAqXG4gICAqIEByZXR1cm4ge1Byb21pc2U8VFtdPn0gQSBzaW5nbGUgcGFnZSBvciB0aGUgZW50aXJlIHJlc3VsdCBzZXQuXG4gICAqL1xuICBhc3luYyBmZXRjaCgpOiBQcm9taXNlPFRbXT4ge1xuICAgIHJldHVybiB0aGlzLiNvcHRzLmFsbCA/IGF3YWl0IHRoaXMuZmV0Y2hBbGwoKSA6IGF3YWl0IHRoaXMuZmV0Y2hQYWdlKCk7XG4gIH1cblxuICAvKipcbiAgICogRmV0Y2hlcyBhIHNpbmdsZSBwYWdlIG9mIHRoZSByZXN1bHQgc2V0IGZyb20gd2hlcmUgaXQgcHJldmlvdXNseSBsZWZ0IG9mZi5cbiAgICogTXV0YXRlcyBzZWxmIHRvIHJlbWVtYmVyIHdoZXJlIGl0IGxlZnQgb2ZmLlxuICAgKlxuICAgKiBAcmV0dXJuIHtQcm9taXNlPFRbXT59IFRoZSBuZXh0IHBhZ2Ugb2YgdGhlIHJlc3VsdCBzZXQuXG4gICAqL1xuICBhc3luYyBmZXRjaFBhZ2UoKTogUHJvbWlzZTxUW10+IHtcbiAgICBpZiAodGhpcy4jZG9uZSkge1xuICAgICAgcmV0dXJuIFtdO1xuICAgIH1cblxuICAgIGNvbnN0IHJlc3AgPSBhd2FpdCB0aGlzLiNsaXN0Rm4oe1xuICAgICAgXCJwYWdlLnNpemVcIjogdGhpcy4jb3B0cy5zaXplLFxuICAgICAgXCJwYWdlLnN0YXJ0XCI6IHRoaXMuI2xhc3QsXG4gICAgfSk7XG4gICAgdGhpcy4jbGFzdCA9IHRoaXMuI2xhc3RGbihyZXNwKTtcbiAgICB0aGlzLiNkb25lID0gIXRoaXMuI2xhc3Q7XG4gICAgcmV0dXJuIHRoaXMuI2l0ZW1zRm4ocmVzcCk7XG4gIH1cblxuICAvKipcbiAgICogRmV0Y2hlcyB0aGUgZW50aXJlIHJlc3VsdCBzZXQgc3RhcnRpbmcgZnJvbSB3aGVyZSBpdCBwcmV2aW91c2x5IGxlZnQgb2ZmXG4gICAqIGJ5IGl0ZXJhdGluZyB0aHJvdWdoIHRoZSBwYWdlcyByZXR1cm5lZCBieSB0aGUgcmVtb3RlIGVuZC5cbiAgICpcbiAgICogQHJldHVybiB7UHJvbWlzZTxUW10+fSBUaGUgZW50aXJlIHJlc3VsdCBzZXQuXG4gICAqL1xuICBhc3luYyBmZXRjaEFsbCgpOiBQcm9taXNlPFRbXT4ge1xuICAgIGNvbnN0IHJlc3VsdCA9IFtdO1xuICAgIHdoaWxlICghdGhpcy4jZG9uZSkge1xuICAgICAgY29uc3QgaXRlbXMgPSBhd2FpdCB0aGlzLmZldGNoUGFnZSgpO1xuICAgICAgcmVzdWx0LnB1c2goLi4uaXRlbXMpO1xuICAgIH1cbiAgICByZXR1cm4gcmVzdWx0O1xuICB9XG59XG4iXX0=

package/dist/cjs/src/response.d.ts

@@ -0,0 +1,114 @@
+import { CubeSignerClient, SignerSession } from ".";
+import { MfaReceipt } from "./mfa";
+import { AcceptedResponse, NewSessionResponse } from "./schema_types";
+/**
+ * Response type, which can be either a value of type {@link U}
+ * or {@link AcceptedResponse} (status code 202) which requires MFA.
+ */
+export type Response<U> = U | AcceptedResponse;
+/**
+ * Request function which optionally takes additional headers
+ * (which, for example, can be used to attach an MFA receipt).
+ */
+export type RequestFn<U> = (headers?: HeadersInit) => Promise<Response<U>>;
+/**
+ * Map function occasionally used to map a response from the API into a higher-level type.
+ */
+export type MapFn<U, V> = (u: U) => V;
+/**
+ * Take a {@link Response<U>} and a {@link MapFn<U, V>} function and return
+ * a {@link Response<V>} that maps the value of the original response when its status code is 200.
+ *
+ * @param {Response<U>} resp Original response
+ * @param {Map<U, V>} mapFn Map to apply to the response value when its status code is 200.
+ * @return {Response<V>} Response whose value for status code 200 is mapped from U to V
+ */
+export declare function mapResponse<U, V>(resp: Response<U>, mapFn: MapFn<U, V>): Response<V>;
+export interface MfaRequired {
+    /** Org id */
+    org_id: string;
+    /** MFA request id */
+    id: string;
+    /** Optional MFA session */
+    session?: NewSessionResponse | null;
+}
+/**
+ * A response of a CubeSigner request.
+ */
+export declare class CubeSignerResponse<U> {
+    #private;
+    /** @return {string} The MFA id associated with this request (if any) */
+    mfaId(): string;
+    /** @return {boolean} True if this request requires an MFA approval */
+    requiresMfa(): boolean;
+    /**
+     * Return session information to use for any MFA approval requests (if any was included in the response).
+     * @return {ClientSessionInfo | undefined}
+     */
+    mfaSessionInfo(): NewSessionResponse | undefined;
+    /** @return {U} The response data, if no MFA is required */
+    data(): U;
+    /**
+     * Approve the MFA request using a given session and a TOTP code.
+     *
+     * @param {SignerSession} session Signer session to use
+     * @param {string} code 6-digit TOTP code
+     * @return {CubeSignerResponse<U>} The result of signing with the approval
+     */
+    approveTotp(session: SignerSession, code: string): Promise<CubeSignerResponse<U>>;
+    /**
+     * Reject the MFA request using a given session and a TOTP code.
+     *
+     * @param {SignerSession} session Signer session to use
+     * @param {string} code 6-digit TOTP code
+     */
+    rejectTotp(session: SignerSession, code: string): Promise<void>;
+    /**
+     * Approve the MFA request using a given {@link CubeSignerClient} instance (i.e., its session).
+     *
+     * @param {CubeSignerClient} cs CubeSigner whose session to use
+     * @return {CubeSignerResponse<U>} The result of signing with the approval
+     */
+    approve(cs: CubeSignerClient): Promise<CubeSignerResponse<U>>;
+    /**
+     * Reject the MFA request using a given {@link CubeSignerClient} instance (i.e., its session).
+     *
+     * @param {CubeSignerClient} cs CubeSigner client whose session to use
+     */
+    reject(cs: CubeSignerClient): Promise<void>;
+    /**
+     * Resubmits the request with a given MFA receipt attached.
+     *
+     * @param {MfaReceipt} mfaReceipt The MFA receipt
+     * @return {Promise<CubeSignerResponse<U>>} The result of signing after MFA approval
+     */
+    signWithMfaApproval(mfaReceipt: MfaReceipt): Promise<CubeSignerResponse<U>>;
+    /**
+     * Constructor.
+     *
+     * @param {RequestFn} requestFn
+     *    The signing function that this response is from.
+     *    This argument is used to resend requests with different headers if needed.
+     * @param {U | AcceptedResponse} resp The response as returned by the OpenAPI client.
+     * @internal
+     */
+    constructor(requestFn: RequestFn<U>, resp: U | AcceptedResponse);
+    /**
+     * Static constructor.
+     * @param {RequestFn} requestFn
+     *    The request function that this response is from.
+     *    This argument is used to resend requests with different headers if needed.
+     * @param {MfaReceipt} mfaReceipt Optional MFA receipt
+     * @return {Promise<CubeSignerResponse<U>>} New instance of this class.
+     * @internal
+     */
+    static create<U>(requestFn: RequestFn<U>, mfaReceipt?: MfaReceipt): Promise<CubeSignerResponse<U>>;
+    /**
+     * Return HTTP headers containing a given MFA receipt.
+     *
+     * @param {MfaReceipt} mfaReceipt MFA receipt
+     * @return {HeadersInit} Headers including that receipt
+     * @internal
+     */
+    static getMfaHeaders(mfaReceipt?: MfaReceipt): HeadersInit | undefined;
+}