@trpc-panel/core 1.0.0

package/lib/src/parse/routerType.d.ts

@@ -0,0 +1,486 @@
+import { z } from "zod";
+declare const ZodObjectSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+export declare function isZodObject(obj: unknown): obj is z.infer<typeof ZodObjectSchema>;
+declare const SharedProcedureDefPropertiesSchema: z.ZodObject<{
+    inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    input: z.ZodOptional<z.ZodUnknown>;
+    meta: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}>;
+declare const QueryDefSchema: z.ZodIntersection<z.ZodObject<{
+    inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    input: z.ZodOptional<z.ZodUnknown>;
+    meta: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    query: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    query: true;
+}, {
+    query: true;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"query">;
+}, "strip", z.ZodTypeAny, {
+    type: "query";
+}, {
+    type: "query";
+}>]>>;
+export declare function isQueryDef(obj: unknown): obj is QueryDef;
+type QueryDef = z.infer<typeof QueryDefSchema>;
+declare const MutationDefSchema: z.ZodIntersection<z.ZodObject<{
+    inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    input: z.ZodOptional<z.ZodUnknown>;
+    meta: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    mutation: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    mutation: true;
+}, {
+    mutation: true;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"mutation">;
+}, "strip", z.ZodTypeAny, {
+    type: "mutation";
+}, {
+    type: "mutation";
+}>]>>;
+export declare function isMutationDef(obj: unknown): obj is MutationDef;
+export type MutationDef = z.infer<typeof MutationDefSchema>;
+declare const SubscriptionDefSchema: z.ZodIntersection<z.ZodObject<{
+    inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    input: z.ZodOptional<z.ZodUnknown>;
+    meta: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    subscription: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    subscription: true;
+}, {
+    subscription: true;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"subscription">;
+}, "strip", z.ZodTypeAny, {
+    type: "subscription";
+}, {
+    type: "subscription";
+}>]>>;
+type SubscriptionDef = z.infer<typeof SubscriptionDefSchema>;
+export declare function isSubscriptionDef(obj: unknown): obj is SubscriptionDef;
+export declare const ProcedureDefSchema: z.ZodUnion<[z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+    inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    input: z.ZodOptional<z.ZodUnknown>;
+    meta: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    query: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    query: true;
+}, {
+    query: true;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"query">;
+}, "strip", z.ZodTypeAny, {
+    type: "query";
+}, {
+    type: "query";
+}>]>>, z.ZodIntersection<z.ZodObject<{
+    inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    input: z.ZodOptional<z.ZodUnknown>;
+    meta: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    mutation: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    mutation: true;
+}, {
+    mutation: true;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"mutation">;
+}, "strip", z.ZodTypeAny, {
+    type: "mutation";
+}, {
+    type: "mutation";
+}>]>>]>, z.ZodIntersection<z.ZodObject<{
+    inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    input: z.ZodOptional<z.ZodUnknown>;
+    meta: z.ZodOptional<z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        description?: string | undefined;
+    }, {
+        description?: string | undefined;
+    }>>;
+}, "strip", z.ZodTypeAny, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}, {
+    inputs?: unknown[] | undefined;
+    input?: unknown;
+    meta?: {
+        description?: string | undefined;
+    } | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    subscription: z.ZodLiteral<true>;
+}, "strip", z.ZodTypeAny, {
+    subscription: true;
+}, {
+    subscription: true;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"subscription">;
+}, "strip", z.ZodTypeAny, {
+    type: "subscription";
+}, {
+    type: "subscription";
+}>]>>]>;
+export type ProcedureDefSharedProperties = z.infer<typeof SharedProcedureDefPropertiesSchema>;
+export type RouterDef = {
+    router: true;
+    procedures: Record<string, RouterOrProcedure>;
+};
+export type Router = {
+    _def: RouterDef;
+} & {
+    [key: string]: Router | Procedure;
+};
+export declare function isRouter(obj: unknown): obj is Router;
+declare const ProcedureSchema: z.ZodObject<{
+    _def: z.ZodUnion<[z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+        inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+        input: z.ZodOptional<z.ZodUnknown>;
+        meta: z.ZodOptional<z.ZodObject<{
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            description?: string | undefined;
+        }, {
+            description?: string | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    }, {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    }>, z.ZodUnion<[z.ZodObject<{
+        query: z.ZodLiteral<true>;
+    }, "strip", z.ZodTypeAny, {
+        query: true;
+    }, {
+        query: true;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"query">;
+    }, "strip", z.ZodTypeAny, {
+        type: "query";
+    }, {
+        type: "query";
+    }>]>>, z.ZodIntersection<z.ZodObject<{
+        inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+        input: z.ZodOptional<z.ZodUnknown>;
+        meta: z.ZodOptional<z.ZodObject<{
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            description?: string | undefined;
+        }, {
+            description?: string | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    }, {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    }>, z.ZodUnion<[z.ZodObject<{
+        mutation: z.ZodLiteral<true>;
+    }, "strip", z.ZodTypeAny, {
+        mutation: true;
+    }, {
+        mutation: true;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"mutation">;
+    }, "strip", z.ZodTypeAny, {
+        type: "mutation";
+    }, {
+        type: "mutation";
+    }>]>>]>, z.ZodIntersection<z.ZodObject<{
+        inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+        input: z.ZodOptional<z.ZodUnknown>;
+        meta: z.ZodOptional<z.ZodObject<{
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            description?: string | undefined;
+        }, {
+            description?: string | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    }, {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    }>, z.ZodUnion<[z.ZodObject<{
+        subscription: z.ZodLiteral<true>;
+    }, "strip", z.ZodTypeAny, {
+        subscription: true;
+    }, {
+        subscription: true;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"subscription">;
+    }, "strip", z.ZodTypeAny, {
+        type: "subscription";
+    }, {
+        type: "subscription";
+    }>]>>]>;
+}, "strip", z.ZodTypeAny, {
+    _def: ({
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    } & ({
+        query: true;
+    } | {
+        type: "query";
+    })) | ({
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    } & ({
+        mutation: true;
+    } | {
+        type: "mutation";
+    })) | ({
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    } & ({
+        subscription: true;
+    } | {
+        type: "subscription";
+    }));
+}, {
+    _def: ({
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    } & ({
+        query: true;
+    } | {
+        type: "query";
+    })) | ({
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    } & ({
+        mutation: true;
+    } | {
+        type: "mutation";
+    })) | ({
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    } & ({
+        subscription: true;
+    } | {
+        type: "subscription";
+    }));
+}>;
+export type Procedure = z.infer<typeof ProcedureSchema>;
+export declare function isProcedure(obj: unknown | Function): obj is Procedure;
+declare const QuerySchema: z.ZodObject<{
+    _def: z.ZodIntersection<z.ZodObject<{
+        inputs: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+        input: z.ZodOptional<z.ZodUnknown>;
+        meta: z.ZodOptional<z.ZodObject<{
+            description: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            description?: string | undefined;
+        }, {
+            description?: string | undefined;
+        }>>;
+    }, "strip", z.ZodTypeAny, {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    }, {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    }>, z.ZodUnion<[z.ZodObject<{
+        query: z.ZodLiteral<true>;
+    }, "strip", z.ZodTypeAny, {
+        query: true;
+    }, {
+        query: true;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"query">;
+    }, "strip", z.ZodTypeAny, {
+        type: "query";
+    }, {
+        type: "query";
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    _def: {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    } & ({
+        query: true;
+    } | {
+        type: "query";
+    });
+}, {
+    _def: {
+        inputs?: unknown[] | undefined;
+        input?: unknown;
+        meta?: {
+            description?: string | undefined;
+        } | undefined;
+    } & ({
+        query: true;
+    } | {
+        type: "query";
+    });
+}>;
+export type Query = z.infer<typeof QuerySchema>;
+export type RouterOrProcedure = Router | Procedure;
+export {};

package/lib/src/parse/utils.d.ts

@@ -0,0 +1,2 @@
+import { ParseReferences, SharedInputNodeProperties } from "@src/parse/parseNodeTypes";
+export declare function nodePropertiesFromRef(references: ParseReferences): SharedInputNodeProperties;

package/lib/src/render.d.ts

@@ -0,0 +1,7 @@
+import { AnyRouter } from "@trpc/server";
+import { TrpcPanelExtraOptions } from "./parse/parseRouter";
+export type RenderOptions = {
+    url: string;
+    cache?: boolean;
+} & TrpcPanelExtraOptions;
+export declare function renderTrpcPanel(router: AnyRouter, options: RenderOptions): string;

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@trpc-panel/core",
+  "version": "1.0.0",
+  "description": "UI for testing tRPC backends",
+  "main": "lib/index.js",
+  "module": "lib/index.mjs",
+  "typings": "lib/src/index.d.ts",
+  "scripts": {
+    "test": "jest",
+    "test:watch": "jest --watchAll",
+    "build": "bun x rollup --bundleConfigAsCjs --config rollup.config.js",
+    "dev": "bun x rollup --config rollup.config.js --watch --bundleConfigAsCjs"
+  },
+  "author": "",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./lib/src/index.d.ts",
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.js",
+      "default": "./lib/index.js"
+    }
+  },
+  "files": [
+    "lib/"
+  ],
+  "directories": {
+    "lib": "lib"
+  },
+  "peerDependencies": {
+    "@trpc/server": "^11.7.2",
+    "zod": "^3.19.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.2",
+    "@babel/preset-react": "^7.18.6",
+    "@emotion/react": "^11.10.5",
+    "@emotion/styled": "^11.10.5",
+    "@hookform/resolvers": "^2.9.10",
+    "@mui/icons-material": "^5.10.16",
+    "@mui/material": "^5.10.16",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-commonjs": "^23.0.2",
+    "@rollup/plugin-json": "^5.0.1",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-replace": "^5.0.1",
+    "@rollup/plugin-terser": "^0.2.0",
+    "@rollup/plugin-typescript": "^10.0.1",
+    "@tanstack/react-query": "^5.0.0",
+    "@testing-library/jest-dom": "^5.16.5",
+    "@testing-library/react": "^13.4.0",
+    "@testing-library/user-event": "^14.4.3",
+    "@trpc/client": "11.7.2",
+    "@trpc/react-query": "11.7.2",
+    "@trpc/server": "11.7.2",
+    "@types/jest": "^29.2.4",
+    "@types/json-bigint": "^1.0.1",
+    "@types/node": "^20.10.0",
+    "@types/react": "^18.0.21",
+    "@types/react-dom": "^18.0.6",
+    "ajv": "^8.11.2",
+    "ajv-formats": "^2.1.1",
+    "autoprefixer": "^10.4.13",
+    "devalue": "^4.2.0",
+    "gulp": "^4.0.2",
+    "gulp-inline-source": "^4.0.0",
+    "gulp-replace": "^1.1.3",
+    "jest": "^29.3.1",
+    "json-bigint": "^1.0.0",
+    "postcss": "^8.4.19",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "react-hook-form": "^7.39.5",
+    "react-hot-toast": "^2.4.0",
+    "react-hotkeys-hook": "^4.0.6",
+    "rollup": "^3.7.4",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-livereload": "^2.0.5",
+    "rollup-plugin-postcss": "^4.0.2",
+    "rollup-plugin-serve": "^2.0.1",
+    "rollup-plugin-visualizer": "^5.8.3",
+    "superjson": "^1.12.0",
+    "tailwindcss": "^3.2.4",
+    "ts-jest": "^29.0.3",
+    "tslib": "^2.4.1",
+    "typescript": "^5.3.3",
+    "url": "^0.11.0",
+    "zod": "^3.19.1",
+    "zustand": "^4.1.5"
+  },
+  "dependencies": {
+    "fuzzysort": "^2.0.4",
+    "path": "^0.12.7",
+    "url": "^0.11.0",
+    "zod-to-json-schema": "^3.20.0"
+  }
+}