feat: v6 (#401)

BREAKING CHANGE: remove `code` and `headers` properties that were previously deprecated BREAKING CHANGE: switch package to ESM instead of CommonJS
octokit · Feb 23, 2024 · d73dee6 · d73dee6
1 parent d15db41
commit d73dee6
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 127 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -4,13 +4,14 @@
   "publishConfig": {
     "access": "public"
   },
+  "type": "module",
   "description": "Error class for Octokit request errors",
   "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"
   },
   "repository": "github:octokit/request-error.js",
   "keywords": [
@@ -22,15 +23,12 @@
   "author": "Gregor Martynus (https://github.com/gr2m)",
   "license": "MIT",
   "dependencies": {
-    "@octokit/types": "^12.0.0",
-    "deprecation": "^2.0.0",
-    "once": "^1.4.0"
+    "@octokit/types": "^12.0.0"
   },
   "devDependencies": {
-    "@octokit/tsconfig": "^2.0.0",
+    "@octokit/tsconfig": "^3.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": "^20.0.0",
-    "@types/once": "^1.4.0",
     "esbuild": "^0.20.0",
     "glob": "^10.2.6",
     "jest": "^29.0.0",
@@ -39,14 +37,21 @@
     "typescript": "^5.0.0"
   },
   "jest": {
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
     "transform": {
       "^.+\\.(ts|tsx)$": [
         "ts-jest",
         {
-          "tsconfig": "test/tsconfig.test.json"
+          "tsconfig": "test/tsconfig.test.json",
+          "useESM": true
         }
       ]
     },
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.js$": "$1"
+    },
     "coverageThreshold": {
       "global": {
         "statements": 100,

diff --git a/scripts/build.mjs b/scripts/build.mjs
@@ -43,7 +43,7 @@ async function main() {
       bundle: true,
       platform: "node",
       target: "node18",
-      format: "cjs",
+      format: "esm",
       ...sharedOptions,
     }),
     // Build an ESM browser bundle
@@ -74,10 +74,18 @@ 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: {
+          ".": {
+            node: {
+              types: "./dist-types/index.d.ts",
+              import: "./dist-node/index.js",
+            },
+            browser: {
+              types: "./dist-types/index.d.ts",
+              import: "./dist-web/index.js",
+            }
+          }
+        },
         sideEffects: false,
         unpkg: "dist-web/index.js",
       },

diff --git a/src/index.ts b/src/index.ts
@@ -1,14 +1,5 @@
-import { Deprecation } from "deprecation";
-import once from "once";
-const logOnceCode = once((deprecation: any) => console.warn(deprecation));
-const logOnceHeaders = once((deprecation: any) => console.warn(deprecation));
-
-import type {
-  RequestOptions,
-  ResponseHeaders,
-  OctokitResponse,
-} from "@octokit/types";
-import type { RequestErrorOptions } from "./types";
+import type { RequestOptions, OctokitResponse } from "@octokit/types";
+import type { RequestErrorOptions } from "./types.js";
 
 /**
  * Error with extra properties to help with debugging
@@ -21,25 +12,11 @@ export class RequestError extends Error {
    */
   status: number;
 
-  /**
-   * http status code
-   *
-   * @deprecated `error.code` is deprecated in favor of `error.status`
-   */
-  code!: number;
-
   /**
    * Request options that lead to the error.
    */
   request: RequestOptions;
 
-  /**
-   * error response headers
-   *
-   * @deprecated `error.headers` is deprecated in favor of `error.response.headers`
-   */
-  headers!: ResponseHeaders;
-
   /**
    * Response object if a response was received
    */
@@ -60,15 +37,9 @@ export class RequestError extends Error {
 
     this.name = "HttpError";
     this.status = statusCode;
-    let headers: ResponseHeaders;
-
-    if ("headers" in options && typeof options.headers !== "undefined") {
-      headers = options.headers;
-    }
 
     if ("response" in options) {
       this.response = options.response;
-      headers = options.response.headers;
     }
 
     // redact request credentials without mutating original request options
@@ -91,27 +62,5 @@ export class RequestError extends Error {
       .replace(/\baccess_token=\w+/g, "access_token=[REDACTED]");
 
     this.request = requestCopy;
-
-    // deprecations
-    Object.defineProperty(this, "code", {
-      get() {
-        logOnceCode(
-          new Deprecation(
-            "[@octokit/request-error] `error.code` is deprecated, use `error.status`.",
-          ),
-        );
-        return statusCode;
-      },
-    });
-    Object.defineProperty(this, "headers", {
-      get() {
-        logOnceHeaders(
-          new Deprecation(
-            "[@octokit/request-error] `error.headers` is deprecated, use `error.response.headers`.",
-          ),
-        );
-        return headers || {};
-      },
-    });
   }
 }
diff --git a/src/types.ts b/src/types.ts
@@ -1,16 +1,6 @@
-import type {
-  RequestOptions,
-  ResponseHeaders,
-  OctokitResponse,
-} from "@octokit/types";
+import type { RequestOptions, OctokitResponse } from "@octokit/types";
 
-export type RequestErrorOptions =
-  | {
-      /** @deprecated set `response` instead */
-      headers?: ResponseHeaders;
-      request: RequestOptions;
-    }
-  | {
-      response: OctokitResponse<unknown>;
-      request: RequestOptions;
-    };
+export type RequestErrorOptions = {
+  response?: OctokitResponse<unknown>;
+  request: RequestOptions;
+};
diff --git a/test/request-error.test.ts b/test/request-error.test.ts
@@ -1,12 +1,18 @@
-import { RequestError } from "../src";
-import type { RequestErrorOptions } from "../src/types";
+import { RequestError } from "../src/index.js";
+import type { RequestErrorOptions } from "../src/types.js";
 
 const mockOptions: RequestErrorOptions = {
   request: {
     method: "GET",
     url: "https://api.github.com/",
     headers: {},
   },
+  response: {
+    headers: {},
+    status: 200,
+    url: "https://api.github.com/",
+    data: {},
+  },
 };
 
 describe("RequestError", () => {
@@ -130,27 +136,4 @@ describe("RequestError", () => {
       url: "https://api.github.com/",
     });
   });
-
-  test("deprecates .code", () => {
-    global.console.warn = jest.fn();
-    expect(new RequestError("test", 123, mockOptions).code).toEqual(123);
-    expect(new RequestError("test", 404, mockOptions).code).toEqual(404);
-    expect(console.warn).toHaveBeenCalledTimes(1);
-  });
-
-  test("deprecates .headers", () => {
-    global.console.warn = jest.fn();
-    expect(new RequestError("test", 123, mockOptions).headers).toStrictEqual(
-      {},
-    );
-    expect(
-      new RequestError("test", 404, { ...mockOptions, headers: { foo: "bar" } })
-        .headers,
-    ).toStrictEqual({ foo: "bar" });
-    expect(
-      new RequestError("test", 404, { ...mockOptions, headers: undefined })
-        .headers,
-    ).toStrictEqual({});
-    expect(console.warn).toHaveBeenCalledTimes(1);
-  });
 });
diff --git a/test/tsconfig.test.json b/test/tsconfig.test.json
@@ -2,8 +2,7 @@
   "extends": "../tsconfig.json",
   "compilerOptions": {
     "emitDeclarationOnly": false,
-    "noEmit": true,
-    "verbatimModuleSyntax": false
+    "noEmit": true
   },
   "include": ["src/**/*"]
 }