@dynamic-labs/wallet-book 1.1.0-alpha.9 → 1.1.0

package/src/schemas/walletGroup.d.ts

@@ -1,4 +1,49 @@
 import { z } from 'zod';
+declare const WalletOverrideEntrySchema: z.ZodObject<{
+    brand: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+        alt: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        imageId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        primaryColor: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        spriteId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    }, "strip", z.ZodTypeAny, {
+        alt?: string | undefined;
+        imageId?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    }, {
+        alt?: unknown;
+        imageId?: unknown;
+        primaryColor?: unknown;
+        spriteId?: unknown;
+    }>, {
+        alt?: string | undefined;
+        imageId?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    }, {
+        alt?: unknown;
+        imageId?: unknown;
+        primaryColor?: unknown;
+        spriteId?: unknown;
+    }>>;
+    name: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+}, "strip", z.ZodTypeAny, {
+    brand?: {
+        alt?: string | undefined;
+        imageId?: string | undefined;
+        primaryColor?: string | undefined;
+        spriteId?: string | undefined;
+    } | undefined;
+    name?: string | undefined;
+}, {
+    brand?: {
+        alt?: unknown;
+        imageId?: unknown;
+        primaryColor?: unknown;
+        spriteId?: unknown;
+    } | undefined;
+    name?: unknown;
+}>;
 export declare const walletGroupSchema: z.ZodObject<{
     brand: z.ZodEffects<z.ZodOptional<z.ZodObject<{
         alt: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
@@ -28,23 +73,88 @@ export declare const walletGroupSchema: z.ZodObject<{
     } | undefined>;
     key: z.ZodString;
     name: z.ZodString;
+    walletOverrides: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
+        brand: z.ZodOptional<z.ZodEffects<z.ZodObject<{
+            alt: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+            imageId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+            primaryColor: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+            spriteId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+        }, "strip", z.ZodTypeAny, {
+            alt?: string | undefined;
+            imageId?: string | undefined;
+            primaryColor?: string | undefined;
+            spriteId?: string | undefined;
+        }, {
+            alt?: unknown;
+            imageId?: unknown;
+            primaryColor?: unknown;
+            spriteId?: unknown;
+        }>, {
+            alt?: string | undefined;
+            imageId?: string | undefined;
+            primaryColor?: string | undefined;
+            spriteId?: string | undefined;
+        }, {
+            alt?: unknown;
+            imageId?: unknown;
+            primaryColor?: unknown;
+            spriteId?: unknown;
+        }>>;
+        name: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    }, "strip", z.ZodTypeAny, {
+        brand?: {
+            alt?: string | undefined;
+            imageId?: string | undefined;
+            primaryColor?: string | undefined;
+            spriteId?: string | undefined;
+        } | undefined;
+        name?: string | undefined;
+    }, {
+        brand?: {
+            alt?: unknown;
+            imageId?: unknown;
+            primaryColor?: unknown;
+            spriteId?: unknown;
+        } | undefined;
+        name?: unknown;
+    }>>>;
 }, "strip", z.ZodTypeAny, {
-    key: string;
     name: string;
+    key: string;
     brand?: {
         alt?: string | undefined;
         imageId?: string | undefined;
         primaryColor?: string | undefined;
         spriteId?: string | undefined;
     } | undefined;
+    walletOverrides?: Record<string, {
+        brand?: {
+            alt?: string | undefined;
+            imageId?: string | undefined;
+            primaryColor?: string | undefined;
+            spriteId?: string | undefined;
+        } | undefined;
+        name?: string | undefined;
+    }> | undefined;
 }, {
-    key: string;
     name: string;
+    key: string;
     brand?: {
         alt?: unknown;
         imageId?: unknown;
         primaryColor?: unknown;
         spriteId?: unknown;
     } | undefined;
+    walletOverrides?: Record<string, {
+        brand?: {
+            alt?: unknown;
+            imageId?: unknown;
+            primaryColor?: unknown;
+            spriteId?: unknown;
+        } | undefined;
+        name?: unknown;
+    }> | undefined;
 }>;
 export type WalletGroupSchema = z.infer<typeof walletGroupSchema>;
+export type WalletGroupOverride = z.infer<typeof WalletOverrideEntrySchema>;
+export {};

package/src/schemas/walletGroup.js

@@ -1,6 +1,11 @@
 import { z } from 'zod';
 import { nonEmptyString } from './utils/nonEmptyString.js';
+import { brandSchema } from './walletSchema.js';
 
+const WalletOverrideEntrySchema = z.object({
+    brand: brandSchema.optional(),
+    name: nonEmptyString,
+});
 const walletGroupSchema = z.object({
     brand: z
         .object({
@@ -23,6 +28,7 @@ const walletGroupSchema = z.object({
     }),
     key: z.string(),
     name: z.string(),
+    walletOverrides: z.record(WalletOverrideEntrySchema).optional(),
 });
 
 export { walletGroupSchema };

package/src/schemas/walletSchema.cjs

@@ -18,6 +18,16 @@ const injectedConfigSchema = zod.z.object({
         flag: zod.z.string(),
         value: zod.z.boolean().optional().default(true),
     })),
+    /**
+     * Allows declaring which interface, if any, this wallet's implementation follows
+     * ex. Leather with https://btckit.org/
+     */
+    providerInterface: zod.z.string().optional(),
+    /**
+     * Allows declaring that this wallet is discoverable through the the Wallet Standard
+     * See https://github.com/wallet-standard/wallet-standard
+     * Also allows ignoring wallets that don't support the provided features
+     */
     walletStandard: zod.z
         .object({ features: zod.z.array(zod.z.string()), name: zod.z.string() })
         .optional(),
@@ -35,28 +45,28 @@ const injectedConfigSchema = zod.z.object({
         path: ['config'],
     }),
 });
+const brandSchema = zod.z
+    .object({
+    alt: nonEmptyString.nonEmptyString,
+    imageId: nonEmptyString.nonEmptyString,
+    primaryColor: nonEmptyString.nonEmptyString,
+    spriteId: nonEmptyString.nonEmptyString,
+})
+    .refine((val) => {
+    if (!val)
+        return true;
+    if (!(val.spriteId && val.imageId) && (val.spriteId || val.imageId)) {
+        return true;
+    }
+    return false;
+}, {
+    message: 'Only one of spriteId or imageId can be defined',
+    path: ['brand'],
+});
 const walletSchema = zod.z
     .preprocess((val) => val, zod.z.object({
-    brand: zod.z
-        .object({
-        alt: nonEmptyString.nonEmptyString,
-        imageId: nonEmptyString.nonEmptyString,
-        primaryColor: nonEmptyString.nonEmptyString,
-        spriteId: nonEmptyString.nonEmptyString,
-    })
-        .optional()
-        .refine((val) => {
-        if (!val)
-            return true;
-        if (!(val.spriteId && val.imageId) &&
-            (val.spriteId || val.imageId)) {
-            return true;
-        }
-        return false;
-    }, {
-        message: 'Only one of spriteId or imageId can be defined',
-        path: ['brand'],
-    }),
+    brand: brandSchema.optional(),
+    chainGroup: zod.z.string().optional(),
     chains: zod.z.array(zod.z.string()).optional(),
     desktop: zod.z
         .object({
@@ -73,6 +83,10 @@ const walletSchema = zod.z
     eip6963Config: zod.z.object({ rdns: zod.z.string() }).optional(),
     filterFromWalletConnect: zod.z.boolean().optional(),
     group: zod.z.string().optional(),
+    /**
+     * Indicates which hardware wallets are enabled for this wallet
+     */
+    hardwareWallets: zod.z.array(zod.z.string()).optional(),
     injectedConfig: zod.z.array(injectedConfigSchema).optional(),
     mobile: zod.z
         .object({
@@ -95,9 +109,13 @@ const walletSchema = zod.z
     })
         .optional()
         .transform(filterEmptyObject.filterEmptyObject),
+    walletGroup: zod.z.string().optional(),
 }))
     .transform((val) => {
     var _a, _b, _c, _d, _e, _f;
+    if (val.group) {
+        val.chainGroup = val.group;
+    }
     if (((_a = val.mobile) === null || _a === void 0 ? void 0 : _a.iosId) || ((_b = val.mobile) === null || _b === void 0 ? void 0 : _b.ios) === null) {
         (_c = val.mobile) === null || _c === void 0 ? true : delete _c.ios;
     }
@@ -107,4 +125,5 @@ const walletSchema = zod.z
     return val;
 });
 
+exports.brandSchema = brandSchema;
 exports.walletSchema = walletSchema;

package/src/schemas/walletSchema.d.ts

@@ -11,6 +11,16 @@ declare const injectedConfigSchema: z.ZodObject<{
         flag: string;
         value?: boolean | undefined;
     }>, "many">;
+    /**
+     * Allows declaring which interface, if any, this wallet's implementation follows
+     * ex. Leather with https://btckit.org/
+     */
+    providerInterface: z.ZodOptional<z.ZodString>;
+    /**
+     * Allows declaring that this wallet is discoverable through the the Wallet Standard
+     * See https://github.com/wallet-standard/wallet-standard
+     * Also allows ignoring wallets that don't support the provided features
+     */
     walletStandard: z.ZodOptional<z.ZodObject<{
         features: z.ZodArray<z.ZodString, "many">;
         name: z.ZodString;
@@ -28,6 +38,7 @@ declare const injectedConfigSchema: z.ZodObject<{
         value: boolean;
         flag: string;
     }[];
+    providerInterface?: string | undefined;
     walletStandard?: {
         features: string[];
         name: string;
@@ -39,14 +50,41 @@ declare const injectedConfigSchema: z.ZodObject<{
         flag: string;
         value?: boolean | undefined;
     }[];
+    providerInterface?: string | undefined;
     walletStandard?: {
         features: string[];
         name: string;
     } | undefined;
     windowLocations?: string[] | undefined;
 }>;
+export declare const brandSchema: z.ZodEffects<z.ZodObject<{
+    alt: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    imageId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    primaryColor: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+    spriteId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
+}, "strip", z.ZodTypeAny, {
+    alt?: string | undefined;
+    imageId?: string | undefined;
+    primaryColor?: string | undefined;
+    spriteId?: string | undefined;
+}, {
+    alt?: unknown;
+    imageId?: unknown;
+    primaryColor?: unknown;
+    spriteId?: unknown;
+}>, {
+    alt?: string | undefined;
+    imageId?: string | undefined;
+    primaryColor?: string | undefined;
+    spriteId?: string | undefined;
+}, {
+    alt?: unknown;
+    imageId?: unknown;
+    primaryColor?: unknown;
+    spriteId?: unknown;
+}>;
 export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
-    brand: z.ZodEffects<z.ZodOptional<z.ZodObject<{
+    brand: z.ZodOptional<z.ZodEffects<z.ZodObject<{
         alt: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
         imageId: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
         primaryColor: z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>;
@@ -61,17 +99,18 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         imageId?: unknown;
         primaryColor?: unknown;
         spriteId?: unknown;
-    }>>, {
+    }>, {
         alt?: string | undefined;
         imageId?: string | undefined;
         primaryColor?: string | undefined;
         spriteId?: string | undefined;
-    } | undefined, {
+    }, {
         alt?: unknown;
         imageId?: unknown;
         primaryColor?: unknown;
         spriteId?: unknown;
-    } | undefined>;
+    }>>;
+    chainGroup: z.ZodOptional<z.ZodString>;
     chains: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     desktop: z.ZodEffects<z.ZodOptional<z.ZodObject<{
         chromeId: z.ZodEffects<z.ZodEffects<z.ZodOptional<z.ZodString>, string | undefined, unknown>, string | undefined, unknown>;
@@ -123,6 +162,10 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     }>>;
     filterFromWalletConnect: z.ZodOptional<z.ZodBoolean>;
     group: z.ZodOptional<z.ZodString>;
+    /**
+     * Indicates which hardware wallets are enabled for this wallet
+     */
+    hardwareWallets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     injectedConfig: z.ZodOptional<z.ZodArray<z.ZodObject<{
         chain: z.ZodString;
         extensionLocators: z.ZodArray<z.ZodObject<{
@@ -135,6 +178,16 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             flag: string;
             value?: boolean | undefined;
         }>, "many">;
+        /**
+         * Allows declaring which interface, if any, this wallet's implementation follows
+         * ex. Leather with https://btckit.org/
+         */
+        providerInterface: z.ZodOptional<z.ZodString>;
+        /**
+         * Allows declaring that this wallet is discoverable through the the Wallet Standard
+         * See https://github.com/wallet-standard/wallet-standard
+         * Also allows ignoring wallets that don't support the provided features
+         */
         walletStandard: z.ZodOptional<z.ZodObject<{
             features: z.ZodArray<z.ZodString, "many">;
             name: z.ZodString;
@@ -152,6 +205,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             value: boolean;
             flag: string;
         }[];
+        providerInterface?: string | undefined;
         walletStandard?: {
             features: string[];
             name: string;
@@ -163,6 +217,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
             flag: string;
             value?: boolean | undefined;
         }[];
+        providerInterface?: string | undefined;
         walletStandard?: {
             features: string[];
             name: string;
@@ -220,6 +275,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     } | undefined, {
         sdks?: unknown;
     } | undefined>;
+    walletGroup: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     brand?: {
@@ -228,6 +284,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         primaryColor?: string | undefined;
         spriteId?: string | undefined;
     } | undefined;
+    chainGroup?: string | undefined;
     chains?: string[] | undefined;
     desktop?: {
         chromeId?: string | undefined;
@@ -243,12 +300,14 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     } | undefined;
     filterFromWalletConnect?: boolean | undefined;
     group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
     injectedConfig?: {
         chain: string;
         extensionLocators: {
             value: boolean;
             flag: string;
         }[];
+        providerInterface?: string | undefined;
         walletStandard?: {
             features: string[];
             name: string;
@@ -269,6 +328,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     walletConnect?: {
         sdks?: string[] | undefined;
     } | undefined;
+    walletGroup?: string | undefined;
 }, {
     name: string;
     brand?: {
@@ -277,6 +337,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         primaryColor?: unknown;
         spriteId?: unknown;
     } | undefined;
+    chainGroup?: string | undefined;
     chains?: string[] | undefined;
     desktop?: {
         chromeId?: unknown;
@@ -292,12 +353,14 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     } | undefined;
     filterFromWalletConnect?: boolean | undefined;
     group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
     injectedConfig?: {
         chain: string;
         extensionLocators: {
             flag: string;
             value?: boolean | undefined;
         }[];
+        providerInterface?: string | undefined;
         walletStandard?: {
             features: string[];
             name: string;
@@ -318,6 +381,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     walletConnect?: {
         sdks?: unknown;
     } | undefined;
+    walletGroup?: string | undefined;
 }>, {
     name: string;
     brand?: {
@@ -326,6 +390,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         primaryColor?: string | undefined;
         spriteId?: string | undefined;
     } | undefined;
+    chainGroup?: string | undefined;
     chains?: string[] | undefined;
     desktop?: {
         chromeId?: string | undefined;
@@ -341,12 +406,14 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     } | undefined;
     filterFromWalletConnect?: boolean | undefined;
     group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
     injectedConfig?: {
         chain: string;
         extensionLocators: {
             value: boolean;
             flag: string;
         }[];
+        providerInterface?: string | undefined;
         walletStandard?: {
             features: string[];
             name: string;
@@ -367,6 +434,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     walletConnect?: {
         sdks?: string[] | undefined;
     } | undefined;
+    walletGroup?: string | undefined;
 }, unknown>, {
     name: string;
     brand?: {
@@ -375,6 +443,7 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
         primaryColor?: string | undefined;
         spriteId?: string | undefined;
     } | undefined;
+    chainGroup?: string | undefined;
     chains?: string[] | undefined;
     desktop?: {
         chromeId?: string | undefined;
@@ -390,12 +459,14 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     } | undefined;
     filterFromWalletConnect?: boolean | undefined;
     group?: string | undefined;
+    hardwareWallets?: string[] | undefined;
     injectedConfig?: {
         chain: string;
         extensionLocators: {
             value: boolean;
             flag: string;
         }[];
+        providerInterface?: string | undefined;
         walletStandard?: {
             features: string[];
             name: string;
@@ -416,7 +487,9 @@ export declare const walletSchema: z.ZodEffects<z.ZodEffects<z.ZodObject<{
     walletConnect?: {
         sdks?: string[] | undefined;
     } | undefined;
+    walletGroup?: string | undefined;
 }, unknown>;
 export type WalletSchema = z.infer<typeof walletSchema>;
 export type WalletInjectedConfigSchema = z.infer<typeof injectedConfigSchema>;
+export type WalletBrand = z.infer<typeof brandSchema>;
 export {};

package/src/schemas/walletSchema.js

@@ -14,6 +14,16 @@ const injectedConfigSchema = z.object({
         flag: z.string(),
         value: z.boolean().optional().default(true),
     })),
+    /**
+     * Allows declaring which interface, if any, this wallet's implementation follows
+     * ex. Leather with https://btckit.org/
+     */
+    providerInterface: z.string().optional(),
+    /**
+     * Allows declaring that this wallet is discoverable through the the Wallet Standard
+     * See https://github.com/wallet-standard/wallet-standard
+     * Also allows ignoring wallets that don't support the provided features
+     */
     walletStandard: z
         .object({ features: z.array(z.string()), name: z.string() })
         .optional(),
@@ -31,28 +41,28 @@ const injectedConfigSchema = z.object({
         path: ['config'],
     }),
 });
+const brandSchema = z
+    .object({
+    alt: nonEmptyString,
+    imageId: nonEmptyString,
+    primaryColor: nonEmptyString,
+    spriteId: nonEmptyString,
+})
+    .refine((val) => {
+    if (!val)
+        return true;
+    if (!(val.spriteId && val.imageId) && (val.spriteId || val.imageId)) {
+        return true;
+    }
+    return false;
+}, {
+    message: 'Only one of spriteId or imageId can be defined',
+    path: ['brand'],
+});
 const walletSchema = z
     .preprocess((val) => val, z.object({
-    brand: z
-        .object({
-        alt: nonEmptyString,
-        imageId: nonEmptyString,
-        primaryColor: nonEmptyString,
-        spriteId: nonEmptyString,
-    })
-        .optional()
-        .refine((val) => {
-        if (!val)
-            return true;
-        if (!(val.spriteId && val.imageId) &&
-            (val.spriteId || val.imageId)) {
-            return true;
-        }
-        return false;
-    }, {
-        message: 'Only one of spriteId or imageId can be defined',
-        path: ['brand'],
-    }),
+    brand: brandSchema.optional(),
+    chainGroup: z.string().optional(),
     chains: z.array(z.string()).optional(),
     desktop: z
         .object({
@@ -69,6 +79,10 @@ const walletSchema = z
     eip6963Config: z.object({ rdns: z.string() }).optional(),
     filterFromWalletConnect: z.boolean().optional(),
     group: z.string().optional(),
+    /**
+     * Indicates which hardware wallets are enabled for this wallet
+     */
+    hardwareWallets: z.array(z.string()).optional(),
     injectedConfig: z.array(injectedConfigSchema).optional(),
     mobile: z
         .object({
@@ -91,9 +105,13 @@ const walletSchema = z
     })
         .optional()
         .transform(filterEmptyObject),
+    walletGroup: z.string().optional(),
 }))
     .transform((val) => {
     var _a, _b, _c, _d, _e, _f;
+    if (val.group) {
+        val.chainGroup = val.group;
+    }
     if (((_a = val.mobile) === null || _a === void 0 ? void 0 : _a.iosId) || ((_b = val.mobile) === null || _b === void 0 ? void 0 : _b.ios) === null) {
         (_c = val.mobile) === null || _c === void 0 ? true : delete _c.ios;
     }
@@ -103,4 +121,4 @@ const walletSchema = z
     return val;
 });
 
-export { walletSchema };
+export { brandSchema, walletSchema };