@cubist-labs/cubesigner-sdk 0.2.24 → 0.3.1

package/dist/cjs/src/events.js

@@ -0,0 +1,195 @@
+"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 _EventDispatcher_handlers, _Events_onError, _Events_onSessionExpired, _EventEmitter_events;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GlobalEvents = exports.EventEmitter = exports.Events = exports.messageMatchesSessionExpired = void 0;
+/**
+ * Dispatcher for a single event type.
+ *
+ * Provides methods for registering and unregistering handlers,
+ * as well as dispatching events to all registered handlers.
+ */
+class EventDispatcher {
+    /**
+     * Constructor.
+     */
+    constructor() {
+        _EventDispatcher_handlers.set(this, void 0);
+        __classPrivateFieldSet(this, _EventDispatcher_handlers, [], "f");
+    }
+    /**
+     * Register a new handler.
+     *
+     * @param {EventHandler<T>} handler Event handler to register
+     * @return {EventDispatcher<T>} This instance to allow for chaining.
+     */
+    register(handler) {
+        __classPrivateFieldGet(this, _EventDispatcher_handlers, "f").push(handler);
+        return this;
+    }
+    /**
+     * Unregister a handler. If {@link handler} is not already registered, it's a no-op.
+     *
+     * @param {EventHandler<T>} handler Event handler to unregister
+     * @return {boolean} Whether the handler was found (and unregistered).
+     */
+    unregister(handler) {
+        const idx = __classPrivateFieldGet(this, _EventDispatcher_handlers, "f").indexOf(handler);
+        if (idx >= 0) {
+            __classPrivateFieldGet(this, _EventDispatcher_handlers, "f").splice(idx, 1);
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    /**
+     * Dispatch an event to all registered handlers.
+     * @param {T} event Event to dispatch.
+     */
+    async dispatch(event) {
+        await Promise.all(__classPrivateFieldGet(this, _EventDispatcher_handlers, "f").map((h) => h(event)));
+    }
+}
+_EventDispatcher_handlers = new WeakMap();
+const SessionExpiredRegexes = [
+    /^Session '(?<purpose>[^']*)' for '(?<identity>[^']*)' has expired$/,
+    /^Session '(?<purpose>[^']*)' for '(?<identity>[^']*)' has been revoked$/,
+    /^Auth token for epoch (?<epoch>\d+) has expired$/,
+    /^Refresh token for epoch (?<epoch_num>\d+) has expired$/,
+    /^Outdated session$/,
+];
+/**
+ * Whether an error message matches one of several different "session expired" responses.
+ *
+ * @param {string} msg The string to test.
+ * @return {boolean} Whether the string matches.
+ * @internal Exported only so that it can be called from a unit test
+ */
+function messageMatchesSessionExpired(msg) {
+    return SessionExpiredRegexes.some((re) => re.test(msg));
+}
+exports.messageMatchesSessionExpired = messageMatchesSessionExpired;
+/**
+ * Class for registering and unregistering event handlers.
+ */
+class Events {
+    constructor() {
+        _Events_onError.set(this, new EventDispatcher());
+        _Events_onSessionExpired.set(this, new EventDispatcher());
+    }
+    /**
+     * Register a handler for {@link ErrorEvent}: triggered every time a request to
+     * a CubeSigner API endpoint returns a non-success response.
+     *
+     * @param {EventHandler<ErrorEvent>} handler The handler to register.
+     */
+    onError(handler) {
+        __classPrivateFieldGet(this, _Events_onError, "f").register(handler);
+    }
+    /**
+     * Register a handler for {@link SessionExpiredEvent}: triggered every time a
+     * request to a CubeSigner API endpoint fails because of an expired session.
+     *
+     * @param {EventHandler<SessionExpiredEvent>} handler The handler to register.
+     */
+    onSessionExpired(handler) {
+        __classPrivateFieldGet(this, _Events_onSessionExpired, "f").register(handler);
+    }
+    /**
+     * Unregister a handler for {@link ErrorEvent}.
+     *
+     * @param {EventHandler<ErrorEvent>} handler The handler to unregister.
+     * @return {boolean} Whether the handler was found (and unregistered).
+     */
+    unregisterOnError(handler) {
+        return __classPrivateFieldGet(this, _Events_onError, "f").unregister(handler);
+    }
+    /**
+     * Unregister a handler for {@link SessionExpiredEvent}.
+     *
+     * @param {EventHandler<SessionExpiredEvent>} handler The handler to unregister.
+     * @return {boolean} Whether the handler was found (and unregistered).
+     */
+    unregisterOnSessionExpired(handler) {
+        return __classPrivateFieldGet(this, _Events_onSessionExpired, "f").unregister(handler);
+    }
+    /** @internal */
+    async triggerSessionExpired() {
+        await __classPrivateFieldGet(this, _Events_onSessionExpired, "f").dispatch({});
+    }
+    /**
+     * @param {ErrorEvent} event Event to trigger
+     * @internal
+     */
+    async triggerErrorEvent(event) {
+        await __classPrivateFieldGet(this, _Events_onError, "f").dispatch(event);
+    }
+}
+exports.Events = Events;
+_Events_onError = new WeakMap(), _Events_onSessionExpired = new WeakMap();
+/**
+ * Used to classify and emit events to one or more {@link Events} instances.
+ */
+class EventEmitter {
+    /**
+     *
+     * @param {Events[]} events Instances to which to emit events
+     * @param {boolean} skipGlobal Whether to include the global events instance {@link GlobalEvents}
+     */
+    constructor(events, skipGlobal) {
+        _EventEmitter_events.set(this, void 0);
+        skipGlobal ??= false;
+        __classPrivateFieldSet(this, _EventEmitter_events, events, "f");
+        if (!skipGlobal) {
+            __classPrivateFieldGet(this, _EventEmitter_events, "f").push(exports.GlobalEvents);
+        }
+    }
+    /**
+     * Called by {@link CubeSignerApi} when an API response indicates an error.
+     *
+     * @param {ErrorEvent} err The error to dispatch.
+     * @internal
+     */
+    async classifyAndEmitError(err) {
+        for (const ev of __classPrivateFieldGet(this, _EventEmitter_events, "f")) {
+            await ev.triggerErrorEvent(err);
+        }
+        // if status is 403 and error matches one of the SessionExpiredRegexes trigger onSessionExpired
+        //
+        // TODO: because errors returned by the authorizer lambda are not forwarded to the client
+        //       we also trigger onSessionExpired when "signerSessionRefresh" fails
+        if (err.status === 403 &&
+            (messageMatchesSessionExpired(err.message) || err.operation == "signerSessionRefresh")) {
+            await this.emitSessionExpired();
+        }
+    }
+    /**
+     * Called by {@link SignerSessionManager} to notify that the session is expired
+     * beyond the possibility of refreshing, meaning that full re-login is required.
+     *
+     * @internal
+     */
+    async emitSessionExpired() {
+        for (const e of __classPrivateFieldGet(this, _EventEmitter_events, "f")) {
+            await e.triggerSessionExpired();
+        }
+    }
+}
+exports.EventEmitter = EventEmitter;
+_EventEmitter_events = new WeakMap();
+/**
+ * Global events.
+ */
+exports.GlobalEvents = new Events();
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../src/events.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAQA;;;;;GAKG;AACH,MAAM,eAAe;IAGnB;;OAEG;IACH;QALS,4CAA6B;QAMpC,uBAAA,IAAI,6BAAa,EAAE,MAAA,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,OAAwB;QAC/B,uBAAA,IAAI,iCAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,OAAwB;QACjC,MAAM,GAAG,GAAG,uBAAA,IAAI,iCAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC5C,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;YACb,uBAAA,IAAI,iCAAU,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CAAC,KAAQ;QACrB,MAAM,OAAO,CAAC,GAAG,CAAC,uBAAA,IAAI,iCAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;CACF;;AAED,MAAM,qBAAqB,GAAG;IAC5B,oEAAoE;IACpE,yEAAyE;IACzE,kDAAkD;IAClD,yDAAyD;IACzD,oBAAoB;CACrB,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,4BAA4B,CAAC,GAAW;IACtD,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAC1D,CAAC;AAFD,oEAEC;AAED;;GAEG;AACH,MAAa,MAAM;IAAnB;QACW,0BAAW,IAAI,eAAe,EAAc,EAAC;QAC7C,mCAAoB,IAAI,eAAe,EAAuB,EAAC;IAsD1E,CAAC;IApDC;;;;;OAKG;IACH,OAAO,CAAC,OAAiC;QACvC,uBAAA,IAAI,uBAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CAAC,OAA0C;QACzD,uBAAA,IAAI,gCAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAC,OAAiC;QACjD,OAAO,uBAAA,IAAI,uBAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CAAC,OAA0C;QACnE,OAAO,uBAAA,IAAI,gCAAkB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,qBAAqB;QACzB,MAAM,uBAAA,IAAI,gCAAkB,CAAC,QAAQ,CAAsB,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,KAAiB;QACvC,MAAM,uBAAA,IAAI,uBAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC;CACF;AAxDD,wBAwDC;;AAED;;GAEG;AACH,MAAa,YAAY;IAGvB;;;;OAIG;IACH,YAAY,MAAgB,EAAE,UAAoB;QAPzC,uCAAkB;QAQzB,UAAU,KAAK,KAAK,CAAC;QACrB,uBAAA,IAAI,wBAAW,MAAM,MAAA,CAAC;QACtB,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,uBAAA,IAAI,4BAAQ,CAAC,IAAI,CAAC,oBAAY,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,oBAAoB,CAAC,GAAe;QACxC,KAAK,MAAM,EAAE,IAAI,uBAAA,IAAI,4BAAQ,EAAE,CAAC;YAC9B,MAAM,EAAE,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC;QAED,+FAA+F;QAC/F,EAAE;QACF,yFAAyF;QACzF,2EAA2E;QAC3E,IACE,GAAG,CAAC,MAAM,KAAK,GAAG;YAClB,CAAC,4BAA4B,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,SAAS,IAAI,sBAAsB,CAAC,EACtF,CAAC;YACD,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,kBAAkB;QACtB,KAAK,MAAM,CAAC,IAAI,uBAAA,IAAI,4BAAQ,EAAE,CAAC;YAC7B,MAAM,CAAC,CAAC,qBAAqB,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;CACF;AAlDD,oCAkDC;;AAED;;GAEG;AACU,QAAA,YAAY,GAAG,IAAI,MAAM,EAAE,CAAC","sourcesContent":["import { ErrResponse } from \"./error\";\n\nexport type EventHandler<T> = (event: T) => Promise<void>;\nexport type ErrorEvent = ErrResponse;\n\n/* eslint-disable-next-line @typescript-eslint/no-empty-interface */\nexport interface SessionExpiredEvent {}\n\n/**\n * Dispatcher for a single event type.\n *\n * Provides methods for registering and unregistering handlers,\n * as well as dispatching events to all registered handlers.\n */\nclass EventDispatcher<T> {\n  readonly #handlers: EventHandler<T>[];\n\n  /**\n   * Constructor.\n   */\n  constructor() {\n    this.#handlers = [];\n  }\n\n  /**\n   * Register a new handler.\n   *\n   * @param {EventHandler<T>} handler Event handler to register\n   * @return {EventDispatcher<T>} This instance to allow for chaining.\n   */\n  register(handler: EventHandler<T>): EventDispatcher<T> {\n    this.#handlers.push(handler);\n    return this;\n  }\n\n  /**\n   * Unregister a handler. If {@link handler} is not already registered, it's a no-op.\n   *\n   * @param {EventHandler<T>} handler Event handler to unregister\n   * @return {boolean} Whether the handler was found (and unregistered).\n   */\n  unregister(handler: EventHandler<T>): boolean {\n    const idx = this.#handlers.indexOf(handler);\n    if (idx >= 0) {\n      this.#handlers.splice(idx, 1);\n      return true;\n    } else {\n      return false;\n    }\n  }\n\n  /**\n   * Dispatch an event to all registered handlers.\n   * @param {T} event Event to dispatch.\n   */\n  async dispatch(event: T): Promise<void> {\n    await Promise.all(this.#handlers.map((h) => h(event)));\n  }\n}\n\nconst SessionExpiredRegexes = [\n  /^Session '(?<purpose>[^']*)' for '(?<identity>[^']*)' has expired$/,\n  /^Session '(?<purpose>[^']*)' for '(?<identity>[^']*)' has been revoked$/,\n  /^Auth token for epoch (?<epoch>\\d+) has expired$/,\n  /^Refresh token for epoch (?<epoch_num>\\d+) has expired$/,\n  /^Outdated session$/,\n];\n\n/**\n * Whether an error message matches one of several different \"session expired\" responses.\n *\n * @param {string} msg The string to test.\n * @return {boolean} Whether the string matches.\n * @internal Exported only so that it can be called from a unit test\n */\nexport function messageMatchesSessionExpired(msg: string): boolean {\n  return SessionExpiredRegexes.some((re) => re.test(msg));\n}\n\n/**\n * Class for registering and unregistering event handlers.\n */\nexport class Events {\n  readonly #onError = new EventDispatcher<ErrorEvent>();\n  readonly #onSessionExpired = new EventDispatcher<SessionExpiredEvent>();\n\n  /**\n   * Register a handler for {@link ErrorEvent}: triggered every time a request to\n   * a CubeSigner API endpoint returns a non-success response.\n   *\n   * @param {EventHandler<ErrorEvent>} handler The handler to register.\n   */\n  onError(handler: EventHandler<ErrorEvent>) {\n    this.#onError.register(handler);\n  }\n\n  /**\n   * Register a handler for {@link SessionExpiredEvent}: triggered every time a\n   * request to a CubeSigner API endpoint fails because of an expired session.\n   *\n   * @param {EventHandler<SessionExpiredEvent>} handler The handler to register.\n   */\n  onSessionExpired(handler: EventHandler<SessionExpiredEvent>) {\n    this.#onSessionExpired.register(handler);\n  }\n\n  /**\n   * Unregister a handler for {@link ErrorEvent}.\n   *\n   * @param {EventHandler<ErrorEvent>} handler The handler to unregister.\n   * @return {boolean} Whether the handler was found (and unregistered).\n   */\n  unregisterOnError(handler: EventHandler<ErrorEvent>): boolean {\n    return this.#onError.unregister(handler);\n  }\n\n  /**\n   * Unregister a handler for {@link SessionExpiredEvent}.\n   *\n   * @param {EventHandler<SessionExpiredEvent>} handler The handler to unregister.\n   * @return {boolean} Whether the handler was found (and unregistered).\n   */\n  unregisterOnSessionExpired(handler: EventHandler<SessionExpiredEvent>): boolean {\n    return this.#onSessionExpired.unregister(handler);\n  }\n\n  /** @internal */\n  async triggerSessionExpired() {\n    await this.#onSessionExpired.dispatch(<SessionExpiredEvent>{});\n  }\n\n  /**\n   * @param {ErrorEvent} event Event to trigger\n   * @internal\n   */\n  async triggerErrorEvent(event: ErrorEvent) {\n    await this.#onError.dispatch(event);\n  }\n}\n\n/**\n * Used to classify and emit events to one or more {@link Events} instances.\n */\nexport class EventEmitter {\n  readonly #events: Events[];\n\n  /**\n   *\n   * @param {Events[]} events Instances to which to emit events\n   * @param {boolean} skipGlobal Whether to include the global events instance {@link GlobalEvents}\n   */\n  constructor(events: Events[], skipGlobal?: boolean) {\n    skipGlobal ??= false;\n    this.#events = events;\n    if (!skipGlobal) {\n      this.#events.push(GlobalEvents);\n    }\n  }\n\n  /**\n   * Called by {@link CubeSignerApi} when an API response indicates an error.\n   *\n   * @param {ErrorEvent} err The error to dispatch.\n   * @internal\n   */\n  async classifyAndEmitError(err: ErrorEvent) {\n    for (const ev of this.#events) {\n      await ev.triggerErrorEvent(err);\n    }\n\n    // if status is 403 and error matches one of the SessionExpiredRegexes trigger onSessionExpired\n    //\n    // TODO: because errors returned by the authorizer lambda are not forwarded to the client\n    //       we also trigger onSessionExpired when \"signerSessionRefresh\" fails\n    if (\n      err.status === 403 &&\n      (messageMatchesSessionExpired(err.message) || err.operation == \"signerSessionRefresh\")\n    ) {\n      await this.emitSessionExpired();\n    }\n  }\n\n  /**\n   * Called by {@link SignerSessionManager} to notify that the session is expired\n   * beyond the possibility of refreshing, meaning that full re-login is required.\n   *\n   * @internal\n   */\n  async emitSessionExpired() {\n    for (const e of this.#events) {\n      await e.triggerSessionExpired();\n    }\n  }\n}\n\n/**\n * Global events.\n */\nexport const GlobalEvents = new Events();\n"]}

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

@@ -0,0 +1,203 @@
+import { EnvInterface } from "./env";
+import { Client } from "./api";
+import { CubeSignerClient } from "./client";
+import { Org } from "./org";
+import { SignerSessionStorage, SignerSessionManager, SignerSessionData } from "./session/signer_session_manager";
+import { CubeSignerResponse } from "./response";
+import { SignerSession } from "./signer_session";
+import { MfaReceipt } from "./mfa";
+import { IdentityProof, MfaRequestInfo, RatchetConfig, UserInfo } from "./schema_types";
+/** CubeSigner constructor options */
+export interface CubeSignerOptions {
+    /** The environment to use */
+    env?: EnvInterface;
+    /** The management authorization token */
+    sessionMgr?: SignerSessionManager;
+    /** Optional organization id */
+    orgId?: string;
+}
+/**
+ * CubeSigner client
+ *
+ * @deprecated Use {@link Org} or {@link CubeSignerClient} instead.
+ */
+export declare class CubeSigner {
+    #private;
+    readonly sessionMgr?: SignerSessionManager;
+    /**
+     * Underlying {@link CubeSignerClient} instance, if set; otherwise throws.
+     * @internal
+     */
+    get csc(): CubeSignerClient;
+    /** @return {EnvInterface} The CubeSigner environment of this client */
+    get env(): EnvInterface;
+    /** Organization ID */
+    get orgId(): string;
+    /**
+     * Set the organization ID
+     * @param {string} orgId The new organization id.
+     */
+    setOrgId(orgId: string): void;
+    /**
+     * Loads an existing management session and creates a CubeSigner instance.
+     *
+     * @param {SignerSessionStorage} storage Session storage to load the session from.
+     * @return {Promise<CubeSigner>} New CubeSigner instance
+     */
+    static loadManagementSession(storage: SignerSessionStorage): Promise<CubeSigner>;
+    /**
+     * Loads a signer session from a session storage (e.g., session file).
+     * @param {SignerSessionStorage} storage Session storage to load the session from.
+     * @return {Promise<SignerSession>} New signer session
+     */
+    static loadSignerSession(storage: SignerSessionStorage): Promise<SignerSession>;
+    /**
+     * Create a new CubeSigner instance.
+     * @param {CubeSignerOptions} options The optional configuration options for the CubeSigner instance.
+     */
+    constructor(options?: CubeSignerOptions);
+    /**
+     * Authenticate an OIDC user and create a new session manager for them.
+     *
+     * @param {string} oidcToken The OIDC token
+     * @param {string} orgId The id of the organization that the user is in
+     * @param {List<string>} scopes The scopes of the resulting session
+     * @param {RatchetConfig} lifetimes Lifetimes of the new session.
+     * @param {SignerSessionStorage?} storage Optional signer session storage (defaults to in-memory storage)
+     * @return {Promise<SignerSessionManager>} The signer session manager
+     */
+    oidcAuth(oidcToken: string, orgId: string, scopes: Array<string>, lifetimes?: RatchetConfig, storage?: SignerSessionStorage): Promise<SignerSessionManager>;
+    /**
+     * Retrieves information about the current user.
+     *
+     * @return {Promise<UserInfo>} User information.
+     */
+    aboutMe(): Promise<UserInfo>;
+    /**
+     * Retrieves existing MFA request.
+     *
+     * @param {string} orgId Organization ID
+     * @param {string} mfaId MFA request ID
+     * @return {Promise<MfaRequestInfo>} MFA request information
+     */
+    mfaGet(orgId: string, mfaId: string): Promise<MfaRequestInfo>;
+    /**
+     * List pending MFA requests accessible to the current user.
+     * @param {string} orgId Organization ID
+     * @return {Promise<MfaRequestInfo[]>} The MFA requests.
+     */
+    mfaList(orgId: string): Promise<MfaRequestInfo[]>;
+    /**
+     * Approve a pending MFA request.
+     *
+     * @param {string} orgId The org id of the MFA request
+     * @param {string} mfaId The id of the MFA request
+     * @return {Promise<MfaRequestInfo>} The result of the MFA request
+     */
+    mfaApprove(orgId: string, mfaId: string): Promise<MfaRequestInfo>;
+    /** Initiate adding a new FIDO device. MFA may be required. */
+    get addFidoStart(): (name: string, mfaReceipt?: MfaReceipt | undefined) => Promise<CubeSignerResponse<import("./mfa").AddFidoChallenge>>;
+    /**
+     * Creates a request to change user's TOTP. This request returns a new TOTP challenge
+     * that must be answered by calling `resetTotpComplete`
+     */
+    get resetTotpStart(): (issuer?: string | undefined, mfaReceipt?: MfaReceipt | undefined) => Promise<CubeSignerResponse<import("./mfa").TotpChallenge>>;
+    /**
+     * Answer the TOTP challenge issued by `resetTotpStart`. If successful, user's
+     * TOTP configuration will be updated to that of the TOTP challenge.he TOTP configuration from the challenge.
+     */
+    get resetTotpComplete(): (totpId: string, code: string) => Promise<void>;
+    /**
+     * Verifies a given TOTP code against the current user's TOTP configuration.
+     * Throws an error if the verification fails.
+     */
+    get verifyTotp(): (code: string) => Promise<void>;
+    /**
+     * Retrieve information about an organization.
+     * @param {string} orgId The ID or name of the organization.
+     * @return {Org} The organization.
+     */
+    getOrg(orgId?: string): Promise<Org>;
+    /**
+     * Deletes a given key.
+     * @param {string} orgId - Organization id
+     * @param {string} keyId - Key id
+     */
+    deleteKey(orgId: string, keyId: string): Promise<void>;
+    /**
+     * Get the management client.
+     * @return {Client} The client.
+     * @internal
+     */
+    management(): Promise<Client>;
+    /**
+     * Obtain a proof of authentication.
+     *
+     * @param {string} orgId The id of the organization that the user is in
+     * @return {Promise<IdentityProof>} Proof of authentication
+     */
+    proveIdentity(orgId: string): Promise<IdentityProof>;
+    /**
+     * Exchange an OIDC token for a proof of authentication.
+     *
+     * @param {string} oidcToken The OIDC token
+     * @param {string} orgId The id of the organization that the user is in
+     * @return {Promise<IdentityProof>} Proof of authentication
+     */
+    oidcProveIdentity(oidcToken: string, orgId: string): Promise<IdentityProof>;
+    /**
+     * Checks if a given identity proof is valid.
+     *
+     * @param {string} orgId The id of the organization that the user is in.
+     * @param {IdentityProof} identityProof The proof of authentication.
+     */
+    verifyIdentity(orgId: string, identityProof: IdentityProof): Promise<void>;
+    /**
+     * Exchange an OIDC token for a CubeSigner session token.
+     * @param {string} oidcToken The OIDC token
+     * @param {string} orgId The id of the organization that the user is in
+     * @param {List<string>} scopes The scopes of the resulting session
+     * @param {RatchetConfig} lifetimes Lifetimes of the new session.
+     * @param {MfaReceipt} mfaReceipt Optional MFA receipt (id + confirmation code)
+     * @return {Promise<CubeSignerResponse<SignerSessionData>>} The session data.
+     */
+    oidcLogin(oidcToken: string, orgId: string, scopes: Array<string>, lifetimes?: RatchetConfig, mfaReceipt?: MfaReceipt): Promise<CubeSignerResponse<SignerSessionData>>;
+}
+/** Errors */
+export * from "./error";
+/** API */
+export * from "./api";
+/** Client */
+export * from "./client";
+/** Callbacks */
+export { Events, EventHandler, ErrorEvent, GlobalEvents, SessionExpiredEvent } from "./events";
+/** Organizations */
+export * from "./org";
+/** Keys */
+export * from "./key";
+/** Roles */
+export * from "./role";
+/** Env */
+export * from "./env";
+/** Fido */
+export * from "./mfa";
+/** Pagination */
+export * from "./paginator";
+/** Response */
+export * from "./response";
+/** Types */
+export * from "./schema_types";
+/** Sessions */
+export * from "./signer_session";
+/** Session storage */
+export * from "./session/session_storage";
+/** Signer session manager */
+export * from "./session/signer_session_manager";
+/** Utils */
+export * from "./util";
+/** User-export decryption helper */
+export { userExportDecrypt, userExportKeygen } from "./user_export";
+/** CubeSigner SDK package name */
+export declare const NAME: string;
+/** CubeSigner SDK version */
+export declare const VERSION: string;