@great-detail/support-sdk 0.4.4 → 0.4.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@great-detail/support-sdk",
-  "version": "0.4.4",
+  "version": "0.4.5",
   "type": "module",
   "description": "JavaScript SDK for the Great Detail Support System",
   "author": "Great Detail Ltd <info@greatdetail.com>",
@@ -36,8 +36,7 @@
     }
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "keywords": [
     "SDK"

package/src/Action/ListActions.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 {
-  request?: RequestInit;
-}
-
-export type ListActionsResponse = {
-  actions: {
-    id: string;
-    actionStatus: string;
-    message: string;
-    name: string;
-    object?: string;
-    result?: string;
-    startedAt?: string;
-    endedAt?: string;
-    createdAt: string;
-    updatedAt?: string;
-  }[];
-};
-
-export default class ListActions {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport.send<ListActionsResponse>("v1/actions", {
-      ...request,
-      method: "GET",
-    });
-  }
-}

package/src/Action/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 ListActionsResponse } from "./ListActions.js";

package/src/Authentication/KeyAuthentication.ts

@@ -1,50 +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 { KEY_ENV_VAR, USER_ENV_VAR } from "../constants/environment.js";
-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[USER_ENV_VAR] ?? KeyAuthentication.DEFAULT_NAME,
-    key = process.env[KEY_ENV_VAR],
-  }: 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() {
-    return {
-      headers: this.getHeaders(),
-    };
-  }
-
-  public getHeaders() {
-    return {
-      Authorization: `Basic ${btoa(this.name + ":" + this.#key)}`,
-    };
-  }
-}

package/src/Authentication/PublicAuthentication.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 Authentication from "./index.js";
-
-/**
- * Public Authentication Configuration.
- * This type of authentication doesn't define any authentication for outgoing
- * HTTP requests. This functionality may work well when using a proxying method
- * to add credentials to a request after-the-fact.
- *
- * 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() {
-    return {
-      headers: this.getHeaders(),
-    };
-  }
-
-  public getHeaders() {
-    return {};
-  }
-}

package/src/Authentication/TokenAuthentication.ts

@@ -1,41 +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 { TOKEN_ENV_VAR } from "../constants/environment.js";
-import Authentication from "./index.js";
-
-export interface Options {
-  token?: string;
-}
-
-export default class TokenAuthentication implements Authentication {
-  #token: string;
-
-  constructor({ token = process.env[TOKEN_ENV_VAR] }: Options = {}) {
-    if (!token) {
-      throw new Error(
-        "Access Token option must be specified when using Token Authentication",
-      );
-    }
-
-    this.#token = token;
-  }
-
-  public async filter() {
-    return {
-      headers: this.getHeaders(),
-    };
-  }
-
-  public getHeaders() {
-    return {
-      Authorization: `Bearer ${this.#token}`,
-    };
-  }
-}

package/src/Authentication/index.ts

@@ -1,13 +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";
-
-type Authentication = RequestFilterable;
-export default Authentication;

package/src/Boilerplate/CreateBoilerplateCategoryBoilerplate.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 FetchTransport from "../Transport/FetchTransport.js";
-
-export interface Options {
-  id: string;
-  body: z.infer<typeof CreateBoilerplateCategoryBoilerplate.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type CreateBoilerplateCategoryBoilerplateResponse = {
-  boilerplate: {
-    id: string;
-    title: string;
-    content: string;
-    account: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class CreateBoilerplateCategoryBoilerplate {
-  public static SCHEMA = z.object({
-    title: z.string(),
-    content: z.string(),
-    account: z.string(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<CreateBoilerplateCategoryBoilerplateResponse>(
-      "v1/boilerplate-categories/" + encodeURIComponent(id) + "/boilerplates",
-      {
-        ...request,
-        method: "POST",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(
-          CreateBoilerplateCategoryBoilerplate.SCHEMA.parse(body),
-        ),
-      },
-    );
-  }
-}

package/src/Boilerplate/GetBoilerplate.ts

@@ -1,41 +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 GetBoilerplateResponse = {
-  boilerplate: {
-    id: string;
-    title: string;
-    content: string;
-    account: string;
-    boilerplateCategory: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class GetBoilerplate {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<GetBoilerplateResponse>(
-      "v1/boilerplates/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/Boilerplate/ListBoilerplateCategoryBoilerplates.ts

@@ -1,41 +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 default class ListBoilerplateCategoryBoilerplates {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<ListBoilerplateCategoryBoilerplatesResponse>(
-      "v1/boilerplate-categories/" + encodeURIComponent(id) + "/boilerplates",
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}
-
-export type ListBoilerplateCategoryBoilerplatesResponse = {
-  boilerplates: {
-    id: string;
-    title: string;
-    content: string;
-    account: string;
-    boilerplateCategory: string;
-    createdAt: string;
-    updatedAt: string;
-  }[];
-};

package/src/Boilerplate/ListBoilerplates.ts

@@ -1,37 +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 ListBoilerplatesResponse = {
-  boilerplates: {
-    id: string;
-    title: string;
-    content: string;
-    account: string;
-    boilerplateCategory: string;
-    createdAt: string;
-    updatedAt: string;
-  }[];
-};
-
-export default class ListBoilerplates {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport.send<ListBoilerplatesResponse>("v1/boilerplates", {
-      ...request,
-      method: "GET",
-    });
-  }
-}

package/src/Boilerplate/UpdateBoilerplate.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 UpdateBoilerplate.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type UpdateBoilerplateResponse = {
-  boilerplate: {
-    id: string;
-    title: string;
-    content: string;
-    account: string;
-    boilerplateCategory: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class UpdateBoilerplate {
-  public static SCHEMA = z.object({
-    title: z.string().optional(),
-    content: z.string().optional(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<UpdateBoilerplateResponse>(
-      "v1/boilerplates/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "PATCH",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(UpdateBoilerplate.SCHEMA.parse(body)),
-      },
-    );
-  }
-}

package/src/Boilerplate/index.ts

@@ -1,14 +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 CreateBoilerplateCategoryBoilerplateResponse } from "./CreateBoilerplateCategoryBoilerplate.js";
-export { type ListBoilerplateCategoryBoilerplatesResponse } from "./ListBoilerplateCategoryBoilerplates.js";
-export { type GetBoilerplateResponse } from "./GetBoilerplate.js";
-export { type ListBoilerplatesResponse } from "./ListBoilerplates.js";
-export { type UpdateBoilerplateResponse } from "./UpdateBoilerplate.js";

package/src/BoilerplateCategory/CreateBoilerplateCategory.ts

@@ -1,52 +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 {
-  body: z.infer<typeof CreateBoilerplateCategory.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type CreateBoilerplateCategoryResponse = {
-  boilerplateCategory: {
-    id: string;
-    title: string;
-    description?: string;
-    account: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class CreateBoilerplateCategory {
-  public static SCHEMA = z.object({
-    title: z.string(),
-    description: z.string().optional(),
-    account: z.string(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ body, request = {} }: Options) {
-    return this._transport.send<CreateBoilerplateCategoryResponse>(
-      "v1/boilerplate-categories",
-      {
-        ...request,
-        method: "POST",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(CreateBoilerplateCategory.SCHEMA.parse(body)),
-      },
-    );
-  }
-}

package/src/BoilerplateCategory/GetBoilerplateCategory.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 GetBoilerplateCategoryResponse = {
-  boilerplateCategory: {
-    id: string;
-    title: string;
-    description?: string;
-    account: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class GetBoilerplateCategory {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, request = {} }: Options) {
-    return this._transport.send<GetBoilerplateCategoryResponse>(
-      "v1/boilerplate-categories/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/BoilerplateCategory/ListBoilerplateCategories.ts

@@ -1,39 +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 ListBoilerplateCategoriesResponse = {
-  boilerplateCategories: {
-    id: string;
-    title: string;
-    description?: string;
-    account: string;
-    createdAt: string;
-    updatedAt: string;
-  }[];
-};
-
-export default class ListBoilerplateCategories {
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ request = {} }: Options = {}) {
-    return this._transport.send<ListBoilerplateCategoriesResponse>(
-      "v1/boilerplate-categories",
-      {
-        ...request,
-        method: "GET",
-      },
-    );
-  }
-}

package/src/BoilerplateCategory/UpdateBoilerplateCategory.ts

@@ -1,52 +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 UpdateBoilerplateCategory.SCHEMA>;
-  request?: RequestInit;
-}
-
-export type UpdateBoilerplateCategoryResponse = {
-  boilerplateCategory: {
-    id: string;
-    title: string;
-    description?: string;
-    account: string;
-    createdAt: string;
-    updatedAt: string;
-  };
-};
-
-export default class UpdateBoilerplateCategory {
-  public static SCHEMA = z.object({
-    title: z.string().optional(),
-    description: z.string().optional(),
-  });
-
-  constructor(protected _transport: FetchTransport) {}
-
-  public async send({ id, body, request = {} }: Options) {
-    return this._transport.send<UpdateBoilerplateCategoryResponse>(
-      "v1/boilerplate-categories/" + encodeURIComponent(id),
-      {
-        ...request,
-        method: "PATCH",
-        headers: {
-          ...request.headers,
-          "Content-Type": "application/json",
-        },
-        body: JSON.stringify(UpdateBoilerplateCategory.SCHEMA.parse(body)),
-      },
-    );
-  }
-}

package/src/BoilerplateCategory/index.ts

@@ -1,13 +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 CreateBoilerplateCategoryResponse } from "./CreateBoilerplateCategory.js";
-export { type GetBoilerplateCategoryResponse } from "./GetBoilerplateCategory.js";
-export { type ListBoilerplateCategoriesResponse } from "./ListBoilerplateCategories.js";
-export { type UpdateBoilerplateCategoryResponse } from "./UpdateBoilerplateCategory.js";