@great-detail/support-sdk 0.4.3 → 0.4.5

package/src/Model/ListModels.ts

@@ -1,35 +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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  request?: RequestInit;
-}
-
-export type ListModelsResponse = {
-  models: {
-    id: string;
-    name: string;
-    url?: string;
-    icon?: string;
-    disambiguatingDescription: string;
-  }[];
-};
-
-export default class ListModels {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport.send<ListModelsResponse>("v1/models", {
-      ...request,
-      method: "GET",
-    });
-  }
-}

package/src/Model/Response/CreateResponseModel.ts

@@ -1,53 +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 FetchTransport from "../../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  body: z.infer<typeof CreateResponseModel.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type CreateResponseResponse = {
-  message: string | null;
-  debug: {
-    duration: string;
-    sources: (string | undefined)[];
-  };
-};
-
-export default class CreateResponseModel {
-  public static SCHEMA = z
-    .array(
-      z.object({
-        role: z.enum(["user", "assistant"]),
-        content: z.string().max(65_536).nullable(),
-      }),
-    )
-    .min(1);
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<CreateResponseResponse>(
-      "v1/models/" + encodeURIComponent(id) + "/response",
-      {
-        ...request,
-        method: "POST",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(CreateResponseModel.SCHEMA.parse(body)),
-      },
-    );
-  }
-}

package/src/Model/index.ts

@@ -1,15 +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
- */
-
-export { type GetModelResponse } from "./GetModel.js";
-export { type ListModelsResponse } from "./ListModels.js";
-
-export { type CreateCorrectionResponse } from "./Correction/CreateCorrectionModel.js";
-
-export { type CreateResponseResponse } from "./Response/CreateResponseModel.js";

package/src/Note/CreateContactNote.ts

@@ -1,49 +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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  body: z.infer<typeof CreateContactNote.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type CreateContactNoteResponse = {
-  note: {
-    id: string;
-    content: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class CreateContactNote {
-  public static SCHEMA = z.object({
-    content: z.string(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<CreateContactNoteResponse>(
-      "v1/contacts/" + encodeURIComponent(id) + "/notes",
-      {
-        ...request,
-        method: "POST",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(CreateContactNote.SCHEMA.parse(body)),
-      },
-    );
-  }
-}

package/src/Note/CreateConversationNote.ts

@@ -1,49 +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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  body: z.infer<typeof CreateConversationNote.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type CreateConversationNoteResponse = {
-  note: {
-    id: string;
-    content: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class CreateConversationNote {
-  public static SCHEMA = z.object({
-    content: z.string(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<CreateConversationNoteResponse>(
-      "v1/conversations/" + encodeURIComponent(id) + "/notes",
-      {
-        ...request,
-        method: "POST",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(CreateConversationNote.SCHEMA.parse(body)),
-      },
-    );
-  }
-}

package/src/Note/GetNote.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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  request?: RequestInit;
-}
-
-export type GetNoteResponse = {
-  note: {
-    id: string;
-    content: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class GetNote {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<GetNoteResponse>(
-      "v1/notes/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/Note/ListContactNotes.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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  request?: RequestInit;
-}
-
-export type ListContactNotesResponse = {
-  notes: {
-    id: string;
-    content: string;
-    createdAt: string;
-    updatedAt: string;
-  }[];
-};
-
-export default class ListContactNotes {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<ListContactNotesResponse>(
-      "v1/contacts/" + encodeURIComponent(id) + "/notes",
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/Note/ListConversationNotes.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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  request?: RequestInit;
-}
-
-export type ListConversationNotesResponse = {
-  notes: {
-    id: string;
-    content: string;
-    createdAt: string;
-    updatedAt: string;
-  }[];
-};
-
-export default class ListConversationNotes {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<ListConversationNotesResponse>(
-      "v1/conversations/" + encodeURIComponent(id) + "/notes",
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/Note/UpdateNote.ts

@@ -1,49 +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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  body: z.infer<typeof UpdateNote.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type UpdateNoteResponse = {
-  note: {
-    id: string;
-    content: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class UpdateNote {
-  public static SCHEMA = z.object({
-    content: z.string().optional(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<UpdateNoteResponse>(
-      "v1/notes/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "PATCH",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(UpdateNote.SCHEMA.parse(body)),
-      },
-    );
-  }
-}

package/src/Note/index.ts

@@ -1,15 +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
- */
-
-export { type CreateContactNoteResponse } from "./CreateContactNote.js";
-export { type CreateConversationNoteResponse } from "./CreateConversationNote.js";
-export { type GetNoteResponse } from "./GetNote.js";
-export { type ListContactNotesResponse } from "./ListContactNotes.js";
-export { type ListConversationNotesResponse } from "./ListConversationNotes.js";
-export { type UpdateNoteResponse } from "./UpdateNote.js";

package/src/NotificationSubscription/CreateContactNotificationSubscription.ts

@@ -1,57 +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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  body: z.infer<typeof CreateContactNotificationSubscription.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type CreateContactNotificationSubscriptionResponse = {
-  subscription: {
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class CreateContactNotificationSubscription {
-  public static SCHEMA = z.discriminatedUnion("type", [
-    z.object({
-      type: z.literal("vapid"),
-      endpoint: z.string().url(),
-      keys: z.object({
-        p256dh: z.string(),
-        auth: z.string(),
-      }),
-    }),
-  ]);
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<CreateContactNotificationSubscriptionResponse>(
-      "v1/contacts/" + encodeURIComponent(id) + "/subscriptions",
-      {
-        ...request,
-        method: "POST",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(
-          CreateContactNotificationSubscription.SCHEMA.parse(body),
-        ),
-      },
-    );
-  }
-}

package/src/NotificationSubscription/index.ts

@@ -1,10 +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
- */
-
-export { type CreateContactNotificationSubscriptionResponse } from "./CreateContactNotificationSubscription.js";

package/src/Request/RequestFilterable.ts

@@ -1,16 +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
- */
-
-export default interface RequestFilterable {
-  /**
-   * @deprecated
-   */
-  filter(...options: unknown[]): Promise<{ headers: Record<string, string> }>;
-  getHeaders(): Record<string, string>;
-}

package/src/Request/RequestStandardHeaders.ts

@@ -1,32 +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 { 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() {
-    return {
-      headers: this.getHeaders(),
-    };
-  }
-
-  public getHeaders() {
-    return this._standardHeaders;
-  }
-}

package/src/Source/GetSource.ts

@@ -1,40 +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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  request?: RequestInit;
-}
-
-export type GetSourceResponse = {
-  source: {
-    id: string;
-    name: string;
-    category: string;
-    url?: string;
-    icon?: string;
-    disambiguatingDescription: string;
-  };
-};
-
-export default class GetSource {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<GetSourceResponse>(
-      "v1/sources/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/Source/ListSources.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
- */
-
-import FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  request?: RequestInit;
-}
-
-export type ListSourcesResponse = {
-  sources: {
-    id: string;
-    name: string;
-    category: string;
-    url?: string;
-    icon?: string;
-    disambiguatingDescription: string;
-  }[];
-};
-
-export default class ListSources {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport.send<ListSourcesResponse>("v1/sources", {
-      ...request,
-      method: "GET",
-    });
-  }
-}

package/src/Source/index.ts

@@ -1,11 +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
- */
-
-export { type GetSourceResponse } from "./GetSource.js";
-export { type ListSourcesResponse } from "./ListSources.js";

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;
-    });
-  }
-}