getta 0.4.7 → 1.0.1

package/{lib → dist}/types/main.d.ts

@@ -1,7 +1,6 @@
-import Cachemap from "@cachemap/core";
-import { PlainObject } from "@repodog/types";
-import { Required } from "utility-types";
-import { ConstructorOptions, FetchResponse, RequestOptions, ShortcutProperties, Shortcuts } from "./types";
+import { type Core } from '@cachemap/core';
+import type { SetRequired } from 'type-fest';
+import { type ConstructorOptions, type Context, type FetchResponse, type PlainObject, type RequestOptions, type ShortcutProperties, type Shortcuts } from './types.ts';
 export declare class Getta {
     private _basePath;
     private _bodyParser;
@@ -17,6 +16,7 @@ export declare class Getta {
     private _pathTemplateRegExp;
     private _performance;
     private _queryParams;
+    private _rateLimit;
     private _rateLimitCount;
     private _rateLimitedRequestQueue;
     private _rateLimitPerSecond;
@@ -25,15 +25,15 @@ export declare class Getta {
     private _requestTracker;
     private _streamReader;
     constructor(options: ConstructorOptions);
-    get cache(): Cachemap | undefined;
-    createShortcut(name: string, path: string, { method, ...otherOptions }: Required<RequestOptions, "method">): void;
-    delete(path: string, options?: Omit<RequestOptions, "method">, context?: PlainObject): Promise<FetchResponse<PlainObject>>;
-    get(path: string, options?: Omit<RequestOptions, "method">, context?: PlainObject): Promise<FetchResponse<PlainObject> | {
+    get cache(): Core | undefined;
+    createShortcut(name: string, path: string, { method, ...otherOptions }: SetRequired<RequestOptions, 'method'>): void;
+    delete(path: string, options?: Omit<RequestOptions, 'method'>, context?: Context): Promise<FetchResponse<PlainObject>>;
+    get(path: string, options?: Omit<RequestOptions, 'method'>, context?: Context): Promise<FetchResponse<PlainObject> | {
         data: PlainObject | undefined;
         headers: Headers;
     }>;
-    post(path: string, options: Omit<Required<RequestOptions, "body">, "method">, context?: PlainObject): Promise<FetchResponse<PlainObject>>;
-    put(path: string, options: Omit<Required<RequestOptions, "body">, "methood">, context?: PlainObject): Promise<FetchResponse<PlainObject>>;
+    post(path: string, options: Omit<SetRequired<RequestOptions, 'body'>, 'method'>, context?: Context): Promise<FetchResponse<PlainObject>>;
+    put(path: string, options: Omit<SetRequired<RequestOptions, 'body'>, 'methood'>, context?: Context): Promise<FetchResponse<PlainObject>>;
     private _addRequestToRateLimitedQueue;
     private _cacheEntryDelete;
     private _cacheEntryGet;
@@ -46,12 +46,12 @@ export declare class Getta {
     private _get;
     private _getResolve;
     private _logResponse;
-    private _rateLimit;
     private _releaseRateLimitedRequestQueue;
     private _request;
     private _resolvePendingRequests;
     private _setPendingRequest;
+    private _startRateLimit;
     private _trackRequest;
 }
-export declare const createRestClient: <N extends string>(options: ConstructorOptions, shortcuts?: Shortcuts | undefined) => Getta & ShortcutProperties<N>;
+export declare const createRestClient: <N extends string>(options: ConstructorOptions, shortcuts?: Shortcuts) => Getta & ShortcutProperties<N>;
 //# sourceMappingURL=main.d.ts.map

package/dist/types/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,KAAK,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAI9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAO7C,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,OAAO,EAGZ,KAAK,aAAa,EAOlB,KAAK,WAAW,EAChB,KAAK,cAAc,EAGnB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EAEf,MAAM,YAAY,CAAC;AAEpB,qBAAa,KAAK;IAChB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAO;IAC1B,OAAO,CAAC,MAAM,CAAC,CAAO;IACtB,OAAO,CAAC,2BAA2B,CAAU;IAC7C,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,IAAI,CAAkB;IAC9B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,2BAA2B,CAAS;IAC5C,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,UAAU,CAAU;IAC5B,OAAO,CAAC,eAAe,CAAK;IAC5B,OAAO,CAAC,wBAAwB,CAAoB;IACpD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,eAAe,CAAuC;IAC9D,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,eAAe,CAAsD;IAC7E,OAAO,CAAC,aAAa,CAAe;gBAExB,OAAO,EAAE,kBAAkB;IA8CvC,IAAI,KAAK,IAAI,IAAI,GAAG,SAAS,CAE5B;IAEM,cAAc,CACnB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,EAAE,MAAM,EAAE,GAAG,YAAY,EAAE,EAAE,WAAW,CAAC,cAAc,EAAE,QAAQ,CAAC;IAiBvD,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM,EAAE,OAAO,CAAC,EAAE,OAAO;IAIpF,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM,EAAE,OAAO,CAAC,EAAE,OAAO;;;;IAIjF,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO;IAIlG,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO;IAI/G,OAAO,CAAC,6BAA6B;YAMvB,iBAAiB;YAQjB,cAAc;YAQd,cAAc;YAYd,cAAc;YAQd,OAAO;YA+BP,MAAM;YA6FN,qBAAqB;YAmBrB,kBAAkB;YAclB,IAAI;YAyCJ,WAAW;IAoCzB,OAAO,CAAC,YAAY;YAsBN,+BAA+B;YAQ/B,QAAQ;IAyBtB,OAAO,CAAC,uBAAuB;IAc/B,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,eAAe;IAevB,OAAO,CAAC,aAAa;CAUtB;AAED,eAAO,MAAM,gBAAgB,8BAA+B,kBAAkB,cAAc,SAAS,kCAgBpG,CAAC"}

package/dist/types/types.d.ts

@@ -0,0 +1,161 @@
+import { type Core } from '@cachemap/core';
+import type { SetRequired } from 'type-fest';
+export type PlainObject = Record<string, any>;
+export type Func = (...args: any[]) => any;
+export type FetchMethod = 'get' | 'post' | 'put' | 'delete';
+export type StreamReader = 'arrayBuffer' | 'blob' | 'formData' | 'json' | 'text';
+export type ShortcutProperties<T extends string | number> = {
+    [K in T]: <Resource = PlainObject>(...args: any[]) => Promise<FetchResponse<Resource>>;
+};
+export interface ConstructorOptions {
+    /**
+     * The base path of the url for all requests made from
+     * an instance of the rest client, i.e. https://www.example.com/api.
+     */
+    basePath: string;
+    /**
+     * An optional callback to pass each response body through after
+     * it has been parsed by the stream reader.
+     */
+    bodyParser?: Func;
+    /**
+     * An instance of the @cachemap/core cache for caching responses
+     * against the request. Caching is only enabled on GET requests.
+     * For more info on @cachemap/core see https://github.com/badbatch/cachemap.
+     */
+    cache?: Core;
+    /**
+     * Enables conditional requests with If-None-Match header.
+     * Default is true
+     */
+    enableConditionalRequests?: boolean;
+    /**
+     * How long to wait for a request to respond before timing out
+     * and returning an error.
+     * Default is 5000
+     */
+    fetchTimeout?: number;
+    /**
+     * Any headers to attach to every request.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Log function to pass rest client logs to a logger.
+     */
+    log?: Log;
+    /**
+     * The maximum number of times a request can redirect before
+     * the rest client returns an error.
+     * Default is 5
+     */
+    maxRedirects?: number;
+    /**
+     * The maximum number of times a request can retry before
+     * the rest client returns an error.
+     * Default is 3
+     */
+    maxRetries?: number;
+    /**
+     * An optional path template regex that can be used to clean up
+     * the template url.
+     * Default is /({\w+\?})/g
+     */
+    optionalPathTemplateRegExp?: RegExp;
+    /**
+     * A callback that takes the path template, the data to be injected into
+     * the template, and the path template regex, and returns the templated url.
+     * There is a default template callback that will cater to most needs.
+     */
+    pathTemplateCallback?: PathTemplateCallback;
+    /**
+     * A regex to tell the rest client where to inject data into the
+     * template. There is a default one that will cater to most needs.
+     */
+    pathTemplateRegExp?: RegExp;
+    /**
+     * The performance module to use for recording request
+     * durations.
+     */
+    performance: Performance;
+    /**
+     * Any query params to attach to every request.
+     */
+    queryParams?: PlainObject;
+    /**
+     * Whether to enable the rate limit feature.
+     */
+    rateLimit?: boolean;
+    /**
+     * How many requests per second to throttle the rest client.
+     * Default is 50
+     */
+    rateLimitPerSecond?: number;
+    /**
+     * How many milliseconds to wait before retrying a request.
+     * Default is 100
+     */
+    requestRetryWait?: number;
+    /**
+     * The stream reader to use when parsing the response body.
+     * Default is 'json'
+     */
+    streamReader?: StreamReader;
+}
+export interface FetchOptions {
+    body?: BodyInit;
+    headers: Record<string, string>;
+    method: FetchMethod;
+    redirects?: number;
+    retries?: number;
+}
+export interface FetchResponse<Resource = PlainObject> extends ResponseDataWithErrors<Resource>, Response {
+}
+export interface FetchRedirectHandlerOptions extends FetchOptions {
+    status: number;
+}
+export type Log = (message: string, data: PlainObject, logLevel?: LogLevel) => void;
+export type LogLevel = 'error' | 'warn' | 'info' | 'http' | 'verbose' | 'debug' | 'silly';
+export interface Performance {
+    now(): number;
+}
+export interface RequestOptions {
+    /**
+     * For POST and PUT methods, the body to send with the request.
+     */
+    body?: BodyInit;
+    /**
+     * Any headers to attach to the request.
+     */
+    headers?: Record<string, string>;
+    /**
+     * The fetch method.
+     */
+    method?: FetchMethod;
+    /**
+     * Data to be injected into the path template.
+     */
+    pathTemplateData?: Record<string, string>;
+    /**
+     * Any query params to attach to the request.
+     */
+    queryParams?: PlainObject;
+}
+export type RequestQueue = [(value: FetchResponse) => void, string, FetchOptions, PlainObject][];
+export interface ResponseDataWithErrors<Resource = PlainObject> {
+    data?: Resource;
+    errors?: Error[];
+}
+export type PathTemplateCallback = (path: string, data: Record<string, string>, pathTemplateRegExp: RegExp) => string;
+export type PendingRequestResolver = (value: FetchResponse) => void;
+export interface PendingRequestResolvers {
+    resolve: PendingRequestResolver;
+}
+export interface RequestTracker {
+    active: string[];
+    pending: Map<string, PendingRequestResolvers[]>;
+}
+export type Shortcuts = Record<string, [string, SetRequired<RequestOptions, 'method'>]>;
+export type Context = {
+    startTime?: number;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAG7C,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAG9C,MAAM,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAE3C,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5D,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;KAEzD,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,WAAW,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;CACvF,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,IAAI,CAAC;IACb;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;IACV;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,EAAE,WAAW,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa,CAAC,QAAQ,GAAG,WAAW,CAAE,SAAQ,sBAAsB,CAAC,QAAQ,CAAC,EAAE,QAAQ;CAAG;AAE5G,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEpF,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC;AAE1F,MAAM,WAAW,WAAW;IAC1B,GAAG,IAAI,MAAM,CAAC;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,CAAC,EAAE,CAAC;AAEjG,MAAM,WAAW,sBAAsB,CAAC,QAAQ,GAAG,WAAW;IAC5D,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,EAAE,MAAM,KAAK,MAAM,CAAC;AAEtH,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;AAEpE,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,sBAAsB,CAAC;CACjC;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,uBAAuB,EAAE,CAAC,CAAC;CACjD;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;AAExF,MAAM,MAAM,OAAO,GAAG;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/package.json

@@ -1,160 +1,128 @@
 {
   "name": "getta",
-  "version": "0.4.7",
   "description": "An isomorphic rest client based on the Fetch API.",
-  "keywords": [
-    "api-client",
-    "fetch",
-    "isomorphic",
-    "rest"
-  ],
-  "homepage": "https://github.com/badbatch/getta",
-  "bugs": {
-    "url": "https://github.com/badbatch/getta/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:badbatch/getta.git"
-  },
+  "version": "1.0.1",
+  "author": "Dylan Aubrey",
   "license": "MIT",
-  "author": "Dylan Aubrey <dylanaubrey@gmail.com>",
-  "main": "lib/main/index.js",
-  "module": "lib/module/index.mjs",
-  "browser": "lib/browser/index.js",
-  "types": "lib/types/index.d.ts",
-  "scripts": {
-    "build": "yarn run clean:libs && yarn run compile",
-    "clean": "yarn run clean:libs && yarn run clean:docs && yarn run clean:repo",
-    "clean:docs": "del-cli ./docs",
-    "clean:libs": "del-cli ./lib",
-    "clean:repo": "del-cli ./node_modules",
-    "compile": "concurrently npm:compile:*",
-    "compile-watch": "concurrently npm:compile-watch:*",
-    "compile-watch:main": "yarn run compile:main --watch",
-    "compile-watch:types": "yarn run compile:types --watch",
-    "compile:browser": "cross-env BABEL_ENV=web rollup -c ./rollup.config.js",
-    "compile:main": "cross-env BABEL_ENV=main babel ./src --out-dir ./lib/main --extensions \".ts\" --config-file ./babel.config.js",
-    "compile:module": "cross-env BABEL_ENV=module babel ./src --out-dir ./lib/module --extensions \".ts\" --out-file-extension \".mjs\" --config-file ./babel.config.js",
-    "compile:types": "tsc --declaration --declarationMap --emitDeclarationOnly",
-    "cutoff": "cutoff",
-    "cutoff:post-version": "yarn run compile && yarn run docs",
-    "docs": "typedoc --includes ./src --out ./docs --options ./typedoc.js",
-    "lint": "tslint --project ./tsconfig.json",
-    "new-repo": "new-repo",
-    "publish-cutoff": "publish-cutoff",
-    "test": "jest --logHeapUsage",
-    "type-check": "tsc --noEmit",
-    "validate": "yarn run build && yarn run lint && yarn run type-check && yarn run test && yarn run docs",
-    "wipe": "del-cli ./yarn.lock ./node_modules"
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
+  "homepage": "https://github.com/badbatch/getta",
+  "repository": "https://github.com/badbatch/getta",
+  "bugs": "https://github.com/badbatch/getta/issues",
+  "type": "module",
+  "main": "./dist/main/index.mjs",
+  "types": "./dist/types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
-    "@cachemap/core": "^4.0.4",
-    "@repodog/constants": "^0.3.29",
-    "@repodog/helpers": "^0.3.27",
-    "@repodog/types": "^0.3.26",
-    "@types/md5": "^2.1.33",
-    "cacheability": "^3.0.2",
-    "md5": "^2.2.1",
-    "query-string": "^6.11.1"
+    "cacheability": "^4.0.9",
+    "query-string": "^8.1.0",
+    "ts-md5": "^1.3.1"
   },
   "peerDependencies": {
-    "@babel/runtime": "< 8",
-    "core-js": "< 4",
-    "isomorphic-fetch": "< 3",
-    "lodash": "< 5"
+    "@babel/runtime": "<8",
+    "core-js": "<4",
+    "lodash-es": "<5"
   },
   "devDependencies": {
-    "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.8.6",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-proposal-decorators": "^7.8.3",
-    "@babel/plugin-proposal-export-default-from": "^7.8.3",
-    "@babel/plugin-proposal-export-namespace-from": "^7.8.3",
-    "@babel/plugin-proposal-function-sent": "^7.8.3",
-    "@babel/plugin-proposal-json-strings": "^7.8.3",
-    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.8.3",
-    "@babel/plugin-proposal-numeric-separator": "^7.8.3",
-    "@babel/plugin-proposal-optional-chaining": "^7.8.3",
-    "@babel/plugin-proposal-throw-expressions": "^7.8.3",
+    "@babel/cli": "^7.21.5",
+    "@babel/core": "^7.21.8",
+    "@babel/eslint-parser": "^7.21.8",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-export-namespace-from": "^7.18.9",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/plugin-syntax-import-meta": "^7.8.3",
-    "@babel/plugin-syntax-top-level-await": "^7.8.3",
-    "@babel/plugin-transform-modules-commonjs": "^7.8.3",
-    "@babel/plugin-transform-runtime": "^7.8.3",
-    "@babel/preset-env": "^7.8.6",
-    "@babel/preset-typescript": "^7.8.3",
-    "@babel/register": "^7.8.6",
-    "@babel/runtime": "^7.8.4",
-    "@cachemap/constants": "^4.0.2",
-    "@cachemap/controller": "^4.0.3",
-    "@cachemap/map": "^4.0.3",
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
-    "@repodog/babel-config": "^0.3.31",
-    "@repodog/commitlint-config": "^0.3.24",
-    "@repodog/config-helpers": "^0.3.30",
-    "@repodog/constants": "^0.3.29",
-    "@repodog/eslint-config": "^0.3.26",
-    "@repodog/jest-config": "^0.3.31",
-    "@repodog/markdownlint-config": "^0.3.24",
-    "@repodog/new-repo": "^0.3.38",
-    "@repodog/prettier-config": "^0.3.25",
-    "@repodog/rollup-config": "^0.3.27",
-    "@repodog/ts-config": "^0.3.24",
-    "@repodog/tslint-config": "^0.3.26",
-    "@repodog/typedoc-config": "^0.3.24",
-    "@types/fetch-mock": "^7.3.2",
-    "@types/fs-extra": "^8.1.0",
+    "@babel/plugin-syntax-import-assertions": "^7.20.0",
+    "@babel/plugin-transform-runtime": "^7.21.4",
+    "@babel/preset-env": "^7.21.5",
+    "@babel/preset-react": "^7.18.6",
+    "@babel/preset-typescript": "^7.21.5",
+    "@babel/runtime": "^7.21.5",
+    "@cachemap/core": "^5.0.0",
+    "@cachemap/map": "^5.0.0",
+    "@commitlint/cli": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
+    "@commitlint/prompt-cli": "^17.6.3",
+    "@jest/globals": "^29.5.0",
+    "@repodog/babel-config": "^1.1.7",
+    "@repodog/cli": "^1.1.9",
+    "@repodog/commitlint-config": "^1.1.5",
+    "@repodog/eslint-config": "^1.1.11",
+    "@repodog/eslint-config-jest": "^1.1.9",
+    "@repodog/jest-config": "^1.1.9",
+    "@repodog/markdownlint-config": "^1.1.5",
+    "@repodog/prettier-config": "^1.1.5",
+    "@repodog/rollup-config": "^1.1.6",
+    "@repodog/syncpack-config": "^1.1.5",
+    "@repodog/ts-config": "^1.1.5",
+    "@rollup/plugin-babel": "^6.0.3",
+    "@rollup/plugin-image": "^3.0.2",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.2",
+    "@rollup/plugin-terser": "^0.4.1",
     "@types/jest": "^25.1.3",
-    "@types/lodash": "^4.14.149",
-    "@types/node": "^13.7.7",
-    "babel-eslint": "^10.1.0",
-    "babel-plugin-lodash": "^3.3.4",
-    "concurrently": "^5.1.0",
-    "core-js": "^3.6.4",
-    "cross-env": "^7.0.0",
-    "cutoff": "^0.2.7",
+    "@types/lodash-es": "^4.17.9",
+    "@types/node": "^18.11.18",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
+    "babel-jest": "^29.5.0",
+    "babel-plugin-codegen": "^4.1.5",
+    "babel-plugin-macros": "^3.1.0",
+    "core-js": "^3.27.2",
     "del-cli": "^3.0.0",
-    "dotenv": "^8.0.0",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb": "^18.0.1",
-    "eslint-config-prettier": "^6.10.0",
-    "eslint-plugin-import": "^2.20.1",
-    "eslint-plugin-prettier": "^3.1.2",
-    "eslint-plugin-sort-class-members": "^1.6.0",
-    "fetch-mock": "^9.0.0",
-    "fs-extra": "^8.1.0",
-    "husky": "^4.2.3",
-    "isomorphic-fetch": "^2.2.1",
-    "jest": "^25.1.0",
-    "lodash": "^4.17.5",
-    "markdownlint-cli": "^0.22.0",
-    "prettier": "^1.19.1",
-    "rollup": "^1.32.0",
-    "rollup-plugin-analyzer": "^3.2.2",
-    "rollup-plugin-babel": "^5.0.0-alpha.1",
-    "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-json": "^4.0.0",
-    "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-terser": "^5.2.0",
-    "ts-jest": "^25.2.1",
-    "ts-node": "^8.6.2",
-    "ts-toolbelt": "^6.3.5",
-    "tslint": "^6.0.0",
-    "tslint-config-prettier": "^1.18.0",
-    "tslint-plugin-prettier": "^2.1.0",
-    "type-fest": "^0.11.0",
-    "typedoc": "^0.16.11",
-    "typedoc-plugin-markdown": "^2.2.17",
-    "typescript": "^3.8.3",
-    "utility-types": "^3.10.0"
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-import-resolver-typescript": "^3.5.5",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-sort-class-members": "^1.18.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.3",
+    "generate-changelog": "^1.8.0",
+    "husky": "^8.0.3",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^29.5.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.21.6",
+    "rollup-plugin-analyzer": "^4.0.0",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-sourcemaps": "^0.6.3",
+    "suppress-experimental-warnings": "^1.1.17",
+    "syncpack": "^9.8.6",
+    "type-fest": "^3.10.0",
+    "typescript": "^5.0.3",
+    "vitest": "^0.34.6",
+    "zod": "^3.22.4"
   },
-  "engines": {
-    "node": "< 10.16.0"
+  "keywords": [
+    "api-client",
+    "fetch",
+    "isomorphic",
+    "rest"
+  ],
+  "scripts": {
+    "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:main": "rollup -c ./rollup.config.cjs",
+    "compile:types": "tsc --project ./tsconfig.build.json",
+    "cut:changelog": "changelog",
+    "cut:post-version": "pnpm run build",
+    "lint": "eslint . --ext .ts,.cjs",
+    "repodog": "repodog",
+    "syncpack": "syncpack",
+    "test": "node --require=suppress-experimental-warnings --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "type-check": "tsc --noEmit",
+    "validate": "syncpack format && syncpack lint-semver-ranges && pnpm run build && pnpm run lint && pnpm run type-check && pnpm run test"
   }
-}
+}

package/src/{__tests__ → __testUtils__}/data/136-7317.json

@@ -56,7 +56,7 @@
     "defaultSku": {
       "defaultImage": {
         "mediaType": "Large",
-        "src": "https://tesco.scene7.com/is/image/tesco/136-7317_PI_66650MN?$[preset]$",
+        "src": "https://example.scene7.com/is/image/example/136-7317_PI_66650MN?$[preset]$",
         "renderSource": "Scene 7",
         "defaultImage": true
       }

package/src/{__tests__ → __testUtils__}/data/180-1387.json

@@ -72,7 +72,7 @@
     "defaultSku": {
       "defaultImage": {
         "mediaType": "Large",
-        "src": "https://tesco.scene7.com/is/image/tesco/180-1387_PI_TPS2696380?$[preset]$",
+        "src": "https://example.scene7.com/is/image/example/180-1387_PI_TPS2696380?$[preset]$",
         "renderSource": "Scene 7",
         "alt": "String",
         "defaultImage": true

package/src/{__tests__ → __testUtils__}/data/183-3905.json

@@ -74,7 +74,7 @@
     "defaultSku": {
       "defaultImage": {
         "mediaType": "Large",
-        "src": "https://tesco.scene7.com/is/image/tesco/183-3905_PI_TPS2456767?$[preset]$",
+        "src": "https://example.scene7.com/is/image/example/183-3905_PI_TPS2456767?$[preset]$",
         "renderSource": "Scene 7",
         "alt": "String",
         "defaultImage": true

package/src/{__tests__ → __testUtils__}/data/202-3315.json

@@ -55,7 +55,7 @@
     "defaultSku": {
       "defaultImage": {
         "mediaType": "Large",
-        "src": "https://tesco.scene7.com/is/image/tesco/202-3315_PI_66650AL2?$[preset]$",
+        "src": "https://example.scene7.com/is/image/example/202-3315_PI_66650AL2?$[preset]$",
         "renderSource": "Scene 7",
         "defaultImage": true
       }

package/src/__testUtils__/data/index.ts

@@ -0,0 +1,23 @@
+export const PRD_136_7317 = {
+  // eslint-disable-next-line unicorn/no-await-expression-member
+  body: (await import('./136-7317.json')).default,
+  url: 'https://www.example.com/direct/rest/content/catalog/product/136-7317',
+};
+
+export const PRD_180_1387 = {
+  // eslint-disable-next-line unicorn/no-await-expression-member
+  body: (await import('./180-1387.json')).default,
+  url: 'https://www.example.com/direct/rest/content/catalog/product/180-1387',
+};
+
+export const PRD_183_3905 = {
+  // eslint-disable-next-line unicorn/no-await-expression-member
+  body: (await import('./183-3905.json')).default,
+  url: 'https://www.example.com/direct/rest/content/catalog/product/183-3905',
+};
+
+export const PRD_202_3315 = {
+  // eslint-disable-next-line unicorn/no-await-expression-member
+  body: (await import('./202-3315.json')).default,
+  url: 'https://www.example.com/direct/rest/content/catalog/product/202-3315',
+};

package/src/__testUtils__/helpers/index.ts

@@ -0,0 +1,49 @@
+import { Core } from '@cachemap/core';
+import { init as map } from '@cachemap/map';
+import { DEFAULT_PATH_TEMPLATE_REGEX } from '../../constants.ts';
+import { buildEndpoint } from '../../helpers/buildEndpoint/index.ts';
+import { defaultPathTemplateCallback } from '../../helpers/defaultPathTemplateCallback/index.ts';
+import { OPTIONAL_PATH_TEMPLATE_REGEX } from '../../index.ts';
+import { type RequestOptions } from '../../types.ts';
+
+export const basePath = 'https://example.com';
+
+export const defaultPath = '/direct/rest/content/catalog/{type}/{id,+}?format={brief|standard}';
+
+export const graphqlPath = '/graphql/api';
+
+export const defaultPathTemplateData = { 'brief|standard': 'standard', 'id,+': '136-7317', type: 'product' };
+
+export const defaultPayload = { payload: true };
+
+export const idPathTemplateData = { 'id,+': '136-7317' };
+
+export const pathTemplateDataWithoutID = { 'brief|standard': 'standard', type: 'product' };
+
+export const defaultEtag = '33a64df551425fcc55e4d42a148795d9f25f89d4';
+
+export const defaultHeaders = {
+  'cache-control': 'public, max-age=6000',
+  'content-type': 'application/json',
+  etag: defaultEtag,
+};
+
+export const getCache = () => {
+  return new Core({
+    name: 'cachemap',
+    store: map(),
+    type: 'test',
+  });
+};
+
+export const buildTestEndpoint = (
+  path: string,
+  { pathTemplateData = defaultPathTemplateData, queryParams }: RequestOptions = {}
+) =>
+  buildEndpoint(basePath, path, {
+    optionalPathTemplateRegExp: OPTIONAL_PATH_TEMPLATE_REGEX,
+    pathTemplateCallback: defaultPathTemplateCallback,
+    pathTemplateData,
+    pathTemplateRegExp: DEFAULT_PATH_TEMPLATE_REGEX,
+    queryParams,
+  });