@aneuhold/core-ts-api-lib 2.0.3 → 2.0.5

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

@@ -9,20 +9,35 @@ export type DOFunctionInput = object;
  */
 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.
+ * Raw input to a Digital Ocean function. This is with the expectation that
+ * `web: raw` is set in the `project.yml` file.
  */
 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.
+         * The body to be parsed or deserialized.
          */
         body: string;
+        headers: {
+            accept?: string;
+            'accept-encoding'?: string;
+            /**
+             * This is important.
+             */
+            'content-type'?: string;
+            host?: string;
+            'user-agent'?: string;
+            'x-forwarded-for'?: string;
+            'x-forwarded-proto'?: string;
+            'x-request-id'?: string;
+        };
+        /**
+         * This needs to be used to determine if the body is base64 encoded.
+         */
+        isBase64Encoded: boolean;
+        method?: string;
+        path?: string;
+        queryString?: string;
     };
 }
 /**
@@ -36,8 +51,14 @@ export interface DOFunctionRawOutput {
      * The body is a base64 encoded string.
      */
     body: string;
+    statusCode: number;
     headers: {
-        'Content-Type': 'application/octet-stream';
+        /**
+         * This is different than what gets passed in. This is on purpose. DO
+         * functions changes the header name when being passed in, but not when
+         * being passed out.
+         */
+        'Content-Type': string;
     };
 }
 /**
@@ -48,10 +69,6 @@ export interface DOFunctionCallOutput<TOutput extends DOFunctionOutput> {
     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.
  *
@@ -82,11 +99,11 @@ export default abstract class DOFunction<TInput extends DOFunctionInput, TOutput
      */
     call(input: TInput): Promise<DOFunctionCallOutput<TOutput>>;
     /**
-     * Decodes an {@link ArrayBuffer} into a {@link DOFunctionCallOutput}.
+     * Decodes the response from the Digital Ocean function.
      *
-     * @param buffer - The buffer to decode.
+     * @param response - The response to decode.
      * @returns The decoded output.
      */
-    private decodeArrayBuffer;
+    private decodeResponse;
 }
 //# sourceMappingURL=DOFunction.d.ts.map

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

@@ -1 +1 @@
-{"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;IAgBjE;;;;;OAKG;IACH,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,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,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;CAO7B"}

package/lib/services/DOFunctionService/DOFunction.js

@@ -1,8 +1,4 @@
 import { BSON } from 'bson';
-/**
- * An abstract class that can be extended to define a Digital Ocean
- * function.
- */
 /**
  * An abstract class representing a Digital Ocean Function.
  *
@@ -39,26 +35,27 @@ export default class DOFunction {
         if (!this.url) {
             throw new Error(`${this.functionName} URL is not set`);
         }
-        const result = await fetch(this.url, {
+        const body = Buffer.from(BSON.serialize(input)).toString('base64');
+        const response = await fetch(this.url, {
             method: 'POST',
             headers: {
+                Connection: 'keep-alive',
                 '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: BSON.serialize(input)
+            body: body
         });
-        return this.decodeArrayBuffer(await result.arrayBuffer());
+        return await this.decodeResponse(response);
     }
     /**
-     * Decodes an {@link ArrayBuffer} into a {@link DOFunctionCallOutput}.
+     * Decodes the response from the Digital Ocean function.
      *
-     * @param buffer - The buffer to decode.
+     * @param response - The response to decode.
      * @returns The decoded output.
      */
-    decodeArrayBuffer(buffer) {
-        const bytes = new Uint8Array(buffer);
-        return BSON.deserialize(bytes);
+    async decodeResponse(response) {
+        const bodyText = await response.text();
+        const buffer = Buffer.from(bodyText, 'base64');
+        return BSON.deserialize(buffer);
     }
 }
 //# sourceMappingURL=DOFunction.js.map

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

@@ -1 +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,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,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;SAC5B,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,IAAI,CAAC,WAAW,CAAC,KAAK,CAAkC,CAAC;IAClE,CAAC;CACF"}
+{"version":3,"file":"DOFunction.js","sourceRoot":"./src/","sources":["services/DOFunctionService/DOFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AA8E5B;;;;;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,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACnE,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;aAC3C;YACD,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;QACH,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,cAAc,CAC1B,QAAkB;QAElB,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAkC,CAAC;IACnE,CAAC;CACF"}

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

@@ -0,0 +1,66 @@
+import { BSON } from 'bson';
+import { describe, expect, it, vi } from 'vitest';
+import DOFunction, {
+  DOFunctionCallOutput,
+  DOFunctionInput,
+  DOFunctionOutput
+} from './DOFunction.js';
+
+describe('DOFunction', () => {
+  it('should call the function and return the expected output', async () => {
+    const exampleFunction = ExampleFunction.getFunction();
+
+    const input: ExampleInput = { name: 'John' };
+    const expectedOutput: DOFunctionCallOutput<ExampleOutput> = {
+      success: true,
+      errors: [],
+      data: { greeting: 'Hello, John!' }
+    };
+
+    global.fetch = vi.fn().mockResolvedValue({
+      text: vi
+        .fn()
+        .mockResolvedValue(
+          Buffer.from(BSON.serialize(expectedOutput)).toString('base64')
+        )
+    });
+
+    const output = await exampleFunction.call(input);
+
+    expect(output).toEqual(expectedOutput);
+    expect(global.fetch).toHaveBeenCalledWith(EXAMPLE_FUNCTION_URL, {
+      method: 'POST',
+      headers: {
+        Connection: 'keep-alive',
+        'Content-Type': 'application/octet-stream'
+      },
+      body: Buffer.from(BSON.serialize(input)).toString('base64')
+    });
+  });
+});
+
+const EXAMPLE_FUNCTION_URL = 'https://example.com/function';
+
+export class ExampleFunction extends DOFunction<ExampleInput, ExampleOutput> {
+  private static instance: ExampleFunction | undefined;
+
+  private constructor() {
+    super();
+    this.url = EXAMPLE_FUNCTION_URL;
+  }
+
+  static getFunction(): ExampleFunction {
+    if (!ExampleFunction.instance) {
+      ExampleFunction.instance = new ExampleFunction();
+    }
+    return ExampleFunction.instance;
+  }
+}
+
+interface ExampleInput extends DOFunctionInput {
+  name: string;
+}
+
+interface ExampleOutput extends DOFunctionOutput {
+  greeting: string;
+}

package/lib/services/DOFunctionService/DOFunction.ts

@@ -13,20 +13,35 @@ export type DOFunctionInput = object;
 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.
+ * Raw input to a Digital Ocean function. This is with the expectation that
+ * `web: raw` is set in the `project.yml` file.
  */
 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.
+     * The body to be parsed or deserialized.
      */
     body: string;
+    headers: {
+      accept?: string;
+      'accept-encoding'?: string;
+      /**
+       * This is important.
+       */
+      'content-type'?: string;
+      host?: string;
+      'user-agent'?: string;
+      'x-forwarded-for'?: string;
+      'x-forwarded-proto'?: string;
+      'x-request-id'?: string;
+    };
+    /**
+     * This needs to be used to determine if the body is base64 encoded.
+     */
+    isBase64Encoded: boolean;
+    method?: string;
+    path?: string;
+    queryString?: string;
   };
 }
 
@@ -41,8 +56,14 @@ export interface DOFunctionRawOutput {
    * The body is a base64 encoded string.
    */
   body: string;
+  statusCode: number;
   headers: {
-    'Content-Type': 'application/octet-stream';
+    /**
+     * This is different than what gets passed in. This is on purpose. DO
+     * functions changes the header name when being passed in, but not when
+     * being passed out.
+     */
+    'Content-Type': string;
   };
 }
 
@@ -55,10 +76,6 @@ export interface DOFunctionCallOutput<TOutput extends DOFunctionOutput> {
   data: TOutput;
 }
 
-/**
- * An abstract class that can be extended to define a Digital Ocean
- * function.
- */
 /**
  * An abstract class representing a Digital Ocean Function.
  *
@@ -102,28 +119,29 @@ export default abstract class DOFunction<
     if (!this.url) {
       throw new Error(`${this.functionName} URL is not set`);
     }
-    const result = await fetch(this.url, {
+    const body = Buffer.from(BSON.serialize(input)).toString('base64');
+    const response = await fetch(this.url, {
       method: 'POST',
       headers: {
+        Connection: 'keep-alive',
         '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: BSON.serialize(input)
+      body: body
     });
-    return this.decodeArrayBuffer(await result.arrayBuffer());
+    return await this.decodeResponse(response);
   }
 
   /**
-   * Decodes an {@link ArrayBuffer} into a {@link DOFunctionCallOutput}.
+   * Decodes the response from the Digital Ocean function.
    *
-   * @param buffer - The buffer to decode.
+   * @param response - The response to decode.
    * @returns The decoded output.
    */
-  private decodeArrayBuffer(
-    buffer: ArrayBuffer
-  ): DOFunctionCallOutput<TOutput> {
-    const bytes = new Uint8Array(buffer);
-    return BSON.deserialize(bytes) as DOFunctionCallOutput<TOutput>;
+  private async decodeResponse(
+    response: Response
+  ): Promise<DOFunctionCallOutput<TOutput>> {
+    const bodyText = await response.text();
+    const buffer = Buffer.from(bodyText, 'base64');
+    return BSON.deserialize(buffer) as DOFunctionCallOutput<TOutput>;
   }
 }

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

@@ -39,7 +39,8 @@ export default class DOFunctionService {
      */
     private static deserializeInput;
     /**
-     * Serializes the output object into a base64 string.
+     * Serializes the output object into a base64 string. This could be updated
+     * to support other serialization methods in the future.
      *
      * @param output - The output object to serialize.
      * @returns The serialized output as a base64 string.

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

@@ -1 +1 @@
-{"version":3,"file":"DOFunctionService.d.ts","sourceRoot":"./src/","sources":["services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AACA,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACpB,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;;;;;;;;;;;OAWG;WACU,gBAAgB,CAC3B,MAAM,SAAS,eAAe,EAC9B,OAAO,SAAS,gBAAgB,EAEhC,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,GACjE,OAAO,CAAC,mBAAmB,CAAC;IAyB/B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAY/B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;CAM/B"}
+{"version":3,"file":"DOFunctionService.d.ts","sourceRoot":"./src/","sources":["services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AACA,OAAO,EACL,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACpB,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;;;;;;;;;;;OAWG;WACU,gBAAgB,CAC3B,MAAM,SAAS,eAAe,EAC9B,OAAO,SAAS,gBAAgB,EAEhC,QAAQ,EAAE,kBAAkB,EAC5B,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,GACjE,OAAO,CAAC,mBAAmB,CAAC;IA0B/B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IA2B/B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;CAM/B"}

package/lib/services/DOFunctionService/DOFunctionService.js

@@ -34,6 +34,7 @@ export default class DOFunctionService {
         const input = this.deserializeInput(rawInput);
         const rawOutput = {
             body: '',
+            statusCode: 200,
             headers: {
                 'Content-Type': 'application/octet-stream'
             }
@@ -62,23 +63,38 @@ export default class DOFunctionService {
      * @returns The deserialized input object.
      */
     static deserializeInput(rawInput) {
-        const binaryString = atob(rawInput.http.body);
-        const len = binaryString.length;
-        const bytes = new Uint8Array(len);
-        for (let i = 0; i < len; i += 1) {
-            bytes[i] = binaryString.charCodeAt(i);
+        const { http } = rawInput;
+        const { body, isBase64Encoded, headers } = http;
+        let decodedBody;
+        if (isBase64Encoded) {
+            decodedBody = Buffer.from(body, 'base64');
         }
-        return BSON.deserialize(bytes);
+        else {
+            decodedBody = Buffer.from(body, 'utf8');
+        }
+        // Determine if the incoming content type is BSON
+        const isBson = headers['content-type'] === 'application/octet-stream';
+        let requestData;
+        if (isBson) {
+            // Deserialize BSON data
+            requestData = BSON.deserialize(decodedBody);
+        }
+        else {
+            // Parse JSON data
+            requestData = JSON.parse(decodedBody.toString('utf8'));
+        }
+        return requestData;
     }
     /**
-     * Serializes the output object into a base64 string.
+     * Serializes the output object into a base64 string. This could be updated
+     * to support other serialization methods in the future.
      *
      * @param output - The output object to serialize.
      * @returns The serialized output as a base64 string.
      */
     static serializeOutput(output) {
-        const uInt8Array = BSON.serialize(output);
-        return Buffer.from(uInt8Array).toString('base64');
+        const bsonBuffer = BSON.serialize(output);
+        return Buffer.from(bsonBuffer).toString('base64');
     }
 }
 //# sourceMappingURL=DOFunctionService.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"DOFunctionService.js","sourceRoot":"./src/","sources":["services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAQ5B,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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAI3B,QAA4B,EAC5B,OAAkE;QAElE,MAAM,KAAK,GAAW,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACtD,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,EAAE;YACR,OAAO,EAAE;gBACP,cAAc,EAAE,0BAA0B;aAC3C;SACF,CAAC;QACF,yCAAyC;QACzC,MAAM,aAAa,GAAkC;YACnD,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,EAAa;SACpB,CAAC;QACF,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;YACpC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,gBAAgB,CAC7B,QAA4B;QAE5B,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC;QAClC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,CAAW,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;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":"./src/","sources":["services/DOFunctionService/DOFunctionService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAQ5B,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;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAI3B,QAA4B,EAC5B,OAAkE;QAElE,MAAM,KAAK,GAAW,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;QACtD,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,EAAE;YACR,UAAU,EAAE,GAAG;YACf,OAAO,EAAE;gBACP,cAAc,EAAE,0BAA0B;aAC3C;SACF,CAAC;QACF,yCAAyC;QACzC,MAAM,aAAa,GAAkC;YACnD,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,EAAE;YACV,IAAI,EAAE,EAAa;SACpB,CAAC;QACF,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;YACpC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzC,SAAS,CAAC,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACK,MAAM,CAAC,gBAAgB,CAC7B,QAA4B;QAE5B,MAAM,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAC;QAC1B,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEhD,IAAI,WAAmB,CAAC;QACxB,IAAI,eAAe,EAAE,CAAC;YACpB,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1C,CAAC;QAED,iDAAiD;QACjD,MAAM,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,KAAK,0BAA0B,CAAC;QACtE,IAAI,WAAmB,CAAC;QACxB,IAAI,MAAM,EAAE,CAAC;YACX,wBAAwB;YACxB,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAW,CAAC;QACxD,CAAC;aAAM,CAAC;YACN,kBAAkB;YAClB,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAW,CAAC;QACnE,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,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"}

package/lib/services/DOFunctionService/DOFunctionService.spec.ts

@@ -0,0 +1,61 @@
+import { BSON } from 'bson';
+import { describe, expect, it, vi } from 'vitest';
+import { DOFunctionRawInput, DOFunctionRawOutput } from './DOFunction.js';
+import { ExampleFunction } from './DOFunction.spec.js';
+import DOFunctionService from './DOFunctionService.js';
+
+describe('DOFunctionService', () => {
+  it('should handle API request and return the expected raw output', async () => {
+    const rawInput: DOFunctionRawInput = {
+      http: {
+        body: Buffer.from(BSON.serialize({ name: 'John' })).toString('base64'),
+        headers: {
+          accept: '',
+          'accept-encoding': '',
+          'content-type': 'application/octet-stream',
+          host: '',
+          'user-agent': '',
+          'x-forwarded-for': '',
+          'x-forwarded-proto': '',
+          'x-request-id': ''
+        },
+        isBase64Encoded: true,
+        method: 'POST',
+        path: '',
+        queryString: ''
+      }
+    };
+
+    const expectedOutput = {
+      success: true,
+      errors: [],
+      data: { greeting: 'Hello, John!' }
+    };
+
+    const expectedRawOutput: DOFunctionRawOutput = {
+      body: Buffer.from(BSON.serialize(expectedOutput)).toString('base64'),
+      statusCode: 200,
+      headers: {
+        'Content-Type': 'application/octet-stream'
+      }
+    };
+
+    global.fetch = vi.fn().mockResolvedValue({
+      text: vi
+        .fn()
+        .mockResolvedValue(
+          Buffer.from(BSON.serialize(expectedOutput)).toString('base64')
+        )
+    });
+
+    const handler = ExampleFunction.getFunction().call.bind(
+      ExampleFunction.getFunction()
+    );
+    const rawOutput = await DOFunctionService.handleApiRequest(
+      rawInput,
+      handler
+    );
+
+    expect(rawOutput).toEqual(expectedRawOutput);
+  });
+});

package/lib/services/DOFunctionService/DOFunctionService.ts

@@ -51,6 +51,7 @@ export default class DOFunctionService {
     const input: TInput = this.deserializeInput(rawInput);
     const rawOutput: DOFunctionRawOutput = {
       body: '',
+      statusCode: 200,
       headers: {
         'Content-Type': 'application/octet-stream'
       }
@@ -81,17 +82,33 @@ export default class DOFunctionService {
   private static deserializeInput<TInput extends DOFunctionInput>(
     rawInput: DOFunctionRawInput
   ): TInput {
-    const binaryString = atob(rawInput.http.body);
-    const len = binaryString.length;
-    const bytes = new Uint8Array(len);
-    for (let i = 0; i < len; i += 1) {
-      bytes[i] = binaryString.charCodeAt(i);
+    const { http } = rawInput;
+    const { body, isBase64Encoded, headers } = http;
+
+    let decodedBody: Buffer;
+    if (isBase64Encoded) {
+      decodedBody = Buffer.from(body, 'base64');
+    } else {
+      decodedBody = Buffer.from(body, 'utf8');
+    }
+
+    // Determine if the incoming content type is BSON
+    const isBson = headers['content-type'] === 'application/octet-stream';
+    let requestData: TInput;
+    if (isBson) {
+      // Deserialize BSON data
+      requestData = BSON.deserialize(decodedBody) as TInput;
+    } else {
+      // Parse JSON data
+      requestData = JSON.parse(decodedBody.toString('utf8')) as TInput;
     }
-    return BSON.deserialize(bytes) as TInput;
+
+    return requestData;
   }
 
   /**
-   * Serializes the output object into a base64 string.
+   * Serializes the output object into a base64 string. This could be updated
+   * to support other serialization methods in the future.
    *
    * @param output - The output object to serialize.
    * @returns The serialized output as a base64 string.
@@ -99,7 +116,7 @@ export default class DOFunctionService {
   private static serializeOutput<TOutput extends DOFunctionOutput>(
     output: DOFunctionCallOutput<TOutput>
   ): string {
-    const uInt8Array = BSON.serialize(output);
-    return Buffer.from(uInt8Array).toString('base64');
+    const bsonBuffer = BSON.serialize(output);
+    return Buffer.from(bsonBuffer).toString('base64');
   }
 }

package/package.json

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