@constructive-io/graphql-types 2.12.4

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,137 @@
+# @constructive-io/graphql-types
+
+GraphQL/Graphile types for the Constructive framework.
+
+This package contains TypeScript type definitions for PostGraphile/Graphile configuration used by Constructive server, explorer, and related packages.
+
+## Installation
+
+```bash
+npm install @constructive-io/graphql-types
+```
+
+## Usage
+
+```typescript
+import { 
+  ConstructiveOptions, 
+  GraphileOptions, 
+  ApiOptions, 
+  GraphileFeatureOptions,
+  constructiveDefaults 
+} from '@constructive-io/graphql-types';
+
+// ConstructiveOptions extends PgpmOptions with GraphQL configuration
+const config: ConstructiveOptions = {
+  graphile: {
+    schema: ['public', 'app_public'],
+    appendPlugins: [],
+  },
+  api: {
+    enableMetaApi: true,
+    exposedSchemas: ['public'],
+  },
+  features: {
+    simpleInflection: true,
+    postgis: true,
+  },
+};
+```
+
+## Types
+
+### ConstructiveOptions
+
+Full configuration options for Constructive framework, extending `PgpmOptions` with GraphQL/Graphile configuration.
+
+### GraphileOptions
+
+PostGraphile/Graphile configuration including schema, plugins, and build options.
+
+### ApiOptions
+
+Configuration for the Constructive API including meta API settings, exposed schemas, and role configuration.
+
+### GraphileFeatureOptions
+
+Feature flags for GraphQL/Graphile including inflection settings and PostGIS support.
+
+## Re-exports
+
+This package re-exports all types from `@pgpmjs/types` for convenience, so you can import both core PGPM types and GraphQL types from a single package.
+
+---
+
+## 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/constructive.d.ts

@@ -0,0 +1,49 @@
+import { PgConfig } from 'pg-env';
+import { PgpmOptions, PgTestConnectionOptions, DeploymentOptions, ServerOptions, CDNOptions, MigrationOptions, JobsConfig } from '@pgpmjs/types';
+import { GraphileOptions, GraphileFeatureOptions, ApiOptions } from './graphile';
+/**
+ * GraphQL-specific options for Constructive
+ */
+export interface ConstructiveGraphQLOptions {
+    /** PostGraphile/Graphile configuration */
+    graphile?: GraphileOptions;
+    /** Feature flags and toggles for GraphQL */
+    features?: GraphileFeatureOptions;
+    /** API configuration options */
+    api?: ApiOptions;
+}
+/**
+ * Full Constructive configuration options
+ * Extends PgpmOptions with GraphQL/Graphile configuration
+ */
+export interface ConstructiveOptions extends PgpmOptions, ConstructiveGraphQLOptions {
+    /** Test database configuration options */
+    db?: Partial<PgTestConnectionOptions>;
+    /** PostgreSQL connection configuration */
+    pg?: Partial<PgConfig>;
+    /** PostGraphile/Graphile configuration */
+    graphile?: GraphileOptions;
+    /** HTTP server configuration */
+    server?: ServerOptions;
+    /** Feature flags and toggles for GraphQL */
+    features?: GraphileFeatureOptions;
+    /** API configuration options */
+    api?: ApiOptions;
+    /** CDN and file storage configuration */
+    cdn?: CDNOptions;
+    /** Module deployment configuration */
+    deployment?: DeploymentOptions;
+    /** Migration and code generation options */
+    migrations?: MigrationOptions;
+    /** Job system configuration */
+    jobs?: JobsConfig;
+}
+/**
+ * Default GraphQL-specific configuration values
+ */
+export declare const constructiveGraphqlDefaults: ConstructiveGraphQLOptions;
+/**
+ * Full default configuration values for Constructive framework
+ * Combines PGPM core defaults with GraphQL/Graphile defaults
+ */
+export declare const constructiveDefaults: ConstructiveOptions;

package/constructive.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructiveDefaults = exports.constructiveGraphqlDefaults = void 0;
+const deepmerge_1 = __importDefault(require("deepmerge"));
+const types_1 = require("@pgpmjs/types");
+const graphile_1 = require("./graphile");
+/**
+ * Default GraphQL-specific configuration values
+ */
+exports.constructiveGraphqlDefaults = {
+    graphile: graphile_1.graphileDefaults,
+    features: graphile_1.graphileFeatureDefaults,
+    api: graphile_1.apiDefaults
+};
+/**
+ * Full default configuration values for Constructive framework
+ * Combines PGPM core defaults with GraphQL/Graphile defaults
+ */
+exports.constructiveDefaults = deepmerge_1.default.all([
+    types_1.pgpmDefaults,
+    exports.constructiveGraphqlDefaults
+]);

package/esm/constructive.js

@@ -0,0 +1,19 @@
+import deepmerge from 'deepmerge';
+import { pgpmDefaults } from '@pgpmjs/types';
+import { graphileDefaults, graphileFeatureDefaults, apiDefaults } from './graphile';
+/**
+ * Default GraphQL-specific configuration values
+ */
+export const constructiveGraphqlDefaults = {
+    graphile: graphileDefaults,
+    features: graphileFeatureDefaults,
+    api: apiDefaults
+};
+/**
+ * Full default configuration values for Constructive framework
+ * Combines PGPM core defaults with GraphQL/Graphile defaults
+ */
+export const constructiveDefaults = deepmerge.all([
+    pgpmDefaults,
+    constructiveGraphqlDefaults
+]);

package/esm/graphile.js

@@ -0,0 +1,29 @@
+/**
+ * Default GraphQL/Graphile configuration values
+ */
+export const graphileDefaults = {
+    schema: [],
+    appendPlugins: [],
+    overrideSettings: {},
+    graphileBuildOptions: {},
+};
+/**
+ * Default feature options for GraphQL/Graphile
+ */
+export const graphileFeatureDefaults = {
+    simpleInflection: true,
+    oppositeBaseNames: true,
+    postgis: true
+};
+/**
+ * Default API configuration values
+ */
+export const apiDefaults = {
+    enableMetaApi: true,
+    exposedSchemas: [],
+    anonRole: 'administrator',
+    roleName: 'administrator',
+    defaultDatabaseId: 'hard-coded',
+    isPublic: true,
+    metaSchemas: ['collections_public', 'meta_public']
+};

package/esm/index.js

@@ -0,0 +1,6 @@
+// Re-export all core types from @pgpmjs/types for convenience
+export * from '@pgpmjs/types';
+// Export GraphQL/Graphile specific types
+export { graphileDefaults, graphileFeatureDefaults, apiDefaults } from './graphile';
+// Export Constructive combined types
+export { constructiveGraphqlDefaults, constructiveDefaults } from './constructive';

package/graphile.d.ts

@@ -0,0 +1,57 @@
+import type { Plugin } from 'graphile-build';
+import { PostGraphileOptions } from 'postgraphile';
+/**
+ * PostGraphile/Graphile configuration
+ */
+export interface GraphileOptions {
+    /** Database schema(s) to expose through GraphQL */
+    schema?: string | string[];
+    /** Additional Graphile plugins to load */
+    appendPlugins?: Plugin[];
+    /** Build options for Graphile */
+    graphileBuildOptions?: PostGraphileOptions['graphileBuildOptions'];
+    /** Override settings for PostGraphile */
+    overrideSettings?: Partial<PostGraphileOptions>;
+}
+/**
+ * Feature flags and toggles for GraphQL/Graphile
+ */
+export interface GraphileFeatureOptions {
+    /** Use simple inflection for GraphQL field names */
+    simpleInflection?: boolean;
+    /** Use opposite base names for relationships */
+    oppositeBaseNames?: boolean;
+    /** Enable PostGIS spatial database support */
+    postgis?: boolean;
+}
+/**
+ * Configuration options for the Constructive API
+ */
+export interface ApiOptions {
+    /** Whether to enable the meta API endpoints */
+    enableMetaApi?: boolean;
+    /** Database schemas to expose through the API */
+    exposedSchemas?: string[];
+    /** Anonymous role name for unauthenticated requests */
+    anonRole?: string;
+    /** Default role name for authenticated requests */
+    roleName?: string;
+    /** Default database identifier to use */
+    defaultDatabaseId?: string;
+    /** Whether the API is publicly accessible */
+    isPublic?: boolean;
+    /** Schemas containing metadata tables */
+    metaSchemas?: string[];
+}
+/**
+ * Default GraphQL/Graphile configuration values
+ */
+export declare const graphileDefaults: GraphileOptions;
+/**
+ * Default feature options for GraphQL/Graphile
+ */
+export declare const graphileFeatureDefaults: GraphileFeatureOptions;
+/**
+ * Default API configuration values
+ */
+export declare const apiDefaults: ApiOptions;

package/graphile.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiDefaults = exports.graphileFeatureDefaults = exports.graphileDefaults = void 0;
+/**
+ * Default GraphQL/Graphile configuration values
+ */
+exports.graphileDefaults = {
+    schema: [],
+    appendPlugins: [],
+    overrideSettings: {},
+    graphileBuildOptions: {},
+};
+/**
+ * Default feature options for GraphQL/Graphile
+ */
+exports.graphileFeatureDefaults = {
+    simpleInflection: true,
+    oppositeBaseNames: true,
+    postgis: true
+};
+/**
+ * Default API configuration values
+ */
+exports.apiDefaults = {
+    enableMetaApi: true,
+    exposedSchemas: [],
+    anonRole: 'administrator',
+    roleName: 'administrator',
+    defaultDatabaseId: 'hard-coded',
+    isPublic: true,
+    metaSchemas: ['collections_public', 'meta_public']
+};

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from '@pgpmjs/types';
+export { GraphileOptions, GraphileFeatureOptions, ApiOptions, graphileDefaults, graphileFeatureDefaults, apiDefaults } from './graphile';
+export { ConstructiveGraphQLOptions, ConstructiveOptions, constructiveGraphqlDefaults, constructiveDefaults } from './constructive';

package/index.js

@@ -0,0 +1,28 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructiveDefaults = exports.constructiveGraphqlDefaults = exports.apiDefaults = exports.graphileFeatureDefaults = exports.graphileDefaults = void 0;
+// Re-export all core types from @pgpmjs/types for convenience
+__exportStar(require("@pgpmjs/types"), exports);
+// Export GraphQL/Graphile specific types
+var graphile_1 = require("./graphile");
+Object.defineProperty(exports, "graphileDefaults", { enumerable: true, get: function () { return graphile_1.graphileDefaults; } });
+Object.defineProperty(exports, "graphileFeatureDefaults", { enumerable: true, get: function () { return graphile_1.graphileFeatureDefaults; } });
+Object.defineProperty(exports, "apiDefaults", { enumerable: true, get: function () { return graphile_1.apiDefaults; } });
+// Export Constructive combined types
+var constructive_1 = require("./constructive");
+Object.defineProperty(exports, "constructiveGraphqlDefaults", { enumerable: true, get: function () { return constructive_1.constructiveGraphqlDefaults; } });
+Object.defineProperty(exports, "constructiveDefaults", { enumerable: true, get: function () { return constructive_1.constructiveDefaults; } });

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@constructive-io/graphql-types",
+  "version": "2.12.4",
+  "author": "Constructive <developers@constructive.io>",
+  "description": "Constructive GraphQL/Graphile types for PostGraphile integration",
+  "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 --passWithNoTests",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@pgpmjs/types": "^2.12.4",
+    "deepmerge": "^4.3.1",
+    "graphile-build": "^4.14.1",
+    "pg-env": "^1.2.3",
+    "postgraphile": "^4.14.1"
+  },
+  "keywords": [
+    "graphql",
+    "types",
+    "typescript",
+    "constructive",
+    "postgraphile",
+    "graphile"
+  ],
+  "devDependencies": {
+    "makage": "^0.1.8"
+  },
+  "gitHead": "22cfe32e994e26a6490e04e28bab26d1e7e6345c"
+}