@aneuhold/core-ts-api-lib 2.0.9 → 2.0.10

package/lib/tests/ExampleFunction.d.ts

@@ -0,0 +1,14 @@
+import DOFunction, { DOFunctionInput, DOFunctionOutput } from '../services/DOFunctionService/DOFunction.js';
+export declare const EXAMPLE_FUNCTION_URL = "https://example.com/function";
+export declare class ExampleFunction extends DOFunction<ExampleInput, ExampleOutput> {
+    private static instance;
+    private constructor();
+    static getFunction(): ExampleFunction;
+}
+export interface ExampleInput extends DOFunctionInput {
+    name: string;
+}
+export interface ExampleOutput extends DOFunctionOutput {
+    greeting: string;
+}
+//# sourceMappingURL=ExampleFunction.d.ts.map

package/lib/tests/ExampleFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleFunction.d.ts","sourceRoot":"./src/","sources":["tests/ExampleFunction.ts"],"names":[],"mappings":"AAAA,OAAO,UAAU,EAAE,EACjB,eAAe,EACf,gBAAgB,EACjB,MAAM,6CAA6C,CAAC;AAErD,eAAO,MAAM,oBAAoB,iCAAiC,CAAC;AAEnE,qBAAa,eAAgB,SAAQ,UAAU,CAAC,YAAY,EAAE,aAAa,CAAC;IAC1E,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA8B;IAErD,OAAO;IAKP,MAAM,CAAC,WAAW,IAAI,eAAe;CAMtC;AAED,MAAM,WAAW,YAAa,SAAQ,eAAe;IACnD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAc,SAAQ,gBAAgB;IACrD,QAAQ,EAAE,MAAM,CAAC;CAClB"}

package/lib/tests/ExampleFunction.js

@@ -0,0 +1,16 @@
+import DOFunction from '../services/DOFunctionService/DOFunction.js';
+export const EXAMPLE_FUNCTION_URL = 'https://example.com/function';
+export class ExampleFunction extends DOFunction {
+    static instance;
+    constructor() {
+        super();
+        this.url = EXAMPLE_FUNCTION_URL;
+    }
+    static getFunction() {
+        if (!ExampleFunction.instance) {
+            ExampleFunction.instance = new ExampleFunction();
+        }
+        return ExampleFunction.instance;
+    }
+}
+//# sourceMappingURL=ExampleFunction.js.map

package/lib/tests/ExampleFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExampleFunction.js","sourceRoot":"./src/","sources":["tests/ExampleFunction.ts"],"names":[],"mappings":"AAAA,OAAO,UAGN,MAAM,6CAA6C,CAAC;AAErD,MAAM,CAAC,MAAM,oBAAoB,GAAG,8BAA8B,CAAC;AAEnE,MAAM,OAAO,eAAgB,SAAQ,UAAuC;IAClE,MAAM,CAAC,QAAQ,CAA8B;IAErD;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,GAAG,GAAG,oBAAoB,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,WAAW;QAChB,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,CAAC;YAC9B,eAAe,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;QACnD,CAAC;QACD,OAAO,eAAe,CAAC,QAAQ,CAAC;IAClC,CAAC;CACF"}

package/lib/tests/ExampleFunction.ts

@@ -0,0 +1,30 @@
+import DOFunction, {
+  DOFunctionInput,
+  DOFunctionOutput
+} from '../services/DOFunctionService/DOFunction.js';
+
+export 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;
+  }
+}
+
+export interface ExampleInput extends DOFunctionInput {
+  name: string;
+}
+
+export interface ExampleOutput extends DOFunctionOutput {
+  greeting: string;
+}

package/lib/tests/TestUtil.d.ts

@@ -0,0 +1,10 @@
+export declare class TestUtil {
+    /**
+     * Mocks fetch globally to return the expected output. This should match how
+     * the output is expected to be returned from the Digital Ocean function.
+     *
+     * @param expectedOutput The expected output from the fetch call.
+     */
+    static mockFetch(expectedOutput: object): void;
+}
+//# sourceMappingURL=TestUtil.d.ts.map

package/lib/tests/TestUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestUtil.d.ts","sourceRoot":"./src/","sources":["tests/TestUtil.ts"],"names":[],"mappings":"AAGA,qBAAa,QAAQ;IACnB;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,cAAc,EAAE,MAAM;CAQxC"}

package/lib/tests/TestUtil.js

@@ -0,0 +1,19 @@
+import { BSON } from 'bson';
+import { vi } from 'vitest';
+export class TestUtil {
+    /**
+     * Mocks fetch globally to return the expected output. This should match how
+     * the output is expected to be returned from the Digital Ocean function.
+     *
+     * @param expectedOutput The expected output from the fetch call.
+     */
+    static mockFetch(expectedOutput) {
+        global.fetch = vi.fn().mockResolvedValue({
+            arrayBuffer: vi
+                .fn()
+                .mockResolvedValue(Buffer.from(BSON.serialize(expectedOutput))),
+            headers: new Map([['Content-Type', 'application/octet-stream']])
+        });
+    }
+}
+//# sourceMappingURL=TestUtil.js.map

package/lib/tests/TestUtil.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestUtil.js","sourceRoot":"./src/","sources":["tests/TestUtil.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE5B,MAAM,OAAO,QAAQ;IACnB;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,cAAsB;QACrC,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;YACvC,WAAW,EAAE,EAAE;iBACZ,EAAE,EAAE;iBACJ,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,CAAC;YACjE,OAAO,EAAE,IAAI,GAAG,CAAC,CAAC,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAC,CAAC;SACjE,CAAC,CAAC;IACL,CAAC;CACF"}

package/lib/tests/TestUtil.ts

@@ -0,0 +1,19 @@
+import { BSON } from 'bson';
+import { vi } from 'vitest';
+
+export class TestUtil {
+  /**
+   * Mocks fetch globally to return the expected output. This should match how
+   * the output is expected to be returned from the Digital Ocean function.
+   *
+   * @param expectedOutput The expected output from the fetch call.
+   */
+  static mockFetch(expectedOutput: object) {
+    global.fetch = vi.fn().mockResolvedValue({
+      arrayBuffer: vi
+        .fn()
+        .mockResolvedValue(Buffer.from(BSON.serialize(expectedOutput))),
+      headers: new Map([['Content-Type', 'application/octet-stream']])
+    });
+  }
+}

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

@@ -0,0 +1,37 @@
+import { BSON } from 'bson';
+import { describe, expect, it } from 'vitest';
+import { DOFunctionCallOutput } from '../../../services/DOFunctionService/DOFunction.js';
+import {
+  EXAMPLE_FUNCTION_URL,
+  ExampleFunction,
+  ExampleInput,
+  ExampleOutput
+} from '../../ExampleFunction.js';
+import { TestUtil } from '../../TestUtil.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!' }
+    };
+
+    TestUtil.mockFetch(expectedOutput);
+
+    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))
+    });
+  });
+});

package/package.json

@@ -2,7 +2,7 @@
   "name": "@aneuhold/core-ts-api-lib",
   "author": "Anton G. Neuhold Jr.",
   "license": "MIT",
-  "version": "2.0.9",
+  "version": "2.0.10",
   "description": "A library for interacting with the backend and defining the backend API for personal projects.",
   "packageManager": "yarn@4.5.1",
   "type": "module",
@@ -52,7 +52,7 @@
     "@aneuhold/main-scripts": "^2.0.6",
     "@types/node": "^20.17.1",
     "eslint": "^9.13.0",
-    "jsr": "^0.13.2",
+    "jsr": "^0.13.3",
     "prettier": "^3.3.3",
     "rimraf": "^6.0.1",
     "tsx": "^4.19.1",

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

@@ -1,66 +0,0 @@
-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/DOFunctionService.spec.ts

@@ -1,61 +0,0 @@
-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);
-  });
-});