@constructive-io/graphql-codegen 2.17.11

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Constructive <developers@constructive.io>
+Copyright (c) 2020-present, Interweb, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,161 @@
+# @constructive-io/graphql-codegen
+
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml/badge.svg" />
+  </a>
+   <a href="https://github.com/constructive-io/constructive/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+   <a href="https://www.npmjs.com/package/@constructive-io/graphql-codegen"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=graphql%2Fcodegen%2Fpackage.json"/></a>
+</p>
+
+Generate GraphQL mutations/queries
+
+```sh
+npm install @constructive-io/graphql-codegen
+```
+
+## introspecting via GraphQL
+
+```js
+import {
+  generate
+} from '@constructive-io/graphql-codegen';
+import { print } from 'graphql/language';
+
+const gen = generate(resultOfIntrospectionQuery);
+const output = Object.keys(gen).reduce((m, key) => {
+  m[key] = print(gen[key].ast);
+  return m;
+}, {});
+
+console.log(output);
+```
+
+# output
+
+which will output the entire API as an object with the mutations and queries as values
+
+```json
+{
+  "createApiTokenMutation": "mutation createApiTokenMutation($id: UUID, $userId: UUID!, $accessToken: String, $accessTokenExpiresAt: Datetime) {
+  createApiToken(input: {apiToken: {id: $id, userId: $userId, accessToken: $accessToken, accessTokenExpiresAt: $accessTokenExpiresAt}}) {
+    apiToken {
+      id
+      userId
+      accessToken
+      accessTokenExpiresAt
+    }
+  }
+}
+```
+
+## Codegen (types, operations, SDK, React Query)
+
+Programmatic codegen generates files to disk from a schema SDL file or from a live endpoint via introspection.
+
+```js
+import { runCodegen, defaultGraphQLCodegenOptions } from '@constructive-io/graphql-codegen'
+
+await runCodegen({
+  input: { schema: './schema.graphql' }, // or: { endpoint: 'http://localhost:3000/graphql', headers: { Host: 'meta8.localhost' } }
+  output: defaultGraphQLCodegenOptions.output, // root/typesFile/operationsDir/sdkFile/reactQueryFile
+  documents: defaultGraphQLCodegenOptions.documents, // format: 'gql'|'ts', naming convention
+  features: { emitTypes: true, emitOperations: true, emitSdk: true, emitReactQuery: true },
+  reactQuery: { fetcher: 'graphql-request' }
+}, process.cwd())
+```
+
+Outputs under `output.root`:
+- `types/generated.ts` (schema types)
+- `operations/*` (queries/mutations/Fragments)
+- `sdk.ts` (typed GraphQL Request client)
+- `react-query.ts` (typed React Query hooks; generated when `emitReactQuery: true`)
+
+Documents options:
+- `format`: `'gql' | 'ts'`
+- `convention`: `'dashed' | 'underscore' | 'camelcase' | 'camelUpper'`
+- `allowQueries`, `excludeQueries`, `excludePatterns` to control which root fields become operations
+
+Endpoint introspection:
+- Set `input.endpoint` and optional `input.headers`
+- If your dev server routes by hostname, add `headers: { Host: 'meta8.localhost' }`
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
+Master the workflow for adding, organizing, and managing database changes with pgpm.
+
+ 4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related Constructive Tooling
+
+### 🧪 Testing
+
+* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [supabase-test](https://github.com/constructive-io/constructive/tree/main/postgres/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [graphile-test](https://github.com/constructive-io/constructive/tree/main/graphile/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/postgres/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
+
+### 🧠 Parsing & AST
+
+* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
+* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+* [pg-ast](https://www.npmjs.com/package/pg-ast): **🔍 Low-level AST tools** and transformations for Postgres query structures.
+
+### 🚀 API & Dev Tools
+
+* [@constructive-io/graphql-server](https://github.com/constructive-io/constructive/tree/main/graphql/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
+* [@constructive-io/graphql-explorer](https://github.com/constructive-io/constructive/tree/main/graphql/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
+
+### 🔁 Streaming & Uploads
+
+* [etag-hash](https://github.com/constructive-io/constructive/tree/main/streaming/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
+* [etag-stream](https://github.com/constructive-io/constructive/tree/main/streaming/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
+* [uuid-hash](https://github.com/constructive-io/constructive/tree/main/streaming/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
+* [uuid-stream](https://github.com/constructive-io/constructive/tree/main/streaming/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
+* [@constructive-io/s3-streamer](https://github.com/constructive-io/constructive/tree/main/streaming/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
+* [@constructive-io/upload-names](https://github.com/constructive-io/constructive/tree/main/streaming/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
+
+### 🧰 CLI & Codegen
+
+* [pgpm](https://github.com/constructive-io/constructive/tree/main/pgpm/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+* [@constructive-io/cli](https://github.com/constructive-io/constructive/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing Constructive projects—supports database scaffolding, migrations, seeding, code generation, and automation.
+* [@constructive-io/graphql-codegen](https://github.com/constructive-io/constructive/tree/main/graphql/codegen): **✨ GraphQL code generation** (types, operations, SDK) from schema/endpoint introspection.
+* [@constructive-io/query-builder](https://github.com/constructive-io/constructive/tree/main/packages/query-builder): **🏗️ SQL constructor** providing a robust TypeScript-based query builder for dynamic generation of `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and stored procedure calls—supports advanced SQL features like `JOIN`, `GROUP BY`, and schema-qualified queries.
+* [@constructive-io/graphql-query](https://github.com/constructive-io/constructive/tree/main/graphql/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
+
+## Credits
+
+**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/codegen.d.ts

@@ -0,0 +1,13 @@
+import { GraphQLCodegenOptions } from './options';
+export declare function runCodegen(opts: GraphQLCodegenOptions, cwd: string): Promise<{
+    root: string;
+    typesFile: string;
+    operationsDir: string;
+    sdkFile: string;
+}>;
+export declare function runCodegenFromJSONConfig(configPath: string, cwd: string): Promise<{
+    root: string;
+    typesFile: string;
+    operationsDir: string;
+    sdkFile: string;
+}>;

package/codegen.js

@@ -0,0 +1,267 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runCodegen = runCodegen;
+exports.runCodegenFromJSONConfig = runCodegenFromJSONConfig;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const graphql_1 = require("graphql");
+const inflection = require('inflection');
+const gql_1 = require("./gql");
+const introspectron_1 = require("introspectron");
+const options_1 = require("./options");
+const core_1 = require("@graphql-codegen/core");
+const typescriptPlugin = __importStar(require("@graphql-codegen/typescript"));
+const typescriptOperationsPlugin = __importStar(require("@graphql-codegen/typescript-operations"));
+const typescriptGraphqlRequestPlugin = __importStar(require("@graphql-codegen/typescript-graphql-request"));
+const typescriptReactQueryPlugin = __importStar(require("@graphql-codegen/typescript-react-query"));
+const graphql_request_1 = require("graphql-request");
+const parser_1 = require("@babel/parser");
+const generator_1 = __importDefault(require("@babel/generator"));
+const t = __importStar(require("@babel/types"));
+function addDocumentNodeImport(code) {
+    const ast = (0, parser_1.parse)(code, {
+        sourceType: 'module',
+        plugins: ['typescript']
+    });
+    const importDecl = t.importDeclaration([t.importSpecifier(t.identifier('DocumentNode'), t.identifier('DocumentNode'))], t.stringLiteral('graphql'));
+    importDecl.importKind = 'type';
+    ast.program.body.unshift(importDecl);
+    const output = (0, generator_1.default)(ast, {}, code);
+    return output.code;
+}
+function getFilename(key, convention) {
+    if (convention === 'underscore')
+        return inflection.underscore(key);
+    if (convention === 'dashed')
+        return inflection.underscore(key).replace(/_/g, '-');
+    if (convention === 'camelUpper')
+        return inflection.camelize(key, false);
+    return key;
+}
+async function ensureDir(p) {
+    await fs_1.promises.mkdir(p, { recursive: true });
+}
+async function readFileUTF8(p) {
+    return fs_1.promises.readFile(p, 'utf8');
+}
+async function writeFileUTF8(p, content) {
+    await ensureDir((0, path_1.dirname)(p));
+    await fs_1.promises.writeFile(p, content, 'utf8');
+}
+async function getIntrospectionFromSDL(schemaPath) {
+    const sdl = await readFileUTF8(schemaPath);
+    const schema = (0, graphql_1.buildSchema)(sdl);
+    const q = (0, graphql_1.getIntrospectionQuery)();
+    const res = await (0, graphql_1.graphql)({ schema, source: q });
+    return res.data;
+}
+async function getIntrospectionFromEndpoint(endpoint, headers) {
+    const client = new graphql_request_1.GraphQLClient(endpoint, { headers });
+    const q = (0, graphql_1.getIntrospectionQuery)();
+    const res = await client.request(q);
+    return res;
+}
+function generateKeyedObjFromGqlMap(gqlMap) {
+    const gen = (0, gql_1.generate)(gqlMap);
+    return Object.entries(gen).reduce((acc, [key, val]) => {
+        if (val?.ast)
+            acc[key] = (0, graphql_1.print)(val.ast);
+        return acc;
+    }, {});
+}
+function applyQueryFilters(map, docs) {
+    const allow = (docs.allowQueries || []).filter(Boolean);
+    const exclude = (docs.excludeQueries || []).filter(Boolean);
+    const patterns = (docs.excludePatterns || []).filter(Boolean);
+    let keys = Object.keys(map);
+    if (allow.length > 0)
+        keys = keys.filter((k) => allow.includes(k));
+    if (exclude.length > 0)
+        keys = keys.filter((k) => !exclude.includes(k));
+    if (patterns.length > 0) {
+        const regs = patterns.map((p) => {
+            try {
+                return new RegExp(p);
+            }
+            catch {
+                return null;
+            }
+        }).filter((r) => !!r);
+        keys = keys.filter((k) => !regs.some((r) => r.test(k)));
+    }
+    return keys.reduce((acc, k) => {
+        acc[k] = map[k];
+        return acc;
+    }, {});
+}
+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');
+        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}'`);
+        }
+        else {
+            await writeFileUTF8((0, path_1.join)(dir, filename), docs[key]);
+        }
+    }
+    if (format === 'ts')
+        await writeFileUTF8((0, path_1.join)(dir, 'index.ts'), index.sort().join('\n'));
+}
+async function runCodegen(opts, cwd) {
+    const options = {
+        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 || {}) }
+    };
+    const root = (0, path_1.join)(cwd, options.output.root);
+    const typesFile = (0, path_1.join)(root, options.output.typesFile);
+    const operationsDir = (0, path_1.join)(root, options.output.operationsDir);
+    const sdkFile = (0, path_1.join)(root, options.output.sdkFile);
+    const reactQueryFile = (0, path_1.join)(root, options.output.reactQueryFile || 'react-query.ts');
+    const hasSchemaPath = !!options.input.schema && options.input.schema.trim() !== '';
+    const hasEndpoint = !!options.input.endpoint && options.input.endpoint.trim() !== '';
+    const schemaPath = hasSchemaPath ? ((0, path_1.isAbsolute)(options.input.schema) ? options.input.schema : (0, path_1.resolve)(cwd, options.input.schema)) : '';
+    const introspection = hasEndpoint
+        ? await getIntrospectionFromEndpoint(options.input.endpoint, options.input.headers || {})
+        : await getIntrospectionFromSDL(schemaPath);
+    const { queries, mutations } = (0, introspectron_1.parseGraphQuery)(introspection);
+    const gqlMap = applyQueryFilters({ ...queries, ...mutations }, options.documents);
+    let docs = {};
+    const schema = hasEndpoint
+        ? (0, graphql_1.buildClientSchema)(introspection)
+        : (0, graphql_1.buildSchema)(await readFileUTF8(schemaPath));
+    if (options.features.emitOperations || options.features.emitSdk || options.features.emitReactQuery) {
+        docs = generateKeyedObjFromGqlMap(gqlMap);
+    }
+    if (options.features.emitOperations) {
+        await writeOperationsDocuments(docs, operationsDir, options.documents.format, options.documents.convention);
+    }
+    if (options.features.emitTypes) {
+        const typesContent = await (0, core_1.codegen)({
+            filename: typesFile,
+            schema: schema,
+            documents: [],
+            config: {},
+            plugins: [{ typescript: {} }],
+            pluginMap: { typescript: typescriptPlugin }
+        });
+        await writeFileUTF8(typesFile, typesContent);
+    }
+    if (options.features.emitSdk) {
+        const documents = [];
+        for (const [name, content] of Object.entries(docs)) {
+            try {
+                const doc = require('graphql').parse(content);
+                documents.push({ location: name, document: doc });
+            }
+            catch (e) { }
+        }
+        const sdkContent = await (0, core_1.codegen)({
+            filename: sdkFile,
+            schema: schema,
+            documents,
+            config: {},
+            plugins: [
+                { typescript: {} },
+                { 'typescript-operations': {} },
+                { 'typescript-graphql-request': {} }
+            ],
+            pluginMap: {
+                typescript: typescriptPlugin,
+                'typescript-operations': typescriptOperationsPlugin,
+                'typescript-graphql-request': typescriptGraphqlRequestPlugin
+            }
+        });
+        // Fix TS2742: Add missing DocumentNode import using Babel AST
+        const sdkContentWithImport = addDocumentNodeImport(sdkContent);
+        await writeFileUTF8(sdkFile, sdkContentWithImport);
+    }
+    if (options.features.emitReactQuery) {
+        const documents = [];
+        for (const [name, content] of Object.entries(docs)) {
+            try {
+                const doc = require('graphql').parse(content);
+                documents.push({ location: name, document: doc });
+            }
+            catch (e) { }
+        }
+        const rqConfig = {
+            fetcher: options.reactQuery?.fetcher || 'graphql-request',
+            legacyMode: options.reactQuery?.legacyMode || false,
+            exposeDocument: options.reactQuery?.exposeDocument || false,
+            addInfiniteQuery: options.reactQuery?.addInfiniteQuery || false
+        };
+        const rqContent = await (0, core_1.codegen)({
+            filename: reactQueryFile,
+            schema: schema,
+            documents,
+            config: rqConfig,
+            plugins: [
+                { typescript: {} },
+                { 'typescript-operations': {} },
+                { 'typescript-react-query': rqConfig }
+            ],
+            pluginMap: {
+                typescript: typescriptPlugin,
+                'typescript-operations': typescriptOperationsPlugin,
+                'typescript-react-query': typescriptReactQueryPlugin
+            }
+        });
+        await writeFileUTF8(reactQueryFile, rqContent);
+    }
+    return { root, typesFile, operationsDir, sdkFile };
+}
+async function runCodegenFromJSONConfig(configPath, cwd) {
+    const path = (0, path_1.isAbsolute)(configPath) ? configPath : (0, path_1.resolve)(cwd, configPath);
+    const content = await readFileUTF8(path);
+    let overrides = {};
+    try {
+        overrides = JSON.parse(content);
+    }
+    catch (e) {
+        throw new Error('Invalid JSON config: ' + e);
+    }
+    const merged = (0, options_1.mergeGraphQLCodegenOptions)(options_1.defaultGraphQLCodegenOptions, overrides);
+    return runCodegen(merged, cwd);
+}