@aneuhold/core-ts-api-lib 2.1.24 → 2.2.0

package/CHANGELOG.md

@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 🔖 [2.2.0] (2025-07-12)
+
+### ✅ Added
+
+- Added new `APIResponse<T>` generic type for standardized API responses
+- Added `GCloudAPIService` for interacting with Google Cloud API endpoints
+- Added `gcloudBackendUrl` field to `DashboardConfig` type
+
+### 🏗️ Changed
+
+- _Breaking Change:_ Replaced `DOFunctionCallOutput<T>` with `APIResponse<T>` throughout the codebase
+- Updated `APIService.callDashboardAPI()` to use `GCloudAPIService` instead of `DOFunctionService`
+- Updated `APIService.setDashboardAPIUrl()` to set URL on `GCloudAPIService`
+- Enhanced JSDoc comment for `setDashboardAPIUrl()` to clarify URL format requirements
+
+### 🔥 Removed
+
+- _Breaking Change:_ Removed `DOFunctionCallOutput` type from public exports
+
+## 🔖 [2.1.25] (2025-07-04)
+
+### 🏗️ Changed
+
+- Updated dependencies including @aneuhold/core-ts-lib and @aneuhold/main-scripts
+
 ## 🔖 [2.1.24] (2025-06-26)
 
 ### 🏗️ Changed
@@ -32,6 +57,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 <!-- Link References -->
 
+[2.2.0]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.1.25...core-ts-api-lib-v2.2.0
+[2.1.25]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.1.24...core-ts-api-lib-v2.1.25
 [2.1.24]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.1.23...core-ts-api-lib-v2.1.24
 [2.1.23]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.1.22...core-ts-api-lib-v2.1.23
 [2.1.22]: https://github.com/aneuhold/ts-libs/releases/tag/core-ts-api-lib-v2.1.22

package/lib/index.d.ts

@@ -1,11 +1,12 @@
 import APIService from './services/APIService/APIService.js';
-import { DOFunctionCallOutput, DOFunctionRawInput, DOFunctionRawOutput } from './services/DOFunctionService/DOFunction.js';
+import { 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 { APIResponse } from './types/APIResponse.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 };
+export type { APIResponse, AuthCheckPasswordInput, AuthCheckPasswordOutput, AuthValidateUserInput, AuthValidateUserOutput, DashboardConfig, 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,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EACL,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,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,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,WAAW,EACX,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,WAAW,EACX,YAAY,EACb,CAAC"}

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,MAAM,qCAAqC,CAAC;AAK7D,OAAO,iBAAiB,MAAM,mDAAmD,CAAC;AAkBlF,yDAAyD;AACzD,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC"}

package/lib/index.ts

@@ -1,6 +1,5 @@
 import APIService from './services/APIService/APIService.js';
 import {
-  DOFunctionCallOutput,
   DOFunctionRawInput,
   DOFunctionRawOutput
 } from './services/DOFunctionService/DOFunction.js';
@@ -18,6 +17,7 @@ import {
   ProjectDashboardOptions,
   ProjectDashboardOutput
 } from './services/DOFunctionService/functions/projectDashboard.js';
+import { APIResponse } from './types/APIResponse.js';
 import { DashboardConfig } from './types/DashboardConfig.js';
 import { Translation, Translations } from './types/Translations.js';
 
@@ -26,12 +26,12 @@ export { APIService, DOFunctionService };
 
 // Export TypeScript types where needed
 export type {
+  APIResponse,
   AuthCheckPasswordInput,
   AuthCheckPasswordOutput,
   AuthValidateUserInput,
   AuthValidateUserOutput,
   DashboardConfig,
-  DOFunctionCallOutput,
   DOFunctionRawInput,
   DOFunctionRawOutput,
   ProjectDashboardInput,

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

@@ -1,4 +1,4 @@
-import { DOFunctionCallOutput } from '../DOFunctionService/DOFunction.js';
+import { APIResponse } from '../../types/APIResponse.js';
 import { AuthValidateUserInput, AuthValidateUserOutput } from '../DOFunctionService/functions/authValidateUser.js';
 import { ProjectDashboardInput, ProjectDashboardOutput } from '../DOFunctionService/functions/projectDashboard.js';
 /**
@@ -13,11 +13,11 @@ export default class APIService {
      * @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>>;
+    static validateUser(input: AuthValidateUserInput): Promise<APIResponse<AuthValidateUserOutput>>;
     /**
      * Sets the URL for the dashboard API.
      *
-     * @param url - The URL to be set for the dashboard API.
+     * @param url - The URL to be set for the dashboard API. This should include a trailing slash.
      */
     static setDashboardAPIUrl(url: string): void;
     /**
@@ -27,6 +27,6 @@ export default class APIService {
      * @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<DOFunctionCallOutput<ProjectDashboardOutput>>;
+    static callDashboardAPI(input: ProjectDashboardInput): Promise<APIResponse<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":"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"}
+{"version":3,"file":"APIService.d.ts","sourceRoot":"","sources":["../../../src/services/APIService/APIService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,oDAAoD,CAAC;AAG5D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B;;;;;;OAMG;WACU,YAAY,CACvB,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAK/C;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM;IAIrC;;;;;;OAMG;WACU,gBAAgB,CAC3B,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;CAGhD"}

package/lib/services/APIService/APIService.js

@@ -1,4 +1,5 @@
 import DOFunctionService from '../DOFunctionService/DOFunctionService.js';
+import GCloudAPIService from '../GCloudAPIService/GCloudAPIService.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.
@@ -18,10 +19,10 @@ export default class APIService {
     /**
      * Sets the URL for the dashboard API.
      *
-     * @param url - The URL to be set for the dashboard API.
+     * @param url - The URL to be set for the dashboard API. This should include a trailing slash.
      */
     static setDashboardAPIUrl(url) {
-        DOFunctionService.projectDashboard.setUrl(url);
+        GCloudAPIService.setUrl(url);
     }
     /**
      * Calls the dashboard API and returns the result. This will fail if the
@@ -31,8 +32,7 @@ export default class APIService {
      * @returns A promise that resolves to the result of the dashboard API call.
      */
     static async callDashboardAPI(input) {
-        const result = await DOFunctionService.projectDashboard.call(input);
-        return result;
+        return GCloudAPIService.projectDashboard(input);
     }
 }
 //# sourceMappingURL=APIService.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"APIService.js","sourceRoot":"","sources":["../../../src/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"}
+{"version":3,"file":"APIService.js","sourceRoot":"","sources":["../../../src/services/APIService/APIService.ts"],"names":[],"mappings":"AACA,OAAO,iBAAiB,MAAM,2CAA2C,CAAC;AAS1E,OAAO,gBAAgB,MAAM,yCAAyC,CAAC;AAEvE;;;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,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAC3B,KAA4B;QAE5B,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAClD,CAAC;CACF"}

package/lib/services/APIService/APIService.ts

@@ -1,4 +1,4 @@
-import { DOFunctionCallOutput } from '../DOFunctionService/DOFunction.js';
+import { APIResponse } from '../../types/APIResponse.js';
 import DOFunctionService from '../DOFunctionService/DOFunctionService.js';
 import {
   AuthValidateUserInput,
@@ -8,6 +8,7 @@ import {
   ProjectDashboardInput,
   ProjectDashboardOutput
 } from '../DOFunctionService/functions/projectDashboard.js';
+import GCloudAPIService from '../GCloudAPIService/GCloudAPIService.js';
 
 /**
  * A service for making calls to the backend API for personal projects. This is
@@ -23,7 +24,7 @@ export default class APIService {
    */
   static async validateUser(
     input: AuthValidateUserInput
-  ): Promise<DOFunctionCallOutput<AuthValidateUserOutput>> {
+  ): Promise<APIResponse<AuthValidateUserOutput>> {
     const result = await DOFunctionService.authValidateUser.call(input);
     return result;
   }
@@ -31,10 +32,10 @@ export default class APIService {
   /**
    * Sets the URL for the dashboard API.
    *
-   * @param url - The URL to be set for the dashboard API.
+   * @param url - The URL to be set for the dashboard API. This should include a trailing slash.
    */
   static setDashboardAPIUrl(url: string) {
-    DOFunctionService.projectDashboard.setUrl(url);
+    GCloudAPIService.setUrl(url);
   }
 
   /**
@@ -46,8 +47,7 @@ export default class APIService {
    */
   static async callDashboardAPI(
     input: ProjectDashboardInput
-  ): Promise<DOFunctionCallOutput<ProjectDashboardOutput>> {
-    const result = await DOFunctionService.projectDashboard.call(input);
-    return result;
+  ): Promise<APIResponse<ProjectDashboardOutput>> {
+    return GCloudAPIService.projectDashboard(input);
   }
 }

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

@@ -1,3 +1,4 @@
+import { APIResponse } from '../../types/APIResponse.js';
 /**
  * The input to a Digital Ocean function must always be an object.
  */
@@ -61,14 +62,6 @@ export interface DOFunctionRawOutput {
         'Content-Type': string;
     };
 }
-/**
- * A generic interface representing the output of a Digital Ocean function call.
- */
-export interface DOFunctionCallOutput<TOutput extends DOFunctionOutput> {
-    success: boolean;
-    errors: string[];
-    data: TOutput;
-}
 /**
  * Type guard to check if an input object conforms to the DOFunctionRawInput structure.
  *
@@ -104,7 +97,7 @@ export default abstract class DOFunction<TInput extends DOFunctionInput, TOutput
      * @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>>;
+    call(input: TInput): Promise<APIResponse<TOutput>>;
     /**
      * Decodes the response from the Digital Ocean function.
      *

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,IAAI,EAAE;QACJ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE;YACP,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB,CAAC;QACF;;WAEG;QACH,eAAe,EAAE,OAAO,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE;QACP;;;;WAIG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB,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;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB,CAShF;AAED;;;;;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;IAgBjE;;;;;OAKG;YACW,cAAc;CAgB7B"}
+{"version":3,"file":"DOFunction.d.ts","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunction.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC;AAErC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE;QACJ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE;YACP,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB,CAAC;QACF;;WAEG;QACH,eAAe,EAAE,OAAO,CAAC;QACzB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE;QACP;;;;WAIG;QACH,cAAc,EAAE,MAAM,CAAC;KACxB,CAAC;CACH;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB,CAShF;AAED;;;;;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,WAAW,CAAC,OAAO,CAAC,CAAC;IAgBxD;;;;;OAKG;YACW,cAAc;CAgB7B"}

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

@@ -1 +1 @@
-{"version":3,"file":"DOFunction.js","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AA8E5B;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,OAAO,CACL,CAAC,CAAC,KAAK;QACP,OAAO,KAAK,KAAK,QAAQ;QACzB,MAAM,IAAI,KAAK;QACf,OAAQ,KAA4B,CAAC,IAAI,KAAK,QAAQ;QACtD,MAAM,IAAK,KAA4B,CAAC,IAAI,IAAI,sCAAsC;QACtF,iBAAiB,IAAK,KAA4B,CAAC,IAAI,CACxD,CAAC;AACJ,CAAC;AAED;;;;;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,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,UAAU,EAAE,YAAY;gBACxB,cAAc,EAAE,0BAA0B;gBAC1C,MAAM,EAAE,0BAA0B;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;SAC5B,CAAC,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,cAAc,CAAC,QAAkB;QAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,0BAA0B,CAAC;QACnF,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,CAAkC,CAAC;QACvE,CAAC;aAAM,CAAC;YACN,kDAAkD;YAClD,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAY,CAAC;YAClD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;gBACzC,IAAI,EAAE,EAAa;aACpB,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"DOFunction.js","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAsE5B;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,OAAO,CACL,CAAC,CAAC,KAAK;QACP,OAAO,KAAK,KAAK,QAAQ;QACzB,MAAM,IAAI,KAAK;QACf,OAAQ,KAA4B,CAAC,IAAI,KAAK,QAAQ;QACtD,MAAM,IAAK,KAA4B,CAAC,IAAI,IAAI,sCAAsC;QACtF,iBAAiB,IAAK,KAA4B,CAAC,IAAI,CACxD,CAAC;AACJ,CAAC;AAED;;;;;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,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE;YACrC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,UAAU,EAAE,YAAY;gBACxB,cAAc,EAAE,0BAA0B;gBAC1C,MAAM,EAAE,0BAA0B;aACnC;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;SAC5B,CAAC,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,cAAc,CAAC,QAAkB;QAC7C,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,0BAA0B,CAAC;QACnF,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;YAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,CAAyB,CAAC;QAC9D,CAAC;aAAM,CAAC;YACN,kDAAkD;YAClD,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAY,CAAC;YAClD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;gBACzC,IAAI,EAAE,EAAa;aACpB,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}

package/lib/services/DOFunctionService/DOFunction.ts

@@ -1,4 +1,5 @@
 import { BSON } from 'bson';
+import { APIResponse } from '../../types/APIResponse.js';
 
 /**
  * The input to a Digital Ocean function must always be an object.
@@ -67,15 +68,6 @@ export interface DOFunctionRawOutput {
   };
 }
 
-/**
- * A generic interface representing the output of a Digital Ocean function call.
- */
-export interface DOFunctionCallOutput<TOutput extends DOFunctionOutput> {
-  success: boolean;
-  errors: string[];
-  data: TOutput;
-}
-
 /**
  * Type guard to check if an input object conforms to the DOFunctionRawInput structure.
  *
@@ -132,7 +124,7 @@ export default abstract class DOFunction<
    * @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>> {
+  async call(input: TInput): Promise<APIResponse<TOutput>> {
     if (!this.url) {
       throw new Error(`${this.functionName} URL is not set`);
     }
@@ -154,12 +146,12 @@ export default abstract class DOFunction<
    * @param response - The response to decode.
    * @returns The decoded output.
    */
-  private async decodeResponse(response: Response): Promise<DOFunctionCallOutput<TOutput>> {
+  private async decodeResponse(response: Response): Promise<APIResponse<TOutput>> {
     const isBson = response.headers.get('Content-Type') === 'application/octet-stream';
     if (isBson) {
       const buffer = await response.arrayBuffer();
       const uint8Array = new Uint8Array(buffer);
-      return BSON.deserialize(uint8Array) as DOFunctionCallOutput<TOutput>;
+      return BSON.deserialize(uint8Array) as APIResponse<TOutput>;
     } else {
       // This normally only happens if there is an error
       const result = (await response.json()) as unknown;

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

@@ -1,4 +1,5 @@
-import { DOFunctionCallOutput, DOFunctionInput, DOFunctionOutput, DOFunctionRawInput, DOFunctionRawOutput } from './DOFunction.js';
+import { APIResponse } from '../../types/APIResponse.js';
+import { 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';
@@ -32,7 +33,7 @@ export default class DOFunctionService {
      * @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>(functionName: string, rawInputFromDO: DOFunctionRawInput | TInput, handler: (input: TInput) => Promise<DOFunctionCallOutput<TOutput>>): Promise<DOFunctionRawOutput>;
+    static handleApiRequest<TInput extends DOFunctionInput, TOutput extends DOFunctionOutput>(functionName: string, rawInputFromDO: DOFunctionRawInput | TInput, handler: (input: TInput) => Promise<APIResponse<TOutput>>): Promise<DOFunctionRawOutput>;
     /**
      * Deserializes the raw input into a typed input object using type guards.
      * Handles raw HTTP input, the DO UI wrapper, or already deserialized input.

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

@@ -1 +1 @@
-{"version":3,"file":"DOFunctionService.d.ts","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AACjE,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAC/D,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC;;OAEG;IACH,MAAM,CAAC,iBAAiB,EAAE,iBAAiB,CAAmC;IAE9E;;OAEG;IACH,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAAkC;IAE3E;;OAEG;IACH,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAAkC;IAE3E;;;;;;;;;;;;;OAaG;WACU,gBAAgB,CAAC,MAAM,SAAS,eAAe,EAAE,OAAO,SAAS,gBAAgB,EAC5F,YAAY,EAAE,MAAM,EACpB,cAAc,EAAE,kBAAkB,GAAG,MAAM,EAC3C,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,GACjE,OAAO,CAAC,mBAAmB,CAAC;IA2D/B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IA4D/B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;CAM/B"}
+{"version":3,"file":"DOFunctionService.d.ts","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EAEpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AACjE,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAC/D,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC;;OAEG;IACH,MAAM,CAAC,iBAAiB,EAAE,iBAAiB,CAAmC;IAE9E;;OAEG;IACH,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAAkC;IAE3E;;OAEG;IACH,MAAM,CAAC,gBAAgB,EAAE,gBAAgB,CAAkC;IAE3E;;;;;;;;;;;;;OAaG;WACU,gBAAgB,CAAC,MAAM,SAAS,eAAe,EAAE,OAAO,SAAS,gBAAgB,EAC5F,YAAY,EAAE,MAAM,EACpB,cAAc,EAAE,kBAAkB,GAAG,MAAM,EAC3C,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GACxD,OAAO,CAAC,mBAAmB,CAAC;IA2D/B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IA4D/B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;CAM/B"}

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

@@ -1 +1 @@
-{"version":3,"file":"DOFunctionService.js","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,uBAAuB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAML,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AACjE,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAC/D,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC;;OAEG;IACH,MAAM,CAAC,iBAAiB,GAAsB,iBAAiB,CAAC,WAAW,EAAE,CAAC;IAE9E;;OAEG;IACH,MAAM,CAAC,gBAAgB,GAAqB,gBAAgB,CAAC,WAAW,EAAE,CAAC;IAE3E;;OAEG;IACH,MAAM,CAAC,gBAAgB,GAAqB,gBAAgB,CAAC,WAAW,EAAE,CAAC;IAE3E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAC3B,YAAoB,EACpB,cAA2C,EAC3C,OAAkE;QAElE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,oDAAoD,YAAY,IAAI,CAAC,CAAC,CAAC,YAAY;QAClG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,wDAAwD,YAAY,MAAM,CAAC,CAAC,CAAC,uBAAuB;QACnH,OAAO,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACtD,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,yDAAyD,YAAY,IAAI,CAAC,CAAC,CAAC,0BAA0B;YACrH,MAAM,SAAS,GAAwB;gBACrC,IAAI,EAAE,EAAE;gBACR,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE;oBACP,cAAc,EAAE,0BAA0B;iBAC3C;aACF,CAAC;YACF,MAAM,aAAa,GAAkC;gBACnD,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,EAAa;aACpB,CAAC;YAEF,IAAI,CAAC;gBACH,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,gDAAgD,YAAY,MAAM,CAAC,CAAC,CAAC,yBAAyB;gBAC7G,MAAM,KAAK,GAAW,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;gBAC5D,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,qDAAqD,YAAY,MAAM,CAAC,CAAC,CAAC,qBAAqB;gBAC9G,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;gBACpC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,sDAAsD,YAAY,IAAI,CAAC,CAAC,CAAC,oBAAoB;gBAC5G,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,+CAA+C,YAAY,MAAM,CAAC,CAAC,CAAC,uBAAuB;gBAC1G,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;gBAE9C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpB,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,qDAAqD,YAAY,6BAA6B,CAC/F,CAAC,CAAC,sBAAsB;oBACzB,SAAS,CAAC,UAAU,GAAG,GAAG,CAAC;oBAC3B,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;gBACzD,CAAC;qBAAM,CAAC;oBACN,EAAE,CAAC,MAAM,CAAC,OAAO,CACf,qDAAqD,YAAY,6BAA6B,CAC/F,CAAC,CAAC,sBAAsB;oBACzB,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,EAAE,CAAC,MAAM,CAAC,KAAK,CACb,6DAA6D,YAAY,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,CAC3F,CAAC,CAAC,YAAY;gBACf,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC,CAAC;gBAExD,MAAM,KAAK,GAAG,CAAU,CAAC;gBACzB,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC1D,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;gBAC/C,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;gBACvD,SAAS,CAAC,UAAU,GAAG,GAAG,CAAC;YAC7B,CAAC;YACD,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,0DAA0D,YAAY,yBAAyB,CAChG,CAAC,CAAC,wBAAwB;YAC3B,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,gBAAgB,CAC7B,WAAwC;QAExC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,kDAAkD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEhG,mEAAmE;QACnE,IAAI,oBAAoB,CAAC,WAAW,CAAC,EAAE,CAAC;YACtC,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,6GAA6G,CAC9G,CAAC;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;YAC7B,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAEhD,IAAI,WAAmB,CAAC;YACxB,IAAI,eAAe,EAAE,CAAC;gBACpB,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;gBAC1E,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;gBAC9E,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC;YAED,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,KAAK,0BAA0B,CAAC;YACtE,IAAI,WAAmB,CAAC;YAExB,IAAI,MAAM,EAAE,CAAC;gBACX,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;gBAC/D,IAAI,CAAC;oBACH,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAW,CAAC;gBACxD,CAAC;gBAAC,OAAO,SAAS,EAAE,CAAC;oBACnB,EAAE,CAAC,MAAM,CAAC,KAAK,CACb,oDAAoD,MAAM,CAAC,SAAS,CAAC,+BAA+B,CACrG,CAAC;oBACF,IAAI,CAAC;wBACH,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAW,CAAC;oBACnE,CAAC;oBAAC,OAAO,SAAS,EAAE,CAAC;wBACnB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,mDAAmD,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;wBACxF,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;oBACvE,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;gBACnF,IAAI,CAAC;oBACH,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAW,CAAC;gBACnE,CAAC;gBAAC,OAAO,SAAS,EAAE,CAAC;oBACnB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,0CAA0C,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;oBAC/E,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,iDAAiD;aAC5C,CAAC;YACJ,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,mGAAmG,CACpG,CAAC;YACF,OAAO,WAAW,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,eAAe,CAC5B,MAAqC;QAErC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC"}
+{"version":3,"file":"DOFunctionService.js","sourceRoot":"","sources":["../../../src/services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,MAAM,uBAAuB,CAAC;AAC3C,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,OAAO,EAKL,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,iBAAiB,MAAM,kCAAkC,CAAC;AACjE,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAC/D,OAAO,gBAAgB,MAAM,iCAAiC,CAAC;AAE/D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC;;OAEG;IACH,MAAM,CAAC,iBAAiB,GAAsB,iBAAiB,CAAC,WAAW,EAAE,CAAC;IAE9E;;OAEG;IACH,MAAM,CAAC,gBAAgB,GAAqB,gBAAgB,CAAC,WAAW,EAAE,CAAC;IAE3E;;OAEG;IACH,MAAM,CAAC,gBAAgB,GAAqB,gBAAgB,CAAC,WAAW,EAAE,CAAC;IAE3E;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAC3B,YAAoB,EACpB,cAA2C,EAC3C,OAAyD;QAEzD,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,oDAAoD,YAAY,IAAI,CAAC,CAAC,CAAC,YAAY;QAClG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,wDAAwD,YAAY,MAAM,CAAC,CAAC,CAAC,uBAAuB;QACnH,OAAO,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YACtD,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,yDAAyD,YAAY,IAAI,CAAC,CAAC,CAAC,0BAA0B;YACrH,MAAM,SAAS,GAAwB;gBACrC,IAAI,EAAE,EAAE;gBACR,UAAU,EAAE,GAAG;gBACf,OAAO,EAAE;oBACP,cAAc,EAAE,0BAA0B;iBAC3C;aACF,CAAC;YACF,MAAM,aAAa,GAAyB;gBAC1C,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,EAAE;gBACV,IAAI,EAAE,EAAa;aACpB,CAAC;YAEF,IAAI,CAAC;gBACH,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,gDAAgD,YAAY,MAAM,CAAC,CAAC,CAAC,yBAAyB;gBAC7G,MAAM,KAAK,GAAW,IAAI,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;gBAC5D,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,qDAAqD,YAAY,MAAM,CAAC,CAAC,CAAC,qBAAqB;gBAC9G,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;gBACpC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,sDAAsD,YAAY,IAAI,CAAC,CAAC,CAAC,oBAAoB;gBAC5G,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,+CAA+C,YAAY,MAAM,CAAC,CAAC,CAAC,uBAAuB;gBAC1G,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;gBAE9C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpB,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,qDAAqD,YAAY,6BAA6B,CAC/F,CAAC,CAAC,sBAAsB;oBACzB,SAAS,CAAC,UAAU,GAAG,GAAG,CAAC;oBAC3B,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;gBACzD,CAAC;qBAAM,CAAC;oBACN,EAAE,CAAC,MAAM,CAAC,OAAO,CACf,qDAAqD,YAAY,6BAA6B,CAC/F,CAAC,CAAC,sBAAsB;oBACzB,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,EAAE,CAAC,MAAM,CAAC,KAAK,CACb,6DAA6D,YAAY,MAAM,MAAM,CAAC,CAAC,CAAC,EAAE,CAC3F,CAAC,CAAC,YAAY;gBACf,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC,CAAC;gBAExD,MAAM,KAAK,GAAG,CAAU,CAAC;gBACzB,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC1D,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;gBAC/C,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;gBACvD,SAAS,CAAC,UAAU,GAAG,GAAG,CAAC;YAC7B,CAAC;YACD,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,0DAA0D,YAAY,yBAAyB,CAChG,CAAC,CAAC,wBAAwB;YAC3B,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,gBAAgB,CAC7B,WAAwC;QAExC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,kDAAkD,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QAEhG,mEAAmE;QACnE,IAAI,oBAAoB,CAAC,WAAW,CAAC,EAAE,CAAC;YACtC,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,6GAA6G,CAC9G,CAAC;YACF,MAAM,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;YAC7B,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;YAEhD,IAAI,WAAmB,CAAC;YACxB,IAAI,eAAe,EAAE,CAAC;gBACpB,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;gBAC1E,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,6DAA6D,CAAC,CAAC;gBAC9E,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC1C,CAAC;YAED,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,KAAK,0BAA0B,CAAC;YACtE,IAAI,WAAmB,CAAC;YAExB,IAAI,MAAM,EAAE,CAAC;gBACX,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;gBAC/D,IAAI,CAAC;oBACH,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAW,CAAC;gBACxD,CAAC;gBAAC,OAAO,SAAS,EAAE,CAAC;oBACnB,EAAE,CAAC,MAAM,CAAC,KAAK,CACb,oDAAoD,MAAM,CAAC,SAAS,CAAC,+BAA+B,CACrG,CAAC;oBACF,IAAI,CAAC;wBACH,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAW,CAAC;oBACnE,CAAC;oBAAC,OAAO,SAAS,EAAE,CAAC;wBACnB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,mDAAmD,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;wBACxF,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;oBACvE,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;gBACnF,IAAI,CAAC;oBACH,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAW,CAAC;gBACnE,CAAC;gBAAC,OAAO,SAAS,EAAE,CAAC;oBACnB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,0CAA0C,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;oBAC/E,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;YACD,OAAO,WAAW,CAAC;QACrB,CAAC;QACD,iDAAiD;aAC5C,CAAC;YACJ,EAAE,CAAC,MAAM,CAAC,IAAI,CACZ,mGAAmG,CACpG,CAAC;YACF,OAAO,WAAW,CAAC;QACrB,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,eAAe,CAC5B,MAA4B;QAE5B,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC"}

package/lib/services/DOFunctionService/DOFunctionService.ts

@@ -1,7 +1,7 @@
 import { DR } from '@aneuhold/core-ts-lib';
 import { BSON } from 'bson';
+import { APIResponse } from '../../types/APIResponse.js';
 import {
-  DOFunctionCallOutput,
   DOFunctionInput,
   DOFunctionOutput,
   DOFunctionRawInput,
@@ -48,7 +48,7 @@ export default class DOFunctionService {
   static async handleApiRequest<TInput extends DOFunctionInput, TOutput extends DOFunctionOutput>(
     functionName: string,
     rawInputFromDO: DOFunctionRawInput | TInput,
-    handler: (input: TInput) => Promise<DOFunctionCallOutput<TOutput>>
+    handler: (input: TInput) => Promise<APIResponse<TOutput>>
   ): Promise<DOFunctionRawOutput> {
     DR.logger.info(`[DOFunctionService] handleApiRequest called for "${functionName}".`); // Log entry
     DR.logger.info(`[DOFunctionService] Calling DR.tracer.startSpan for "${functionName}"...`); // Log before startSpan
@@ -61,7 +61,7 @@ export default class DOFunctionService {
           'Content-Type': 'application/octet-stream'
         }
       };
-      const defaultOutput: DOFunctionCallOutput<TOutput> = {
+      const defaultOutput: APIResponse<TOutput> = {
         success: false,
         errors: [],
         data: {} as TOutput
@@ -183,7 +183,7 @@ export default class DOFunctionService {
    * @returns The serialized output as a base64 string.
    */
   private static serializeOutput<TOutput extends DOFunctionOutput>(
-    output: DOFunctionCallOutput<TOutput>
+    output: APIResponse<TOutput>
   ): string {
     const bsonBuffer = BSON.serialize(output);
     return Buffer.from(bsonBuffer).toString('base64');

package/lib/services/GCloudAPIService/GCloudAPIService.d.ts

@@ -0,0 +1,30 @@
+import { APIResponse } from '../../types/APIResponse.js';
+import { ProjectDashboardInput, ProjectDashboardOutput } from '../DOFunctionService/functions/projectDashboard.js';
+/**
+ * A service for interacting with the Google Cloud API service for personal projects.
+ */
+export default class GCloudAPIService {
+    #private;
+    /**
+     * Sets the URL of the Google Cloud API.
+     *
+     * @param url - The URL to set.
+     */
+    static setUrl(url: string): void;
+    /**
+     * Calls the project dashboard endpoint to get, insert, update, or delete dashboard data.
+     *
+     * @param input - The input for the project dashboard function.
+     */
+    static projectDashboard(input: ProjectDashboardInput): Promise<APIResponse<ProjectDashboardOutput>>;
+    /**
+     * Makes a call to the Google Cloud API.
+     *
+     * @param urlPath - The path to the endpoint.
+     * @param input - The input to the endpoint.
+     * @returns A promise that resolves to the output of the function call, wrapped in {@link APIResponse}.
+     * @throws Will throw an error if the URL is not set.
+     */
+    private static call;
+}
+//# sourceMappingURL=GCloudAPIService.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"GCloudAPIService.d.ts","sourceRoot":"","sources":["../../../src/services/GCloudAPIService/GCloudAPIService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,oDAAoD,CAAC;AAE5D;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;;IAOnC;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIhC;;;;OAIG;WACU,gBAAgB,CAC3B,KAAK,EAAE,qBAAqB,GAC3B,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAI/C;;;;;;;OAOG;mBACkB,IAAI;CAoC1B"}

package/lib/services/GCloudAPIService/GCloudAPIService.js

@@ -0,0 +1,66 @@
+/**
+ * A service for interacting with the Google Cloud API service for personal projects.
+ */
+export default class GCloudAPIService {
+    /**
+     * The base URL of the Google Cloud API. For example, `something.com/api/`. It will include
+     * the trailing slash.
+     */
+    static #baseUrl;
+    /**
+     * Sets the URL of the Google Cloud API.
+     *
+     * @param url - The URL to set.
+     */
+    static setUrl(url) {
+        this.#baseUrl = url;
+    }
+    /**
+     * Calls the project dashboard endpoint to get, insert, update, or delete dashboard data.
+     *
+     * @param input - The input for the project dashboard function.
+     */
+    static async projectDashboard(input) {
+        return this.call('project/dashboard', input);
+    }
+    /**
+     * Makes a call to the Google Cloud API.
+     *
+     * @param urlPath - The path to the endpoint.
+     * @param input - The input to the endpoint.
+     * @returns A promise that resolves to the output of the function call, wrapped in {@link APIResponse}.
+     * @throws Will throw an error if the URL is not set.
+     */
+    static async call(urlPath, input) {
+        if (!this.#baseUrl) {
+            throw new Error('GCloudAPI URL is not set');
+        }
+        const response = await fetch(this.#baseUrl + urlPath, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                Accept: 'application/json'
+            },
+            body: JSON.stringify(input)
+        });
+        if (!response.ok) {
+            return {
+                success: false,
+                errors: [`HTTP ${response.status}: ${response.statusText}`],
+                data: {}
+            };
+        }
+        try {
+            const result = (await response.json());
+            return result;
+        }
+        catch (error) {
+            return {
+                success: false,
+                errors: [`Failed to parse response: ${String(error)}`],
+                data: {}
+            };
+        }
+    }
+}
+//# sourceMappingURL=GCloudAPIService.js.map

package/lib/services/GCloudAPIService/GCloudAPIService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GCloudAPIService.js","sourceRoot":"","sources":["../../../src/services/GCloudAPIService/GCloudAPIService.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC;;;OAGG;IACH,MAAM,CAAC,QAAQ,CAAU;IAEzB;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,GAAW;QACvB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAC3B,KAA4B;QAE5B,OAAO,IAAI,CAAC,IAAI,CAAgD,mBAAmB,EAAE,KAAK,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;OAOG;IACK,MAAM,CAAC,KAAK,CAAC,IAAI,CACvB,OAAe,EACf,KAAa;QAEb,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAG,OAAO,EAAE;YACpD,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;aAC3B;YACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;SAC5B,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,CAAC,QAAQ,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC;gBAC3D,IAAI,EAAE,EAAa;aACpB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAyB,CAAC;YAC/D,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,CAAC,6BAA6B,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBACtD,IAAI,EAAE,EAAa;aACpB,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}

package/lib/services/GCloudAPIService/GCloudAPIService.ts

@@ -0,0 +1,81 @@
+import { APIResponse } from '../../types/APIResponse.js';
+import {
+  ProjectDashboardInput,
+  ProjectDashboardOutput
+} from '../DOFunctionService/functions/projectDashboard.js';
+
+/**
+ * A service for interacting with the Google Cloud API service for personal projects.
+ */
+export default class GCloudAPIService {
+  /**
+   * The base URL of the Google Cloud API. For example, `something.com/api/`. It will include
+   * the trailing slash.
+   */
+  static #baseUrl?: string;
+
+  /**
+   * Sets the URL of the Google Cloud API.
+   *
+   * @param url - The URL to set.
+   */
+  static setUrl(url: string): void {
+    this.#baseUrl = url;
+  }
+
+  /**
+   * Calls the project dashboard endpoint to get, insert, update, or delete dashboard data.
+   *
+   * @param input - The input for the project dashboard function.
+   */
+  static async projectDashboard(
+    input: ProjectDashboardInput
+  ): Promise<APIResponse<ProjectDashboardOutput>> {
+    return this.call<ProjectDashboardInput, ProjectDashboardOutput>('project/dashboard', input);
+  }
+
+  /**
+   * Makes a call to the Google Cloud API.
+   *
+   * @param urlPath - The path to the endpoint.
+   * @param input - The input to the endpoint.
+   * @returns A promise that resolves to the output of the function call, wrapped in {@link APIResponse}.
+   * @throws Will throw an error if the URL is not set.
+   */
+  private static async call<TInput, TOutput>(
+    urlPath: string,
+    input: TInput
+  ): Promise<APIResponse<TOutput>> {
+    if (!this.#baseUrl) {
+      throw new Error('GCloudAPI URL is not set');
+    }
+
+    const response = await fetch(this.#baseUrl + urlPath, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json'
+      },
+      body: JSON.stringify(input)
+    });
+
+    if (!response.ok) {
+      return {
+        success: false,
+        errors: [`HTTP ${response.status}: ${response.statusText}`],
+        data: {} as TOutput
+      };
+    }
+
+    try {
+      const result = (await response.json()) as APIResponse<TOutput>;
+      return result;
+    } catch (error) {
+      return {
+        success: false,
+        errors: [`Failed to parse response: ${String(error)}`],
+        data: {} as TOutput
+      };
+    }
+  }
+}

package/lib/types/APIResponse.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Generic for API responses for personal APIs.
+ */
+export type APIResponse<T> = {
+    success: boolean;
+    errors: string[];
+    data: T;
+};
+//# sourceMappingURL=APIResponse.d.ts.map

package/lib/types/APIResponse.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"APIResponse.d.ts","sourceRoot":"","sources":["../../src/types/APIResponse.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,EAAE,CAAC,CAAC;CACT,CAAC"}

package/lib/types/APIResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=APIResponse.js.map

package/lib/types/APIResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"APIResponse.js","sourceRoot":"","sources":["../../src/types/APIResponse.ts"],"names":[],"mappings":""}

package/lib/types/APIResponse.ts

@@ -0,0 +1,8 @@
+/**
+ * Generic for API responses for personal APIs.
+ */
+export type APIResponse<T> = {
+  success: boolean;
+  errors: string[];
+  data: T;
+};

package/lib/types/DashboardConfig.d.ts

@@ -4,6 +4,10 @@
  */
 export type DashboardConfig = {
     projectDashboardFunctionUrl: string;
+    /**
+     * The URL for the GCloud backend API. This should contain the trailing slash.
+     */
+    gcloudBackendUrl: string;
     automationUrls: {
         sunLight: string;
         zoomLighting: string;

package/lib/types/DashboardConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DashboardConfig.d.ts","sourceRoot":"","sources":["../../src/types/DashboardConfig.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,2BAA2B,EAAE,MAAM,CAAC;IACpC,cAAc,EAAE;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,4BAA4B,EAAE,MAAM,CAAC;QACrC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC"}
+{"version":3,"file":"DashboardConfig.d.ts","sourceRoot":"","sources":["../../src/types/DashboardConfig.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,2BAA2B,EAAE,MAAM,CAAC;IACpC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,EAAE,MAAM,CAAC;QACrB,4BAA4B,EAAE,MAAM,CAAC;QACrC,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH,CAAC"}

package/lib/types/DashboardConfig.ts

@@ -4,6 +4,10 @@
  */
 export type DashboardConfig = {
   projectDashboardFunctionUrl: string;
+  /**
+   * The URL for the GCloud backend API. This should contain the trailing slash.
+   */
+  gcloudBackendUrl: string;
   automationUrls: {
     sunLight: string;
     zoomLighting: string;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@aneuhold/core-ts-api-lib",
   "author": "Anton G. Neuhold Jr.",
   "license": "MIT",
-  "version": "2.1.24",
+  "version": "2.2.0",
   "description": "A library for interacting with the backend and defining the backend API for personal projects.",
   "packageManager": "pnpm@10.12.1",
   "type": "module",
@@ -55,7 +55,7 @@
   },
   "devDependencies": {
     "@aneuhold/local-npm-registry": "*",
-    "@aneuhold/main-scripts": "^2.5.0",
+    "@aneuhold/main-scripts": "^2.5.2",
     "@types/node": "^22.15.32",
     "eslint": "^9.29.0",
     "jsr": "^0.13.4",