@dynamic-labs-sdk/client 1.17.1 → 1.19.0

package/dist/modules/flow/getFlow/getFlow.d.ts

@@ -4,11 +4,19 @@ export type GetFlowParams = {
     flowId: string;
 };
 /**
- * Fetches a flow by its ID
+ * Fetches a flow by its ID.
  *
- * @param params GetFlowParams - The parameters for fetching the flow.
+ * @example
+ * ```ts
+ * const flow = await getFlow({ flowId: 'flow-abc123' });
+ * console.log('Flow status:', flow.status);
+ * ```
+ *
+ * @param params.flowId - The unique identifier of the flow to fetch.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns The flow
+ * @returns A promise that resolves to the flow object.
+ * @see cancelFlow
+ * @see getFlowQuote
  * @notInstrumented
  */
 export declare const getFlow: ({ flowId }: GetFlowParams, client?: DynamicClient) => Promise<Flow>;

package/dist/modules/flow/getFlow/getFlow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFlow.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/getFlow/getFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,OAAO,eACN,aAAa,WACjB,aAAa,KACpB,OAAO,CAAC,IAAI,CAQd,CAAC"}
+{"version":3,"file":"getFlow.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/getFlow/getFlow.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,OAAO,eACN,aAAa,WACjB,aAAa,KACpB,OAAO,CAAC,IAAI,CAQd,CAAC"}

package/dist/modules/flow/getFlowQuote/getFlowQuote.d.ts

@@ -17,11 +17,24 @@ export type GetFlowQuoteParams = {
     slippage?: number;
 };
 /**
- * Fetches a quote for a flow
+ * Fetches a quote for a flow.
  *
- * @param params GetFlowQuoteParams - The quote parameters.
+ * @example
+ * ```ts
+ * const flow = await getFlowQuote({
+ *   flowId: 'flow-abc123',
+ *   slippage: 0.5,
+ * });
+ * ```
+ *
+ * @param params.flowId - The unique identifier of the flow.
+ * @param [params.fromChainId] - Optional chain ID overriding the one set at attachFlowSource time.
+ * @param [params.fromTokenAddress] - Optional token address (defaults to native token).
+ * @param [params.slippage] - Acceptable slippage percentage.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
- * @returns The updated flow with quote data
+ * @returns A promise that resolves to the updated flow with quote data.
+ * @see getFlow
+ * @see cancelFlow
  * @notInstrumented
  */
 export declare const getFlowQuote: ({ flowId, fromChainId, fromTokenAddress, slippage }: GetFlowQuoteParams, client?: import("../../../exports").DynamicClient) => Promise<Flow>;

package/dist/modules/flow/getFlowQuote/getFlowQuote.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFlowQuote.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/getFlowQuote/getFlowQuote.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAI1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,wDAC8B,kBAAkB,wDAEtE,OAAO,CAAC,IAAI,CAuBd,CAAC"}
+{"version":3,"file":"getFlowQuote.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/getFlowQuote/getFlowQuote.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAI1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,YAAY,wDAC8B,kBAAkB,wDAEtE,OAAO,CAAC,IAAI,CAuBd,CAAC"}

package/dist/modules/flow/prepareFlowSigning/prepareFlowSigning.instrumentation.d.ts

@@ -0,0 +1,9 @@
+import type { InstrumentationPayloadSelectors } from '../../../services/instrumentation/instrumentation.types';
+import type { Flow } from '../flow.types';
+/**
+ * Explicit instrumentation payload for prepareFlowSigning. Logs non-sensitive
+ * volume and routing dimensions only — never the wallet address or any
+ * session token.
+ */
+export declare const prepareFlowSigningInstrumentation: InstrumentationPayloadSelectors<unknown[], Flow>;
+//# sourceMappingURL=prepareFlowSigning.instrumentation.d.ts.map

package/dist/modules/flow/prepareFlowSigning/prepareFlowSigning.instrumentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prepareFlowSigning.instrumentation.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/prepareFlowSigning/prepareFlowSigning.instrumentation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,yDAAyD,CAAC;AAC/G,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,EAAE,+BAA+B,CAC7E,OAAO,EAAE,EACT,IAAI,CAUL,CAAC"}

package/dist/modules/flow/submitFlowTransaction/submitFlowTransaction.instrumentation.d.ts

@@ -0,0 +1,9 @@
+import type { InstrumentationPayloadSelectors } from '../../../services/instrumentation/instrumentation.types';
+import type { Flow } from '../flow.types';
+/**
+ * Explicit instrumentation payload for submitFlowTransaction. Logs
+ * non-sensitive volume and routing dimensions only — never the wallet address
+ * or any session token — so executed flow volume is measurable.
+ */
+export declare const submitFlowTransactionInstrumentation: InstrumentationPayloadSelectors<unknown[], Flow>;
+//# sourceMappingURL=submitFlowTransaction.instrumentation.d.ts.map

package/dist/modules/flow/submitFlowTransaction/submitFlowTransaction.instrumentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"submitFlowTransaction.instrumentation.d.ts","sourceRoot":"","sources":["../../../../src/modules/flow/submitFlowTransaction/submitFlowTransaction.instrumentation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,yDAAyD,CAAC;AAC/G,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;GAIG;AACH,eAAO,MAAM,oCAAoC,EAAE,+BAA+B,CAChF,OAAO,EAAE,EACT,IAAI,CAUL,CAAC"}

package/dist/modules/funding/moonpay/getMoonPayUrl/getMoonPayUrl.d.ts

@@ -10,10 +10,6 @@ import type { GetMoonPayUrlParams } from '../moonpay.types';
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns The signed MoonPay URL.
  * @instrumented
- * @redact-params - the return is a bare signed onramp URL whose query string
- * carries the provider signature plus the user's wallet address; a bare-string
- * return is logged under the synthetic `result` key, which no key-based rule
- * covers, so redact the whole event.
  */
 export declare const getMoonPayUrl: (params: GetMoonPayUrlParams, client?: DynamicClient) => Promise<string>;
 //# sourceMappingURL=getMoonPayUrl.d.ts.map

package/dist/modules/funding/moonpay/getMoonPayUrl/getMoonPayUrl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getMoonPayUrl.d.ts","sourceRoot":"","sources":["../../../../../src/modules/funding/moonpay/getMoonPayUrl/getMoonPayUrl.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAI9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAE5D;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,aAAa,WAChB,mBAAmB,WACnB,aAAa,KACpB,OAAO,CAAC,MAAM,CAsChB,CAAC"}
+{"version":3,"file":"getMoonPayUrl.d.ts","sourceRoot":"","sources":["../../../../../src/modules/funding/moonpay/getMoonPayUrl/getMoonPayUrl.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAI9D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAE5D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,WAChB,mBAAmB,WACnB,aAAa,KACpB,OAAO,CAAC,MAAM,CAsChB,CAAC"}

package/dist/modules/initializeClient/initializeClient.d.ts

@@ -7,9 +7,25 @@
  *
  * You only need to call this function if you are not using `autoInitialize: true` in createDynamicClient.
  *
+ * @example
+ * ```ts
+ * const client = createDynamicClient({
+ *   environmentId: 'env-id',
+ *   autoInitialize: false,
+ * });
+ *
+ * try {
+ *   await initializeClient(client);
+ * } catch (error) {
+ *   console.error('Failed to initialize:', error);
+ * }
+ * ```
+ *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves when initialization is complete.
  * @throws ClientAlreadyInitializedError If the client is already initialized.
+ * @see createDynamicClient
+ * @see waitForClientInitialized
  * @instrumented
  * @noHook Client lifecycle management is not exposed as a React hook.
  */

package/dist/modules/initializeClient/initializeClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"initializeClient.d.ts","sourceRoot":"","sources":["../../../src/modules/initializeClient/initializeClient.ts"],"names":[],"mappings":"AAwBA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,mEAqK5B,CAAC"}
+{"version":3,"file":"initializeClient.d.ts","sourceRoot":"","sources":["../../../src/modules/initializeClient/initializeClient.ts"],"names":[],"mappings":"AAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,gBAAgB,mEAqK5B,CAAC"}

package/dist/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.d.ts

@@ -2,8 +2,18 @@
  * Allows waiting until all modules of the client have been properly initialized
  * and are ready for use.
  *
- * @returns a promise that resolves once the client is fully initialized.
-  * @notInstrumented
+ * @example
+ * ```ts
+ * const client = createDynamicClient({ environmentId: 'env-id' });
+ * await waitForClientInitialized(client);
+ * // Client is now fully ready
+ * ```
+ *
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns A promise that resolves once the client is fully initialized.
+ * @see initializeClient
+ * @see createDynamicClient
+ * @notInstrumented
  * @noHook Client lifecycle management is not exposed as a hook; use useInitStatus.
  */
 export declare const waitForClientInitialized: (client?: import("../../../exports").DynamicClient) => Promise<void>;

package/dist/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"waitForClientInitialized.d.ts","sourceRoot":"","sources":["../../../../src/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.ts"],"names":[],"mappings":"AAGA;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,sEAIpC,CAAC"}
+{"version":3,"file":"waitForClientInitialized.d.ts","sourceRoot":"","sources":["../../../../src/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB,sEAIpC,CAAC"}

package/dist/modules/mfa/consumeMfaToken/consumeMfaToken.d.ts

@@ -8,7 +8,6 @@
  * @returns The MFA token that was consumed.
  * @throws Error if no MFA token is found.
  * @instrumented
- * @redact-params
  */
 export declare const consumeMfaToken: (client?: import("../../../exports").DynamicClient) => string;
 //# sourceMappingURL=consumeMfaToken.d.ts.map

package/dist/modules/mfa/consumeMfaToken/consumeMfaToken.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"consumeMfaToken.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/consumeMfaToken/consumeMfaToken.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,+DAY3B,CAAC"}
+{"version":3,"file":"consumeMfaToken.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/consumeMfaToken/consumeMfaToken.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,eAAe,+DAY3B,CAAC"}

package/dist/modules/mfa/createNewMfaRecoveryCodes/createNewMfaRecoveryCodes.d.ts

@@ -7,7 +7,6 @@
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to the newly generated recovery codes.
  * @instrumented
- * @redact-params
  */
 export declare const createNewMfaRecoveryCodes: (client?: import("../../../exports").DynamicClient) => Promise<import("@dynamic-labs/sdk-api-core").MFARegenRecoveryCodesResponse>;
 //# sourceMappingURL=createNewMfaRecoveryCodes.d.ts.map

package/dist/modules/mfa/createNewMfaRecoveryCodes/createNewMfaRecoveryCodes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createNewMfaRecoveryCodes.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/createNewMfaRecoveryCodes/createNewMfaRecoveryCodes.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,yBAAyB,oIASrC,CAAC"}
+{"version":3,"file":"createNewMfaRecoveryCodes.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/createNewMfaRecoveryCodes/createNewMfaRecoveryCodes.ts"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH,eAAO,MAAM,yBAAyB,oIASrC,CAAC"}

package/dist/modules/mfa/isPendingRecoveryCodesAcknowledgment/isPendingRecoveryCodesAcknowledgment.d.ts

@@ -7,6 +7,7 @@
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns True if recovery codes are pending acknowledgment, false otherwise.
   * @notInstrumented
+ * @hook Exposed as a hook so consumers reactively know when recovery codes await acknowledgment, updated when the user changes.
  */
 export declare const isPendingRecoveryCodesAcknowledgment: (client?: import("../../../exports").DynamicClient) => boolean;
 //# sourceMappingURL=isPendingRecoveryCodesAcknowledgment.d.ts.map

package/dist/modules/mfa/isPendingRecoveryCodesAcknowledgment/isPendingRecoveryCodesAcknowledgment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isPendingRecoveryCodesAcknowledgment.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/isPendingRecoveryCodesAcknowledgment/isPendingRecoveryCodesAcknowledgment.ts"],"names":[],"mappings":"AAKA;;;;;;;;;GASG;AACH,eAAO,MAAM,oCAAoC,gEAUhD,CAAC"}
+{"version":3,"file":"isPendingRecoveryCodesAcknowledgment.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/isPendingRecoveryCodesAcknowledgment/isPendingRecoveryCodesAcknowledgment.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oCAAoC,gEAUhD,CAAC"}

package/dist/modules/mfa/isUserMissingMfaAuth/isUserMissingMfaAuth.d.ts

@@ -7,6 +7,7 @@
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns True if the user needs additional MFA authentication, false otherwise.
   * @notInstrumented
+ * @hook Exposed as a hook so consumers reactively know when MFA is still required, updated when the user changes.
  */
 export declare const isUserMissingMfaAuth: (client?: import("../../../exports").DynamicClient) => boolean;
 //# sourceMappingURL=isUserMissingMfaAuth.d.ts.map

package/dist/modules/mfa/isUserMissingMfaAuth/isUserMissingMfaAuth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isUserMissingMfaAuth.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/isUserMissingMfaAuth/isUserMissingMfaAuth.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,gEAMhC,CAAC"}
+{"version":3,"file":"isUserMissingMfaAuth.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/isUserMissingMfaAuth/isUserMissingMfaAuth.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,gEAMhC,CAAC"}

package/dist/modules/mfa/registerTotpMfaDevice/registerTotpMfaDevice.d.ts

@@ -8,9 +8,6 @@
  * @returns A promise that resolves to the TOTP registration response containing setup information,
  * like the secret key and the OTP Auth URI.
  * @instrumented
- * @redact-params - the response embeds the TOTP shared secret in both `secret`
- * and the `uri` (`otpauth://...?secret=...`); redact the whole event so the
- * seed never reaches logs via the un-keyed `uri` field.
  */
 export declare const registerTotpMfaDevice: (client?: import("../../../exports").DynamicClient) => Promise<import("@dynamic-labs/sdk-api-core").MFARegisterTotpDeviceGetResponse>;
 //# sourceMappingURL=registerTotpMfaDevice.d.ts.map

package/dist/modules/mfa/registerTotpMfaDevice/registerTotpMfaDevice.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registerTotpMfaDevice.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/registerTotpMfaDevice/registerTotpMfaDevice.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,qBAAqB,uIAUjC,CAAC"}
+{"version":3,"file":"registerTotpMfaDevice.d.ts","sourceRoot":"","sources":["../../../../src/modules/mfa/registerTotpMfaDevice/registerTotpMfaDevice.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,qBAAqB,uIAUjC,CAAC"}

package/dist/modules/otp/sendEmailOTP/sendEmailOTP.d.ts

@@ -7,11 +7,24 @@ export type SendEmailOTPParams = {
  *
  * Once you have the OTP code, you should then use `verifyOTP` to verify it and complete the authentication process.
  *
+ * @example
+ * ```ts
+ * const { verificationUUID } = await sendEmailOTP({
+ *   email: 'user@example.com',
+ * });
+ * // Then verify with the code the user received
+ * await verifyOTP({
+ *   otpVerification: { email: 'user@example.com', verificationUUID },
+ *   verificationToken: '123456',
+ * });
+ * ```
+ *
  * @param params.email - The email address to send the OTP to.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to an OTPVerification object containing the email and verification UUID.
+ * @see verifyOTP
+ * @see sendSmsOTP
  * @instrumented
- * @redact-params
  */
 export declare const sendEmailOTP: ({ email }: SendEmailOTPParams, client?: import("../../../exports").DynamicClient) => Promise<OTPVerification>;
 //# sourceMappingURL=sendEmailOTP.d.ts.map

package/dist/modules/otp/sendEmailOTP/sendEmailOTP.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sendEmailOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/sendEmailOTP/sendEmailOTP.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,YAAY,cACZ,kBAAkB,wDAE5B,OAAO,CAAC,eAAe,CAgBzB,CAAC"}
+{"version":3,"file":"sendEmailOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/sendEmailOTP/sendEmailOTP.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,YAAY,cACZ,kBAAkB,wDAE5B,OAAO,CAAC,eAAe,CAgBzB,CAAC"}

package/dist/modules/otp/sendSmsOTP/sendSmsOTP.d.ts

@@ -7,12 +7,23 @@ export type SendSmsOTPParams = {
 /**
  * Sends a one-time password (OTP) via SMS to the specified phone number.
  *
+ * @example
+ * ```ts
+ * const { verificationUUID } = await sendSmsOTP({
+ *   isoCountryCode: 'US',
+ *   phoneNumber: '5551234567',
+ * });
+ * // Then verify with the code the user received
+ * await verifyOTP({ otpVerification: { phoneNumber: '5551234567', verificationUUID }, verificationToken: '123456' });
+ * ```
+ *
  * @param params.isoCountryCode - The ISO country code for the phone number (e.g., 'US', 'CA', 'GB').
  * @param params.phoneNumber - The phone number to send the OTP to.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to an OTPVerification object containing the phone details and verification UUID.
+ * @see verifyOTP
+ * @see sendEmailOTP
  * @instrumented
- * @redact-params
  */
 export declare const sendSmsOTP: ({ isoCountryCode, phoneNumber }: SendSmsOTPParams, client?: import("../../../exports").DynamicClient) => Promise<OTPVerification>;
 //# sourceMappingURL=sendSmsOTP.d.ts.map

package/dist/modules/otp/sendSmsOTP/sendSmsOTP.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sendSmsOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/sendSmsOTP/sendSmsOTP.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGxD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,WAAW,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,oCACY,gBAAgB,wDAEhD,OAAO,CAAC,eAAe,CAoBzB,CAAC"}
+{"version":3,"file":"sendSmsOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/sendSmsOTP/sendSmsOTP.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAGxD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,cAAc,EAAE,WAAW,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,UAAU,oCACY,gBAAgB,wDAEhD,OAAO,CAAC,eAAe,CAoBzB,CAAC"}

package/dist/modules/otp/verifyOTP/verifyOTP.d.ts

@@ -1,6 +1,25 @@
 import type { TokenScope, VerifyResponse } from '@dynamic-labs/sdk-api-core';
 import type { OTPVerification } from '../otp.types';
+/**
+ * Parameters for verifying an OTP during sign-in or an authenticated user update.
+ *
+ * @example
+ * ```ts
+ * const params: VerifyOTPParams = {
+ *   otpVerification,
+ *   verificationToken: '123456',
+ * };
+ * ```
+ * @see verifyOTP
+ * @see sendEmailOTP
+ */
 export type VerifyOTPParams = {
+    /**
+     * When true on a sign-in request, the server returns an elevated access
+     * token with credential:link scope if MFA is optional and the user has
+     * no MFA methods registered. Ignored on post-login verify requests.
+     */
+    allowNewMFALinking?: boolean;
     otpVerification: OTPVerification;
     requestedScopes?: TokenScope[];
     verificationToken: string;
@@ -11,12 +30,24 @@ export type VerifyOTPParams = {
  * This function validates the OTP code provided by the user and completes
  * the verification process for either sign-in or account updates.
  *
+ * @example
+ * ```ts
+ * const { verificationUUID } = await sendEmailOTP({ email: 'user@example.com' });
+ * const response = await verifyOTP({
+ *   otpVerification: { email: 'user@example.com', verificationUUID },
+ *   verificationToken: '123456',
+ * });
+ * ```
+ *
+ * @param [params.allowNewMFALinking] - Whether sign-in may return a credential-link elevated token for users without MFA.
  * @param params.otpVerification - The OTP verification object containing verification details.
  * @param params.verificationToken - The token received from the OTP verification process.
+ * @param [params.requestedScopes] - Optional token scopes to request during verification.
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to the verify response object upon successful verification.
+ * @see sendEmailOTP
+ * @see sendSmsOTP
  * @instrumented
- * @redact-params
  */
-export declare const verifyOTP: ({ otpVerification, verificationToken, requestedScopes }: VerifyOTPParams, client?: import("../../../exports").DynamicClient) => Promise<VerifyResponse>;
+export declare const verifyOTP: ({ allowNewMFALinking, otpVerification, requestedScopes, verificationToken, }: VerifyOTPParams, client?: import("../../../exports").DynamicClient) => Promise<VerifyResponse>;
 //# sourceMappingURL=verifyOTP.d.ts.map

package/dist/modules/otp/verifyOTP/verifyOTP.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"verifyOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/verifyOTP/verifyOTP.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAK7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAIpD,MAAM,MAAM,eAAe,GAAG;IAC5B,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,CAAC,EAAE,UAAU,EAAE,CAAC;IAC/B,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,SAAS,4DACqC,eAAe,wDAEvE,OAAO,CAAC,cAAc,CAwBxB,CAAC"}
+{"version":3,"file":"verifyOTP.d.ts","sourceRoot":"","sources":["../../../../src/modules/otp/verifyOTP/verifyOTP.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAK7E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAIpD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,CAAC,EAAE,UAAU,EAAE,CAAC;IAC/B,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,SAAS,iFAMjB,eAAe,wDAEjB,OAAO,CAAC,cAAc,CAwBxB,CAAC"}

package/dist/modules/otp/verifyOTP/verifyOTPForUserSignIn/verifyOTPForUserSignIn.d.ts

@@ -1,5 +1,5 @@
 import type { DynamicClient } from '../../../../client/types';
 import type { VerifyOTPParams } from '../verifyOTP';
 /** @notInstrumented */
-export declare const verifyOTPForUserSignIn: ({ otpVerification, verificationToken }: VerifyOTPParams, client: DynamicClient) => Promise<import("@dynamic-labs/sdk-api-core").VerifyResponse>;
+export declare const verifyOTPForUserSignIn: ({ allowNewMFALinking, otpVerification, verificationToken }: VerifyOTPParams, client: DynamicClient) => Promise<import("@dynamic-labs/sdk-api-core").VerifyResponse>;
 //# sourceMappingURL=verifyOTPForUserSignIn.d.ts.map

package/dist/modules/otp/verifyOTP/verifyOTPForUserSignIn/verifyOTPForUserSignIn.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"verifyOTPForUserSignIn.d.ts","sourceRoot":"","sources":["../../../../../src/modules/otp/verifyOTP/verifyOTPForUserSignIn/verifyOTPForUserSignIn.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,uBAAuB;AACvB,eAAO,MAAM,sBAAsB,2CACO,eAAe,UAC/C,aAAa,iEAqBtB,CAAC"}
+{"version":3,"file":"verifyOTPForUserSignIn.d.ts","sourceRoot":"","sources":["../../../../../src/modules/otp/verifyOTP/verifyOTPForUserSignIn/verifyOTPForUserSignIn.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD,uBAAuB;AACvB,eAAO,MAAM,sBAAsB,+DAC2B,eAAe,UACnE,aAAa,iEAsBtB,CAAC"}

package/dist/modules/projectSettings/fetchProjectSettings/fetchProjectSettings.d.ts

@@ -9,8 +9,16 @@ export declare const PROJECT_SETTINGS_EXPIRATION_TIME: number;
  * from Dynamic's servers, including authentication options, enabled chains,
  * and security configurations. The settings are cached for performance.
  *
+ * @example
+ * ```ts
+ * const settings = await fetchProjectSettings();
+ * console.log('Enabled chains:', settings.chains);
+ * ```
+ *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to the updated project settings.
+ * @see createDynamicClient
+ * @see initializeClient
  * @notInstrumented
  * @noHook Internal settings fetch that is not part of the public hook surface.
  */

package/dist/modules/projectSettings/fetchProjectSettings/fetchProjectSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetchProjectSettings.d.ts","sourceRoot":"","sources":["../../../../src/modules/projectSettings/fetchProjectSettings/fetchProjectSettings.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,eAAO,MAAM,gCAAgC,QAAgB,CAAC;AAE9D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,oBAAoB,6HA4ChC,CAAC"}
+{"version":3,"file":"fetchProjectSettings.d.ts","sourceRoot":"","sources":["../../../../src/modules/projectSettings/fetchProjectSettings/fetchProjectSettings.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,eAAO,MAAM,gCAAgC,QAAgB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,oBAAoB,6HA4ChC,CAAC"}

package/dist/modules/user/checkUserScopes/checkUserScopes.d.ts

@@ -0,0 +1,28 @@
+import type { User } from '../user.types';
+type CheckUserScopesParams = {
+    scopes: string[];
+    user: User;
+};
+/**
+ * Checks whether the given user has all the specified scopes.
+ *
+ * The user's `scope` field is a whitespace-separated string of granted
+ * permissions (per RFC 8693 §4.2). This helper splits it and verifies that
+ * every entry in `scopes` is present.
+ *
+ * @example
+ * const user = getDefaultClient().user;
+ * if (user && checkUserScopes({ user, scopes: ['wallets:read'] })) {
+ *   showWalletBalances();
+ * }
+ *
+ * @param params.user - The authenticated user to check.
+ * @param params.scopes - The scope strings the user must have.
+ * @returns `true` if the user has every scope in `scopes`, `false` otherwise.
+ * @see User
+ * @see updateUser
+ * @notInstrumented
+ */
+export declare const checkUserScopes: ({ scopes, user, }: CheckUserScopesParams) => boolean;
+export {};
+//# sourceMappingURL=checkUserScopes.d.ts.map

package/dist/modules/user/checkUserScopes/checkUserScopes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkUserScopes.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/checkUserScopes/checkUserScopes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAE1C,KAAK,qBAAqB,GAAG;IAC3B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;CACZ,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,eAAe,sBAGzB,qBAAqB,KAAG,OAI1B,CAAC"}

package/dist/modules/user/checkUserScopes/index.d.ts

@@ -0,0 +1,2 @@
+export { checkUserScopes } from './checkUserScopes';
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/user/checkUserScopes/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/checkUserScopes/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/modules/user/deleteUser/deleteUser.d.ts

@@ -4,8 +4,16 @@
  * This function performs a hard delete of the user account. Upon successful deletion,
  * the user will be automatically logged out and all authentication data will be cleared.
  *
+ * @example
+ * ```ts
+ * // Permanently delete the user's account
+ * await deleteUser();
+ * ```
+ *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves when the user account is successfully deleted.
+ * @see logout
+ * @see refreshUser
  * @instrumented
  */
 export declare const deleteUser: (client?: import("../../../exports").DynamicClient) => Promise<void>;

package/dist/modules/user/deleteUser/deleteUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deleteUser.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/deleteUser/deleteUser.ts"],"names":[],"mappings":"AAKA;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU,yDAEpB,OAAO,CAAC,IAAI,CASd,CAAC"}
+{"version":3,"file":"deleteUser.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/deleteUser/deleteUser.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,UAAU,yDAEpB,OAAO,CAAC,IAAI,CASd,CAAC"}

package/dist/modules/user/isUserOnboardingComplete/isUserOnboardingComplete.d.ts

@@ -12,9 +12,17 @@
  * is one such feature — its backend calls reject a pre-`user:basic` token — but
  * this predicate is general and not specific to embedded wallets.
  *
+ * @deprecated Use {@link checkUserScopes} instead. This function conflates
+ * Dynamic-controlled requirements (MFA, device registration, required fields)
+ * with the concept of "onboarding complete", which is app-specific. Replace
+ * with `checkUserScopes({ user, scopes: ['user:basic'] })` to check whether
+ * Dynamic's requirements are satisfied, and compose your own logic on top for
+ * any app-specific onboarding steps.
+ *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns True if onboarding is complete (no pending requirements), false if there are pending requirements.
-  * @notInstrumented
+ * @notInstrumented
+ * @hook Exposed as a hook so consumers reactively know when onboarding is complete, updated when the user changes.
  */
 export declare const isUserOnboardingComplete: (client?: import("../../../exports").DynamicClient) => boolean;
 //# sourceMappingURL=isUserOnboardingComplete.d.ts.map

package/dist/modules/user/isUserOnboardingComplete/isUserOnboardingComplete.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"isUserOnboardingComplete.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/isUserOnboardingComplete/isUserOnboardingComplete.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,wBAAwB,gEAiBpC,CAAC"}
+{"version":3,"file":"isUserOnboardingComplete.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/isUserOnboardingComplete/isUserOnboardingComplete.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,wBAAwB,gEAiBpC,CAAC"}

package/dist/modules/user/refreshAuth/refreshAuth.d.ts

@@ -1,14 +1,27 @@
 import type { VerifyResponse } from '@dynamic-labs/sdk-api-core';
 /**
- * Refreshes the current user's data from the server.
+ * Refreshes the current session's authentication from the server.
  *
- * This function fetches the latest user information and token from the backend
- * updating the local user and token states with any changes.
+ * This rotates the auth token via a full verify call and updates both the
+ * token and the user state from the response, returning the raw
+ * `VerifyResponse` (which includes the new token). Reach for this when you
+ * need a fresh JWT — e.g. before a call that requires a non-expired token.
+ *
+ * Prefer `refreshUser` when you only need the latest user profile and do not
+ * care about rotating the token: it hits the authenticated-user endpoint,
+ * touches only the user state, and returns the `SdkUser` directly.
+ *
+ * @example
+ * ```ts
+ * const response = await refreshAuth();
+ * console.log('Token refreshed:', response.token);
+ * ```
  *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to the verify response.
+ * @see logout
+ * @see refreshUser
  * @instrumented
- * @redact-params
  */
 export declare const refreshAuth: (client?: import("../../../exports").DynamicClient) => Promise<VerifyResponse>;
 //# sourceMappingURL=refreshAuth.d.ts.map

package/dist/modules/user/refreshAuth/refreshAuth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"refreshAuth.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/refreshAuth/refreshAuth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAOjE;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,yDAErB,OAAO,CAAC,cAAc,CAWxB,CAAC"}
+{"version":3,"file":"refreshAuth.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/refreshAuth/refreshAuth.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAOjE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,WAAW,yDAErB,OAAO,CAAC,cAAc,CAWxB,CAAC"}

package/dist/modules/user/refreshUser/refreshUser.d.ts

@@ -1,12 +1,25 @@
 import type { SdkUser } from '@dynamic-labs/sdk-api-core';
 /**
- * Refreshes the current user's data from the server.
+ * Refreshes the current user's profile from the server.
  *
- * This function fetches the latest authenticated user information from the backend
- * and updates the local user state.
+ * This fetches the latest authenticated user from the backend and updates only
+ * the local user state, returning the `SdkUser`. It does not touch the auth
+ * token — use it when you just need up-to-date user data.
+ *
+ * Prefer `refreshAuth` when you need to rotate the auth token as well: it runs
+ * a full verify, updates both token and user state, and returns the raw
+ * `VerifyResponse` (including the new token).
+ *
+ * @example
+ * ```ts
+ * const user = await refreshUser();
+ * console.log('Updated user:', user.email);
+ * ```
  *
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to the authenticated user.
+ * @see refreshAuth
+ * @see deleteUser
  * @instrumented
  * @noHook Low-level refresh primitive that is not exposed as a React hook.
  */

package/dist/modules/user/refreshUser/refreshUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"refreshUser.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/refreshUser/refreshUser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAO1D;;;;;;;;;;GAUG;AACH,eAAO,MAAM,WAAW,yDAErB,OAAO,CAAC,OAAO,CAejB,CAAC"}
+{"version":3,"file":"refreshUser.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/refreshUser/refreshUser.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAO1D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,WAAW,yDAErB,OAAO,CAAC,OAAO,CAejB,CAAC"}

package/dist/modules/user/updateUser/updateUser.d.ts

@@ -14,7 +14,6 @@ type UpdateUserParams = {
  * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
  * @returns A promise that resolves to OTP verification details if verification is required, or undefined.
   * @instrumented
-  * @redact-params
  */
 export declare const updateUser: ({ userFields }: UpdateUserParams, client?: import("../../../exports").DynamicClient) => Promise<OTPVerification | undefined>;
 export {};

package/dist/modules/user/updateUser/updateUser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateUser.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/updateUser/updateUser.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEtD,KAAK,gBAAgB,GAAG;IACtB,UAAU,EAAE,gBAAgB,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,mBACL,gBAAgB,wDAE/B,OAAO,CAAC,eAAe,GAAG,SAAS,CA4BrC,CAAC"}
+{"version":3,"file":"updateUser.d.ts","sourceRoot":"","sources":["../../../../src/modules/user/updateUser/updateUser.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAEtD,KAAK,gBAAgB,GAAG;IACtB,UAAU,EAAE,gBAAgB,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,UAAU,mBACL,gBAAgB,wDAE/B,OAAO,CAAC,eAAe,GAAG,SAAS,CA4BrC,CAAC"}

package/dist/modules/user/user.types.d.ts

@@ -1,6 +1,14 @@
 import type { SdkUser, UserFields } from '@dynamic-labs/sdk-api-core';
 /**
- * A user that is authenticated with the Dynamic SDK.
+ * A user that is authenticated with the Dynamic SDK. Carries profile fields,
+ * verified credentials, and the granted `scope` string used for authorization.
+ *
+ * @example
+ * const user: User | undefined = getDefaultClient().user;
+ * if (user) console.log(user.email, user.scope);
+ *
+ * @see checkUserScopes
+ * @see updateUser
  */
 export type User = SdkUser;
 /**

package/dist/modules/user/user.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"user.types.d.ts","sourceRoot":"","sources":["../../../src/modules/user/user.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,UAAU,EACR,OAAO,GACP,OAAO,GACP,WAAW,GACX,UAAU,GACV,UAAU,GACV,aAAa,GACb,YAAY,GACZ,MAAM,GACN,SAAS,GACT,UAAU,GACV,UAAU,GACV,8BAA8B,GAC9B,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,CACf,CAAC"}
+{"version":3,"file":"user.types.d.ts","sourceRoot":"","sources":["../../../src/modules/user/user.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAEtE;;;;;;;;;;GAUG;AACH,MAAM,MAAM,IAAI,GAAG,OAAO,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,IAAI,CACjC,UAAU,EACR,OAAO,GACP,OAAO,GACP,WAAW,GACX,UAAU,GACV,UAAU,GACV,aAAa,GACb,YAAY,GACZ,MAAM,GACN,SAAS,GACT,UAAU,GACV,UAAU,GACV,8BAA8B,GAC9B,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,WAAW,GACX,YAAY,CACf,CAAC"}