@cubist-labs/cubesigner-sdk 0.2.28 → 0.3.8

package/dist/esm/src/response.js

@@ -0,0 +1,198 @@
+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 __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 _CubeSignerResponse_instances, _CubeSignerResponse_requestFn, _CubeSignerResponse_resp, _CubeSignerResponse_mfaRequired, _CubeSignerResponse_mfaVoteTotp, _CubeSignerResponse_mfaVoteCs;
+/**
+ * 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 function mapResponse(resp, mapFn) {
+    if (resp.accepted?.MfaRequired) {
+        return resp;
+    }
+    else {
+        return mapFn(resp);
+    }
+}
+/**
+ * A response of a CubeSigner request.
+ */
+export class CubeSignerResponse {
+    /** @return {string} The MFA id associated with this request (if any) */
+    mfaId() {
+        return __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f").id;
+    }
+    /** @return {boolean} True if this request requires an MFA approval */
+    requiresMfa() {
+        return __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f") !== undefined;
+    }
+    /**
+     * Return session information to use for any MFA approval requests (if any was included in the response).
+     * @return {ClientSessionInfo | undefined}
+     */
+    mfaSessionInfo() {
+        return __classPrivateFieldGet(this, _CubeSignerResponse_resp, "f").accepted?.MfaRequired?.session ?? undefined;
+    }
+    /** @return {U} The response data, if no MFA is required */
+    data() {
+        if (this.requiresMfa()) {
+            throw new Error("Cannot call `data()` while MFA is required");
+        }
+        return __classPrivateFieldGet(this, _CubeSignerResponse_resp, "f");
+    }
+    /**
+     * 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
+     */
+    async approveTotp(session, code) {
+        return await __classPrivateFieldGet(this, _CubeSignerResponse_instances, "m", _CubeSignerResponse_mfaVoteTotp).call(this, session, code, "approve");
+    }
+    /**
+     * 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
+     */
+    async rejectTotp(session, code) {
+        await __classPrivateFieldGet(this, _CubeSignerResponse_instances, "m", _CubeSignerResponse_mfaVoteTotp).call(this, session, code, "reject");
+    }
+    /**
+     * 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
+     */
+    async approve(cs) {
+        return await __classPrivateFieldGet(this, _CubeSignerResponse_instances, "m", _CubeSignerResponse_mfaVoteCs).call(this, cs, "approve");
+    }
+    /**
+     * Reject the MFA request using a given {@link CubeSignerClient} instance (i.e., its session).
+     *
+     * @param {CubeSignerClient} cs CubeSigner client whose session to use
+     */
+    async reject(cs) {
+        await __classPrivateFieldGet(this, _CubeSignerResponse_instances, "m", _CubeSignerResponse_mfaVoteCs).call(this, cs, "reject");
+    }
+    /**
+     * 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
+     */
+    async signWithMfaApproval(mfaReceipt) {
+        const headers = CubeSignerResponse.getMfaHeaders(mfaReceipt);
+        return new CubeSignerResponse(__classPrivateFieldGet(this, _CubeSignerResponse_requestFn, "f"), await __classPrivateFieldGet(this, _CubeSignerResponse_requestFn, "f").call(this, headers));
+    }
+    // --------------------------------------------------------------------------
+    // -- INTERNAL --------------------------------------------------------------
+    // --------------------------------------------------------------------------
+    /**
+     * 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, resp) {
+        _CubeSignerResponse_instances.add(this);
+        _CubeSignerResponse_requestFn.set(this, void 0);
+        _CubeSignerResponse_resp.set(this, void 0);
+        /**
+         * Optional MFA id. Only set if there is an MFA request associated with the
+         * signing request
+         */
+        _CubeSignerResponse_mfaRequired.set(this, void 0);
+        __classPrivateFieldSet(this, _CubeSignerResponse_requestFn, requestFn, "f");
+        __classPrivateFieldSet(this, _CubeSignerResponse_resp, resp, "f");
+        __classPrivateFieldSet(this, _CubeSignerResponse_mfaRequired, __classPrivateFieldGet(this, _CubeSignerResponse_resp, "f").accepted?.MfaRequired, "f");
+    }
+    /**
+     * 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 async create(requestFn, mfaReceipt) {
+        const seed = await requestFn(this.getMfaHeaders(mfaReceipt));
+        return new CubeSignerResponse(requestFn, seed);
+    }
+    /**
+     * Return HTTP headers containing a given MFA receipt.
+     *
+     * @param {MfaReceipt} mfaReceipt MFA receipt
+     * @return {HeadersInit} Headers including that receipt
+     * @internal
+     */
+    static getMfaHeaders(mfaReceipt) {
+        return mfaReceipt
+            ? {
+                "x-cubist-mfa-id": mfaReceipt.mfaId,
+                "x-cubist-mfa-org-id": mfaReceipt.mfaOrgId,
+                "x-cubist-mfa-confirmation": mfaReceipt.mfaConf,
+            }
+            : undefined;
+    }
+}
+_CubeSignerResponse_requestFn = new WeakMap(), _CubeSignerResponse_resp = new WeakMap(), _CubeSignerResponse_mfaRequired = new WeakMap(), _CubeSignerResponse_instances = new WeakSet(), _CubeSignerResponse_mfaVoteTotp = 
+/**
+ * Approve or reject an MFA request using a given session and a TOTP code.
+ *
+ * @param {SignerSession} session Signer session to use
+ * @param {string} code 6-digit TOTP code
+ * @param {MfaVote} vote Approve or reject
+ * @return {CubeSignerResponse<U>} The result of signing with the approval
+ */
+async function _CubeSignerResponse_mfaVoteTotp(session, code, vote) {
+    if (!this.requiresMfa()) {
+        return this;
+    }
+    const mfaId = this.mfaId();
+    const mfaOrgId = __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f").org_id;
+    const mfaApproval = await session.mfaVoteTotp(mfaId, code, vote);
+    const mfaConf = mfaApproval.receipt?.confirmation;
+    if (!mfaConf) {
+        return this;
+    }
+    return await this.signWithMfaApproval({ mfaId, mfaOrgId, mfaConf });
+}, _CubeSignerResponse_mfaVoteCs = 
+/**
+ * Approve or reject an MFA request using a given {@link CubeSignerClient} instance (i.e., its session).
+ *
+ * @param {CubeSignerClient} cs CubeSigner whose session to use
+ * @param {MfaVote} mfaVote Approve or reject
+ * @return {CubeSignerResponse<U>} The result of signing with the approval
+ */
+async function _CubeSignerResponse_mfaVoteCs(cs, mfaVote) {
+    if (!this.requiresMfa()) {
+        return this;
+    }
+    const mfaId = __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f").id;
+    const mfaOrgId = __classPrivateFieldGet(this, _CubeSignerResponse_mfaRequired, "f").org_id;
+    const mfaApproval = await cs.mfaVoteCs(mfaId, mfaVote);
+    const mfaConf = mfaApproval.receipt?.confirmation;
+    if (!mfaConf) {
+        return this;
+    }
+    return await this.signWithMfaApproval({ mfaId, mfaOrgId, mfaConf });
+};
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"response.js","sourceRoot":"","sources":["../../../src/response.ts"],"names":[],"mappings":";;;;;;;;;;;;AAqBA;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CAAO,IAAiB,EAAE,KAAkB;IACrE,IAAK,IAAyB,CAAC,QAAQ,EAAE,WAAW,EAAE,CAAC;QACrD,OAAO,IAAwB,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,IAAS,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC;AAWD;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAS7B,wEAAwE;IACxE,KAAK;QACH,OAAO,uBAAA,IAAI,uCAAc,CAAC,EAAE,CAAC;IAC/B,CAAC;IAED,sEAAsE;IACtE,WAAW;QACT,OAAO,uBAAA,IAAI,uCAAa,KAAK,SAAS,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,cAAc;QACZ,OAAQ,uBAAA,IAAI,gCAA2B,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,IAAI,SAAS,CAAC;IACtF,CAAC;IAED,2DAA2D;IAC3D,IAAI;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,uBAAA,IAAI,gCAAW,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,OAAsB,EAAE,IAAY;QACpD,OAAO,MAAM,uBAAA,IAAI,sEAAa,MAAjB,IAAI,EAAc,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,OAAsB,EAAE,IAAY;QACnD,MAAM,uBAAA,IAAI,sEAAa,MAAjB,IAAI,EAAc,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnD,CAAC;IA+BD;;;;;OAKG;IACH,KAAK,CAAC,OAAO,CAAC,EAAoB;QAChC,OAAO,MAAM,uBAAA,IAAI,oEAAW,MAAf,IAAI,EAAY,EAAE,EAAE,SAAS,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,EAAoB;QAC/B,MAAM,uBAAA,IAAI,oEAAW,MAAf,IAAI,EAAY,EAAE,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IA2BD;;;;;OAKG;IACH,KAAK,CAAC,mBAAmB,CAAC,UAAsB;QAC9C,MAAM,OAAO,GAAG,kBAAkB,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC7D,OAAO,IAAI,kBAAkB,CAAC,uBAAA,IAAI,qCAAW,EAAE,MAAM,uBAAA,IAAI,qCAAW,MAAf,IAAI,EAAY,OAAO,CAAC,CAAC,CAAC;IACjF,CAAC;IAED,6EAA6E;IAC7E,6EAA6E;IAC7E,6EAA6E;IAE7E;;;;;;;;OAQG;IACH,YAAY,SAAuB,EAAE,IAA0B;;QAxJtD,gDAAyB;QACzB,2CAA4B;QACrC;;;WAGG;QACM,kDAA2B;QAmJlC,uBAAA,IAAI,iCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,4BAAS,IAAI,MAAA,CAAC;QAClB,uBAAA,IAAI,mCAAiB,uBAAA,IAAI,gCAA2B,CAAC,QAAQ,EAAE,WAAW,MAAA,CAAC;IAC7E,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,SAAuB,EACvB,UAAuB;QAEvB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC;QAC7D,OAAO,IAAI,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,aAAa,CAAC,UAAuB;QAC1C,OAAO,UAAU;YACf,CAAC,CAAC;gBACE,iBAAiB,EAAE,UAAU,CAAC,KAAK;gBACnC,qBAAqB,EAAE,UAAU,CAAC,QAAQ;gBAC1C,2BAA2B,EAAE,UAAU,CAAC,OAAO;aAChD;YACH,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;CACF;;AAxIC;;;;;;;GAOG;AACH,KAAK,0CACH,OAAsB,EACtB,IAAY,EACZ,IAAa;IAEb,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,uBAAA,IAAI,uCAAc,CAAC,MAAM,CAAC;IAC3C,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACjE,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC;IAElD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AACtE,CAAC;AAqBD;;;;;;GAMG;AACH,KAAK,wCAAY,EAAoB,EAAE,OAAgB;IACrD,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,KAAK,GAAG,uBAAA,IAAI,uCAAc,CAAC,EAAE,CAAC;IACpC,MAAM,QAAQ,GAAG,uBAAA,IAAI,uCAAc,CAAC,MAAM,CAAC;IAE3C,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC;IAElD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,MAAM,IAAI,CAAC,mBAAmB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;AACtE,CAAC","sourcesContent":["import { CubeSignerClient, MfaVote, SignerSession } from \".\";\nimport { MfaReceipt } from \"./mfa\";\nimport { AcceptedResponse, NewSessionResponse } from \"./schema_types\";\n\n/**\n * Response type, which can be either a value of type {@link U}\n * or {@link AcceptedResponse} (status code 202) which requires MFA.\n */\nexport type Response<U> = U | AcceptedResponse;\n\n/**\n * Request function which optionally takes additional headers\n * (which, for example, can be used to attach an MFA receipt).\n */\nexport type RequestFn<U> = (headers?: HeadersInit) => Promise<Response<U>>;\n\n/**\n * Map function occasionally used to map a response from the API into a higher-level type.\n */\nexport type MapFn<U, V> = (u: U) => V;\n\n/**\n * Take a {@link Response<U>} and a {@link MapFn<U, V>} function and return\n * a {@link Response<V>} that maps the value of the original response when its status code is 200.\n *\n * @param {Response<U>} resp Original response\n * @param {Map<U, V>} mapFn Map to apply to the response value when its status code is 200.\n * @return {Response<V>} Response whose value for status code 200 is mapped from U to V\n */\nexport function mapResponse<U, V>(resp: Response<U>, mapFn: MapFn<U, V>): Response<V> {\n  if ((resp as AcceptedResponse).accepted?.MfaRequired) {\n    return resp as AcceptedResponse;\n  } else {\n    return mapFn(resp as U);\n  }\n}\n\nexport interface MfaRequired {\n  /** Org id */\n  org_id: string;\n  /** MFA request id */\n  id: string;\n  /** Optional MFA session */\n  session?: NewSessionResponse | null;\n}\n\n/**\n * A response of a CubeSigner request.\n */\nexport class CubeSignerResponse<U> {\n  readonly #requestFn: RequestFn<U>;\n  readonly #resp: U | AcceptedResponse;\n  /**\n   * Optional MFA id. Only set if there is an MFA request associated with the\n   * signing request\n   */\n  readonly #mfaRequired?: MfaRequired;\n\n  /** @return {string} The MFA id associated with this request (if any) */\n  mfaId(): string {\n    return this.#mfaRequired!.id;\n  }\n\n  /** @return {boolean} True if this request requires an MFA approval */\n  requiresMfa(): boolean {\n    return this.#mfaRequired !== undefined;\n  }\n\n  /**\n   * Return session information to use for any MFA approval requests (if any was included in the response).\n   * @return {ClientSessionInfo | undefined}\n   */\n  mfaSessionInfo(): NewSessionResponse | undefined {\n    return (this.#resp as AcceptedResponse).accepted?.MfaRequired?.session ?? undefined;\n  }\n\n  /** @return {U} The response data, if no MFA is required */\n  data(): U {\n    if (this.requiresMfa()) {\n      throw new Error(\"Cannot call `data()` while MFA is required\");\n    }\n    return this.#resp as U;\n  }\n\n  /**\n   * Approve the MFA request using a given session and a TOTP code.\n   *\n   * @param {SignerSession} session Signer session to use\n   * @param {string} code 6-digit TOTP code\n   * @return {CubeSignerResponse<U>} The result of signing with the approval\n   */\n  async approveTotp(session: SignerSession, code: string): Promise<CubeSignerResponse<U>> {\n    return await this.#mfaVoteTotp(session, code, \"approve\");\n  }\n\n  /**\n   * Reject the MFA request using a given session and a TOTP code.\n   *\n   * @param {SignerSession} session Signer session to use\n   * @param {string} code 6-digit TOTP code\n   */\n  async rejectTotp(session: SignerSession, code: string) {\n    await this.#mfaVoteTotp(session, code, \"reject\");\n  }\n\n  /**\n   * Approve or reject an MFA request using a given session and a TOTP code.\n   *\n   * @param {SignerSession} session Signer session to use\n   * @param {string} code 6-digit TOTP code\n   * @param {MfaVote} vote Approve or reject\n   * @return {CubeSignerResponse<U>} The result of signing with the approval\n   */\n  async #mfaVoteTotp(\n    session: SignerSession,\n    code: string,\n    vote: MfaVote,\n  ): Promise<CubeSignerResponse<U>> {\n    if (!this.requiresMfa()) {\n      return this;\n    }\n\n    const mfaId = this.mfaId();\n    const mfaOrgId = this.#mfaRequired!.org_id;\n    const mfaApproval = await session.mfaVoteTotp(mfaId, code, vote);\n    const mfaConf = mfaApproval.receipt?.confirmation;\n\n    if (!mfaConf) {\n      return this;\n    }\n\n    return await this.signWithMfaApproval({ mfaId, mfaOrgId, mfaConf });\n  }\n\n  /**\n   * Approve the MFA request using a given {@link CubeSignerClient} instance (i.e., its session).\n   *\n   * @param {CubeSignerClient} cs CubeSigner whose session to use\n   * @return {CubeSignerResponse<U>} The result of signing with the approval\n   */\n  async approve(cs: CubeSignerClient): Promise<CubeSignerResponse<U>> {\n    return await this.#mfaVoteCs(cs, \"approve\");\n  }\n\n  /**\n   * Reject the MFA request using a given {@link CubeSignerClient} instance (i.e., its session).\n   *\n   * @param {CubeSignerClient} cs CubeSigner client whose session to use\n   */\n  async reject(cs: CubeSignerClient) {\n    await this.#mfaVoteCs(cs, \"reject\");\n  }\n\n  /**\n   * Approve or reject an MFA request using a given {@link CubeSignerClient} instance (i.e., its session).\n   *\n   * @param {CubeSignerClient} cs CubeSigner whose session to use\n   * @param {MfaVote} mfaVote Approve or reject\n   * @return {CubeSignerResponse<U>} The result of signing with the approval\n   */\n  async #mfaVoteCs(cs: CubeSignerClient, mfaVote: MfaVote): Promise<CubeSignerResponse<U>> {\n    if (!this.requiresMfa()) {\n      return this;\n    }\n\n    const mfaId = this.#mfaRequired!.id;\n    const mfaOrgId = this.#mfaRequired!.org_id;\n\n    const mfaApproval = await cs.mfaVoteCs(mfaId, mfaVote);\n    const mfaConf = mfaApproval.receipt?.confirmation;\n\n    if (!mfaConf) {\n      return this;\n    }\n\n    return await this.signWithMfaApproval({ mfaId, mfaOrgId, mfaConf });\n  }\n\n  /**\n   * Resubmits the request with a given MFA receipt attached.\n   *\n   * @param {MfaReceipt} mfaReceipt The MFA receipt\n   * @return {Promise<CubeSignerResponse<U>>} The result of signing after MFA approval\n   */\n  async signWithMfaApproval(mfaReceipt: MfaReceipt): Promise<CubeSignerResponse<U>> {\n    const headers = CubeSignerResponse.getMfaHeaders(mfaReceipt);\n    return new CubeSignerResponse(this.#requestFn, await this.#requestFn(headers));\n  }\n\n  // --------------------------------------------------------------------------\n  // -- INTERNAL --------------------------------------------------------------\n  // --------------------------------------------------------------------------\n\n  /**\n   * Constructor.\n   *\n   * @param {RequestFn} requestFn\n   *    The signing function that this response is from.\n   *    This argument is used to resend requests with different headers if needed.\n   * @param {U | AcceptedResponse} resp The response as returned by the OpenAPI client.\n   * @internal\n   */\n  constructor(requestFn: RequestFn<U>, resp: U | AcceptedResponse) {\n    this.#requestFn = requestFn;\n    this.#resp = resp;\n    this.#mfaRequired = (this.#resp as AcceptedResponse).accepted?.MfaRequired;\n  }\n\n  /**\n   * Static constructor.\n   * @param {RequestFn} requestFn\n   *    The request function that this response is from.\n   *    This argument is used to resend requests with different headers if needed.\n   * @param {MfaReceipt} mfaReceipt Optional MFA receipt\n   * @return {Promise<CubeSignerResponse<U>>} New instance of this class.\n   * @internal\n   */\n  static async create<U>(\n    requestFn: RequestFn<U>,\n    mfaReceipt?: MfaReceipt,\n  ): Promise<CubeSignerResponse<U>> {\n    const seed = await requestFn(this.getMfaHeaders(mfaReceipt));\n    return new CubeSignerResponse(requestFn, seed);\n  }\n\n  /**\n   * Return HTTP headers containing a given MFA receipt.\n   *\n   * @param {MfaReceipt} mfaReceipt MFA receipt\n   * @return {HeadersInit} Headers including that receipt\n   * @internal\n   */\n  static getMfaHeaders(mfaReceipt?: MfaReceipt): HeadersInit | undefined {\n    return mfaReceipt\n      ? {\n          \"x-cubist-mfa-id\": mfaReceipt.mfaId,\n          \"x-cubist-mfa-org-id\": mfaReceipt.mfaOrgId,\n          \"x-cubist-mfa-confirmation\": mfaReceipt.mfaConf,\n        }\n      : undefined;\n  }\n}\n"]}

package/dist/esm/src/role.d.ts

@@ -0,0 +1,289 @@
+import { Key, KeyWithPoliciesInfo, MfaType, PageOpts, RoleInfo, SignerSession, SignerSessionInfo, SignerSessionLifetime, SignerSessionStorage } from ".";
+import { CubeSignerClient } from "./client";
+/**
+ * Restrict transaction receiver.
+ *
+ * @example { TxReceiver: "0x8c594691c0e592ffa21f153a16ae41db5befcaaa" }
+ */
+export type TxReceiver = {
+    TxReceiver: string;
+};
+/** The kind of deposit contracts. */
+export declare enum DepositContract {
+    /** Canonical deposit contract */
+    Canonical = 0,// eslint-disable-line no-unused-vars
+    /** Wrapper deposit contract */
+    Wrapper = 1
+}
+/** Restrict transactions to calls to deposit contract. */
+export type TxDeposit = TxDepositBase | TxDepositPubkey | TxDepositRole;
+/** Restrict transactions to calls to deposit contract*/
+export type TxDepositBase = {
+    TxDeposit: {
+        kind: DepositContract;
+    };
+};
+/**
+ * Restrict transactions to calls to deposit contract with fixed validator (pubkey):
+ *
+ * @example { TxDeposit: { kind: DespositContract.Canonical, validator: { pubkey: "8879...8"} }}
+ */
+export type TxDepositPubkey = {
+    TxDeposit: {
+        kind: DepositContract;
+        pubkey: string;
+    };
+};
+/**
+ * Restrict transactions to calls to deposit contract with any validator key in a role:
+ *
+ * @example { TxDeposit: { kind: DespositContract.Canonical, validator: { role_id: "Role#c63...af"} }}
+ */
+export type TxDepositRole = {
+    TxDeposit: {
+        kind: DepositContract;
+        role_id: string;
+    };
+};
+/**
+ * Only allow connections from clients whose IP addresses match any of these IPv4 CIDR blocks.
+ *
+ * @example { SourceIpAllowlist: [ "123.456.78.9/16" ] }
+ */
+export type SourceIpAllowlist = {
+    SourceIpAllowlist: string[];
+};
+/** All different kinds of sensitive operations. */
+export declare enum OperationKind {
+    BlobSign = "BlobSign",// eslint-disable-line no-unused-vars
+    EvmSign = "Eth1Sign",// eslint-disable-line no-unused-vars
+    Eth2Sign = "Eth2Sign",// eslint-disable-line no-unused-vars
+    Eth2Stake = "Eth2Stake",// eslint-disable-line no-unused-vars
+    Eth2Unstake = "Eth2Unstake",// eslint-disable-line no-unused-vars
+    SolanaSign = "SolanaSign"
+}
+/**
+ * MFA policy
+ *
+ * @example {
+ * {
+ *   count: 1,
+ *   num_auth_factors: 1,
+ *   allowed_mfa_types: [ "Totp" ],
+ *   allowed_approvers: [ "User#123" ],
+ * }
+ */
+export type MfaPolicy = {
+    count?: number;
+    num_auth_factors?: number;
+    allowed_approvers?: string[];
+    allowed_mfa_types?: MfaType[];
+    restricted_operations?: OperationKind[];
+};
+/**
+ * Require MFA for transactions.
+ *
+ * @example {
+ *     RequireMfa: {
+ *       count: 1,
+ *       allowed_mfa_types: [ "Totp" ],
+ *       allowed_approvers: [ "User#123" ],
+ *       restricted_operations: [
+ *         "Eth1Sign",
+ *         "BlobSign"
+ *       ]
+ *     }
+ *   }
+ */
+export type RequireMfa = {
+    RequireMfa: MfaPolicy;
+};
+/** Allow raw blob signing */
+export declare const AllowRawBlobSigning: "AllowRawBlobSigning";
+export type AllowRawBlobSigning = typeof AllowRawBlobSigning;
+/** Allow EIP-191 signing */
+export declare const AllowEip191Signing: "AllowEip191Signing";
+export type AllowEip191Signing = typeof AllowEip191Signing;
+/** Allow EIP-712 signing */
+export declare const AllowEip712Signing: "AllowEip712Signing";
+export type AllowEip712Signing = typeof AllowEip712Signing;
+/** Key policies that restrict the requests that the signing endpoints accept */
+type KeyDenyPolicy = TxReceiver | TxDeposit | SourceIpAllowlist | RequireMfa;
+/**
+ * Key policy
+ *
+ * @example [
+ *   {
+ *     "TxReceiver": "0x8c594691c0e592ffa21f153a16ae41db5befcaaa"
+ *   },
+ *   {
+ *     "TxDeposit": {
+ *       "kind": "Canonical"
+ *     }
+ *   },
+ *   {
+ *     "RequireMfa": {
+ *       "count": 1,
+ *       "allowed_mfa_types": ["CubeSigner"],
+ *       "restricted_operations": [
+ *         "Eth1Sign",
+ *         "BlobSign"
+ *       ]
+ *     }
+ *   }
+ * ]
+ */
+export type KeyPolicy = (KeyDenyPolicy | AllowRawBlobSigning | AllowEip191Signing | AllowEip712Signing)[];
+/** Role policy */
+export type RolePolicy = KeyDenyPolicy[];
+/** A key guarded by a policy. */
+export declare class KeyWithPolicies {
+    #private;
+    readonly keyId: string;
+    readonly policy?: KeyPolicy;
+    /** @return {Promise<Key>} The key */
+    getKey(): Promise<Key>;
+    /**
+     * Constructor.
+     * @param {CubeSignerClient} csc The CubeSigner instance to use for signing.
+     * @param {KeyWithPoliciesInfo} keyWithPolicies The key and its policies
+     * @internal
+     */
+    constructor(csc: CubeSignerClient, keyWithPolicies: KeyWithPoliciesInfo);
+}
+/** Roles. */
+export declare class Role {
+    #private;
+    /** Human-readable name for the role */
+    get name(): string | undefined;
+    /**
+     * The ID of the role.
+     * @example Role#bfe3eccb-731e-430d-b1e5-ac1363e6b06b
+     */
+    get id(): string;
+    /**
+     * @return {RoleInfo} the cached properties of this role. The cached properties
+     * reflect the state of the last fetch or update (e.g., after awaiting
+     * `Role.enabled()` or `Role.disable()`).
+     */
+    get cached(): RoleInfo;
+    /** Delete the role. */
+    delete(): Promise<void>;
+    /** Is the role enabled? */
+    enabled(): Promise<boolean>;
+    /** Enable the role. */
+    enable(): Promise<void>;
+    /** Disable the role. */
+    disable(): Promise<void>;
+    /**
+     * Set new policy (overwriting any policies previously set for this role)
+     * @param {RolePolicy} policy The new policy to set
+     */
+    setPolicy(policy: RolePolicy): Promise<void>;
+    /**
+     * Append to existing role policy. This append is not atomic---it uses
+     * {@link policy} to fetch the current policy and then {@link setPolicy}
+     * to set the policy---and should not be used in across concurrent sessions.
+     *
+     * @param {RolePolicy} policy The policy to append to the existing one.
+     */
+    appendPolicy(policy: RolePolicy): Promise<void>;
+    /**
+     * Get the policy for the role.
+     * @return {Promise<RolePolicy>} The policy for the role.
+     */
+    policy(): Promise<RolePolicy>;
+    /**
+     * The list of all users with access to the role.
+     * @example [
+     *   "User#c3b9379c-4e8c-4216-bd0a-65ace53cf98f",
+     *   "User#5593c25b-52e2-4fb5-b39b-96d41d681d82"
+     * ]
+     *
+     * @param {PageOpts} page Optional pagination options; by default, retrieves all users.
+     */
+    users(page?: PageOpts): Promise<string[]>;
+    /**
+     * Add an existing user to an existing role.
+     *
+     * @param {string} userId The user-id of the user to add to the role.
+     */
+    addUser(userId: string): Promise<void>;
+    /**
+     * Remove an existing user from an existing role.
+     *
+     * @param {string} userId The user-id of the user to remove from the role.
+     */
+    removeUser(userId: string): Promise<void>;
+    /**
+     * The list of keys in the role.
+     * @example [
+     *    {
+     *     id: "Key#bfe3eccb-731e-430d-b1e5-ac1363e6b06b",
+     *     policy: { TxReceiver: "0x8c594691c0e592ffa21f153a16ae41db5befcaaa" }
+     *    },
+     *  ]
+     *
+     * @param {PageOpts} page Optional pagination options; by default, retrieves all keys in this role.
+     */
+    keys(page?: PageOpts): Promise<KeyWithPolicies[]>;
+    /**
+     * Add a list of existing keys to an existing role.
+     *
+     * @param {Key[]} keys The list of keys to add to the role.
+     * @param {KeyPolicy?} policy The optional policy to apply to each key.
+     */
+    addKeys(keys: Key[], policy?: KeyPolicy): Promise<void>;
+    /**
+     * Add an existing key to an existing role.
+     *
+     * @param {Key} key The key to add to the role.
+     * @param {KeyPolicy?} policy The optional policy to apply to the key.
+     */
+    addKey(key: Key, policy?: KeyPolicy): Promise<void>;
+    /**
+     * Remove an existing key from an existing role.
+     *
+     * @param {Key} key The key to remove from the role.
+     */
+    removeKey(key: Key): Promise<void>;
+    /**
+     * Create a new session for this role.
+     * @param {SignerSessionStorage} storage The session storage to use
+     * @param {string} purpose Descriptive purpose.
+     * @param {SignerSessionLifetime} lifetimes Optional session lifetimes.
+     * @param {string[]} scopes Session scopes. Only `sign:*` scopes are allowed.
+     * @return {Promise<SignerSession>} New signer session.
+     */
+    createSession(storage: SignerSessionStorage, purpose: string, lifetimes?: SignerSessionLifetime, scopes?: string[]): Promise<SignerSession>;
+    /**
+     * List all signer sessions for this role. Returned objects can be used to
+     * revoke individual sessions, but they cannot be used for authentication.
+     *
+     * @param {PageOpts} page Optional pagination options; by default, retrieves all sessions.
+     * @return {Promise<SignerSessionInfo[]>} Signer sessions for this role.
+     */
+    sessions(page?: PageOpts): Promise<SignerSessionInfo[]>;
+    /**
+     * Constructor.
+     * @param {CubeSignerClient} csc The CubeSigner instance to use for signing.
+     * @param {RoleInfo} data The JSON response from the API server.
+     * @internal
+     */
+    constructor(csc: CubeSignerClient, data: RoleInfo);
+    /**
+     * Update the role.
+     *
+     * @param {UpdateRoleRequest} request The JSON request to send to the API server.
+     * @return {Promise<RoleInfo>} The updated role information.
+     */
+    private update;
+    /**
+     * Fetches the role information.
+     *
+     * @return {RoleInfo} The role information.
+     * @internal
+     */
+    private fetch;
+}
+export {};