@haathie/postgraphile-targeted-conditions 0.1.0 → 0.1.1

package/lib/index.js

@@ -15,6 +15,10 @@ export const TargetedConditionsPlugin = {
                     description: 'Allow filtering using by fields on this relation',
                     entities: ['pgCodecRef', 'pgRefDefinition']
                 },
+                'filterRequired': {
+                    description: 'Make the filter condition required',
+                    entities: ['pgCodecAttribute'],
+                },
                 ...Object.entries(FILTER_TYPES_MAP).reduce((acc, [filterType, { description }]) => {
                     const behaviourName = `filterType:${filterType}`;
                     acc[behaviourName] = {

package/lib/schema-fields.js

@@ -22,9 +22,13 @@ export const fields = (fieldMap, build, ctx) => {
             throw new Error(`Condition type ${typeName} for attribute "${attrName}" `
                 + `not found in codec "${pgCodec.name}".`);
         }
+        const isRequired = behavior.pgCodecAttributeMatches([pgCodec, attrName], 'filterRequired');
+        const fieldType = isRequired
+            ? new build.graphql.GraphQLNonNull(type)
+            : type;
         const fieldName = inflection
             .attribute({ attributeName: attrName, codec: pgCodec });
-        fieldMap[fieldName] = fieldWithHooks({ fieldName, isConditionContainer: true }, () => ({ extensions: { grafast: { apply: passThroughApply } }, type }));
+        fieldMap[fieldName] = fieldWithHooks({ fieldName, isConditionContainer: true }, () => ({ extensions: { grafast: { apply: passThroughApply } }, type: fieldType }));
     }
     // add queries via refs
     for (const [refName, { paths }] of Object.entries(pgCodec.refs || {})) {

package/lib/types.d.ts

@@ -43,6 +43,7 @@ export type FilterMethodConfig = {
 };
 interface FilterBehaviours extends Record<`filterType:${FilterType}`, true>, Record<`filterMethod:${FilterMethod}`, true> {
     'filterable': true;
+    'filterRequired': true;
 }
 declare global {
     namespace GraphileBuild {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@haathie/postgraphile-targeted-conditions",
-	"version": "0.1.0",
+	"version": "0.1.1",
 	"type": "module",
 	"files": ["lib"],
 	"main": "lib/index.js",
@@ -16,7 +16,7 @@
 		"build": "tsc -p tsconfig.json"
 	},
 	"dependencies": {
-		"@haathie/postgraphile-common-utils": "*"
+		"@haathie/postgraphile-common-utils": "^0.1.2"
 	},
 	"peerDependencies": {
 		"postgraphile": "*"

package/readme.md

@@ -59,6 +59,18 @@ input ContactNameCondition @oneOf {
 
 This allows for adding/removing filter types without breaking existing queries. For example, if you add a new filter type for "equals in" to the "name" column, and the above query will still work without any changes.
 
+## Making Conditions Required
+
+By default, all conditions are optional. However, you can make a condition required by adding a `filterRequired` behaviour.
+
+``` sql
+COMMENT ON COLUMN app.contacts.name is $$
+@behaviour filterType:icontains filterType:eq filterRequired
+$$;
+```
+
+This will make the `condition` argument for the `name` field required in the GraphQL schema, and it will also make sure that at least one of the filter types is provided in the query.
+
 ## Relational Conditions
 
 Let's say we have a `contacts` table and a `tags` table, with each contact having multiple tags. We can add a filter to the `contacts` table to filter by tags. We'll create a ref and add `filterable` behaviour to it.
@@ -207,4 +219,4 @@ See how [paradedb method](src/filter-implementations/paradedb.ts) is implemented
 
 - Adding relational conditions can lead to performance issues, especially if the related table has a large number of rows. Use with caution and please ensure you have the necessary indices in place.
 - Apart from relations, adding arbitrary conditions on fields for vibes only is not a good idea. It can cause unexpected performance issues, and it is recommended to only add conditions that are necessary for your application. The plugin is meant for you to quickly add targeted conditions to your queries, and only the ones you want -- so we spend more time writing mission-critical code rather than boilerplate SQL or GraphQL plans.
-- This plugin does not work with Postgres compound types at the moment. Only the `eq` and `eqIn` filter types are supported for compound types.
+- This plugin does not work with Postgres compound types at the moment. Only the `eq` and `eqIn` filter types are supported for compound types.