@aneuhold/core-ts-api-lib 2.2.3 → 2.2.4

package/CHANGELOG.md

@@ -5,6 +5,15 @@ 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.4] (2025-11-04)
+
+### 🏗️ Changed
+
+- Switched `GCloudAPIService` to use BSON serialization for requests and responses
+- Updated request and response `Content-Type` headers to `application/octet-stream`
+- Added private `decodeResponse` helper for decoding API responses
+- Improved error handling for non-BSON responses in `GCloudAPIService`
+
 ## 🔖 [2.2.3] (2025-10-25)
 
 ### 🏗️ Changed
@@ -75,6 +84,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 <!-- Link References -->
 
+[2.2.4]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.3...core-ts-api-lib-v2.2.4
 [2.2.3]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.2...core-ts-api-lib-v2.2.3
 [2.2.2]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.1...core-ts-api-lib-v2.2.2
 [2.2.1]: https://github.com/aneuhold/ts-libs/compare/core-ts-api-lib-v2.2.0...core-ts-api-lib-v2.2.1

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

@@ -22,9 +22,15 @@ export default class GCloudAPIService {
      *
      * @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.
+     * @throws {Error} Will throw an error if the URL is not set.
      */
     private static call;
+    /**
+     * Decodes the response from the Google Cloud API.
+     *
+     * @param response - The response to decode.
+     * @returns The decoded output.
+     */
+    private static decodeResponse;
 }
 //# sourceMappingURL=GCloudAPIService.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"GCloudAPIService.d.ts","sourceRoot":"","sources":["../../../src/services/GCloudAPIService/GCloudAPIService.ts"],"names":[],"mappings":"AACA,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;;;;;;OAMG;mBACkB,IAAI;IAqBzB;;;;;OAKG;mBACkB,cAAc;CAiBpC"}

package/lib/services/GCloudAPIService/GCloudAPIService.js

@@ -1,3 +1,4 @@
+import { BSON } from 'bson';
 /**
  * A service for interacting with the Google Cloud API service for personal projects.
  */
@@ -28,8 +29,7 @@ export default class GCloudAPIService {
      *
      * @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.
+     * @throws {Error} Will throw an error if the URL is not set.
      */
     static async call(urlPath, input) {
         if (!this.#baseUrl) {
@@ -38,26 +38,35 @@ export default class GCloudAPIService {
         const response = await fetch(this.#baseUrl + urlPath, {
             method: 'POST',
             headers: {
-                'Content-Type': 'application/json',
-                Accept: 'application/json'
+                Connection: 'keep-alive',
+                'Content-Type': 'application/octet-stream',
+                Accept: 'application/octet-stream'
             },
-            body: JSON.stringify(input)
+            body: Buffer.from(BSON.serialize(input))
         });
-        if (!response.ok) {
-            return {
-                success: false,
-                errors: [`HTTP ${response.status}: ${response.statusText}`],
-                data: {}
-            };
+        const decodedResponse = await this.decodeResponse(response);
+        return decodedResponse;
+    }
+    /**
+     * Decodes the response from the Google Cloud API.
+     *
+     * @param response - The response to decode.
+     * @returns The decoded output.
+     */
+    static async decodeResponse(response) {
+        const contentType = response.headers.get('Content-Type');
+        const isBson = contentType?.includes('application/octet-stream');
+        if (isBson) {
+            const buffer = await response.arrayBuffer();
+            const uint8Array = new Uint8Array(buffer);
+            return BSON.deserialize(uint8Array);
         }
-        try {
+        else {
+            // This normally only happens if there is an error
             const result = (await response.json());
-            return result;
-        }
-        catch (error) {
             return {
                 success: false,
-                errors: [`Failed to parse response: ${String(error)}`],
+                errors: [JSON.stringify(result, null, 2)],
                 data: {}
             };
         }

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

@@ -1 +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"}
+{"version":3,"file":"GCloudAPIService.js","sourceRoot":"","sources":["../../../src/services/GCloudAPIService/GCloudAPIService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAO5B;;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;;;;;;OAMG;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,UAAU,EAAE,YAAY;gBACxB,cAAc,EAAE,0BAA0B;gBAC1C,MAAM,EAAE,0BAA0B;aACnC;YACD,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SACzC,CAAC,CAAC;QACH,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,cAAc,CAAU,QAAQ,CAAC,CAAC;QACrE,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,KAAK,CAAC,cAAc,CAAU,QAAkB;QAC7D,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACzD,MAAM,MAAM,GAAG,WAAW,EAAE,QAAQ,CAAC,0BAA0B,CAAC,CAAC;QACjE,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/GCloudAPIService/GCloudAPIService.ts

@@ -1,3 +1,4 @@
+import { BSON } from 'bson';
 import { APIResponse } from '../../types/APIResponse.js';
 import {
   ProjectDashboardInput,
@@ -39,10 +40,9 @@ export default class GCloudAPIService {
    *
    * @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.
+   * @throws {Error} Will throw an error if the URL is not set.
    */
-  private static async call<TInput, TOutput>(
+  private static async call<TInput extends object, TOutput>(
     urlPath: string,
     input: TInput
   ): Promise<APIResponse<TOutput>> {
@@ -53,27 +53,35 @@ export default class GCloudAPIService {
     const response = await fetch(this.#baseUrl + urlPath, {
       method: 'POST',
       headers: {
-        'Content-Type': 'application/json',
-        Accept: 'application/json'
+        Connection: 'keep-alive',
+        'Content-Type': 'application/octet-stream',
+        Accept: 'application/octet-stream'
       },
-      body: JSON.stringify(input)
+      body: Buffer.from(BSON.serialize(input))
     });
+    const decodedResponse = await this.decodeResponse<TOutput>(response);
+    return decodedResponse;
+  }
 
-    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) {
+  /**
+   * Decodes the response from the Google Cloud API.
+   *
+   * @param response - The response to decode.
+   * @returns The decoded output.
+   */
+  private static async decodeResponse<TOutput>(response: Response): Promise<APIResponse<TOutput>> {
+    const contentType = response.headers.get('Content-Type');
+    const isBson = contentType?.includes('application/octet-stream');
+    if (isBson) {
+      const buffer = await response.arrayBuffer();
+      const uint8Array = new Uint8Array(buffer);
+      return BSON.deserialize(uint8Array) as APIResponse<TOutput>;
+    } else {
+      // This normally only happens if there is an error
+      const result = (await response.json()) as unknown;
       return {
         success: false,
-        errors: [`Failed to parse response: ${String(error)}`],
+        errors: [JSON.stringify(result, null, 2)],
         data: {} as TOutput
       };
     }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@aneuhold/core-ts-api-lib",
   "author": "Anton G. Neuhold Jr.",
   "license": "MIT",
-  "version": "2.2.3",
+  "version": "2.2.4",
   "description": "A library for interacting with the backend and defining the backend API for personal projects.",
   "packageManager": "pnpm@10.12.1",
   "type": "module",