wedance-shared 1.0.211 → 1.0.213

package/dist/types/index.d.ts

@@ -15,4 +15,5 @@ export * from "./poll.js";
 export * from "./privateClass.js";
 export * from "./revenue.js";
 export * from "./school.js";
+export * from "./transaction.js";
 export * from "./festivals/index.js";

package/dist/types/index.js

@@ -16,6 +16,7 @@ export * from "./poll.js";
 export * from "./privateClass.js";
 export * from "./revenue.js";
 export * from "./school.js";
+export * from "./transaction.js";
 // Re-export from subdirectories
 export * from "./festivals/index.js";
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAE5B,gCAAgC;AAChC,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,mBAAmB,CAAC;AAClC,cAAc,cAAc,CAAC;AAC7B,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AAEjC,gCAAgC;AAChC,cAAc,sBAAsB,CAAC"}

package/dist/types/transaction.d.ts

@@ -0,0 +1,55 @@
+import type { Pass } from "./pass.js";
+/**
+ * A row in the money ledger. One per movement of money, never updated in place
+ * except to settle `status`. Every amount is in MINOR units (cents), in the
+ * transaction's own `currency`.
+ */
+export type TransactionType = "payment" | "refund";
+export type TransactionStatus = "pending" | "succeeded" | "failed";
+/** Where the record came from: Stripe's API, or a staff member keying it in. */
+export type TransactionSource = "stripe" | "manual";
+/**
+ * The pass payment methods plus `mobilepay`, which Stripe offers at checkout but
+ * `passes.payment_method` has never been able to represent.
+ */
+export type TransactionPaymentMethod = Pass["paymentMethod"] | "mobilepay";
+export interface Transaction {
+    id: string;
+    organizerId: string;
+    /** Firebase uid of the payer, when they have an account. */
+    userId: string | null;
+    studentId: string | null;
+    passId: string | null;
+    /**
+     * The payment a refund reverses. Always set on a refund, always null on a
+     * payment.
+     */
+    parentTransactionId: string | null;
+    recordedByStaffId: string | null;
+    /** Firebase uid of whoever recorded it, for admins who are not school staff. */
+    recordedByUserId: string | null;
+    type: TransactionType;
+    status: TransactionStatus;
+    /** MINOR units, always positive. Direction comes from `type`. */
+    amount: number;
+    /**
+     * On a payment, the WeDance fee charged. On a refund, the fee returned to the
+     * payer — 0 in both refund modes, because WeDance always keeps its fee.
+     */
+    applicationFeeAmount: number;
+    /** `amount - applicationFeeAmount`. Derived in the database. */
+    netAmount: number;
+    currency: string;
+    source: TransactionSource;
+    paymentMethod: TransactionPaymentMethod;
+    paymentIntentId: string | null;
+    refundId: string | null;
+    checkoutSessionId: string | null;
+    context: "event" | "school";
+    /** Written by the test-mode Stripe webhook. Excluded from revenue. */
+    test: boolean;
+    description: string | null;
+    metadata: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/types/transaction.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=transaction.js.map

package/dist/types/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../src/types/transaction.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wedance-shared",
-  "version": "1.0.211",
+  "version": "1.0.213",
   "description": "This repository contains shared TypeScript types and interfaces used across multiple WeDance applications:",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",