@fabriktor/fx 0.0.62 → 0.0.63

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

@@ -8,6 +8,7 @@ type PaymentInsertOptions = Parameters<PaymentsOperator["insertOnePayment"]>[0];
 type PaymentReplaceOptions = Parameters<PaymentsOperator["replaceOnePayment"]>[0];
 type PmtAccountInsertOptions = Parameters<PaymentsOperator["insertOnePmtAccount"]>[0];
 type PmtAccountReplaceOptions = Parameters<PaymentsOperator["replaceOnePmtAccount"]>[0];
+type PmtAccountOnboardingOptions = Parameters<PaymentsOperator["onboarding"]>[0];
 type PmtBankAccountInsertOptions = Parameters<PaymentsOperator["insertOnePmtBankAccount"]>[0];
 type PmtBankAccountReplaceOptions = Parameters<PaymentsOperator["replaceOnePmtBankAccount"]>[0];
 type PmtCardInsertOptions = Parameters<PaymentsOperator["insertOnePmtCard"]>[0];
@@ -31,6 +32,8 @@ export type ReplacePaymentOptions = PaymentReplaceOptions;
 export type SearchPaymentsOptions = SearchPaymentRecordsOptions;
 export type SearchPaymentsPage = SearchPage<Payment>;
 export type CreatePmtAccountOptions = PmtAccountInsertOptions;
+export type ContinuePmtAccountOnboardingOptions = PmtAccountOnboardingOptions;
+export type ContinuePmtAccountOnboardingResult = string;
 export type ReplacePmtAccountOptions = PmtAccountReplaceOptions;
 export type SearchPmtAccountsOptions = SearchPaymentRecordsOptions;
 export type SearchPmtAccountsPage = SearchPage<PmtAccount>;
@@ -93,6 +96,7 @@ export interface PaymentsFXOperator {
     replacePayment(opts: ReplacePaymentOptions): Promise<Payment>;
     searchPayments(opts: SearchPaymentsOptions): Promise<SearchPaymentsPage>;
     createPmtAccount(opts: CreatePmtAccountOptions): Promise<PmtAccount>;
+    continuePmtAccountOnboarding(opts: ContinuePmtAccountOnboardingOptions): Promise<ContinuePmtAccountOnboardingResult>;
     replacePmtAccount(opts: ReplacePmtAccountOptions): Promise<PmtAccount>;
     searchPmtAccounts(opts: SearchPmtAccountsOptions): Promise<SearchPmtAccountsPage>;
     createPmtBankAccount(opts: CreatePmtBankAccountOptions): Promise<PmtBankAccount>;
@@ -129,6 +133,7 @@ export declare class PaymentsFX implements PaymentsFXOperator {
     replacePayment(opts: ReplacePaymentOptions): Promise<Payment>;
     searchPayments(opts: SearchPaymentsOptions): Promise<SearchPaymentsPage>;
     createPmtAccount(opts: CreatePmtAccountOptions): Promise<PmtAccount>;
+    continuePmtAccountOnboarding(opts: ContinuePmtAccountOnboardingOptions): Promise<ContinuePmtAccountOnboardingResult>;
     replacePmtAccount(opts: ReplacePmtAccountOptions): Promise<PmtAccount>;
     searchPmtAccounts(opts: SearchPmtAccountsOptions): Promise<SearchPmtAccountsPage>;
     createPmtBankAccount(opts: CreatePmtBankAccountOptions): Promise<PmtBankAccount>;

package/dist/src/payments/payments.js

@@ -10,6 +10,7 @@ import { runSearch } from "../core/search.js";
 const publicAmountPattern = /^\d+$/;
 const resourcePayment = "payment";
 const resourcePmtAccount = "pmt_account";
+const resourcePmtAccountOnboarding = "pmt_account_onboarding";
 const resourcePmtBankAccount = "pmt_bank_account";
 const resourcePmtCard = "pmt_card";
 const resourcePmtRefund = "pmt_refund";
@@ -22,6 +23,8 @@ 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 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.";
 const msgPmtBankAccountMissing = "Payment bank account could not be resolved after the mutation.";
 const msgCreatedPmtCardIDMissing = "Created payment card response did not contain an ID.";
@@ -81,6 +84,26 @@ export class PaymentsFX {
         const id = requiredOperationID(out, msgCreatedPmtAccountIDMissing);
         return await this.findPmtAccount(id);
     }
+    async continuePmtAccountOnboarding(opts) {
+        const id = resolvedID(opts.pmt_account_id);
+        if (id === undefined) {
+            throw errValidation({
+                field: "pmt_account_id",
+                msg: msgPmtAccountOnboardingIDMissing,
+            });
+        }
+        const out = await this.payments.onboarding({
+            pmt_account_id: id,
+        });
+        const accountLink = out.value?.account_link.trim() ?? "";
+        if (accountLink === "") {
+            throw errResolveFailed({
+                resource: resourcePmtAccountOnboarding,
+                msg: msgPmtAccountOnboardingLinkMissing,
+            });
+        }
+        return accountLink;
+    }
     async replacePmtAccount(opts) {
         await this.payments.replaceOnePmtAccount(opts);
         return await this.findPmtAccount(opts.id);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fabriktor/fx",
-  "version": "0.0.62",
+  "version": "0.0.63",
   "description": "![Fabriktor Logo](./img/fabriktor-character.gif)",
   "type": "module",
   "exports": {
@@ -17,7 +17,7 @@
     "typescript": "^6.0.3"
   },
   "dependencies": {
-    "@fabriktor/client": "0.0.58",
-    "@fabriktor/schema": "0.0.40"
+    "@fabriktor/client": "0.0.59",
+    "@fabriktor/schema": "0.0.41"
   }
 }