@great-detail/support-sdk 0.0.1

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@great-detail/support-sdk",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "JavaScript SDK for the Great Detail Support System",
+  "author": "Great Detail Ltd <info@greatdetail.com>",
+  "contributors": [
+    "Dom Webber <dom.webber@hotmail.com>",
+    "Great Detail Ltd <info@greatdetail.com>"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "bin": "./dist/cli.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./cli": {
+      "import": {
+        "types": "./dist/cli/index.d.ts",
+        "default": "./dist/cli/index.js"
+      },
+      "require": {
+        "types": "./dist/cli/index.d.cts",
+        "default": "./dist/cli/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "keywords": [
+    "SDK"
+  ],
+  "scripts": {
+    "build": "npm-run-all tsup",
+    "changeset": "changeset",
+    "eslint": "eslint .",
+    "eslint:dev": "eslint . --fix",
+    "lint": "npm-run-all eslint typecheck publint prettier",
+    "lint:dev": "npm-run-all eslint:dev typecheck publint prettier:dev",
+    "prettier": "prettier --check .",
+    "prettier:dev": "prettier --write .",
+    "publint": "publint",
+    "release": "changeset publish",
+    "tsup": "tsup --entry src/index.ts --entry src/cli.ts --format cjs,esm --minify --dts",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "cross-fetch": "^4.0.0",
+    "ora": "^8.0.1",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.7",
+    "@great-detail/eslint-config": "^1.0.4",
+    "@great-detail/prettier-config": "^0.2.4",
+    "@types/node": "^20.14.12",
+    "eslint": "^8.57.0",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.3.3",
+    "publint": "^0.2.9",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.2.3",
+    "typescript": "^5.5.4"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  }
+}

package/src/Action/ListActions.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 {
+  request?: RequestInit;
+}
+
+export default class ListActionsRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ request = {}, ...options }: Options = {}) {
+    return this._client
+      .send(
+        "/v1/actions",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListActionsResponse(response));
+  }
+}
+
+export type ListResponse = {
+  actions: {
+    id: string;
+    actionStatus: string;
+    object?: unknown;
+    result?: unknown;
+    startedAt?: string;
+    endedAt?: string;
+  }[];
+};
+
+export class ListActionsResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Authentication/KeyAuthentication.ts

@@ -0,0 +1,47 @@
+/**
+ * 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 { DEFAULT_KEY_AUTHENTICATION_NAME } from "../constants/index.js";
+import Authentication from "./index.js";
+
+export interface Options {
+  name?: string;
+  key?: string;
+}
+
+export default class KeyAuthentication implements Authentication {
+  public static DEFAULT_NAME = DEFAULT_KEY_AUTHENTICATION_NAME;
+
+  public name: string;
+  #key: string;
+
+  constructor({
+    name = process.env.SUPPORT_KEY_NAME ?? KeyAuthentication.DEFAULT_NAME,
+    key = process.env.SUPPORT_API_KEY,
+  }: Options = {}) {
+    if (!key) {
+      throw new Error(
+        "API Key option must be specified when using Key Authentication",
+      );
+    }
+
+    this.name = name;
+    this.#key = key;
+  }
+
+  public async filter(request: RequestInit): Promise<RequestInit> {
+    return {
+      ...request,
+      headers: {
+        ...request.headers,
+        Authorization: `Basic ${btoa(this.name + ":" + this.#key)}`,
+      },
+    };
+  }
+}

package/src/Authentication/PublicAuthentication.ts

@@ -0,0 +1,22 @@
+/**
+ * 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 Authentication from "./index.js";
+
+/**
+ * Public Authentication Configuration.
+ * Note: Not all APIs and endpoints will work with this authentication type.
+ *
+ * @since 1.0.l0
+ */
+export default class PublicAuthentication implements Authentication {
+  public async filter(request: RequestInit) {
+    return request;
+  }
+}

package/src/Authentication/TokenAuthentication.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 Authentication from "./index.js";
+
+export interface Options {
+  token?: string;
+}
+
+export default class TokenAuthentication implements Authentication {
+  #token: string;
+
+  constructor({ token = process.env.SUPPORT_ACCESS_TOKEN }: Options = {}) {
+    if (!token) {
+      throw new Error(
+        "Access Token option must be specified when using Token Authentication",
+      );
+    }
+
+    this.#token = token;
+  }
+
+  public async filter(request: RequestInit): Promise<RequestInit> {
+    return {
+      ...request,
+      headers: {
+        ...request.headers,
+        Authorization: `Bearer ${this.#token}`,
+      },
+    };
+  }
+}

package/src/Authentication/index.ts

@@ -0,0 +1,12 @@
+/**
+ * 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 RequestFilterable from "../Request/RequestFilterable.js";
+
+export default interface Authentication extends RequestFilterable {}

package/src/Channel/ListChannels.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 {
+  request?: RequestInit;
+}
+
+export default class ListChannelsRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ request = {}, ...options }: Options = {}) {
+    return this._client
+      .send(
+        "/v1/channels",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListChannelsResponse(response));
+  }
+}
+
+export type ListResponse = {
+  channels: {
+    id: string;
+    name?: string;
+    channelStatus: "ActiveChannelStatus" | "PotentialChannelStatus";
+    source: "twilio-sendgrid" | "meta-whatsapp";
+    createdAt: string;
+    updatedAt?: string;
+  }[];
+};
+
+export class ListChannelsResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Client/index.ts

@@ -0,0 +1,122 @@
+/**
+ * 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 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 ListContactsRequest from "../Contact/ListContacts.js";
+import GetConversationRequest from "../Conversation/GetConversation.js";
+import ListConversationsRequest from "../Conversation/ListConversations.js";
+import ListLabelsRequest from "../Label/ListLabels.js";
+import ListMessagesRequest from "../Message/ListMessages.js";
+import CreateCorrectionModelRequest from "../Model/Correction/CreateCorrectionModel.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 ListSourcesRequest from "../Source/ListSources.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;
+}
+
+export default class Client {
+  public static DEFAULT_BASE_URL = DEFAULT_SUPPORT_BASE_URL;
+
+  public options: ClientOptions;
+
+  constructor(
+    authentication: Authentication,
+    options: InputClientOptions = {},
+  ) {
+    this.options = {
+      requestFilterables: [new RequestStandardHeaders(), authentication],
+      baseURL: process.env.SUPPORT_BASE_URL ?? Client.DEFAULT_BASE_URL,
+      ...options,
+    };
+  }
+
+  public action = {
+    list: new ListActionsRequest(this),
+  };
+
+  public channel = {
+    list: new ListChannelsRequest(this),
+  };
+
+  public contact = {
+    list: new ListContactsRequest(this),
+  };
+
+  public conversation = {
+    get: new GetConversationRequest(this),
+    list: new ListConversationsRequest(this),
+  };
+
+  public label = {
+    list: new ListLabelsRequest(this),
+  };
+
+  public message = {
+    list: new ListMessagesRequest(this),
+  };
+
+  public model = {
+    list: new ListModelsRequest(this),
+    response: {
+      create: new CreateResponseModelRequest(this),
+    },
+    correction: {
+      create: new CreateCorrectionModelRequest(this),
+    },
+  };
+
+  public source = {
+    list: new ListSourcesRequest(this),
+  };
+
+  protected async _filterRequest(request: RequestInit): Promise<RequestInit> {
+    for (const filterable of this.options.requestFilterables) {
+      request = await filterable.filter(request);
+    }
+
+    return request;
+  }
+
+  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),
+      ),
+    );
+  }
+}

package/src/Contact/ListContacts.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 {
+  request?: RequestInit;
+}
+
+export default class ListContactsRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ request = {}, ...options }: Options = {}) {
+    return this._client
+      .send(
+        "/v1/contacts",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListContactsResponse(response));
+  }
+}
+
+export type ListResponse = {
+  contacts: {
+    id: string;
+    name?: string;
+    emailAddress?: string;
+    telephoneNumber?: string;
+    createdAt: string;
+    updatedAt?: string;
+  }[];
+};
+
+export class ListContactsResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Conversation/GetConversation.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 GetConversationRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ id, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/conversations/" + encodeURIComponent(id),
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new GetConversationResponse(response));
+  }
+}
+
+export type GetResponse = {
+  conversation: {
+    id: string;
+    hasEnded: boolean;
+    accountChannel: string;
+    createdAt: string;
+    updatedAt: string;
+  };
+};
+
+export class GetConversationResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<GetResponse> {
+    return this.response.json();
+  }
+}

package/src/Conversation/ListConversations.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 {
+  request?: RequestInit;
+}
+
+export default class ListConversationsRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ request = {}, ...options }: Options = {}) {
+    return this._client
+      .send(
+        "/v1/conversations",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListConversationsResponse(response));
+  }
+}
+
+export type ListResponse = {
+  conversations: {
+    id: string;
+    hasEnded: boolean;
+    accountChannel: string;
+    createdAt: string;
+    updatedAt: string;
+  }[];
+};
+
+export class ListConversationsResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Label/ListLabels.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 {
+  request?: RequestInit;
+}
+
+export default class ListLabelsRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ request = {}, ...options }: Options = {}) {
+    return this._client
+      .send(
+        "/v1/labels",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListLabelsResponse(response));
+  }
+}
+
+export type ListResponse = {
+  labels: {
+    id: string;
+    title: string;
+    description?: string;
+    createdAt: string;
+    updatedAt?: string;
+  }[];
+};
+
+export class ListLabelsResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Message/ListMessages.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 {
+  request?: RequestInit;
+}
+
+export default class ListMessagesRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ request = {}, ...options }: Options = {}) {
+    return this._client
+      .send(
+        "/v1/messages",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListMessagesResponse(response));
+  }
+}
+
+export type ListResponse = {
+  messages: {
+    id: string;
+    role: "user" | "assistant";
+    messageStatus: string;
+    externalIdentifier?: string;
+    conversation: string;
+    contact: string;
+    createdAt: string;
+    updatedAt: string;
+  }[];
+};
+
+export class ListMessagesResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Model/Correction/CreateCorrectionModel.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 "../../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  body: z.infer<typeof CreateCorrectionModelRequest.SCHEMA>;
+  request?: RequestInit;
+}
+
+export default class CreateCorrectionModelRequest {
+  public static SCHEMA = z.object({
+    input: z.string().max(65_536),
+    original: z.string().max(65_536),
+    correction: z.string().max(65_536),
+  });
+
+  constructor(protected _client: Client) {}
+
+  public async send({ id, body, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/models/" + encodeURIComponent(id) + "/correction",
+        {
+          ...request,
+          method: "POST",
+          headers: {
+            ...request.headers,
+            "Content-Type": "application/json",
+          },
+          body: JSON.stringify(CreateCorrectionModelRequest.SCHEMA.parse(body)),
+        },
+        options,
+      )
+      .then((response) => new CreateCorrectionModelResponse(response));
+  }
+}
+
+export type ListResponse = unknown;
+
+export class CreateCorrectionModelResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Model/ListModels.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 {
+  request?: RequestInit;
+}
+
+export default class ListModelsRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ request = {}, ...options }: Options = {}) {
+    return this._client
+      .send(
+        "/v1/models",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListModelsResponse(response));
+  }
+}
+
+export type ListResponse = {
+  models: {
+    id: string;
+    name: string;
+    url: string;
+    icon: string;
+    disambiguatingDescription: string;
+  }[];
+};
+
+export class ListModelsResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Model/Response/CreateResponseModel.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 "../../Client/index.js";
+
+export interface Options extends SendOptions {
+  id: string;
+  body: z.infer<typeof CreateResponseModelRequest.SCHEMA>;
+  request?: RequestInit;
+}
+
+export default class CreateResponseModelRequest {
+  public static SCHEMA = z
+    .array(
+      z.object({
+        role: z.enum(["user", "assistant"]),
+        content: z.string().max(65_536).nullable(),
+      }),
+    )
+    .min(1);
+
+  constructor(protected _client: Client) {}
+
+  public async send({ id, body, request = {}, ...options }: Options) {
+    return this._client
+      .send(
+        "/v1/models/" + encodeURIComponent(id) + "/response",
+        {
+          ...request,
+          method: "POST",
+          headers: {
+            ...request.headers,
+            "Content-Type": "application/json",
+          },
+          body: JSON.stringify(CreateResponseModelRequest.SCHEMA.parse(body)),
+        },
+        options,
+      )
+      .then((response) => new CreateResponseModelResponse(response));
+  }
+}
+
+export type ListResponse = {
+  message: string | null;
+  debug: {
+    duration: string;
+    sources: (string | undefined)[];
+  };
+};
+
+export class CreateResponseModelResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/Request/RequestFilterable.ts

@@ -0,0 +1,12 @@
+/**
+ * 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
+ */
+
+export default interface RequestFilterable {
+  filter(request: RequestInit): Promise<RequestInit>;
+}

package/src/Request/RequestStandardHeaders.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { STANDARD_HEADERS } from "../constants/index.js";
+import RequestFilterable from "./RequestFilterable.js";
+
+export default class RequestStandardHeaders implements RequestFilterable {
+  public static STANDARD_HEADERS = STANDARD_HEADERS;
+
+  constructor(
+    protected _standardHeaders: Record<
+      string,
+      string
+    > = RequestStandardHeaders.STANDARD_HEADERS,
+  ) {}
+
+  public async filter(request: RequestInit) {
+    return {
+      ...request,
+      headers: {
+        ...request.headers,
+        ...this._standardHeaders,
+      },
+    };
+  }
+}

package/src/Source/ListSources.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 {
+  request?: RequestInit;
+}
+
+export default class ListSourcesRequest {
+  constructor(protected _client: Client) {}
+
+  public async send({ request = {}, ...options }: Options = {}) {
+    return this._client
+      .send(
+        "/v1/sources",
+        {
+          ...request,
+          method: "GET",
+        },
+        options,
+      )
+      .then((response) => new ListSourcesResponse(response));
+  }
+}
+
+export type ListResponse = {
+  sources: {
+    id: string;
+    name: string;
+    category: string;
+    url: string;
+    disambiguatingDescription: string;
+  }[];
+};
+
+export class ListSourcesResponse {
+  constructor(public response: Response) {}
+
+  public async result(): Promise<ListResponse> {
+    return this.response.json();
+  }
+}

package/src/cli/actions.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { Command } from "commander";
+import { oraPromise } from "ora";
+import type { Options as CommandOptions } from "./index.js";
+
+export interface Options extends CommandOptions {}
+
+export default function actions({ client, ora }: Options) {
+  const command = new Command("actions").description("Actions");
+
+  command.addCommand(
+    new Command("list").description("List actions").action(async () => {
+      const result = await oraPromise(() => client.action.list.send(), {
+        ...ora,
+        text: "Finding actions",
+      });
+
+      console.log(await result.result());
+    }),
+  );
+
+  return command;
+}

package/src/cli/channels.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { Command } from "commander";
+import { oraPromise } from "ora";
+import type { Options as CommandOptions } from "./index.js";
+
+export interface Options extends CommandOptions {}
+
+export default function channels({ client, ora }: Options) {
+  const command = new Command("channels").description("Channels");
+
+  command.addCommand(
+    new Command("list").description("List channels").action(async () => {
+      const result = await oraPromise(() => client.channel.list.send(), {
+        ...ora,
+        text: "Finding channels",
+      });
+
+      console.log(await result.result());
+    }),
+  );
+
+  return command;
+}

package/src/cli/contacts.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { Command } from "commander";
+import { oraPromise } from "ora";
+import type { Options as CommandOptions } from "./index.js";
+
+export interface Options extends CommandOptions {}
+
+export default function contacts({ client, ora }: Options) {
+  const command = new Command("contacts").description("Contacts");
+
+  command.addCommand(
+    new Command("list").description("List contacts").action(async () => {
+      const result = await oraPromise(() => client.contact.list.send(), {
+        ...ora,
+        text: "Finding contacts",
+      });
+
+      console.log(await result.result());
+    }),
+  );
+
+  return command;
+}

package/src/cli/conversations.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { Command } from "commander";
+import { oraPromise } from "ora";
+import type { Options as CommandOptions } from "./index.js";
+
+export interface Options extends CommandOptions {}
+
+export default function conversations({ client, ora }: Options) {
+  const command = new Command("conversations").description("Conversations");
+
+  command.addCommand(
+    new Command("get")
+      .description("Find conversation")
+      .argument("<conversation>", "Conversation ID")
+      .action(async (id) => {
+        const result = await oraPromise(
+          () => client.conversation.get.send({ id }),
+          {
+            ...ora,
+            text: "Finding conversation",
+          },
+        );
+
+        console.log(await result.result());
+      }),
+  );
+
+  command.addCommand(
+    new Command("list").description("List conversations").action(async () => {
+      const result = await oraPromise(() => client.conversation.list.send(), {
+        ...ora,
+        text: "Finding conversations",
+      });
+
+      console.log(await result.result());
+    }),
+  );
+
+  return command;
+}

package/src/cli/index.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { Command } from "commander";
+import PublicAuthentication from "../Authentication/PublicAuthentication.js";
+import Client from "../Client/index.js";
+import actions from "./actions.js";
+import channels from "./channels.js";
+import contacts from "./contacts.js";
+import conversations from "./conversations.js";
+import labels from "./labels.js";
+import messages from "./messages.js";
+import models from "./models.js";
+import sources from "./sources.js";
+import type { Options as OraOptions } from "ora";
+
+export interface Options {
+  client: Client;
+  ora: OraOptions;
+}
+
+const options: Options = {
+  ora: {
+    spinner: "simpleDotsScrolling",
+  },
+  client: new Client(new PublicAuthentication()),
+};
+
+const cli = new Command("gds")
+  .description("Great Detail Support System")
+  .addCommand(actions(options))
+  .addCommand(channels(options))
+  .addCommand(contacts(options))
+  .addCommand(conversations(options))
+  .addCommand(labels(options))
+  .addCommand(messages(options))
+  .addCommand(models(options))
+  .addCommand(sources(options));
+
+export default cli;

package/src/cli/labels.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { Command } from "commander";
+import { oraPromise } from "ora";
+import type { Options as CommandOptions } from "./index.js";
+
+export interface Options extends CommandOptions {}
+
+export default function labels({ client, ora }: Options) {
+  const command = new Command("labels").description("Labels");
+
+  command.addCommand(
+    new Command("list").description("List labels").action(async () => {
+      const result = await oraPromise(() => client.label.list.send(), {
+        ...ora,
+        text: "Finding labels",
+      });
+
+      console.log(await result.result());
+    }),
+  );
+
+  return command;
+}

package/src/cli/messages.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { Command } from "commander";
+import { oraPromise } from "ora";
+import type { Options as CommandOptions } from "./index.js";
+
+export interface Options extends CommandOptions {}
+
+export default function messages({ client, ora }: Options) {
+  const command = new Command("messages").description("Messages");
+
+  command.addCommand(
+    new Command("list").description("List messages").action(async () => {
+      const result = await oraPromise(() => client.message.list.send(), {
+        ...ora,
+        text: "Finding messages",
+      });
+
+      console.log(await result.result());
+    }),
+  );
+
+  return command;
+}

package/src/cli/models.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { Command } from "commander";
+import { oraPromise } from "ora";
+import type { Options as CommandOptions } from "./index.js";
+
+export interface Options extends CommandOptions {}
+
+export default function models({ client, ora }: Options) {
+  const command = new Command("models").description("Models");
+
+  command.addCommand(
+    new Command("list").description("List models").action(async () => {
+      const result = await oraPromise(() => client.model.list.send(), {
+        ...ora,
+        text: "Finding models",
+      });
+
+      console.log(await result.result());
+    }),
+  );
+
+  return command;
+}

package/src/cli/sources.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { Command } from "commander";
+import { oraPromise } from "ora";
+import type { Options as CommandOptions } from "./index.js";
+
+export interface Options extends CommandOptions {}
+
+export default function sources({ client, ora }: Options) {
+  const command = new Command("sources").description("Sources");
+
+  command.addCommand(
+    new Command("list").description("List sources").action(async () => {
+      const result = await oraPromise(() => client.source.list.send(), {
+        ...ora,
+        text: "Finding sources",
+      });
+
+      console.log(await result.result());
+    }),
+  );
+
+  return command;
+}

package/src/cli.ts

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+
+/**
+ * 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 cli from "./cli/index.js";
+
+cli.parseAsync(process.argv);

package/src/constants/index.ts

@@ -0,0 +1,31 @@
+/**
+ * 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
+ */
+
+/**
+ * Support System API Base URL.
+ *
+ * @since 1.0.0
+ */
+export const DEFAULT_SUPPORT_BASE_URL = "https://api.support.greatdetail.com";
+
+/**
+ * Standard HTTP Request Headers.
+ *
+ * @since 1.0.0
+ */
+export const STANDARD_HEADERS = {
+  "X-Powered-By": "GDSupport/JavaScript",
+};
+
+/**
+ * Default Basic Authentication Username for Key Authentication.
+ *
+ * @since 1.0.0
+ */
+export const DEFAULT_KEY_AUTHENTICATION_NAME = "api-key";

package/src/index.ts

@@ -0,0 +1,15 @@
+/**
+ * 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
+ */
+
+export { DEFAULT_SUPPORT_BASE_URL } from "./constants/index.js";
+export { default as KeyAuthentication } from "./Authentication/KeyAuthentication.js";
+export { default as TokenAuthentication } from "./Authentication/TokenAuthentication.js";
+export { default as PublicAuthentication } from "./Authentication/PublicAuthentication.js";
+export { type default as RequestFilterable } from "./Request/RequestFilterable.js";
+export { default, default as Client } from "./Client/index.js";