Merge pull request #200 from enormora/readonly

Support readonly() in query-builder

Author: lo1tuma

dprint.json

@@ -12,7 +12,7 @@
         "singleBodyPosition": "nextLine",
         "nextControlFlowPosition": "sameLine",
         "trailingCommas": "never",
-        "operatorPosition": "nextLine",
+        "operatorPosition": "sameLine",
         "preferHanging": false,
         "preferSingleLine": false,
         "arrowFunction.useParentheses": "force",
@@ -68,11 +68,7 @@
         "emphasisKind": "underscores",
         "strongKind": "asterisks"
     },
-    "excludes": [
-        "target/",
-        "**/node_modules",
-        "**/*-lock.json"
-    ],
+    "excludes": ["target/", "**/node_modules", "**/*-lock.json"],
     "plugins": [
         "./node_modules/@dprint/typescript/plugin.wasm",
         "./node_modules/@dprint/json/plugin.wasm",

eslint.config.js

@@ -15,7 +15,8 @@ export default [
             'prettier/prettier': 'off',
             'dprint/typescript': ['error', { configFile: 'dprint.json' }],
             'import/order': 'off',
-            '@stylistic/member-delimiter-style': 'off'
+            '@stylistic/member-delimiter-style': 'off',
+            '@stylistic/operator-linebreak': 'off'
         }
     },
     {

source/zod-graphql-client/client.ts

@@ -110,12 +110,12 @@ export function createClientFactory(dependencies: CreateClientDependencies): Cre
             const variableDefinitions = extractVariableDefinitions(variables);
             const variableValues = extractVariableValues(variables);
 
-            const serializedQuery = operationType === 'query'
-                ? buildGraphqlQuery(schema, {
+            const serializedQuery = operationType === 'query' ?
+                buildGraphqlQuery(schema, {
                     operationName: options.operationName,
                     variableDefinitions
-                })
-                : buildGraphqlMutation(schema, {
+                }) :
+                buildGraphqlMutation(schema, {
                     operationName: options.operationName,
                     variableDefinitions
                 });

source/zod-graphql-fake-client/fake-client.ts

@@ -47,12 +47,12 @@ export function createFakeGraphqlClient(clientOptions: FakeClientOptions = {}):
         const variableDefinitions = extractVariableDefinitions(variables);
         const variableValues = extractVariableValues(variables);
 
-        const serializedQuery = type === 'query'
-            ? buildGraphqlQuery(schema, {
+        const serializedQuery = type === 'query' ?
+            buildGraphqlQuery(schema, {
                 operationName: options.operationName,
                 variableDefinitions
-            })
-            : buildGraphqlMutation(schema, {
+            }) :
+            buildGraphqlMutation(schema, {
                 operationName: options.operationName,
                 variableDefinitions
             });

source/zod-graphql-query-builder/builder.test.ts

@@ -50,9 +50,9 @@ function checkQuery(testCase: QueryTestCase): TestFn {
         const builder = createQueryBuilder();
         const schema = buildSchema(builder);
 
-        const result = testCase.type === 'query'
-            ? builder.buildQuery(schema, operationOptions)
-            : builder.buildMutation(schema, operationOptions);
+        const result = testCase.type === 'query' ?
+            builder.buildQuery(schema, operationOptions) :
+            builder.buildMutation(schema, operationOptions);
 
         assert.strictEqual(result, expectedQuery);
     };
@@ -652,6 +652,28 @@ function checkQuery(testCase: QueryTestCase): TestFn {
         })
     );
 
+    test(
+        `builds a ${operationType} with readonly objects`,
+        checkQuery({
+            type: operationType,
+            buildSchema() {
+                return z.object({ foo: z.string() }).strict().readonly();
+            },
+            expectedQuery: `${operationType} { foo }`
+        })
+    );
+
+    test(
+        `builds a ${operationType} with nested readonly objects`,
+        checkQuery({
+            type: operationType,
+            buildSchema() {
+                return z.object({ foo: z.object({ bar: z.string() }).strict().readonly() }).strict().readonly();
+            },
+            expectedQuery: `${operationType} { foo { bar } }`
+        })
+    );
+
     test(
         `builds a ${operationType} with union of primitives fields`,
         checkQuery({

source/zod-graphql-query-builder/builder.ts

@@ -1,4 +1,12 @@
-import { type ArrayCardinality, z, ZodArray, ZodDiscriminatedUnion, type ZodLazy, ZodUndefined } from 'zod';
+import {
+    type ArrayCardinality,
+    z,
+    ZodArray,
+    ZodDiscriminatedUnion,
+    type ZodLazy,
+    ZodReadonly,
+    ZodUndefined
+} from 'zod';
 import { isCustomScalarSchema } from './custom-scalar.js';
 import {
     type FieldSchema,
@@ -229,8 +237,9 @@ export function createQueryBuilder(): QueryBuilder {
         let referencedVariables = new Set<string>();
         const { variableDefinitions = {}, operationName = '' } = options;
         const bodyEntries: string[] = [];
+        const shape = schema instanceof ZodReadonly ? schema.unwrap().shape : schema.shape;
 
-        for (const [fieldName, fieldSchema] of Object.entries(schema.shape)) {
+        for (const [fieldName, fieldSchema] of Object.entries(shape)) {
             const serializedField = serializeFieldSchema(fieldName, fieldSchema);
 
             if (serializedField.serializedValue.length > 0) {

source/zod-graphql-query-builder/query-schema.ts

@@ -11,7 +11,7 @@ import {
     type ZodNumber,
     ZodObject,
     type ZodRawShape,
-    type ZodReadonly,
+    ZodReadonly,
     type ZodString,
     ZodTuple,
     type ZodTypeAny,
@@ -66,14 +66,16 @@ function isWrappedFieldSchema(schema: FieldSchema): schema is WrappedFieldSchema
         return false;
     }
 
-    return schema instanceof ZodLazy || schema instanceof ZodEffects || schema instanceof ZodNullable;
+    return schema instanceof ZodLazy || schema instanceof ZodEffects || schema instanceof ZodNullable ||
+        schema instanceof ZodReadonly;
 }
 
 type UnwrappedChainResult = {
     unwrappedSchema: NonWrappedFieldSchema;
     wrapperElements: WrappedFieldSchema[];
 };
 
+// eslint-disable-next-line max-statements,complexity -- no idea how to refactor for now
 function recursiveUnwrapFieldSchemaChain(
     parent: FieldSchema,
     currentChain: WrappedFieldSchema[]
@@ -93,6 +95,8 @@ function recursiveUnwrapFieldSchemaChain(
         unwrapped = parent.innerType();
     } else if (parent instanceof ZodNullable) {
         unwrapped = parent.unwrap();
+    } else if (parent instanceof ZodReadonly) {
+        unwrapped = parent.unwrap();
     }
 
     if (isWrappedFieldSchema(unwrapped)) {
@@ -115,7 +119,7 @@ export function unwrapFieldSchema(parent: FieldSchema): NonWrappedFieldSchema {
 }
 
 type QueryShape = Record<string, FieldSchema>;
-export type QuerySchema = StrictObjectSchema<QueryShape>;
+export type QuerySchema = StrictObjectSchema<QueryShape> | ZodReadonly<StrictObjectSchema<QueryShape>>;
 
 export type FieldSchemaTuple<Schema extends FieldSchema> = ZodTuple<[Schema, ...Schema[]], Schema | null>;