graphile-connection-filter 1.4.1 → 1.5.1

package/esm/index.d.ts

@@ -48,6 +48,7 @@
  * }
  * ```
  */
+import './augmentations';
 export { ConnectionFilterPreset } from './preset';
 export { ConnectionFilterInflectionPlugin, ConnectionFilterTypesPlugin, ConnectionFilterArgPlugin, ConnectionFilterAttributesPlugin, ConnectionFilterOperatorsPlugin, ConnectionFilterCustomOperatorsPlugin, ConnectionFilterLogicalOperatorsPlugin, ConnectionFilterComputedAttributesPlugin, ConnectionFilterForwardRelationsPlugin, ConnectionFilterBackwardRelationsPlugin, makeApplyFromOperatorSpec, } from './plugins';
 export type { ConnectionFilterOperatorSpec, ConnectionFilterOperatorRegistration, ConnectionFilterOperatorFactory, ConnectionFilterOptions, ConnectionFilterOperatorsDigest, PgConnectionFilterOperatorsScope, } from './types';

package/esm/index.js

@@ -48,6 +48,12 @@
  * }
  * ```
  */
+// Load the global type augmentations (inflection methods, build/scope
+// properties) so that downstream satellite plugins which `import
+// 'graphile-connection-filter'` pick up the `filterType`/`filterManyType`/
+// etc. type extensions without having to reach into the package's internal
+// file layout.
+import './augmentations';
 export { ConnectionFilterPreset } from './preset';
 // Re-export all plugins for granular use
 export { ConnectionFilterInflectionPlugin, ConnectionFilterTypesPlugin, ConnectionFilterArgPlugin, ConnectionFilterAttributesPlugin, ConnectionFilterOperatorsPlugin, ConnectionFilterCustomOperatorsPlugin, ConnectionFilterLogicalOperatorsPlugin, ConnectionFilterComputedAttributesPlugin, ConnectionFilterForwardRelationsPlugin, ConnectionFilterBackwardRelationsPlugin, makeApplyFromOperatorSpec, } from './plugins';

package/esm/plugins/ConnectionFilterArgPlugin.d.ts

@@ -3,9 +3,10 @@ import type { GraphileConfig } from 'graphile-config';
 /**
  * ConnectionFilterArgPlugin
  *
- * Adds the filter argument (configurable name, default 'where') to connection
- * and simple collection fields. Uses `applyPlan` to create a PgCondition that
- * child filter fields can add WHERE clauses to.
+ * Adds the `where` argument (name configurable via
+ * `connectionFilterArgumentName`, default `'where'`) to connection and
+ * simple collection fields. Uses `applyPlan` to create a PgCondition
+ * that child filter fields can add WHERE clauses to.
  *
  * This runs before PgConnectionArgOrderByPlugin so that filters are applied
  * before ordering (important for e.g. full-text search rank ordering).

package/esm/plugins/ConnectionFilterArgPlugin.js

@@ -4,9 +4,10 @@ const version = '1.0.0';
 /**
  * ConnectionFilterArgPlugin
  *
- * Adds the filter argument (configurable name, default 'where') to connection
- * and simple collection fields. Uses `applyPlan` to create a PgCondition that
- * child filter fields can add WHERE clauses to.
+ * Adds the `where` argument (name configurable via
+ * `connectionFilterArgumentName`, default `'where'`) to connection and
+ * simple collection fields. Uses `applyPlan` to create a PgCondition
+ * that child filter fields can add WHERE clauses to.
  *
  * This runs before PgConnectionArgOrderByPlugin so that filters are applied
  * before ordering (important for e.g. full-text search rank ordering).
@@ -14,7 +15,7 @@ const version = '1.0.0';
 export const ConnectionFilterArgPlugin = {
     name: 'ConnectionFilterArgPlugin',
     version,
-    description: 'Adds the filter argument to connection and list fields',
+    description: 'Adds the `where` argument to connection and list fields',
     before: ['PgConnectionArgOrderByPlugin'],
     schema: {
         hooks: {
@@ -59,7 +60,7 @@ export const ConnectionFilterArgPlugin = {
                                 applyPlan: EXPORTABLE((PgCondition, isEmpty, attributeCodec) => function (_, $connection, fieldArg) {
                                     const $pgSelect = $connection.getSubplan();
                                     fieldArg.apply($pgSelect, (queryBuilder, value) => {
-                                        // If filter is null/undefined or empty {}, treat as "no filter" — skip
+                                        // If where is null/undefined or empty {}, treat as "no filter" — skip
                                         if (value == null || isEmpty(value))
                                             return;
                                         const condition = new PgCondition(queryBuilder);
@@ -75,7 +76,7 @@ export const ConnectionFilterArgPlugin = {
                             : {
                                 applyPlan: EXPORTABLE((PgCondition, isEmpty, attributeCodec) => function (_, $pgSelect, fieldArg) {
                                     fieldArg.apply($pgSelect, (queryBuilder, value) => {
-                                        // If filter is null/undefined or empty {}, treat as "no filter" — skip
+                                        // If where is null/undefined or empty {}, treat as "no filter" — skip
                                         if (value == null || isEmpty(value))
                                             return;
                                         const condition = new PgCondition(queryBuilder);
@@ -89,7 +90,7 @@ export const ConnectionFilterArgPlugin = {
                                 }, [PgCondition, isEmpty, attributeCodec]),
                             }),
                     },
-                }, `Adding connection filter '${argName}' arg to field '${fieldName}' of '${Self.name}'`);
+                }, `Adding connection where arg '${argName}' to field '${fieldName}' of '${Self.name}'`);
             },
         },
     },

package/esm/plugins/ConnectionFilterAttributesPlugin.js

@@ -54,11 +54,11 @@ export const ConnectionFilterAttributesPlugin = {
                                     return;
                                 }
                                 if (isEmpty(value)) {
-                                    throw Object.assign(new Error('Empty objects are forbidden in filter argument input.'), {});
+                                    throw Object.assign(new Error('Empty objects are forbidden in where argument input.'), {});
                                 }
                                 if (!connectionFilterAllowNullInput &&
                                     value === null) {
-                                    throw Object.assign(new Error('Null literals are forbidden in filter argument input.'), {});
+                                    throw Object.assign(new Error('Null literals are forbidden in where argument input.'), {});
                                 }
                                 const condition = new PgCondition(queryBuilder);
                                 condition.extensions.pgFilterAttribute = colSpec;

package/esm/plugins/ConnectionFilterBackwardRelationsPlugin.d.ts

@@ -8,7 +8,7 @@ import type { GraphileConfig } from 'graphile-config';
  *
  * For unique backward relations (one-to-one), a single filter field is added:
  * ```graphql
- * allClients(filter: {
+ * allClients(where: {
  *   profileByClientId: { bio: { includes: "engineer" } }
  * }) { ... }
  * ```
@@ -16,7 +16,7 @@ import type { GraphileConfig } from 'graphile-config';
  * For non-unique backward relations (one-to-many), a "many" filter type is added
  * with `some`, `every`, and `none` sub-fields:
  * ```graphql
- * allClients(filter: {
+ * allClients(where: {
  *   ordersByClientId: { some: { total: { greaterThan: 1000 } } }
  * }) { ... }
  * ```

package/esm/plugins/ConnectionFilterBackwardRelationsPlugin.js

@@ -9,7 +9,7 @@ const version = '1.0.0';
  *
  * For unique backward relations (one-to-one), a single filter field is added:
  * ```graphql
- * allClients(filter: {
+ * allClients(where: {
  *   profileByClientId: { bio: { includes: "engineer" } }
  * }) { ... }
  * ```
@@ -17,7 +17,7 @@ const version = '1.0.0';
  * For non-unique backward relations (one-to-many), a "many" filter type is added
  * with `some`, `every`, and `none` sub-fields:
  * ```graphql
- * allClients(filter: {
+ * allClients(where: {
  *   ordersByClientId: { some: { total: { greaterThan: 1000 } } }
  * }) { ... }
  * ```

package/esm/plugins/ConnectionFilterComputedAttributesPlugin.d.ts

@@ -11,7 +11,7 @@ import type { GraphileConfig } from 'graphile-config';
  *
  * This plugin adds a `fullName` filter field to `PersonFilter`, typed as `StringFilter`,
  * allowing queries like:
- *   { people(filter: { fullName: { startsWith: "John" } }) { ... } }
+ *   { people(where: { fullName: { startsWith: "John" } }) { ... } }
  *
  * Controlled by the `connectionFilterComputedColumns` schema option (default: true).
  * Requires the `filterBy` behavior on the pgResource to be enabled.

package/esm/plugins/ConnectionFilterComputedAttributesPlugin.js

@@ -12,7 +12,7 @@ const version = '1.0.0';
  *
  * This plugin adds a `fullName` filter field to `PersonFilter`, typed as `StringFilter`,
  * allowing queries like:
- *   { people(filter: { fullName: { startsWith: "John" } }) { ... } }
+ *   { people(where: { fullName: { startsWith: "John" } }) { ... } }
  *
  * Controlled by the `connectionFilterComputedColumns` schema option (default: true).
  * Requires the `filterBy` behavior on the pgResource to be enabled.

package/esm/plugins/ConnectionFilterForwardRelationsPlugin.d.ts

@@ -11,7 +11,7 @@ import type { GraphileConfig } from 'graphile-config';
  * allowing queries like:
  *
  * ```graphql
- * allOrders(filter: {
+ * allOrders(where: {
  *   clientByClientId: { name: { startsWith: "Acme" } }
  * }) { ... }
  * ```

package/esm/plugins/ConnectionFilterForwardRelationsPlugin.js

@@ -12,7 +12,7 @@ const version = '1.0.0';
  * allowing queries like:
  *
  * ```graphql
- * allOrders(filter: {
+ * allOrders(where: {
  *   clientByClientId: { name: { startsWith: "Acme" } }
  * }) { ... }
  * ```

package/esm/plugins/operatorApply.js

@@ -38,7 +38,7 @@ export function makeApplyFromOperatorSpec(build, _typeName, fieldName, spec, _ty
             return;
         }
         if (!connectionFilterAllowNullInput && value === null) {
-            throw Object.assign(new Error('Null literals are forbidden in filter argument input.'), {});
+            throw Object.assign(new Error('Null literals are forbidden in where argument input.'), {});
         }
         // Optionally transform the input value
         const resolvedInput = resolveInput ? resolveInput(value) : value;

package/esm/utils.js

@@ -88,9 +88,9 @@ export function makeAssertAllowed(build) {
     const { options, EXPORTABLE } = build;
     const { connectionFilterAllowNullInput, } = options;
     const assertAllowed = EXPORTABLE((connectionFilterAllowNullInput, isEmpty) => function (value, mode) {
-        // Reject empty objects in nested filter contexts (and/or/not, relation filters)
+        // Reject empty objects in nested where contexts (and/or/not, relation filters)
         if (mode === 'object' && isEmpty(value)) {
-            throw Object.assign(new Error('Empty objects are forbidden in filter argument input.'), {});
+            throw Object.assign(new Error('Empty objects are forbidden in where argument input.'), {});
         }
         if (mode === 'list') {
             const arr = value;
@@ -98,14 +98,14 @@ export function makeAssertAllowed(build) {
                 const l = arr.length;
                 for (let i = 0; i < l; i++) {
                     if (isEmpty(arr[i])) {
-                        throw Object.assign(new Error('Empty objects are forbidden in filter argument input.'), {});
+                        throw Object.assign(new Error('Empty objects are forbidden in where argument input.'), {});
                     }
                 }
             }
         }
         // For all modes, check null
         if (!connectionFilterAllowNullInput && value === null) {
-            throw Object.assign(new Error('Null literals are forbidden in filter argument input.'), {});
+            throw Object.assign(new Error('Null literals are forbidden in where argument input.'), {});
         }
     }, [connectionFilterAllowNullInput, isEmpty]);
     return assertAllowed;

package/index.d.ts

@@ -48,6 +48,7 @@
  * }
  * ```
  */
+import './augmentations';
 export { ConnectionFilterPreset } from './preset';
 export { ConnectionFilterInflectionPlugin, ConnectionFilterTypesPlugin, ConnectionFilterArgPlugin, ConnectionFilterAttributesPlugin, ConnectionFilterOperatorsPlugin, ConnectionFilterCustomOperatorsPlugin, ConnectionFilterLogicalOperatorsPlugin, ConnectionFilterComputedAttributesPlugin, ConnectionFilterForwardRelationsPlugin, ConnectionFilterBackwardRelationsPlugin, makeApplyFromOperatorSpec, } from './plugins';
 export type { ConnectionFilterOperatorSpec, ConnectionFilterOperatorRegistration, ConnectionFilterOperatorFactory, ConnectionFilterOptions, ConnectionFilterOperatorsDigest, PgConnectionFilterOperatorsScope, } from './types';

package/index.js

@@ -51,6 +51,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getComputedAttributeResources = exports.isComputedScalarAttributeResource = exports.getQueryBuilder = exports.makeAssertAllowed = exports.isEmpty = exports.$$filters = exports.makeApplyFromOperatorSpec = exports.ConnectionFilterBackwardRelationsPlugin = exports.ConnectionFilterForwardRelationsPlugin = exports.ConnectionFilterComputedAttributesPlugin = exports.ConnectionFilterLogicalOperatorsPlugin = exports.ConnectionFilterCustomOperatorsPlugin = exports.ConnectionFilterOperatorsPlugin = exports.ConnectionFilterAttributesPlugin = exports.ConnectionFilterArgPlugin = exports.ConnectionFilterTypesPlugin = exports.ConnectionFilterInflectionPlugin = exports.ConnectionFilterPreset = void 0;
+// Load the global type augmentations (inflection methods, build/scope
+// properties) so that downstream satellite plugins which `import
+// 'graphile-connection-filter'` pick up the `filterType`/`filterManyType`/
+// etc. type extensions without having to reach into the package's internal
+// file layout.
+require("./augmentations");
 var preset_1 = require("./preset");
 Object.defineProperty(exports, "ConnectionFilterPreset", { enumerable: true, get: function () { return preset_1.ConnectionFilterPreset; } });
 // Re-export all plugins for granular use

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-connection-filter",
-  "version": "1.4.1",
+  "version": "1.5.1",
   "description": "PostGraphile v5 native connection filter plugin - adds advanced filtering to connections",
   "author": "Constructive <developers@constructive.io>",
   "homepage": "https://github.com/constructive-io/constructive",
@@ -41,9 +41,9 @@
   },
   "devDependencies": {
     "@types/node": "^22.19.11",
-    "graphile-test": "^4.8.1",
+    "graphile-test": "^4.9.0",
     "makage": "^0.3.0",
-    "pgsql-test": "^4.8.1"
+    "pgsql-test": "^4.9.0"
   },
   "peerDependencies": {
     "@dataplan/pg": "1.0.0",
@@ -54,5 +54,5 @@
     "pg-sql2": "5.0.0",
     "postgraphile": "5.0.0"
   },
-  "gitHead": "79cd3e66871804a22c672c7ca2fa5e2105d4b368"
+  "gitHead": "b421fce9f2ac3ce7cd276e5f724ded99db085066"
 }

package/plugins/ConnectionFilterArgPlugin.d.ts

@@ -3,9 +3,10 @@ import type { GraphileConfig } from 'graphile-config';
 /**
  * ConnectionFilterArgPlugin
  *
- * Adds the filter argument (configurable name, default 'where') to connection
- * and simple collection fields. Uses `applyPlan` to create a PgCondition that
- * child filter fields can add WHERE clauses to.
+ * Adds the `where` argument (name configurable via
+ * `connectionFilterArgumentName`, default `'where'`) to connection and
+ * simple collection fields. Uses `applyPlan` to create a PgCondition
+ * that child filter fields can add WHERE clauses to.
  *
  * This runs before PgConnectionArgOrderByPlugin so that filters are applied
  * before ordering (important for e.g. full-text search rank ordering).

package/plugins/ConnectionFilterArgPlugin.js

@@ -7,9 +7,10 @@ const version = '1.0.0';
 /**
  * ConnectionFilterArgPlugin
  *
- * Adds the filter argument (configurable name, default 'where') to connection
- * and simple collection fields. Uses `applyPlan` to create a PgCondition that
- * child filter fields can add WHERE clauses to.
+ * Adds the `where` argument (name configurable via
+ * `connectionFilterArgumentName`, default `'where'`) to connection and
+ * simple collection fields. Uses `applyPlan` to create a PgCondition
+ * that child filter fields can add WHERE clauses to.
  *
  * This runs before PgConnectionArgOrderByPlugin so that filters are applied
  * before ordering (important for e.g. full-text search rank ordering).
@@ -17,7 +18,7 @@ const version = '1.0.0';
 exports.ConnectionFilterArgPlugin = {
     name: 'ConnectionFilterArgPlugin',
     version,
-    description: 'Adds the filter argument to connection and list fields',
+    description: 'Adds the `where` argument to connection and list fields',
     before: ['PgConnectionArgOrderByPlugin'],
     schema: {
         hooks: {
@@ -62,7 +63,7 @@ exports.ConnectionFilterArgPlugin = {
                                 applyPlan: EXPORTABLE((PgCondition, isEmpty, attributeCodec) => function (_, $connection, fieldArg) {
                                     const $pgSelect = $connection.getSubplan();
                                     fieldArg.apply($pgSelect, (queryBuilder, value) => {
-                                        // If filter is null/undefined or empty {}, treat as "no filter" — skip
+                                        // If where is null/undefined or empty {}, treat as "no filter" — skip
                                         if (value == null || isEmpty(value))
                                             return;
                                         const condition = new PgCondition(queryBuilder);
@@ -78,7 +79,7 @@ exports.ConnectionFilterArgPlugin = {
                             : {
                                 applyPlan: EXPORTABLE((PgCondition, isEmpty, attributeCodec) => function (_, $pgSelect, fieldArg) {
                                     fieldArg.apply($pgSelect, (queryBuilder, value) => {
-                                        // If filter is null/undefined or empty {}, treat as "no filter" — skip
+                                        // If where is null/undefined or empty {}, treat as "no filter" — skip
                                         if (value == null || isEmpty(value))
                                             return;
                                         const condition = new PgCondition(queryBuilder);
@@ -92,7 +93,7 @@ exports.ConnectionFilterArgPlugin = {
                                 }, [PgCondition, utils_1.isEmpty, attributeCodec]),
                             }),
                     },
-                }, `Adding connection filter '${argName}' arg to field '${fieldName}' of '${Self.name}'`);
+                }, `Adding connection where arg '${argName}' to field '${fieldName}' of '${Self.name}'`);
             },
         },
     },

package/plugins/ConnectionFilterAttributesPlugin.js

@@ -57,11 +57,11 @@ exports.ConnectionFilterAttributesPlugin = {
                                     return;
                                 }
                                 if (isEmpty(value)) {
-                                    throw Object.assign(new Error('Empty objects are forbidden in filter argument input.'), {});
+                                    throw Object.assign(new Error('Empty objects are forbidden in where argument input.'), {});
                                 }
                                 if (!connectionFilterAllowNullInput &&
                                     value === null) {
-                                    throw Object.assign(new Error('Null literals are forbidden in filter argument input.'), {});
+                                    throw Object.assign(new Error('Null literals are forbidden in where argument input.'), {});
                                 }
                                 const condition = new PgCondition(queryBuilder);
                                 condition.extensions.pgFilterAttribute = colSpec;

package/plugins/ConnectionFilterBackwardRelationsPlugin.d.ts

@@ -8,7 +8,7 @@ import type { GraphileConfig } from 'graphile-config';
  *
  * For unique backward relations (one-to-one), a single filter field is added:
  * ```graphql
- * allClients(filter: {
+ * allClients(where: {
  *   profileByClientId: { bio: { includes: "engineer" } }
  * }) { ... }
  * ```
@@ -16,7 +16,7 @@ import type { GraphileConfig } from 'graphile-config';
  * For non-unique backward relations (one-to-many), a "many" filter type is added
  * with `some`, `every`, and `none` sub-fields:
  * ```graphql
- * allClients(filter: {
+ * allClients(where: {
  *   ordersByClientId: { some: { total: { greaterThan: 1000 } } }
  * }) { ... }
  * ```

package/plugins/ConnectionFilterBackwardRelationsPlugin.js

@@ -12,7 +12,7 @@ const version = '1.0.0';
  *
  * For unique backward relations (one-to-one), a single filter field is added:
  * ```graphql
- * allClients(filter: {
+ * allClients(where: {
  *   profileByClientId: { bio: { includes: "engineer" } }
  * }) { ... }
  * ```
@@ -20,7 +20,7 @@ const version = '1.0.0';
  * For non-unique backward relations (one-to-many), a "many" filter type is added
  * with `some`, `every`, and `none` sub-fields:
  * ```graphql
- * allClients(filter: {
+ * allClients(where: {
  *   ordersByClientId: { some: { total: { greaterThan: 1000 } } }
  * }) { ... }
  * ```

package/plugins/ConnectionFilterComputedAttributesPlugin.d.ts

@@ -11,7 +11,7 @@ import type { GraphileConfig } from 'graphile-config';
  *
  * This plugin adds a `fullName` filter field to `PersonFilter`, typed as `StringFilter`,
  * allowing queries like:
- *   { people(filter: { fullName: { startsWith: "John" } }) { ... } }
+ *   { people(where: { fullName: { startsWith: "John" } }) { ... } }
  *
  * Controlled by the `connectionFilterComputedColumns` schema option (default: true).
  * Requires the `filterBy` behavior on the pgResource to be enabled.

package/plugins/ConnectionFilterComputedAttributesPlugin.js

@@ -15,7 +15,7 @@ const version = '1.0.0';
  *
  * This plugin adds a `fullName` filter field to `PersonFilter`, typed as `StringFilter`,
  * allowing queries like:
- *   { people(filter: { fullName: { startsWith: "John" } }) { ... } }
+ *   { people(where: { fullName: { startsWith: "John" } }) { ... } }
  *
  * Controlled by the `connectionFilterComputedColumns` schema option (default: true).
  * Requires the `filterBy` behavior on the pgResource to be enabled.

package/plugins/ConnectionFilterForwardRelationsPlugin.d.ts

@@ -11,7 +11,7 @@ import type { GraphileConfig } from 'graphile-config';
  * allowing queries like:
  *
  * ```graphql
- * allOrders(filter: {
+ * allOrders(where: {
  *   clientByClientId: { name: { startsWith: "Acme" } }
  * }) { ... }
  * ```

package/plugins/ConnectionFilterForwardRelationsPlugin.js

@@ -15,7 +15,7 @@ const version = '1.0.0';
  * allowing queries like:
  *
  * ```graphql
- * allOrders(filter: {
+ * allOrders(where: {
  *   clientByClientId: { name: { startsWith: "Acme" } }
  * }) { ... }
  * ```

package/plugins/operatorApply.js

@@ -41,7 +41,7 @@ function makeApplyFromOperatorSpec(build, _typeName, fieldName, spec, _type) {
             return;
         }
         if (!connectionFilterAllowNullInput && value === null) {
-            throw Object.assign(new Error('Null literals are forbidden in filter argument input.'), {});
+            throw Object.assign(new Error('Null literals are forbidden in where argument input.'), {});
         }
         // Optionally transform the input value
         const resolvedInput = resolveInput ? resolveInput(value) : value;

package/utils.js

@@ -95,9 +95,9 @@ function makeAssertAllowed(build) {
     const { options, EXPORTABLE } = build;
     const { connectionFilterAllowNullInput, } = options;
     const assertAllowed = EXPORTABLE((connectionFilterAllowNullInput, isEmpty) => function (value, mode) {
-        // Reject empty objects in nested filter contexts (and/or/not, relation filters)
+        // Reject empty objects in nested where contexts (and/or/not, relation filters)
         if (mode === 'object' && isEmpty(value)) {
-            throw Object.assign(new Error('Empty objects are forbidden in filter argument input.'), {});
+            throw Object.assign(new Error('Empty objects are forbidden in where argument input.'), {});
         }
         if (mode === 'list') {
             const arr = value;
@@ -105,14 +105,14 @@ function makeAssertAllowed(build) {
                 const l = arr.length;
                 for (let i = 0; i < l; i++) {
                     if (isEmpty(arr[i])) {
-                        throw Object.assign(new Error('Empty objects are forbidden in filter argument input.'), {});
+                        throw Object.assign(new Error('Empty objects are forbidden in where argument input.'), {});
                     }
                 }
             }
         }
         // For all modes, check null
         if (!connectionFilterAllowNullInput && value === null) {
-            throw Object.assign(new Error('Null literals are forbidden in filter argument input.'), {});
+            throw Object.assign(new Error('Null literals are forbidden in where argument input.'), {});
         }
     }, [connectionFilterAllowNullInput, isEmpty]);
     return assertAllowed;