graphile-plugin-fulltext-filter 2.0.1

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Hyperweb <developers@hyperweb.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,174 @@
+# graphile-plugin-fulltext-filter
+
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/launchql/launchql/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/launchql/launchql/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/launchql/launchql/actions/workflows/run-tests.yaml/badge.svg" />
+  </a>
+   <a href="https://github.com/launchql/launchql/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+</p>
+
+Full text searching on `tsvector` fields for use with `postgraphile-plugin-connection-filter`. This plugin implements a full text search operator for `tsvector` columns in PostGraphile v4.
+
+## Install
+
+```sh
+pnpm add graphile-plugin-fulltext-filter
+```
+
+## Usage
+
+### CLI
+
+```bash
+postgraphile --append-plugins postgraphile-plugin-connection-filter,graphile-plugin-fulltext-filter
+```
+
+See [here](https://www.graphile.org/postgraphile/extending/#loading-additional-plugins) for more information about loading plugins with PostGraphile.
+
+### Library
+
+```js
+const express = require('express');
+const { postgraphile } = require('postgraphile');
+const PostGraphileConnectionFilterPlugin = require('postgraphile-plugin-connection-filter');
+const FulltextFilterPlugin = require('graphile-plugin-fulltext-filter');
+
+const app = express();
+
+app.use(
+  postgraphile(pgConfig, schema, {
+    appendPlugins: [
+      PostGraphileConnectionFilterPlugin,
+      FulltextFilterPlugin,
+    ],
+  })
+);
+
+app.listen(5000);
+```
+
+## Performance
+
+All `tsvector` columns that aren't `@omit`'d should have indexes on them:
+
+```sql
+ALTER TABLE posts ADD COLUMN full_text tsvector;
+CREATE INDEX full_text_idx ON posts USING gin(full_text);
+```
+
+## Operators
+
+This plugin adds the `matches` filter operator to the filter plugin, accepting a GraphQL String input and using the `@@` operator to perform full-text searches on `tsvector` columns.
+
+This plugin uses [pg-tsquery](https://github.com/caub/pg-tsquery) to parse the user input to prevent Postgres throwing on bad user input unnecessarily.
+
+## Fields
+
+For each `tsvector` column, a rank column will be automatically added to the GraphQL type for the table by appending `Rank` to the end of the column's name. For example, a column `full_text` will appear as `fullText` in the GraphQL type, and a second column, `fullTextRank` will be added to the type as a `Float`.
+
+This rank field can be used for ordering and is automatically added to the orderBy enum for the table.
+
+## Examples
+
+```graphql
+query {
+  allPosts(
+    filter: {
+      fullText: { matches: 'foo -bar' }
+    }
+    orderBy: FULL_TEXT_RANK_DESC
+  ) {
+    ...
+    fullTextRank
+  }
+}
+```
+
+## Testing
+
+```sh
+pnpm test
+```
+
+Tests expect a running PostgreSQL instance. See test configuration for database connection details.
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://launchql.com/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://launchql.com/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://launchql.com/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://launchql.com/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://launchql.com/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://launchql.com/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://launchql.com/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related LaunchQL Tooling
+
+### 🧪 Testing
+
+* [launchql/pgsql-test](https://github.com/launchql/launchql/tree/main/packages/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [launchql/supabase-test](https://github.com/launchql/launchql/tree/main/packages/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [launchql/graphile-test](https://github.com/launchql/launchql/tree/main/packages/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [launchql/pg-query-context](https://github.com/launchql/launchql/tree/main/packages/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
+
+* [launchql/pgsql-parser](https://github.com/launchql/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [launchql/libpg-query-node](https://github.com/launchql/libpg-query-node): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [launchql/pg-proto-parser](https://github.com/launchql/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://github.com/launchql/pgsql-parser/tree/main/packages/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://github.com/launchql/pgsql-parser/tree/main/packages/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://github.com/launchql/pgsql-parser/tree/main/packages/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+* [launchql/pg-ast](https://github.com/launchql/launchql/tree/main/packages/pg-ast): **🔍 Low-level AST tools** and transformations for Postgres query structures.
+
+### 🚀 API & Dev Tools
+
+* [launchql/server](https://github.com/launchql/launchql/tree/main/packages/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
+* [launchql/explorer](https://github.com/launchql/launchql/tree/main/packages/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
+
+### 🔁 Streaming & Uploads
+
+* [launchql/s3-streamer](https://github.com/launchql/launchql/tree/main/packages/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
+* [launchql/etag-hash](https://github.com/launchql/launchql/tree/main/packages/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
+* [launchql/etag-stream](https://github.com/launchql/launchql/tree/main/packages/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
+* [launchql/uuid-hash](https://github.com/launchql/launchql/tree/main/packages/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
+* [launchql/uuid-stream](https://github.com/launchql/launchql/tree/main/packages/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
+* [launchql/upload-names](https://github.com/launchql/launchql/tree/main/packages/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
+
+### 🧰 CLI & Codegen
+
+* [pgpm](https://github.com/launchql/launchql/tree/main/packages/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+* [@launchql/cli](https://github.com/launchql/launchql/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing LaunchQL projects—supports database scaffolding, migrations, seeding, code generation, and automation.
+* [launchql/launchql-gen](https://github.com/launchql/launchql/tree/main/packages/launchql-gen): **✨ Auto-generated GraphQL** mutations and queries dynamically built from introspected schema data.
+* [@launchql/query-builder](https://github.com/launchql/launchql/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.
+* [@launchql/query](https://github.com/launchql/launchql/tree/main/packages/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
+
+## Credits
+
+🛠 Built by LaunchQL — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/launchql)
+
+
+## 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/esm/index.js

@@ -0,0 +1,189 @@
+import { Tsquery } from 'pg-tsquery';
+import { omit } from 'graphile-build-pg';
+const tsquery = new Tsquery();
+const PostGraphileFulltextFilterPlugin = (builder) => {
+    builder.hook('inflection', (inflection, build) => build.extend(inflection, {
+        fullTextScalarTypeName() {
+            return 'FullText';
+        },
+        pgTsvRank(fieldName) {
+            return this.camelCase(`${fieldName}-rank`);
+        },
+        pgTsvOrderByColumnRankEnum(table, attr, ascending) {
+            const columnName = attr.kind === 'procedure'
+                ? attr.name.substring(table.name.length + 1)
+                : this._columnName(attr, { skipRowId: true }); // eslint-disable-line no-underscore-dangle
+            return this.constantCase(`${columnName}_rank_${ascending ? 'asc' : 'desc'}`);
+        },
+    }));
+    builder.hook('build', (build) => {
+        const { pgIntrospectionResultsByKind: introspectionResultsByKind, pgRegisterGqlTypeByTypeId: registerGqlTypeByTypeId, pgRegisterGqlInputTypeByTypeId: registerGqlInputTypeByTypeId, graphql: { GraphQLScalarType }, inflection, } = build;
+        const tsvectorType = introspectionResultsByKind.type.find((t) => t.name === 'tsvector');
+        if (!tsvectorType) {
+            throw new Error('Unable to find tsvector type through introspection.');
+        }
+        const scalarName = inflection.fullTextScalarTypeName();
+        const GraphQLFullTextType = new GraphQLScalarType({
+            name: scalarName,
+            serialize(value) {
+                return value;
+            },
+            parseValue(value) {
+                return value;
+            },
+            parseLiteral(lit) {
+                return lit;
+            },
+        });
+        registerGqlTypeByTypeId(tsvectorType.id, () => GraphQLFullTextType);
+        registerGqlInputTypeByTypeId(tsvectorType.id, () => GraphQLFullTextType);
+        return build.extend(build, {
+            pgTsvType: tsvectorType,
+        });
+    });
+    builder.hook('init', (_, build) => {
+        const { addConnectionFilterOperator, pgSql: sql, pgGetGqlInputTypeByTypeIdAndModifier: getGqlInputTypeByTypeIdAndModifier, graphql: { GraphQLString }, pgTsvType, } = build;
+        if (!pgTsvType) {
+            return build;
+        }
+        if (!(addConnectionFilterOperator instanceof Function)) {
+            throw new Error('PostGraphileFulltextFilterPlugin requires PostGraphileConnectionFilterPlugin to be loaded before it.');
+        }
+        const InputType = getGqlInputTypeByTypeIdAndModifier(pgTsvType.id, null);
+        addConnectionFilterOperator(InputType.name, 'matches', 'Performs a full text search on the field.', () => GraphQLString, (identifier, val, input, fieldName, queryBuilder) => {
+            const tsQueryString = `${tsquery.parse(input) || ''}`;
+            queryBuilder.__fts_ranks = queryBuilder.__fts_ranks || {};
+            queryBuilder.__fts_ranks[fieldName] = [identifier, tsQueryString];
+            return sql.query `${identifier} @@ to_tsquery(${sql.value(tsQueryString)})`;
+        }, {
+            allowedFieldTypes: [InputType.name],
+        });
+        return build;
+    });
+    builder.hook('GraphQLObjectType:fields', (fields, build, context) => {
+        const { pgIntrospectionResultsByKind: introspectionResultsByKind, graphql: { GraphQLFloat }, pgColumnFilter, pg2gql, pgSql: sql, inflection, pgTsvType, } = build;
+        const { scope: { isPgRowType, isPgCompoundType, pgIntrospection: table }, fieldWithHooks, } = context;
+        if (!(isPgRowType || isPgCompoundType) ||
+            !table ||
+            table.kind !== 'class' ||
+            !pgTsvType) {
+            return fields;
+        }
+        const tableType = introspectionResultsByKind.type.find((type) => type.type === 'c' &&
+            type.namespaceId === table.namespaceId &&
+            type.classId === table.id);
+        if (!tableType) {
+            throw new Error('Could not determine the type of this table.');
+        }
+        const tsvColumns = table.attributes
+            .filter((attr) => attr.typeId === pgTsvType.id)
+            .filter((attr) => pgColumnFilter(attr, build, context))
+            .filter((attr) => !omit(attr, 'filter'));
+        const tsvProcs = introspectionResultsByKind.procedure
+            .filter((proc) => proc.isStable)
+            .filter((proc) => proc.namespaceId === table.namespaceId)
+            .filter((proc) => proc.name.startsWith(`${table.name}_`))
+            .filter((proc) => proc.argTypeIds.length > 0)
+            .filter((proc) => proc.argTypeIds[0] === tableType.id)
+            .filter((proc) => proc.returnTypeId === pgTsvType.id)
+            .filter((proc) => !omit(proc, 'filter'));
+        if (tsvColumns.length === 0 && tsvProcs.length === 0) {
+            return fields;
+        }
+        const newRankField = (baseFieldName, rankFieldName) => fieldWithHooks(rankFieldName, ({ addDataGenerator }) => {
+            addDataGenerator(({ alias }) => ({
+                pgQuery: (queryBuilder) => {
+                    const { parentQueryBuilder } = queryBuilder;
+                    if (!parentQueryBuilder ||
+                        !parentQueryBuilder.__fts_ranks ||
+                        !parentQueryBuilder.__fts_ranks[baseFieldName]) {
+                        return;
+                    }
+                    const [identifier, tsQueryString] = parentQueryBuilder.__fts_ranks[baseFieldName];
+                    queryBuilder.select?.(sql.fragment `ts_rank(${identifier}, to_tsquery(${sql.value(tsQueryString)}))`, alias);
+                },
+            }));
+            return {
+                description: `Full-text search ranking when filtered by \`${baseFieldName}\`.`,
+                type: GraphQLFloat,
+                resolve: (data) => pg2gql(data[rankFieldName], GraphQLFloat),
+            };
+        }, {
+            isPgTSVRankField: true,
+        });
+        const tsvFields = tsvColumns.reduce((memo, attr) => {
+            const fieldName = inflection.column(attr);
+            const rankFieldName = inflection.pgTsvRank(fieldName);
+            memo[rankFieldName] = newRankField(fieldName, rankFieldName);
+            return memo;
+        }, {});
+        const tsvProcFields = tsvProcs.reduce((memo, proc) => {
+            const psuedoColumnName = proc.name.substring(table.name.length + 1);
+            const fieldName = inflection.computedColumn(psuedoColumnName, proc, table);
+            const rankFieldName = inflection.pgTsvRank(fieldName);
+            memo[rankFieldName] = newRankField(fieldName, rankFieldName);
+            return memo;
+        }, {});
+        return Object.assign({}, fields, tsvFields, tsvProcFields);
+    });
+    builder.hook('GraphQLEnumType:values', (values, build, context) => {
+        const { extend, pgSql: sql, pgColumnFilter, pgIntrospectionResultsByKind: introspectionResultsByKind, inflection, pgTsvType, } = build;
+        const { scope: { isPgRowSortEnum, pgIntrospection: table }, } = context;
+        if (!isPgRowSortEnum || !table || table.kind !== 'class' || !pgTsvType) {
+            return values;
+        }
+        const tableType = introspectionResultsByKind.type.find((type) => type.type === 'c' &&
+            type.namespaceId === table.namespaceId &&
+            type.classId === table.id);
+        if (!tableType) {
+            throw new Error('Could not determine the type of this table.');
+        }
+        const tsvColumns = introspectionResultsByKind.attribute
+            .filter((attr) => attr.classId === table.id)
+            .filter((attr) => attr.typeId === pgTsvType.id);
+        const tsvProcs = introspectionResultsByKind.procedure
+            .filter((proc) => proc.isStable)
+            .filter((proc) => proc.namespaceId === table.namespaceId)
+            .filter((proc) => proc.name.startsWith(`${table.name}_`))
+            .filter((proc) => proc.argTypeIds.length === 1)
+            .filter((proc) => proc.argTypeIds[0] === tableType.id)
+            .filter((proc) => proc.returnTypeId === pgTsvType.id)
+            .filter((proc) => !omit(proc, 'order'));
+        if (tsvColumns.length === 0 && tsvProcs.length === 0) {
+            return values;
+        }
+        return extend(values, tsvColumns
+            .concat(tsvProcs)
+            .filter((attr) => pgColumnFilter(attr, build, context))
+            .filter((attr) => !omit(attr, 'order'))
+            .reduce((memo, attr) => {
+            const fieldName = attr.kind === 'procedure'
+                ? inflection.computedColumn(attr.name.substring(table.name.length + 1), attr, table)
+                : inflection.column(attr);
+            const ascFieldName = inflection.pgTsvOrderByColumnRankEnum(table, attr, true);
+            const descFieldName = inflection.pgTsvOrderByColumnRankEnum(table, attr, false);
+            const findExpr = ({ queryBuilder }) => {
+                if (!queryBuilder.__fts_ranks || !queryBuilder.__fts_ranks[fieldName]) {
+                    return sql.fragment `1`;
+                }
+                const [identifier, tsQueryString] = queryBuilder.__fts_ranks[fieldName];
+                return sql.fragment `ts_rank(${identifier}, to_tsquery(${sql.value(tsQueryString)}))`;
+            };
+            memo[ascFieldName] = {
+                value: {
+                    alias: `${ascFieldName.toLowerCase()}`,
+                    specs: [[findExpr, true]],
+                },
+            };
+            memo[descFieldName] = {
+                value: {
+                    alias: `${descFieldName.toLowerCase()}`,
+                    specs: [[findExpr, false]],
+                },
+            };
+            return memo;
+        }, {}), `Adding TSV rank columns for sorting on table '${table.name}'`);
+    });
+};
+export { PostGraphileFulltextFilterPlugin };
+export default PostGraphileFulltextFilterPlugin;

package/index.d.ts

@@ -0,0 +1,4 @@
+import type { Plugin } from 'graphile-build';
+declare const PostGraphileFulltextFilterPlugin: Plugin;
+export { PostGraphileFulltextFilterPlugin };
+export default PostGraphileFulltextFilterPlugin;

package/index.js

@@ -0,0 +1,192 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostGraphileFulltextFilterPlugin = void 0;
+const pg_tsquery_1 = require("pg-tsquery");
+const graphile_build_pg_1 = require("graphile-build-pg");
+const tsquery = new pg_tsquery_1.Tsquery();
+const PostGraphileFulltextFilterPlugin = (builder) => {
+    builder.hook('inflection', (inflection, build) => build.extend(inflection, {
+        fullTextScalarTypeName() {
+            return 'FullText';
+        },
+        pgTsvRank(fieldName) {
+            return this.camelCase(`${fieldName}-rank`);
+        },
+        pgTsvOrderByColumnRankEnum(table, attr, ascending) {
+            const columnName = attr.kind === 'procedure'
+                ? attr.name.substring(table.name.length + 1)
+                : this._columnName(attr, { skipRowId: true }); // eslint-disable-line no-underscore-dangle
+            return this.constantCase(`${columnName}_rank_${ascending ? 'asc' : 'desc'}`);
+        },
+    }));
+    builder.hook('build', (build) => {
+        const { pgIntrospectionResultsByKind: introspectionResultsByKind, pgRegisterGqlTypeByTypeId: registerGqlTypeByTypeId, pgRegisterGqlInputTypeByTypeId: registerGqlInputTypeByTypeId, graphql: { GraphQLScalarType }, inflection, } = build;
+        const tsvectorType = introspectionResultsByKind.type.find((t) => t.name === 'tsvector');
+        if (!tsvectorType) {
+            throw new Error('Unable to find tsvector type through introspection.');
+        }
+        const scalarName = inflection.fullTextScalarTypeName();
+        const GraphQLFullTextType = new GraphQLScalarType({
+            name: scalarName,
+            serialize(value) {
+                return value;
+            },
+            parseValue(value) {
+                return value;
+            },
+            parseLiteral(lit) {
+                return lit;
+            },
+        });
+        registerGqlTypeByTypeId(tsvectorType.id, () => GraphQLFullTextType);
+        registerGqlInputTypeByTypeId(tsvectorType.id, () => GraphQLFullTextType);
+        return build.extend(build, {
+            pgTsvType: tsvectorType,
+        });
+    });
+    builder.hook('init', (_, build) => {
+        const { addConnectionFilterOperator, pgSql: sql, pgGetGqlInputTypeByTypeIdAndModifier: getGqlInputTypeByTypeIdAndModifier, graphql: { GraphQLString }, pgTsvType, } = build;
+        if (!pgTsvType) {
+            return build;
+        }
+        if (!(addConnectionFilterOperator instanceof Function)) {
+            throw new Error('PostGraphileFulltextFilterPlugin requires PostGraphileConnectionFilterPlugin to be loaded before it.');
+        }
+        const InputType = getGqlInputTypeByTypeIdAndModifier(pgTsvType.id, null);
+        addConnectionFilterOperator(InputType.name, 'matches', 'Performs a full text search on the field.', () => GraphQLString, (identifier, val, input, fieldName, queryBuilder) => {
+            const tsQueryString = `${tsquery.parse(input) || ''}`;
+            queryBuilder.__fts_ranks = queryBuilder.__fts_ranks || {};
+            queryBuilder.__fts_ranks[fieldName] = [identifier, tsQueryString];
+            return sql.query `${identifier} @@ to_tsquery(${sql.value(tsQueryString)})`;
+        }, {
+            allowedFieldTypes: [InputType.name],
+        });
+        return build;
+    });
+    builder.hook('GraphQLObjectType:fields', (fields, build, context) => {
+        const { pgIntrospectionResultsByKind: introspectionResultsByKind, graphql: { GraphQLFloat }, pgColumnFilter, pg2gql, pgSql: sql, inflection, pgTsvType, } = build;
+        const { scope: { isPgRowType, isPgCompoundType, pgIntrospection: table }, fieldWithHooks, } = context;
+        if (!(isPgRowType || isPgCompoundType) ||
+            !table ||
+            table.kind !== 'class' ||
+            !pgTsvType) {
+            return fields;
+        }
+        const tableType = introspectionResultsByKind.type.find((type) => type.type === 'c' &&
+            type.namespaceId === table.namespaceId &&
+            type.classId === table.id);
+        if (!tableType) {
+            throw new Error('Could not determine the type of this table.');
+        }
+        const tsvColumns = table.attributes
+            .filter((attr) => attr.typeId === pgTsvType.id)
+            .filter((attr) => pgColumnFilter(attr, build, context))
+            .filter((attr) => !(0, graphile_build_pg_1.omit)(attr, 'filter'));
+        const tsvProcs = introspectionResultsByKind.procedure
+            .filter((proc) => proc.isStable)
+            .filter((proc) => proc.namespaceId === table.namespaceId)
+            .filter((proc) => proc.name.startsWith(`${table.name}_`))
+            .filter((proc) => proc.argTypeIds.length > 0)
+            .filter((proc) => proc.argTypeIds[0] === tableType.id)
+            .filter((proc) => proc.returnTypeId === pgTsvType.id)
+            .filter((proc) => !(0, graphile_build_pg_1.omit)(proc, 'filter'));
+        if (tsvColumns.length === 0 && tsvProcs.length === 0) {
+            return fields;
+        }
+        const newRankField = (baseFieldName, rankFieldName) => fieldWithHooks(rankFieldName, ({ addDataGenerator }) => {
+            addDataGenerator(({ alias }) => ({
+                pgQuery: (queryBuilder) => {
+                    const { parentQueryBuilder } = queryBuilder;
+                    if (!parentQueryBuilder ||
+                        !parentQueryBuilder.__fts_ranks ||
+                        !parentQueryBuilder.__fts_ranks[baseFieldName]) {
+                        return;
+                    }
+                    const [identifier, tsQueryString] = parentQueryBuilder.__fts_ranks[baseFieldName];
+                    queryBuilder.select?.(sql.fragment `ts_rank(${identifier}, to_tsquery(${sql.value(tsQueryString)}))`, alias);
+                },
+            }));
+            return {
+                description: `Full-text search ranking when filtered by \`${baseFieldName}\`.`,
+                type: GraphQLFloat,
+                resolve: (data) => pg2gql(data[rankFieldName], GraphQLFloat),
+            };
+        }, {
+            isPgTSVRankField: true,
+        });
+        const tsvFields = tsvColumns.reduce((memo, attr) => {
+            const fieldName = inflection.column(attr);
+            const rankFieldName = inflection.pgTsvRank(fieldName);
+            memo[rankFieldName] = newRankField(fieldName, rankFieldName);
+            return memo;
+        }, {});
+        const tsvProcFields = tsvProcs.reduce((memo, proc) => {
+            const psuedoColumnName = proc.name.substring(table.name.length + 1);
+            const fieldName = inflection.computedColumn(psuedoColumnName, proc, table);
+            const rankFieldName = inflection.pgTsvRank(fieldName);
+            memo[rankFieldName] = newRankField(fieldName, rankFieldName);
+            return memo;
+        }, {});
+        return Object.assign({}, fields, tsvFields, tsvProcFields);
+    });
+    builder.hook('GraphQLEnumType:values', (values, build, context) => {
+        const { extend, pgSql: sql, pgColumnFilter, pgIntrospectionResultsByKind: introspectionResultsByKind, inflection, pgTsvType, } = build;
+        const { scope: { isPgRowSortEnum, pgIntrospection: table }, } = context;
+        if (!isPgRowSortEnum || !table || table.kind !== 'class' || !pgTsvType) {
+            return values;
+        }
+        const tableType = introspectionResultsByKind.type.find((type) => type.type === 'c' &&
+            type.namespaceId === table.namespaceId &&
+            type.classId === table.id);
+        if (!tableType) {
+            throw new Error('Could not determine the type of this table.');
+        }
+        const tsvColumns = introspectionResultsByKind.attribute
+            .filter((attr) => attr.classId === table.id)
+            .filter((attr) => attr.typeId === pgTsvType.id);
+        const tsvProcs = introspectionResultsByKind.procedure
+            .filter((proc) => proc.isStable)
+            .filter((proc) => proc.namespaceId === table.namespaceId)
+            .filter((proc) => proc.name.startsWith(`${table.name}_`))
+            .filter((proc) => proc.argTypeIds.length === 1)
+            .filter((proc) => proc.argTypeIds[0] === tableType.id)
+            .filter((proc) => proc.returnTypeId === pgTsvType.id)
+            .filter((proc) => !(0, graphile_build_pg_1.omit)(proc, 'order'));
+        if (tsvColumns.length === 0 && tsvProcs.length === 0) {
+            return values;
+        }
+        return extend(values, tsvColumns
+            .concat(tsvProcs)
+            .filter((attr) => pgColumnFilter(attr, build, context))
+            .filter((attr) => !(0, graphile_build_pg_1.omit)(attr, 'order'))
+            .reduce((memo, attr) => {
+            const fieldName = attr.kind === 'procedure'
+                ? inflection.computedColumn(attr.name.substring(table.name.length + 1), attr, table)
+                : inflection.column(attr);
+            const ascFieldName = inflection.pgTsvOrderByColumnRankEnum(table, attr, true);
+            const descFieldName = inflection.pgTsvOrderByColumnRankEnum(table, attr, false);
+            const findExpr = ({ queryBuilder }) => {
+                if (!queryBuilder.__fts_ranks || !queryBuilder.__fts_ranks[fieldName]) {
+                    return sql.fragment `1`;
+                }
+                const [identifier, tsQueryString] = queryBuilder.__fts_ranks[fieldName];
+                return sql.fragment `ts_rank(${identifier}, to_tsquery(${sql.value(tsQueryString)}))`;
+            };
+            memo[ascFieldName] = {
+                value: {
+                    alias: `${ascFieldName.toLowerCase()}`,
+                    specs: [[findExpr, true]],
+                },
+            };
+            memo[descFieldName] = {
+                value: {
+                    alias: `${descFieldName.toLowerCase()}`,
+                    specs: [[findExpr, false]],
+                },
+            };
+            return memo;
+        }, {}), `Adding TSV rank columns for sorting on table '${table.name}'`);
+    });
+};
+exports.PostGraphileFulltextFilterPlugin = PostGraphileFulltextFilterPlugin;
+exports.default = PostGraphileFulltextFilterPlugin;

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "graphile-plugin-fulltext-filter",
+  "version": "2.0.1",
+  "description": "Full text searching on tsvector fields for use with postgraphile-plugin-connection-filter",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "author": "Mark Lipscombe",
+  "homepage": "https://github.com/launchql/launchql",
+  "license": "MIT",
+  "scripts": {
+    "clean": "makage clean",
+    "copy": "makage assets",
+    "prepack": "pnpm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
+    "lint": "eslint . --fix",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/launchql/launchql"
+  },
+  "keywords": [
+    "postgraphile",
+    "graphile",
+    "launchql",
+    "plugin",
+    "postgres",
+    "graphql",
+    "fulltext",
+    "tsvector"
+  ],
+  "bugs": {
+    "url": "https://github.com/launchql/launchql/issues"
+  },
+  "dependencies": {
+    "graphile-build": "^4.14.1",
+    "graphile-build-pg": "^4.14.1",
+    "pg-tsquery": "^8.1.0",
+    "postgraphile-plugin-connection-filter": "^2.0.0"
+  },
+  "peerDependencies": {
+    "postgraphile-core": "^4.2.0",
+    "postgraphile-plugin-connection-filter": "^2.0.0"
+  },
+  "devDependencies": {
+    "graphile-test": "^2.8.8",
+    "graphql": "15.10.1",
+    "makage": "^0.1.6",
+    "pgsql-test": "^2.14.11",
+    "postgraphile-plugin-connection-filter": "^2.0.0"
+  },
+  "gitHead": "ff477433074d91c28be6017e858b601fa99aa568"
+}