getta 1.0.6 → 1.0.8

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "getta",
   "description": "An isomorphic rest client based on the Fetch API.",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "author": "Dylan Aubrey",
   "license": "MIT",
   "homepage": "https://github.com/badbatch/getta",
-  "repository": "https://github.com/badbatch/getta",
+  "repository": "badbatch/getta",
   "bugs": "https://github.com/badbatch/getta/issues",
   "type": "module",
   "main": "./dist/cjs/index.cjs",
@@ -25,96 +25,51 @@
     "access": "public"
   },
   "dependencies": {
-    "cacheability": "^4.0.20",
-    "query-string": "^8.1.0",
-    "ts-md5": "^1.3.1"
-  },
-  "peerDependencies": {
-    "@babel/runtime": "<8",
-    "core-js": "<4",
-    "lodash-es": "<5"
+    "@types/lodash-es": "^4.17.12",
+    "cacheability": "^4.0.27",
+    "core-js": "^3.39.0",
+    "lodash-es": "^4.17.21",
+    "query-string": "^9.1.1",
+    "ts-md5": "^1.3.1",
+    "type-fest": "^4.26.1"
   },
   "devDependencies": {
-    "@babel/cli": "^7.23.0",
-    "@babel/core": "^7.23.2",
-    "@babel/eslint-parser": "^7.22.15",
-    "@babel/plugin-proposal-decorators": "^7.23.3",
-    "@babel/plugin-syntax-import-assertions": "^7.22.5",
-    "@babel/plugin-transform-class-properties": "^7.23.3",
-    "@babel/plugin-transform-export-namespace-from": "^7.23.4",
-    "@babel/plugin-transform-modules-commonjs": "^7.23.3",
-    "@babel/plugin-transform-runtime": "^7.23.2",
-    "@babel/preset-env": "^7.23.2",
-    "@babel/preset-react": "^7.22.15",
-    "@babel/preset-typescript": "^7.23.2",
-    "@babel/runtime": "^7.23.2",
-    "@cachemap/core": "^5.0.8",
-    "@cachemap/map": "^5.0.6",
-    "@commitlint/cli": "^17.7.2",
-    "@commitlint/config-conventional": "^17.7.0",
-    "@commitlint/prompt-cli": "^17.7.2",
+    "@cachemap/core": "^5.2.2",
+    "@cachemap/map": "^5.0.8",
+    "@commitlint/cli": "^19.5.0",
     "@jest/globals": "^29.7.0",
-    "@repodog/babel-config": "^1.1.11",
-    "@repodog/cli": "^1.4.1",
-    "@repodog/commitlint-config": "^1.1.6",
-    "@repodog/eslint-config": "^1.1.19",
-    "@repodog/eslint-config-jest": "^1.1.10",
-    "@repodog/jest-config": "^1.1.11",
-    "@repodog/markdownlint-config": "^1.1.5",
-    "@repodog/prettier-config": "^1.1.5",
-    "@repodog/rollup-config": "^1.1.8",
-    "@repodog/syncpack-config": "^1.2.3",
-    "@repodog/ts-config": "^1.3.0",
-    "@rollup/plugin-babel": "^6.0.4",
-    "@rollup/plugin-commonjs": "^25.0.7",
-    "@rollup/plugin-image": "^3.0.3",
-    "@rollup/plugin-json": "^6.0.1",
-    "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@types/jest": "^25.2.3",
-    "@types/lodash-es": "^4.17.9",
-    "@types/node": "^20.11.0",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "babel-jest": "^29.7.0",
-    "babel-plugin-codegen": "^4.1.5",
-    "babel-plugin-macros": "^3.1.0",
-    "core-js": "^3.33.0",
-    "cts-types": "^0.0.6",
-    "del-cli": "^5.1.0",
-    "eslint": "^8.51.0",
-    "eslint-config-prettier": "^8.10.0",
-    "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-import": "^2.28.1",
-    "eslint-plugin-jest": "^27.4.2",
-    "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-sort-class-members": "^1.19.0",
-    "eslint-plugin-sort-destructure-keys": "^1.5.0",
-    "eslint-plugin-sort-keys-fix": "^1.1.2",
-    "eslint-plugin-typescript-sort-keys": "^2.3.0",
-    "eslint-plugin-unicorn": "^46.0.1",
-    "fetch-mocked": "^0.0.21",
+    "@repodog/cli": "^1.6.36",
+    "@repodog/commitlint-config": "^19.0.3",
+    "@repodog/eslint-config": "^9.0.7",
+    "@repodog/eslint-config-jest": "^9.0.3",
+    "@repodog/jest-config": "^29.0.3",
+    "@repodog/markdownlint-config": "^1.2.4",
+    "@repodog/prettier-config": "^3.0.2",
+    "@repodog/rollup-config": "^4.0.3",
+    "@repodog/swc-config": "^1.0.3",
+    "@repodog/syncpack-config": "^13.0.2",
+    "@repodog/ts-config": "^5.0.4",
+    "@rollup/plugin-swc": "^0.3.0",
+    "@swc/core": "^1.7.26",
+    "@swc/jest": "^0.2.36",
+    "@types/jest": "^29.5.13",
+    "@types/node": "^22.8.7",
+    "cts-types": "^0.0.7",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.11.0",
+    "fetch-mocked": "^0.0.26",
     "generate-changelog": "^1.8.0",
-    "husky": "^8.0.3",
-    "identity-obj-proxy": "^3.0.0",
+    "husky": "^9.1.6",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-environment-node": "^29.7.0",
-    "jest-mock": "^29.7.0",
-    "lodash-es": "^4.17.21",
-    "markdownlint-cli": "^0.34.0",
-    "node-fetch": "^3.3.2",
-    "prettier": "^2.8.8",
-    "rollup": "^3.29.4",
-    "rollup-plugin-analyzer": "^4.0.0",
-    "rollup-plugin-copy": "^3.5.0",
-    "rollup-plugin-sourcemaps": "^0.6.3",
-    "suppress-experimental-warnings": "^1.1.17",
-    "syncpack": "^12.3.0",
-    "type-fest": "^3.13.1",
-    "typescript": "^5.2.2",
-    "zod": "^3.22.4"
+    "markdownlint-cli2": "^0.14.0",
+    "prettier": "^3.3.3",
+    "rollup": "^4.22.4",
+    "suppress-experimental-warnings": "^2.0.0",
+    "syncpack": "^13.0.0",
+    "typescript": "^5.6.2",
+    "zod": "^3.23.8"
   },
   "keywords": [
     "api-client",
@@ -126,17 +81,18 @@
     "build": "pnpm run clean:dist && pnpm run compile",
     "clean:deps": "del-cli ./node_modules",
     "clean:dist": "del-cli ./dist",
-    "commit": "commit",
     "compile": "pnpm run /^compile:.*/",
     "compile:cjs": "MODULE_SYSTEM=cjs rollup -c ./rollup.config.cjs",
     "compile:esm": "rollup -c ./rollup.config.cjs",
     "compile:types": "tsc --project ./tsconfig.build.json && cts-types build dist/types/esm dist/types/cjs",
     "cut:changelog": "changelog",
-    "cut:post-version": "pnpm run build",
-    "lint": "eslint . --ext .ts,.cjs",
+    "installActivateMise": "sh shellScripts/installActivateMise.sh",
+    "lint": "pnpm run /^lint:.*/",
+    "lint:code": "eslint .",
+    "lint:docs": "markdownlint-cli2 --config \".markdownlint.json\" \"**/*.md\" \"!**/node_modules/**\"",
     "repodog": "repodog",
     "syncpack": "syncpack format && syncpack list-mismatches && syncpack lint-semver-ranges",
-    "test": "node --require=suppress-experimental-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test": "COMPILER=swc node --require=suppress-experimental-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
     "type-check": "tsc --noEmit",
     "validate": "pnpm run syncpack && pnpm run build && pnpm run lint && pnpm run type-check && pnpm run test"
   }

package/shellScripts/installActivateMise.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e  # Exit immediately if a command exits with a non-zero status.
+
+if ! [ "$(command -v mise)" ]; then
+  curl -sSf https://mise.run | sh
+  mise activate >/dev/null
+fi
+
+if [[ -z "${CI}" ]]; then
+  mise install
+fi

package/src/__testUtils__/helpers/index.ts

@@ -38,7 +38,7 @@ export const getCache = () => {
 
 export const buildTestEndpoint = (
   path: string,
-  { pathTemplateData = defaultPathTemplateData, queryParams }: RequestOptions = {}
+  { pathTemplateData = defaultPathTemplateData, queryParams }: RequestOptions = {},
 ) =>
   buildEndpoint(basePath, path, {
     optionalPathTemplateRegExp: OPTIONAL_PATH_TEMPLATE_REGEX,

package/src/constants.ts

@@ -1,10 +1,10 @@
-import type { PlainObject } from './types.ts';
+import { type PlainObject } from './types.ts';
 
-export const ARRAY_BUFFER_FORMAT = 'arrayBuffer' as const;
-export const BLOB_FORMAT = 'blob' as const;
-export const FORM_DATA_FORMAT = 'formData' as const;
-export const JSON_FORMAT = 'json' as const;
-export const TEXT_FORMAT = 'text' as const;
+export const ARRAY_BUFFER_FORMAT = 'arrayBuffer';
+export const BLOB_FORMAT = 'blob';
+export const FORM_DATA_FORMAT = 'formData';
+export const JSON_FORMAT = 'json';
+export const TEXT_FORMAT = 'text';
 
 export const STREAM_READERS = {
   ARRAY_BUFFER_FORMAT,
@@ -15,10 +15,10 @@ export const STREAM_READERS = {
 };
 
 export const DEFAULT_BODY_PARSER = (body: PlainObject) => body;
-export const DEFAULT_FETCH_TIMEOUT = 5000 as const;
+export const DEFAULT_FETCH_TIMEOUT = 5000;
 export const DEFAULT_HEADERS = { 'content-type': 'application/json' };
-export const DEFAULT_MAX_REDIRECTS = 5 as const;
-export const DEFAULT_MAX_RETRIES = 3 as const;
+export const DEFAULT_MAX_REDIRECTS = 5;
+export const DEFAULT_MAX_RETRIES = 3;
 export const DEFAULT_PATH_TEMPLATE_REGEX = /({type})|({id})|({id,\+})|({brief\|standard})/g;
 export const OPTIONAL_PATH_TEMPLATE_REGEX = /({\w+\?})/g;
 export const DEFAULT_RATE_LIMIT = 50;
@@ -37,27 +37,27 @@ export const RESOURCE_NOT_FOUND_ERROR = 'The requested resource could not been f
 
 export const FETCH_TIMEOUT_ERROR = 'The request timed out. Getta did not get a response within';
 
-export const GET_METHOD = 'get' as const;
-export const POST_METHOD = 'post' as const;
-export const PUT_METHOD = 'put' as const;
-export const DELETE_METHOD = 'delete' as const;
+export const GET_METHOD = 'get';
+export const POST_METHOD = 'post';
+export const PUT_METHOD = 'put';
+export const DELETE_METHOD = 'delete';
 
 export const FETCH_METHODS = [GET_METHOD, POST_METHOD, PUT_METHOD, DELETE_METHOD];
 
-export const INFORMATION_REPSONSE = 'information' as const;
-export const SUCCESSFUL_REPSONSE = 'successful' as const;
-export const REDIRECTION_REPSONSE = 'redirection' as const;
-export const CLIENT_ERROR_REPSONSE = 'clientError' as const;
-export const SERVER_ERROR_REPSONSE = 'serverError' as const;
+export const INFORMATION_REPSONSE = 'information';
+export const SUCCESSFUL_REPSONSE = 'successful';
+export const REDIRECTION_REPSONSE = 'redirection';
+export const CLIENT_ERROR_REPSONSE = 'clientError';
+export const SERVER_ERROR_REPSONSE = 'serverError';
 
-export const NOT_MODIFIED_STATUS_CODE = 304 as const;
-export const NOT_FOUND_STATUS_CODE = 404 as const;
+export const NOT_MODIFIED_STATUS_CODE = 304;
+export const NOT_FOUND_STATUS_CODE = 404;
 
-export const COOKIE_HEADER = 'Cookie' as const;
-export const ETAG_HEADER = 'ETag' as const;
-export const LOCATION_HEADER = 'Location' as const;
-export const IF_NONE_MATCH_HEADER = 'If-None-Match' as const;
-export const CACHE_CONTROL_HEADER = 'Cache-Control' as const;
+export const COOKIE_HEADER = 'Cookie';
+export const ETAG_HEADER = 'ETag';
+export const LOCATION_HEADER = 'Location';
+export const IF_NONE_MATCH_HEADER = 'If-None-Match';
+export const CACHE_CONTROL_HEADER = 'Cache-Control';
 
-export const REQUEST_SENT = 'request_sent' as const;
-export const RESPONSE_RECEIVED = 'response_received' as const;
+export const REQUEST_SENT = 'request_sent';
+export const RESPONSE_RECEIVED = 'response_received';

package/src/helpers/buildEndpoint/index.ts

@@ -10,7 +10,7 @@ export const buildEndpoint = (
     pathTemplateData,
     pathTemplateRegExp,
     queryParams,
-  }: BuildEndpointOptions
+  }: BuildEndpointOptions,
 ) => {
   const pathJoiner = basePath.endsWith('/') || path.startsWith('/') ? '' : '/';
   let endpoint = `${basePath}${pathJoiner}${path}`;

package/src/helpers/defaultPathTemplateCallback/index.test.ts

@@ -5,13 +5,13 @@ import { defaultPathTemplateCallback } from './index.ts';
 describe('defaultPathTemplateCallback', () => {
   it('SHOULD populate the path template correctly', () => {
     expect(defaultPathTemplateCallback(defaultPath, defaultPathTemplateData, DEFAULT_PATH_TEMPLATE_REGEX)).toBe(
-      '/direct/rest/content/catalog/product/136-7317?format=standard'
+      '/direct/rest/content/catalog/product/136-7317?format=standard',
     );
   });
 
   it('SHOULD populate the path template correctly when the data value is a zero', () => {
     expect(
-      defaultPathTemplateCallback(defaultPath, { ...defaultPathTemplateData, 'id,+': 0 }, DEFAULT_PATH_TEMPLATE_REGEX)
+      defaultPathTemplateCallback(defaultPath, { ...defaultPathTemplateData, 'id,+': 0 }, DEFAULT_PATH_TEMPLATE_REGEX),
     ).toBe('/direct/rest/content/catalog/product/0?format=standard');
   });
 });

package/src/helpers/defaultPathTemplateCallback/index.ts

@@ -1,7 +1,7 @@
 export const defaultPathTemplateCallback = (
   pathTemplate: string,
   data: Record<string, string | number | boolean>,
-  pathTemplateRegExp: RegExp
+  pathTemplateRegExp: RegExp,
 ) => {
   const dataKeys = Object.keys(data);
 

package/src/main.test.ts

@@ -50,7 +50,7 @@ describe('Getta', () => {
               pathTemplateData: pathTemplateDataWithoutID,
             },
           ],
-        }
+        },
       );
     });
 
@@ -76,7 +76,7 @@ describe('Getta', () => {
         expect(response).toEqual(
           expect.objectContaining({
             data: PRD_136_7317.body,
-          })
+          }),
         );
       });
     });
@@ -99,7 +99,7 @@ describe('Getta', () => {
         expect(response).toEqual(
           expect.objectContaining({
             data: PRD_136_7317.body,
-          })
+          }),
         );
       });
     });
@@ -125,7 +125,7 @@ describe('Getta', () => {
           expect(response).toEqual(
             expect.objectContaining({
               data: PRD_136_7317.body,
-            })
+            }),
           );
         });
       });
@@ -146,7 +146,7 @@ describe('Getta', () => {
           beforeEach(async () => {
             mockedFetch.mockGetOnce(
               { headers: { [consts.IF_NONE_MATCH_HEADER]: defaultEtag }, url: buildTestEndpoint(defaultPath) },
-              { headers: defaultHeaders, status: 304 }
+              { headers: defaultHeaders, status: 304 },
             );
 
             response = await restClient.getProduct({ pathTemplateData: idPathTemplateData });
@@ -160,7 +160,7 @@ describe('Getta', () => {
             expect(response).toEqual(
               expect.objectContaining({
                 data: PRD_136_7317.body,
-              })
+              }),
             );
           });
         });
@@ -169,7 +169,7 @@ describe('Getta', () => {
           beforeEach(async () => {
             mockedFetch.mockGetOnce(
               { headers: { [consts.IF_NONE_MATCH_HEADER]: defaultEtag }, url: buildTestEndpoint(defaultPath) },
-              { body: PRD_136_7317.body, headers: defaultHeaders }
+              { body: PRD_136_7317.body, headers: defaultHeaders },
             );
 
             response = await restClient.getProduct({ pathTemplateData: idPathTemplateData });
@@ -183,7 +183,7 @@ describe('Getta', () => {
             expect(response).toEqual(
               expect.objectContaining({
                 data: PRD_136_7317.body,
-              })
+              }),
             );
           });
         });
@@ -192,7 +192,7 @@ describe('Getta', () => {
           beforeEach(async () => {
             mockedFetch.mockGetOnce(
               { headers: { [consts.IF_NONE_MATCH_HEADER]: defaultEtag }, url: buildTestEndpoint(defaultPath) },
-              { status: 404 }
+              { status: 404 },
             );
 
             response = await restClient.getProduct({ pathTemplateData: idPathTemplateData });
@@ -206,7 +206,7 @@ describe('Getta', () => {
             expect(response).toEqual(
               expect.objectContaining({
                 errors: [new Error(consts.RESOURCE_NOT_FOUND_ERROR)],
-              })
+              }),
             );
           });
         });
@@ -219,7 +219,7 @@ describe('Getta', () => {
       beforeEach(async () => {
         mockedFetch.mockGet(
           { headers: { [consts.COOKIE_HEADER]: REDIRECT_COOKIE_FLAG }, url: '*' },
-          { headers: { ...defaultHeaders, [consts.LOCATION_HEADER]: basePath }, status: 301 }
+          { headers: { ...defaultHeaders, [consts.LOCATION_HEADER]: basePath }, status: 301 },
         );
 
         response = await restClient.getProduct({
@@ -236,7 +236,7 @@ describe('Getta', () => {
         expect(response).toEqual(
           expect.objectContaining({
             errors: [new Error(`${consts.MAX_REDIRECTS_EXCEEDED_ERROR} 5.`)],
-          })
+          }),
         );
       });
     });
@@ -247,7 +247,7 @@ describe('Getta', () => {
       beforeEach(async () => {
         mockedFetch.mockGet(
           { headers: { [consts.COOKIE_HEADER]: RETRY_COOKIE_FLAG }, url: buildTestEndpoint(defaultPath) },
-          { body: PRD_136_7317.body, status: 500 }
+          { body: PRD_136_7317.body, status: 500 },
         );
 
         response = await restClient.getProduct({
@@ -264,7 +264,7 @@ describe('Getta', () => {
         expect(response).toEqual(
           expect.objectContaining({
             errors: [new Error(`${consts.MAX_RETRIES_EXCEEDED_ERROR} 3.`)],
-          })
+          }),
         );
       });
     });
@@ -314,7 +314,7 @@ describe('Getta', () => {
         expect(response).toEqual(
           expect.objectContaining({
             errors: [new Error(`${consts.FETCH_TIMEOUT_ERROR} 100ms.`)],
-          })
+          }),
         );
       });
     });
@@ -334,7 +334,7 @@ describe('Getta', () => {
               method: consts.POST_METHOD,
             },
           ],
-        }
+        },
       );
     });
 
@@ -346,7 +346,7 @@ describe('Getta', () => {
       beforeEach(async () => {
         mockedFetch.mockPostOnce(
           { body: { mock: true }, url: buildTestEndpoint(graphqlPath) },
-          { body: PRD_136_7317.body, headers: defaultHeaders }
+          { body: PRD_136_7317.body, headers: defaultHeaders },
         );
 
         response = await restClient.post(graphqlPath, {
@@ -362,7 +362,7 @@ describe('Getta', () => {
         expect(response).toEqual(
           expect.objectContaining({
             data: PRD_136_7317.body,
-          })
+          }),
         );
       });
     });
@@ -371,7 +371,7 @@ describe('Getta', () => {
       beforeEach(async () => {
         mockedFetch.mockPostOnce(
           { body: { mock: true }, url: buildTestEndpoint(graphqlPath) },
-          { body: PRD_136_7317.body, headers: defaultHeaders }
+          { body: PRD_136_7317.body, headers: defaultHeaders },
         );
 
         response = await restClient.postProduct({ body: JSON.stringify({ ...defaultPayload, mock: true }) });
@@ -385,7 +385,7 @@ describe('Getta', () => {
         expect(response).toEqual(
           expect.objectContaining({
             data: PRD_136_7317.body,
-          })
+          }),
         );
       });
     });
@@ -406,7 +406,7 @@ describe('Getta', () => {
               pathTemplateData: pathTemplateDataWithoutID,
             },
           ],
-        }
+        },
       );
     });
 
@@ -486,7 +486,7 @@ describe('Getta', () => {
               pathTemplateData: pathTemplateDataWithoutID,
             },
           ],
-        }
+        },
       );
     });
 
@@ -551,12 +551,15 @@ describe('Getta', () => {
         const requestKeys = [...Array.from({ length: 55 }).keys()];
 
         for (const key of requestKeys) {
-          mockedFetch.mockGetOnce(buildTestEndpoint(`product/${key}`));
+          mockedFetch.mockGetOnce(buildTestEndpoint(`product/${String(key)}`));
         }
 
         // @ts-expect-error property is private
         restClient._addRequestToRateLimitedQueue = jest.fn().mockResolvedValue({ status: 200 });
-        await Promise.all(requestKeys.map(key => restClient.get(`product/${key}`, { headers: defaultHeaders })));
+
+        await Promise.all(
+          requestKeys.map(key => restClient.get(`product/${String(key)}`, { headers: defaultHeaders })),
+        );
       });
 
       it('should call fetch one less than the rate limit', () => {