@great-detail/support-sdk 0.1.5 → 0.2.0

package/src/Model/Response/CreateResponseModel.ts

@@ -8,9 +8,9 @@
  */
 
 import { z } from "zod";
-import Transport, { SendOptions } from "../../Transport/index.js";
+import FetchTransport from "../../Transport/FetchTransport.js";
 
-export interface Options extends SendOptions {
+export interface Options {
   id: string;
   body: z.infer<typeof CreateResponseModel.SCHEMA>;
   request?: RequestInit;
@@ -26,23 +26,19 @@ export default class CreateResponseModel {
     )
     .min(1);
 
-  constructor(protected _transport: Transport) {}
+  constructor(protected _transport: FetchTransport) {}
 
-  public async send({ id, body, request = {}, ...options }: Options) {
+  public async send({ id, body, request = {} }: Options) {
     return this._transport
-      .send(
-        "v1/models/" + encodeURIComponent(id) + "/response",
-        {
-          ...request,
-          method: "POST",
-          headers: {
-            ...request.headers,
-            "Content-Type": "application/json",
-          },
-          body: JSON.stringify(CreateResponseModel.SCHEMA.parse(body)),
+      .send("v1/models/" + encodeURIComponent(id) + "/response", {
+        ...request,
+        method: "POST",
+        headers: {
+          ...request.headers,
+          "Content-Type": "application/json",
         },
-        options,
-      )
+        body: JSON.stringify(CreateResponseModel.SCHEMA.parse(body)),
+      })
       .then((response) => new CreateResponseModelResponse(response));
   }
 }

package/src/Request/RequestFilterable.ts

@@ -8,5 +8,9 @@
  */
 
 export default interface RequestFilterable {
-  filter(request: RequestInit): Promise<RequestInit>;
+  /**
+   * @deprecated
+   */
+  filter(...options: unknown[]): Promise<{ headers: Record<string, string> }>;
+  getHeaders(): Record<string, string>;
 }

package/src/Request/RequestStandardHeaders.ts

@@ -20,13 +20,13 @@ export default class RequestStandardHeaders implements RequestFilterable {
     > = RequestStandardHeaders.STANDARD_HEADERS,
   ) {}
 
-  public async filter(request: RequestInit) {
+  public async filter() {
     return {
-      ...request,
-      headers: {
-        ...request.headers,
-        ...this._standardHeaders,
-      },
+      headers: this.getHeaders(),
     };
   }
+
+  public getHeaders() {
+    return this._standardHeaders;
+  }
 }

package/src/Source/GetSource.ts

@@ -7,26 +7,22 @@
  * @see       https://greatdetail.com
  */
 
-import Transport, { SendOptions } from "../Transport/index.js";
+import FetchTransport from "../Transport/FetchTransport.js";
 
-export interface Options extends SendOptions {
+export interface Options {
   id: string;
   request?: RequestInit;
 }
 
 export default class GetSource {
-  constructor(protected _transport: Transport) {}
+  constructor(protected _transport: FetchTransport) {}
 
-  public async send({ id, request = {}, ...options }: Options) {
+  public async send({ id, request = {} }: Options) {
     return this._transport
-      .send(
-        "v1/sources/" + encodeURIComponent(id),
-        {
-          ...request,
-          method: "GET",
-        },
-        options,
-      )
+      .send("v1/sources/" + encodeURIComponent(id), {
+        ...request,
+        method: "GET",
+      })
       .then((response) => new GetSourceResponse(response));
   }
 }

package/src/Source/ListSources.ts

@@ -7,25 +7,21 @@
  * @see       https://greatdetail.com
  */
 
-import Transport, { SendOptions } from "../Transport/index.js";
+import FetchTransport from "../Transport/FetchTransport.js";
 
-export interface Options extends SendOptions {
+export interface Options {
   request?: RequestInit;
 }
 
 export default class ListSources {
-  constructor(protected _transport: Transport) {}
+  constructor(protected _transport: FetchTransport) {}
 
-  public async send({ request = {}, ...options }: Options = {}) {
+  public async send({ request = {} }: Options = {}) {
     return this._transport
-      .send(
-        "v1/sources",
-        {
-          ...request,
-          method: "GET",
-        },
-        options,
-      )
+      .send("v1/sources", {
+        ...request,
+        method: "GET",
+      })
       .then((response) => new ListSourcesResponse(response));
   }
 }

package/src/Transport/FetchTransport.ts

@@ -0,0 +1,112 @@
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+import isNetworkError from "is-network-error";
+import AuthenticationError from "../Error/AuthenticationError.js";
+import AuthorizationError from "../Error/AuthorizationError.js";
+import LogicError from "../Error/LogicError.js";
+import NetworkError from "../Error/NetworkError.js";
+import ValidationError from "../Error/ValidationError.js";
+import Transport, { Options as TransportOptions } from "./index.js";
+
+export interface InputOptions extends TransportOptions {
+  baseURL: string;
+
+  /**
+   * Alternative Fetch Provider.
+   * Used to override the default fetch provider and use polyfills or other
+   * libraries.
+   *
+   * @since 1.0.0
+   */
+  fetch?: typeof fetch;
+}
+
+export interface Options extends TransportOptions {
+  baseURL: string;
+  fetch: typeof fetch;
+}
+
+export default class FetchTransport implements Transport {
+  public options: Options;
+
+  constructor({
+    baseURL,
+    fetch: fetchAlternative = fetch,
+    ...options
+  }: InputOptions) {
+    this.options = {
+      ...options,
+      fetch: fetchAlternative,
+      baseURL,
+    };
+  }
+
+  public getURL(url: string): string {
+    return new URL(url, this.options.baseURL).toString();
+  }
+
+  public getRequest(url: string, request: RequestInit): Request {
+    // Merge headers
+    request.headers = new Headers(request.headers);
+    for (const filterable of this.options.requestFilterables) {
+      const filterableHeaders = filterable.getHeaders();
+      for (const [headerName, headerValue] of Object.entries(
+        filterableHeaders,
+      )) {
+        request.headers.set(headerName, headerValue);
+      }
+    }
+
+    return new Request(this.getURL(url), request);
+  }
+
+  public async send(url: string, request: RequestInit) {
+    // See: https://github.com/node-fetch/node-fetch/issues/481#issuecomment-592491825
+    return await this.options
+      .fetch(this.getRequest(url, request))
+      .then((response) => {
+        if (!response.ok) {
+          const code = response.status;
+          console.error(JSON.stringify(response));
+
+          switch (code) {
+            case 400: {
+              throw ValidationError.badRequest();
+            }
+
+            case 401: {
+              throw AuthenticationError.unauthenticated();
+            }
+
+            case 403: {
+              throw AuthorizationError.forbidden();
+            }
+
+            case 404: {
+              throw LogicError.notFound(url);
+            }
+
+            case 405: {
+              throw LogicError.forbiddenMethod(url, request.method ?? "GET");
+            }
+          }
+        }
+
+        return response;
+      })
+      .catch((error) => {
+        if (isNetworkError(error)) {
+          throw new NetworkError("A network error occurred", { cause: error });
+        }
+
+        throw error;
+      });
+  }
+}

package/src/Transport/index.ts

@@ -11,50 +11,8 @@ import RequestFilterable from "../Request/RequestFilterable.js";
 
 export interface Options {
   requestFilterables: RequestFilterable[];
-  baseURL: string;
 }
 
-export interface SendOptions {
-  /**
-   * Alternative Fetch Provider.
-   * Used to override the default fetch provider and use polyfills or other
-   * libraries.
-   *
-   * @since 1.0.0
-   */
-  fetch?: typeof fetch;
-}
-
-export default class Transport {
-  public options: Options;
-
-  constructor({ baseURL, ...options }: Options) {
-    this.options = {
-      ...options,
-      baseURL,
-    };
-  }
-
-  protected async _filterRequest(request: RequestInit): Promise<RequestInit> {
-    for (const filterable of this.options.requestFilterables) {
-      request = await filterable.filter(request);
-    }
-
-    return request;
-  }
-
-  public getURL(url: string | URL): URL {
-    return new URL(url, this.options.baseURL);
-  }
-
-  public async send(
-    url: string | URL,
-    request: RequestInit,
-    { fetch: fetchAlternative = fetch }: SendOptions = {},
-  ) {
-    // See: https://github.com/node-fetch/node-fetch/issues/481#issuecomment-592491825
-    return await fetchAlternative(
-      new Request(this.getURL(url), await this._filterRequest(request)),
-    );
-  }
+export default interface Transport {
+  getURL(url: string): string;
 }

package/src/__tests__/Client/Client.test.ts

@@ -0,0 +1,38 @@
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+import { describe, expect, test } from "@jest/globals";
+import Client from "../../Client/index.js";
+import { DEFAULT_SUPPORT_BASE_URL } from "../../constants/index.js";
+
+describe("Client", () => {
+  describe("Determining Base URL", () => {
+    test("When a base URL is set via environment variables, it should be used as the default base URL", () => {
+      // Arrange
+      process.env.SUPPORT_BASE_URL = "https://example.com";
+
+      // Act
+      const baseURL = Client.getBaseURL();
+
+      // Assert
+      expect(baseURL).toBe(process.env.SUPPORT_BASE_URL);
+    });
+
+    test("When a base URL is not set via environment, the default should be assumed", () => {
+      // Arrange
+      process.env = { SUPPORT_BASE_URL: undefined };
+
+      // Act
+      const baseURL = Client.getBaseURL();
+
+      // Assert
+      expect(baseURL).toBe(DEFAULT_SUPPORT_BASE_URL);
+    });
+  });
+});

package/src/constants/environment.ts

@@ -0,0 +1,36 @@
+/**
+ * Great Detail Support System.
+ *
+ * @copyright 2024 Great Detail Ltd
+ * @author    Great Detail Ltd <info@greatdetail.com>
+ * @author    Dom Webber <dom.webber@greatdetail.com>
+ * @see       https://greatdetail.com
+ */
+
+/**
+ * The Token-Authentication Environment Variable Name.
+ *
+ * @since 1.0.0
+ */
+export const TOKEN_ENV_VAR = "SUPPORT_ACCESS_TOKEN";
+
+/**
+ * The API-Key Authentication Environment Variable Name.
+ *
+ * @since 1.0.0
+ */
+export const KEY_ENV_VAR = "SUPPORT_API_KEY";
+
+/**
+ * The API-Key Authentication Username Environment Variable Name.
+ *
+ * @since 1.0.0
+ */
+export const USER_ENV_VAR = "SUPPORT_KEY_NAME";
+
+/**
+ * The Base URL Environment Variable Name.
+ *
+ * @since 1.0.0
+ */
+export const BASE_URL_ENV_VAR = "SUPPORT_BASE_URL";

package/src/constants/index.ts

@@ -29,24 +29,3 @@ export const STANDARD_HEADERS = {
  * @since 1.0.0
  */
 export const DEFAULT_KEY_AUTHENTICATION_NAME = "api-key";
-
-/**
- * The Token-Authentication Environment Variable Name.
- *
- * @since 1.0.0
- */
-export const TOKEN_ENV_VAR = "SUPPORT_ACCESS_TOKEN";
-
-/**
- * The API-Key Authentication Environment Variable Name.
- *
- * @since 1.0.0
- */
-export const KEY_ENV_VAR = "SUPPORT_API_KEY";
-
-/**
- * The API-Key Authentication Username Environment Variable Name.
- *
- * @since 1.0.0
- */
-export const USER_ENV_VAR = "SUPPORT_KEY_NAME";

package/src/index.ts

@@ -12,12 +12,12 @@ export { DEFAULT_SUPPORT_BASE_URL } from "./constants/index.js";
 // Client
 export { default, default as Client, type Options } from "./Client/index.js";
 
+// Errors
+export * as Error from "./Error/index.js";
+
 // Transport & Filtering
 export { type default as RequestFilterable } from "./Request/RequestFilterable.js";
-export {
-  type Options as TransportOptions,
-  type SendOptions as TransportSendOptions,
-} from "./Transport/index.js";
+export { type Options as TransportOptions } from "./Transport/index.js";
 
 // Authentication
 export { default as KeyAuthentication } from "./Authentication/KeyAuthentication.js";

package/dist/chunk-2LKRKCHH.js

@@ -1 +0,0 @@
-var ut="https://api.support.greatdetail.com",lt={"X-Powered-By":"GDSupport/JavaScript"},gt="api-key",ht="SUPPORT_ACCESS_TOKEN",bt="SUPPORT_API_KEY",yt="SUPPORT_KEY_NAME";var i=class{constructor(t){this._transport=t}async send({request:t={},...s}={}){return this._transport.send("v1/actions",{...t,method:"GET"},s).then(n=>new M(n))}},M=class{constructor(t){this.response=t}async result(){return this.response.json()}};var p=class{constructor(t){this._transport=t}async send({request:t={},...s}={}){return this._transport.send("v1/channels",{...t,method:"GET"},s).then(n=>new D(n))}},D=class{constructor(t){this.response=t}async result(){return this.response.json()}};import{z as a}from"zod";var c=class e{constructor(t){this._transport=t}static SCHEMA=a.object({name:a.string(),account:a.string(),emailAddress:a.string().email().optional(),telephoneNumber:a.string().optional()});async send({body:t,request:s={},...n}){return this._transport.send("v1/contacts",{...s,method:"POST",headers:{...s.headers,"Content-Type":"application/json"},body:JSON.stringify(e.SCHEMA.parse(t))},n).then(r=>new G(r))}},G=class{constructor(t){this.response=t}async result(){return this.response.json()}};var d=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/contacts/"+encodeURIComponent(t),{...s,method:"GET"},n).then(r=>new z(r))}},z=class{constructor(t){this.response=t}async result(){return this.response.json()}};var u=class{constructor(t){this._transport=t}async send({request:t={},...s}={}){return this._transport.send("v1/contacts",{...t,method:"GET"},s).then(n=>new F(n))}},F=class{constructor(t){this.response=t}async result(){return this.response.json()}};var l=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/labels/"+encodeURIComponent(t)+"/contacts",{...s,method:"GET"},n).then(r=>new B(r))}},B=class{constructor(t){this.response=t}async result(){return this.response.json()}};import{z as L}from"zod";var m=class e{constructor(t){this._transport=t}static SCHEMA=L.object({name:L.string().optional(),emailAddress:L.string().email().optional(),telephoneNumber:L.string().optional()});async send({id:t,body:s,request:n={},...r}){return this._transport.send("v1/contacts/"+encodeURIComponent(t),{...n,method:"PATCH",headers:{...n.headers,"Content-Type":"application/json"},body:JSON.stringify(e.SCHEMA.parse(s))},r).then(o=>new J(o))}},J=class{constructor(t){this.response=t}async result(){return this.response.json()}};var g=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/conversations/"+encodeURIComponent(t),{...s,method:"GET"},n).then(r=>new K(r))}},K=class{constructor(t){this.response=t}async result(){return this.response.json()}};var h=class{constructor(t){this._transport=t}async send({request:t={},...s}={}){return this._transport.send("v1/conversations",{...t,method:"GET"},s).then(n=>new V(n))}},V=class{constructor(t){this.response=t}async result(){return this.response.json()}};var b=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/labels/"+encodeURIComponent(t)+"/conversations",{...s,method:"GET"},n).then(r=>new Y(r))}},Y=class{constructor(t){this.response=t}async result(){return this.response.json()}};import{z as mt}from"zod";var y=class e{constructor(t){this._transport=t}static SCHEMA=mt.object({hasEnded:mt.boolean()});async send({id:t,body:s,request:n={},...r}){return this._transport.send("v1/conversations/"+encodeURIComponent(t),{...n,method:"POST",headers:{...n.headers,"Content-Type":"application/json"},body:JSON.stringify(e.SCHEMA.parse(s))},r).then(o=>new k(o))}},k=class{constructor(t){this.response=t}async result(){return this.response.json()}};import{z as j}from"zod";var f=class e{constructor(t){this._transport=t}static SCHEMA=j.object({title:j.string(),description:j.string().optional(),account:j.string()});async send({body:t,request:s={},...n}){return this._transport.send("v1/labels",{...s,method:"POST",headers:{...s.headers,"Content-Type":"application/json"},body:JSON.stringify(e.SCHEMA.parse(t))},n).then(r=>new W(r))}},W=class{constructor(t){this.response=t}async result(){return this.response.json()}};var R=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/labels/"+encodeURIComponent(t),{...s,method:"DELETE"},n).then(r=>new X(r))}},X=class{constructor(t){this.response=t}async result(){return this.response.json()}};var x=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/labels/"+encodeURIComponent(t),{...s,method:"GET"},n).then(r=>new Q(r))}},Q=class{constructor(t){this.response=t}async result(){return this.response.json()}};var S=class{constructor(t){this._transport=t}async send({request:t={},...s}={}){return this._transport.send("v1/labels",{...t,method:"GET"},s).then(n=>new Z(n))}},Z=class{constructor(t){this.response=t}async result(){return this.response.json()}};import{z as $}from"zod";var O=class e{constructor(t){this._transport=t}static SCHEMA=$.object({title:$.string().optional(),description:$.string().optional()});async send({id:t,body:s,request:n={},...r}){return this._transport.send("v1/labels/"+encodeURIComponent(t),{...n,method:"PATCH",headers:{...n.headers,"Content-Type":"application/json"},body:JSON.stringify(e.SCHEMA.parse(s))},r).then(o=>new tt(o))}},tt=class{constructor(t){this.response=t}async result(){return this.response.json()}};var A=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/conversations/"+encodeURIComponent(t)+"/messages",{...s,method:"GET"},n).then(r=>new et(r))}},et=class{constructor(t){this.response=t}async result(){return this.response.json()}};var _=class{constructor(t){this._transport=t}async send({request:t={},...s}={}){return this._transport.send("v1/messages",{...t,method:"GET"},s).then(n=>new st(n))}},st=class{constructor(t){this.response=t}async result(){return this.response.json()}};import{z as H}from"zod";var T=class e{constructor(t){this._transport=t}static SCHEMA=H.object({input:H.string().max(65536),original:H.string().max(65536),correction:H.string().max(65536)});async send({id:t,body:s,request:n={},...r}){return this._transport.send("v1/models/"+encodeURIComponent(t)+"/correction",{...n,method:"POST",headers:{...n.headers,"Content-Type":"application/json"},body:JSON.stringify(e.SCHEMA.parse(s))},r).then(o=>new nt(o))}},nt=class{constructor(t){this.response=t}async result(){return this.response.json()}};var C=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/models/"+encodeURIComponent(t),{...s,method:"GET"},n).then(r=>new rt(r))}},rt=class{constructor(t){this.response=t}async result(){return this.response.json()}};var P=class{constructor(t){this._transport=t}async send({request:t={},...s}={}){return this._transport.send("v1/models",{...t,method:"GET"},s).then(n=>new ot(n))}},ot=class{constructor(t){this.response=t}async result(){return this.response.json()}};import{z as N}from"zod";var E=class e{constructor(t){this._transport=t}static SCHEMA=N.array(N.object({role:N.enum(["user","assistant"]),content:N.string().max(65536).nullable()})).min(1);async send({id:t,body:s,request:n={},...r}){return this._transport.send("v1/models/"+encodeURIComponent(t)+"/response",{...n,method:"POST",headers:{...n.headers,"Content-Type":"application/json"},body:JSON.stringify(e.SCHEMA.parse(s))},r).then(o=>new it(o))}},it=class{constructor(t){this.response=t}async result(){return this.response.json()}};var v=class{constructor(t){this._transport=t}async send({id:t,request:s={},...n}){return this._transport.send("v1/sources/"+encodeURIComponent(t),{...s,method:"GET"},n).then(r=>new pt(r))}},pt=class{constructor(t){this.response=t}async result(){return this.response.json()}};var w=class{constructor(t){this._transport=t}async send({request:t={},...s}={}){return this._transport.send("v1/sources",{...t,method:"GET"},s).then(n=>new at(n))}},at=class{constructor(t){this.response=t}async result(){return this.response.json()}};var U=class{options;constructor({baseURL:t,...s}){this.options={...s,baseURL:t}}async _filterRequest(t){for(let s of this.options.requestFilterables)t=await s.filter(t);return t}getURL(t){return new URL(t,this.options.baseURL)}async send(t,s,{fetch:n=fetch}={}){return await n(new Request(this.getURL(t),await this._filterRequest(s)))}};var q=class{constructor(t){this._transport=t}async send({id:t}){return this._transport.getURL("v1/contacts/"+encodeURIComponent(t)+"/vcf")}};var I=class e{constructor(t=e.STANDARD_HEADERS){this._standardHeaders=t}static STANDARD_HEADERS=lt;async filter(t){return{...t,headers:{...t.headers,...this._standardHeaders}}}};var ct=class e{static DEFAULT_BASE_URL=ut;_transport;constructor(t,{baseURL:s,...n}={}){this._transport=new U({requestFilterables:[new I,t],...n,baseURL:s?.toString()??e.getBaseURL()})}static getBaseURL(){return process.env.SUPPORT_BASE_URL??this.DEFAULT_BASE_URL}get action(){return{list:new i(this._transport)}}get channel(){return{list:new p(this._transport)}}get contact(){return{get:new d(this._transport),list:new u(this._transport),update:new m(this._transport),create:new c(this._transport),vcf:{getURL:new q(this._transport)}}}get conversation(){return{get:new g(this._transport),list:new h(this._transport),update:new y(this._transport),message:{list:new A(this._transport)}}}get label(){return{create:new f(this._transport),get:new x(this._transport),list:new S(this._transport),update:new O(this._transport),delete:new R(this._transport),contact:{list:new l(this._transport)},conversation:{list:new b(this._transport)}}}get message(){return{list:new _(this._transport)}}get model(){return{get:new C(this._transport),list:new P(this._transport),response:{create:new E(this._transport)},correction:{create:new T(this._transport)}}}get source(){return{get:new v(this._transport),list:new w(this._transport)}}};var dt=class{async filter(t){return t}};export{ut as a,gt as b,ht as c,bt as d,yt as e,ct as f,dt as g};

package/src/__tests__/Authentication/KeyAuthentication.test.ts

@@ -1,79 +0,0 @@
-/**
- * Great Detail Support System.
- *
- * @copyright 2024 Great Detail Ltd
- * @author    Great Detail Ltd <info@greatdetail.com>
- * @author    Dom Webber <dom.webber@greatdetail.com>
- * @see       https://greatdetail.com
- */
-
-import { describe, expect, test } from "@jest/globals";
-import KeyAuthentication from "../../Authentication/KeyAuthentication.js";
-
-describe("KeyAuthentication", () => {
-  describe("Authentication application via filtering", () => {
-    test("When an api key is sourced from environment variables, it should be added in request headers", async () => {
-      // Arrange
-      const key = "example-api-key";
-      process.env.SUPPORT_API_KEY = key;
-      const auth = new KeyAuthentication();
-      const init = {
-        headers: {
-          // Ensure that existing, non-colliding, headers remain
-          "X-Trace-ID": "example",
-
-          // Ensure that existing, colliding, headers are overwritten
-          Authorization: "Basic ZXhhbXBsZTpleGFtcGxl", // example:example
-        },
-      };
-
-      // Act
-      const request = await auth.filter(init);
-
-      // Assert
-      expect(request).toHaveProperty("headers");
-      expect(request.headers).toHaveProperty(
-        "Authorization",
-        "Basic YXBpLWtleTpleGFtcGxlLWFwaS1rZXk=",
-      );
-      expect(request.headers).toHaveProperty("X-Trace-ID", "example");
-    });
-
-    test("When an api key is sourced directly, it should be added in request headers", async () => {
-      // Arrange
-      const key = "example-api-key";
-      const auth = new KeyAuthentication({ key });
-      const init = {
-        headers: {
-          // Ensure that existing, non-colliding, headers remain
-          "X-Trace-ID": "example",
-
-          // Ensure that existing, colliding, headers are overwritten
-          Authorization: "Basic ZXhhbXBsZTpleGFtcGxl", // example:example
-        },
-      };
-
-      // Act
-      const request = await auth.filter(init);
-
-      // Assert
-      expect(request).toHaveProperty("headers");
-      expect(request.headers).toHaveProperty(
-        "Authorization",
-        "Basic YXBpLWtleTpleGFtcGxlLWFwaS1rZXk=",
-      );
-      expect(request.headers).toHaveProperty("X-Trace-ID", "example");
-    });
-
-    test("When no api key can be found, the constructor should throw", async () => {
-      // Arrange
-      process.env = {};
-
-      // Act
-      const auth = () => new KeyAuthentication(); // eslint-disable-line unicorn/consistent-function-scoping
-
-      // Assert
-      expect(auth).toThrow();
-    });
-  });
-});

package/src/__tests__/Authentication/TokenAuthentication.test.ts

@@ -1,79 +0,0 @@
-/**
- * Great Detail Support System.
- *
- * @copyright 2024 Great Detail Ltd
- * @author    Great Detail Ltd <info@greatdetail.com>
- * @author    Dom Webber <dom.webber@greatdetail.com>
- * @see       https://greatdetail.com
- */
-
-import { describe, expect, test } from "@jest/globals";
-import TokenAuthentication from "../../Authentication/TokenAuthentication.js";
-
-describe("TokenAuthentication", () => {
-  describe("Authentication application via filtering", () => {
-    test("When a token is sourced from environment variables, it should be added in request headers", async () => {
-      // Arrange
-      const token = "example-access-token";
-      process.env.SUPPORT_ACCESS_TOKEN = token;
-      const auth = new TokenAuthentication();
-      const init = {
-        headers: {
-          // Ensure that existing, non-colliding, headers remain
-          "X-Trace-ID": "example",
-
-          // Ensure that existing, colliding, headers are overwritten
-          Authorization: "Basic ZXhhbXBsZTpleGFtcGxl", // example:example
-        },
-      };
-
-      // Act
-      const request = await auth.filter(init);
-
-      // Assert
-      expect(request).toHaveProperty("headers");
-      expect(request.headers).toHaveProperty(
-        "Authorization",
-        "Bearer " + token,
-      );
-      expect(request.headers).toHaveProperty("X-Trace-ID", "example");
-    });
-
-    test("When a token is sourced directly, it should be added in request headers", async () => {
-      // Arrange
-      const token = "example-access-token";
-      const auth = new TokenAuthentication({ token });
-      const init = {
-        headers: {
-          // Ensure that existing, non-colliding, headers remain
-          "X-Trace-ID": "example",
-
-          // Ensure that existing, colliding, headers are overwritten
-          Authorization: "Basic ZXhhbXBsZTpleGFtcGxl", // example:example
-        },
-      };
-
-      // Act
-      const request = await auth.filter(init);
-
-      // Assert
-      expect(request).toHaveProperty("headers");
-      expect(request.headers).toHaveProperty(
-        "Authorization",
-        "Bearer " + token,
-      );
-      expect(request.headers).toHaveProperty("X-Trace-ID", "example");
-    });
-
-    test("When no token can be found, the constructor should throw", async () => {
-      // Arrange
-      process.env = {};
-
-      // Act
-      const auth = () => new TokenAuthentication(); // eslint-disable-line unicorn/consistent-function-scoping
-
-      // Assert
-      expect(auth).toThrow();
-    });
-  });
-});