@moneylion/engine-api 1.0.0

package/dist/rate_tables.js

@@ -0,0 +1,91 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Client } from "./client.js";
+import { rateTableDecoder } from "./decoders.js";
+const pollInterval = 1000; // 1 second
+/**
+ * The class used to fetch rate tables from the Engine API.
+ * This class will handle polling the rate tables endpoint until the pending responses are fulfilled.
+ */
+export class AsyncRateTable {
+    /**
+     * Construct a new AsyncRateTable instance.
+     * @param rateTable - An existing Rate Table structure to start from.
+     * @param uuid - A UUID of an existing Rate Table to fetch.
+     * @param client - A Client instance to use for fetching the data.
+     * @param host - A host used to construct a Client instance if none is provided.
+     * @param auth_token - An authentication token used to construct a Client instance if none is provided.
+     *
+     * @remarks
+     * Either one of rateTable or uuid is required, but providing both is an error.
+     * Similarly, provide either a pre-constructed Client instance or the host and auth_token parameters to construct one but not both.
+     */
+    constructor({ rateTable, uuid, client, host, auth_token, }) {
+        if (client && host && auth_token) {
+            throw new TypeError("Client cannot be provided at the same time as a host and auth_token.");
+        }
+        if (rateTable && uuid) {
+            throw new TypeError("Rate table and uuid cannot be provided at the same time.");
+        }
+        if (client) {
+            this.client = client;
+        }
+        else if (host && auth_token) {
+            this.client = new Client(host, auth_token);
+        }
+        else {
+            throw new TypeError("Either client must be provided or host and auth_token must be provided.");
+        }
+        this.rateTable = rateTable;
+        this.uuid = uuid;
+        if (!this.rateTable && !this.uuid) {
+            throw new TypeError("Either a rate table or a uuid must be provided.");
+        }
+    }
+    /**
+     * Resolve the async Rate Table into a real Rate Table.
+     *
+     * @returns A Rate Table with no pending responses.
+     *
+     * @remarks
+     *
+     * This will only make a network request if one is required.
+     * A network request is required if only a UUID was provided to the constructor, or if the provided Rate Table has pending responses.
+     * This method will also poll the API every second until the returned Rate Table has no more pending responses.
+     */
+    resolve() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.rateTable && this.rateTable.pendingResponses.length > 0) {
+                const resolved = yield this.getRateTable(this.rateTable.uuid);
+                return new Promise((resolve) => {
+                    setTimeout(() => {
+                        resolve(resolved.resolve());
+                    }, pollInterval);
+                });
+            }
+            else if (this.uuid) {
+                const resolved = yield this.getRateTable(this.uuid);
+                return resolved.resolve();
+            }
+            else if (this.rateTable) {
+                return this.rateTable;
+            }
+            throw new TypeError("No uuid or rate table was provided to resolve");
+        });
+    }
+    getRateTable(uuid) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = `originator/rateTables/${uuid}`;
+            const resp = yield this.client.get(endpoint);
+            const rateTable = rateTableDecoder.runWithException(resp);
+            return new AsyncRateTable({ rateTable, client: this.client });
+        });
+    }
+}

package/dist/rate_tables.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/rate_tables.test.js

@@ -0,0 +1,224 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { describe, expect, test, beforeAll, afterEach, afterAll, } from "@jest/globals";
+import { Client } from "./client";
+import { setupServer } from "msw/node";
+import { http, HttpResponse } from "msw";
+import { AsyncRateTable } from "./rate_tables";
+const fullRateTable = {
+    uuid: "full-rate-table-uuid",
+    leadUuid: "full-lead-uuid",
+    loanAmount: 10000,
+    creditCardOffers: [],
+    loanOffers: [],
+    mortgageOffers: [],
+    savingsOffers: [],
+    specialOffers: [
+        {
+            uuid: "full-special-offer-uuid",
+            name: "Mock Credit Builder Offer",
+            desc: "Description of the credit builder offer",
+            url: "https://offers.engine.tech/ref/d6888b75-5454-498c-8710-e4c22daaf64e",
+            partnerName: "Engine Demo Loans Demand Sub Account 1",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account-wjksncio.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "credit_builder",
+        },
+        {
+            uuid: "full-special-offer-uuid-2",
+            name: "Mock Debt Relief Offer",
+            desc: "Description of the debt relief offer",
+            url: "https://offers.engine.tech/ref/567beb02-9230-4bad-b60a-b2311bad400b",
+            partnerName: "Engine Demo Loans Demand Sub Account 2",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_2-wjkurpux.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "debt_relief",
+        },
+        {
+            uuid: "full-special-offer-uuid-3",
+            name: "Mock Installment Loans Offer",
+            desc: "Description of the installment loans offer",
+            url: "https://offers.engine.tech/ref/ec88908d-bdee-4b5d-8c49-2268167ea3c5",
+            partnerName: "Engine Demo Loans Demand Sub Account 3",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_3-wjkuspug.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "installment_loans",
+        },
+    ],
+    pendingOriginators: [],
+    pendingResponses: [],
+};
+const pendingRateTable = {
+    uuid: "pending-rate-table-uuid",
+    leadUuid: "pending-lead-uuid",
+    loanAmount: 20000,
+    creditCardOffers: [],
+    loanOffers: [],
+    mortgageOffers: [],
+    savingsOffers: [],
+    specialOffers: [
+        {
+            uuid: "pending-special-offer-uuid",
+            name: "Mock Credit Builder Offer",
+            desc: "Description of the credit builder offer",
+            url: "https://offers.engine.tech/ref/d6888b75-5454-498c-8710-e4c22daaf64e",
+            partnerName: "Engine Demo Loans Demand Sub Account 1",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account-wjksncio.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "credit_builder",
+        },
+        {
+            uuid: "pending-special-offer-uuid-2",
+            name: "Mock Debt Relief Offer",
+            desc: "Description of the debt relief offer",
+            url: "https://offers.engine.tech/ref/567beb02-9230-4bad-b60a-b2311bad400b",
+            partnerName: "Engine Demo Loans Demand Sub Account 2",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_2-wjkurpux.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "debt_relief",
+        },
+        {
+            uuid: "pending-special-offer-uuid-3",
+            name: "Mock Installment Loans Offer",
+            desc: "Description of the installment loans offer",
+            url: "https://offers.engine.tech/ref/ec88908d-bdee-4b5d-8c49-2268167ea3c5",
+            partnerName: "Engine Demo Loans Demand Sub Account 3",
+            partnerImageUrl: "https://s3.amazonaws.com/images.evenfinancial.com/logos/dev/engine_demo_loans_demand_sub_account_3-wjkuspug.svg",
+            recommendationScore: 10,
+            payout: 0.1,
+            productSubType: "installment_loans",
+        },
+    ],
+    pendingOriginators: [],
+    pendingResponses: [
+        {
+            partner: {
+                uuid: "partner-uuid",
+                name: "partner",
+                description: "partner-description",
+                disclaimer: "partner-disclaimer",
+                supportsPreSelect: false,
+                shouldDisplayPreSelect: false,
+                supportsPersonalizedOffers: false,
+                imageUrl: "partner-image",
+            },
+            productTypes: ["credit_card"],
+        },
+    ],
+};
+const doublePollUuid = "double-poll-uuid";
+const testHost = "https://engine.com";
+const token = "good_auth_token";
+const handlers = [
+    http.get(`${testHost}/originator/rateTables/${pendingRateTable["uuid"]}`, () => {
+        return new HttpResponse(JSON.stringify(fullRateTable), {
+            status: 200,
+        });
+    }),
+    http.get(`${testHost}/originator/rateTables/${doublePollUuid}`, () => {
+        return new HttpResponse(JSON.stringify(pendingRateTable), {
+            status: 200,
+        });
+    }),
+];
+const server = setupServer(...handlers);
+describe("Leads", () => {
+    beforeAll(() => server.listen({
+        onUnhandledRequest: "error",
+    }));
+    afterEach(() => server.resetHandlers());
+    afterAll(() => server.close());
+    test("Either client or host and auth_token must be provided to constructor", () => {
+        expect(() => new AsyncRateTable({
+            host: testHost,
+            auth_token: token,
+            uuid: "test-uuid",
+        })).not.toThrowError();
+        expect(() => new AsyncRateTable({
+            client: new Client(testHost, token),
+            uuid: "test-uuid",
+        })).not.toThrowError();
+        expect(() => new AsyncRateTable({ uuid: "test-uuid" })).toThrowError(TypeError);
+    });
+    test("Either a rate table or a uuid must be provided to constructor", () => {
+        expect(() => new AsyncRateTable({ host: testHost, auth_token: token })).toThrowError(TypeError);
+        expect(() => new AsyncRateTable({
+            host: testHost,
+            auth_token: token,
+            uuid: "test-uuid",
+        })).not.toThrowError();
+        expect(() => new AsyncRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: fullRateTable,
+        })).not.toThrowError();
+    });
+    test("Providing both a rate table and a uuid to constructor is an error", () => {
+        expect(() => new AsyncRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: fullRateTable,
+            uuid: "test-uuid",
+        })).toThrowError(TypeError);
+    });
+    test("Providing both a client instance and a host/auth_token pair is an error", () => {
+        expect(() => new AsyncRateTable({
+            client: new Client(testHost, token),
+            host: testHost,
+            auth_token: token,
+            uuid: "test-uuid",
+        })).toThrowError(TypeError);
+    });
+    test("Providing a UUID resolves the rate table.", () => __awaiter(void 0, void 0, void 0, function* () {
+        const rateTables = new AsyncRateTable({
+            host: testHost,
+            auth_token: token,
+            uuid: doublePollUuid,
+        });
+        const resp = yield rateTables.resolve();
+        expect(resp).toEqual(fullRateTable);
+    }));
+    test("Providing a rate table with pending responses resolves the rate table.", () => __awaiter(void 0, void 0, void 0, function* () {
+        const rateTables = new AsyncRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: pendingRateTable,
+        });
+        const resp = yield rateTables.resolve();
+        expect(resp).toEqual(fullRateTable);
+    }));
+    test("Providing a rate table with no pending responses resolves the rate table.", () => __awaiter(void 0, void 0, void 0, function* () {
+        const rateTables = new AsyncRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: fullRateTable,
+        });
+        const resp = yield rateTables.resolve();
+        expect(resp).toEqual(fullRateTable);
+    }));
+    test("If there are no pending responses no requests are made when resolving.", () => __awaiter(void 0, void 0, void 0, function* () {
+        const rateTables = new AsyncRateTable({
+            host: testHost,
+            auth_token: token,
+            rateTable: fullRateTable,
+        });
+        let requestSent = false;
+        server.events.on("request:start", () => {
+            requestSent = true;
+        });
+        yield rateTables.resolve();
+        expect(requestSent).toBe(false);
+    }));
+});

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@moneylion/engine-api",
+  "version": "1.0.0",
+  "description": "Interface to engine.tech API",
+  "type": "module",
+  "main": "dist/index.js",
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsc",
+    "lint": "prettier . --check && eslint src/",
+    "lint:fix": "prettier . --write && eslint --fix src/",
+    "test": "npm run build && NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest dist/",
+    "generate:schema": "openapi-typescript https://even-api-reference.s3.amazonaws.com/releases/branches/public@1.49.0/latest/open-api/public/spec.json -o src/generated/schema.d.ts"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@tsconfig/node18": "^18.2.2",
+    "@typescript-eslint/eslint-plugin": "^7.3.1",
+    "@typescript-eslint/parser": "^7.3.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
+    "jest": "^29.7.0",
+    "msw": "^2.2.10",
+    "openapi-typescript": "^6.7.5",
+    "prettier": "3.2.5",
+    "ts-jest": "^29.1.2"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@mojotech/json-type-validation": "^3.1.0",
+    "node-fetch": "^3.3.2"
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": false,
+    "tabWidth": 4,
+    "trailingComma": "es5",
+    "useTabs": true
+  }
+}