graphile-search 1.1.3 → 1.2.0

package/codecs/operator-factories.d.ts

@@ -18,5 +18,11 @@ export declare function createMatchesOperatorFactory(fullTextScalarName: string,
  * Creates the `similarTo` and `wordSimilarTo` filter operator factories
  * for pg_trgm fuzzy text matching. Declared here so they're registered
  * via the declarative `connectionFilterOperatorFactories` API.
+ *
+ * These operators target 'StringTrgm' (resolved to 'StringTrgmFilter'),
+ * NOT the global 'String' type. The unified search plugin registers
+ * 'StringTrgmFilter' and selectively assigns it to string columns on
+ * tables that qualify for trgm (via intentional search or @trgmSearch tag).
+ * This prevents trgm operators from appearing on every string field.
  */
 export declare function createTrgmOperatorFactories(): ConnectionFilterOperatorFactory;

package/codecs/operator-factories.js

@@ -38,13 +38,19 @@ function createMatchesOperatorFactory(fullTextScalarName, tsConfig) {
  * Creates the `similarTo` and `wordSimilarTo` filter operator factories
  * for pg_trgm fuzzy text matching. Declared here so they're registered
  * via the declarative `connectionFilterOperatorFactories` API.
+ *
+ * These operators target 'StringTrgm' (resolved to 'StringTrgmFilter'),
+ * NOT the global 'String' type. The unified search plugin registers
+ * 'StringTrgmFilter' and selectively assigns it to string columns on
+ * tables that qualify for trgm (via intentional search or @trgmSearch tag).
+ * This prevents trgm operators from appearing on every string field.
  */
 function createTrgmOperatorFactories() {
     return (build) => {
         const { sql } = build;
         return [
             {
-                typeNames: 'String',
+                typeNames: 'StringTrgm',
                 operatorName: 'similarTo',
                 spec: {
                     description: 'Fuzzy matches using pg_trgm trigram similarity. Tolerates typos and misspellings.',
@@ -62,7 +68,7 @@ function createTrgmOperatorFactories() {
                 },
             },
             {
-                typeNames: 'String',
+                typeNames: 'StringTrgm',
                 operatorName: 'wordSimilarTo',
                 spec: {
                     description: 'Fuzzy matches using pg_trgm word_similarity. Finds the best matching substring within the column value.',

package/esm/codecs/operator-factories.d.ts

@@ -18,5 +18,11 @@ export declare function createMatchesOperatorFactory(fullTextScalarName: string,
  * Creates the `similarTo` and `wordSimilarTo` filter operator factories
  * for pg_trgm fuzzy text matching. Declared here so they're registered
  * via the declarative `connectionFilterOperatorFactories` API.
+ *
+ * These operators target 'StringTrgm' (resolved to 'StringTrgmFilter'),
+ * NOT the global 'String' type. The unified search plugin registers
+ * 'StringTrgmFilter' and selectively assigns it to string columns on
+ * tables that qualify for trgm (via intentional search or @trgmSearch tag).
+ * This prevents trgm operators from appearing on every string field.
  */
 export declare function createTrgmOperatorFactories(): ConnectionFilterOperatorFactory;

package/esm/codecs/operator-factories.js

@@ -34,13 +34,19 @@ export function createMatchesOperatorFactory(fullTextScalarName, tsConfig) {
  * Creates the `similarTo` and `wordSimilarTo` filter operator factories
  * for pg_trgm fuzzy text matching. Declared here so they're registered
  * via the declarative `connectionFilterOperatorFactories` API.
+ *
+ * These operators target 'StringTrgm' (resolved to 'StringTrgmFilter'),
+ * NOT the global 'String' type. The unified search plugin registers
+ * 'StringTrgmFilter' and selectively assigns it to string columns on
+ * tables that qualify for trgm (via intentional search or @trgmSearch tag).
+ * This prevents trgm operators from appearing on every string field.
  */
 export function createTrgmOperatorFactories() {
     return (build) => {
         const { sql } = build;
         return [
             {
-                typeNames: 'String',
+                typeNames: 'StringTrgm',
                 operatorName: 'similarTo',
                 spec: {
                     description: 'Fuzzy matches using pg_trgm trigram similarity. Tolerates typos and misspellings.',
@@ -58,7 +64,7 @@ export function createTrgmOperatorFactories() {
                 },
             },
             {
-                typeNames: 'String',
+                typeNames: 'StringTrgm',
                 operatorName: 'wordSimilarTo',
                 spec: {
                     description: 'Fuzzy matches using pg_trgm word_similarity. Finds the best matching substring within the column value.',

package/esm/plugin.js

@@ -61,10 +61,15 @@ export function createUnifiedSearchPlugin(options) {
                 }
             }
         }
-        // Phase 2: Only run supplementary adapters if at least one primary
-        // adapter with isIntentionalSearch found columns on this codec.
+        // Phase 2: Run supplementary adapters if intentional search exists
+        // OR if the table/column has a @trgmSearch smart tag.
         // pgvector (isIntentionalSearch: false) alone won't trigger trgm.
-        if (hasIntentionalSearch) {
+        const hasTrgmSearchTag = 
+        // Table-level tag
+        codec.extensions?.tags?.trgmSearch ||
+            // Column-level tag
+            (codec.attributes && Object.values(codec.attributes).some((attr) => attr?.extensions?.tags?.trgmSearch));
+        if (hasIntentionalSearch || hasTrgmSearchTag) {
             for (const adapter of supplementaryAdapters) {
                 const columns = adapter.detectColumns(codec, build);
                 if (columns.length > 0) {
@@ -85,6 +90,8 @@ export function createUnifiedSearchPlugin(options) {
             'PgConnectionArgFilterAttributesPlugin',
             'PgConnectionArgFilterOperatorsPlugin',
             'AddConnectionFilterOperatorPlugin',
+            'ConnectionFilterTypesPlugin',
+            'ConnectionFilterCustomOperatorsPlugin',
             // Allow individual codec plugins to load first (e.g. Bm25CodecPlugin)
             'Bm25CodecPlugin',
             'VectorCodecPlugin',
@@ -161,6 +168,26 @@ export function createUnifiedSearchPlugin(options) {
                     for (const adapter of adapters) {
                         adapter.registerTypes(build);
                     }
+                    // Register StringTrgmFilter — a variant of StringFilter that includes
+                    // trgm operators (similarTo, wordSimilarTo). Only string columns on
+                    // tables that qualify for trgm will use this type instead of StringFilter.
+                    const hasTrgmAdapter = adapters.some((a) => a.name === 'trgm');
+                    if (hasTrgmAdapter) {
+                        const DPTYPES = build.dataplanPg?.TYPES;
+                        const textCodec = DPTYPES?.text ?? TYPES.text;
+                        build.registerInputObjectType('StringTrgmFilter', {
+                            pgConnectionFilterOperators: {
+                                isList: false,
+                                pgCodecs: [textCodec],
+                                inputTypeName: 'String',
+                                rangeElementInputTypeName: null,
+                                domainBaseTypeName: null,
+                            },
+                        }, () => ({
+                            description: 'A filter to be used against String fields with pg_trgm support. ' +
+                                'All fields are combined with a logical \u2018and.\u2019',
+                        }), 'UnifiedSearchPlugin (StringTrgmFilter)');
+                    }
                     return _;
                 },
                 /**
@@ -446,6 +473,26 @@ export function createUnifiedSearchPlugin(options) {
                         return fields;
                     }
                     let newFields = fields;
+                    // ── StringFilter → StringTrgmFilter type swapping ──
+                    // For tables that qualify for trgm, swap the type of string attribute
+                    // filter fields so they get similarTo/wordSimilarTo operators.
+                    const hasTrgm = adapterColumns.some((ac) => ac.adapter.name === 'trgm');
+                    if (hasTrgm) {
+                        const StringTrgmFilterType = build.getTypeByName('StringTrgmFilter');
+                        const StringFilterType = build.getTypeByName('StringFilter');
+                        if (StringTrgmFilterType && StringFilterType) {
+                            const swapped = {};
+                            for (const [key, field] of Object.entries(newFields)) {
+                                if (field && typeof field === 'object' && field.type === StringFilterType) {
+                                    swapped[key] = Object.assign({}, field, { type: StringTrgmFilterType });
+                                }
+                                else {
+                                    swapped[key] = field;
+                                }
+                            }
+                            newFields = swapped;
+                        }
+                    }
                     for (const { adapter, columns } of adapterColumns) {
                         for (const column of columns) {
                             const fieldName = inflection.camelCase(`${adapter.filterPrefix}_${column.attributeName}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-search",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Unified PostGraphile v5 search plugin — abstracts tsvector, BM25, pg_trgm, and pgvector behind a single adapter-based architecture with composite searchScore",
   "author": "Constructive <developers@constructive.io>",
   "homepage": "https://github.com/constructive-io/constructive",
@@ -31,11 +31,11 @@
   "devDependencies": {
     "@types/node": "^22.19.11",
     "@types/pg": "^8.18.0",
-    "graphile-connection-filter": "^1.1.3",
-    "graphile-test": "^4.5.5",
+    "graphile-connection-filter": "^1.1.4",
+    "graphile-test": "^4.5.6",
     "makage": "^0.1.10",
     "pg": "^8.20.0",
-    "pgsql-test": "^4.5.5"
+    "pgsql-test": "^4.5.6"
   },
   "peerDependencies": {
     "@dataplan/pg": "1.0.0-rc.8",
@@ -62,5 +62,5 @@
     "hybrid-search",
     "searchScore"
   ],
-  "gitHead": "9c322f47ca08b5b853fcb395fe2bfc224f8c4c27"
+  "gitHead": "9f3837555601b15e693ae0b750124fb0a8df3176"
 }

package/plugin.js

@@ -64,10 +64,15 @@ function createUnifiedSearchPlugin(options) {
                 }
             }
         }
-        // Phase 2: Only run supplementary adapters if at least one primary
-        // adapter with isIntentionalSearch found columns on this codec.
+        // Phase 2: Run supplementary adapters if intentional search exists
+        // OR if the table/column has a @trgmSearch smart tag.
         // pgvector (isIntentionalSearch: false) alone won't trigger trgm.
-        if (hasIntentionalSearch) {
+        const hasTrgmSearchTag = 
+        // Table-level tag
+        codec.extensions?.tags?.trgmSearch ||
+            // Column-level tag
+            (codec.attributes && Object.values(codec.attributes).some((attr) => attr?.extensions?.tags?.trgmSearch));
+        if (hasIntentionalSearch || hasTrgmSearchTag) {
             for (const adapter of supplementaryAdapters) {
                 const columns = adapter.detectColumns(codec, build);
                 if (columns.length > 0) {
@@ -88,6 +93,8 @@ function createUnifiedSearchPlugin(options) {
             'PgConnectionArgFilterAttributesPlugin',
             'PgConnectionArgFilterOperatorsPlugin',
             'AddConnectionFilterOperatorPlugin',
+            'ConnectionFilterTypesPlugin',
+            'ConnectionFilterCustomOperatorsPlugin',
             // Allow individual codec plugins to load first (e.g. Bm25CodecPlugin)
             'Bm25CodecPlugin',
             'VectorCodecPlugin',
@@ -164,6 +171,26 @@ function createUnifiedSearchPlugin(options) {
                     for (const adapter of adapters) {
                         adapter.registerTypes(build);
                     }
+                    // Register StringTrgmFilter — a variant of StringFilter that includes
+                    // trgm operators (similarTo, wordSimilarTo). Only string columns on
+                    // tables that qualify for trgm will use this type instead of StringFilter.
+                    const hasTrgmAdapter = adapters.some((a) => a.name === 'trgm');
+                    if (hasTrgmAdapter) {
+                        const DPTYPES = build.dataplanPg?.TYPES;
+                        const textCodec = DPTYPES?.text ?? pg_1.TYPES.text;
+                        build.registerInputObjectType('StringTrgmFilter', {
+                            pgConnectionFilterOperators: {
+                                isList: false,
+                                pgCodecs: [textCodec],
+                                inputTypeName: 'String',
+                                rangeElementInputTypeName: null,
+                                domainBaseTypeName: null,
+                            },
+                        }, () => ({
+                            description: 'A filter to be used against String fields with pg_trgm support. ' +
+                                'All fields are combined with a logical \u2018and.\u2019',
+                        }), 'UnifiedSearchPlugin (StringTrgmFilter)');
+                    }
                     return _;
                 },
                 /**
@@ -449,6 +476,26 @@ function createUnifiedSearchPlugin(options) {
                         return fields;
                     }
                     let newFields = fields;
+                    // ── StringFilter → StringTrgmFilter type swapping ──
+                    // For tables that qualify for trgm, swap the type of string attribute
+                    // filter fields so they get similarTo/wordSimilarTo operators.
+                    const hasTrgm = adapterColumns.some((ac) => ac.adapter.name === 'trgm');
+                    if (hasTrgm) {
+                        const StringTrgmFilterType = build.getTypeByName('StringTrgmFilter');
+                        const StringFilterType = build.getTypeByName('StringFilter');
+                        if (StringTrgmFilterType && StringFilterType) {
+                            const swapped = {};
+                            for (const [key, field] of Object.entries(newFields)) {
+                                if (field && typeof field === 'object' && field.type === StringFilterType) {
+                                    swapped[key] = Object.assign({}, field, { type: StringTrgmFilterType });
+                                }
+                                else {
+                                    swapped[key] = field;
+                                }
+                            }
+                            newFields = swapped;
+                        }
+                    }
                     for (const { adapter, columns } of adapterColumns) {
                         for (const column of columns) {
                             const fieldName = inflection.camelCase(`${adapter.filterPrefix}_${column.attributeName}`);