@constructive-io/graphql-codegen 2.17.29 → 2.17.31

package/README.md

@@ -84,6 +84,103 @@ Endpoint introspection:
 - Set `input.endpoint` and optional `input.headers`
 - If your dev server routes by hostname, add `headers: { Host: 'meta8.localhost' }`
 
+## Selection Options
+
+Configure result field selections, mutation input style, and connection pagination shape.
+
+```ts
+selection: {
+  defaultMutationModelFields?: string[]
+  modelFields?: Record<string, string[]>
+  mutationInputMode?: 'expanded' | 'model' | 'raw' | 'patchCollapsed'
+  connectionStyle?: 'nodes' | 'edges'
+  forceModelOutput?: boolean
+}
+```
+
+- `defaultMutationModelFields`
+  - Sets default fields selected from the object payload returned by mutations when the mutation exposes an OBJECT output.
+  - Example: `['id']` will select only the `id` from the returned model unless overridden per model.
+
+- `modelFields`
+  - Per‑model overrides for returned object payload fields.
+  - Example: `{ domain: ['id','domain','subdomain'] }` selects those fields from the `domain` object output.
+
+- `mutationInputMode`
+  - Controls how mutation variables and `input` are generated.
+  - `expanded`: one variable per input property; `input` is a flat object of those variables.
+  - `model`: one variable per property; variables are nested under the singular model key inside `input`.
+  - `raw`: a single `$input: <CreateXInput>!` variable passed directly as `input: $input`.
+  - `patchCollapsed`: a single `$patch: <ModelPatch>!` plus required locator(s) (e.g., `$id`), passed as `input: { id: $id, patch: $patch }`.
+
+- `connectionStyle`
+  - Standardizes connection queries and nested many selections.
+  - `nodes`: emits `totalCount` and `nodes { ... }`.
+  - `edges`: emits `totalCount`, `pageInfo { ... }`, and `edges { cursor node { ... } }`.
+
+- `forceModelOutput`
+  - When `true`, ensures the object payload is selected even if `defaultMutationModelFields` is empty, defaulting to `['id']`.
+  - Useful to avoid generating mutations that only return `clientMutationId`.
+
+### Examples
+
+Create mutation with raw input:
+
+```graphql
+mutation createDomain($input: CreateDomainInput!) {
+  createDomain(input: $input) {
+    domain { id, domain, subdomain }
+  }
+}
+```
+
+Patch mutation with collapsed patch:
+
+```graphql
+mutation updateDomain($id: UUID!, $patch: DomainPatch!) {
+  updateDomain(input: { id: $id, patch: $patch }) {
+    domain { id }
+    clientMutationId
+  }
+}
+```
+
+Edges‑style connection query:
+
+```graphql
+query getDomainsPaginated($first: Int, $after: Cursor) {
+  domains(first: $first, after: $after) {
+    totalCount
+    pageInfo { hasNextPage hasPreviousPage endCursor startCursor }
+    edges { cursor node { id domain subdomain } }
+  }
+}
+```
+
+## Custom Scalars and Type Overrides
+
+- When your schema exposes custom scalars that are not available in the printed SDL or differ across environments, you can configure both TypeScript scalar typings and GraphQL type names used in generated operations.
+
+- Add these to your config object:
+
+```json
+{
+  "scalars": {
+    "LaunchqlInternalTypeHostname": "string",
+    "PgpmInternalTypeHostname": "string"
+  },
+  "typeNameOverrides": {
+    "LaunchqlInternalTypeHostname": "String",
+    "PgpmInternalTypeHostname": "String"
+  }
+}
+```
+
+- `scalars`: maps GraphQL scalar names to TypeScript types for `typescript`/`typescript-operations`/`typescript-graphql-request`/`typescript-react-query` plugins.
+- `typeNameOverrides`: rewrites scalar names in generated GraphQL AST so variable definitions and input fields use compatible built‑in GraphQL types.
+
+- These options are also available programmatically through `LaunchQLGenOptions`.
+
 ---
 
 ## Education and Tutorials

package/codegen.js

@@ -97,8 +97,8 @@ async function getIntrospectionFromEndpoint(endpoint, headers) {
     const res = await client.request(q);
     return res;
 }
-function generateKeyedObjFromGqlMap(gqlMap) {
-    const gen = (0, gql_1.generate)(gqlMap);
+function generateKeyedObjFromGqlMap(gqlMap, selection, typeNameOverrides, typeIndex) {
+    const gen = (0, gql_1.generate)(gqlMap, selection, typeNameOverrides, typeIndex);
     return Object.entries(gen).reduce((acc, [key, val]) => {
         if (val?.ast)
             acc[key] = (0, graphql_1.print)(val.ast);
@@ -134,11 +134,12 @@ async function writeOperationsDocuments(docs, dir, format, convention) {
     await ensureDir(dir);
     const index = [];
     for (const key of Object.keys(docs)) {
-        const filename = getFilename(key, convention) + (format === 'ts' ? '.ts' : '.gql');
+        const base = getFilename(key, convention);
+        const filename = base + (format === 'ts' ? '.ts' : '.gql');
         if (format === 'ts') {
             const code = `import gql from 'graphql-tag'\nexport const ${key} = gql\`\n${docs[key]}\n\``;
             await writeFileUTF8((0, path_1.join)(dir, filename), code);
-            index.push(`export * from './${filename}'`);
+            index.push(`export * from './${base}'`);
         }
         else {
             await writeFileUTF8((0, path_1.join)(dir, filename), docs[key]);
@@ -152,7 +153,10 @@ async function runCodegen(opts, cwd) {
         input: { ...(options_1.defaultGraphQLCodegenOptions.input), ...(opts.input || {}) },
         output: { ...(options_1.defaultGraphQLCodegenOptions.output), ...(opts.output || {}) },
         documents: { ...(options_1.defaultGraphQLCodegenOptions.documents), ...(opts.documents || {}) },
-        features: { ...(options_1.defaultGraphQLCodegenOptions.features), ...(opts.features || {}) }
+        features: { ...(options_1.defaultGraphQLCodegenOptions.features), ...(opts.features || {}) },
+        selection: { ...(options_1.defaultGraphQLCodegenOptions.selection), ...(opts.selection || {}) },
+        scalars: { ...(options_1.defaultGraphQLCodegenOptions.scalars || {}), ...(opts.scalars || {}) },
+        typeNameOverrides: { ...(options_1.defaultGraphQLCodegenOptions.typeNameOverrides || {}), ...(opts.typeNameOverrides || {}) }
     };
     const root = (0, path_1.join)(cwd, options.output.root);
     const typesFile = (0, path_1.join)(root, options.output.typesFile);
@@ -171,8 +175,9 @@ async function runCodegen(opts, cwd) {
     const schema = hasEndpoint
         ? (0, graphql_1.buildClientSchema)(introspection)
         : (0, graphql_1.buildSchema)(await readFileUTF8(schemaPath));
+    const typeIndex = buildTypeIndex(introspection);
     if (options.features.emitOperations || options.features.emitSdk || options.features.emitReactQuery) {
-        docs = generateKeyedObjFromGqlMap(gqlMap);
+        docs = generateKeyedObjFromGqlMap(gqlMap, options.selection, options.typeNameOverrides, typeIndex);
     }
     if (options.features.emitOperations) {
         await writeOperationsDocuments(docs, operationsDir, options.documents.format, options.documents.convention);
@@ -182,7 +187,7 @@ async function runCodegen(opts, cwd) {
             filename: typesFile,
             schema: schema,
             documents: [],
-            config: {},
+            config: { scalars: options.scalars || {} },
             plugins: [{ typescript: {} }],
             pluginMap: { typescript: typescriptPlugin }
         });
@@ -201,7 +206,7 @@ async function runCodegen(opts, cwd) {
             filename: sdkFile,
             schema: schema,
             documents,
-            config: {},
+            config: { scalars: options.scalars || {} },
             plugins: [
                 { typescript: {} },
                 { 'typescript-operations': {} },
@@ -230,7 +235,9 @@ async function runCodegen(opts, cwd) {
             fetcher: options.reactQuery?.fetcher || 'graphql-request',
             legacyMode: options.reactQuery?.legacyMode || false,
             exposeDocument: options.reactQuery?.exposeDocument || false,
-            addInfiniteQuery: options.reactQuery?.addInfiniteQuery || false
+            addInfiniteQuery: options.reactQuery?.addInfiniteQuery || false,
+            reactQueryVersion: options.reactQuery?.reactQueryVersion || 5,
+            scalars: options.scalars || {}
         };
         const rqContent = await (0, core_1.codegen)({
             filename: reactQueryFile,
@@ -265,3 +272,22 @@ async function runCodegenFromJSONConfig(configPath, cwd) {
     const merged = (0, options_1.mergeGraphQLCodegenOptions)(options_1.defaultGraphQLCodegenOptions, overrides);
     return runCodegen(merged, cwd);
 }
+function buildTypeIndex(introspection) {
+    const byName = {};
+    const types = (introspection && introspection.__schema && introspection.__schema.types) || [];
+    for (const t of types) {
+        if (t && typeof t.name === 'string' && t.name.length > 0)
+            byName[t.name] = t;
+    }
+    return {
+        byName,
+        getInputFieldType(typeName, fieldName) {
+            const typ = byName[typeName];
+            if (!typ || typ.kind !== 'INPUT_OBJECT')
+                return null;
+            const fields = typ.inputFields || [];
+            const f = fields.find((x) => x && x.name === fieldName);
+            return f ? f.type : null;
+        }
+    };
+}

package/esm/codegen.js

@@ -57,8 +57,8 @@ async function getIntrospectionFromEndpoint(endpoint, headers) {
     const res = await client.request(q);
     return res;
 }
-function generateKeyedObjFromGqlMap(gqlMap) {
-    const gen = generateGql(gqlMap);
+function generateKeyedObjFromGqlMap(gqlMap, selection, typeNameOverrides, typeIndex) {
+    const gen = generateGql(gqlMap, selection, typeNameOverrides, typeIndex);
     return Object.entries(gen).reduce((acc, [key, val]) => {
         if (val?.ast)
             acc[key] = print(val.ast);
@@ -94,11 +94,12 @@ async function writeOperationsDocuments(docs, dir, format, convention) {
     await ensureDir(dir);
     const index = [];
     for (const key of Object.keys(docs)) {
-        const filename = getFilename(key, convention) + (format === 'ts' ? '.ts' : '.gql');
+        const base = getFilename(key, convention);
+        const filename = base + (format === 'ts' ? '.ts' : '.gql');
         if (format === 'ts') {
             const code = `import gql from 'graphql-tag'\nexport const ${key} = gql\`\n${docs[key]}\n\``;
             await writeFileUTF8(join(dir, filename), code);
-            index.push(`export * from './${filename}'`);
+            index.push(`export * from './${base}'`);
         }
         else {
             await writeFileUTF8(join(dir, filename), docs[key]);
@@ -112,7 +113,10 @@ export async function runCodegen(opts, cwd) {
         input: { ...(defaultGraphQLCodegenOptions.input), ...(opts.input || {}) },
         output: { ...(defaultGraphQLCodegenOptions.output), ...(opts.output || {}) },
         documents: { ...(defaultGraphQLCodegenOptions.documents), ...(opts.documents || {}) },
-        features: { ...(defaultGraphQLCodegenOptions.features), ...(opts.features || {}) }
+        features: { ...(defaultGraphQLCodegenOptions.features), ...(opts.features || {}) },
+        selection: { ...(defaultGraphQLCodegenOptions.selection), ...(opts.selection || {}) },
+        scalars: { ...(defaultGraphQLCodegenOptions.scalars || {}), ...(opts.scalars || {}) },
+        typeNameOverrides: { ...(defaultGraphQLCodegenOptions.typeNameOverrides || {}), ...(opts.typeNameOverrides || {}) }
     };
     const root = join(cwd, options.output.root);
     const typesFile = join(root, options.output.typesFile);
@@ -131,8 +135,9 @@ export async function runCodegen(opts, cwd) {
     const schema = hasEndpoint
         ? buildClientSchema(introspection)
         : buildSchema(await readFileUTF8(schemaPath));
+    const typeIndex = buildTypeIndex(introspection);
     if (options.features.emitOperations || options.features.emitSdk || options.features.emitReactQuery) {
-        docs = generateKeyedObjFromGqlMap(gqlMap);
+        docs = generateKeyedObjFromGqlMap(gqlMap, options.selection, options.typeNameOverrides, typeIndex);
     }
     if (options.features.emitOperations) {
         await writeOperationsDocuments(docs, operationsDir, options.documents.format, options.documents.convention);
@@ -142,7 +147,7 @@ export async function runCodegen(opts, cwd) {
             filename: typesFile,
             schema: schema,
             documents: [],
-            config: {},
+            config: { scalars: options.scalars || {} },
             plugins: [{ typescript: {} }],
             pluginMap: { typescript: typescriptPlugin }
         });
@@ -161,7 +166,7 @@ export async function runCodegen(opts, cwd) {
             filename: sdkFile,
             schema: schema,
             documents,
-            config: {},
+            config: { scalars: options.scalars || {} },
             plugins: [
                 { typescript: {} },
                 { 'typescript-operations': {} },
@@ -190,7 +195,9 @@ export async function runCodegen(opts, cwd) {
             fetcher: options.reactQuery?.fetcher || 'graphql-request',
             legacyMode: options.reactQuery?.legacyMode || false,
             exposeDocument: options.reactQuery?.exposeDocument || false,
-            addInfiniteQuery: options.reactQuery?.addInfiniteQuery || false
+            addInfiniteQuery: options.reactQuery?.addInfiniteQuery || false,
+            reactQueryVersion: options.reactQuery?.reactQueryVersion || 5,
+            scalars: options.scalars || {}
         };
         const rqContent = await runCoreCodegen({
             filename: reactQueryFile,
@@ -225,3 +232,22 @@ export async function runCodegenFromJSONConfig(configPath, cwd) {
     const merged = mergeGraphQLCodegenOptions(defaultGraphQLCodegenOptions, overrides);
     return runCodegen(merged, cwd);
 }
+function buildTypeIndex(introspection) {
+    const byName = {};
+    const types = (introspection && introspection.__schema && introspection.__schema.types) || [];
+    for (const t of types) {
+        if (t && typeof t.name === 'string' && t.name.length > 0)
+            byName[t.name] = t;
+    }
+    return {
+        byName,
+        getInputFieldType(typeName, fieldName) {
+            const typ = byName[typeName];
+            if (!typ || typ.kind !== 'INPUT_OBJECT')
+                return null;
+            const fields = typ.inputFields || [];
+            const f = fields.find((x) => x && x.name === fieldName);
+            return f ? f.type : null;
+        }
+    };
+}