@aneuhold/core-ts-api-lib 1.0.119 → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2024] [Anton G Neuhold Jr]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,50 @@
-# Core TypeScript API Library
+# Personal Core API Library
 
-![npm](https://img.shields.io/npm/v/%40aneuhold%2Fcore-ts-api-lib)
+[![JSR](https://jsr.io/badges/@aneuhold/core-ts-api-lib)](https://jsr.io/@aneuhold/core-ts-api-lib)
+[![NPM](https://img.shields.io/npm/v/%40aneuhold%2Fcore-ts-api-lib)](https://www.npmjs.com/package/@aneuhold/core-ts-api-lib)
 
-A core library for interacting with and defining the backend API for personal projects. This can be pulled in to any frontend or backend personal project.
+A library for interacting with the backend and defining the backend API for personal projects.
+
+## 📦 Installation
+
+To add to a repo, follow the instructions below for your environment:
+
+### For Node using NPM
+
+Run `yarn add @aneuhold/core-ts-api-lib`
+
+### For Node using JSR
+
+The below instructions still allow for things like Renovate to work, and normal commands with yarn such as `yarn up`.
+
+1. Add the required JSR configuration to a `.yarnrc.yml` file if not there already:
+   ```yml
+   npmScopes:
+     jsr:
+       npmRegistryServer: 'https://npm.jsr.io'
+   ```
+1. Add the package with `yarn add @jsr/aneuhold__core-ts-api-lib`
+
+### For Deno
+
+Run `deno add jsr:@aneuhold/core-ts-api-lib`
+
+## 🟢 Usage
+
+Pull in one of the services and use it like so:
+
+```ts
+import { APIService } from '@aneuhold/core-ts-api-lib';
+// If using Node with JSR
+// import { APIService } from '@jsr/aneuhold__core-ts-api-lib';
+
+export default async function validateUser() {
+  const userInfo = await APIService.validateUser({
+    username: 'user',
+    password: 'pass'
+  });
+  console.log(userInfo);
+}
+```
+
+[See full documentation on usage at JSR!](https://jsr.io/@aneuhold/core-ts-api-lib/doc)

package/lib/index.d.ts

@@ -1,11 +1,11 @@
-import APIService from './services/APIService/APIService';
-import { DOFunctionCallOutput, DOFunctionRawInput, DOFunctionRawOutput } from './services/DOFunctionService/DOFunction';
-import DOFunctionService from './services/DOFunctionService/DOFunctionService';
-import { AuthCheckPasswordInput, AuthCheckPasswordOutput } from './services/DOFunctionService/functions/authCheckPassword';
-import { AuthValidateUserInput, AuthValidateUserOutput } from './services/DOFunctionService/functions/authValidateUser';
-import { ProjectDashboardInput, ProjectDashboardOptions, ProjectDashboardOutput } from './services/DOFunctionService/functions/projectDashboard';
-import { DashboardConfig } from './types/DashboardConfig';
-import { Translation, Translations } from './types/Translations';
-export { DOFunctionService, APIService };
-export type { DOFunctionRawInput, DOFunctionRawOutput, DOFunctionCallOutput, AuthCheckPasswordInput, AuthCheckPasswordOutput, AuthValidateUserInput, AuthValidateUserOutput, ProjectDashboardInput, ProjectDashboardOutput, ProjectDashboardOptions, DashboardConfig, Translations, Translation };
+import APIService from './services/APIService/APIService.js';
+import { DOFunctionCallOutput, DOFunctionRawInput, DOFunctionRawOutput } from './services/DOFunctionService/DOFunction.js';
+import DOFunctionService from './services/DOFunctionService/DOFunctionService.js';
+import { AuthCheckPasswordInput, AuthCheckPasswordOutput } from './services/DOFunctionService/functions/authCheckPassword.js';
+import { AuthValidateUserInput, AuthValidateUserOutput } from './services/DOFunctionService/functions/authValidateUser.js';
+import { ProjectDashboardInput, ProjectDashboardOptions, ProjectDashboardOutput } from './services/DOFunctionService/functions/projectDashboard.js';
+import { DashboardConfig } from './types/DashboardConfig.js';
+import { Translation, Translations } from './types/Translations.js';
+export { APIService, DOFunctionService };
+export type { AuthCheckPasswordInput, AuthCheckPasswordOutput, AuthValidateUserInput, AuthValidateUserOutput, DashboardConfig, DOFunctionCallOutput, DOFunctionRawInput, DOFunctionRawOutput, ProjectDashboardInput, ProjectDashboardOptions, ProjectDashboardOutput, Translation, Translations };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,yCAAyC,CAAC;AACjD,OAAO,iBAAiB,MAAM,gDAAgD,CAAC;AAC/E,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACxB,MAAM,0DAA0D,CAAC;AAClE,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,yDAAyD,CAAC;AACjE,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,yDAAyD,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAGjE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAC;AAGzC,YAAY,EACV,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EACpB,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,eAAe,EACf,YAAY,EACZ,WAAW,EACZ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"./src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EACL,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACpB,MAAM,4CAA4C,CAAC;AACpD,OAAO,iBAAiB,MAAM,mDAAmD,CAAC;AAClF,OAAO,EACL,sBAAsB,EACtB,uBAAuB,EACxB,MAAM,6DAA6D,CAAC;AACrE,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,4DAA4D,CAAC;AACpE,OAAO,EACL,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,4DAA4D,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAGpE,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC;AAGzC,YAAY,EACV,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,WAAW,EACX,YAAY,EACb,CAAC"}

package/lib/index.js

@@ -1,10 +1,5 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.APIService = exports.DOFunctionService = void 0;
-const APIService_1 = __importDefault(require("./services/APIService/APIService"));
-exports.APIService = APIService_1.default;
-const DOFunctionService_1 = __importDefault(require("./services/DOFunctionService/DOFunctionService"));
-exports.DOFunctionService = DOFunctionService_1.default;
+import APIService from './services/APIService/APIService.js';
+import DOFunctionService from './services/DOFunctionService/DOFunctionService.js';
+// Export all the functions and classes from this library
+export { APIService, DOFunctionService };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"./src/","sources":["index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAM7D,OAAO,iBAAiB,MAAM,mDAAmD,CAAC;AAiBlF,yDAAyD;AACzD,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC"}

package/lib/index.ts

@@ -0,0 +1,42 @@
+import APIService from './services/APIService/APIService.js';
+import {
+  DOFunctionCallOutput,
+  DOFunctionRawInput,
+  DOFunctionRawOutput
+} from './services/DOFunctionService/DOFunction.js';
+import DOFunctionService from './services/DOFunctionService/DOFunctionService.js';
+import {
+  AuthCheckPasswordInput,
+  AuthCheckPasswordOutput
+} from './services/DOFunctionService/functions/authCheckPassword.js';
+import {
+  AuthValidateUserInput,
+  AuthValidateUserOutput
+} from './services/DOFunctionService/functions/authValidateUser.js';
+import {
+  ProjectDashboardInput,
+  ProjectDashboardOptions,
+  ProjectDashboardOutput
+} from './services/DOFunctionService/functions/projectDashboard.js';
+import { DashboardConfig } from './types/DashboardConfig.js';
+import { Translation, Translations } from './types/Translations.js';
+
+// Export all the functions and classes from this library
+export { APIService, DOFunctionService };
+
+// Export TypeScript types where needed
+export type {
+  AuthCheckPasswordInput,
+  AuthCheckPasswordOutput,
+  AuthValidateUserInput,
+  AuthValidateUserOutput,
+  DashboardConfig,
+  DOFunctionCallOutput,
+  DOFunctionRawInput,
+  DOFunctionRawOutput,
+  ProjectDashboardInput,
+  ProjectDashboardOptions,
+  ProjectDashboardOutput,
+  Translation,
+  Translations
+};

package/lib/services/APIService/APIService.d.ts

@@ -1,5 +1,6 @@
-import { AuthValidateUserInput } from '../DOFunctionService/functions/authValidateUser';
-import { ProjectDashboardInput } from '../DOFunctionService/functions/projectDashboard';
+import { DOFunctionCallOutput } from '../DOFunctionService/DOFunction.js';
+import { AuthValidateUserInput, AuthValidateUserOutput } from '../DOFunctionService/functions/authValidateUser.js';
+import { ProjectDashboardInput, ProjectDashboardOutput } from '../DOFunctionService/functions/projectDashboard.js';
 /**
  * A service for making calls to the backend API for personal projects. This is
  * abstracted so that the backend implementation can change over time.
@@ -8,13 +9,24 @@ export default class APIService {
     /**
      * Validates the provided username and password against the database and
      * returns the user's information if successful.
+     *
+     * @param input - The input containing username and password.
+     * @returns A promise that resolves to the user's information if validation is successful.
+     */
+    static validateUser(input: AuthValidateUserInput): Promise<DOFunctionCallOutput<AuthValidateUserOutput>>;
+    /**
+     * Sets the URL for the dashboard API.
+     *
+     * @param url - The URL to be set for the dashboard API.
      */
-    static validateUser(input: AuthValidateUserInput): Promise<import("../..").DOFunctionCallOutput<import("../DOFunctionService/functions/authValidateUser").AuthValidateUserOutput>>;
     static setDashboardAPIUrl(url: string): void;
     /**
      * Calls the dashboard API and returns the result. This will fail if the
      * dashboard API URL has not been set. See {@link setDashboardAPIUrl}.
+     *
+     * @param input - The input for the dashboard API call.
+     * @returns A promise that resolves to the result of the dashboard API call.
      */
-    static callDashboardAPI(input: ProjectDashboardInput): Promise<import("../..").DOFunctionCallOutput<import("../DOFunctionService/functions/projectDashboard").ProjectDashboardOutput>>;
+    static callDashboardAPI(input: ProjectDashboardInput): Promise<DOFunctionCallOutput<ProjectDashboardOutput>>;
 }
 //# sourceMappingURL=APIService.d.ts.map

package/lib/services/APIService/APIService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"APIService.d.ts","sourceRoot":"","sources":["../../../src/services/APIService/APIService.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,iDAAiD,CAAC;AACxF,OAAO,EAAE,qBAAqB,EAAE,MAAM,iDAAiD,CAAC;AAExF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B;;;OAGG;WACU,YAAY,CAAC,KAAK,EAAE,qBAAqB;IAKtD,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM;IAIrC;;;OAGG;WACU,gBAAgB,CAAC,KAAK,EAAE,qBAAqB;CAI3D"}
+{"version":3,"file":"APIService.d.ts","sourceRoot":"./src/","sources":["services/APIService/APIService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,oCAAoC,CAAC;AAE1E,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,oDAAoD,CAAC;AAE5D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B;;;;;;OAMG;WACU,YAAY,CACvB,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;IAKxD;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM;IAIrC;;;;;;OAMG;WACU,gBAAgB,CAC3B,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,CAAC;CAIzD"}

package/lib/services/APIService/APIService.js

@@ -1,32 +1,38 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const DOFunctionService_1 = __importDefault(require("../DOFunctionService/DOFunctionService"));
+import DOFunctionService from '../DOFunctionService/DOFunctionService.js';
 /**
  * A service for making calls to the backend API for personal projects. This is
  * abstracted so that the backend implementation can change over time.
  */
-class APIService {
+export default class APIService {
     /**
      * Validates the provided username and password against the database and
      * returns the user's information if successful.
+     *
+     * @param input - The input containing username and password.
+     * @returns A promise that resolves to the user's information if validation is successful.
      */
     static async validateUser(input) {
-        const result = await DOFunctionService_1.default.authValidateUser.call(input);
+        const result = await DOFunctionService.authValidateUser.call(input);
         return result;
     }
+    /**
+     * Sets the URL for the dashboard API.
+     *
+     * @param url - The URL to be set for the dashboard API.
+     */
     static setDashboardAPIUrl(url) {
-        DOFunctionService_1.default.projectDashboard.setUrl(url);
+        DOFunctionService.projectDashboard.setUrl(url);
     }
     /**
      * Calls the dashboard API and returns the result. This will fail if the
      * dashboard API URL has not been set. See {@link setDashboardAPIUrl}.
+     *
+     * @param input - The input for the dashboard API call.
+     * @returns A promise that resolves to the result of the dashboard API call.
      */
     static async callDashboardAPI(input) {
-        const result = await DOFunctionService_1.default.projectDashboard.call(input);
+        const result = await DOFunctionService.projectDashboard.call(input);
         return result;
     }
 }
-exports.default = APIService;
+//# sourceMappingURL=APIService.js.map

package/lib/services/APIService/APIService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"APIService.js","sourceRoot":"./src/","sources":["services/APIService/APIService.ts"],"names":[],"mappings":"AACA,OAAO,iBAAiB,MAAM,2CAA2C,CAAC;AAU1E;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CACvB,KAA4B;QAE5B,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAW;QACnC,iBAAiB,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAC3B,KAA4B;QAE5B,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpE,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/lib/services/APIService/APIService.ts

@@ -0,0 +1,53 @@
+import { DOFunctionCallOutput } from '../DOFunctionService/DOFunction.js';
+import DOFunctionService from '../DOFunctionService/DOFunctionService.js';
+import {
+  AuthValidateUserInput,
+  AuthValidateUserOutput
+} from '../DOFunctionService/functions/authValidateUser.js';
+import {
+  ProjectDashboardInput,
+  ProjectDashboardOutput
+} from '../DOFunctionService/functions/projectDashboard.js';
+
+/**
+ * A service for making calls to the backend API for personal projects. This is
+ * abstracted so that the backend implementation can change over time.
+ */
+export default class APIService {
+  /**
+   * Validates the provided username and password against the database and
+   * returns the user's information if successful.
+   *
+   * @param input - The input containing username and password.
+   * @returns A promise that resolves to the user's information if validation is successful.
+   */
+  static async validateUser(
+    input: AuthValidateUserInput
+  ): Promise<DOFunctionCallOutput<AuthValidateUserOutput>> {
+    const result = await DOFunctionService.authValidateUser.call(input);
+    return result;
+  }
+
+  /**
+   * Sets the URL for the dashboard API.
+   *
+   * @param url - The URL to be set for the dashboard API.
+   */
+  static setDashboardAPIUrl(url: string) {
+    DOFunctionService.projectDashboard.setUrl(url);
+  }
+
+  /**
+   * Calls the dashboard API and returns the result. This will fail if the
+   * dashboard API URL has not been set. See {@link setDashboardAPIUrl}.
+   *
+   * @param input - The input for the dashboard API call.
+   * @returns A promise that resolves to the result of the dashboard API call.
+   */
+  static async callDashboardAPI(
+    input: ProjectDashboardInput
+  ): Promise<DOFunctionCallOutput<ProjectDashboardOutput>> {
+    const result = await DOFunctionService.projectDashboard.call(input);
+    return result;
+  }
+}

package/lib/services/DOFunctionService/DOFunction.d.ts

@@ -40,6 +40,9 @@ export interface DOFunctionRawOutput {
         'Content-Type': 'application/octet-stream';
     };
 }
+/**
+ * A generic interface representing the output of a Digital Ocean function call.
+ */
 export interface DOFunctionCallOutput<TOutput extends DOFunctionOutput> {
     success: boolean;
     errors: string[];
@@ -49,6 +52,12 @@ export interface DOFunctionCallOutput<TOutput extends DOFunctionOutput> {
  * An abstract class that can be extended to define a Digital Ocean
  * function.
  */
+/**
+ * An abstract class representing a Digital Ocean Function.
+ *
+ * @template TInput - The type of the input to the function, extending {@link DOFunctionInput}.
+ * @template TOutput - The type of the output from the function, extending {@link DOFunctionOutput}.
+ */
 export default abstract class DOFunction<TInput extends DOFunctionInput, TOutput extends DOFunctionOutput> {
     /**
      * The URL of the digital ocean function.
@@ -56,13 +65,28 @@ export default abstract class DOFunction<TInput extends DOFunctionInput, TOutput
     protected url?: string;
     protected functionName: string;
     protected constructor();
+    /**
+     * Sets the URL of the Digital Ocean function.
+     *
+     * @param url - The URL to set.
+     */
     setUrl(url: string): void;
     /**
      * A generic call method for any Digital Ocean Function from the client.
      * This gets pretty crazy with the serialization logic. It has been tested
      * heavily.
+     *
+     * @param input - The input to the function.
+     * @returns A promise that resolves to the output of the function call, wrapped in {@link DOFunctionCallOutput}.
+     * @throws Will throw an error if the URL is not set.
      */
     call(input: TInput): Promise<DOFunctionCallOutput<TOutput>>;
+    /**
+     * Decodes an {@link ArrayBuffer} into a {@link DOFunctionCallOutput}.
+     *
+     * @param buffer - The buffer to decode.
+     * @returns The decoded output.
+     */
     private decodeArrayBuffer;
 }
 //# sourceMappingURL=DOFunction.d.ts.map

package/lib/services/DOFunctionService/DOFunction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DOFunction.d.ts","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunction.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE;QACJ;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE;QACP,cAAc,EAAE,0BAA0B,CAAC;KAC5C,CAAC;CACH;AAED,MAAM,WAAW,oBAAoB,CAAC,OAAO,SAAS,gBAAgB;IACpE,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,UAAU,CACtC,MAAM,SAAS,eAAe,EAC9B,OAAO,SAAS,gBAAgB;IAEhC;;OAEG;IACH,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAE/B,SAAS;IAIT,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB;;;;OAIG;IACG,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAgBjE,OAAO,CAAC,iBAAiB;CAM1B"}
+{"version":3,"file":"DOFunction.d.ts","sourceRoot":"./src/","sources":["services/DOFunctionService/DOFunction.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE;QACJ;;;WAGG;QACH,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE;QACP,cAAc,EAAE,0BAA0B,CAAC;KAC5C,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,OAAO,SAAS,gBAAgB;IACpE,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,OAAO,CAAC;CACf;AAED;;;GAGG;AACH;;;;;GAKG;AACH,MAAM,CAAC,OAAO,CAAC,QAAQ,OAAO,UAAU,CACtC,MAAM,SAAS,eAAe,EAC9B,OAAO,SAAS,gBAAgB;IAEhC;;OAEG;IACH,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEvB,SAAS,CAAC,YAAY,EAAE,MAAM,CAAC;IAE/B,SAAS;IAIT;;;;OAIG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB;;;;;;;;OAQG;IACG,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAiBjE;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;CAa1B"}

package/lib/services/DOFunctionService/DOFunction.js

@@ -1,11 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const bson_1 = require("bson");
+import { BSON } from 'bson';
 /**
  * An abstract class that can be extended to define a Digital Ocean
  * function.
  */
-class DOFunction {
+/**
+ * An abstract class representing a Digital Ocean Function.
+ *
+ * @template TInput - The type of the input to the function, extending {@link DOFunctionInput}.
+ * @template TOutput - The type of the output from the function, extending {@link DOFunctionOutput}.
+ */
+export default class DOFunction {
     /**
      * The URL of the digital ocean function.
      */
@@ -14,6 +18,11 @@ class DOFunction {
     constructor() {
         this.functionName = this.constructor.name;
     }
+    /**
+     * Sets the URL of the Digital Ocean function.
+     *
+     * @param url - The URL to set.
+     */
     setUrl(url) {
         this.url = url;
     }
@@ -21,11 +30,16 @@ class DOFunction {
      * A generic call method for any Digital Ocean Function from the client.
      * This gets pretty crazy with the serialization logic. It has been tested
      * heavily.
+     *
+     * @param input - The input to the function.
+     * @returns A promise that resolves to the output of the function call, wrapped in {@link DOFunctionCallOutput}.
+     * @throws Will throw an error if the URL is not set.
      */
     async call(input) {
         if (!this.url) {
             throw new Error(`${this.functionName} URL is not set`);
         }
+        const serializedInput = BSON.serialize(input);
         const result = await fetch(this.url, {
             method: 'POST',
             headers: {
@@ -33,13 +47,27 @@ class DOFunction {
             },
             // It isn't clear why this works by itself. It comes in to the function
             // as a base64 string.
-            body: bson_1.BSON.serialize(input)
+            body: serializedInput
         });
         return this.decodeArrayBuffer(await result.arrayBuffer());
     }
+    /**
+     * Decodes an {@link ArrayBuffer} into a {@link DOFunctionCallOutput}.
+     *
+     * @param buffer - The buffer to decode.
+     * @returns The decoded output.
+     */
     decodeArrayBuffer(buffer) {
         const bytes = new Uint8Array(buffer);
-        return bson_1.BSON.deserialize(bytes);
+        console.log('Buffer length:', bytes.length);
+        console.log('Buffer content:', bytes);
+        try {
+            return BSON.deserialize(bytes);
+        }
+        catch (error) {
+            console.error('Deserialization error:', error);
+            throw error;
+        }
     }
 }
-exports.default = DOFunction;
+//# sourceMappingURL=DOFunction.js.map

package/lib/services/DOFunctionService/DOFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DOFunction.js","sourceRoot":"./src/","sources":["services/DOFunctionService/DOFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAyD5B;;;GAGG;AACH;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAgB,UAAU;IAItC;;OAEG;IACO,GAAG,CAAU;IAEb,YAAY,CAAS;IAE/B;QACE,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,GAAW;QAChB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;IACjB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,CAAC,KAAa;QACtB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,YAAY,iBAAiB,CAAC,CAAC;QACzD,CAAC;QACD,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YACnC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,0BAA0B;aAC3C;YACD,uEAAuE;YACvE,sBAAsB;YACtB,IAAI,EAAE,eAAe;SACtB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,iBAAiB,CAAC,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACK,iBAAiB,CACvB,MAAmB;QAEnB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACrC,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAkC,CAAC;QAClE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;YAC/C,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF"}

package/lib/services/DOFunctionService/DOFunction.ts

@@ -0,0 +1,137 @@
+import { BSON } from 'bson';
+
+/**
+ * The input to a Digital Ocean function must always be an object.
+ */
+export type DOFunctionInput = object;
+
+/**
+ * The output from a Digital Ocean function must always be an object. This
+ * is the data that actually matters and doesn't require parsing the `body`
+ * property.
+ */
+export type DOFunctionOutput = object;
+
+/**
+ * Raw input to a Digital Ocean function will always have a data property
+ * which is a string. This string must be parsed using EJSON.parse.
+ */
+export interface DOFunctionRawInput {
+  /**
+   * There are many other properties in the `http` object, but only the body
+   * property is used.
+   */
+  http: {
+    /**
+     * The body property needs to be parsed with atob, then put through some
+     * other processing.
+     */
+    body: string;
+  };
+}
+
+/**
+ * Raw output from a Digital Ocean function must always be an object with
+ * a body property. The body property must be a string that is base64 encoded
+ * or an object. With how this project is set up, it will always be base64
+ * encoded to support BSON types.
+ */
+export interface DOFunctionRawOutput {
+  /**
+   * The body is a base64 encoded string.
+   */
+  body: string;
+  headers: {
+    'Content-Type': 'application/octet-stream';
+  };
+}
+
+/**
+ * A generic interface representing the output of a Digital Ocean function call.
+ */
+export interface DOFunctionCallOutput<TOutput extends DOFunctionOutput> {
+  success: boolean;
+  errors: string[];
+  data: TOutput;
+}
+
+/**
+ * An abstract class that can be extended to define a Digital Ocean
+ * function.
+ */
+/**
+ * An abstract class representing a Digital Ocean Function.
+ *
+ * @template TInput - The type of the input to the function, extending {@link DOFunctionInput}.
+ * @template TOutput - The type of the output from the function, extending {@link DOFunctionOutput}.
+ */
+export default abstract class DOFunction<
+  TInput extends DOFunctionInput,
+  TOutput extends DOFunctionOutput
+> {
+  /**
+   * The URL of the digital ocean function.
+   */
+  protected url?: string;
+
+  protected functionName: string;
+
+  protected constructor() {
+    this.functionName = this.constructor.name;
+  }
+
+  /**
+   * Sets the URL of the Digital Ocean function.
+   *
+   * @param url - The URL to set.
+   */
+  setUrl(url: string) {
+    this.url = url;
+  }
+
+  /**
+   * A generic call method for any Digital Ocean Function from the client.
+   * This gets pretty crazy with the serialization logic. It has been tested
+   * heavily.
+   *
+   * @param input - The input to the function.
+   * @returns A promise that resolves to the output of the function call, wrapped in {@link DOFunctionCallOutput}.
+   * @throws Will throw an error if the URL is not set.
+   */
+  async call(input: TInput): Promise<DOFunctionCallOutput<TOutput>> {
+    if (!this.url) {
+      throw new Error(`${this.functionName} URL is not set`);
+    }
+    const serializedInput = BSON.serialize(input);
+    const result = await fetch(this.url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/octet-stream'
+      },
+      // It isn't clear why this works by itself. It comes in to the function
+      // as a base64 string.
+      body: serializedInput
+    });
+    return this.decodeArrayBuffer(await result.arrayBuffer());
+  }
+
+  /**
+   * Decodes an {@link ArrayBuffer} into a {@link DOFunctionCallOutput}.
+   *
+   * @param buffer - The buffer to decode.
+   * @returns The decoded output.
+   */
+  private decodeArrayBuffer(
+    buffer: ArrayBuffer
+  ): DOFunctionCallOutput<TOutput> {
+    const bytes = new Uint8Array(buffer);
+    console.log('Buffer length:', bytes.length);
+    console.log('Buffer content:', bytes);
+    try {
+      return BSON.deserialize(bytes) as DOFunctionCallOutput<TOutput>;
+    } catch (error) {
+      console.error('Deserialization error:', error);
+      throw error;
+    }
+  }
+}

package/lib/services/DOFunctionService/DOFunctionService.d.ts

@@ -1,13 +1,22 @@
-import { DOFunctionCallOutput, DOFunctionInput, DOFunctionOutput, DOFunctionRawInput, DOFunctionRawOutput } from './DOFunction';
-import AuthCheckPassword from './functions/authCheckPassword';
-import AuthValidateUser from './functions/authValidateUser';
-import ProjectDashboard from './functions/projectDashboard';
+import { DOFunctionCallOutput, DOFunctionInput, DOFunctionOutput, DOFunctionRawInput, DOFunctionRawOutput } from './DOFunction.js';
+import AuthCheckPassword from './functions/authCheckPassword.js';
+import AuthValidateUser from './functions/authValidateUser.js';
+import ProjectDashboard from './functions/projectDashboard.js';
 /**
  * A service to provide some utility related to Digital Ocean functions.
  */
 export default class DOFunctionService {
-    static auchCheckPassword: AuthCheckPassword;
+    /**
+     * {@link AuthCheckPassword} function instance.
+     */
+    static authCheckPassword: AuthCheckPassword;
+    /**
+     * {@link AuthValidateUser} function instance.
+     */
     static authValidateUser: AuthValidateUser;
+    /**
+     * {@link ProjectDashboard} function instance.
+     */
     static projectDashboard: ProjectDashboard;
     /**
      * A generic method to handle any API request on the backend. This has
@@ -16,9 +25,25 @@ export default class DOFunctionService {
      * This will take care of returning the error if the handler throws.
      * Ideally the handler should not throw though unless something really
      * unexpected happened.
+     *
+     * @param rawInput - The raw input for the function.
+     * @param handler - The handler function to process the input.
+     * @returns The raw output of the function call.
      */
     static handleApiRequest<TInput extends DOFunctionInput, TOutput extends DOFunctionOutput>(rawInput: DOFunctionRawInput, handler: (input: TInput) => Promise<DOFunctionCallOutput<TOutput>>): Promise<DOFunctionRawOutput>;
+    /**
+     * Deserializes the raw input into a typed input object.
+     *
+     * @param rawInput - The raw input to deserialize.
+     * @returns The deserialized input object.
+     */
     private static deserializeInput;
+    /**
+     * Serializes the output object into a base64 string.
+     *
+     * @param output - The output object to serialize.
+     * @returns The serialized output as a base64 string.
+     */
     private static serializeOutput;
 }
 //# sourceMappingURL=DOFunctionService.d.ts.map