strict type checking

hyperweb-io · Apr 19, 2024 · c9fac2d · c9fac2d
1 parent 94957d5
commit c9fac2d
Show file tree

Hide file tree

Showing 10 changed files with 150 additions and 51 deletions.
diff --git a/__fixtures__/output/contract.camel.ts b/__fixtures__/output/contract.camel.ts
@@ -33,13 +33,21 @@ export interface PoolConfig {
   poolType: PoolType;
 }
 export type PoolType = {
-  xyk: any;
+  xyk: {
+    [key: string]: unknown;
+  };
 } | {
-  stable2Pool: any;
+  stable2Pool: {
+    [key: string]: unknown;
+  };
 } | {
-  stable3Pool: any;
+  stable3Pool: {
+    [key: string]: unknown;
+  };
 } | {
-  weighted: any;
+  weighted: {
+    [key: string]: unknown;
+  };
 } | {
   custom: string;
 };
@@ -53,9 +61,13 @@ export interface SingleSwapRequest {
   swapType: SwapType;
 }
 export type SwapType = {
-  giveIn: any;
+  giveIn: {
+    [key: string]: unknown;
+  };
 } | {
-  giveOut: any;
+  giveOut: {
+    [key: string]: unknown;
+  };
 } | {
   custom: string;
 };
@@ -106,7 +118,11 @@ export type ExecuteMsg = {
     owner: string;
   };
 } | {
-  dropOwnershipProposal: any;
+  dropOwnershipProposal: {
+    [key: string]: unknown;
+  };
 } | {
-  claimOwnership: any;
+  claimOwnership: {
+    [key: string]: unknown;
+  };
 };
diff --git a/__fixtures__/output/contract.ts b/__fixtures__/output/contract.ts
@@ -33,13 +33,21 @@ export interface PoolConfig {
   pool_type: PoolType;
 }
 export type PoolType = {
-  xyk: any;
+  xyk: {
+    [key: string]: unknown;
+  };
 } | {
-  stable2_pool: any;
+  stable2_pool: {
+    [key: string]: unknown;
+  };
 } | {
-  stable3_pool: any;
+  stable3_pool: {
+    [key: string]: unknown;
+  };
 } | {
-  weighted: any;
+  weighted: {
+    [key: string]: unknown;
+  };
 } | {
   custom: string;
 };
@@ -53,9 +61,13 @@ export interface SingleSwapRequest {
   swap_type: SwapType;
 }
 export type SwapType = {
-  give_in: any;
+  give_in: {
+    [key: string]: unknown;
+  };
 } | {
-  give_out: any;
+  give_out: {
+    [key: string]: unknown;
+  };
 } | {
   custom: string;
 };
@@ -106,7 +118,11 @@ export type ExecuteMsg = {
     owner: string;
   };
 } | {
-  drop_ownership_proposal: any;
+  drop_ownership_proposal: {
+    [key: string]: unknown;
+  };
 } | {
-  claim_ownership: any;
+  claim_ownership: {
+    [key: string]: unknown;
+  };
 };
diff --git a/__fixtures__/output/memo.camel.ts b/__fixtures__/output/memo.camel.ts
@@ -4,6 +4,8 @@ export interface Memo {
     key: string;
     description: string;
     gitRepo: string;
-    memo: any;
+    memo: {
+      [key: string]: unknown;
+    };
   }[];
 }
diff --git a/__fixtures__/output/memo.ts b/__fixtures__/output/memo.ts
@@ -4,6 +4,8 @@ export interface Memo {
     key: string;
     description: string;
     git_repo: string;
-    memo: any;
+    memo: {
+      [key: string]: unknown;
+    };
   }[];
 }
diff --git a/__tests__/__snapshots__/contract.test.ts.snap b/__tests__/__snapshots__/contract.test.ts.snap
@@ -36,13 +36,21 @@ export interface PoolConfig {
   pool_type: PoolType;
 }
 export type PoolType = {
-  xyk: any;
+  xyk: {
+    [key: string]: unknown;
+  };
 } | {
-  stable2_pool: any;
+  stable2_pool: {
+    [key: string]: unknown;
+  };
 } | {
-  stable3_pool: any;
+  stable3_pool: {
+    [key: string]: unknown;
+  };
 } | {
-  weighted: any;
+  weighted: {
+    [key: string]: unknown;
+  };
 } | {
   custom: string;
 };
@@ -56,9 +64,13 @@ export interface SingleSwapRequest {
   swap_type: SwapType;
 }
 export type SwapType = {
-  give_in: any;
+  give_in: {
+    [key: string]: unknown;
+  };
 } | {
-  give_out: any;
+  give_out: {
+    [key: string]: unknown;
+  };
 } | {
   custom: string;
 };
@@ -109,9 +121,13 @@ export type ExecuteMsg = {
     owner: string;
   };
 } | {
-  drop_ownership_proposal: any;
+  drop_ownership_proposal: {
+    [key: string]: unknown;
+  };
 } | {
-  claim_ownership: any;
+  claim_ownership: {
+    [key: string]: unknown;
+  };
 };"
 `;
 
@@ -151,13 +167,21 @@ export interface PoolConfig {
   poolType: PoolType;
 }
 export type PoolType = {
-  xyk: any;
+  xyk: {
+    [key: string]: unknown;
+  };
 } | {
-  stable2Pool: any;
+  stable2Pool: {
+    [key: string]: unknown;
+  };
 } | {
-  stable3Pool: any;
+  stable3Pool: {
+    [key: string]: unknown;
+  };
 } | {
-  weighted: any;
+  weighted: {
+    [key: string]: unknown;
+  };
 } | {
   custom: string;
 };
@@ -171,9 +195,13 @@ export interface SingleSwapRequest {
   swapType: SwapType;
 }
 export type SwapType = {
-  giveIn: any;
+  giveIn: {
+    [key: string]: unknown;
+  };
 } | {
-  giveOut: any;
+  giveOut: {
+    [key: string]: unknown;
+  };
 } | {
   custom: string;
 };
@@ -224,8 +252,12 @@ export type ExecuteMsg = {
     owner: string;
   };
 } | {
-  dropOwnershipProposal: any;
+  dropOwnershipProposal: {
+    [key: string]: unknown;
+  };
 } | {
-  claimOwnership: any;
+  claimOwnership: {
+    [key: string]: unknown;
+  };
 };"
 `;
diff --git a/__tests__/__snapshots__/memo.test.ts.snap b/__tests__/__snapshots__/memo.test.ts.snap
@@ -7,7 +7,9 @@ exports[`memo 1`] = `
     key: string;
     description: string;
     git_repo: string;
-    memo: any;
+    memo: {
+      [key: string]: unknown;
+    };
   }[];
 }"
 `;
@@ -19,7 +21,9 @@ exports[`memo camelCase 1`] = `
     key: string;
     description: string;
     gitRepo: string;
-    memo: any;
+    memo: {
+      [key: string]: unknown;
+    };
   }[];
 }"
 `;
diff --git a/package.json b/package.json
@@ -47,6 +47,7 @@
   "dependencies": {
     "@babel/core": "^7.24.4",
     "@babel/generator": "^7.24.4",
-    "@babel/types": "^7.24.0"
+    "@babel/types": "^7.24.0",
+    "deepmerge": "^4.3.1"
   }
 }
diff --git a/src/context.ts b/src/context.ts
@@ -1,8 +1,10 @@
 import type { JSONSchema } from "./types";
+import deepmerge from 'deepmerge';
 
 export interface SchemaTSOptions {
   useSingleQuotes: boolean;
   useCamelCase: boolean;
+  strictTypeSafety: boolean;  // true uses { [k: string]: unknown; }, false uses any
 }
 
 export interface SchemaTSContextI {
@@ -20,17 +22,18 @@ export class SchemaTSContext implements SchemaTSContextI {
   parents: JSONSchema[];
 
   constructor(
-    options: SchemaTSOptions,
+    options: Partial<SchemaTSOptions>,
     root: JSONSchema,
     schema: JSONSchema,
     parents: JSONSchema[] = []
   ) {
-    this.options = options;
+    this.options = deepmerge(defaultOptions, options ?? {});
     this.schema = schema;
     this.root = root;
     this.parents = parents;
   }
 
+  // (currently not used)
   // Clone the context with the option to add a new parent
   clone(newParent: JSONSchema): SchemaTSContext {
     // Create a new array for parents to avoid mutation of the original array
@@ -39,4 +42,8 @@ export class SchemaTSContext implements SchemaTSContextI {
   }
 }
 
-export const defaultOptions: SchemaTSOptions = { useSingleQuotes: true, useCamelCase: false };
+export const defaultOptions: SchemaTSOptions = { 
+  useSingleQuotes: true, 
+  useCamelCase: false,
+  strictTypeSafety: true
+};