feat: v5 (#175)

* maint: spelling (#167)

Signed-off-by: Josh Soref <[email protected]>

BREAKING CHANGE: change spelling of `paginateGraphql` export to `paginateGraphQL`

* feat: package is now ESM

BREAKING CHANGE: package is now ESM

* fix: add return type annotation

---------

Co-authored-by: Josh Soref <[email protected]>

Author: wolfy1339

CONTRIBUTING.md

@@ -56,6 +56,6 @@ Only one version number is bumped at a time, the highest version change trumps t
 Besides publishing a new version to npm, semantic-release also creates a git tag and release
 on GitHub, generates changelogs from the commit messages and puts them into the release notes.
 
-Before the publish it runs the `npm run build` script which creates a `pkg/` folder with distributions for browsers, node and Typescript definitions. The contents of the `pkg/` folder are published to the npm registry.
+Before the publish it runs the `npm run build` script which creates a `pkg/` folder with distributions for browsers, node and TypeScript definitions. The contents of the `pkg/` folder are published to the npm registry.
 
 If the pull request looks good but does not follow the commit conventions, use the <kbd>Squash & merge</kbd> button.

README.md

@@ -18,7 +18,7 @@ Load `@octokit/plugin-paginate-graphql` and [`@octokit/core`](https://github.com
 ```html
 <script type="module">
   import { Octokit } from "https://esm.sh/@octokit/core";
-  import { paginateGraphql } from "https://esm.sh/@octokit/plugin-paginate-graphql";
+  import { paginateGraphQL } from "https://esm.sh/@octokit/plugin-paginate-graphql";
 </script>
 ```
 
@@ -30,16 +30,16 @@ Node
 Install with `npm install @octokit/core @octokit/plugin-paginate-graphql`. Optionally replace `@octokit/core` with a core-compatible module
 
 ```js
-const { Octokit } = require("@octokit/core");
-const { paginateGraphql } = require("@octokit/plugin-paginate-graphql");
+import { Octokit } from "@octokit/core";
+import { paginateGraphQL } from "@octokit/plugin-paginate-graphql";
 ```
 
 </td></tr>
 </tbody>
 </table>
 
 ```js
-const MyOctokit = Octokit.plugin(paginateGraphql);
+const MyOctokit = Octokit.plugin(paginateGraphQL);
 const octokit = new MyOctokit({ auth: "secret123" });
 
 const { repository } = await octokit.graphql.paginate(
@@ -61,18 +61,18 @@ const { repository } = await octokit.graphql.paginate(
 console.log(`Found ${repository.issues.nodes.length} issues!`);
 ```
 
-There are two convetions this plugin relies on:
+There are two conventions this plugin relies on:
 
 1. The name of the cursor variable must be `$cursor`
 2. You must include a valid `pageInfo` object in the paginated resource (see [Pagination Direction](#pagination-direction) for more info on what is considered valid)
 
 ## `octokit.graphql.paginate()`
 
-The `paginateGraphql` plugin adds a new `octokit.graphql.paginate()` method which accepts a query with a single `$cursor` variable that is used to paginate.
+The `paginateGraphQL` plugin adds a new `octokit.graphql.paginate()` method which accepts a query with a single `$cursor` variable that is used to paginate.
 
 The query gets passed over to the `octokit.graphql()`-function. The response is then scanned for the required `pageInfo`-object. If `hasNextPage` is `true`, it will automatically use the `endCursor` to execute the next query until `hasNextPage` is `false`.
 
-While iterating, it ongoingly merges all `nodes` and/or `edges` of all responses and returns a combined response in the end.
+While iterating, it continually merges all `nodes` and/or `edges` of all responses and returns a combined response in the end.
 
 > **Warning**
 > Please note that this plugin only supports pagination of a single resource - so you can **not** execute queries with parallel or nested pagination. You can find more details in [the chapter below](#unsupported-nested-pagination).
@@ -159,7 +159,7 @@ await octokit.graphql.paginate(
 
 ### Pagination Direction
 
-You can control the pagination direction by the properties deinfed in the `pageInfo` resource.
+You can control the pagination direction by the properties defined in the `pageInfo` resource.
 
 For a forward pagination, use:
 
@@ -183,7 +183,7 @@ If you provide all 4 properties in a `pageInfo`, the plugin will default to forw
 
 ### Unsupported: Nested pagination
 
-Nested pagination with GraphlQL is complicated, so the following **is not supported**:
+Nested pagination with GraphQL is complicated, so the following **is not supported**:
 
 ```js
 await octokit.graphql.paginate((cursor) => {
@@ -218,7 +218,7 @@ There is a great video from GitHub Universe 2019 [Advanced patterns for GitHub's
 
 ### TypeScript Support
 
-You can type the response of the `paginateGraphql()` and `iterator()` functions like this:
+You can type the response of the `paginateGraphQL()` and `iterator()` functions like this:
 
 ```ts
 await octokit.graphql.paginate<RepositoryIssueResponseType>((cursor) => {

package-lock.json

@@ -3,18 +3,18 @@
   "publishConfig": {
     "access": "public"
   },
+  "type": "module",
   "version": "0.0.0-development",
   "description": "Octokit plugin to paginate GraphQL API endpoint responses",
-  "main": "index.js",
   "scripts": {
     "build": "node scripts/build.mjs && tsc -p tsconfig.json",
     "lint": "prettier --check '{src,test}/**/*' README.md package.json",
     "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json",
     "pretest": "npm run -s lint",
-    "test": "jest --coverage",
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage",
     "test:typescript": "npx tsc --noEmit --declaration --noUnusedLocals --esModuleInterop --strict test/typescript-validate.ts",
-    "test:watch": "jest --watch",
-    "test:e2e": "jest --testRegex test/*.e2e.ts"
+    "test:watch": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --watch",
+    "test:e2e": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --testRegex test/*.e2e.ts"
   },
   "repository": "github:octokit/plugin-paginate-graphql.js",
   "keywords": [
@@ -25,12 +25,12 @@
   ],
   "license": "MIT",
   "peerDependencies": {
-    "@octokit/core": ">=5"
+    "@octokit/core": ">=6"
   },
   "devDependencies": {
-    "@octokit/core": "^5.0.0",
-    "@octokit/plugin-rest-endpoint-methods": "^10.0.0",
-    "@octokit/tsconfig": "^2.0.0",
+    "@octokit/core": "^6.0.0",
+    "@octokit/plugin-rest-endpoint-methods": "^11.0.0",
+    "@octokit/tsconfig": "^3.0.0",
     "@types/fetch-mock": "^7.3.1",
     "@types/jest": "^29.0.0",
     "@types/node": "^20.0.0",
@@ -46,11 +46,15 @@
   },
   "jest": {
     "preset": "ts-jest",
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
     "transform": {
       "^.+\\.(ts|tsx)$": [
         "ts-jest",
         {
-          "tsconfig": "test/tsconfig.test.json"
+          "tsconfig": "test/tsconfig.test.json",
+          "useESM": true
         }
       ]
     },
@@ -64,6 +68,9 @@
         "functions": 100,
         "lines": 100
       }
+    },
+    "moduleNameMapper": {
+      "^(.+)\\.jsx?$": "$1"
     }
   },
   "release": {

package.json

@@ -75,9 +75,13 @@ async function main() {
         ...pkg,
         files: ["dist-*/**", "bin/**"],
         main: "dist-node/index.js",
-        browser: "dist-web/index.js",
         types: "dist-types/index.d.ts",
-        module: "dist-src/index.js",
+        exports: {
+          ".": {
+            types: "./dist-types/index.d.ts",
+            import: "./dist-node/index.js",
+          }
+        },
         sideEffects: false,
       },
       null,

scripts/build.mjs

@@ -1,4 +1,4 @@
-import type { CursorValue, PageInfoContext } from "./page-info";
+import type { CursorValue, PageInfoContext } from "./page-info.js";
 
 // Todo: Add link to explanation
 const generateMessage = (path: string[], cursorValue: CursorValue): string =>

src/errors.ts

@@ -1,5 +1,5 @@
-import type { PageInfoContext } from "./page-info";
-import { findPaginatedResourcePath, get } from "./object-helpers";
+import type { PageInfoContext } from "./page-info.js";
+import { findPaginatedResourcePath, get } from "./object-helpers.js";
 
 const extractPageInfos = (responseData: any): PageInfoContext => {
   const pageInfoPath = findPaginatedResourcePath(responseData);