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

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

@@ -19,25 +19,25 @@ export interface DOFunctionRawInput {
          */
         body: string;
         headers: {
-            accept: string;
-            'accept-encoding': string;
+            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;
+            '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;
+        method?: string;
+        path?: string;
+        queryString?: string;
     };
 }
 /**

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,IAAI,EAAE;QACJ;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE;YACP,MAAM,EAAE,MAAM,CAAC;YACf,iBAAiB,EAAE,MAAM,CAAC;YAC1B;;eAEG;YACH,cAAc,EAAE,MAAM,CAAC;YACvB,IAAI,EAAE,MAAM,CAAC;YACb,YAAY,EAAE,MAAM,CAAC;YACrB,iBAAiB,EAAE,MAAM,CAAC;YAC1B,mBAAmB,EAAE,MAAM,CAAC;YAC5B,cAAc,EAAE,MAAM,CAAC;SACxB,CAAC;QACF;;WAEG;QACH,eAAe,EAAE,OAAO,CAAC;QACzB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,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"}
+{"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.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

@@ -23,25 +23,25 @@ export interface DOFunctionRawInput {
      */
     body: string;
     headers: {
-      accept: string;
-      'accept-encoding': string;
+      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;
+      '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;
+    method?: string;
+    path?: string;
+    queryString?: string;
   };
 }
 

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/package.json

@@ -2,7 +2,7 @@
   "name": "@aneuhold/core-ts-api-lib",
   "author": "Anton G. Neuhold Jr.",
   "license": "MIT",
-  "version": "2.0.4",
+  "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",