@fabriktor/fx 0.0.131 → 0.0.133

package/dist/src/payments/payments.d.ts

@@ -1,4 +1,4 @@
-import { PaymentEntityTypeBill, PaymentEntityTypePayroll, type Bill, type Payroll, PSPPaymentStatusPending, PSPPaymentStatusPartial, PSPPaymentStatusFull, type CreditLedgerEntry, type Payment, type PmtAccount, type PmtBankAccount, type PmtCard, type PmtCustomer, type PmtPublicSession, type PmtRefund } from "@fabriktor/schema";
+import { PaymentEntityTypeBill, PaymentEntityTypePayroll, type Bill, type Payroll, PSPPaymentStatusPending, PSPPaymentStatusPartial, PSPPaymentStatusFull, type CreditLedgerEntry, type Payment, type PmtAccount, type PmtBankAccount, type PmtCard, type PmtCustomer, type PmtPublicSession, type PmtRefund, type SortStripeBalanceResult } from "@fabriktor/schema";
 import { type PaymentsOperator, type BillableOperator, type PayrollsOperator } from "@fabriktor/client";
 import { type SearchOptions, type OwnerSearchOptions, type SearchPage } from "../core/search.js";
 import { EventBus } from "../core/events.js";
@@ -69,6 +69,7 @@ export type PayableEntityBalance = EntityPayments & {
 export type SearchPayableEntitiesOptions = SearchOptions & {
     owner_id: string;
     type: PayableEntityType;
+    include_pending?: boolean;
 };
 export type ResolvePayableEntityOptions = {
     owner_id: string;
@@ -149,6 +150,11 @@ export type GetPmtAccountAccessOptions = {
     owner_id: string;
     signal?: AbortSignal;
 };
+export type GetPayoutBalanceOptions = GetPmtAccountAccessOptions;
+export type PayoutBalance = {
+    access: PmtAccountAccess;
+    balance: SortStripeBalanceResult | null;
+};
 export declare function isPmtAccountReady(account: PmtAccount | null): boolean;
 export declare function currentPmtAccount(accounts: readonly PmtAccount[]): PmtAccount | null;
 export declare function pmtAccountAccess(account: PmtAccount | null): PmtAccountAccess;
@@ -200,6 +206,7 @@ export interface PaymentsFXOperator {
     replacePmtAccount(opts: ReplacePmtAccountOptions): Promise<PmtAccount>;
     searchPmtAccounts(opts: SearchPmtAccountsOptions): Promise<SearchPmtAccountsPage>;
     getPmtAccountAccess(opts: GetPmtAccountAccessOptions): Promise<PmtAccountAccess>;
+    getPayoutBalance(opts: GetPayoutBalanceOptions): Promise<PayoutBalance>;
     createPmtBankAccount(opts: CreatePmtBankAccountOptions): Promise<PmtBankAccount>;
     replacePmtBankAccount(opts: ReplacePmtBankAccountOptions): Promise<PmtBankAccount>;
     searchPmtBankAccounts(opts: SearchPmtBankAccountsOptions): Promise<SearchPmtBankAccountsPage>;
@@ -247,6 +254,7 @@ export declare class PaymentsFX implements PaymentsFXOperator {
     replacePmtAccount(opts: ReplacePmtAccountOptions): Promise<PmtAccount>;
     searchPmtAccounts(opts: SearchPmtAccountsOptions): Promise<SearchPmtAccountsPage>;
     getPmtAccountAccess(opts: GetPmtAccountAccessOptions): Promise<PmtAccountAccess>;
+    getPayoutBalance(opts: GetPayoutBalanceOptions): Promise<PayoutBalance>;
     createPmtBankAccount(opts: CreatePmtBankAccountOptions): Promise<PmtBankAccount>;
     replacePmtBankAccount(opts: ReplacePmtBankAccountOptions): Promise<PmtBankAccount>;
     searchPmtBankAccounts(opts: SearchPmtBankAccountsOptions): Promise<SearchPmtBankAccountsPage>;

package/dist/src/payments/payments.js

@@ -14,6 +14,7 @@ const publicAmountPattern = /^\d+$/;
 const resourcePayment = "payment";
 const resourcePmtAccount = "pmt_account";
 const resourcePmtAccountOnboarding = "pmt_account_onboarding";
+const resourcePayoutBalance = "payout_balance";
 const resourcePmtBankAccount = "pmt_bank_account";
 const resourcePmtCard = "pmt_card";
 const resourcePmtRefund = "pmt_refund";
@@ -37,6 +38,7 @@ const msgCreatedPaymentIDMissing = "Created payment response did not contain an
 const msgPaymentMissing = "Payment could not be resolved after the mutation.";
 const msgCreatedPmtAccountIDMissing = "Created payment account response did not contain an ID.";
 const msgPmtAccountMissing = "Payment account could not be resolved after the mutation.";
+const msgPayoutBalanceMissing = "Payout balance response is incomplete.";
 const msgPmtAccountOnboardingIDMissing = "Payment account onboarding requires a valid account ID.";
 const msgPmtAccountOnboardingLinkMissing = "Payment account onboarding did not return a link.";
 const msgCreatedPmtBankAccountIDMissing = "Created payment bank account response did not contain an ID.";
@@ -283,7 +285,8 @@ export class PaymentsFX {
                 entities,
                 signal: opts.signal,
             });
-            const results = balances.flatMap((balance, index) => balance.remaining_amount > 0 && !balance.has_pending
+            const results = balances.flatMap((balance, index) => balance.remaining_amount > 0 &&
+                (opts.include_pending || !balance.has_pending)
                 ? [{ ...balance, entity: entities[index] }]
                 : []);
             if (results.length || source.done) {
@@ -502,6 +505,31 @@ export class PaymentsFX {
             page = out.next_page;
         }
     }
+    async getPayoutBalance(opts) {
+        const access = await this.getPmtAccountAccess(opts);
+        opts.signal?.throwIfAborted();
+        const accountID = resolvedID(access.account?.psp_id);
+        if (accountID === undefined) {
+            return { access, balance: null };
+        }
+        // Outstanding funds remain visible when the account needs updated onboarding.
+        const out = await this.payments.balance({ psp_account_id: accountID }, { signal: opts.signal });
+        opts.signal?.throwIfAborted();
+        if (!out?.value) {
+            throw errResolveFailed({
+                resource: resourcePayoutBalance,
+                msg: msgPayoutBalanceMissing,
+            });
+        }
+        return {
+            access,
+            balance: {
+                available: out.value.available ?? [],
+                pending: out.value.pending ?? [],
+                instant_available: out.value.instant_available ?? [],
+            },
+        };
+    }
     async createPmtBankAccount(opts) {
         const out = await this.payments.insertOnePmtBankAccount(opts);
         const id = requiredOperationID(out, msgCreatedPmtBankAccountIDMissing);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabriktor/fx",
-  "version": "0.0.131",
+  "version": "0.0.133",
   "description": "![Fabriktor Logo](./img/fabriktor-character.gif)",
   "type": "module",
   "exports": {
@@ -17,7 +17,7 @@
     "typescript": "^6.0.3"
   },
   "dependencies": {
-    "@fabriktor/client": "0.0.92",
+    "@fabriktor/client": "0.0.93",
     "@fabriktor/fx": "0.0.94",
     "@fabriktor/schema": "0.0.66"
   }