@layerzerolabs/typescript-utils 0.0.45 → 0.0.46

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layerzerolabs/typescript-utils",
-  "version": "0.0.45",
+  "version": "0.0.46",
   "private": false,
   "license": "MIT",
   "type": "module",
@@ -16,8 +16,8 @@
   "devDependencies": {
     "tsup": "^8.4.0",
     "vitest": "^3.2.3",
-    "@layerzerolabs/tsup-configuration": "0.0.45",
-    "@layerzerolabs/typescript-configuration": "0.0.45"
+    "@layerzerolabs/tsup-configuration": "0.0.46",
+    "@layerzerolabs/typescript-configuration": "0.0.46"
   },
   "publishConfig": {
     "access": "restricted",

package/src/deep.test-d.ts

@@ -0,0 +1,33 @@
+import { expectTypeOf, test } from 'vitest';
+
+import type { Branded } from './branded';
+import type { DeepOptional } from './deep';
+
+test('DeepOptional', () => {
+    // 1 level
+    type A = DeepOptional<{ a: string; b: number }>;
+    expectTypeOf<A>().toEqualTypeOf<{ a?: string; b?: number }>();
+
+    // 2 levels
+    type B = DeepOptional<{ a: { c: string }; b: number }>;
+    expectTypeOf<B>().toEqualTypeOf<{ a?: { c?: string }; b?: number }>();
+
+    // 1 level with brand tag
+    type obj = { a: string; b: number };
+    type branded = Branded<obj, 'foo'>;
+    type C = DeepOptional<branded>;
+    expectTypeOf<C>().toEqualTypeOf<{ a?: string; b?: number; ___tag___: 'foo' }>();
+
+    // 2 levels with brand tag
+    type obj2 = { a: branded; b: number };
+    type D = DeepOptional<Branded<obj2, 'foo2'>>;
+    expectTypeOf<D>().toEqualTypeOf<{
+        a?: {
+            a?: string;
+            b?: number;
+            ___tag___: 'foo';
+        };
+        b?: number;
+        ___tag___: 'foo2';
+    }>();
+});

package/src/deep.ts

@@ -1,7 +1,20 @@
+import type { Prettify } from './viem';
+
+/**
+ * Copy the brand tag from the branded.ts file, can't import it to keep it hidden from library users
+ */
+const brandTag = '___tag___';
+
 export type DeepRequire<T> = {
     [P in keyof T]-?: DeepRequire<T[P]>;
 };
 
-export type DeepOptional<T> = {
-    [P in keyof T]?: DeepOptional<T[P]>;
-};
+export type DeepOptional<T> = T extends { [brandTag]: infer U }
+    ? Prettify<
+          { [brandTag]: U } & {
+              [P in keyof T]?: DeepOptional<T[P]>;
+          }
+      >
+    : {
+          [P in keyof T]?: DeepOptional<T[P]>;
+      };

package/src/strings.ts

@@ -37,6 +37,6 @@ export type HexStringIsTrimmed<T extends HexString> = T extends '0x0'
         ? false
         : true;
 
-export declare const _DecimalString: unique symbol;
+export declare const _NumberString: unique symbol;
 
-export type DecimalString = Branded<typeof _DecimalString, 'DecimalString'>;
+export type DecimalString = Branded<typeof _NumberString, 'DecimalString'>;

package/dist/H4XPUNCM.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/deep.ts"],"names":[],"mappings":";;;AAIA,cAAA,EAAA","file":"H4XPUNCM.js","sourcesContent":["export type DeepRequire<T> = {\n    [P in keyof T]-?: DeepRequire<T[P]>;\n};\n\nexport type DeepOptional<T> = {\n    [P in keyof T]?: DeepOptional<T[P]>;\n};\n"]}

package/dist/PUPSLF67.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/deep.ts"],"names":["init_cjs_shims"],"mappings":";;;;;AAIAA,2BAAA,EAAA","file":"PUPSLF67.cjs","sourcesContent":["export type DeepRequire<T> = {\n    [P in keyof T]-?: DeepRequire<T[P]>;\n};\n\nexport type DeepOptional<T> = {\n    [P in keyof T]?: DeepOptional<T[P]>;\n};\n"]}