@fabriktor/fx 0.0.129 → 0.0.131

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

@@ -86,11 +86,23 @@ export type CreateEntityPaymentOptions = {
 };
 export type CreatePaymentOptions = PaymentInsertOptions & MultiCreateCheckpoint;
 export type ReplacePaymentOptions = PaymentReplaceOptions;
-export type SearchPaymentsOptions = OwnerSearchOptions & {
+export type PaymentSearchFilters = {
     type?: Payment["type"] | Payment["type"][];
     kind?: Payment["kind"];
+    psp_actionable_status?: Payment["psp_actionable_status"][];
+    currency?: string;
 };
+export type SearchPaymentsOptions = SearchOptions & EntityPaymentScope & PaymentSearchFilters;
 export type SearchPaymentsPage = SearchPage<Payment>;
+export declare const PaymentDirection: {
+    readonly Outgoing: "outgoing";
+    readonly Incoming: "incoming";
+};
+export type PaymentDirection = (typeof PaymentDirection)[keyof typeof PaymentDirection];
+export type SearchPaymentHistoryOptions = OwnerSearchOptions & PaymentSearchFilters & {
+    direction: PaymentDirection;
+};
+export declare function isIncomingPayment(payment: Payment, viewerID: string): boolean;
 export type CreatePmtAccountOptions = PmtAccountInsertOptions;
 export type ContinuePmtAccountOnboardingOptions = PmtAccountOnboardingOptions;
 export type ContinuePmtAccountOnboardingResult = string;
@@ -182,6 +194,7 @@ export interface PaymentsFXOperator {
     createPayment(opts: CreatePaymentOptions): Promise<Payment>;
     replacePayment(opts: ReplacePaymentOptions): Promise<Payment>;
     searchPayments(opts: SearchPaymentsOptions): Promise<SearchPaymentsPage>;
+    searchPaymentHistory(opts: SearchPaymentHistoryOptions): Promise<SearchPaymentsPage>;
     createPmtAccount(opts: CreatePmtAccountOptions): Promise<PmtAccount>;
     continuePmtAccountOnboarding(opts: ContinuePmtAccountOnboardingOptions): Promise<ContinuePmtAccountOnboardingResult>;
     replacePmtAccount(opts: ReplacePmtAccountOptions): Promise<PmtAccount>;
@@ -228,6 +241,7 @@ export declare class PaymentsFX implements PaymentsFXOperator {
     createPayment(opts: CreatePaymentOptions): Promise<Payment>;
     replacePayment(opts: ReplacePaymentOptions): Promise<Payment>;
     searchPayments(opts: SearchPaymentsOptions): Promise<SearchPaymentsPage>;
+    searchPaymentHistory(opts: SearchPaymentHistoryOptions): Promise<SearchPaymentsPage>;
     createPmtAccount(opts: CreatePmtAccountOptions): Promise<PmtAccount>;
     continuePmtAccountOnboarding(opts: ContinuePmtAccountOnboardingOptions): Promise<ContinuePmtAccountOnboardingResult>;
     replacePmtAccount(opts: ReplacePmtAccountOptions): Promise<PmtAccount>;

package/dist/src/payments/payments.js

@@ -26,7 +26,7 @@ const msgPayableSourceMissing = "Payable entity source is unavailable.";
 const msgPayableBalanceChanged = "Payment balance changed or a payment is still pending. Refresh before paying.";
 const msgPaymentMethodRequired = "A payment method is required.";
 const msgPayableUnavailable = "This entity is not available for payment.";
-const msgPaymentScopeMissing = "Payment history requires a payer or recipient scope and an entity type.";
+const msgPaymentScopeMissing = "Payment history requires a payer or recipient scope.";
 const msgPaymentHistoryIncomplete = "Payment history response is incomplete.";
 const msgPaymentEntityInvalid = "Payment resolution requires a valid entity, currency, and amount.";
 const msgPaymentEntityConflict = "Payment resolution received conflicting entity amounts.";
@@ -63,6 +63,14 @@ const msgPublicAmountExceedsBalance = "Public payment amount cannot exceed the s
 export const PaymentsEvents = {
     Changed: createEvent(),
 };
+export const PaymentDirection = {
+    Outgoing: "outgoing",
+    Incoming: "incoming",
+};
+export function isIncomingPayment(payment, viewerID) {
+    return (payment.recipient_id === viewerID &&
+        (payment.is_external || payment.payer_id !== viewerID));
+}
 export const PmtAccountAccessStatus = {
     Missing: "missing",
     OnboardingRequired: "onboarding_required",
@@ -261,7 +269,6 @@ export class PaymentsFX {
                     ...opts,
                     page,
                     query: queryParams({
-                        is_banked: false,
                         is_problematic: false,
                     }),
                     search: (request) => this.payrolls.searchManyPayrolls(request),
@@ -391,12 +398,57 @@ export class PaymentsFX {
         return payment;
     }
     async searchPayments(opts) {
-        return await runOwnerSearch({
+        const owner_id = resolvedID(opts.owner_id);
+        const recipient_id = resolvedID(opts.recipient_id);
+        if (!owner_id && !recipient_id)
+            throw errValidation({ msg: msgPaymentScopeMissing });
+        return await runSearch({
             ...opts,
-            query: queryParams({ type: opts.type, kind: opts.kind }),
+            query: queryParams({
+                owner_id,
+                recipient_id,
+                type: opts.type,
+                kind: opts.kind,
+                psp_actionable_status: opts.psp_actionable_status,
+                currency: opts.currency?.trim().toUpperCase() || undefined,
+            }),
             search: (searchOpts) => this.payments.searchManyPayments(searchOpts),
         });
     }
+    async searchPaymentHistory(opts) {
+        const { owner_id, direction, ...searchOpts } = opts;
+        const viewer = resolvedID(owner_id);
+        if (!viewer)
+            throw errValidation({ msg: msgPaymentScopeMissing });
+        const incoming = direction === PaymentDirection.Incoming;
+        let page = opts.page;
+        while (true) {
+            opts.signal?.throwIfAborted();
+            const out = await this.searchPayments({
+                ...searchOpts,
+                ...(incoming ? { recipient_id: viewer } : { owner_id: viewer }),
+                page,
+            });
+            // Public bill payments belong to their recipient. Ownership alone does
+            // not make them outgoing; scan source pages without changing their order.
+            const results = out.results.filter((payment) => isIncomingPayment(payment, viewer) === incoming);
+            if (results.length || out.done) {
+                return {
+                    ...out,
+                    results,
+                    total_count: undefined,
+                    last_page: undefined,
+                };
+            }
+            if (out.next_page <= out.page) {
+                throw errResolveFailed({
+                    resource: resourcePayment,
+                    msg: msgPaymentHistoryIncomplete,
+                });
+            }
+            page = out.next_page;
+        }
+    }
     async createPmtAccount(opts) {
         const out = await this.payments.insertOnePmtAccount(opts);
         const id = requiredOperationID(out, msgCreatedPmtAccountIDMissing);
@@ -897,7 +949,6 @@ function payableEntity(record, type, ownerID) {
                 record.is_canceled
             : bill ||
                 record.owner_id !== ownerID ||
-                record.is_banked ||
                 record.is_problematic)) {
         throw errValidation({ msg: msgPayableUnavailable });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabriktor/fx",
-  "version": "0.0.129",
+  "version": "0.0.131",
   "description": "![Fabriktor Logo](./img/fabriktor-character.gif)",
   "type": "module",
   "exports": {