@great-detail/support-sdk 0.0.4 → 0.0.6

package/dist/index.d.ts

@@ -1,4 +1,6 @@
-import { z } from 'zod';
+import { A as Authentication } from './index-zrmJVCfU.js';
+export { C as Client, h as CreateCorrectionResponsePayload, d as CreateLabelResponsePayload, i as CreateResponseResponsePayload, G as GetConversationResponsePayload, L as ListActionsResponsePayload, a as ListChannelsResponsePayload, b as ListContactsResponsePayload, c as ListConversationsResponsePayload, e as ListLabelsResponsePayload, f as ListMessagesResponsePayload, g as ListModelsResponsePayload, j as ListSourcesResponsePayload, R as RequestFilterable, C as default } from './index-zrmJVCfU.js';
+import 'zod';
 
 /**
  * Great Detail Support System.
@@ -15,30 +17,6 @@ import { z } from 'zod';
  */
 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.
  *
@@ -48,7 +26,7 @@ interface Authentication extends RequestFilterable {
  * @see       https://greatdetail.com
  */
 
-interface Options$d {
+interface Options$1 {
     name?: string;
     key?: string;
 }
@@ -56,7 +34,7 @@ declare class KeyAuthentication implements Authentication {
     #private;
     static DEFAULT_NAME: string;
     name: string;
-    constructor({ name, key, }?: Options$d);
+    constructor({ name, key, }?: Options$1);
     filter(request: RequestInit): Promise<RequestInit>;
 }
 
@@ -69,12 +47,12 @@ declare class KeyAuthentication implements Authentication {
  * @see       https://greatdetail.com
  */
 
-interface Options$c {
+interface Options {
     token?: string;
 }
 declare class TokenAuthentication implements Authentication {
     #private;
-    constructor({ token }?: Options$c);
+    constructor({ token }?: Options);
     filter(request: RequestInit): Promise<RequestInit>;
 }
 
@@ -97,492 +75,4 @@ 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$b extends SendOptions {
-    request?: RequestInit;
-}
-declare class ListActionsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$b): 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$a extends SendOptions {
-    request?: RequestInit;
-}
-declare class ListChannelsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$a): 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$9 extends SendOptions {
-    request?: RequestInit;
-}
-declare class ListContactsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$9): 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$8 extends SendOptions {
-    id: string;
-    request?: RequestInit;
-}
-declare class GetConversationRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ id, request, ...options }: Options$8): 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$7 extends SendOptions {
-    request?: RequestInit;
-}
-declare class ListConversationsRequest {
-    protected _client: Client;
-    constructor(_client: Client);
-    send({ request, ...options }?: Options$7): 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$6 extends SendOptions {
-    body: z.infer<typeof CreateLabelRequest.SCHEMA>;
-    request?: RequestInit;
-}
-declare class CreateLabelRequest {
-    protected _client: Client;
-    static SCHEMA: z.ZodObject<{
-        title: z.ZodString;
-        description: z.ZodOptional<z.ZodString>;
-        account: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        title: string;
-        account: string;
-        description?: string | undefined;
-    }, {
-        title: string;
-        account: string;
-        description?: string | undefined;
-    }>;
-    constructor(_client: Client);
-    send({ body, request, ...options }: Options$6): Promise<CreateLabelResponse>;
-}
-type CreateLabelResponsePayload = {
-    label: {
-        id: string;
-        title: string;
-        description?: string;
-        createdAt: string;
-        updatedAt?: string;
-    };
-};
-declare class CreateLabelResponse {
-    response: Response;
-    constructor(response: Response);
-    result(): Promise<CreateLabelResponsePayload>;
-}
-
-/**
- * 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: {
-        create: CreateLabelRequest;
-        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 CreateLabelResponsePayload, 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 };
+export { DEFAULT_SUPPORT_BASE_URL, KeyAuthentication, PublicAuthentication, TokenAuthentication };

package/dist/index.js

@@ -1 +1 @@
-import{a,b as n,c as p,d as i}from"./chunk-WCSPJBPY.js";var t=class s{static DEFAULT_NAME=n;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{i as Client,a as DEFAULT_SUPPORT_BASE_URL,t as KeyAuthentication,p as PublicAuthentication,o as TokenAuthentication,i as default};
+import{a as l,b as i,c as n,d as a,e as p,f as m,g as f}from"./chunk-OVSCTY74.js";var t=class s{static DEFAULT_NAME=i;name;#e;constructor({name:e=process.env[p]??s.DEFAULT_NAME,key:r=process.env[a]}={}){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[n]}={}){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{f as Client,l as DEFAULT_SUPPORT_BASE_URL,t as KeyAuthentication,m as PublicAuthentication,o as TokenAuthentication,f as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@great-detail/support-sdk",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "type": "module",
   "description": "JavaScript SDK for the Great Detail Support System",
   "author": "Great Detail Ltd <info@greatdetail.com>",
@@ -47,6 +47,7 @@
     "changeset": "changeset",
     "eslint": "eslint .",
     "eslint:dev": "eslint . --fix",
+    "jest": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --passWithNoTests",
     "lint": "npm-run-all eslint typecheck publint prettier",
     "lint:dev": "npm-run-all eslint:dev typecheck publint prettier:dev",
     "prerelease": "npm-run-all build",
@@ -54,7 +55,8 @@
     "prettier:dev": "prettier --write .",
     "publint": "publint",
     "release": "changeset publish",
-    "tsup": "tsup --entry src/index.ts --entry src/cli.ts --format cjs,esm --minify --dts",
+    "test": "npm-run-all jest",
+    "tsup": "tsup --entry src/index.ts --entry src/cli.ts --entry src/cli/index.ts --format cjs,esm --minify --dts",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
@@ -67,11 +69,15 @@
     "@changesets/cli": "^2.27.7",
     "@great-detail/eslint-config": "^1.0.4",
     "@great-detail/prettier-config": "^0.2.4",
+    "@jest/globals": "^29.7.0",
     "@types/node": "^20.14.12",
+    "cross-env": "^7.0.3",
     "eslint": "^8.57.0",
+    "jest": "^29.7.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.3.3",
     "publint": "^0.2.9",
+    "ts-jest": "^29.2.3",
     "ts-node": "^10.9.2",
     "tsup": "^8.2.3",
     "typescript": "^5.5.4"

package/src/Action/ListActions.ts

@@ -34,10 +34,14 @@ export type ListActionsResponsePayload = {
   actions: {
     id: string;
     actionStatus: string;
-    object?: unknown;
-    result?: unknown;
+    message: string;
+    name: string;
+    object?: string;
+    result?: string;
     startedAt?: string;
     endedAt?: string;
+    createdAt: string;
+    updatedAt?: string;
   }[];
 };
 

package/src/Authentication/KeyAuthentication.ts

@@ -7,7 +7,11 @@
  * @see       https://greatdetail.com
  */
 
-import { DEFAULT_KEY_AUTHENTICATION_NAME } from "../constants/index.js";
+import {
+  DEFAULT_KEY_AUTHENTICATION_NAME,
+  KEY_ENV_VAR,
+  USER_ENV_VAR,
+} from "../constants/index.js";
 import Authentication from "./index.js";
 
 export interface Options {
@@ -22,8 +26,8 @@ export default class KeyAuthentication implements Authentication {
   #key: string;
 
   constructor({
-    name = process.env.SUPPORT_KEY_NAME ?? KeyAuthentication.DEFAULT_NAME,
-    key = process.env.SUPPORT_API_KEY,
+    name = process.env[USER_ENV_VAR] ?? KeyAuthentication.DEFAULT_NAME,
+    key = process.env[KEY_ENV_VAR],
   }: Options = {}) {
     if (!key) {
       throw new Error(

package/src/Authentication/TokenAuthentication.ts

@@ -7,6 +7,7 @@
  * @see       https://greatdetail.com
  */
 
+import { TOKEN_ENV_VAR } from "../constants/index.js";
 import Authentication from "./index.js";
 
 export interface Options {
@@ -16,7 +17,7 @@ export interface Options {
 export default class TokenAuthentication implements Authentication {
   #token: string;
 
-  constructor({ token = process.env.SUPPORT_ACCESS_TOKEN }: Options = {}) {
+  constructor({ token = process.env[TOKEN_ENV_VAR] }: Options = {}) {
     if (!token) {
       throw new Error(
         "Access Token option must be specified when using Token Authentication",

package/src/Channel/ListChannels.ts

@@ -31,14 +31,31 @@ export default class ListChannelsRequest {
 }
 
 export type ListChannelsResponsePayload = {
-  channels: {
+  channels: ({
     id: string;
     name?: string;
     channelStatus: "ActiveChannelStatus" | "PotentialChannelStatus";
-    source: "twilio-sendgrid" | "meta-whatsapp";
+    account: string;
     createdAt: string;
     updatedAt?: string;
-  }[];
+  } & (
+    | {
+        source: "meta-whatsapp";
+        metaWhatsapp: {
+          id: string;
+          whatsappAccountID: string;
+          whatsappPhoneNumberID: string;
+          accessToken: string;
+        };
+      }
+    | {
+        source: "twilio-sendgrid";
+        twilioSendgrid: {
+          id: string;
+          apiKey: string;
+        };
+      }
+  ))[];
 };
 
 export class ListChannelsResponse {