graphile-settings 3.1.1 → 4.0.0

package/index.d.ts

@@ -1,3 +1,37 @@
-import { ConstructiveOptions } from '@constructive-io/graphql-types';
-import { PostGraphileOptions } from 'postgraphile';
-export declare const getGraphileSettings: (rawOpts: ConstructiveOptions) => PostGraphileOptions;
+/**
+ * graphile-settings
+ *
+ * Shared PostGraphile v5 settings, presets, and plugins for Constructive.
+ *
+ * This package provides:
+ * - Custom plugins for PostGraphile v5
+ * - Pre-configured presets combining multiple plugins
+ *
+ * USAGE:
+ *
+ * 1. Use the main preset:
+ * ```typescript
+ * import { ConstructivePreset, makePgService } from 'graphile-settings';
+ * import { makeSchema } from 'graphile-build';
+ *
+ * const preset = {
+ *   extends: [ConstructivePreset],
+ *   pgServices: [makePgService({ connectionString, schemas })],
+ * };
+ * const { schema } = await makeSchema(preset);
+ * ```
+ *
+ * 2. Use individual plugins:
+ * ```typescript
+ * import { MinimalPreset, InflektPreset } from 'graphile-settings/plugins';
+ * ```
+ */
+import { makePgService } from 'postgraphile/adaptors/pg';
+import 'postgraphile/grafserv';
+import 'graphile-build';
+export { ConstructivePreset } from './presets/constructive-preset';
+export * from './plugins/index';
+export * from './presets/index';
+import { MinimalPreset } from './plugins/minimal-preset';
+export { MinimalPreset };
+export { makePgService };

package/index.js

@@ -1,4 +1,32 @@
 "use strict";
+/**
+ * graphile-settings
+ *
+ * Shared PostGraphile v5 settings, presets, and plugins for Constructive.
+ *
+ * This package provides:
+ * - Custom plugins for PostGraphile v5
+ * - Pre-configured presets combining multiple plugins
+ *
+ * USAGE:
+ *
+ * 1. Use the main preset:
+ * ```typescript
+ * import { ConstructivePreset, makePgService } from 'graphile-settings';
+ * import { makeSchema } from 'graphile-build';
+ *
+ * const preset = {
+ *   extends: [ConstructivePreset],
+ *   pgServices: [makePgService({ connectionString, schemas })],
+ * };
+ * const { schema } = await makeSchema(preset);
+ * ```
+ *
+ * 2. Use individual plugins:
+ * ```typescript
+ * import { MinimalPreset, InflektPreset } from 'graphile-settings/plugins';
+ * ```
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -10,134 +38,33 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     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 };
+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.getGraphileSettings = void 0;
-const pg_many_to_many_1 = __importDefault(require("@graphile-contrib/pg-many-to-many"));
-const graphql_env_1 = require("@constructive-io/graphql-env");
-const graphile_postgis_1 = __importDefault(require("graphile-postgis"));
-const graphile_plugin_fulltext_filter_1 = __importDefault(require("graphile-plugin-fulltext-filter"));
-const graphile_build_1 = require("graphile-build");
-const graphile_i18n_1 = require("graphile-i18n");
-const graphile_meta_schema_1 = __importDefault(require("graphile-meta-schema"));
-const graphile_search_plugin_1 = __importDefault(require("graphile-search-plugin"));
-const graphile_simple_inflector_1 = __importDefault(require("graphile-simple-inflector"));
-const graphile_plugin_connection_filter_1 = __importDefault(require("graphile-plugin-connection-filter"));
-const graphile_plugin_connection_filter_postgis_1 = __importDefault(require("graphile-plugin-connection-filter-postgis"));
-const graphile_pg_type_mappings_1 = __importDefault(require("graphile-pg-type-mappings"));
-const graphile_upload_plugin_1 = __importStar(require("graphile-upload-plugin"));
-const getGraphileSettings = (rawOpts) => {
-    const opts = (0, graphql_env_1.getEnvOptions)(rawOpts);
-    const { server, graphile, features, cdn } = opts;
-    // Instantiate uploader with merged cdn opts
-    const uploader = new graphile_upload_plugin_1.Uploader({
-        bucketName: cdn.bucketName,
-        awsRegion: cdn.awsRegion,
-        awsAccessKey: cdn.awsAccessKey,
-        awsSecretKey: cdn.awsSecretKey,
-        minioEndpoint: cdn.minioEndpoint,
-        provider: cdn.provider,
-    });
-    const resolveUpload = uploader.resolveUpload.bind(uploader);
-    const plugins = [
-        graphile_plugin_connection_filter_1.default,
-        graphile_plugin_fulltext_filter_1.default,
-        graphile_pg_type_mappings_1.default,
-        graphile_upload_plugin_1.default,
-        graphile_meta_schema_1.default,
-        pg_many_to_many_1.default,
-        graphile_search_plugin_1.default,
-    ];
-    if (features?.postgis) {
-        plugins.push(graphile_postgis_1.default, graphile_plugin_connection_filter_postgis_1.default);
-    }
-    if (features?.simpleInflection) {
-        plugins.push(graphile_simple_inflector_1.default);
-    }
-    plugins.push(graphile_i18n_1.LangPlugin);
-    return {
-        graphileBuildOptions: {
-            uploadFieldDefinitions: [
-                {
-                    name: 'upload',
-                    namespaceName: 'public',
-                    type: 'JSON',
-                    resolve: resolveUpload,
-                },
-                {
-                    name: 'attachment',
-                    namespaceName: 'public',
-                    type: 'String',
-                    resolve: resolveUpload,
-                },
-                {
-                    name: 'image',
-                    namespaceName: 'public',
-                    type: 'JSON',
-                    resolve: resolveUpload,
-                },
-                {
-                    tag: 'upload',
-                    resolve: resolveUpload,
-                },
-            ],
-            pgSimplifyOppositeBaseNames: features?.oppositeBaseNames,
-            connectionFilterComputedColumns: false,
-        },
-        appendPlugins: plugins,
-        skipPlugins: [graphile_build_1.NodePlugin],
-        dynamicJson: true,
-        disableGraphiql: false,
-        enhanceGraphiql: true,
-        enableQueryBatching: true,
-        graphiql: true,
-        watch: false,
-        port: server?.port,
-        host: server?.host,
-        schema: graphile?.schema,
-        ignoreRBAC: false,
-        legacyRelations: 'omit',
-        showErrorStack: false,
-        // @ts-ignore
-        extendedErrors: false,
-        disableQueryLog: false,
-        includeExtensionResources: true,
-        setofFunctionsContainNulls: false,
-        retryOnInitFail: async (_error) => {
-            return false;
-        },
-        additionalGraphQLContextFromRequest: async (req, res) => {
-            const langContext = await (0, graphile_i18n_1.additionalGraphQLContextFromRequest)(req, res);
-            return {
-                ...langContext,
-                req,
-                res,
-            };
-        },
-    };
-};
-exports.getGraphileSettings = getGraphileSettings;
+exports.makePgService = exports.MinimalPreset = exports.ConstructivePreset = void 0;
+const pg_1 = require("postgraphile/adaptors/pg");
+Object.defineProperty(exports, "makePgService", { enumerable: true, get: function () { return pg_1.makePgService; } });
+// Import modules for type augmentation
+// These add properties to the GraphileConfig.Preset interface:
+// - grafserv: adds 'grafserv' property
+// - graphile-build: adds 'schema' property (typed as GraphileBuild.SchemaOptions)
+// - postgraphile-plugin-connection-filter: augments SchemaOptions with connectionFilter* options
+require("postgraphile/grafserv");
+require("graphile-build");
+// ============================================================================
+// Re-export all plugins and presets
+// ============================================================================
+// Main preset
+var constructive_preset_1 = require("./presets/constructive-preset");
+Object.defineProperty(exports, "ConstructivePreset", { enumerable: true, get: function () { return constructive_preset_1.ConstructivePreset; } });
+// Re-export all plugins for convenience
+__exportStar(require("./plugins/index"), exports);
+// Re-export presets
+__exportStar(require("./presets/index"), exports);
+// ============================================================================
+// Utilities
+// ============================================================================
+// Import the new MinimalPreset from plugins
+const minimal_preset_1 = require("./plugins/minimal-preset");
+Object.defineProperty(exports, "MinimalPreset", { enumerable: true, get: function () { return minimal_preset_1.MinimalPreset; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-settings",
-  "version": "3.1.1",
+  "version": "4.0.0",
   "author": "Constructive <developers@constructive.io>",
   "description": "graphile settings",
   "main": "index.js",
@@ -29,30 +29,24 @@
     "test:watch": "jest --watch"
   },
   "dependencies": {
-    "@constructive-io/graphql-env": "^2.10.0",
-    "@constructive-io/graphql-types": "^2.15.0",
-    "@graphile-contrib/pg-many-to-many": "^1.0.2",
+    "@constructive-io/graphql-env": "^3.0.0",
+    "@constructive-io/graphql-types": "^3.0.0",
+    "@graphile-contrib/pg-many-to-many": "2.0.0-rc.1",
     "@pgpmjs/types": "^2.16.0",
     "cors": "^2.8.5",
     "express": "^5.2.1",
-    "graphile-build": "^4.14.1",
-    "graphile-i18n": "^1.1.1",
-    "graphile-meta-schema": "^1.1.1",
-    "graphile-pg-type-mappings": "^1.1.1",
-    "graphile-plugin-connection-filter": "^3.1.1",
-    "graphile-plugin-connection-filter-postgis": "^2.1.1",
-    "graphile-plugin-fulltext-filter": "^3.1.1",
-    "graphile-postgis": "^1.1.1",
-    "graphile-query": "^2.6.0",
-    "graphile-search-plugin": "^1.1.1",
-    "graphile-simple-inflector": "^1.1.1",
-    "graphile-upload-plugin": "^1.1.1",
-    "graphql": "15.10.1",
-    "graphql-tag": "2.12.6",
-    "graphql-upload": "^13.0.0",
+    "grafast": "^1.0.0-rc.4",
+    "graphile-build": "^5.0.0-rc.3",
+    "graphile-build-pg": "^5.0.0-rc.3",
+    "graphile-config": "1.0.0-rc.3",
+    "graphile-search-plugin": "^3.0.0",
+    "graphql": "^16.9.0",
+    "inflekt": "^0.3.0",
     "lru-cache": "^11.2.4",
     "pg": "^8.17.1",
-    "postgraphile": "^4.14.1",
+    "pg-sql2": "^5.0.0-rc.3",
+    "postgraphile": "^5.0.0-rc.4",
+    "postgraphile-plugin-connection-filter": "^3.0.0-rc.1",
     "request-ip": "^3.3.0"
   },
   "devDependencies": {
@@ -60,7 +54,7 @@
     "@types/express": "^5.0.6",
     "@types/pg": "^8.16.0",
     "@types/request-ip": "^0.0.41",
-    "makage": "^0.1.12",
+    "makage": "^0.1.10",
     "nodemon": "^3.1.10",
     "ts-node": "^10.9.2"
   },
@@ -71,5 +65,5 @@
     "constructive",
     "graphql"
   ],
-  "gitHead": "49049ad3ddd762d35625f657cb42fa0862b829a0"
+  "gitHead": "b2daeefe49cdefb3d01ea63cf778fb9b847ab5fe"
 }

package/plugins/conflict-detector.d.ts

@@ -0,0 +1,7 @@
+import type { GraphileConfig } from 'graphile-config';
+export declare const ConflictDetectorPlugin: GraphileConfig.Plugin;
+/**
+ * Preset that includes the conflict detector plugin.
+ */
+export declare const ConflictDetectorPreset: GraphileConfig.Preset;
+export default ConflictDetectorPlugin;

package/plugins/conflict-detector.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConflictDetectorPreset = exports.ConflictDetectorPlugin = void 0;
+exports.ConflictDetectorPlugin = {
+    name: 'ConflictDetectorPlugin',
+    version: '1.0.0',
+    schema: {
+        hooks: {
+            build(build) {
+                // Track codecs by their GraphQL name to detect conflicts
+                const codecsByName = new Map();
+                // Iterate through all codecs to find tables
+                for (const codec of Object.values(build.input.pgRegistry.pgCodecs)) {
+                    // Skip non-table codecs (those without attributes or anonymous ones)
+                    if (!codec.attributes || codec.isAnonymous)
+                        continue;
+                    // Get the schema name from the codec's extensions
+                    const pgExtensions = codec.extensions?.pg;
+                    const schemaName = pgExtensions?.schemaName || 'unknown';
+                    const tableName = codec.name;
+                    // Get the GraphQL name that would be generated
+                    const graphqlName = build.inflection.tableType(codec);
+                    const info = {
+                        name: graphqlName,
+                        schemaName,
+                        tableName,
+                    };
+                    if (!codecsByName.has(graphqlName)) {
+                        codecsByName.set(graphqlName, []);
+                    }
+                    codecsByName.get(graphqlName).push(info);
+                }
+                // Check for conflicts and log warnings
+                for (const [graphqlName, codecs] of codecsByName) {
+                    if (codecs.length > 1) {
+                        const locations = codecs
+                            .map((c) => `${c.schemaName}.${c.tableName}`)
+                            .join(', ');
+                        console.warn(`\nNAMING CONFLICT DETECTED: GraphQL type "${graphqlName}" would be generated from multiple tables:\n` +
+                            `   Tables: ${locations}\n` +
+                            `   Resolution options:\n` +
+                            `   1. Add @name smart tag to one table: COMMENT ON TABLE schema.table IS E'@name UniqueTypeName';\n` +
+                            `   2. Rename one of the tables in the database\n` +
+                            `   3. Exclude one table from the schema using @omit smart tag\n`);
+                    }
+                }
+                return build;
+            },
+        },
+    },
+};
+/**
+ * Preset that includes the conflict detector plugin.
+ */
+exports.ConflictDetectorPreset = {
+    plugins: [exports.ConflictDetectorPlugin],
+};
+exports.default = exports.ConflictDetectorPlugin;

package/plugins/custom-inflector.d.ts

@@ -0,0 +1,9 @@
+import type { GraphileConfig } from 'graphile-config';
+export declare const InflektPlugin: GraphileConfig.Plugin;
+/**
+ * Preset that includes the inflekt-based inflector plugin.
+ * Use this in your main preset's `extends` array.
+ */
+export declare const InflektPreset: GraphileConfig.Preset;
+export declare const CustomInflectorPlugin: GraphileConfig.Plugin;
+export declare const CustomInflectorPreset: GraphileConfig.Preset;