graphile-plugin-connection-filter 2.3.2 → 2.3.3

package/README.md

@@ -16,27 +16,40 @@
   </a>
 </p>
 
-Adds a powerful suite of filtering capabilities to a PostGraphile schema.
+**`graphile-plugin-connection-filter`** adds a powerful suite of filtering capabilities to PostGraphile schemas.
 
 > **Warning:** Use of this plugin with the default options may make it **astoundingly trivial** for a malicious actor (or a well-intentioned application that generates complex GraphQL queries) to overwhelm your database with expensive queries. See the [Performance and Security](https://github.com/graphile-contrib/graphile-plugin-connection-filter#performance-and-security) section below for details.
 
-## Usage
+## 🚀 Installation
 
 Requires PostGraphile v4.5.0 or higher.
 
 Install with:
 
 ```
-yarn add postgraphile graphile-plugin-connection-filter
+pnpm add postgraphile graphile-plugin-connection-filter
 ```
 
-CLI usage via `--append-plugins`:
+## ✨ Features
+
+This plugin supports filtering on almost all PostgreSQL types, including complex types such as domains, ranges, arrays, and composite types. For details on the specific operators supported for each type, see [docs/operators.md](https://github.com/graphile-contrib/graphile-plugin-connection-filter/blob/master/docs/operators.md).
+
+See also:
+
+- [@graphile/pg-aggregates](https://github.com/graphile/pg-aggregates) - integrates with this plugin to enable powerful aggregate filtering
+- [graphile-plugin-connection-filter-postgis](https://github.com/launchql/launchql/tree/main/graphile/graphile-plugin-connection-filter-postgis) - adds PostGIS functions and operators for filtering on `geography`/`geometry` columns
+- [postgraphile-plugin-fulltext-filter](https://github.com/mlipscombe/postgraphile-plugin-fulltext-filter) - adds a full text search operator for filtering on `tsvector` columns
+- [postgraphile-plugin-unaccented-text-search-filter](https://github.com/spacefill/postgraphile-plugin-unaccented-text-search-filter) - adds unaccent text search operators
+
+## 📦 Usage
+
+### CLI usage via `--append-plugins`:
 
 ```
 postgraphile --append-plugins graphile-plugin-connection-filter -c postgres://localhost/my_db ...
 ```
 
-Library usage via `appendPlugins`:
+### Library usage via `appendPlugins`:
 
 ```ts
 import ConnectionFilterPlugin from "graphile-plugin-connection-filter";
@@ -47,7 +60,7 @@ const middleware = postgraphile(DATABASE_URL, SCHEMAS, {
 });
 ```
 
-## Performance and Security
+## ⚠️ Performance and Security
 
 By default, this plugin:
 
@@ -65,24 +78,13 @@ To protect your server, you can:
 
 Also see the [Production Considerations](https://www.graphile.org/postgraphile/production) page of the official PostGraphile docs, which discusses query whitelisting.
 
-## Features
-
-This plugin supports filtering on almost all PostgreSQL types, including complex types such as domains, ranges, arrays, and composite types. For details on the specific operators supported for each type, see [docs/operators.md](https://github.com/graphile-contrib/graphile-plugin-connection-filter/blob/master/docs/operators.md).
-
-See also:
-
-- [@graphile/pg-aggregates](https://github.com/graphile/pg-aggregates) - integrates with this plugin to enable powerful aggregate filtering
-- [graphile-plugin-connection-filter-postgis](https://github.com/launchql/launchql/tree/main/graphile/graphile-plugin-connection-filter-postgis) - adds PostGIS functions and operators for filtering on `geography`/`geometry` columns
-- [postgraphile-plugin-fulltext-filter](https://github.com/mlipscombe/postgraphile-plugin-fulltext-filter) - adds a full text search operator for filtering on `tsvector` columns
-- [postgraphile-plugin-unaccented-text-search-filter](https://github.com/spacefill/postgraphile-plugin-unaccented-text-search-filter) - adds unaccent text search operators
-
-## Handling `null` and empty objects
+## 🚦 Handling `null` and empty objects
 
 By default, this plugin will throw an error when `null` literals or empty objects (`{}`) are included in `filter` input objects. This prevents queries with ambiguous semantics such as `filter: { field: null }` and `filter: { field: { equalTo: null } }` from returning unexpected results. For background on this decision, see https://github.com/graphile-contrib/graphile-plugin-connection-filter/issues/58.
 
 To allow `null` and `{}` in inputs, use the `connectionFilterAllowNullInput` and `connectionFilterAllowEmptyObjectInput` options documented under [Plugin Options](https://github.com/graphile-contrib/graphile-plugin-connection-filter#plugin-options). Please note that even with `connectionFilterAllowNullInput` enabled, `null` is never interpreted as a SQL `NULL`; fields with `null` values are simply ignored when resolving the query.
 
-## Plugin Options
+## 🔧 Plugin Options
 
 When using PostGraphile as a library, the following plugin options can be passed via `graphileBuildOptions`:
 
@@ -265,7 +267,7 @@ postgraphile(pgConfig, schema, {
 });
 ```
 
-## Examples
+## 🧪 Examples
 
 ```graphql
 query {
@@ -279,15 +281,11 @@ query {
 
 For an extensive set of examples, see [docs/examples.md](https://github.com/graphile-contrib/graphile-plugin-connection-filter/blob/master/docs/examples.md).
 
-## Development
-
-To establish a test environment, create an empty PostgreSQL database with C collation (required for consistent ordering of strings) and set a `TEST_DATABASE_URL` environment variable with your database connection string.
+## 🧪 Testing
 
-```bash
-createdb graphile_test_c --template template0 --lc-collate C
-export TEST_DATABASE_URL=postgres://localhost:5432/graphile_test_c
-yarn
-yarn test
+```sh
+# requires a local Postgres available (defaults to postgres/password@localhost:5432)
+pnpm --filter graphile-plugin-connection-filter test
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphile-plugin-connection-filter",
-  "version": "2.3.2",
+  "version": "2.3.3",
   "description": "Filtering on PostGraphile connections",
   "author": "Matt Bretl",
   "homepage": "https://github.com/launchql/launchql",
@@ -49,10 +49,10 @@
   "devDependencies": {
     "@graphile-contrib/pg-simplify-inflector": "^6.1.0",
     "@types/pg": "^8.15.6",
-    "graphile-test": "^2.8.10",
+    "graphile-test": "^2.8.11",
     "makage": "^0.1.6",
     "pg": "^8.16.0",
-    "pgsql-test": "^2.14.13"
+    "pgsql-test": "^2.14.14"
   },
-  "gitHead": "4e1ff9771c2b07808a9830281abc24d12c689187"
+  "gitHead": "00c90828cab8d3e306ebb2bc6053aab4aa9ae807"
 }