@great-detail/support-sdk 0.4.4 → 0.4.5

package/src/Transport/FetchTransport.ts

@@ -1,100 +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 isNetworkError from "is-network-error";
-import ky, { HTTPError, KyInstance } from "ky";
-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;
-}
-
-export interface Options extends TransportOptions {
-  baseURL: string;
-}
-
-export default class FetchTransport implements Transport {
-  public client: KyInstance;
-  public options: Options;
-
-  constructor({ baseURL, ...options }: InputOptions) {
-    this.options = {
-      ...options,
-      baseURL,
-    };
-    this.client = ky.create({
-      prefixUrl: this.options.baseURL,
-      hooks: {
-        beforeRequest: [
-          (request) => {
-            for (const filterable of this.options.requestFilterables) {
-              const filterableHeaders = filterable.getHeaders();
-              for (const [headerName, headerValue] of Object.entries(
-                filterableHeaders,
-              )) {
-                // Skip explicitly-overwritten headers
-                if (request.headers.has(headerName)) {
-                  continue;
-                }
-
-                request.headers.set(headerName, headerValue);
-              }
-            }
-          },
-        ],
-      },
-    });
-  }
-
-  public getURL(url: string): string {
-    return new URL(url, this.options.baseURL).toString();
-  }
-
-  public async send<T = unknown>(url: string, request: RequestInit) {
-    return await this.client<T>(url, request).catch((error) => {
-      if (isNetworkError(error)) {
-        throw new NetworkError("A network error occurred", { cause: error });
-      }
-
-      if (error instanceof HTTPError) {
-        const code = error.response.status;
-        console.error(JSON.stringify(error.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");
-          }
-        }
-      }
-
-      throw error;
-    });
-  }
-}

package/src/Transport/index.ts

@@ -1,18 +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 RequestFilterable from "../Request/RequestFilterable.js";
-
-export interface Options {
-  requestFilterables: RequestFilterable[];
-}
-
-export default interface Transport {
-  getURL(url: string): string;
-}

package/src/Webhook/index.ts

@@ -1,55 +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 { z } from "zod";
-import Client from "../Client/index.js";
-
-export type Options = {
-  request: {
-    body: unknown;
-    headers: Record<string, string | string[]>;
-    [key: string]: unknown | undefined;
-  };
-};
-
-export type WebhookResponse = z.infer<typeof Webhook.SCHEMA>;
-
-export default class Webhook {
-  public static SCHEMA = z.object({
-    event: z.intersection(
-      z.object({
-        id: z.string(),
-        createdAt: z.string().datetime(),
-      }),
-      z.discriminatedUnion("type", [
-        z.object({
-          type: z.literal("contact.created"),
-          contact: z.string(),
-        }),
-        z.object({
-          type: z.literal("message.created"),
-          message: z.string(),
-        }),
-      ]),
-    ),
-  });
-
-  constructor(protected _client: Client) {}
-
-  /**
-   * @deprecated Pre-release Functionality
-   */
-  public async event({ request }: Options) {
-    const { event } = Webhook.SCHEMA.parse(request.body);
-
-    return {
-      event,
-    };
-  }
-}

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

@@ -1,38 +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 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/cli/actions.ts

@@ -1,31 +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 { Command } from "commander";
-import { oraPromise } from "ora";
-import type { Options as CommandOptions } from "./index.js";
-
-export type Options = 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.json());
-    }),
-  );
-
-  return command;
-}

package/src/cli/channels.ts

@@ -1,31 +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 { Command } from "commander";
-import { oraPromise } from "ora";
-import type { Options as CommandOptions } from "./index.js";
-
-export type Options = 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.json());
-    }),
-  );
-
-  return command;
-}

package/src/cli/contacts.ts

@@ -1,45 +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 { Command } from "commander";
-import { oraPromise } from "ora";
-import type { Options as CommandOptions } from "./index.js";
-
-export type Options = 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.json());
-      }),
-  );
-
-  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.json());
-    }),
-  );
-
-  return command;
-}

package/src/cli/conversations.ts

@@ -1,48 +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 { Command } from "commander";
-import { oraPromise } from "ora";
-import type { Options as CommandOptions } from "./index.js";
-
-export type Options = 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.json());
-      }),
-  );
-
-  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.json());
-    }),
-  );
-
-  return command;
-}

package/src/cli/index.ts

@@ -1,46 +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 { 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

@@ -1,62 +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 { Command } from "commander";
-import { oraPromise } from "ora";
-import type { Options as CommandOptions } from "./index.js";
-
-export type Options = 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.json());
-      }),
-  );
-
-  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.json());
-    }),
-  );
-
-  command.addCommand(
-    new Command("conversations")
-      .description("Find label conversations")
-      .argument("<label>", "Label ID")
-      .action(async (id) => {
-        const result = await oraPromise(
-          () => client.label.conversation.list.send({ id }),
-          {
-            ...ora,
-            text: "Finding conversations",
-          },
-        );
-
-        console.log(await result.json());
-      }),
-  );
-
-  return command;
-}

package/src/cli/messages.ts

@@ -1,31 +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 { Command } from "commander";
-import { oraPromise } from "ora";
-import type { Options as CommandOptions } from "./index.js";
-
-export type Options = 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.json());
-    }),
-  );
-
-  return command;
-}

package/src/cli/models.ts

@@ -1,45 +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 { Command } from "commander";
-import { oraPromise } from "ora";
-import type { Options as CommandOptions } from "./index.js";
-
-export type Options = 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.json());
-      }),
-  );
-
-  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.json());
-    }),
-  );
-
-  return command;
-}

package/src/cli/sources.ts

@@ -1,45 +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 { Command } from "commander";
-import { oraPromise } from "ora";
-import type { Options as CommandOptions } from "./index.js";
-
-export type Options = 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.json());
-      }),
-  );
-
-  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.json());
-    }),
-  );
-
-  return command;
-}

package/src/cli.ts

@@ -1,13 +0,0 @@
-#!/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/environment.ts

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

@@ -1,31 +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
- */
-
-/**
- * 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";