Merge pull request #11 from iway1/improve-zod-parser

Improve zod parser

packages/trpc-panel/jest.config.ts

@@ -0,0 +1,195 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/9h/968nnkxd7zb1_x_lr9gms__h0000gn/T/jest_dx",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

packages/trpc-panel/package.json

@@ -7,7 +7,7 @@
   "typings": "lib/src/index.d.ts",
   "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest",
     "build": "npx rollup --config rollup.config.js",
     "dev": "rollup --config rollup.config.js --watch"
   },
@@ -48,6 +48,7 @@
     "@trpc/client": "^10.4.2",
     "@trpc/react-query": "^10.4.2",
     "@trpc/server": "^10.0.0",
+    "@types/jest": "^29.2.4",
     "@types/react": "^18.0.21",
     "@types/react-dom": "^18.0.6",
     "ajv": "^8.11.2",
@@ -56,6 +57,7 @@
     "gulp": "^4.0.2",
     "gulp-inline-source": "^4.0.0",
     "gulp-replace": "^1.1.3",
+    "jest": "^29.3.1",
     "postcss": "^8.4.19",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",

packages/trpc-panel/rollup.config.js

@@ -7,7 +7,6 @@ import commonjs from "@rollup/plugin-commonjs";
 import copy from "rollup-plugin-copy";
 import replace from "@rollup/plugin-replace";
 import { terser } from "rollup-plugin-terser";
-import { visualizer } from "rollup-plugin-visualizer";
 import postcss from "rollup-plugin-postcss";
 import path from "path";
 const isWatching =

packages/trpc-panel/src/parse/input-mappers/zod/parsers/parseZodBigIntDef.tsx

@@ -0,0 +1,12 @@
+import { ParsedInputNode, ParseReferences } from "src/parse/parsed-node-types";
+import { ZodBigIntDef } from "zod";
+
+export function parseZodBigIntDef(
+    _def: ZodBigIntDef,
+    refs: ParseReferences
+): ParsedInputNode {
+    return {
+        type: "number",
+        ...refs,
+    };
+}

packages/trpc-panel/src/parse/input-mappers/zod/parsers/parseZodBrandedDef.tsx

@@ -0,0 +1,10 @@
+import { zodSelectorFunction } from "src/parse/input-mappers/zod/selector";
+import { ParsedInputNode, ParseReferences } from "src/parse/parsed-node-types";
+import { AnyZodObject, ZodBrandedDef } from "zod";
+
+export function parseZodBrandedDef(
+    def: ZodBrandedDef<AnyZodObject>,
+    refs: ParseReferences
+): ParsedInputNode {
+    return zodSelectorFunction(def.type._def, refs);
+}

packages/trpc-panel/src/parse/input-mappers/zod/parsers/parseZodDefaultDef.tsx

@@ -0,0 +1,10 @@
+import { zodSelectorFunction } from "src/parse/input-mappers/zod/selector";
+import { ParsedInputNode, ParseReferences } from "src/parse/parsed-node-types";
+import { ZodDefaultDef } from "zod";
+
+export function parseZodDefaultDef(
+    def: ZodDefaultDef,
+    refs: ParseReferences
+): ParsedInputNode {
+    return zodSelectorFunction(def.innerType._def, refs);
+}

packages/trpc-panel/src/parse/input-mappers/zod/parsers/parseZodEffectsDef.tsx

@@ -0,0 +1,10 @@
+import { zodSelectorFunction } from "src/parse/input-mappers/zod/selector";
+import { ParsedInputNode, ParseReferences } from "src/parse/parsed-node-types";
+import { ZodEffectsDef } from "zod";
+
+export function parseZodEffectsDef(
+    def: ZodEffectsDef,
+    refs: ParseReferences
+): ParsedInputNode {
+    return zodSelectorFunction(def.schema._def, refs);
+}

packages/trpc-panel/src/parse/input-mappers/zod/parsers/parseZodNullDef.tsx

@@ -0,0 +1,13 @@
+import { ParsedInputNode, ParseReferences } from "src/parse/parsed-node-types";
+import { ZodNullDef } from "zod";
+
+export function parseZodNullDef(
+    _def: ZodNullDef,
+    refs: ParseReferences
+): ParsedInputNode {
+    return {
+        type: "literal",
+        value: null,
+        ...refs,
+    };
+}

packages/trpc-panel/src/parse/input-mappers/zod/parsers/parseZodPromiseDef.tsx

@@ -0,0 +1,10 @@
+import { zodSelectorFunction } from "src/parse/input-mappers/zod/selector";
+import { ParsedInputNode, ParseReferences } from "src/parse/parsed-node-types";
+import { ZodPromiseDef } from "zod";
+
+export function parseZodPromiseDef(
+    def: ZodPromiseDef,
+    refs: ParseReferences
+): ParsedInputNode {
+    return zodSelectorFunction(def.type._def, refs);
+}

packages/trpc-panel/src/parse/input-mappers/zod/parsers/parseZodUndefinedDef.tsx

@@ -0,0 +1,13 @@
+import { ParsedInputNode, ParseReferences } from "src/parse/parsed-node-types";
+import { ZodUndefinedDef } from "zod";
+
+export function parseZodUndefinedDef(
+    _def: ZodUndefinedDef,
+    ref: ParseReferences
+): ParsedInputNode {
+    return {
+        type: "literal",
+        value: undefined,
+        ...ref,
+    };
+}

packages/trpc-panel/src/parse/input-mappers/zod/selector.ts

@@ -2,15 +2,22 @@ import { ParsedInputNode } from "../../parsed-node-types";
 import {
     z,
     ZodArrayDef,
+    ZodBigIntDef,
     ZodBooleanDef,
+    ZodBrandedDef,
+    ZodDefaultDef,
+    ZodEffectsDef,
     ZodEnumDef,
     ZodFirstPartyTypeKind,
     ZodLiteralDef,
     ZodNullableDef,
+    ZodNullDef,
     ZodNumberDef,
     ZodObjectDef,
     ZodOptionalDef,
+    ZodPromiseDef,
     ZodStringDef,
+    ZodUndefinedDef,
 } from "zod";
 import { parseZodStringDef } from "./parsers/parseZodStringDef";
 import { ParserSelectorFunction } from "../../parsed-node-types";
@@ -27,6 +34,13 @@ import { parseZodNumberDef } from "./parsers/parseZodNumberDef";
 import { parseZodObjectDef } from "./parsers/parseZodObjectDef";
 import { parseZodOptionalDef } from "src/parse/input-mappers/zod/parsers/parseZodOptionalDef";
 import { parseZodNullableDef } from "src/parse/input-mappers/zod/parsers/parseZodNullableDef";
+import { parseZodBigIntDef } from "src/parse/input-mappers/zod/parsers/parseZodBigIntDef";
+import { parseZodBrandedDef } from "src/parse/input-mappers/zod/parsers/parseZodBrandedDef";
+import { parseZodDefaultDef } from "src/parse/input-mappers/zod/parsers/parseZodDefaultDef";
+import { parseZodEffectsDef } from "src/parse/input-mappers/zod/parsers/parseZodEffectsDef";
+import { parseZodNullDef } from "src/parse/input-mappers/zod/parsers/parseZodNullDef";
+import { parseZodPromiseDef } from "src/parse/input-mappers/zod/parsers/parseZodPromiseDef";
+import { parseZodUndefinedDef } from "src/parse/input-mappers/zod/parsers/parseZodUndefinedDef";
 
 export const zodSelectorFunction: ParserSelectorFunction<ZodDefWithType> = (
     def,
@@ -61,6 +75,20 @@ export const zodSelectorFunction: ParserSelectorFunction<ZodDefWithType> = (
             return parseZodStringDef(def as ZodStringDef, references);
         case ZodFirstPartyTypeKind.ZodNullable:
             return parseZodNullableDef(def as ZodNullableDef, references);
+        case ZodFirstPartyTypeKind.ZodBigInt:
+            return parseZodBigIntDef(def as ZodBigIntDef, references);
+        case ZodFirstPartyTypeKind.ZodBranded:
+            return parseZodBrandedDef(def as ZodBrandedDef<any>, references);
+        case ZodFirstPartyTypeKind.ZodDefault:
+            return parseZodDefaultDef(def as ZodDefaultDef, references);
+        case ZodFirstPartyTypeKind.ZodEffects:
+            return parseZodEffectsDef(def as ZodEffectsDef, references);
+        case ZodFirstPartyTypeKind.ZodNull:
+            return parseZodNullDef(def as ZodNullDef, references);
+        case ZodFirstPartyTypeKind.ZodPromise:
+            return parseZodPromiseDef(def as ZodPromiseDef, references);
+        case ZodFirstPartyTypeKind.ZodUndefined:
+            return parseZodUndefinedDef(def as ZodUndefinedDef, references);
     }
     return { type: "unsupported", path: references.path, optional: false };
 };

packages/trpc-panel/src/parse/parsed-node-types.ts

@@ -33,9 +33,12 @@ export type DiscriminatedUnionNode = {
     discriminatorName: string;
 } & SharedInputNodeProperties;
 
+/**
+ * Any time you just want the front end to send back a value use this
+ */
 export type LiteralNode = {
     type: "literal";
-    value: string | boolean | number | bigint;
+    value: string | boolean | number | bigint | null | undefined;
 } & SharedInputNodeProperties;
 
 export type StringNode = {

packages/trpc-panel/src/tests/parsers/zod/parseZodArrayDef.test.ts

@@ -0,0 +1,3 @@
+describe("Parse zod array", () => {
+    it("should parse a zod array into a ParsedArray node.", () => {});
+});