npm - @trpc-panel/core - Versions diffs - 1.0.0 - Mend

@trpc-panel/core 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (60) hide show

package/lib/react-app/index.html ADDED Viewed

@@ -0,0 +1,16 @@
+<!doctype html>
+<html class="h-full" lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>tRPC.panel()</title>
+    {{css}}
+</head>
+<body class="h-full">
+    <noscript>
+        You need to enable JavaScript to run this app.
+    </noscript>
+    <div class="flex flex-1 w-full h-full" id="root"></div>
+    {{js}}
+</body>
+</html>

package/lib/src/index.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+export { renderTrpcPanel as renderTrpcPanel } from "./render";
+export type { TRPCPanelMeta } from "./meta";
+export { parseRouterWithOptions } from "./parse/parseRouter";

package/lib/src/meta.d.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import { z } from "zod";
+export declare const TRPCPanelMetaSchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    description?: string | undefined;
+}, {
+    description?: string | undefined;
+}>;
+export type TRPCPanelMeta = z.infer<typeof TRPCPanelMetaSchema>;

package/lib/src/parse/__tests__/parseProcedure.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/__tests__/parseRouter.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/__tests__/utils/router.d.ts ADDED Viewed

@@ -0,0 +1,159 @@
+import { ObjectNode } from "@src/parse/parseNodeTypes";
+import { z } from "zod";
+import { ParsedProcedure } from "@src/parse/parseProcedure";
+export declare const testTrpcInstance: import("@trpc/server").TRPCRootObject<object, {
+    description?: string | undefined;
+}, {}, {
+    ctx: object;
+    meta: {
+        description?: string | undefined;
+    };
+    errorShape: import("@trpc/server").TRPCDefaultErrorShape;
+    transformer: false;
+}>;
+export declare const parseTestRouterInputSchema: z.ZodObject<{
+    id: z.ZodString;
+    age: z.ZodNumber;
+    expectedAgeOfDeath: z.ZodOptional<z.ZodNumber>;
+    object: z.ZodObject<{
+        nestedId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        nestedId: string;
+    }, {
+        nestedId: string;
+    }>;
+    du: z.ZodDiscriminatedUnion<"d", [z.ZodObject<{
+        d: z.ZodLiteral<"one">;
+        oneProps: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        d: "one";
+        oneProps: string;
+    }, {
+        d: "one";
+        oneProps: string;
+    }>, z.ZodObject<{
+        d: z.ZodLiteral<"two">;
+    }, "strip", z.ZodTypeAny, {
+        d: "two";
+    }, {
+        d: "two";
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    object: {
+        nestedId: string;
+    };
+    id: string;
+    age: number;
+    du: {
+        d: "one";
+        oneProps: string;
+    } | {
+        d: "two";
+    };
+    expectedAgeOfDeath?: number | undefined;
+}, {
+    object: {
+        nestedId: string;
+    };
+    id: string;
+    age: number;
+    du: {
+        d: "one";
+        oneProps: string;
+    } | {
+        d: "two";
+    };
+    expectedAgeOfDeath?: number | undefined;
+}>;
+export declare const expectedTestRouterInputParsedNode: ObjectNode;
+export declare const testQueryExpectedParseResult: ParsedProcedure;
+export declare const testMutationExpectedParseResult: ParsedProcedure;
+export declare const testQuery: import("@trpc/server").TRPCQueryProcedure<{
+    input: {
+        object: {
+            nestedId: string;
+        };
+        id: string;
+        age: number;
+        du: {
+            d: "one";
+            oneProps: string;
+        } | {
+            d: "two";
+        };
+        expectedAgeOfDeath?: number | undefined;
+    };
+    output: string;
+    meta: {
+        description?: string | undefined;
+    };
+}>;
+export declare const testMutation: import("@trpc/server").TRPCMutationProcedure<{
+    input: {
+        object: {
+            nestedId: string;
+        };
+        id: string;
+        age: number;
+        du: {
+            d: "one";
+            oneProps: string;
+        } | {
+            d: "two";
+        };
+        expectedAgeOfDeath?: number | undefined;
+    };
+    output: string;
+    meta: {
+        description?: string | undefined;
+    };
+}>;
+export declare const parseTestRouter: import("@trpc/server").TRPCBuiltRouter<{
+    ctx: object;
+    meta: {
+        description?: string | undefined;
+    };
+    errorShape: import("@trpc/server").TRPCDefaultErrorShape;
+    transformer: false;
+}, import("@trpc/server").TRPCDecorateCreateRouterOptions<{
+    testQuery: import("@trpc/server").TRPCQueryProcedure<{
+        input: {
+            object: {
+                nestedId: string;
+            };
+            id: string;
+            age: number;
+            du: {
+                d: "one";
+                oneProps: string;
+            } | {
+                d: "two";
+            };
+            expectedAgeOfDeath?: number | undefined;
+        };
+        output: string;
+        meta: {
+            description?: string | undefined;
+        };
+    }>;
+    testMutation: import("@trpc/server").TRPCMutationProcedure<{
+        input: {
+            object: {
+                nestedId: string;
+            };
+            id: string;
+            age: number;
+            du: {
+                d: "one";
+                oneProps: string;
+            } | {
+                d: "two";
+            };
+            expectedAgeOfDeath?: number | undefined;
+        };
+        output: string;
+        meta: {
+            description?: string | undefined;
+        };
+    }>;
+}>>;

package/lib/src/parse/__tests__/utils/schemas.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+import { ParsedInputNode } from "@src/parse/parseNodeTypes";
+import { ZodSchema } from "zod";
+export declare const testEnumValues: readonly ["a", "b", "c"];
+export declare const testSchemas: {
+    schema: ZodSchema;
+    parsed: ParsedInputNode;
+}[];

package/lib/src/parse/input-mappers/__tests__/zod/array.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/bigint.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/boolean.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/branded.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/default.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/discriminatedUnion.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/effects.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/enum.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/literal.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/null.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/nullable.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/number.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/object.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/optional.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/promise.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/string.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/undefined.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/__tests__/zod/void.test.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export {};

package/lib/src/parse/input-mappers/defaultReferences.d.ts ADDED Viewed

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

package/lib/src/parse/input-mappers/zod/parsers/parseZodArrayDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ZodArrayDef } from "zod";
+import { ArrayNode, ParseFunction } from "../../../parseNodeTypes";
+export declare const parseZodArrayDef: ParseFunction<ZodArrayDef, ArrayNode>;

package/lib/src/parse/input-mappers/zod/parsers/parseZodBigIntDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParsedInputNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { ZodBigIntDef } from "zod";
+export declare function parseZodBigIntDef(def: ZodBigIntDef, refs: ParseReferences): ParsedInputNode;

package/lib/src/parse/input-mappers/zod/parsers/parseZodBooleanFieldDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ZodBooleanDef } from "zod";
+import { BooleanNode, ParseFunction } from "../../../parseNodeTypes";
+export declare const parseZodBooleanFieldDef: ParseFunction<ZodBooleanDef, BooleanNode>;

package/lib/src/parse/input-mappers/zod/parsers/parseZodBrandedDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParsedInputNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { AnyZodObject, ZodBrandedDef } from "zod";
+export declare function parseZodBrandedDef(def: ZodBrandedDef<AnyZodObject>, refs: ParseReferences): ParsedInputNode;

package/lib/src/parse/input-mappers/zod/parsers/parseZodDefaultDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParsedInputNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { ZodDefaultDef } from "zod";
+export declare function parseZodDefaultDef(def: ZodDefaultDef, refs: ParseReferences): ParsedInputNode;

package/lib/src/parse/input-mappers/zod/parsers/parseZodDiscriminatedUnionDef.d.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import { AnyZodObject } from "zod";
+import { DiscriminatedUnionNode, ParseFunction } from "../../../parseNodeTypes";
+type OptionsMap = Map<string, AnyZodObject>;
+type ZodDiscriminatedUnionThreePointTwenty = {
+    optionsMap: OptionsMap;
+    discriminator: string;
+    description?: string;
+};
+type ZodDiscriminatedUnionPreThreePointTwenty = {
+    options: OptionsMap;
+    discriminator: string;
+    description?: string;
+};
+export type ZodDiscriminatedUnionDefUnversioned = ZodDiscriminatedUnionPreThreePointTwenty | ZodDiscriminatedUnionThreePointTwenty;
+export declare const parseZodDiscriminatedUnionDef: ParseFunction<ZodDiscriminatedUnionDefUnversioned, DiscriminatedUnionNode>;
+export {};

package/lib/src/parse/input-mappers/zod/parsers/parseZodEffectsDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParsedInputNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { ZodEffectsDef } from "zod";
+export declare function parseZodEffectsDef(def: ZodEffectsDef, refs: ParseReferences): ParsedInputNode;

package/lib/src/parse/input-mappers/zod/parsers/parseZodEnumDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ZodEnumDef } from "zod";
+import { EnumNode, ParseFunction } from "../../../parseNodeTypes";
+export declare const parseZodEnumDef: ParseFunction<ZodEnumDef, EnumNode>;

package/lib/src/parse/input-mappers/zod/parsers/parseZodLiteralDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ZodLiteralDef } from "zod";
+import { LiteralNode, ParseFunction } from "../../../parseNodeTypes";
+export declare const parseZodLiteralDef: ParseFunction<ZodLiteralDef, LiteralNode>;

package/lib/src/parse/input-mappers/zod/parsers/parseZodNullDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParsedInputNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { ZodNullDef } from "zod";
+export declare function parseZodNullDef(def: ZodNullDef, refs: ParseReferences): ParsedInputNode;

package/lib/src/parse/input-mappers/zod/parsers/parseZodNullableDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParsedInputNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { ZodNullableDef } from "zod";
+export declare function parseZodNullableDef(def: ZodNullableDef, refs: ParseReferences): ParsedInputNode;

package/lib/src/parse/input-mappers/zod/parsers/parseZodNumberDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { NumberNode, ParseFunction } from "../../../parseNodeTypes";
+import { ZodNumberDef } from "zod";
+export declare const parseZodNumberDef: ParseFunction<ZodNumberDef, NumberNode>;

package/lib/src/parse/input-mappers/zod/parsers/parseZodObjectDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ZodObjectDef } from "zod";
+import { ObjectNode, ParseFunction, UnsupportedNode } from "../../../parseNodeTypes";
+export declare const parseZodObjectDef: ParseFunction<ZodObjectDef, ObjectNode | UnsupportedNode>;

package/lib/src/parse/input-mappers/zod/parsers/parseZodOptionalDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ZodOptionalDef } from "zod";
+import { ParsedInputNode, ParseFunction } from "../../../parseNodeTypes";
+export declare const parseZodOptionalDef: ParseFunction<ZodOptionalDef, ParsedInputNode>;

package/lib/src/parse/input-mappers/zod/parsers/parseZodPromiseDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParsedInputNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { ZodPromiseDef } from "zod";
+export declare function parseZodPromiseDef(def: ZodPromiseDef, refs: ParseReferences): ParsedInputNode;

package/lib/src/parse/input-mappers/zod/parsers/parseZodStringDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParseFunction, StringNode } from "../../../parseNodeTypes";
+import { ZodStringDef } from "zod";
+export declare const parseZodStringDef: ParseFunction<ZodStringDef, StringNode>;

package/lib/src/parse/input-mappers/zod/parsers/parseZodUndefinedDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParsedInputNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { ZodUndefinedDef } from "zod";
+export declare function parseZodUndefinedDef(def: ZodUndefinedDef, refs: ParseReferences): ParsedInputNode;

package/lib/src/parse/input-mappers/zod/parsers/parseZodVoidDef.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { LiteralNode, ParseReferences } from "@src/parse/parseNodeTypes";
+import { ZodVoidDef } from "zod";
+export declare function parseZodVoidDef(_: ZodVoidDef, refs: ParseReferences): LiteralNode;

package/lib/src/parse/input-mappers/zod/selector.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+import { ParserSelectorFunction } from "../../parseNodeTypes";
+import { ZodDefWithType } from "./zod-types";
+export declare const zodSelectorFunction: ParserSelectorFunction<ZodDefWithType>;

package/lib/src/parse/input-mappers/zod/zod-types.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+import { ZodFirstPartyTypeKind, ZodTypeDef } from "zod";
+export type ZodDefWithType = ZodTypeDef & {
+    typeName: ZodFirstPartyTypeKind;
+};

package/lib/src/parse/parseErrorLogs.d.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export declare function logParseError(procedurePath: string, error: string): void;

package/lib/src/parse/parseNodeTypes.d.ts ADDED Viewed

@@ -0,0 +1,61 @@
+import { ZodTypeDef } from "zod";
+import { ZodDiscriminatedUnionDefUnversioned } from "./input-mappers/zod/parsers/parseZodDiscriminatedUnionDef";
+import { TrpcPanelExtraOptions } from "./parseRouter";
+export type SharedInputNodeProperties = {
+    path: (string | number)[];
+    optional?: true;
+};
+type InputNodeTypes = ZodTypeDef | ZodDiscriminatedUnionDefUnversioned;
+export type ArrayNode = {
+    type: "array";
+    childType: ParsedInputNode;
+} & SharedInputNodeProperties;
+export type ObjectNode = {
+    type: "object";
+    children: {
+        [name: string]: ParsedInputNode;
+    };
+} & SharedInputNodeProperties;
+export type EnumNode = {
+    type: "enum";
+    enumValues: string[];
+} & SharedInputNodeProperties;
+export type DiscriminatedUnionNode = {
+    type: "discriminated-union";
+    discriminatedUnionValues: string[];
+    discriminatedUnionChildrenMap: {
+        [value: string]: ObjectNode;
+    };
+    discriminatorName: string;
+} & SharedInputNodeProperties;
+export type LiteralNode = {
+    type: "literal";
+    value: string | boolean | number | bigint | null | undefined;
+} & SharedInputNodeProperties;
+export type StringNode = {
+    type: "string";
+} & SharedInputNodeProperties;
+export type NumberNode = {
+    type: "number";
+} & SharedInputNodeProperties;
+export type BooleanNode = {
+    type: "boolean";
+} & SharedInputNodeProperties;
+export type UnsupportedNode = {
+    type: "unsupported";
+} & SharedInputNodeProperties;
+export type ParsedInputNode = ArrayNode | ObjectNode | EnumNode | DiscriminatedUnionNode | LiteralNode | StringNode | NumberNode | BooleanNode | UnsupportedNode;
+export type AddDataFunctions = {
+    addDescriptionIfExists: (def: {
+        description?: string;
+    }, refs: ParseReferences) => void;
+};
+export type ParseReferences = {
+    path: string[];
+    optional?: true;
+    options: TrpcPanelExtraOptions;
+    addDataFunctions: AddDataFunctions;
+};
+export type ParseFunction<InputNodeType extends InputNodeTypes, ParsedNodeType extends ParsedInputNode> = (def: InputNodeType, references: ParseReferences) => ParsedNodeType;
+export type ParserSelectorFunction<InputNodeType extends InputNodeTypes> = (inputNode: InputNodeType, references: ParseReferences) => ParsedInputNode;
+export {};

package/lib/src/parse/parseProcedure.d.ts ADDED Viewed

@@ -0,0 +1,18 @@
+import { Procedure } from "./routerType";
+import { JSON7SchemaType, ProcedureType, TrpcPanelExtraOptions } from "./parseRouter";
+import { ParsedInputNode } from "@src/parse/parseNodeTypes";
+export type ProcedureExtraData = {
+    parameterDescriptions: {
+        [path: string]: string;
+    };
+    description?: string;
+};
+export type ParsedProcedure = {
+    inputSchema: JSON7SchemaType;
+    node: ParsedInputNode;
+    nodeType: "procedure";
+    procedureType: ProcedureType;
+    pathFromRootRouter: string[];
+    extraData: ProcedureExtraData;
+};
+export declare function parseProcedure(procedure: Procedure, path: string[], options: TrpcPanelExtraOptions): ParsedProcedure | null;

package/lib/src/parse/parseRouter.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+import { AnyRouter as TRPCRouter } from "@trpc/server";
+import { zodToJsonSchema } from "zod-to-json-schema";
+import { ParsedProcedure } from "./parseProcedure";
+export type JSON7SchemaType = ReturnType<typeof zodToJsonSchema>;
+export type ProcedureType = "query" | "mutation" | "subscription";
+export type ParsedRouterChildren = {
+    [key: string]: ParsedRouter | ParsedProcedure;
+};
+export type ParsedRouter = {
+    children: ParsedRouterChildren;
+    path: string[];
+    nodeType: "router";
+};
+export type ParseRouterRefs = {
+    path: string[];
+};
+export type TrpcPanelExtraOptions = {
+    logFailedProcedureParse?: boolean;
+    transformer?: "superjson";
+};
+export declare function parseRouterWithOptions(router: TRPCRouter, parseRouterOptions: TrpcPanelExtraOptions): ParsedRouter;