graphile-plugin-utils 1.0.1

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,139 @@
+# graphile-plugin-utils
+
+<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-plugin-utils"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=graphile%2Fgraphile-plugin-utils%2Fpackage.json"/></a>
+</p>
+
+
+Shared internals for Constructive's PostGraphile v5 plugins. This package holds
+the small cross-plugin helpers that would otherwise be duplicated across
+`graphile-connection-filter`, `graphile-search`, and `graphile-pg-aggregates`,
+so there is a single home for them and no plugin has to depend on a sibling
+feature plugin just to borrow a utility.
+
+## Installation
+
+```bash
+npm install graphile-plugin-utils
+```
+
+## API
+
+### `getQueryBuilder(build, $condition)`
+
+Walks from a `PgCondition` up to its `PgSelectQueryBuilder`, following Benjie's
+pattern from `postgraphile-plugin-fulltext-filter`. Satellite filter plugins
+(search, BM25, pgvector) use it from inside a filter's `apply` callback to
+inject `SELECT` expressions (for ranking/scoring) and `ORDER BY` clauses.
+
+```ts
+import { getQueryBuilder } from 'graphile-plugin-utils';
+
+const qb = getQueryBuilder(build, $condition);
+if (qb) {
+  qb.orderBy({ /* ... */ });
+}
+```
+
+Returns the query builder, or `null` when it cannot be resolved (e.g. the build
+does not expose `dataplanPg.PgCondition`).
+
+### `isComputedScalarAttributeResource(resource)`
+
+Type guard for a computed scalar attribute function — a `pgResource` that takes
+a table row as its first parameter, returns a scalar, and is unique. Used to
+recognise computed columns exposed as functions when building filters and
+aggregates.
+
+```ts
+import { isComputedScalarAttributeResource } from 'graphile-plugin-utils';
+
+const computed = Object.values(build.input.pgRegistry.pgResources).filter(
+  isComputedScalarAttributeResource
+);
+```
+
+## License
+
+MIT
+
+---
+
+## 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.
+
+### 📚 Documentation & Skills
+
+* [constructive-skills](https://github.com/constructive-io/constructive-skills): **📖 Platform documentation and AI agent skills** — feature catalog, blueprint reference, SDK guides (i18n, billing, limits, events, uploads, security, entities, search, AI), and deployment guides.
+
+Install skills for AI coding agents:
+
+```bash
+# All platform skills (security, blueprints, codegen, billing, etc.)
+npx skills add constructive-io/constructive-skills
+
+# Individual repo skills (pgpm, testing, CLI, search, etc.)
+npx skills add https://github.com/constructive-io/constructive --skill pgpm
+npx skills add https://github.com/constructive-io/constructive --skill constructive-testing
+```
+
+## 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/__tests__/pg-resources.test.d.ts

@@ -0,0 +1 @@
+export {};

package/__tests__/pg-resources.test.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const pg_resources_1 = require("../pg-resources");
+const tableCodec = { attributes: { id: {} } };
+const scalarCodec = {};
+function resource(overrides) {
+    return {
+        isUnique: true,
+        codec: scalarCodec,
+        parameters: [{ codec: tableCodec }],
+        ...overrides
+    };
+}
+describe('isComputedScalarAttributeResource', () => {
+    it('accepts a unique scalar function taking a table row', () => {
+        expect((0, pg_resources_1.isComputedScalarAttributeResource)(resource({}))).toBe(true);
+    });
+    it('rejects a resource without parameters', () => {
+        expect((0, pg_resources_1.isComputedScalarAttributeResource)(resource({ parameters: [] }))).toBe(false);
+    });
+    it('rejects a table-returning resource (codec has attributes)', () => {
+        expect((0, pg_resources_1.isComputedScalarAttributeResource)(resource({ codec: tableCodec }))).toBe(false);
+    });
+    it('rejects a non-unique resource', () => {
+        expect((0, pg_resources_1.isComputedScalarAttributeResource)(resource({ isUnique: false }))).toBe(false);
+    });
+    it('rejects when the first parameter is not a table row', () => {
+        expect((0, pg_resources_1.isComputedScalarAttributeResource)(resource({ parameters: [{ codec: scalarCodec }] }))).toBe(false);
+    });
+});

package/esm/__tests__/pg-resources.test.js

@@ -0,0 +1,28 @@
+import { isComputedScalarAttributeResource } from '../pg-resources';
+const tableCodec = { attributes: { id: {} } };
+const scalarCodec = {};
+function resource(overrides) {
+    return {
+        isUnique: true,
+        codec: scalarCodec,
+        parameters: [{ codec: tableCodec }],
+        ...overrides
+    };
+}
+describe('isComputedScalarAttributeResource', () => {
+    it('accepts a unique scalar function taking a table row', () => {
+        expect(isComputedScalarAttributeResource(resource({}))).toBe(true);
+    });
+    it('rejects a resource without parameters', () => {
+        expect(isComputedScalarAttributeResource(resource({ parameters: [] }))).toBe(false);
+    });
+    it('rejects a table-returning resource (codec has attributes)', () => {
+        expect(isComputedScalarAttributeResource(resource({ codec: tableCodec }))).toBe(false);
+    });
+    it('rejects a non-unique resource', () => {
+        expect(isComputedScalarAttributeResource(resource({ isUnique: false }))).toBe(false);
+    });
+    it('rejects when the first parameter is not a table row', () => {
+        expect(isComputedScalarAttributeResource(resource({ parameters: [{ codec: scalarCodec }] }))).toBe(false);
+    });
+});

package/esm/index.js

@@ -0,0 +1,5 @@
+// Shared internals for Constructive PostGraphile v5 plugins.
+// PgCondition → PgSelectQueryBuilder walker (search / BM25 / pgvector)
+export { getQueryBuilder } from './query-builder';
+// pg-resource introspection helpers (connection-filter / pg-aggregates)
+export { isComputedScalarAttributeResource } from './pg-resources';

package/esm/pg-resources.js

@@ -0,0 +1,27 @@
+/**
+ * Whether a pgResource is a computed scalar attribute function, i.e. one that:
+ * - takes at least one parameter,
+ * - returns a scalar (its codec has no attributes),
+ * - is unique (returns a single row),
+ * - and takes a table row as its first parameter (that parameter's codec has
+ *   attributes).
+ *
+ * Shared by the connection-filter and pg-aggregates plugins, which both need
+ * to recognise computed columns exposed as functions.
+ */
+export function isComputedScalarAttributeResource(s) {
+    if (!s.parameters || s.parameters.length < 1) {
+        return false;
+    }
+    if (s.codec.attributes) {
+        return false;
+    }
+    if (!s.isUnique) {
+        return false;
+    }
+    const firstParameter = s.parameters[0];
+    if (!firstParameter?.codec.attributes) {
+        return false;
+    }
+    return true;
+}

package/esm/query-builder.js

@@ -0,0 +1,36 @@
+/**
+ * Walks from a PgCondition up to the PgSelectQueryBuilder.
+ * Uses the `.parent` property on PgCondition to traverse up the chain,
+ * following Benjie's pattern from postgraphile-plugin-fulltext-filter.
+ *
+ * This is used by satellite plugins (search, BM25, pgvector) that need to
+ * access the query builder from within a filter's apply callback to inject
+ * SELECT expressions (for ranking/scoring) and ORDER BY clauses.
+ *
+ * @param build - The Graphile Build object (needs build.dataplanPg.PgCondition)
+ * @param $condition - The PgCondition instance from the filter apply callback
+ * @returns The PgSelectQueryBuilder if found, or null
+ */
+export function getQueryBuilder(build, $condition) {
+    const PgCondition = build.dataplanPg?.PgCondition;
+    if (!PgCondition)
+        return null;
+    let current = $condition;
+    const { alias } = current;
+    // Walk up through nested PgConditions (e.g. and/or/not)
+    // Note: PgCondition.parent is protected, so we use bracket notation
+    // to access it from outside the class hierarchy.
+    while (current &&
+        current instanceof PgCondition &&
+        current.alias === alias) {
+        current = current['parent'];
+    }
+    // Verify we found a query builder with matching alias
+    // Using duck-typing per Benjie's pattern
+    if (current &&
+        typeof current.selectAndReturnIndex === 'function' &&
+        current.alias === alias) {
+        return current;
+    }
+    return null;
+}

package/index.d.ts

@@ -0,0 +1,2 @@
+export { getQueryBuilder } from './query-builder';
+export { isComputedScalarAttributeResource } from './pg-resources';

package/index.js

@@ -0,0 +1,10 @@
+"use strict";
+// Shared internals for Constructive PostGraphile v5 plugins.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isComputedScalarAttributeResource = exports.getQueryBuilder = void 0;
+// PgCondition → PgSelectQueryBuilder walker (search / BM25 / pgvector)
+var query_builder_1 = require("./query-builder");
+Object.defineProperty(exports, "getQueryBuilder", { enumerable: true, get: function () { return query_builder_1.getQueryBuilder; } });
+// pg-resource introspection helpers (connection-filter / pg-aggregates)
+var pg_resources_1 = require("./pg-resources");
+Object.defineProperty(exports, "isComputedScalarAttributeResource", { enumerable: true, get: function () { return pg_resources_1.isComputedScalarAttributeResource; } });

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "graphile-plugin-utils",
+  "version": "1.0.1",
+  "description": "Shared internals for Constructive PostGraphile v5 plugins - PgCondition query-builder walker and pg-resource introspection helpers",
+  "author": "Constructive <developers@constructive.io>",
+  "homepage": "https://github.com/constructive-io/constructive",
+  "license": "MIT",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "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"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/constructive-io/constructive"
+  },
+  "keywords": [
+    "postgraphile",
+    "graphile",
+    "constructive",
+    "plugin",
+    "postgres",
+    "graphql",
+    "utils",
+    "v5"
+  ],
+  "bugs": {
+    "url": "https://github.com/constructive-io/constructive/issues"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.11",
+    "makage": "^0.3.0"
+  },
+  "peerDependencies": {
+    "@dataplan/pg": "1.0.3",
+    "graphile-build": "5.0.2",
+    "graphile-build-pg": "5.0.2",
+    "graphile-config": "1.0.1",
+    "graphql": "16.13.0",
+    "pg-sql2": "5.0.1",
+    "postgraphile": "5.0.3"
+  },
+  "gitHead": "cd21f62bb64bdc7f4f40f6cef6af73f8f1c8f8dc"
+}

package/pg-resources.d.ts

@@ -0,0 +1,13 @@
+import type { PgCodec, PgRegistry, PgResource, PgResourceParameter } from '@dataplan/pg';
+/**
+ * Whether a pgResource is a computed scalar attribute function, i.e. one that:
+ * - takes at least one parameter,
+ * - returns a scalar (its codec has no attributes),
+ * - is unique (returns a single row),
+ * - and takes a table row as its first parameter (that parameter's codec has
+ *   attributes).
+ *
+ * Shared by the connection-filter and pg-aggregates plugins, which both need
+ * to recognise computed columns exposed as functions.
+ */
+export declare function isComputedScalarAttributeResource(s: PgResource<any, any, any, any, any>): s is PgResource<string, PgCodec, never[], PgResourceParameter[], PgRegistry>;

package/pg-resources.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isComputedScalarAttributeResource = isComputedScalarAttributeResource;
+/**
+ * Whether a pgResource is a computed scalar attribute function, i.e. one that:
+ * - takes at least one parameter,
+ * - returns a scalar (its codec has no attributes),
+ * - is unique (returns a single row),
+ * - and takes a table row as its first parameter (that parameter's codec has
+ *   attributes).
+ *
+ * Shared by the connection-filter and pg-aggregates plugins, which both need
+ * to recognise computed columns exposed as functions.
+ */
+function isComputedScalarAttributeResource(s) {
+    if (!s.parameters || s.parameters.length < 1) {
+        return false;
+    }
+    if (s.codec.attributes) {
+        return false;
+    }
+    if (!s.isUnique) {
+        return false;
+    }
+    const firstParameter = s.parameters[0];
+    if (!firstParameter?.codec.attributes) {
+        return false;
+    }
+    return true;
+}

package/query-builder.d.ts

@@ -0,0 +1,15 @@
+import type { GraphileBuild } from 'graphile-build';
+/**
+ * Walks from a PgCondition up to the PgSelectQueryBuilder.
+ * Uses the `.parent` property on PgCondition to traverse up the chain,
+ * following Benjie's pattern from postgraphile-plugin-fulltext-filter.
+ *
+ * This is used by satellite plugins (search, BM25, pgvector) that need to
+ * access the query builder from within a filter's apply callback to inject
+ * SELECT expressions (for ranking/scoring) and ORDER BY clauses.
+ *
+ * @param build - The Graphile Build object (needs build.dataplanPg.PgCondition)
+ * @param $condition - The PgCondition instance from the filter apply callback
+ * @returns The PgSelectQueryBuilder if found, or null
+ */
+export declare function getQueryBuilder(build: GraphileBuild.Build, $condition: any): any | null;

package/query-builder.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getQueryBuilder = getQueryBuilder;
+/**
+ * Walks from a PgCondition up to the PgSelectQueryBuilder.
+ * Uses the `.parent` property on PgCondition to traverse up the chain,
+ * following Benjie's pattern from postgraphile-plugin-fulltext-filter.
+ *
+ * This is used by satellite plugins (search, BM25, pgvector) that need to
+ * access the query builder from within a filter's apply callback to inject
+ * SELECT expressions (for ranking/scoring) and ORDER BY clauses.
+ *
+ * @param build - The Graphile Build object (needs build.dataplanPg.PgCondition)
+ * @param $condition - The PgCondition instance from the filter apply callback
+ * @returns The PgSelectQueryBuilder if found, or null
+ */
+function getQueryBuilder(build, $condition) {
+    const PgCondition = build.dataplanPg?.PgCondition;
+    if (!PgCondition)
+        return null;
+    let current = $condition;
+    const { alias } = current;
+    // Walk up through nested PgConditions (e.g. and/or/not)
+    // Note: PgCondition.parent is protected, so we use bracket notation
+    // to access it from outside the class hierarchy.
+    while (current &&
+        current instanceof PgCondition &&
+        current.alias === alias) {
+        current = current['parent'];
+    }
+    // Verify we found a query builder with matching alias
+    // Using duck-typing per Benjie's pattern
+    if (current &&
+        typeof current.selectAndReturnIndex === 'function' &&
+        current.alias === alias) {
+        return current;
+    }
+    return null;
+}