@great-detail/support-sdk 0.0.4 → 0.0.6

package/src/Client/index.ts

@@ -11,17 +11,21 @@ import ListActionsRequest from "../Action/ListActions.js";
 import Authentication from "../Authentication/index.js";
 import ListChannelsRequest from "../Channel/ListChannels.js";
 import { DEFAULT_SUPPORT_BASE_URL } from "../constants/index.js";
+import GetContactRequest from "../Contact/GetContact.js";
 import ListContactsRequest from "../Contact/ListContacts.js";
 import GetConversationRequest from "../Conversation/GetConversation.js";
 import ListConversationsRequest from "../Conversation/ListConversations.js";
 import CreateLabelRequest from "../Label/CreateLabel.js";
+import GetLabelRequest from "../Label/GetLabel.js";
 import ListLabelsRequest from "../Label/ListLabels.js";
 import ListMessagesRequest from "../Message/ListMessages.js";
 import CreateCorrectionModelRequest from "../Model/Correction/CreateCorrectionModel.js";
+import GetModelRequest from "../Model/GetModel.js";
 import ListModelsRequest from "../Model/ListModels.js";
 import CreateResponseModelRequest from "../Model/Response/CreateResponseModel.js";
 import RequestFilterable from "../Request/RequestFilterable.js";
 import RequestStandardHeaders from "../Request/RequestStandardHeaders.js";
+import GetSourceRequest from "../Source/GetSource.js";
 import ListSourcesRequest from "../Source/ListSources.js";
 
 export interface ClientOptions {
@@ -69,6 +73,7 @@ export default class Client {
   };
 
   public contact = {
+    get: new GetContactRequest(this),
     list: new ListContactsRequest(this),
   };
 
@@ -79,6 +84,7 @@ export default class Client {
 
   public label = {
     create: new CreateLabelRequest(this),
+    get: new GetLabelRequest(this),
     list: new ListLabelsRequest(this),
   };
 
@@ -87,6 +93,7 @@ export default class Client {
   };
 
   public model = {
+    get: new GetModelRequest(this),
     list: new ListModelsRequest(this),
     response: {
       create: new CreateResponseModelRequest(this),
@@ -97,6 +104,7 @@ export default class Client {
   };
 
   public source = {
+    get: new GetSourceRequest(this),
     list: new ListSourcesRequest(this),
   };
 

package/src/Contact/GetContact.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 Client, { SendOptions } from "../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class GetContactRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/contacts/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new GetContactResponse(response));
+  }
+}
+
+export type GetContactResponsePayload = {
+  contact: {
+    id: string;
+    name?: string;
+    emailAddress?: string;
+    telephoneNumber?: string;
+    account: string;
+    createdAt: string;
+    updatedAt?: string;
+  };
+};
+
+export class GetContactResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<GetContactResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Contact/ListContacts.ts

@@ -36,6 +36,7 @@ export type ListContactsResponsePayload = {
     name?: string;
     emailAddress?: string;
     telephoneNumber?: string;
+    account: string;
     createdAt: string;
     updatedAt?: string;
   }[];

package/src/Label/CreateLabel.ts

@@ -48,6 +48,7 @@ export type CreateLabelResponsePayload = {
     id: string;
     title: string;
     description?: string;
+    account: string;
     createdAt: string;
     updatedAt?: string;
   };

package/src/Label/GetLabel.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 Client, { SendOptions } from "../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class GetLabelRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/labels/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new GetLabelResponse(response));
+  }
+}
+
+export type GetLabelResponsePayload = {
+  label: {
+    id: string;
+    title: string;
+    description?: string;
+    account: string;
+    createdAt: string;
+    updatedAt?: string;
+  };
+};
+
+export class GetLabelResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<GetLabelResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Label/ListLabels.ts

@@ -35,6 +35,7 @@ export type ListLabelsResponsePayload = {
     id: string;
     title: string;
     description?: string;
+    account: string;
     createdAt: string;
     updatedAt?: string;
   }[];

package/src/Message/ListMessages.ts

@@ -38,6 +38,13 @@ export type ListMessagesResponsePayload = {
     externalIdentifier?: string;
     conversation: string;
     contact: string;
+    messageEvents: {
+      id: string;
+      messageEventType: string;
+      triggeredAt: string;
+      createdAt: string;
+      updatedAt?: string;
+    }[];
     createdAt: string;
     updatedAt: string;
   }[];

package/src/Model/GetModel.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 Client, { SendOptions } from "../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class GetModelRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/models/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new GetModelResponse(response));
+  }
+}
+
+export type GetModelResponsePayload = {
+  model: {
+    id: string;
+    name: string;
+    url?: string;
+    icon?: string;
+    disambiguatingDescription: string;
+  };
+};
+
+export class GetModelResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<GetModelResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Model/ListModels.ts

@@ -34,8 +34,8 @@ export type ListModelsResponsePayload = {
   models: {
     id: string;
     name: string;
-    url: string;
-    icon: string;
+    url?: string;
+    icon?: string;
     disambiguatingDescription: string;
   }[];
 };

package/src/Source/GetSource.ts

@@ -0,0 +1,51 @@
+/**
+ * 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 Client, { SendOptions } from "../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class GetSourceRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/sources/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new GetSourceResponse(response));
+  }
+}
+
+export type GetSourceResponsePayload = {
+  source: {
+    id: string;
+    name: string;
+    category: string;
+    url?: string;
+    icon?: string;
+    disambiguatingDescription: string;
+  };
+};
+
+export class GetSourceResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<GetSourceResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Source/ListSources.ts

@@ -35,7 +35,8 @@ export type ListSourcesResponsePayload = {
     id: string;
     name: string;
     category: string;
-    url: string;
+    url?: string;
+    icon?: string;
     disambiguatingDescription: string;
   }[];
 };

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

@@ -0,0 +1,79 @@
+/**
+ * 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

@@ -0,0 +1,79 @@
+/**
+ * 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();
+    });
+  });
+});

package/src/cli/contacts.ts

@@ -16,6 +16,20 @@ export interface Options extends CommandOptions {}
 export default function contacts({ client, ora }: Options) {
   const command = new Command("contacts").description("Contacts");
 
+  command.addCommand(
+    new Command("get")
+      .description("Find contact")
+      .argument("<contact>", "Contact ID")
+      .action(async (id) => {
+        const result = await oraPromise(() => client.contact.get.send({ id }), {
+          ...ora,
+          text: "Finding contact",
+        });
+
+        console.log(await result.result());
+      }),
+  );
+
   command.addCommand(
     new Command("list").description("List contacts").action(async () => {
       const result = await oraPromise(() => client.contact.list.send(), {

package/src/cli/labels.ts

@@ -16,6 +16,20 @@ export interface Options extends CommandOptions {}
 export default function labels({ client, ora }: Options) {
   const command = new Command("labels").description("Labels");
 
+  command.addCommand(
+    new Command("get")
+      .description("Find label")
+      .argument("<label>", "Label ID")
+      .action(async (id) => {
+        const result = await oraPromise(() => client.label.get.send({ id }), {
+          ...ora,
+          text: "Finding label",
+        });
+
+        console.log(await result.result());
+      }),
+  );
+
   command.addCommand(
     new Command("list").description("List labels").action(async () => {
       const result = await oraPromise(() => client.label.list.send(), {

package/src/cli/models.ts

@@ -16,6 +16,20 @@ export interface Options extends CommandOptions {}
 export default function models({ client, ora }: Options) {
   const command = new Command("models").description("Models");
 
+  command.addCommand(
+    new Command("get")
+      .description("Find model")
+      .argument("<model>", "Model ID")
+      .action(async (id) => {
+        const result = await oraPromise(() => client.model.get.send({ id }), {
+          ...ora,
+          text: "Finding model",
+        });
+
+        console.log(await result.result());
+      }),
+  );
+
   command.addCommand(
     new Command("list").description("List models").action(async () => {
       const result = await oraPromise(() => client.model.list.send(), {

package/src/cli/sources.ts

@@ -16,6 +16,20 @@ export interface Options extends CommandOptions {}
 export default function sources({ client, ora }: Options) {
   const command = new Command("sources").description("Sources");
 
+  command.addCommand(
+    new Command("get")
+      .description("Find source")
+      .argument("<source>", "Source ID")
+      .action(async (id) => {
+        const result = await oraPromise(() => client.source.get.send({ id }), {
+          ...ora,
+          text: "Finding source",
+        });
+
+        console.log(await result.result());
+      }),
+  );
+
   command.addCommand(
     new Command("list").description("List sources").action(async () => {
       const result = await oraPromise(() => client.source.list.send(), {

package/src/constants/index.ts

@@ -29,3 +29,24 @@ 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/dist/chunk-WCSPJBPY.js

@@ -1 +0,0 @@
-var j="https://api.support.greatdetail.com",H={"X-Powered-By":"GDSupport/JavaScript"},F="api-key";var O=class{async filter(e){return e}};var o=class{constructor(e){this._client=e}async send({request:e={},...s}={}){return this._client.send("/v1/actions",{...e,method:"GET"},s).then(n=>new C(n))}},C=class{constructor(e){this.response=e}async result(){return this.response.json()}};var i=class{constructor(e){this._client=e}async send({request:e={},...s}={}){return this._client.send("/v1/channels",{...e,method:"GET"},s).then(n=>new A(n))}},A=class{constructor(e){this.response=e}async result(){return this.response.json()}};var p=class{constructor(e){this._client=e}async send({request:e={},...s}={}){return this._client.send("/v1/contacts",{...e,method:"GET"},s).then(n=>new P(n))}},P=class{constructor(e){this.response=e}async result(){return this.response.json()}};var c=class{constructor(e){this._client=e}async send({id:e,request:s={},...n}){return this._client.send("/v1/conversations/"+encodeURIComponent(e),{...s,method:"GET"},n).then(r=>new _(r))}},_=class{constructor(e){this.response=e}async result(){return this.response.json()}};var a=class{constructor(e){this._client=e}async send({request:e={},...s}={}){return this._client.send("/v1/conversations",{...e,method:"GET"},s).then(n=>new E(n))}},E=class{constructor(e){this.response=e}async result(){return this.response.json()}};import{z as l}from"zod";var d=class t{constructor(e){this._client=e}static SCHEMA=l.object({title:l.string(),description:l.optional(l.string()),account:l.string()});async send({body:e,request:s={},...n}){return this._client.send("/v1/labels",{...s,method:"POST",headers:{...s.headers,"Content-Type":"application/json"},body:JSON.stringify(t.SCHEMA.parse(e))},n).then(r=>new q(r))}},q=class{constructor(e){this.response=e}async result(){return this.response.json()}};var u=class{constructor(e){this._client=e}async send({request:e={},...s}={}){return this._client.send("/v1/labels",{...e,method:"GET"},s).then(n=>new w(n))}},w=class{constructor(e){this.response=e}async result(){return this.response.json()}};var m=class{constructor(e){this._client=e}async send({request:e={},...s}={}){return this._client.send("/v1/messages",{...e,method:"GET"},s).then(n=>new T(n))}},T=class{constructor(e){this.response=e}async result(){return this.response.json()}};import{z as R}from"zod";var h=class t{constructor(e){this._client=e}static SCHEMA=R.object({input:R.string().max(65536),original:R.string().max(65536),correction:R.string().max(65536)});async send({id:e,body:s,request:n={},...r}){return this._client.send("/v1/models/"+encodeURIComponent(e)+"/correction",{...n,method:"POST",headers:{...n.headers,"Content-Type":"application/json"},body:JSON.stringify(t.SCHEMA.parse(s))},r).then(S=>new L(S))}},L=class{constructor(e){this.response=e}async result(){return this.response.json()}};var b=class{constructor(e){this._client=e}async send({request:e={},...s}={}){return this._client.send("/v1/models",{...e,method:"GET"},s).then(n=>new I(n))}},I=class{constructor(e){this.response=e}async result(){return this.response.json()}};import{z as x}from"zod";var f=class t{constructor(e){this._client=e}static SCHEMA=x.array(x.object({role:x.enum(["user","assistant"]),content:x.string().max(65536).nullable()})).min(1);async send({id:e,body:s,request:n={},...r}){return this._client.send("/v1/models/"+encodeURIComponent(e)+"/response",{...n,method:"POST",headers:{...n.headers,"Content-Type":"application/json"},body:JSON.stringify(t.SCHEMA.parse(s))},r).then(S=>new v(S))}},v=class{constructor(e){this.response=e}async result(){return this.response.json()}};var g=class{constructor(e){this._client=e}async send({request:e={},...s}={}){return this._client.send("/v1/sources",{...e,method:"GET"},s).then(n=>new U(n))}},U=class{constructor(e){this.response=e}async result(){return this.response.json()}};var y=class t{constructor(e=t.STANDARD_HEADERS){this._standardHeaders=e}static STANDARD_HEADERS=H;async filter(e){return{...e,headers:{...e.headers,...this._standardHeaders}}}};var D=class t{static DEFAULT_BASE_URL=j;options;constructor(e,s={}){this.options={requestFilterables:[new y,e],baseURL:process.env.SUPPORT_BASE_URL??t.DEFAULT_BASE_URL,...s}}action={list:new o(this)};channel={list:new i(this)};contact={list:new p(this)};conversation={get:new c(this),list:new a(this)};label={create:new d(this),list:new u(this)};message={list:new m(this)};model={list:new b(this),response:{create:new f(this)},correction:{create:new h(this)}};source={list:new g(this)};async _filterRequest(e){for(let s of this.options.requestFilterables)e=await s.filter(e);return e}async send(e,s,{fetch:n=fetch}={}){return await n(new Request(new URL(e,this.options.baseURL),await this._filterRequest(s)))}};export{j as a,F as b,O as c,D as d};