@ttoss/graphql-api 0.4.5 → 0.4.7

package/README.md

@@ -140,7 +140,7 @@ _We inspired ourselves on [graphql-compose-relay](https://graphql-compose.github
 This packages provides the method `composeWithConnection` to create a connection type and queries for a given type, based on [graphql-compose-connection](https://graphql-compose.github.io/docs/plugins/plugin-connection.html) plugin and following the [Relay Connection Specification](https://facebook.github.io/relay/graphql/connections.htm).
 
 ```typescript
-import { composeWithConnection } from '@ttoss/appsync-api';
+import { composeWithConnection } from '@ttoss/graphql-api';
 
 AuthorTC.addResolver({
   name: 'findMany',
@@ -190,7 +190,7 @@ schemaComposer.Query.addFields({
 });
 ```
 
-When you `composeWithConnection` a type, it will add the resolver `connection` to the type, so you can add to `Query` or any other type:
+When you `composeWithConnection` a type composer, it will add the resolver `connection` to the type composer, so you can add to `Query` or any other type composer. For example:
 
 ```ts
 schemaComposer.Query.addFields({
@@ -204,6 +204,8 @@ The resolver `connection` has the following arguments based on the [Relay Connec
 - `after`: the cursor to start the query.
 - `last`: the number of nodes to return.
 - `before`: the cursor to start the query.
+- `limit`: the limit of nodes to return. It's the `first` or `last` argument plus one. It's used to know if there are more nodes to return to set `hasNextPage` or `hasPreviousPage` [PageInfo](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo) fields. For example, if `first` is `10`, `limit` will be `11`. If the resolver returns `11` nodes, the resolver will return `10` but it knows there are more nodes to return, so `hasNextPage` will be `true`.
+- `skip`: it's the `count` minus `last`. It only works on [backward pagination](https://relay.dev/graphql/connections.htm#sec-Backward-pagination-arguments).
 - `sort`: the sort option to use. It's the keys of the `sort` object. In our example, it's `ASC` and `DESC`.
 - `filter`: the filter to use. It'll exist if you add the `filter` to `findManyResolver` for example, the implementation below will add the `filter` argument with the `name` and `book` fields:
 
@@ -249,10 +251,14 @@ The resolver that will be used to find the nodes. It receives the following argu
         after?: string;
         last?: number;
         before?: string;
+        /**
+         * It's the `first` or `last` argument plus one.
+         */
+        limit: number;
         /**
          * The `filter` argument, if provided on the query.
          */
-        filter: {
+        filter?: {
           name: string;
           book: string;
         };
@@ -278,6 +284,8 @@ The resolver that will be used to find the nodes. It receives the following argu
 
 #### `countResolver`
 
+The resolver that will be used to count the nodes.
+
 #### `sort`
 
 It's an object that defines the sort options. Each key is the sort name and the value is an object with the following properties:

package/dist/cli.js

@@ -37,7 +37,11 @@ var import_npmlog = __toESM(require("npmlog"));
 var import_yargs = __toESM(require("yargs"));
 var logPrefix = "graphql-api";
 (0, import_ts_node.register)({
-  transpileOnly: true
+  transpileOnly: true,
+  compilerOptions: {
+    module: "NodeNext",
+    moduleResolution: "NodeNext"
+  }
 });
 var argv = (0, import_yargs.default)(process.argv.slice(2)).argv;
 (async () => {

package/dist/esm/cli.js

@@ -2,8 +2,8 @@
 import { __require } from "./chunk-O4CP4YC5.js";
 
 // src/cli.ts
-import * as fs from "fs";
-import * as path from "path";
+import * as fs from "node:fs";
+import * as path from "node:path";
 import * as typescriptPlugin from "@graphql-codegen/typescript";
 import { codegen } from "@graphql-codegen/core";
 import { parse } from "graphql";
@@ -12,7 +12,11 @@ import log from "npmlog";
 import yargs from "yargs";
 var logPrefix = "graphql-api";
 register({
-  transpileOnly: true
+  transpileOnly: true,
+  compilerOptions: {
+    module: "NodeNext",
+    moduleResolution: "NodeNext"
+  }
 });
 var argv = yargs(process.argv.slice(2)).argv;
 (async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/graphql-api",
-  "version": "0.4.5",
+  "version": "0.4.7",
   "description": "A library for building GraphQL APIs using ttoss ecosystem.",
   "author": "ttoss",
   "contributors": [
@@ -14,15 +14,15 @@
   "exports": {
     ".": {
       "import": "./dist/esm/index.js",
-      "require": "./dist/index.js"
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     },
     "./shield": {
       "import": "./dist/esm/shield.js",
-      "require": "./dist/shield.js"
+      "require": "./dist/shield.js",
+      "types": "./dist/shield.d.ts"
     }
   },
-  "main": "dist/index.js",
-  "module": "dist/esm/index.js",
   "bin": {
     "ttoss-graphql-api": "./bin/cli.js"
   },
@@ -31,7 +31,6 @@
     "src"
   ],
   "sideEffects": false,
-  "typings": "dist/index.d.ts",
   "dependencies": {
     "@graphql-codegen/core": "^4.0.0",
     "@graphql-codegen/typescript": "^4.0.1",
@@ -40,7 +39,7 @@
     "graphql-middleware": "^6.1.35",
     "graphql-shield": "^7.6.5",
     "npmlog": "^7.0.1",
-    "ts-node": "^10.9.1",
+    "ts-node": "^10.9.2",
     "yargs": "^17.7.2"
   },
   "peerDependencies": {
@@ -51,7 +50,7 @@
     "graphql": "^16.8.1",
     "jest": "^29.7.0",
     "tsup": "^8.0.1",
-    "@ttoss/config": "^1.31.2"
+    "@ttoss/config": "^1.31.4"
   },
   "keywords": [
     "api",
@@ -61,16 +60,6 @@
     "access": "public",
     "provenance": true
   },
-  "typesVersions": {
-    "*": {
-      ".": [
-        "./dist/index.d.ts"
-      ],
-      "shield": [
-        "./dist/shield.d.ts"
-      ]
-    }
-  },
   "scripts": {
     "build": "tsup",
     "test": "jest"

package/src/cli.ts

@@ -11,6 +11,10 @@ const logPrefix = 'graphql-api';
 
 register({
   transpileOnly: true,
+  compilerOptions: {
+    module: 'NodeNext',
+    moduleResolution: 'NodeNext',
+  },
 });
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -34,11 +38,9 @@ const argv: any = yargs(process.argv.slice(2)).argv;
     }
 
     // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const { schemaComposer } = require(path.resolve(
-      process.cwd(),
-      'src',
-      'schemaComposer.ts'
-    ));
+    const { schemaComposer } = require(
+      path.resolve(process.cwd(), 'src', 'schemaComposer.ts')
+    );
 
     const sdl = schemaComposer.toSDL();