@riocrypto/common-server 1.0.2933 → 1.0.2935

package/build/index.d.ts

@@ -90,6 +90,7 @@ export * from "./models/STP-deposit-CLABE";
 export * from "./models/STP-settings";
 export * from "./models/fintoc-mxn-withdrawal";
 export * from "./models/fintoc-deposit-CLABE";
+export * from "./models/inbound-deposit-intake";
 export * from "./models/processor-readiness";
 export * from "./models/payment-address-verification";
 export * from "./models/alfin-virtual-cci";

package/build/index.js

@@ -106,6 +106,7 @@ __exportStar(require("./models/STP-deposit-CLABE"), exports);
 __exportStar(require("./models/STP-settings"), exports);
 __exportStar(require("./models/fintoc-mxn-withdrawal"), exports);
 __exportStar(require("./models/fintoc-deposit-CLABE"), exports);
+__exportStar(require("./models/inbound-deposit-intake"), exports);
 __exportStar(require("./models/processor-readiness"), exports);
 __exportStar(require("./models/payment-address-verification"), exports);
 __exportStar(require("./models/alfin-virtual-cci"), exports);

package/build/models/inbound-deposit-intake.d.ts

@@ -0,0 +1,43 @@
+import { Mongoose, Model, Document, HydratedDocument } from "mongoose";
+import { TreasuryProvider } from "@riocrypto/common";
+export declare enum InboundDepositIntakeStatus {
+    /** Recorded, waiting for the worker. */
+    Pending = "pending",
+    /** A worker has taken it. Reset to pending if left here too long. */
+    Processing = "processing",
+    /** Matching ran to completion, whatever it concluded. See `outcome`. */
+    Done = "done",
+    /** Matching threw and retries are exhausted. Needs a person. */
+    Failed = "failed"
+}
+export type InboundDepositIntakeSource = "webhook" | "poller";
+interface InboundDepositIntakeAttrs {
+    provider: TreasuryProvider;
+    /** The provider's id for the deposit, e.g. a Fintoc transfer id. */
+    externalId: string;
+    source: InboundDepositIntakeSource;
+    /** The provider's webhook event id, for tracing back to their dashboard. */
+    externalEventId?: string;
+    receivedAt: Date;
+}
+interface InboundDepositIntakeDoc extends Document {
+    provider: TreasuryProvider;
+    externalId: string;
+    source: InboundDepositIntakeSource;
+    externalEventId?: string;
+    status: InboundDepositIntakeStatus;
+    attempts: number;
+    /** The reason the provider's matcher returned, once it has run. */
+    outcome?: string;
+    /** Whether that run published a payment, as opposed to skipping or rejecting. */
+    processed?: boolean;
+    lastError?: string;
+    receivedAt: Date;
+    startedAt?: Date;
+    finishedAt?: Date;
+}
+interface InboundDepositIntakeModel extends Model<InboundDepositIntakeDoc> {
+    build(attrs: InboundDepositIntakeAttrs): HydratedDocument<InboundDepositIntakeDoc>;
+}
+declare const buildInboundDepositIntake: (mongoose: Mongoose) => InboundDepositIntakeModel;
+export { buildInboundDepositIntake, InboundDepositIntakeDoc, InboundDepositIntakeAttrs, };

package/build/models/inbound-deposit-intake.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildInboundDepositIntake = exports.InboundDepositIntakeStatus = void 0;
+const common_1 = require("@riocrypto/common");
+// One row per inbound deposit a provider has told us about, written the moment we
+// learn the deposit exists and before any work is done on it. This is what lets a
+// deposit survive the pod being killed mid-processing: the webhook only records
+// that the deposit arrived, and a worker in the provider's service does the
+// matching from here, so a restart resumes rather than forgets. It is a processing
+// ledger, not an accounting record; the money itself is recorded in
+// InboundBankDeposit once matching has run.
+//
+// Shared across providers. Each service works only the rows for its own provider,
+// and what "processing" means for a row is that service's business.
+var InboundDepositIntakeStatus;
+(function (InboundDepositIntakeStatus) {
+    /** Recorded, waiting for the worker. */
+    InboundDepositIntakeStatus["Pending"] = "pending";
+    /** A worker has taken it. Reset to pending if left here too long. */
+    InboundDepositIntakeStatus["Processing"] = "processing";
+    /** Matching ran to completion, whatever it concluded. See `outcome`. */
+    InboundDepositIntakeStatus["Done"] = "done";
+    /** Matching threw and retries are exhausted. Needs a person. */
+    InboundDepositIntakeStatus["Failed"] = "failed";
+})(InboundDepositIntakeStatus = exports.InboundDepositIntakeStatus || (exports.InboundDepositIntakeStatus = {}));
+// Finished rows are kept a month for tracing a payment that went wrong, then
+// dropped. Rows that never finish have no finishedAt and so never expire, which is
+// the point: an unfinished deposit should stay visible until someone deals with it.
+const FINISHED_ROW_TTL_SECONDS = 30 * 24 * 60 * 60;
+const buildInboundDepositIntake = (mongoose) => {
+    if (mongoose.models.InboundDepositIntake) {
+        return mongoose.model("InboundDepositIntake");
+    }
+    const InboundDepositIntakeSchema = new mongoose.Schema({
+        provider: {
+            type: String,
+            required: true,
+            enum: Object.values(common_1.TreasuryProvider),
+        },
+        externalId: {
+            type: String,
+            required: true,
+        },
+        source: {
+            type: String,
+            required: true,
+            enum: ["webhook", "poller"],
+        },
+        externalEventId: {
+            type: String,
+        },
+        status: {
+            type: String,
+            required: true,
+            enum: Object.values(InboundDepositIntakeStatus),
+            default: InboundDepositIntakeStatus.Pending,
+        },
+        attempts: {
+            type: Number,
+            required: true,
+            default: 0,
+        },
+        outcome: {
+            type: String,
+        },
+        processed: {
+            type: Boolean,
+        },
+        lastError: {
+            type: String,
+        },
+        receivedAt: {
+            type: Date,
+            required: true,
+        },
+        startedAt: {
+            type: Date,
+        },
+        finishedAt: {
+            type: Date,
+        },
+    }, {
+        toJSON: {
+            transform(doc, ret) {
+                ret.id = ret._id.valueOf();
+                delete ret._id;
+                delete ret.__v;
+            },
+        },
+    });
+    // The dedup. A webhook delivered twice, or a deposit the poller sees after the
+    // webhook already recorded it, is an insert that fails rather than a second row.
+    // Scoped by provider so two providers' id schemes can never collide.
+    InboundDepositIntakeSchema.index({ provider: 1, externalId: 1 }, { unique: true });
+    // What each worker polls on: the oldest pending row for its provider first, and
+    // the processing rows whose startedAt says their owner died.
+    InboundDepositIntakeSchema.index({ provider: 1, status: 1, receivedAt: 1 });
+    InboundDepositIntakeSchema.index({ provider: 1, status: 1, startedAt: 1 });
+    InboundDepositIntakeSchema.index({ finishedAt: 1 }, { expireAfterSeconds: FINISHED_ROW_TTL_SECONDS });
+    InboundDepositIntakeSchema.statics.build = (attrs) => {
+        return new InboundDepositIntake(attrs);
+    };
+    const InboundDepositIntake = mongoose.model("InboundDepositIntake", InboundDepositIntakeSchema);
+    return InboundDepositIntake;
+};
+exports.buildInboundDepositIntake = buildInboundDepositIntake;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riocrypto/common-server",
-  "version": "1.0.2933",
+  "version": "1.0.2935",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",