getta 0.4.6 → 1.0.0

package/lib/types/helpers/get-response-group/index.d.ts

@@ -1,2 +0,0 @@
-export default function getResponseGroup(status: number): "information" | "successful" | "redirection" | "clientError" | "serverError";
-//# sourceMappingURL=index.d.ts.map

package/lib/types/helpers/get-response-group/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/helpers/get-response-group/index.ts"],"names":[],"mappings":"AAQA,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,MAAM,EAAE,MAAM,gFAatD"}

package/lib/types/helpers/is-cacheability-valid/index.d.ts

@@ -1,3 +0,0 @@
-import Cacheability from "cacheability";
-export default function isCacheabilityValid(cacheability: Cacheability): boolean;
-//# sourceMappingURL=index.d.ts.map

package/lib/types/helpers/is-cacheability-valid/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/helpers/is-cacheability-valid/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,cAAc,CAAC;AAExC,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAAC,YAAY,EAAE,YAAY,WAGrE"}

package/lib/types/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./constants";
-export { default as defaultPathTemplateCallback } from "./helpers/default-path-template-callback";
-export { Getta, createRestClient } from "./main";
-export * from "./types";
-//# sourceMappingURL=index.d.ts.map

package/lib/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,OAAO,IAAI,2BAA2B,EAAE,MAAM,0CAA0C,CAAC;AAClG,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AACjD,cAAc,SAAS,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,QAA0B,MAAM,gBAAgB,CAAC;AACxD,OAAO,EAAQ,WAAW,EAAgB,MAAM,gBAAgB,CAAC;AAIjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAuCzC,OAAO,EACL,kBAAkB,EAGlB,aAAa,EAMb,cAAc,EAGd,kBAAkB,EAClB,SAAS,EAEV,MAAM,SAAS,CAAC;AAEjB,qBAAa,KAAK;IAChB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,WAAW,CAAO;IAC1B,OAAO,CAAC,MAAM,CAAC,CAAW;IAC1B,OAAO,CAAC,2BAA2B,CAAU;IAC7C,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,QAAQ,CAAe;IAC/B,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,eAAe,CAAa;IACpC,OAAO,CAAC,wBAAwB,CAAoB;IACpD,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,eAAe,CAA6B;IACpD,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,eAAe,CAAsD;IAC7E,OAAO,CAAC,aAAa,CAAe;gBAExB,OAAO,EAAE,kBAAkB;IA4CvC,IAAI,KAAK,IAAI,QAAQ,GAAG,SAAS,CAEhC;IAEM,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,GAAG,YAAY,EAAE,EAAE,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC;IAgBpG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM,EAAE,OAAO,CAAC,EAAE,WAAW;IAIxF,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAM,EAAE,OAAO,CAAC,EAAE,WAAW;;;;IAIrF,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW;IAInG,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW;IAIhH,OAAO,CAAC,6BAA6B;YAMvB,iBAAiB;YAUjB,cAAc;YAUd,cAAc;YAUd,cAAc;YAUd,OAAO;YA+BP,MAAM;YAkFN,qBAAqB;YAmBrB,kBAAkB;YAclB,IAAI;YAuCJ,WAAW;IAkCzB,OAAO,CAAC,YAAY;IAuBpB,OAAO,CAAC,UAAU;IAelB,OAAO,CAAC,+BAA+B;YASzB,QAAQ;IAyBtB,OAAO,CAAC,uBAAuB;IAW/B,OAAO,CAAC,kBAAkB;IAO1B,OAAO,CAAC,aAAa;CAStB;AAED,eAAO,MAAM,gBAAgB,8BAA+B,kBAAkB,qEAS7E,CAAC"}

package/lib/types/main.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=main.test.d.ts.map

package/lib/types/main.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"main.test.d.ts","sourceRoot":"","sources":["../../src/main.test.ts"],"names":[],"mappings":""}

package/lib/types/types.d.ts

@@ -1,69 +0,0 @@
-import Cachemap from "@cachemap/core";
-import { Func, PlainObject, StringObject } from "@repodog/types";
-import { Required } from "utility-types";
-export declare type FetchMethod = "get" | "post" | "put" | "delete";
-export declare type StreamReader = "arrayBuffer" | "blob" | "formData" | "json" | "text";
-export declare type ShortcutProperties<T extends string | number> = {
-    [K in T]: <Resource = PlainObject>(...args: any[]) => Promise<FetchResponse<Resource>>;
-};
-export interface ConstructorOptions {
-    basePath: string;
-    bodyParser?: Func;
-    cache?: Cachemap;
-    enableConditionalRequests?: boolean;
-    fetchTimeout?: number;
-    headers?: StringObject;
-    log?: Log;
-    maxRedirects?: number;
-    maxRetries?: number;
-    optionalPathTemplateRegExp?: RegExp;
-    pathTemplateCallback?: PathTemplateCallback;
-    pathTemplateRegExp?: RegExp;
-    performance: Performance;
-    queryParams?: PlainObject;
-    rateLimitPerSecond?: number;
-    requestRetryWait?: number;
-    streamReader?: StreamReader;
-}
-export interface FetchOptions {
-    body?: BodyInit;
-    headers: StringObject;
-    method: FetchMethod;
-    redirects?: number;
-    retries?: number;
-}
-export interface FetchResponse<Resource = PlainObject> extends ResponseDataWithErrors<Resource>, Response {
-}
-export interface FetchRedirectHandlerOptions extends FetchOptions {
-    status: number;
-}
-export declare type Log = (message: string, data: PlainObject, logLevel?: LogLevel) => void;
-export declare type LogLevel = "error" | "warn" | "info" | "http" | "verbose" | "debug" | "silly";
-export interface Performance {
-    now(): number;
-}
-export interface RequestOptions {
-    body?: BodyInit;
-    headers?: StringObject;
-    method?: FetchMethod;
-    pathTemplateData?: StringObject;
-    queryParams?: PlainObject;
-}
-export declare type RequestQueue = [(value: FetchResponse) => void, string, FetchOptions, PlainObject][];
-export interface ResponseDataWithErrors<Resource = PlainObject> {
-    data?: Resource;
-    errors?: Error[];
-}
-export declare type PathTemplateCallback = (path: string, data: StringObject, pathTemplateRegExp: RegExp) => string;
-export declare type PendingRequestResolver = (value: FetchResponse<PlainObject>) => void;
-export interface PendingRequestResolvers {
-    resolve: PendingRequestResolver;
-}
-export interface RequestTracker {
-    active: string[];
-    pending: Map<string, PendingRequestResolvers[]>;
-}
-export interface Shortcuts {
-    [key: string]: [string, Required<RequestOptions, "method">];
-}
-//# sourceMappingURL=types.d.ts.map

package/lib/types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,oBAAY,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5D,oBAAY,YAAY,GAAG,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjF,oBAAY,kBAAkB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI;KACzD,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,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,GAAG,CAAC,EAAE,GAAG,CAAC;IACV,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAC5C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,EAAE,YAAY,CAAC;IACtB,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,oBAAY,GAAG,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,IAAI,CAAC;AAEpF,oBAAY,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,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC3B;AAED,oBAAY,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,oBAAY,oBAAoB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,KAAK,MAAM,CAAC;AAE5G,oBAAY,sBAAsB,GAAG,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;AAEjF,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,WAAW,SAAS;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;CAC7D"}

package/src/__tests__/data/index.ts

@@ -1,19 +0,0 @@
-export const PRD_136_7317 = {
-  body: require("./136-7317.json"),
-  url: "https://www.tesco.com/direct/rest/content/catalog/product/136-7317",
-};
-
-export const PRD_180_1387 = {
-  body: require("./180-1387.json"),
-  url: "https://www.tesco.com/direct/rest/content/catalog/product/180-1387",
-};
-
-export const PRD_183_3905 = {
-  body: require("./183-3905.json"),
-  url: "https://www.tesco.com/direct/rest/content/catalog/product/183-3905",
-};
-
-export const PRD_202_3315 = {
-  body: require("./202-3315.json"),
-  url: "https://www.tesco.com/direct/rest/content/catalog/product/202-3315",
-};

package/src/__tests__/helpers/index.ts

@@ -1,61 +0,0 @@
-import Cachemap from "@cachemap/core";
-import map from "@cachemap/map";
-import { PlainObject } from "@repodog/types";
-import { OPTIONAL_PATH_TEMPLATE_REGEX } from "../..";
-import { DEFAULT_PATH_TEMPLATE_REGEX } from "../../constants";
-import buildEndpoint from "../../helpers/build-endpoint";
-import defaultPathTemplateCallback from "../../helpers/default-path-template-callback";
-import { RequestOptions } from "../../types";
-import { MockRequestCallbackParams, TearDownTestParams } from "../types";
-
-export const basePath = "https://tesco.com";
-
-export const defaultPath = "/direct/rest/content/catalog/{type}/{id,+}?format={brief|standard}";
-
-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 function getCache() {
-  return new Cachemap({
-    name: "cachemap",
-    store: map(),
-    type: "test",
-  });
-}
-
-export function mockRequest(
-  path: string,
-  body: PlainObject,
-  { headers = {}, pathTemplateData, queryParams }: RequestOptions = {},
-  callback: (options: MockRequestCallbackParams) => void,
-) {
-  callback({
-    body: JSON.stringify(body),
-    endpoint: buildEndpoint(basePath, path, {
-      optionalPathTemplateRegExp: OPTIONAL_PATH_TEMPLATE_REGEX,
-      pathTemplateCallback: defaultPathTemplateCallback,
-      pathTemplateData,
-      pathTemplateRegExp: DEFAULT_PATH_TEMPLATE_REGEX,
-      queryParams,
-    }),
-    headers: { ...defaultHeaders, ...headers },
-  });
-}
-
-export async function tearDownTest({ fetchMock, restClient }: TearDownTestParams) {
-  fetchMock.restore();
-  await restClient?.cache?.clear();
-}

package/src/__tests__/types.ts

@@ -1,14 +0,0 @@
-import { StringObject } from "@repodog/types";
-import { FetchMockStatic } from "fetch-mock";
-import { Getta } from "../main";
-
-export interface TearDownTestParams {
-  fetchMock: FetchMockStatic;
-  restClient: Getta;
-}
-
-export interface MockRequestCallbackParams {
-  body?: BodyInit;
-  endpoint: string;
-  headers: StringObject;
-}

package/src/helpers/build-endpoint/index.ts

@@ -1,34 +0,0 @@
-import queryString from "query-string";
-import { BuildEndpointOptions } from "./types";
-
-export default function buildEndpoint(
-  basePath: string,
-  path: string,
-  {
-    optionalPathTemplateRegExp,
-    pathTemplateCallback,
-    pathTemplateData,
-    pathTemplateRegExp,
-    queryParams,
-  }: BuildEndpointOptions,
-) {
-  const pathJoiner = basePath.endsWith("/") || path.startsWith("/") ? "" : "/";
-  let endpoint = `${basePath}${pathJoiner}${path}`;
-
-  if (pathTemplateData) {
-    endpoint = pathTemplateCallback(endpoint, pathTemplateData, pathTemplateRegExp);
-  }
-
-  endpoint = endpoint.replace(optionalPathTemplateRegExp, "");
-
-  if (endpoint.endsWith("/")) {
-    endpoint = endpoint.substring(0, endpoint.length - 1);
-  }
-
-  if (queryParams && Object.keys(queryParams).length) {
-    const queryJoin = queryString.extract(endpoint) ? "&" : "?";
-    endpoint = `${endpoint}${queryJoin}${queryString.stringify(queryParams)}`;
-  }
-
-  return endpoint;
-}

package/src/helpers/default-path-template-callback/index.test.ts

@@ -1,11 +0,0 @@
-import defaultPathTemplateCallback from ".";
-import { defaultPath, defaultPathTemplateData } from "../../__tests__/helpers";
-import { DEFAULT_PATH_TEMPLATE_REGEX } from "../../constants";
-
-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",
-    );
-  });
-});

package/src/helpers/default-path-template-callback/index.ts

@@ -1,16 +0,0 @@
-import { StringObject } from "@repodog/types";
-
-export default function defaultPathTemplateCallback(
-  pathTemplate: string,
-  data: StringObject,
-  pathTemplateRegExp: RegExp,
-) {
-  const dataKeys = Object.keys(data);
-
-  return pathTemplate.replace(pathTemplateRegExp, match => {
-    return dataKeys.reduce((value, key) => {
-      if (match.includes(key)) return data[key];
-      return value;
-    }, "");
-  });
-}

package/src/helpers/get-response-group/index.ts

@@ -1,22 +0,0 @@
-import {
-  CLIENT_ERROR_REPSONSE,
-  INFORMATION_REPSONSE,
-  REDIRECTION_REPSONSE,
-  SERVER_ERROR_REPSONSE,
-  SUCCESSFUL_REPSONSE,
-} from "../../constants";
-
-export default function getResponseGroup(status: number) {
-  switch (true) {
-    case status < 200:
-      return INFORMATION_REPSONSE;
-    case status < 300:
-      return SUCCESSFUL_REPSONSE;
-    case status < 400:
-      return REDIRECTION_REPSONSE;
-    case status < 500:
-      return CLIENT_ERROR_REPSONSE;
-    default:
-      return SERVER_ERROR_REPSONSE;
-  }
-}

package/src/helpers/is-cacheability-valid/index.ts

@@ -1,6 +0,0 @@
-import Cacheability from "cacheability";
-
-export default function isCacheabilityValid(cacheability: Cacheability) {
-  const noCache = cacheability?.metadata?.cacheControl?.noCache ?? false;
-  return !noCache && cacheability.checkTTL();
-}