Merge pull request #5836 from neo4j/generic-scalar-filters

Generic input filters

.changeset/clever-tomatoes-float.md

@@ -0,0 +1,5 @@
+---
+"@neo4j/graphql": major
+---
+
+The `typename_IN` filter has been renamed to `typename`.

.changeset/fair-elephants-yell.md

@@ -0,0 +1,5 @@
+---
+"@neo4j/graphql": major
+---
+
+Aggregations are no longer generated for `ID` fields.

.changeset/four-insects-repeat.md

@@ -0,0 +1,15 @@
+---
+"@neo4j/graphql": patch
+---
+
+Deprecate individual mutations in favor of generic mutations
+
+-   `_SET`
+-   `_POP`
+-   `_PUSH`
+-   `_INCREMENT`
+-   `_ADD`
+-   `_DECREMENT`
+-   `_SUBTRACT`
+-   `_MULTIPLY`
+-   `_DIVIDE`

.changeset/green-jobs-jam.md

@@ -0,0 +1,16 @@
+---
+"@neo4j/graphql": minor
+---
+
+Add suport for generic update operators:
+
+```graphql
+mutation {
+    updateMovies(update: { name: { set: "The Matrix" } }) {
+        movies {
+            id
+            name
+        }
+    }
+}
+```

.changeset/khaki-roses-raise.md

@@ -0,0 +1,31 @@
+---
+"@neo4j/graphql": patch
+---
+
+Deprecates old aggregation filters for relationships in favor of more generic filters:
+
+Before:
+
+```js
+query Movies {
+  movies(
+    where: { actorsAggregate: { node: { lastRating_AVERAGE_GT: 6 } } }
+  ) {
+    title
+  }
+}
+```
+
+Now:
+
+```js
+query Movies {
+  movies(
+    where: {
+      actorsAggregate: { node: { lastRating: { average: { gt: 6 } } } }
+    }
+  ) {
+    title
+  }
+}
+```

.changeset/nine-games-clap.md

@@ -0,0 +1,6 @@
+---
+"@neo4j/graphql": patch
+---
+
+Deprecate relationship filtering using the non-generic version such as `actors_SOME: { title_EQ: "The Matrix" }` in favor of the generic input `actors: { some: { title: { eq: "The Matrix" } } }`.
+The setting `excludeDeprecatedFields` now contains the option `relationshipFilters` to remove these deprecated filters.

.changeset/quick-dolphins-accept.md

@@ -0,0 +1,6 @@
+---
+"@neo4j/graphql": patch
+---
+
+Deprecate attribute filtering using the non-generic version such as `title_EQ: "The Matrix"` in favor of the generic input `title: { eq: "The Matrix" }`.
+The setting `excludeDeprecatedFields` now contains the option `attributeFilters` to remove these deprecated filters.

.changeset/silly-toys-sing.md

@@ -0,0 +1,13 @@
+---
+"@neo4j/graphql": patch
+---
+
+Add generic filters for aggregations:
+
+```graphql
+{
+    posts(where: { likesAggregate: { node: { rating: { average: { eq: 3.2 } } } } }) {
+        title
+    }
+}
+```

.changeset/six-bottles-hear.md

@@ -0,0 +1,12 @@
+---
+"@neo4j/graphql": patch
+---
+
+Introduce the flag "aggregationFilters" to remove deprecated aggregation filters:
+
+```js
+const neoSchema = new Neo4jGraphQL({
+    typeDefs,
+    features: { excludeDeprecatedFields: { aggregationFilters: true } },
+});
+```

.changeset/unlucky-spoons-trade.md

@@ -0,0 +1,25 @@
+---
+"@neo4j/graphql": minor
+---
+
+Introduce a new style for filtering relationships and connections.
+The quantifiers `SOME` | `NONE` | `SINGLE` | `ALL` are now available as a nested input object.
+
+**Relationship**
+
+```graphql
+{
+    movies(where: { genres: { some: { name: { equals: "some genre" } } } }) {
+        actorCount
+    }
+}
+```
+
+**Connection** 
+```graphql
+{
+    movies(where: { genresConnection: { some: { node: { name: { equals: "some genre" } } } } }) {
+        actorCount
+    }
+}
+```

packages/graphql/src/classes/Neo4jGraphQL.test.ts

@@ -39,10 +39,14 @@ describe("Neo4jGraphQL", () => {
         describe("getExecutableSchema", () => {
             test("error should contain path", async () => {
                 let schema: GraphQLSchema | undefined = undefined;
+                const typeDefs = /* GraphQL */ `
+                    type User @node @authorization(filter: [{ where: { banana: { id: "$jwt.sub" } } }]) {
+                        id: ID
+                    }
+                `;
                 const errors: Error[] = await getErrorAsync(async () => {
                     schema = await new Neo4jGraphQL({
-                        typeDefs:
-                            'type User @node @authorization(filter: [{ where: { banana: { id: "$jwt.sub" } } }]) {id: ID}',
+                        typeDefs,
                     }).getExecutableSchema();
                 });
                 expect(errors).toHaveLength(1);

packages/graphql/src/classes/Neo4jGraphQL.ts

@@ -401,7 +401,12 @@ class Neo4jGraphQL {
             });
 
             if (this.validate) {
-                validateUserDefinition({ userDocument: document, augmentedDocument: typeDefs, jwt: jwt?.type });
+                validateUserDefinition({
+                    userDocument: document,
+                    augmentedDocument: typeDefs,
+                    jwt: jwt?.type,
+                    features: this.features,
+                });
             }
 
             this._nodes = nodes;
@@ -473,6 +478,7 @@ class Neo4jGraphQL {
                 additionalDirectives: directives,
                 additionalTypes: types,
                 jwt: jwt?.type,
+                features: this.features,
             });
         }
 

packages/graphql/src/graphql/directives/type-dependant-directives/get-static-auth-definitions.ts

@@ -62,6 +62,7 @@ export function getStaticAuthorizationDefinitions(
 
     const JWTPayloadWhere = createJWTPayloadWhere(userDocument, schema, JWTPayloadDefinition);
     const JWTPayloadWhereAST = astFromInputObjectType(JWTPayloadWhere, schema);
+
     ASTs.push(JWTPayloadWhereAST);
     return ASTs;
 }
@@ -80,14 +81,16 @@ function createJWTPayloadWhere(
         (field) => new AttributeAdapter(parseAttribute(field, definitionCollection))
     );
 
+    const composer = new SchemaComposer();
     const inputFieldsType = getWhereFieldsForAttributes({
         attributes: jwtFieldAttributeAdapters,
         userDefinedFieldDirectives: undefined,
         features: undefined,
         ignoreCypherFieldFilters: false,
+        composer,
     });
 
-    const composer = new SchemaComposer();
+
     const inputTC = composer.createInputTC({
         name: "JWTPayloadWhere",
         fields: inputFieldsType,

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/BigIntScalarAggregationFilters.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { BigIntScalarFilters } from "../generic-operators/BigIntScalarFilters";
+
+export const BigIntScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "BigIntScalarAggregationFilters",
+    description: "Filters for an aggregation of an BigInt field",
+    fields: {
+        average: { type: BigIntScalarFilters },
+        max: { type: BigIntScalarFilters },
+        min: { type: BigIntScalarFilters },
+        sum: { type: BigIntScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/DateTimeScalarAggregationFilters.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { DateTimeScalarFilters } from "../generic-operators/DateTimeScalarFilters";
+
+export const DateTimeScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "DateTimeScalarAggregationFilters",
+    description: "Filters for an aggregation of an DateTime input field",
+    fields: {
+        max: { type: DateTimeScalarFilters },
+        min: { type: DateTimeScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/DurationScalarAggregationFilters.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { DurationScalarFilters } from "../generic-operators/DurationScalarFilters";
+
+export const DurationScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "DurationScalarAggregationFilters",
+    description: "Filters for an aggregation of a Dutation input field",
+    fields: {
+        max: { type: DurationScalarFilters },
+        min: { type: DurationScalarFilters },
+        average: { type: DurationScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/FloatScalarAggregationFilters.ts

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { FloatScalarFilters } from "../generic-operators/FloatScalarFilters";
+
+export const FloatScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "FloatScalarAggregationFilters",
+    description: "Filters for an aggregation of a float field",
+    fields: {
+        average: { type: FloatScalarFilters },
+        max: { type: FloatScalarFilters },
+        min: { type: FloatScalarFilters },
+        sum: { type: FloatScalarFilters },
+    },
+});

packages/graphql/src/graphql/input-objects/generic-aggregation-filters/IntScalarAggregationFilters.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) "Neo4j"
+ * Neo4j Sweden AB [http://neo4j.com]
+ *
+ * This file is part of Neo4j.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { GraphQLInputObjectType } from "graphql";
+import { FloatScalarFilters } from "../generic-operators/FloatScalarFilters";
+import { IntScalarFilters } from "../generic-operators/IntScalarFilters";
+
+export const IntScalarAggregationFilters = new GraphQLInputObjectType({
+    name: "IntScalarAggregationFilters",
+    description: "Filters for an aggregation of an int field",
+    fields: {
+        average: { type: FloatScalarFilters },
+        max: { type: IntScalarFilters },
+        min: { type: IntScalarFilters },
+        sum: { type: IntScalarFilters },
+    },
+});