graphile-search-plugin 0.1.7 → 0.1.9

package/README.md

@@ -1,15 +1,28 @@
-# graphile-search-plugin [![Build Status](https://travis-ci.org/pyramation/graphile-search-plugin.svg?branch=master)](https://travis-ci.org/pyramation/graphile-search-plugin)
+# graphile-search-plugin
 
-```sh
-npm install graphile-search-plugin 
-```
+<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>
 
 This [PostGraphile](http://postgraphile.org/) schema plugin was built to enable ordering via `ts_rank` of full-text search on all `tsvector` fields, providing auto-generated queries within PostGraphile.
 
+## Install
+
+```sh
+npm install graphile-search-plugin
+```
+
 ## Usage
 
 1. Append the new plugins!
-2. Query `search<YourTsvectorColumn>` in the `conditions` field 
+2. Query `search<YourTsvectorColumn>` in the `conditions` field
 3. Enjoy!
 
 ```js
@@ -38,3 +51,79 @@ psql test_database < sql/test.sql
 yarn test
 ```
 
+---
+
+## 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,57 @@
+// plugins/PgSearchPlugin.ts
+/**
+ * PgSearchPlugin - Generates search conditions for tsvector columns
+ */
+const PgSearchPlugin = (builder, options = {}) => {
+    const { pgSearchPrefix = 'tsv' } = options;
+    builder.hook('GraphQLInputObjectType:fields', (fields, build, context) => {
+        const { inflection } = build;
+        const { scope: { isPgCondition, pgIntrospection: table }, fieldWithHooks } = context;
+        if (!isPgCondition || !table || table.kind !== 'class')
+            return fields;
+        const tsvs = table.attributes.filter((attr) => attr.type.name === 'tsvector');
+        if (!tsvs.length)
+            return fields;
+        return build.extend(fields, tsvs.reduce((memo, attr) => {
+            const fieldName = inflection.camelCase(`${pgSearchPrefix}_${attr.name}`);
+            memo[fieldName] = fieldWithHooks(fieldName, { type: build.graphql.GraphQLString }, {});
+            return memo;
+        }, {}));
+    });
+    builder.hook('GraphQLObjectType:fields:field:args', (args, build, context) => {
+        const { pgSql: sql, inflection } = build;
+        const { scope: { isPgFieldConnection, isPgFieldSimpleCollection, pgFieldIntrospection: procOrTable, pgFieldIntrospectionTable: tableIfProc, }, addArgDataGenerator, } = context;
+        const table = tableIfProc || procOrTable;
+        if ((!isPgFieldConnection && !isPgFieldSimpleCollection) ||
+            !table ||
+            table.kind !== 'class') {
+            return args;
+        }
+        const tsvs = table.attributes.filter((attr) => attr.type.name === 'tsvector');
+        if (!tsvs.length)
+            return args;
+        tsvs.forEach((tsv) => {
+            const conditionFieldName = inflection.camelCase(`${pgSearchPrefix}_${tsv.name}`);
+            addArgDataGenerator(function addSearchCondition({ condition }) {
+                if (!condition || !(conditionFieldName in condition))
+                    return {};
+                const value = condition[conditionFieldName];
+                if (value == null)
+                    return {};
+                return {
+                    pgQuery: (queryBuilder) => {
+                        const tsquery = sql.fragment `websearch_to_tsquery('english', ${sql.value(value)})`;
+                        const tableAlias = queryBuilder.getTableAlias();
+                        // WHERE condition
+                        queryBuilder.where(sql.fragment `${tableAlias}.${sql.identifier(tsv.name)} @@ ${tsquery}`);
+                        // Automatically add ordering by relevance (descending)
+                        queryBuilder.orderBy(sql.fragment `ts_rank(${tableAlias}.${sql.identifier(tsv.name)}, ${tsquery})`, false);
+                    },
+                };
+            });
+        });
+        return args;
+    }, [], ['PgConnectionArgOrderBy']);
+};
+export { PgSearchPlugin };
+export default PgSearchPlugin;

package/index.d.ts

@@ -0,0 +1,10 @@
+export interface PgSearchPluginOptions {
+    /** Prefix for tsvector fields, default is 'tsv' */
+    pgSearchPrefix?: string;
+}
+/**
+ * PgSearchPlugin - Generates search conditions for tsvector columns
+ */
+declare const PgSearchPlugin: (builder: any, options?: PgSearchPluginOptions) => void;
+export { PgSearchPlugin };
+export default PgSearchPlugin;

package/package.json

@@ -1,26 +1,19 @@
 {
   "name": "graphile-search-plugin",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "generate search conditions for your tsvector columns",
   "author": "Dan Lynch <pyramation@gmail.com>",
-  "homepage": "https://github.com/pyramation/graphile-search-plugin#readme",
-  "license": "SEE LICENSE IN LICENSE",
+  "homepage": "https://github.com/launchql/launchql",
+  "license": "MIT",
   "main": "index.js",
   "module": "esm/index.js",
   "types": "index.d.ts",
-  "directories": {
-    "lib": "src",
-    "test": "__tests__"
-  },
-  "files": [
-    "dist"
-  ],
   "scripts": {
-    "copy": "copyfiles -f ../../LICENSE README.md package.json dist",
-    "clean": "rimraf dist/**",
+    "clean": "makage clean",
+    "copy": "makage assets",
     "prepack": "pnpm run build",
-    "build": "pnpm run clean; tsc -p tsconfig.json; tsc -p tsconfig.esm.json; pnpm run copy",
-    "build:dev": "pnpm run clean; tsc -p tsconfig.json --declarationMap; tsc -p tsconfig.esm.json; pnpm run copy",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
     "lint": "eslint . --fix",
     "test": "jest",
     "test:watch": "jest --watch"
@@ -31,7 +24,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/pyramation/graphile-search-plugin"
+    "url": "https://github.com/launchql/launchql"
   },
   "keywords": [
     "postgraphile",
@@ -42,18 +35,19 @@
     "graphql"
   ],
   "bugs": {
-    "url": "https://github.com/pyramation/graphile-search-plugin/issues"
+    "url": "https://github.com/launchql/launchql/issues"
   },
   "devDependencies": {
     "@pyramation/postgraphile-plugin-fulltext-filter": "2.0.0",
-    "graphile-simple-inflector": "^0.1.1",
-    "graphile-test": "^2.8.3",
-    "pgsql-test": "^2.14.6",
+    "graphile-simple-inflector": "^0.1.4",
+    "graphile-test": "^2.8.5",
+    "makage": "^0.1.6",
+    "pgsql-test": "^2.14.8",
     "postgraphile-plugin-connection-filter": "^2.0.0"
   },
   "dependencies": {
     "graphile-build": "^4.14.1",
     "graphql-tag": "2.12.6"
   },
-  "gitHead": "4850ef84ce134d1bb43dc9132619a59257bd1157"
+  "gitHead": "e4643c07b6a961b964bbb132308366fc549504a1"
 }