getta 0.4.7 → 1.0.1

package/src/constants.ts

@@ -1,10 +1,10 @@
-import { PlainObject } from "@repodog/types";
+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' 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 STREAM_READERS = {
   ARRAY_BUFFER_FORMAT,
@@ -16,48 +16,48 @@ export const STREAM_READERS = {
 
 export const DEFAULT_BODY_PARSER = (body: PlainObject) => body;
 export const DEFAULT_FETCH_TIMEOUT = 5000 as const;
-export const DEFAULT_HEADERS = { "content-type": "application/json" };
+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_PATH_TEMPLATE_REGEX = /({type})|({id})|({id,\+})|({brief\|standard})/g;
-export const OPTIONAL_PATH_TEMPLATE_REGEX = /({[a-zA-Z0-9_]+\?})/g;
+export const OPTIONAL_PATH_TEMPLATE_REGEX = /({\w+\?})/g;
 export const DEFAULT_RATE_LIMIT = 50;
 export const DEFAULT_REQUEST_RETRY_WAIT = 100;
 
 export const MISSING_BASE_PATH_ERROR = `Getta expected to receive 'basePath' in the constructor options,
   but recevied undefined.`;
 
-export const MAX_REDIRECTS_EXCEEDED_ERROR = "The request exceeded the maximum number of redirects, which is";
+export const MAX_REDIRECTS_EXCEEDED_ERROR = 'The request exceeded the maximum number of redirects, which is';
 
-export const MAX_RETRIES_EXCEEDED_ERROR = "The request exceeded the maximum number of retries, which is";
+export const MAX_RETRIES_EXCEEDED_ERROR = 'The request exceeded the maximum number of retries, which is';
 
 export const INVALID_FETCH_METHOD_ERROR = "Getta expected to receive 'get', 'post', 'put' or 'delete', but received";
 
-export const RESOURCE_NOT_FOUND_ERROR = "The requested resource could not been found.";
+export const RESOURCE_NOT_FOUND_ERROR = 'The requested resource could not been found.';
 
-export const FETCH_TIMEOUT_ERROR = "The request timed out. Getta did not get a response within";
+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' 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 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' 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 NOT_MODIFIED_STATUS_CODE = 304 as const;
 export const NOT_FOUND_STATUS_CODE = 404 as const;
 
-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' 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 REQUEST_SENT = "request_sent" as const;
-export const RESPONSE_RECEIVED = "response_received" as const;
+export const REQUEST_SENT = 'request_sent' as const;
+export const RESPONSE_RECEIVED = 'response_received' as const;

package/src/helpers/buildEndpoint/index.ts

@@ -0,0 +1,34 @@
+import queryString from 'query-string';
+import { type BuildEndpointOptions } from './types.ts';
+
+export const 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.slice(0, Math.max(0, endpoint.length - 1));
+  }
+
+  if (queryParams && Object.keys(queryParams).length > 0) {
+    const queryJoin = queryString.extract(endpoint) ? '&' : '?';
+    endpoint = `${endpoint}${queryJoin}${queryString.stringify(queryParams)}`;
+  }
+
+  return endpoint;
+};

package/src/helpers/{build-endpoint → buildEndpoint}/types.ts

@@ -1,6 +1,6 @@
-import { PathTemplateCallback, RequestOptions } from "../../types";
+import { type PathTemplateCallback, type RequestOptions } from '../../types.ts';
 
-export interface BuildEndpointOptions extends Omit<RequestOptions, "headers"> {
+export interface BuildEndpointOptions extends Omit<RequestOptions, 'headers'> {
   optionalPathTemplateRegExp: RegExp;
   pathTemplateCallback: PathTemplateCallback;
   pathTemplateRegExp: RegExp;

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

@@ -0,0 +1,11 @@
+import { defaultPath, defaultPathTemplateData } from '../../__testUtils__/helpers/index.ts';
+import { DEFAULT_PATH_TEMPLATE_REGEX } from '../../constants.ts';
+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'
+    );
+  });
+});

package/src/helpers/defaultPathTemplateCallback/index.ts

@@ -0,0 +1,17 @@
+export const defaultPathTemplateCallback = (
+  pathTemplate: string,
+  data: Record<string, string>,
+  pathTemplateRegExp: RegExp
+) => {
+  const dataKeys = Object.keys(data);
+
+  return pathTemplate.replace(pathTemplateRegExp, match => {
+    for (const key of dataKeys) {
+      if (match.includes(key) && data[key]) {
+        return data[key]!;
+      }
+    }
+
+    return '';
+  });
+};

package/src/helpers/delay/index.ts

@@ -1,3 +1,3 @@
-export default function delay(ms: number) {
+export const delay = (ms: number) => {
   return new Promise(resolve => setTimeout(resolve, ms));
-}
+};

package/src/helpers/getResponseGroup/index.ts

@@ -0,0 +1,25 @@
+import * as consts from '../../constants.ts';
+
+export const getResponseGroup = (status: number) => {
+  switch (true) {
+    case status < 200: {
+      return consts.INFORMATION_REPSONSE;
+    }
+
+    case status < 300: {
+      return consts.SUCCESSFUL_REPSONSE;
+    }
+
+    case status < 400: {
+      return consts.REDIRECTION_REPSONSE;
+    }
+
+    case status < 500: {
+      return consts.CLIENT_ERROR_REPSONSE;
+    }
+
+    default: {
+      return consts.SERVER_ERROR_REPSONSE;
+    }
+  }
+};

package/src/helpers/isCacheabilityValid/index.ts

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

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from "./constants";
-export { default as defaultPathTemplateCallback } from "./helpers/default-path-template-callback";
-export { Getta, createRestClient } from "./main";
-export * from "./types";
+export * from './constants.ts';
+export { defaultPathTemplateCallback } from './helpers/defaultPathTemplateCallback/index.ts';
+export { Getta, createRestClient } from './main.ts';
+export * from './types.ts';