Merge branch 'next' into main

Author: maoosi

CHANGELOG.md

@@ -1,5 +1,98 @@
 # Changelog
 
+## Version 1.0.0-beta.56
+
+### ⚠️ Breaking
+
+- Feat: Introducing pagination on list queries.
+- Feat: Introducing entirely refactored filters on list queries, closer to the Prisma syntax.
+
+#### Filtering (breaking)
+
+To simplify both usage and implementation, filtering on fields and relations have been refactored entirely. The syntax is now closer to [how Prisma handles filtering](https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#filter-conditions-and-operators).
+
+```graphql
+# before
+query {
+    listPosts(
+        where: { title_startsWith: "Foo" }
+    ) {
+        title
+    }
+}
+
+# after (1.0.0-beta.56+)
+query {
+    listPosts(
+        where: { title: { startsWith: "Foo" } }
+    ) {
+        title
+    }
+}
+```
+
+```graphql
+# before
+query {
+    listPosts(
+        where: { title: "Foo" }
+    ) {
+        title
+    }
+}
+
+# after (1.0.0-beta.56+)
+query {
+    listPosts(
+        where: { title: { equals: "Foo" } }
+    ) {
+        title
+    }
+}
+```
+
+Some Types have also been renamed for more consistency:
+
+- `CreateRelations` renamed to `CreateRelationsInput`
+- `UpdateRelations` renamed to `UpdateRelationsInput`
+- `WhereInput` renamed to `WhereFilterInput`
+
+#### Pagination (breaking)
+
+Introducing pagination on list queries ([using Prisma offset pagination](https://www.prisma.io/docs/concepts/components/prisma-client/pagination)).
+
+```graphql
+# after (1.0.0-beta.56+)
+query {
+    listPosts(
+        skip: 0
+        take: 20
+    ) {
+        title
+    }
+}
+```
+
+If the `take` parameter is omitted, PrismaAppSync will use a default value of `50`. It is also possible to change the default value:
+
+```typescript
+// Set the default value to 50, if the `take` parameter is omitted.
+const app = new PrismaAppSync({
+    connectionUrl: process.env.DB_CONNECTION_URL,
+    defaultPagination: 20
+})
+
+// Disable pagination limit, if the `take` parameter is omitted.
+const app = new PrismaAppSync({
+    connectionUrl: process.env.DB_CONNECTION_URL,
+    defaultPagination: false
+})
+```
+
+### Non-breaking
+
+- Fix: Has no exported member 'Prisma' issue resolved ([issues/11](https://github.com/maoosi/prisma-appsync/issues/11))
+
 ## Version 1.0.0-beta.53
 
 ### ⚠️ Breaking

boilerplate/handler.ts

@@ -6,8 +6,14 @@ const app = new PrismaAppSync({
     connectionUrl: process.env.CONNECTION_URL,
     debug: true
 })
+<% if (testingMode) { %>
+// Prisma middleware
+app.prisma.$use(async (params, next) => {
+    console.log('Hello from Prisma middleware!', params)
+    return next(params)
+})
 
-// Lambda function handler
+<% } %>// Lambda function handler
 export const main = async (event: any, context: any, callback: any) => {
     context.callbackWaitsForEmptyEventLoop = false
     console.info('Received event:', JSON.stringify(event))
@@ -22,25 +28,15 @@ export const main = async (event: any, context: any, callback: any) => {
                     where: { id: customResolverParams.args.postId }
                 })
             }
-
         app.registerCustomResolvers({ incrementPostsViews })
 
-        // Prisma middleware
-        app.prisma.$use(async (params, next) => {
-            console.log('Hello from Prisma middleware!', params)
-            return next(params)
-        })
-        
         <% } %>// Parse the `event` from your Lambda function
         app.parseEvent(event)
 
         // Handle CRUD operations / resolve query
         const result = await app.resolve()
         console.info('Resolver result:', result)
 
-        // Close database connection
-        await app.prisma.$disconnect()
-
         // Return query result
         return Promise.resolve(result)
 

dist/generator.js

@@ -316575,7 +316575,7 @@ var require_package2 = __commonJS2((exports2, module2) => {
   module2.exports = {
     name: "prisma-appsync",
     description: "\u26A1 AppSync GraphQL API Generator for \u25ED Prisma 2, the next-gen ORM.",
-    version: "1.0.0-beta.54",
+    version: "1.0.0-beta.56",
     bin: "./dist/generator.js",
     repository: "git@github.com:maoosi/prisma-appsync.git",
     author: "maoosi <hello@sylvainsimao.fr>",
@@ -321101,6 +321101,7 @@ var PrismaAppSyncCompiler = class {
               name: field.name,
               scalar: this.getFieldScalar(field),
               isRequired: this.isFieldRequired(field),
+              isEnum: this.isFieldEnum(field),
               isEditable: !this.isFieldGeneratedRelation(field, model) && !this.isFieldImmutableDate(field),
               isUnique: this.isFieldUnique(field, model),
               ...field.relationName && {
@@ -321164,6 +321165,7 @@ var PrismaAppSyncCompiler = class {
         subFields.push({
           name: idFields.join("_"),
           scalar: `${idFields.join("_")}FieldsInput!`,
+          isEnum: false,
           isRequired: true,
           isEditable: false,
           isUnique: true,
@@ -321179,6 +321181,9 @@ var PrismaAppSyncCompiler = class {
   isFieldRequired(searchField) {
     return searchField.isRequired && !(searchField.relationName && searchField.isList);
   }
+  isFieldEnum(searchField) {
+    return searchField.kind === "enum";
+  }
   isFieldImmutableDate(searchField) {
     return searchField.isId || searchField.isUpdatedAt || ["updatedAt", "createdAt"].includes(searchField.name);
   }

dist/prisma-appsync/_adapter.d.ts

@@ -2,6 +2,7 @@ import { RequestProps, AdapterOptions, AuthType, Operation } from './_types';
 export declare class PrismaAppSyncAdapter {
     private customResolvers;
     private debug;
+    private defaultPagination;
     operation: Operation;
     model: string;
     args: RequestProps;
@@ -16,7 +17,5 @@ export declare class PrismaAppSyncAdapter {
     private getInclude;
     private getSelect;
     private parseSelectionList;
-    private parseData;
-    private parseWhere;
     private parseOrderBy;
 }

dist/prisma-appsync/_constants.d.ts

@@ -1,6 +1,4 @@
 export declare const PrismaAppSyncOperations: string[];
-export declare const PrismaCombinators: string[];
-export declare const PrismaOperators: string[];
 export declare const PrismaOrderByArgs: string[];
 export declare const PrismaExclWords: string[];
 export declare const AuthModes: {

dist/prisma-appsync/_types.d.ts

@@ -8,13 +8,16 @@ export declare type Options = {
     connectionUrl: string;
     debug?: boolean;
     sanitize?: boolean;
+    defaultPagination?: number | false;
 };
 export declare type PrivateOptions = {
     connectionUrl: string;
     debug: boolean;
     sanitize: boolean;
+    defaultPagination: number | false;
 };
 export declare type AdapterOptions = {
+    defaultPagination: number | false;
     customResolvers: any;
     debug: boolean;
 };
@@ -33,6 +36,8 @@ export declare type RequestProps = {
     include?: any;
     where?: any;
     orderBy?: any;
+    skip?: number;
+    take?: number;
     [key: string]: any;
 };
 export declare type BeforeResolveProps = {

dist/prisma-appsync/index.d.ts

@@ -1,9 +1,9 @@
 import { PrismaClient } from '@prisma/client';
 import { PrismaAppSyncAdapter } from './_adapter';
 import { PrismaAppSyncResolver } from './_resolver';
-import { Options, AdapterOptions, RequestProps, AuthType, AuthIdentityProps, AuthRule, CustomResolverProps, AfterResolveProps, BeforeResolveProps } from './_types';
+import { Options, RequestProps, AuthType, AuthIdentityProps, AuthRule, CustomResolverProps, AfterResolveProps, BeforeResolveProps } from './_types';
 import { AuthModes, Operations, AuthActions } from './_constants';
-export { PrismaAppSyncAdapter, PrismaAppSyncResolver, Options, AdapterOptions, RequestProps, AuthType, AuthIdentityProps, AuthRule, CustomResolverProps, AfterResolveProps, BeforeResolveProps, AuthModes, Operations, AuthActions };
+export { PrismaAppSyncAdapter, PrismaAppSyncResolver, Options, RequestProps, AuthType, AuthIdentityProps, AuthRule, CustomResolverProps, AfterResolveProps, BeforeResolveProps, AuthModes, Operations, AuthActions };
 export declare class PrismaAppSync {
     adapter: PrismaAppSyncAdapter;
     resolver: PrismaAppSyncResolver;

dist/prisma-appsync/index.js

@@ -69,10 +69,12 @@ query {
 
 ### Querying multiple {{ model.pluralizedName }}
 
-Multiple {{ model.pluralizedName }} queries can take two inputs:
+Multiple {{ model.pluralizedName }} queries can take four inputs:
 
-- `where`: `{{ model.name }}WhereInput` An optional object type to filter the content based on a nested set of criteria.
+- `where`: `{{ model.name }}WhereFilterInput` An optional object type to filter the content based on a nested set of criteria.
 - `orderBy`: `{{ model.name }}OrderByInput` An optional object type to select which field(s) and order to sort the records on. Sorting can be in ascending order `ASC` or descending order `DESC`.
+- `skip`: `Int` An optional number that specifies how many of the returned objects in the list should be skipped.
+- `take`: `Int` An optional number that specifies how many objects should be returned in the list.
 
 **Standard query**
 
@@ -92,11 +94,14 @@ query {
 }
 ```
 
-**Standard query with where**
+**Standard query with offset pagination**
 
 ```graphql
 query {
-    list{{ model.pluralizedName }}(where: { {{ modelField.name }}: {{ modelField.sample | safe }} }) {
+    list{{ model.pluralizedName }}(
+        skip: 0
+        take: 25
+    ) {
         {% for field in model.fields -%}
         {% if field.relation and field.relation.kind === 'one' -%}
         {{ field.name }} # Relation to one
@@ -110,34 +115,33 @@ query {
 }
 ```
 
-**Advanced query using filters**
-
-<details><summary>List of all filters available</summary>
-<p>
+**Standard query with basic where filter**
 
 ```graphql
-{% for field in model.fields -%}
-{% if not field.relation -%}
-{{ field.name }}: {{ field.scalar }}
-    {{ field.name }}_equals: {{ field.scalar }}
-    {{ field.name }}_not: {{ field.scalar }}
-    {{ field.name }}_lt: {{ field.scalar }}
-    {{ field.name }}_lte: {{ field.scalar }}
-    {{ field.name }}_gt: {{ field.scalar }}
-    {{ field.name }}_gte: {{ field.scalar }}
-    {{ field.name }}_contains: {{ field.scalar }}
-    {{ field.name }}_startsWith: {{ field.scalar }}
-    {{ field.name }}_endsWith: {{ field.scalar }}
-{% endif -%}
-{% endfor %}
+query {
+    list{{ model.pluralizedName }}(where: {
+        {{ modelField.name }}: { equals: {{ modelField.sample | safe }}}
+    }) {
+        {% for field in model.fields -%}
+        {% if field.relation and field.relation.kind === 'one' -%}
+        {{ field.name }} # Relation to one
+        {% elseif  field.relation and field.relation.kind === 'many' %}
+        {{ field.name }} # Relation to many
+        {% else -%}
+        {{ field.name }}
+        {% endif -%}
+        {% endfor -%}
+    }
+}
 ```
 
-</p>
-</details>
+**Standard query with more advanced where filter**
 
 ```graphql
 query {
-    list{{ model.pluralizedName }}(where: { {{ modelField.name }}_startsWith: {{ modelField.sample | safe }} }) {
+    list{{ model.pluralizedName }}(where: {
+        {{ modelField.name }}: { not: { equals: {{ modelField.sample | safe }} } }
+    }) {
         {% for field in model.fields -%}
         {% if field.relation and field.relation.kind === 'one' -%}
         {{ field.name }} # Relation to one
@@ -394,7 +398,7 @@ mutation {
 
 Multiple {{ model.pluralizedName }} delete mutations can take one input:
 
-- `where`: `{{ model.name }}WhereInput!` A required object type specifying a field with a unique constraint (like {{ modelField.name }}).
+- `where`: `{{ model.name }}WhereFilterInput!` A required object type specifying a field with a unique constraint (like {{ modelField.name }}).
 
 **Standard deleteMany mutation**