@account-kit/signer 4.0.0-alpha.5 → 4.0.0-alpha.6

package/dist/types/client/base.d.ts

@@ -31,7 +31,20 @@ export declare abstract class BaseSignerClient<TExportWalletParams = unknown> {
     constructor(params: BaseSignerClientParams);
     protected get user(): User | undefined;
     protected set user(user: User | undefined);
+    /**
+     * Sets the stamper of the TurnkeyClient.
+     *
+     * @param {TurnkeyClient["stamper"]} stamper the stamper function to set for the TurnkeyClient
+     */
     protected setStamper(stamper: TurnkeyClient["stamper"]): void;
+    /**
+     * Exports wallet credentials based on the specified type, either as a SEED_PHRASE or PRIVATE_KEY.
+     *
+     * @param {object} params The parameters for exporting the wallet
+     * @param {ExportWalletStamper} params.exportStamper The stamper used for exporting the wallet
+     * @param {"SEED_PHRASE" | "PRIVATE_KEY"} params.exportAs Specifies the format for exporting the wallet, either as a SEED_PHRASE or PRIVATE_KEY
+     * @returns {Promise<boolean>} A promise that resolves to true if the export is successful
+     */
     protected exportWalletInner(params: {
         exportStamper: ExportWalletStamper;
         exportAs: "SEED_PHRASE" | "PRIVATE_KEY";
@@ -53,13 +66,33 @@ export declare abstract class BaseSignerClient<TExportWalletParams = unknown> {
     /**
      * Listen to events emitted by the client
      *
-     * @param event the event you want to listen to
-     * @param listener the callback function to execute when an event is fired
-     * @returns a function that will remove the listener when called
+     * @param {AlchemySignerClientEvent} event the event you want to listen to
+     * @param {AlchemySignerClientEvents[AlchemySignerClientEvent]} listener the callback function to execute when an event is fired
+     * @returns {() => void} a function that will remove the listener when called
      */
     on: <E extends keyof AlchemySignerClientEvents>(event: E, listener: AlchemySignerClientEvents[E]) => () => EventEmitter<AlchemySignerClientEvents, any>;
+    /**
+     * Handles the creation of authenticators using WebAuthn attestation and the provided options. Requires the user to be authenticated.
+     *
+     * @param {CredentialCreationOptions} options The options used to create the WebAuthn attestation
+     * @returns {Promise<string[]>} A promise that resolves to an array of authenticator IDs
+     * @throws {NotAuthenticatedError} If the user is not authenticated
+     */
     addPasskey: (options: CredentialCreationOptions) => Promise<string[]>;
+    /**
+     * Retrieves the current user or fetches the user information if not already available.
+     *
+     * @param {string} [orgId] optional organization ID, defaults to the user's organization ID
+     * @returns {Promise<User>} A promise that resolves to the user object
+     * @throws {Error} if no organization ID is provided when there is no current user
+     */
     whoami: (orgId?: string | undefined) => Promise<User>;
+    /**
+     * Looks up information based on an email address.
+     *
+     * @param {string} email the email address to look up
+     * @returns {Promise<any>} the result of the lookup request
+     */
     lookupUserByEmail: (email: string) => Promise<{
         orgId: string | null;
     }>;
@@ -68,11 +101,24 @@ export declare abstract class BaseSignerClient<TExportWalletParams = unknown> {
      * For SignMessage or SignTypedData, the caller should hash the message before calling this method and pass
      * that result here.
      *
-     * @param msg the hex representation of the bytes to sign
-     * @returns the signature over the raw hex
+     * @param {Hex} msg the hex representation of the bytes to sign
+     * @returns {Promise<Hex>} the signature over the raw hex
+     */
+    signRawMessage: (msg: Hex) => Promise<Hex>;
+    /**
+     * Returns the current user or null if no user is set.
+     *
+     * @returns {User | null} the current user object or null if no user is available
      */
-    signRawMessage: (msg: Hex) => Promise<`0x${string}`>;
     getUser: () => User | null;
+    /**
+     * Sends a POST request to the given signer route with the specified body and returns the response.
+     * Not intended to be used directly, use the specific methods instead on the client instead.
+     *
+     * @param {SignerRoutes} route The route to which the request should be sent
+     * @param {SignerBody<R>} body The request body containing the data to be sent
+     * @returns {Promise<SignerResponse<R>>} A promise that resolves to the response from the signer
+     */
     request: <R extends "/v1/signup" | "/v1/whoami" | "/v1/auth" | "/v1/lookup" | "/v1/sign-payload">(route: R, body: SignerBody<R>) => Promise<SignerResponse<R>>;
     private exportAsSeedPhrase;
     private exportAsPrivateKey;

package/dist/types/client/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/client/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAA0B,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAGhC,OAAO,KAAK,EAEV,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EACf,4BAA4B,EAC5B,UAAU,EACV,cAAc,EAEd,cAAc,EACd,IAAI,EACL,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAClC,UAAU,EAAE,gBAAgB,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC,SAAS,CAAC,GAAG;IAC3D,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,8BAAsB,gBAAgB,CAAC,mBAAmB,GAAG,OAAO;IAClE,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,SAAS,CAAC,aAAa,EAAE,aAAa,CAAC;IACvC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,yBAAyB,CAAC,CAAC;IAEhE;;;;OAIG;gBACS,MAAM,EAAE,sBAAsB;IAY1C,SAAS,KAAK,IAAI,IAIO,IAAI,GAAG,SAAS,CAFxC;IAED,SAAS,KAAK,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,EAQxC;IAED,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC;IAItD,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE;QAClC,aAAa,EAAE,mBAAmB,CAAC;QACnC,QAAQ,EAAE,aAAa,GAAG,aAAa,CAAC;KACzC,GAAG,OAAO,CAAC,OAAO,CAAC;aAWJ,aAAa,CAC3B,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,cAAc,CAAC;aAEV,aAAa,CAC3B,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC,GAC/C,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;aAEb,iBAAiB,CAAC,MAAM,EAAE;QACxC,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;aAED,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;aAE3B,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;aAE3D,qBAAqB,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEjE,SAAS,CAAC,QAAQ,CAAC,sBAAsB,CACvC,OAAO,EAAE,yBAAyB,EAClC,WAAW,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GACjC,OAAO,CAAC,4BAA4B,CAAC;IAMxC;;;;;;OAMG;IACI,EAAE,sJAOP;IAEK,UAAU,YAAmB,yBAAyB,uBA+B3D;IAEK,MAAM,kCAAqC,QAAQ,IAAI,CAAC,CAgC7D;IAEK,iBAAiB,UAAiB,MAAM;;OAE7C;IAEF;;;;;;;OAOG;IACI,cAAc,QAAe,GAAG,4BAsBrC;IAEK,OAAO,QAAO,IAAI,GAAG,IAAI,CAE9B;IAEK,OAAO,wJA4BZ;IAKF,OAAO,CAAC,kBAAkB,CAmDxB;IAEF,OAAO,CAAC,kBAAkB,CA4BxB;IAEF,SAAS,CAAC,sBAAsB,0uCAKpB,QACR,WAAW,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC,CAAC,CACvD,CAAC,UAAU,CAAC,kBACG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAsCtB;CAEH"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/client/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,gBAAgB,EAA0B,MAAM,cAAc,CAAC;AAC7E,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,YAAY,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAGhC,OAAO,KAAK,EAEV,yBAAyB,EACzB,mBAAmB,EACnB,eAAe,EACf,4BAA4B,EAC5B,UAAU,EACV,cAAc,EAEd,cAAc,EACd,IAAI,EACL,MAAM,YAAY,CAAC;AAEpB,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC;IAClC,UAAU,EAAE,gBAAgB,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG,aAAa,CAAC,SAAS,CAAC,GAAG;IAC3D,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3D,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACxD,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,8BAAsB,gBAAgB,CAAC,mBAAmB,GAAG,OAAO;IAClE,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,gBAAgB,CAAmB;IAC3C,SAAS,CAAC,aAAa,EAAE,aAAa,CAAC;IACvC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,YAAY,EAAE,YAAY,CAAC,yBAAyB,CAAC,CAAC;IAEhE;;;;OAIG;gBACS,MAAM,EAAE,sBAAsB;IAY1C,SAAS,KAAK,IAAI,IAIO,IAAI,GAAG,SAAS,CAFxC;IAED,SAAS,KAAK,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,SAAS,EAQxC;IAED;;;;OAIG;IACH,SAAS,CAAC,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,SAAS,CAAC;IAItD;;;;;;;OAOG;IACH,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE;QAClC,aAAa,EAAE,mBAAmB,CAAC;QACnC,QAAQ,EAAE,aAAa,GAAG,aAAa,CAAC;KACzC,GAAG,OAAO,CAAC,OAAO,CAAC;aAWJ,aAAa,CAC3B,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,cAAc,CAAC;aAEV,aAAa,CAC3B,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,iBAAiB,CAAC,GAC/C,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;aAEb,iBAAiB,CAAC,MAAM,EAAE;QACxC,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;aAED,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;aAE3B,YAAY,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC;aAE3D,qBAAqB,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAEjE,SAAS,CAAC,QAAQ,CAAC,sBAAsB,CACvC,OAAO,EAAE,yBAAyB,EAClC,WAAW,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GACjC,OAAO,CAAC,4BAA4B,CAAC;IAMxC;;;;;;OAMG;IACI,EAAE,sJAOP;IAEF;;;;;;OAMG;IACI,UAAU,YAAmB,yBAAyB,uBA+B3D;IAEF;;;;;;OAMG;IACI,MAAM,kCAAqC,QAAQ,IAAI,CAAC,CAgC7D;IAEF;;;;;OAKG;IACI,iBAAiB,UAAiB,MAAM;;OAE7C;IAEF;;;;;;;OAOG;IACI,cAAc,QAAe,GAAG,KAAG,QAAQ,GAAG,CAAC,CAsBpD;IAEF;;;;OAIG;IACI,OAAO,QAAO,IAAI,GAAG,IAAI,CAE9B;IAEF;;;;;;;OAOG;IACI,OAAO,wJA4BZ;IAKF,OAAO,CAAC,kBAAkB,CAmDxB;IAEF,OAAO,CAAC,kBAAkB,CA4BxB;IAGF,SAAS,CAAC,sBAAsB,0uCAKpB,QACR,WAAW,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC,CAAC,CACvD,CAAC,UAAU,CAAC,kBACG,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAsCtB;CAEH"}

package/dist/types/client/index.d.ts

@@ -121,17 +121,175 @@ export declare class AlchemySignerWebClient extends BaseSignerClient<ExportWalle
     private iframeStamper;
     private webauthnStamper;
     iframeContainerId: string;
+    /**
+     * Initializes a new instance with the given parameters, setting up the connection, iframe configuration, and WebAuthn stamper.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     * ```
+     *
+     * @param {AlchemySignerClientParams} params the parameters required to initialize the client
+     * @param {ConnectionConfig} params.connection The connection details needed to connect to the service
+     * @param {{ iframeElementId?: string; iframeContainerId: string }} params.iframeConfig The configuration details for setting up the iframe stamper
+     * @param {string} params.rpId The relying party ID, defaulting to the current hostname if not provided
+     * @param {string} params.rootOrgId The root organization ID
+     */
     constructor(params: AlchemySignerClientParams);
+    /**
+     * Authenticates the user by either email or passkey account creation flow. Emits events during the process.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.createAccount({ type: "email", email: "you@mail.com" });
+     * ```
+     *
+     * @param {CreateAccountParams} params The parameters for creating an account, including the type (email or passkey) and additional details.
+     * @returns {Promise<SignupResponse>} A promise that resolves with the response object containing the account creation result.
+     */
     createAccount: (params: CreateAccountParams) => Promise<import("./types.js").SignupResponse>;
+    /**
+     * Begin authenticating a user with their email and an expiration time for the authentication request. Initializes the iframe stamper to get the target public key.
+     * This method sends an email to the user to complete their login
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.initEmailAuth({ email: "you@mail.com" });
+     * ```
+     *
+     * @param {Omit<EmailAuthParams, "targetPublicKey">} params The parameters for email authentication, excluding the target public key
+     * @returns {Promise<any>} The response from the authentication request
+     */
     initEmailAuth: (params: Omit<EmailAuthParams, "targetPublicKey">) => Promise<{
         orgId: string;
     }>;
+    /**
+     * Completes email auth for the user by injecting a credential bundle and retrieving the user information based on the provided organization ID. Emits events during the process.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.completeEmailAuth({ orgId: "user-org-id", bundle: "bundle-from-email" });
+     * ```
+     *
+     * @param {{ bundle: string; orgId: string }} config The configuration object for the authentication function containing the credential bundle to inject and the organization id associated with the user
+     * @returns {Promise<User>} A promise that resolves to the authenticated user information
+     */
     completeEmailAuth: ({ bundle, orgId, }: {
         bundle: string;
         orgId: string;
     }) => Promise<User>;
+    /**
+     * Asynchronously handles the authentication process using WebAuthn Stamper. If a user is provided, sets the user and returns it. Otherwise, retrieves the current user and initializes the WebAuthn stamper.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.lookupUserWithPasskey();
+     * ```
+     *
+     * @param {User} [user] An optional user object to authenticate
+     * @returns {Promise<User>} A promise that resolves to the authenticated user object
+     */
     lookupUserWithPasskey: (user?: User | undefined) => Promise<User>;
+    /**
+     * Initiates the export of a wallet by creating an iframe stamper and calling the appropriate export function.
+     * The export can be based on a seed phrase or a private key.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.exportWallet({
+     *  iframeContainerId: "export-iframe-container",
+     * });
+     * ```
+     *
+     * @param {ExportWalletParams} config The parameters for exporting the wallet
+     * @param {string} config.iframeContainerId The ID of the container element that will hold the iframe stamper
+     * @param {string} [config.iframeElementId] Optional ID for the iframe element
+     * @returns {Promise<void>} A promise that resolves when the export process is complete
+     */
     exportWallet: ({ iframeContainerId, iframeElementId, }: ExportWalletParams) => Promise<boolean>;
+    /**
+     * Asynchronous function that clears the user and resets the iframe stamper.
+     *
+     * @example
+     * ```ts
+     * import { AlchemySignerWebClient } from "@account-kit/signer";
+     *
+     * const client = new AlchemySignerWebClient({
+     *  connection: {
+     *    apiKey: "your-api-key",
+     *  },
+     *  iframeConfig: {
+     *   iframeContainerId: "signer-iframe-container",
+     *  },
+     * });
+     *
+     * const account = await client.disconnect();
+     * ```
+     */
     disconnect: () => Promise<void>;
     private initIframeStamper;
     private initWebauthnStamper;

package/dist/types/client/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,iCAAiC,EACjC,eAAe,EACf,kBAAkB,EAClB,IAAI,EACL,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAW1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,+BAA+B,CACvC,CAAC;AAEF;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB,CAAC,kBAAkB,CAAC;IAC9E,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,eAAe,CAAkB;IACzC,iBAAiB,EAAE,MAAM,CAAC;gBAEd,MAAM,EAAE,yBAAyB;IAwBtC,aAAa,WAAkB,mBAAmB,kDAuCvD;IAEK,aAAa,WACV,KAAK,eAAe,EAAE,iBAAiB,CAAC;;OAYhD;IAEK,iBAAiB;gBAId,MAAM;eACP,MAAM;wBAeb;IAEK,qBAAqB,UAAgB,IAAI,GAAG,SAAS,mBAa1D;IAEK,YAAY,4CAGhB,kBAAkB,sBAmBnB;IAEK,UAAU,sBAGf;IAEF,OAAO,CAAC,iBAAiB,CAQvB;IAEF,OAAO,CAAC,mBAAmB,CAYzB;IAEF,SAAS,CAAC,sBAAsB,aACpB,iCAAiC,gBAC9B;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE;;;;;;;;;OAmDjC;CACH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,KAAK,EACV,mBAAmB,EACnB,iCAAiC,EACjC,eAAe,EACf,kBAAkB,EAClB,IAAI,EACL,MAAM,YAAY,CAAC;AAEpB,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAW1C,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC7C,OAAO,+BAA+B,CACvC,CAAC;AAEF;;;GAGG;AACH,qBAAa,sBAAuB,SAAQ,gBAAgB,CAAC,kBAAkB,CAAC;IAC9E,OAAO,CAAC,aAAa,CAAgB;IACrC,OAAO,CAAC,eAAe,CAAkB;IACzC,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;;;;;;;;;;;;;;;;;;;;;OAsBG;gBACS,MAAM,EAAE,yBAAyB;IAwB7C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,aAAa,WAAkB,mBAAmB,kDAuChD;IAEF;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,aAAa,WACV,KAAK,eAAe,EAAE,iBAAiB,CAAC;;OAYhD;IAEF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,iBAAiB;gBAId,MAAM;eACP,MAAM;wBAeb;IAEF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,qBAAqB,UAAgB,IAAI,GAAG,SAAS,mBAa1D;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACI,YAAY,4CAGhB,kBAAkB,sBAmBnB;IAEF;;;;;;;;;;;;;;;;;;OAkBG;IACI,UAAU,sBAGf;IAEF,OAAO,CAAC,iBAAiB,CAQvB;IAEF,OAAO,CAAC,mBAAmB,CAYzB;IAEF,SAAS,CAAC,sBAAsB,aACpB,iCAAiC,gBAC9B;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE;;;;;;;;;OAmDjC;CACH"}

package/dist/types/index.d.ts

@@ -1,9 +1,10 @@
-export type * from "./signer.js";
-export { AlchemyWebSigner } from "./signer.js";
-export type * from "./types.js";
-export { AlchemySignerStatus } from "./types.js";
+export { BaseAlchemySigner } from "./base.js";
 export { BaseSignerClient } from "./client/base.js";
 export { AlchemySignerWebClient } from "./client/index.js";
 export type * from "./client/types.js";
 export { DEFAULT_SESSION_MS } from "./session/manager.js";
+export type * from "./signer.js";
+export { AlchemyWebSigner } from "./signer.js";
+export type * from "./types.js";
+export { AlchemySignerStatus } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,aAAa,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,mBAAmB,YAAY,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,mBAAmB,mBAAmB,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAC;AAC3D,mBAAmB,mBAAmB,CAAC;AACvC,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,mBAAmB,aAAa,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,mBAAmB,YAAY,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC"}

package/dist/types/signer.d.ts

@@ -264,6 +264,27 @@ export type AlchemySignerParams = z.input<typeof AlchemySignerParamsSchema>;
  * A SmartAccountSigner that can be used with any SmartContractAccount
  */
 export declare class AlchemyWebSigner extends BaseAlchemySigner<AlchemySignerWebClient> {
-    constructor(params_: AlchemySignerParams);
+    /**
+     * Initializes an instance with the provided Alchemy signer parameters after parsing them with a schema.
+     *
+     * @example
+     * ```ts
+     * import { AlchemyWebSigner } from "@account-kit/signer";
+     *
+     * const signer = new AlchemyWebSigner({
+     *  client: {
+     *    connection: {
+     *      rpcUrl: "/api/rpc",
+     *    },
+     *    iframeConfig: {
+     *      iframeContainerId: "alchemy-signer-iframe-container",
+     *    },
+     *  },
+     * });
+     * ```
+     *
+     * @param {AlchemySignerParams} params The parameters for the Alchemy signer, including the client and session configuration
+     */
+    constructor(params: AlchemySignerParams);
 }
 //# sourceMappingURL=signer.d.ts.map

package/dist/types/signer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAEL,sBAAsB,EACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,mBAAmB,CAAC;AAG3E,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,eAAe,CAAA;CAAE,GAClE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GACjD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,KAAK,CAAC;CAClB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,iCAAiC,CAAC;CAClD,CAAC;AAEN,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAYtC;;eAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EANC,CAAC;AAEL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB,CAAC,sBAAsB,CAAC;gBACjE,OAAO,EAAE,mBAAmB;CAezC"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAEL,sBAAsB,EACvB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,mBAAmB,CAAC;AAG3E,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,cAAc,CAAC,EAAE,eAAe,CAAA;CAAE,GAClE;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GACjD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,KAAK,CAAC;CAClB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,iCAAiC,CAAC;CAClD,CAAC;AAEN,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAYtC;;eAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EANC,CAAC;AAEL,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,iBAAiB,CAAC,sBAAsB,CAAC;IAC7E;;;;;;;;;;;;;;;;;;;;OAoBG;gBACS,MAAM,EAAE,mBAAmB;CAexC"}

package/dist/types/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.0.0-alpha.5";
+export declare const VERSION = "4.0.0-alpha.6";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@account-kit/signer",
-  "version": "4.0.0-alpha.5",
+  "version": "4.0.0-alpha.6",
   "description": "Core interfaces and clients for interfacing with the Alchemy Signer API",
   "author": "Alchemy",
   "license": "MIT",
@@ -34,6 +34,7 @@
     "build:cjs": "tsc --project tsconfig.build.json --module commonjs --outDir ./dist/cjs --removeComments --verbatimModuleSyntax false && echo > ./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
     "build:esm": "tsc --project tsconfig.build.json --module es2020 --outDir ./dist/esm --removeComments && echo > ./dist/esm/package.json '{\"type\":\"module\"}'",
     "build:types": "tsc --project tsconfig.build.json --module esnext --declarationDir ./dist/types --emitDeclarationOnly --declaration --declarationMap",
+    "docs:gen": "npx ak-docgen generate --in ./src/index.ts --out ../../site/pages/reference/account-kit/signer",
     "clean": "rm -rf ./dist",
     "test": "vitest --passWithNoTests",
     "test:run": "vitest run --passWithNoTests",
@@ -49,7 +50,7 @@
     "vitest": "^0.31.0"
   },
   "dependencies": {
-    "@aa-sdk/core": "^4.0.0-alpha.5",
+    "@aa-sdk/core": "^4.0.0-alpha.6",
     "@turnkey/http": "^2.6.2",
     "@turnkey/iframe-stamper": "^1.0.0",
     "@turnkey/viem": "^0.4.8",
@@ -75,5 +76,5 @@
     "url": "https://github.com/alchemyplatform/aa-sdk/issues"
   },
   "homepage": "https://github.com/alchemyplatform/aa-sdk#readme",
-  "gitHead": "674bcb173cab611f7738ddc804a48846ea19f958"
+  "gitHead": "2c35ec701f526c77ea5e00e2e6f147156c7ac0e4"
 }