graphile-schema 1.1.0

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,155 @@
+# graphile-schema
+
+<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/graphile-schema">
+    <img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=graphile%2Fgraphile-schema%2Fpackage.json"/>
+  </a>
+</p>
+
+Lightweight GraphQL SDL builder for PostgreSQL using PostGraphile v5. Build schemas directly from a database or fetch them from a running GraphQL endpoint — no server dependencies required.
+
+## Installation
+
+```bash
+npm install graphile-schema
+```
+
+## Usage
+
+### Build SDL from a PostgreSQL Database
+
+```typescript
+import { buildSchemaSDL } from 'graphile-schema';
+
+const sdl = await buildSchemaSDL({
+  database: 'mydb',
+  schemas: ['app_public'],
+});
+
+console.log(sdl);
+```
+
+### Fetch SDL from a GraphQL Endpoint
+
+```typescript
+import { fetchEndpointSchemaSDL } from 'graphile-schema';
+
+const sdl = await fetchEndpointSchemaSDL('https://api.example.com/graphql', {
+  auth: 'Bearer my-token',
+  headers: { 'X-Custom-Header': 'value' },
+});
+
+console.log(sdl);
+```
+
+### With Custom Graphile Presets
+
+```typescript
+import { buildSchemaSDL } from 'graphile-schema';
+
+const sdl = await buildSchemaSDL({
+  database: 'mydb',
+  schemas: ['app_public', 'app_private'],
+  graphile: {
+    extends: [MyCustomPreset],
+    schema: { pgSimplifyPatch: false },
+  },
+});
+```
+
+## API
+
+### `buildSchemaSDL(opts)`
+
+Builds a GraphQL SDL string directly from a PostgreSQL database using PostGraphile v5 introspection.
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `database` | `string` | Database name (default: `'constructive'`) |
+| `schemas` | `string[]` | PostgreSQL schemas to introspect |
+| `graphile` | `Partial<GraphileConfig.Preset>` | Optional Graphile preset overrides |
+
+### `fetchEndpointSchemaSDL(endpoint, opts?)`
+
+Fetches a GraphQL SDL string from a running GraphQL endpoint via introspection query.
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `endpoint` | `string` | GraphQL endpoint URL |
+| `opts.headerHost` | `string` | Override the `Host` header |
+| `opts.auth` | `string` | `Authorization` header value |
+| `opts.headers` | `Record<string, string>` | Additional request headers |
+
+## 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.
+
+---
+
+## 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
+
+### 📦 Package Management
+
+* [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.
+
+### 🧪 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.
+* [pgsql-seed](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-seed): **🌱 PostgreSQL seeding utilities** for CSV, JSON, SQL data loading, and pgpm deployment.
+* [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.
+
+## 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/build-schema.d.ts

@@ -0,0 +1,7 @@
+import type { GraphileConfig } from 'graphile-config';
+export type BuildSchemaOptions = {
+    database?: string;
+    schemas: string[];
+    graphile?: Partial<GraphileConfig.Preset>;
+};
+export declare function buildSchemaSDL(opts: BuildSchemaOptions): Promise<string>;

package/build-schema.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildSchemaSDL = buildSchemaSDL;
+const deepmerge_1 = __importDefault(require("deepmerge"));
+const graphql_1 = require("graphql");
+const graphile_settings_1 = require("graphile-settings");
+const graphile_build_1 = require("graphile-build");
+const pg_cache_1 = require("pg-cache");
+const pg_env_1 = require("pg-env");
+async function buildSchemaSDL(opts) {
+    const database = opts.database ?? 'constructive';
+    const schemas = Array.isArray(opts.schemas) ? opts.schemas : [];
+    const config = (0, pg_env_1.getPgEnvOptions)({ database });
+    const connectionString = (0, pg_cache_1.buildConnectionString)(config.user, config.password, config.host, config.port, config.database);
+    const basePreset = {
+        extends: [graphile_settings_1.ConstructivePreset],
+        pgServices: [
+            (0, graphile_settings_1.makePgService)({
+                connectionString,
+                schemas,
+            }),
+        ],
+    };
+    const preset = opts.graphile
+        ? (0, deepmerge_1.default)(basePreset, opts.graphile)
+        : basePreset;
+    const { schema } = await (0, graphile_build_1.makeSchema)(preset);
+    return (0, graphql_1.printSchema)(schema);
+}

package/esm/build-schema.d.ts

@@ -0,0 +1,7 @@
+import type { GraphileConfig } from 'graphile-config';
+export type BuildSchemaOptions = {
+    database?: string;
+    schemas: string[];
+    graphile?: Partial<GraphileConfig.Preset>;
+};
+export declare function buildSchemaSDL(opts: BuildSchemaOptions): Promise<string>;

package/esm/build-schema.js

@@ -0,0 +1,26 @@
+import deepmerge from 'deepmerge';
+import { printSchema } from 'graphql';
+import { ConstructivePreset, makePgService } from 'graphile-settings';
+import { makeSchema } from 'graphile-build';
+import { buildConnectionString } from 'pg-cache';
+import { getPgEnvOptions } from 'pg-env';
+export async function buildSchemaSDL(opts) {
+    const database = opts.database ?? 'constructive';
+    const schemas = Array.isArray(opts.schemas) ? opts.schemas : [];
+    const config = getPgEnvOptions({ database });
+    const connectionString = buildConnectionString(config.user, config.password, config.host, config.port, config.database);
+    const basePreset = {
+        extends: [ConstructivePreset],
+        pgServices: [
+            makePgService({
+                connectionString,
+                schemas,
+            }),
+        ],
+    };
+    const preset = opts.graphile
+        ? deepmerge(basePreset, opts.graphile)
+        : basePreset;
+    const { schema } = await makeSchema(preset);
+    return printSchema(schema);
+}

package/esm/fetch-endpoint-schema.d.ts

@@ -0,0 +1,6 @@
+export type FetchEndpointSchemaOptions = {
+    headerHost?: string;
+    headers?: Record<string, string>;
+    auth?: string;
+};
+export declare function fetchEndpointSchemaSDL(endpoint: string, opts?: FetchEndpointSchemaOptions): Promise<string>;

package/esm/fetch-endpoint-schema.js

@@ -0,0 +1,67 @@
+import { getIntrospectionQuery, buildClientSchema, printSchema } from 'graphql';
+import * as http from 'node:http';
+import * as https from 'node:https';
+export async function fetchEndpointSchemaSDL(endpoint, opts) {
+    const url = new URL(endpoint);
+    const requestUrl = url;
+    const introspectionQuery = getIntrospectionQuery({ descriptions: true });
+    const postData = JSON.stringify({
+        query: introspectionQuery,
+        variables: null,
+        operationName: 'IntrospectionQuery',
+    });
+    const headers = {
+        'Content-Type': 'application/json',
+        'Content-Length': String(Buffer.byteLength(postData)),
+    };
+    if (opts?.headerHost) {
+        headers['Host'] = opts.headerHost;
+    }
+    if (opts?.auth) {
+        headers['Authorization'] = opts.auth;
+    }
+    if (opts?.headers) {
+        for (const [key, value] of Object.entries(opts.headers)) {
+            headers[key] = value;
+        }
+    }
+    const isHttps = requestUrl.protocol === 'https:';
+    const lib = isHttps ? https : http;
+    const responseData = await new Promise((resolve, reject) => {
+        const req = lib.request({
+            hostname: requestUrl.hostname,
+            port: (requestUrl.port ? Number(requestUrl.port) : (isHttps ? 443 : 80)),
+            path: requestUrl.pathname,
+            method: 'POST',
+            headers,
+        }, (res) => {
+            let data = '';
+            res.on('data', (chunk) => { data += chunk; });
+            res.on('end', () => {
+                if (res.statusCode && res.statusCode >= 400) {
+                    reject(new Error(`HTTP ${res.statusCode} – ${data}`));
+                    return;
+                }
+                resolve(data);
+            });
+        });
+        req.on('error', (err) => reject(err));
+        req.write(postData);
+        req.end();
+    });
+    let json;
+    try {
+        json = JSON.parse(responseData);
+    }
+    catch (e) {
+        throw new Error(`Failed to parse response: ${responseData}`);
+    }
+    if (json.errors) {
+        throw new Error('Introspection returned errors');
+    }
+    if (!json.data) {
+        throw new Error('No data in introspection response');
+    }
+    const schema = buildClientSchema(json.data);
+    return printSchema(schema);
+}

package/esm/index.d.ts

@@ -0,0 +1,4 @@
+export { buildSchemaSDL } from './build-schema';
+export type { BuildSchemaOptions } from './build-schema';
+export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';
+export type { FetchEndpointSchemaOptions } from './fetch-endpoint-schema';

package/esm/index.js

@@ -0,0 +1,2 @@
+export { buildSchemaSDL } from './build-schema';
+export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';

package/fetch-endpoint-schema.d.ts

@@ -0,0 +1,6 @@
+export type FetchEndpointSchemaOptions = {
+    headerHost?: string;
+    headers?: Record<string, string>;
+    auth?: string;
+};
+export declare function fetchEndpointSchemaSDL(endpoint: string, opts?: FetchEndpointSchemaOptions): Promise<string>;

package/fetch-endpoint-schema.js

@@ -0,0 +1,103 @@
+"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;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchEndpointSchemaSDL = fetchEndpointSchemaSDL;
+const graphql_1 = require("graphql");
+const http = __importStar(require("node:http"));
+const https = __importStar(require("node:https"));
+async function fetchEndpointSchemaSDL(endpoint, opts) {
+    const url = new URL(endpoint);
+    const requestUrl = url;
+    const introspectionQuery = (0, graphql_1.getIntrospectionQuery)({ descriptions: true });
+    const postData = JSON.stringify({
+        query: introspectionQuery,
+        variables: null,
+        operationName: 'IntrospectionQuery',
+    });
+    const headers = {
+        'Content-Type': 'application/json',
+        'Content-Length': String(Buffer.byteLength(postData)),
+    };
+    if (opts?.headerHost) {
+        headers['Host'] = opts.headerHost;
+    }
+    if (opts?.auth) {
+        headers['Authorization'] = opts.auth;
+    }
+    if (opts?.headers) {
+        for (const [key, value] of Object.entries(opts.headers)) {
+            headers[key] = value;
+        }
+    }
+    const isHttps = requestUrl.protocol === 'https:';
+    const lib = isHttps ? https : http;
+    const responseData = await new Promise((resolve, reject) => {
+        const req = lib.request({
+            hostname: requestUrl.hostname,
+            port: (requestUrl.port ? Number(requestUrl.port) : (isHttps ? 443 : 80)),
+            path: requestUrl.pathname,
+            method: 'POST',
+            headers,
+        }, (res) => {
+            let data = '';
+            res.on('data', (chunk) => { data += chunk; });
+            res.on('end', () => {
+                if (res.statusCode && res.statusCode >= 400) {
+                    reject(new Error(`HTTP ${res.statusCode} – ${data}`));
+                    return;
+                }
+                resolve(data);
+            });
+        });
+        req.on('error', (err) => reject(err));
+        req.write(postData);
+        req.end();
+    });
+    let json;
+    try {
+        json = JSON.parse(responseData);
+    }
+    catch (e) {
+        throw new Error(`Failed to parse response: ${responseData}`);
+    }
+    if (json.errors) {
+        throw new Error('Introspection returned errors');
+    }
+    if (!json.data) {
+        throw new Error('No data in introspection response');
+    }
+    const schema = (0, graphql_1.buildClientSchema)(json.data);
+    return (0, graphql_1.printSchema)(schema);
+}

package/index.d.ts

@@ -0,0 +1,4 @@
+export { buildSchemaSDL } from './build-schema';
+export type { BuildSchemaOptions } from './build-schema';
+export { fetchEndpointSchemaSDL } from './fetch-endpoint-schema';
+export type { FetchEndpointSchemaOptions } from './fetch-endpoint-schema';

package/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchEndpointSchemaSDL = exports.buildSchemaSDL = void 0;
+var build_schema_1 = require("./build-schema");
+Object.defineProperty(exports, "buildSchemaSDL", { enumerable: true, get: function () { return build_schema_1.buildSchemaSDL; } });
+var fetch_endpoint_schema_1 = require("./fetch-endpoint-schema");
+Object.defineProperty(exports, "fetchEndpointSchemaSDL", { enumerable: true, get: function () { return fetch_endpoint_schema_1.fetchEndpointSchemaSDL; } });

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "graphile-schema",
+  "version": "1.1.0",
+  "author": "Constructive <developers@constructive.io>",
+  "description": "Build GraphQL SDL from PostgreSQL databases using PostGraphile v5",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "homepage": "https://github.com/constructive-io/constructive",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/constructive-io/constructive"
+  },
+  "bugs": {
+    "url": "https://github.com/constructive-io/constructive/issues"
+  },
+  "scripts": {
+    "clean": "makage clean",
+    "prepack": "npm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "deepmerge": "^4.3.1",
+    "graphile-build": "^5.0.0-rc.3",
+    "graphile-config": "1.0.0-rc.3",
+    "graphile-settings": "^4.1.0",
+    "graphql": "^16.9.0",
+    "pg-cache": "^3.0.0",
+    "pg-env": "^1.4.0"
+  },
+  "devDependencies": {
+    "makage": "^0.1.10",
+    "ts-node": "^10.9.2"
+  },
+  "keywords": [
+    "graphile",
+    "schema",
+    "graphql",
+    "sdl",
+    "postgraphile",
+    "introspection",
+    "constructive"
+  ],
+  "gitHead": "6dac0247c675de94b41038ac1e5095dc5df0c753"
+}