@great-detail/support-sdk 0.0.9 → 0.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@great-detail/support-sdk",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "type": "module",
   "description": "JavaScript SDK for the Great Detail Support System",
   "author": "Great Detail Ltd <info@greatdetail.com>",

package/src/Action/ListActions.ts

@@ -7,19 +7,19 @@
  * @see       https://greatdetail.com
  */
 
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   request?: RequestInit;
 }
 
 export default class ListActionsRequest {
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ request = {}, ...options }: Options = {}) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/actions",
+        "v1/actions",
         {
           ...request,
           method: "GET",

package/src/Authentication/PublicAuthentication.ts

@@ -11,6 +11,10 @@ import Authentication from "./index.js";
 
 /**
  * Public Authentication Configuration.
+ * This type of authentication doesn't define any authentication for outgoing
+ * HTTP requests. This functionality may work well when using a proxying method
+ * to add credentials to a request after-the-fact.
+ *
  * Note: Not all APIs and endpoints will work with this authentication type.
  *
  * @since 1.0.l0

package/src/Channel/ListChannels.ts

@@ -7,19 +7,19 @@
  * @see       https://greatdetail.com
  */
 
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   request?: RequestInit;
 }
 
 export default class ListChannelsRequest {
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ request = {}, ...options }: Options = {}) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/channels",
+        "v1/channels",
         {
           ...request,
           method: "GET",

package/src/Client/index.ts

@@ -13,126 +13,118 @@ 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 UpdateContactRequest from "../Contact/UpdateContact.js";
 import GetConversationRequest from "../Conversation/GetConversation.js";
 import ListConversationsRequest from "../Conversation/ListConversations.js";
+import ListLabelConversations from "../Conversation/ListLabelConversations.js";
 import UpdateConversationRequest from "../Conversation/UpdateConversation.js";
 import CreateLabelRequest from "../Label/CreateLabel.js";
+import DeleteLabelRequest from "../Label/DeleteLabel.js";
 import GetLabelRequest from "../Label/GetLabel.js";
 import ListLabelsRequest from "../Label/ListLabels.js";
+import UpdateLabelRequest from "../Label/UpdateLabel.js";
 import ListConversationMessages from "../Message/ListConversationMessages.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";
+import Transport from "../Transport/index.js";
 
 export interface ClientOptions {
-  requestFilterables: RequestFilterable[];
-  baseURL: string;
-}
-
-export interface InputClientOptions {
-  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;
+  baseURL?: string | URL;
 }
 
 export default class Client {
   public static DEFAULT_BASE_URL = DEFAULT_SUPPORT_BASE_URL;
 
-  public options: ClientOptions;
+  public transport: Transport;
 
   constructor(
     authentication: Authentication,
-    options: InputClientOptions = {},
+    { baseURL, ...options }: ClientOptions = {},
   ) {
-    this.options = {
+    this.transport = new Transport({
       requestFilterables: [new RequestStandardHeaders(), authentication],
-      baseURL: process.env.SUPPORT_BASE_URL ?? Client.DEFAULT_BASE_URL,
       ...options,
-    };
+      baseURL: baseURL?.toString() ?? Client.getBaseURL(),
+    });
   }
 
-  public action = {
-    list: new ListActionsRequest(this),
-  };
-
-  public channel = {
-    list: new ListChannelsRequest(this),
-  };
-
-  public contact = {
-    get: new GetContactRequest(this),
-    list: new ListContactsRequest(this),
-  };
+  public static getBaseURL(): string {
+    return process.env.SUPPORT_BASE_URL ?? this.DEFAULT_BASE_URL;
+  }
 
-  public conversation = {
-    get: new GetConversationRequest(this),
-    list: new ListConversationsRequest(this),
-    update: new UpdateConversationRequest(this),
-    message: {
-      list: new ListConversationMessages(this),
-    },
-  };
+  public get action() {
+    return {
+      list: new ListActionsRequest(this.transport),
+    };
+  }
 
-  public label = {
-    create: new CreateLabelRequest(this),
-    get: new GetLabelRequest(this),
-    list: new ListLabelsRequest(this),
-  };
+  public get channel() {
+    return {
+      list: new ListChannelsRequest(this.transport),
+    };
+  }
 
-  public message = {
-    list: new ListMessagesRequest(this),
-  };
+  public get contact() {
+    return {
+      get: new GetContactRequest(this.transport),
+      list: new ListContactsRequest(this.transport),
+      update: new UpdateContactRequest(this.transport),
+    };
+  }
 
-  public model = {
-    get: new GetModelRequest(this),
-    list: new ListModelsRequest(this),
-    response: {
-      create: new CreateResponseModelRequest(this),
-    },
-    correction: {
-      create: new CreateCorrectionModelRequest(this),
-    },
-  };
+  public get conversation() {
+    return {
+      get: new GetConversationRequest(this.transport),
+      list: new ListConversationsRequest(this.transport),
+      update: new UpdateConversationRequest(this.transport),
+      message: {
+        list: new ListConversationMessages(this.transport),
+      },
+    };
+  }
 
-  public source = {
-    get: new GetSourceRequest(this),
-    list: new ListSourcesRequest(this),
-  };
+  public get label() {
+    return {
+      create: new CreateLabelRequest(this.transport),
+      get: new GetLabelRequest(this.transport),
+      list: new ListLabelsRequest(this.transport),
+      update: new UpdateLabelRequest(this.transport),
+      delete: new DeleteLabelRequest(this.transport),
+      conversation: {
+        list: new ListLabelConversations(this.transport),
+      },
+    };
+  }
 
-  protected async _filterRequest(request: RequestInit): Promise<RequestInit> {
-    for (const filterable of this.options.requestFilterables) {
-      request = await filterable.filter(request);
-    }
+  public get message() {
+    return {
+      list: new ListMessagesRequest(this.transport),
+    };
+  }
 
-    return request;
+  public get model() {
+    return {
+      get: new GetModelRequest(this.transport),
+      list: new ListModelsRequest(this.transport),
+      response: {
+        create: new CreateResponseModelRequest(this.transport),
+      },
+      correction: {
+        create: new CreateCorrectionModelRequest(this.transport),
+      },
+    };
   }
 
-  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(
-        new URL(url, this.options.baseURL),
-        await this._filterRequest(request),
-      ),
-    );
+  public get source() {
+    return {
+      get: new GetSourceRequest(this.transport),
+      list: new ListSourcesRequest(this.transport),
+    };
   }
 }

package/src/Contact/GetContact.ts

@@ -7,7 +7,7 @@
  * @see       https://greatdetail.com
  */
 
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   id: string;
@@ -15,12 +15,12 @@ export interface Options extends SendOptions {
 }
 
 export default class GetContactRequest {
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ id, request = {}, ...options }: Options) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/contacts/" + encodeURIComponent(id),
+        "v1/contacts/" + encodeURIComponent(id),
         {
           ...request,
           method: "GET",

package/src/Contact/ListContacts.ts

@@ -7,19 +7,19 @@
  * @see       https://greatdetail.com
  */
 
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   request?: RequestInit;
 }
 
 export default class ListContactsRequest {
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ request = {}, ...options }: Options = {}) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/contacts",
+        "v1/contacts",
         {
           ...request,
           method: "GET",

package/src/Contact/UpdateContact.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { z } from "zod";
+import Client, { SendOptions } from "../Transport/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  body: z.infer<typeof UpdateContactRequest.SCHEMA>;
+  request?: RequestInit;
+}
+
+export default class UpdateContactRequest {
+  public static SCHEMA = z.object({
+    name: z.string().optional(),
+    emailAddress: z.string().email().optional(),
+    telephoneNumber: z.string().optional(),
+  });
+
+  constructor(protected _transport: Client) {}
+
+  public async send({ id, body, request = {}, ...options }: Options) {
+    return this._transport
+      .send(
+        "v1/contacts/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "PATCH",
+          headers: {
+            ...request.headers,
+            "Content-Type": "application/json",
+          },
+          body: JSON.stringify(UpdateContactRequest.SCHEMA.parse(body)),
+        },
+        options,
+      )
+      .then((response) => new UpdateContactResponse(response));
+  }
+}
+
+export type UpdateContactResponsePayload = {
+  contact: {
+    id: string;
+    name?: string;
+    emailAddress?: string;
+    telephoneNumber?: string;
+    account: string;
+    createdAt: string;
+    updatedAt?: string;
+  };
+};
+
+export class UpdateContactResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<UpdateContactResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Conversation/GetConversation.ts

@@ -7,7 +7,7 @@
  * @see       https://greatdetail.com
  */
 
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   id: string;
@@ -15,12 +15,12 @@ export interface Options extends SendOptions {
 }
 
 export default class GetConversationRequest {
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ id, request = {}, ...options }: Options) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/conversations/" + encodeURIComponent(id),
+        "v1/conversations/" + encodeURIComponent(id),
         {
           ...request,
           method: "GET",

package/src/Conversation/ListConversations.ts

@@ -7,19 +7,19 @@
  * @see       https://greatdetail.com
  */
 
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   request?: RequestInit;
 }
 
 export default class ListConversationsRequest {
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ request = {}, ...options }: Options = {}) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/conversations",
+        "v1/conversations",
         {
           ...request,
           method: "GET",

package/src/Conversation/ListLabelConversations.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 "../Transport/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class ListLabelConversations {
+  constructor(protected _transport: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._transport
+      .send(
+        "v1/labels/" + encodeURIComponent(id) + "/conversations",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListLabelConversationsResponse(response));
+  }
+}
+
+export type ListLabelConversationsResponsePayload = {
+  conversations: {
+    id: string;
+    name?: string;
+    hasEnded: boolean;
+    conversationStatus:
+      | "AwaitingContactConversationStatus"
+      | "AwaitingAgentConversationStatus"
+      | "ResolvedConversationStatus"
+      | "ClosedConversationStatus";
+    accountChannel: string;
+    createdAt: string;
+    updatedAt: string;
+  }[];
+};
+
+export class ListLabelConversationsResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListLabelConversationsResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Conversation/UpdateConversation.ts

@@ -8,7 +8,7 @@
  */
 
 import { z } from "zod";
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   id: string;
@@ -21,12 +21,12 @@ export default class UpdateConversationRequest {
     hasEnded: z.boolean(),
   });
 
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ id, body, request = {}, ...options }: Options) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/conversations/" + encodeURIComponent(id),
+        "v1/conversations/" + encodeURIComponent(id),
         {
           ...request,
           method: "POST",

package/src/Label/CreateLabel.ts

@@ -8,7 +8,7 @@
  */
 
 import { z } from "zod";
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   body: z.infer<typeof CreateLabelRequest.SCHEMA>;
@@ -18,16 +18,16 @@ export interface Options extends SendOptions {
 export default class CreateLabelRequest {
   public static SCHEMA = z.object({
     title: z.string(),
-    description: z.optional(z.string()),
+    description: z.string().optional(),
     account: z.string(),
   });
 
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ body, request = {}, ...options }: Options) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/labels",
+        "v1/labels",
         {
           ...request,
           method: "POST",

package/src/Label/DeleteLabel.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 "../Transport/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  request?: RequestInit;
+}
+
+export default class DeleteLabelRequest {
+  constructor(protected _transport: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._transport
+      .send(
+        "v1/labels/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "DELETE",
+        },
+        options,
+      )
+      .then((response) => new DeleteLabelResponse(response));
+  }
+}
+
+export type DeleteLabelResponsePayload = Record<string, never>;
+
+export class DeleteLabelResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<DeleteLabelResponsePayload> {
+    return this.response.json();
+  }
+}

package/src/Label/GetLabel.ts

@@ -7,7 +7,7 @@
  * @see       https://greatdetail.com
  */
 
-import Client, { SendOptions } from "../Client/index.js";
+import Client, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   id: string;
@@ -15,12 +15,12 @@ export interface Options extends SendOptions {
 }
 
 export default class GetLabelRequest {
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Client) {}
 
   public async send({ id, request = {}, ...options }: Options) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/labels/" + encodeURIComponent(id),
+        "v1/labels/" + encodeURIComponent(id),
         {
           ...request,
           method: "GET",

package/src/Label/ListLabels.ts

@@ -7,19 +7,19 @@
  * @see       https://greatdetail.com
  */
 
-import Client, { SendOptions } from "../Client/index.js";
+import Transport, { SendOptions } from "../Transport/index.js";
 
 export interface Options extends SendOptions {
   request?: RequestInit;
 }
 
 export default class ListLabelsRequest {
-  constructor(protected _client: Client) {}
+  constructor(protected _transport: Transport) {}
 
   public async send({ request = {}, ...options }: Options = {}) {
-    return this._client
+    return this._transport
       .send(
-        "/v1/labels",
+        "v1/labels",
         {
           ...request,
           method: "GET",