@great-detail/support-sdk 0.0.1 → 0.0.3

package/dist/index.d.ts

@@ -0,0 +1,541 @@
+import { z } from 'zod';
+
+/**
+ * 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
+ */
+declare const DEFAULT_SUPPORT_BASE_URL = "https://api.support.greatdetail.com";
+
+/**
+ * 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
+ */
+interface RequestFilterable {
+    filter(request: RequestInit): Promise<RequestInit>;
+}
+
+/**
+ * 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
+ */
+
+interface Authentication extends RequestFilterable {
+}
+
+/**
+ * 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
+ */
+
+interface Options$c {
+    name?: string;
+    key?: string;
+}
+declare class KeyAuthentication implements Authentication {
+    #private;
+    static DEFAULT_NAME: string;
+    name: string;
+    constructor({ name, key, }?: Options$c);
+    filter(request: RequestInit): Promise<RequestInit>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$b {
+    token?: string;
+}
+declare class TokenAuthentication implements Authentication {
+    #private;
+    constructor({ token }?: Options$b);
+    filter(request: RequestInit): Promise<RequestInit>;
+}
+
+/**
+ * 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
+ */
+
+/**
+ * Public Authentication Configuration.
+ * Note: Not all APIs and endpoints will work with this authentication type.
+ *
+ * @since 1.0.l0
+ */
+declare class PublicAuthentication implements Authentication {
+    filter(request: RequestInit): Promise<RequestInit>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$a extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListActionsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$a): Promise<ListActionsResponse>;
+}
+type ListActionsResponsePayload = {
+    actions: {
+        id: string;
+        actionStatus: string;
+        object?: unknown;
+        result?: unknown;
+        startedAt?: string;
+        endedAt?: string;
+    }[];
+};
+declare class ListActionsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListActionsResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$9 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListChannelsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$9): Promise<ListChannelsResponse>;
+}
+type ListChannelsResponsePayload = {
+    channels: {
+        id: string;
+        name?: string;
+        channelStatus: "ActiveChannelStatus" | "PotentialChannelStatus";
+        source: "twilio-sendgrid" | "meta-whatsapp";
+        createdAt: string;
+        updatedAt?: string;
+    }[];
+};
+declare class ListChannelsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListChannelsResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$8 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListContactsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$8): Promise<ListContactsResponse>;
+}
+type ListContactsResponsePayload = {
+    contacts: {
+        id: string;
+        name?: string;
+        emailAddress?: string;
+        telephoneNumber?: string;
+        createdAt: string;
+        updatedAt?: string;
+    }[];
+};
+declare class ListContactsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListContactsResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$7 extends SendOptions {
+    id: string;
+    request?: RequestInit;
+}
+declare class GetConversationRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ id, request, ...options }: Options$7): Promise<GetConversationResponse>;
+}
+type GetConversationResponsePayload = {
+    conversation: {
+        id: string;
+        hasEnded: boolean;
+        accountChannel: string;
+        createdAt: string;
+        updatedAt: string;
+    };
+};
+declare class GetConversationResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<GetConversationResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$6 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListConversationsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$6): Promise<ListConversationsResponse>;
+}
+type ListConversationsResponsePayload = {
+    conversations: {
+        id: string;
+        hasEnded: boolean;
+        accountChannel: string;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+};
+declare class ListConversationsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListConversationsResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$5 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListLabelsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$5): Promise<ListLabelsResponse>;
+}
+type ListLabelsResponsePayload = {
+    labels: {
+        id: string;
+        title: string;
+        description?: string;
+        createdAt: string;
+        updatedAt?: string;
+    }[];
+};
+declare class ListLabelsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListLabelsResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$4 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListMessagesRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$4): Promise<ListMessagesResponse>;
+}
+type ListMessagesResponsePayload = {
+    messages: {
+        id: string;
+        role: "user" | "assistant";
+        messageStatus: string;
+        externalIdentifier?: string;
+        conversation: string;
+        contact: string;
+        createdAt: string;
+        updatedAt: string;
+    }[];
+};
+declare class ListMessagesResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListMessagesResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$3 extends SendOptions {
+    id: string;
+    body: z.infer<typeof CreateCorrectionModelRequest.SCHEMA>;
+    request?: RequestInit;
+}
+declare class CreateCorrectionModelRequest {
+    protected _client: Client;
+    static SCHEMA: z.ZodObject<{
+        input: z.ZodString;
+        original: z.ZodString;
+        correction: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        input: string;
+        original: string;
+        correction: string;
+    }, {
+        input: string;
+        original: string;
+        correction: string;
+    }>;
+    constructor(_client: Client);
+    send({ id, body, request, ...options }: Options$3): Promise<CreateCorrectionModelResponse>;
+}
+type CreateCorrectionResponsePayload = unknown;
+declare class CreateCorrectionModelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<CreateCorrectionResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$2 extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListModelsRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options$2): Promise<ListModelsResponse>;
+}
+type ListModelsResponsePayload = {
+    models: {
+        id: string;
+        name: string;
+        url: string;
+        icon: string;
+        disambiguatingDescription: string;
+    }[];
+};
+declare class ListModelsResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListModelsResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options$1 extends SendOptions {
+    id: string;
+    body: z.infer<typeof CreateResponseModelRequest.SCHEMA>;
+    request?: RequestInit;
+}
+declare class CreateResponseModelRequest {
+    protected _client: Client;
+    static SCHEMA: z.ZodArray<z.ZodObject<{
+        role: z.ZodEnum<["user", "assistant"]>;
+        content: z.ZodNullable<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        role: "user" | "assistant";
+        content: string | null;
+    }, {
+        role: "user" | "assistant";
+        content: string | null;
+    }>, "many">;
+    constructor(_client: Client);
+    send({ id, body, request, ...options }: Options$1): Promise<CreateResponseModelResponse>;
+}
+type CreateResponseResponsePayload = {
+    message: string | null;
+    debug: {
+        duration: string;
+        sources: (string | undefined)[];
+    };
+};
+declare class CreateResponseModelResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<CreateResponseResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface Options extends SendOptions {
+    request?: RequestInit;
+}
+declare class ListSourcesRequest {
+    protected _client: Client;
+    constructor(_client: Client);
+    send({ request, ...options }?: Options): Promise<ListSourcesResponse>;
+}
+type ListSourcesResponsePayload = {
+    sources: {
+        id: string;
+        name: string;
+        category: string;
+        url: string;
+        disambiguatingDescription: string;
+    }[];
+};
+declare class ListSourcesResponse {
+    response: Response;
+    constructor(response: Response);
+    result(): Promise<ListSourcesResponsePayload>;
+}
+
+/**
+ * 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
+ */
+
+interface ClientOptions {
+    requestFilterables: RequestFilterable[];
+    baseURL: string;
+}
+interface InputClientOptions {
+    baseURL?: string;
+}
+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;
+}
+declare class Client {
+    static DEFAULT_BASE_URL: string;
+    options: ClientOptions;
+    constructor(authentication: Authentication, options?: InputClientOptions);
+    action: {
+        list: ListActionsRequest;
+    };
+    channel: {
+        list: ListChannelsRequest;
+    };
+    contact: {
+        list: ListContactsRequest;
+    };
+    conversation: {
+        get: GetConversationRequest;
+        list: ListConversationsRequest;
+    };
+    label: {
+        list: ListLabelsRequest;
+    };
+    message: {
+        list: ListMessagesRequest;
+    };
+    model: {
+        list: ListModelsRequest;
+        response: {
+            create: CreateResponseModelRequest;
+        };
+        correction: {
+            create: CreateCorrectionModelRequest;
+        };
+    };
+    source: {
+        list: ListSourcesRequest;
+    };
+    protected _filterRequest(request: RequestInit): Promise<RequestInit>;
+    send(url: string | URL, request: RequestInit, { fetch: fetchAlternative }?: SendOptions): Promise<Response>;
+}
+
+export { Client, type CreateCorrectionResponsePayload, type CreateResponseResponsePayload, DEFAULT_SUPPORT_BASE_URL, type GetConversationResponsePayload, KeyAuthentication, type ListActionsResponsePayload, type ListChannelsResponsePayload, type ListContactsResponsePayload, type ListConversationsResponsePayload, type ListLabelsResponsePayload, type ListMessagesResponsePayload, type ListModelsResponsePayload, type ListSourcesResponsePayload, PublicAuthentication, type RequestFilterable, TokenAuthentication, Client as default };

package/dist/index.js

@@ -0,0 +1 @@
+import{a,b as i,c as p,d as n}from"./chunk-LS7DRWDS.js";var t=class s{static DEFAULT_NAME=i;name;#e;constructor({name:e=process.env.SUPPORT_KEY_NAME??s.DEFAULT_NAME,key:r=process.env.SUPPORT_API_KEY}={}){if(!r)throw new Error("API Key option must be specified when using Key Authentication");this.name=e,this.#e=r}async filter(e){return{...e,headers:{...e.headers,Authorization:`Basic ${btoa(this.name+":"+this.#e)}`}}}};var o=class{#e;constructor({token:e=process.env.SUPPORT_ACCESS_TOKEN}={}){if(!e)throw new Error("Access Token option must be specified when using Token Authentication");this.#e=e}async filter(e){return{...e,headers:{...e.headers,Authorization:`Bearer ${this.#e}`}}}};export{n as Client,a as DEFAULT_SUPPORT_BASE_URL,t as KeyAuthentication,p as PublicAuthentication,o as TokenAuthentication,n as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@great-detail/support-sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "description": "JavaScript SDK for the Great Detail Support System",
   "author": "Great Detail Ltd <info@greatdetail.com>",
@@ -49,6 +49,7 @@
     "eslint:dev": "eslint . --fix",
     "lint": "npm-run-all eslint typecheck publint prettier",
     "lint:dev": "npm-run-all eslint:dev typecheck publint prettier:dev",
+    "prerelease": "npm-run-all build",
     "prettier": "prettier --check .",
     "prettier:dev": "prettier --write .",
     "publint": "publint",

package/src/Action/ListActions.ts

@@ -30,7 +30,7 @@ export default class ListActionsRequest {
   }
 }
 
-export type ListResponse = {
+export type ListActionsResponsePayload = {
   actions: {
     id: string;
     actionStatus: string;
@@ -44,7 +44,7 @@ export type ListResponse = {
 export class ListActionsResponse {
   constructor(public response: Response) {}
 
-  public async result(): Promise<ListResponse> {
+  public async result(): Promise<ListActionsResponsePayload> {
     return this.response.json();
   }
 }

package/src/Channel/ListChannels.ts

@@ -30,7 +30,7 @@ export default class ListChannelsRequest {
   }
 }
 
-export type ListResponse = {
+export type ListChannelsResponsePayload = {
   channels: {
     id: string;
     name?: string;
@@ -44,7 +44,7 @@ export type ListResponse = {
 export class ListChannelsResponse {
   constructor(public response: Response) {}
 
-  public async result(): Promise<ListResponse> {
+  public async result(): Promise<ListChannelsResponsePayload> {
     return this.response.json();
   }
 }

package/src/Contact/ListContacts.ts

@@ -30,7 +30,7 @@ export default class ListContactsRequest {
   }
 }
 
-export type ListResponse = {
+export type ListContactsResponsePayload = {
   contacts: {
     id: string;
     name?: string;
@@ -44,7 +44,7 @@ export type ListResponse = {
 export class ListContactsResponse {
   constructor(public response: Response) {}
 
-  public async result(): Promise<ListResponse> {
+  public async result(): Promise<ListContactsResponsePayload> {
     return this.response.json();
   }
 }

package/src/Conversation/GetConversation.ts

@@ -31,7 +31,7 @@ export default class GetConversationRequest {
   }
 }
 
-export type GetResponse = {
+export type GetConversationResponsePayload = {
   conversation: {
     id: string;
     hasEnded: boolean;
@@ -44,7 +44,7 @@ export type GetResponse = {
 export class GetConversationResponse {
   constructor(public response: Response) {}
 
-  public async result(): Promise<GetResponse> {
+  public async result(): Promise<GetConversationResponsePayload> {
     return this.response.json();
   }
 }

package/src/Conversation/ListConversations.ts

@@ -30,7 +30,7 @@ export default class ListConversationsRequest {
   }
 }
 
-export type ListResponse = {
+export type ListConversationsResponsePayload = {
   conversations: {
     id: string;
     hasEnded: boolean;
@@ -43,7 +43,7 @@ export type ListResponse = {
 export class ListConversationsResponse {
   constructor(public response: Response) {}
 
-  public async result(): Promise<ListResponse> {
+  public async result(): Promise<ListConversationsResponsePayload> {
     return this.response.json();
   }
 }

package/src/Label/ListLabels.ts

@@ -30,7 +30,7 @@ export default class ListLabelsRequest {
   }
 }
 
-export type ListResponse = {
+export type ListLabelsResponsePayload = {
   labels: {
     id: string;
     title: string;
@@ -43,7 +43,7 @@ export type ListResponse = {
 export class ListLabelsResponse {
   constructor(public response: Response) {}
 
-  public async result(): Promise<ListResponse> {
+  public async result(): Promise<ListLabelsResponsePayload> {
     return this.response.json();
   }
 }

package/src/Message/ListMessages.ts

@@ -30,7 +30,7 @@ export default class ListMessagesRequest {
   }
 }
 
-export type ListResponse = {
+export type ListMessagesResponsePayload = {
   messages: {
     id: string;
     role: "user" | "assistant";
@@ -46,7 +46,7 @@ export type ListResponse = {
 export class ListMessagesResponse {
   constructor(public response: Response) {}
 
-  public async result(): Promise<ListResponse> {
+  public async result(): Promise<ListMessagesResponsePayload> {
     return this.response.json();
   }
 }

package/src/Model/Correction/CreateCorrectionModel.ts

@@ -44,12 +44,12 @@ export default class CreateCorrectionModelRequest {
   }
 }
 
-export type ListResponse = unknown;
+export type CreateCorrectionResponsePayload = unknown;
 
 export class CreateCorrectionModelResponse {
   constructor(public response: Response) {}
 
-  public async result(): Promise<ListResponse> {
+  public async result(): Promise<CreateCorrectionResponsePayload> {
     return this.response.json();
   }
 }