@dynamic-labs-sdk/client 0.0.1-alpha.7 → 0.0.1-alpha.8

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.1-alpha.8 (2025-07-03)
+
+This was a version bump only, there were no code changes.
+
 ## 0.0.1-alpha.7 (2025-07-02)
 
 ### 🩹 Fixes

package/core.cjs.js

@@ -8,6 +8,7 @@ class MethodNotImplementedError extends getWalletProviderFromWalletAccount.BaseE
     constructor(methodName){
         super({
             cause: null,
+            code: 'method_not_implemented_error',
             docsUrl: null,
             name: 'MethodNotImplementedError',
             shortMessage: `This method is not implemented: ${methodName}`
@@ -86,9 +87,12 @@ const bufferToBase64 = (buf)=>{
     return getBuffer().from(binstr, 'binary').toString('base64');
 };
 
+exports.APIError = getWalletProviderFromWalletAccount.APIError;
 exports.CannotTrackError = getWalletProviderFromWalletAccount.CannotTrackError;
 exports.ClientNotPresentError = getWalletProviderFromWalletAccount.ClientNotPresentError;
+exports.ClientsDoNotMatchError = getWalletProviderFromWalletAccount.ClientsDoNotMatchError;
 exports.InvalidStorageSet = getWalletProviderFromWalletAccount.InvalidStorageSet;
+exports.ValueMustBeDefinedError = getWalletProviderFromWalletAccount.ValueMustBeDefinedError;
 Object.defineProperty(exports, "WalletProviderPriority", {
   enumerable: true,
   get: function () { return getWalletProviderFromWalletAccount.WalletProviderPriority; }

package/core.esm.js

@@ -1,5 +1,5 @@
 import { B as BaseError, g as getCore } from './getWalletProviderFromWalletAccount.esm.js';
-export { C as CannotTrackError, n as ClientNotPresentError, I as InvalidStorageSet, W as WalletProviderPriority, a as assertDefined, b as assignClient, c as createApiClient, e as emitEvent, f as getClient, h as getWalletProviderFromWalletAccount, j as getWalletProviderRegistry, m as hasExtension, s as subscribeWithSelector } from './getWalletProviderFromWalletAccount.esm.js';
+export { A as APIError, C as CannotTrackError, p as ClientNotPresentError, q as ClientsDoNotMatchError, I as InvalidStorageSet, V as ValueMustBeDefinedError, W as WalletProviderPriority, a as assertDefined, b as assignClient, c as createApiClient, e as emitEvent, f as getClient, h as getWalletProviderFromWalletAccount, j as getWalletProviderRegistry, n as hasExtension, s as subscribeWithSelector } from './getWalletProviderFromWalletAccount.esm.js';
 import { Buffer as Buffer$1 } from 'buffer';
 import '@dynamic-labs/sdk-api-core';
 
@@ -7,6 +7,7 @@ class MethodNotImplementedError extends BaseError {
     constructor(methodName){
         super({
             cause: null,
+            code: 'method_not_implemented_error',
             docsUrl: null,
             name: 'MethodNotImplementedError',
             shortMessage: `This method is not implemented: ${methodName}`

package/getWalletProviderFromWalletAccount.cjs.js

@@ -70,7 +70,7 @@ function _extends() {
     return _extends.apply(this, arguments);
 }
 
-var version = "0.0.1-alpha.7";
+var version = "0.0.1-alpha.8";
 var dependencies = {
     "@dynamic-labs/sdk-api-core": "0.0.702"};
 
@@ -115,19 +115,26 @@ const getDetails = ({ details, cause })=>{
         }
         return cause;
     }
+    toString() {
+        return this.formattedMessage;
+    }
     constructor(args){
         const details = getDetails(args);
-        super(formatMessage(_extends({}, args, {
+        const formattedMessage = formatMessage(_extends({}, args, {
             details
-        })), args.cause ? {
+        }));
+        var _args_shortMessage;
+        super((_args_shortMessage = args.shortMessage) != null ? _args_shortMessage : formattedMessage, args.cause ? {
             cause: args.cause
         } : undefined);
         this.name = 'BaseError';
+        this.formattedMessage = formattedMessage;
         this.details = details;
         var _args_name;
         this.name = (_args_name = args.name) != null ? _args_name : this.name;
         var _args_cause;
         this.cause = (_args_cause = args.cause) != null ? _args_cause : this.cause;
+        this.code = args.code;
     }
 }
 
@@ -142,31 +149,103 @@ class APIError extends BaseError {
     constructor(message, code){
         super({
             cause: null,
+            code,
             docsUrl: null,
             name: 'APIError',
             shortMessage: message
         });
-        this.code = code;
     }
 }
 
-const convertToApiErrorMiddleware = {
-    post: async (context)=>{
-        if (context.response.status >= 400) {
-            const apiError = await APIError.fromResponse(context.response);
-            if (apiError) {
-                throw apiError;
-            }
+class MfaInvalidOtpError extends BaseError {
+    constructor({ cause }){
+        super({
+            cause,
+            code: 'mfa_invalid_otp_error',
+            docsUrl: null,
+            name: 'MfaInvalidOtpError',
+            shortMessage: 'Invalid OTP'
+        });
+    }
+}
+
+class MfaRateLimitedError extends BaseError {
+    constructor({ cause }){
+        super({
+            cause,
+            code: 'mfa_rate_limited_error',
+            docsUrl: null,
+            name: 'MfaRateLimitedError',
+            shortMessage: 'Rate limited'
+        });
+    }
+}
+
+/**
+ * Default error mapper for the client that handles common API error codes.
+ *
+ * This mapper transforms specific API error codes into more specific error types:
+ * - `mfa_invalid_code` → `MfaInvalidOtpError`
+ * - `mfa_rate_limited` → `MfaRateLimitedError`
+ *
+ * @param error - The error to be mapped
+ * @returns A transformed error if the error code matches a known pattern, or null if no transformation is needed
+ *
+ * @example
+ * ```typescript
+ * // This will be automatically applied to all API errors
+ * const apiClient = createApiClient(client);
+ *
+ * // The clientErrorMapper will automatically convert mfa_invalid_code errors
+ * // to MfaInvalidOtpError instances
+ * ```
+ */ const clientErrorMapper = (error)=>{
+    if (error instanceof APIError) {
+        if (error.code === 'mfa_invalid_code') {
+            return new MfaInvalidOtpError({
+                cause: error
+            });
+        }
+        if (error.code === 'mfa_rate_limited') {
+            return new MfaRateLimitedError({
+                cause: error
+            });
         }
-        return context.response;
     }
+    return null;
 };
 
+/**
+ * Creates middleware that converts HTTP error responses to APIError instances
+ * and optionally applies custom error mappers to transform them into specific error types.
+ *
+ * @param options.errorMappers - Array of error mappers to apply to API errors
+ * @returns A middleware function that handles error conversion and mapping
+ */ const createConvertToApiErrorMiddleware = ({ errorMappers = [] })=>({
+        post: async (context)=>{
+            if (context.response.status >= 400) {
+                const apiError = await APIError.fromResponse(context.response);
+                if (apiError) {
+                    let errorToThrow = apiError;
+                    for (const mapper of errorMappers){
+                        const newError = mapper(apiError);
+                        if (newError) {
+                            errorToThrow = newError;
+                            break;
+                        }
+                    }
+                    throw errorToThrow;
+                }
+            }
+            return context.response;
+        }
+    });
+
 /**
  * Returns a new instance of the SDK API client.
  *
  * This is not meant for storing, as it is very light we can create it whenever needed.
- */ const createApiClient = (client)=>{
+ */ const createApiClient = (client, options = {})=>{
     const core = getCore(client);
     const settings = {
         basePath: core.apiBaseUrl,
@@ -182,7 +261,12 @@ const convertToApiErrorMiddleware = {
     return new sdkApiCore.SDKApi(new sdkApiCore.Configuration(_extends({}, settings, {
         fetchApi: core.fetch,
         middleware: [
-            convertToApiErrorMiddleware
+            createConvertToApiErrorMiddleware({
+                errorMappers: [
+                    ...options.errorMappers || [],
+                    clientErrorMapper
+                ]
+            })
         ]
     })));
 };
@@ -226,6 +310,7 @@ class ValueMustBeDefinedError extends BaseError {
     constructor(message){
         super({
             cause: null,
+            code: 'value_must_be_defined_error',
             docsUrl: null,
             name: 'ValueMustBeDefined',
             shortMessage: message
@@ -267,6 +352,7 @@ class ClientNotPresentError extends BaseError {
     constructor(){
         super({
             cause: null,
+            code: 'client_not_present_error',
             docsUrl: null,
             name: 'ClientNotPresentError',
             shortMessage: 'The client is not present in the target object.'
@@ -286,6 +372,7 @@ class InvalidStorageSet extends BaseError {
     constructor({ key, value }){
         super({
             cause: null,
+            code: 'invalid_storage_set',
             docsUrl: null,
             metaMessages: [
                 `key: ${key}`,
@@ -301,6 +388,7 @@ class CannotTrackError extends BaseError {
     constructor(){
         super({
             cause: null,
+            code: 'cannot_track_error',
             docsUrl: null,
             name: 'CannotTrackError',
             shortMessage: 'All track calls must be performed in the same node tick'
@@ -334,12 +422,13 @@ class CannotTrackError extends BaseError {
     return core.extensions.has(extensionKey);
 };
 
-class ClientDoNotMatchError extends BaseError {
+class ClientsDoNotMatchError extends BaseError {
     constructor(){
         super({
             cause: null,
+            code: 'clients_do_not_match_error',
             docsUrl: null,
-            name: 'ClientDoNotMatchError',
+            name: 'ClientsDoNotMatchError',
             shortMessage: 'Clients do not match'
         });
     }
@@ -347,7 +436,7 @@ class ClientDoNotMatchError extends BaseError {
 
 const assertClientAreEqual = (client1, client2)=>{
     if (client1 !== client2) {
-        throw new ClientDoNotMatchError();
+        throw new ClientsDoNotMatchError();
     }
 };
 
@@ -452,7 +541,11 @@ exports.APIError = APIError;
 exports.BaseError = BaseError;
 exports.CannotTrackError = CannotTrackError;
 exports.ClientNotPresentError = ClientNotPresentError;
+exports.ClientsDoNotMatchError = ClientsDoNotMatchError;
 exports.InvalidStorageSet = InvalidStorageSet;
+exports.MfaInvalidOtpError = MfaInvalidOtpError;
+exports.MfaRateLimitedError = MfaRateLimitedError;
+exports.ValueMustBeDefinedError = ValueMustBeDefinedError;
 exports._extends = _extends;
 exports.assertDefined = assertDefined;
 exports.assignClient = assignClient;

package/getWalletProviderFromWalletAccount.esm.js

@@ -68,7 +68,7 @@ function _extends() {
     return _extends.apply(this, arguments);
 }
 
-var version = "0.0.1-alpha.7";
+var version = "0.0.1-alpha.8";
 var dependencies = {
     "@dynamic-labs/sdk-api-core": "0.0.702"};
 
@@ -113,19 +113,26 @@ const getDetails = ({ details, cause })=>{
         }
         return cause;
     }
+    toString() {
+        return this.formattedMessage;
+    }
     constructor(args){
         const details = getDetails(args);
-        super(formatMessage(_extends({}, args, {
+        const formattedMessage = formatMessage(_extends({}, args, {
             details
-        })), args.cause ? {
+        }));
+        var _args_shortMessage;
+        super((_args_shortMessage = args.shortMessage) != null ? _args_shortMessage : formattedMessage, args.cause ? {
             cause: args.cause
         } : undefined);
         this.name = 'BaseError';
+        this.formattedMessage = formattedMessage;
         this.details = details;
         var _args_name;
         this.name = (_args_name = args.name) != null ? _args_name : this.name;
         var _args_cause;
         this.cause = (_args_cause = args.cause) != null ? _args_cause : this.cause;
+        this.code = args.code;
     }
 }
 
@@ -140,31 +147,103 @@ class APIError extends BaseError {
     constructor(message, code){
         super({
             cause: null,
+            code,
             docsUrl: null,
             name: 'APIError',
             shortMessage: message
         });
-        this.code = code;
     }
 }
 
-const convertToApiErrorMiddleware = {
-    post: async (context)=>{
-        if (context.response.status >= 400) {
-            const apiError = await APIError.fromResponse(context.response);
-            if (apiError) {
-                throw apiError;
-            }
+class MfaInvalidOtpError extends BaseError {
+    constructor({ cause }){
+        super({
+            cause,
+            code: 'mfa_invalid_otp_error',
+            docsUrl: null,
+            name: 'MfaInvalidOtpError',
+            shortMessage: 'Invalid OTP'
+        });
+    }
+}
+
+class MfaRateLimitedError extends BaseError {
+    constructor({ cause }){
+        super({
+            cause,
+            code: 'mfa_rate_limited_error',
+            docsUrl: null,
+            name: 'MfaRateLimitedError',
+            shortMessage: 'Rate limited'
+        });
+    }
+}
+
+/**
+ * Default error mapper for the client that handles common API error codes.
+ *
+ * This mapper transforms specific API error codes into more specific error types:
+ * - `mfa_invalid_code` → `MfaInvalidOtpError`
+ * - `mfa_rate_limited` → `MfaRateLimitedError`
+ *
+ * @param error - The error to be mapped
+ * @returns A transformed error if the error code matches a known pattern, or null if no transformation is needed
+ *
+ * @example
+ * ```typescript
+ * // This will be automatically applied to all API errors
+ * const apiClient = createApiClient(client);
+ *
+ * // The clientErrorMapper will automatically convert mfa_invalid_code errors
+ * // to MfaInvalidOtpError instances
+ * ```
+ */ const clientErrorMapper = (error)=>{
+    if (error instanceof APIError) {
+        if (error.code === 'mfa_invalid_code') {
+            return new MfaInvalidOtpError({
+                cause: error
+            });
+        }
+        if (error.code === 'mfa_rate_limited') {
+            return new MfaRateLimitedError({
+                cause: error
+            });
         }
-        return context.response;
     }
+    return null;
 };
 
+/**
+ * Creates middleware that converts HTTP error responses to APIError instances
+ * and optionally applies custom error mappers to transform them into specific error types.
+ *
+ * @param options.errorMappers - Array of error mappers to apply to API errors
+ * @returns A middleware function that handles error conversion and mapping
+ */ const createConvertToApiErrorMiddleware = ({ errorMappers = [] })=>({
+        post: async (context)=>{
+            if (context.response.status >= 400) {
+                const apiError = await APIError.fromResponse(context.response);
+                if (apiError) {
+                    let errorToThrow = apiError;
+                    for (const mapper of errorMappers){
+                        const newError = mapper(apiError);
+                        if (newError) {
+                            errorToThrow = newError;
+                            break;
+                        }
+                    }
+                    throw errorToThrow;
+                }
+            }
+            return context.response;
+        }
+    });
+
 /**
  * Returns a new instance of the SDK API client.
  *
  * This is not meant for storing, as it is very light we can create it whenever needed.
- */ const createApiClient = (client)=>{
+ */ const createApiClient = (client, options = {})=>{
     const core = getCore(client);
     const settings = {
         basePath: core.apiBaseUrl,
@@ -180,7 +259,12 @@ const convertToApiErrorMiddleware = {
     return new SDKApi(new Configuration(_extends({}, settings, {
         fetchApi: core.fetch,
         middleware: [
-            convertToApiErrorMiddleware
+            createConvertToApiErrorMiddleware({
+                errorMappers: [
+                    ...options.errorMappers || [],
+                    clientErrorMapper
+                ]
+            })
         ]
     })));
 };
@@ -224,6 +308,7 @@ class ValueMustBeDefinedError extends BaseError {
     constructor(message){
         super({
             cause: null,
+            code: 'value_must_be_defined_error',
             docsUrl: null,
             name: 'ValueMustBeDefined',
             shortMessage: message
@@ -265,6 +350,7 @@ class ClientNotPresentError extends BaseError {
     constructor(){
         super({
             cause: null,
+            code: 'client_not_present_error',
             docsUrl: null,
             name: 'ClientNotPresentError',
             shortMessage: 'The client is not present in the target object.'
@@ -284,6 +370,7 @@ class InvalidStorageSet extends BaseError {
     constructor({ key, value }){
         super({
             cause: null,
+            code: 'invalid_storage_set',
             docsUrl: null,
             metaMessages: [
                 `key: ${key}`,
@@ -299,6 +386,7 @@ class CannotTrackError extends BaseError {
     constructor(){
         super({
             cause: null,
+            code: 'cannot_track_error',
             docsUrl: null,
             name: 'CannotTrackError',
             shortMessage: 'All track calls must be performed in the same node tick'
@@ -332,12 +420,13 @@ class CannotTrackError extends BaseError {
     return core.extensions.has(extensionKey);
 };
 
-class ClientDoNotMatchError extends BaseError {
+class ClientsDoNotMatchError extends BaseError {
     constructor(){
         super({
             cause: null,
+            code: 'clients_do_not_match_error',
             docsUrl: null,
-            name: 'ClientDoNotMatchError',
+            name: 'ClientsDoNotMatchError',
             shortMessage: 'Clients do not match'
         });
     }
@@ -345,7 +434,7 @@ class ClientDoNotMatchError extends BaseError {
 
 const assertClientAreEqual = (client1, client2)=>{
     if (client1 !== client2) {
-        throw new ClientDoNotMatchError();
+        throw new ClientsDoNotMatchError();
     }
 };
 
@@ -446,4 +535,4 @@ const getWalletProviderFromWalletAccount = (walletAccount)=>{
     return walletProvider;
 };
 
-export { APIError as A, BaseError as B, CannotTrackError as C, InvalidStorageSet as I, WalletProviderPriority as W, _extends as _, assertDefined as a, assignClient as b, createApiClient as c, dependencies as d, emitEvent as e, getClient as f, getCore as g, getWalletProviderFromWalletAccount as h, isEqualShallow as i, getWalletProviderRegistry as j, onceEvent as k, onEvent as l, hasExtension as m, ClientNotPresentError as n, offEvent as o, subscribeWithSelector as s, version as v };
+export { APIError as A, BaseError as B, CannotTrackError as C, InvalidStorageSet as I, MfaInvalidOtpError as M, ValueMustBeDefinedError as V, WalletProviderPriority as W, _extends as _, assertDefined as a, assignClient as b, createApiClient as c, dependencies as d, emitEvent as e, getClient as f, getCore as g, getWalletProviderFromWalletAccount as h, isEqualShallow as i, getWalletProviderRegistry as j, MfaRateLimitedError as k, onceEvent as l, onEvent as m, hasExtension as n, offEvent as o, ClientNotPresentError as p, ClientsDoNotMatchError as q, subscribeWithSelector as s, version as v };