@fabriktor/fx 0.0.66 → 0.0.68

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

@@ -61,6 +61,24 @@ export type CreateCreditLedgerEntryOptions = CreditLedgerEntryInsertOptions;
 export type ReplaceCreditLedgerEntryOptions = CreditLedgerEntryReplaceOptions;
 export type SearchCreditLedgerOptions = SearchPaymentRecordsOptions;
 export type SearchCreditLedgerPage = SearchPage<CreditLedgerEntry>;
+export declare const PmtAccountAccessStatus: {
+    readonly Missing: "missing";
+    readonly OnboardingRequired: "onboarding_required";
+    readonly RequirementsDue: "requirements_due";
+    readonly Ready: "ready";
+};
+export type PmtAccountAccessStatus = (typeof PmtAccountAccessStatus)[keyof typeof PmtAccountAccessStatus];
+export type PmtAccountAccess = {
+    account: PmtAccount | null;
+    status: PmtAccountAccessStatus;
+    ready: boolean;
+};
+export type GetPmtAccountAccessOptions = {
+    owner_id: string;
+};
+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;
 export declare const PublicPaymentSessionStatus: {
     readonly NotFound: "not_found";
     readonly Ready: "ready";
@@ -99,6 +117,7 @@ export interface PaymentsFXOperator {
     continuePmtAccountOnboarding(opts: ContinuePmtAccountOnboardingOptions): Promise<ContinuePmtAccountOnboardingResult>;
     replacePmtAccount(opts: ReplacePmtAccountOptions): Promise<PmtAccount>;
     searchPmtAccounts(opts: SearchPmtAccountsOptions): Promise<SearchPmtAccountsPage>;
+    getPmtAccountAccess(opts: GetPmtAccountAccessOptions): Promise<PmtAccountAccess>;
     createPmtBankAccount(opts: CreatePmtBankAccountOptions): Promise<PmtBankAccount>;
     replacePmtBankAccount(opts: ReplacePmtBankAccountOptions): Promise<PmtBankAccount>;
     searchPmtBankAccounts(opts: SearchPmtBankAccountsOptions): Promise<SearchPmtBankAccountsPage>;
@@ -136,6 +155,7 @@ export declare class PaymentsFX implements PaymentsFXOperator {
     continuePmtAccountOnboarding(opts: ContinuePmtAccountOnboardingOptions): Promise<ContinuePmtAccountOnboardingResult>;
     replacePmtAccount(opts: ReplacePmtAccountOptions): Promise<PmtAccount>;
     searchPmtAccounts(opts: SearchPmtAccountsOptions): Promise<SearchPmtAccountsPage>;
+    getPmtAccountAccess(opts: GetPmtAccountAccessOptions): Promise<PmtAccountAccess>;
     createPmtBankAccount(opts: CreatePmtBankAccountOptions): Promise<PmtBankAccount>;
     replacePmtBankAccount(opts: ReplacePmtBankAccountOptions): Promise<PmtBankAccount>;
     searchPmtBankAccounts(opts: SearchPmtBankAccountsOptions): Promise<SearchPmtBankAccountsPage>;

package/dist/src/payments/payments.js

@@ -46,6 +46,47 @@ const msgPublicSessionConsumed = "Public payment session has already been consum
 const msgPublicAmountInvalid = "Public payment amount must be a positive integer.";
 const msgPublicBalanceInvalid = "Public payment session balance is invalid.";
 const msgPublicAmountExceedsBalance = "Public payment amount cannot exceed the session balance.";
+export const PmtAccountAccessStatus = {
+    Missing: "missing",
+    OnboardingRequired: "onboarding_required",
+    RequirementsDue: "requirements_due",
+    Ready: "ready",
+};
+export function isPmtAccountReady(account) {
+    return (account !== null &&
+        !account.psp_deactivate &&
+        account.psp_id.trim() !== "" &&
+        account.psp_id !== ZeroID &&
+        account.is_onboarded &&
+        !account.is_currently_due &&
+        !account.is_external_account_due);
+}
+export function currentPmtAccount(accounts) {
+    return (accounts.find(isPmtAccountReady) ??
+        accounts.find((account) => !account.psp_deactivate) ??
+        null);
+}
+export function pmtAccountAccess(account) {
+    if (account === null) {
+        return { account, status: PmtAccountAccessStatus.Missing, ready: false };
+    }
+    if (account.is_currently_due ||
+        account.is_external_account_due) {
+        return {
+            account,
+            status: PmtAccountAccessStatus.RequirementsDue,
+            ready: false,
+        };
+    }
+    if (!isPmtAccountReady(account)) {
+        return {
+            account,
+            status: PmtAccountAccessStatus.OnboardingRequired,
+            ready: false,
+        };
+    }
+    return { account, status: PmtAccountAccessStatus.Ready, ready: true };
+}
 export const PublicPaymentSessionStatus = {
     NotFound: "not_found",
     Ready: "ready",
@@ -119,6 +160,22 @@ export class PaymentsFX {
             per_page: opts.per_page,
         });
     }
+    async getPmtAccountAccess(opts) {
+        const accounts = [];
+        let page = 1;
+        while (true) {
+            const out = await this.searchPmtAccounts({
+                owner_id: opts.owner_id,
+                page,
+            });
+            accounts.push(...out.results);
+            const account = currentPmtAccount(accounts);
+            if (isPmtAccountReady(account) || out.done) {
+                return pmtAccountAccess(account);
+            }
+            page = out.next_page;
+        }
+    }
     async createPmtBankAccount(opts) {
         const out = await this.payments.insertOnePmtBankAccount(opts);
         const id = requiredOperationID(out, msgCreatedPmtBankAccountIDMissing);

package/dist/src/preferences/preferences.d.ts

@@ -1,5 +1,5 @@
 import type { PreferencesOperator } from "@fabriktor/client";
-import { type OperationResult, type PrefPayment, type PrefClient, type PrefEmployee, type PrefCompany, type PrefVisibility, type PrefLanguage, type PrefNotif, type PrefEmail, type PrefTutorial } from "@fabriktor/schema";
+import { type InPrefClient, type InPrefCompany, type InPrefEmployee, type OperationResult, type PrefPayment, type PrefClient, type PrefEmployee, type PrefCompany, type PrefVisibility, type PrefLanguage, type PrefNotif, type PrefEmail, type PrefTutorial } from "@fabriktor/schema";
 type PrefPaymentInsertOptions = Parameters<PreferencesOperator["insertOnePrefPayment"]>[0];
 type PrefPaymentReplaceOptions = Parameters<PreferencesOperator["replaceOnePrefPayment"]>[0];
 type PrefClientInsertOptions = Parameters<PreferencesOperator["insertOnePrefClient"]>[0];
@@ -36,6 +36,27 @@ export type CreatePrefEmailOptions = PrefEmailInsertOptions;
 export type ReplacePrefEmailOptions = PrefEmailReplaceOptions;
 export type CreatePrefTutorialOptions = PrefTutorialInsertOptions;
 export type ReplacePrefTutorialOptions = PrefTutorialReplaceOptions;
+export type GetPrefClientOptions = {
+    owner_id: string;
+};
+export type GetPrefEmployeeOptions = {
+    owner_id: string;
+};
+export type GetPrefCompanyOptions = {
+    owner_id: string;
+};
+export type SavePrefClientOptions = {
+    current: PrefClient;
+    in: InPrefClient;
+};
+export type SavePrefEmployeeOptions = {
+    current: PrefEmployee;
+    in: InPrefEmployee;
+};
+export type SavePrefCompanyOptions = {
+    current: PrefCompany;
+    in: InPrefCompany;
+};
 export type GetPrefLanguageOptions = {
     owner_id: string;
 };
@@ -54,10 +75,16 @@ export interface PreferencesFXOperator {
     replacePrefPayment(opts: ReplacePrefPaymentOptions): Promise<PrefPayment>;
     createPrefClient(opts: CreatePrefClientOptions): Promise<PrefClient>;
     replacePrefClient(opts: ReplacePrefClientOptions): Promise<PrefClient>;
+    getPrefClient(opts: GetPrefClientOptions): Promise<PrefClient>;
+    savePrefClient(opts: SavePrefClientOptions): Promise<PrefClient>;
     createPrefEmployee(opts: CreatePrefEmployeeOptions): Promise<PrefEmployee>;
     replacePrefEmployee(opts: ReplacePrefEmployeeOptions): Promise<PrefEmployee>;
+    getPrefEmployee(opts: GetPrefEmployeeOptions): Promise<PrefEmployee>;
+    savePrefEmployee(opts: SavePrefEmployeeOptions): Promise<PrefEmployee>;
     createPrefCompany(opts: CreatePrefCompanyOptions): Promise<PrefCompany>;
     replacePrefCompany(opts: ReplacePrefCompanyOptions): Promise<PrefCompany>;
+    getPrefCompany(opts: GetPrefCompanyOptions): Promise<PrefCompany>;
+    savePrefCompany(opts: SavePrefCompanyOptions): Promise<PrefCompany>;
     createPrefVisibility(opts: CreatePrefVisibilityOptions): Promise<PrefVisibility>;
     replacePrefVisibility(opts: ReplacePrefVisibilityOptions): Promise<PrefVisibility>;
     createPrefLanguage(opts: CreatePrefLanguageOptions): Promise<PrefLanguage>;
@@ -82,10 +109,16 @@ export declare class PreferencesFX implements PreferencesFXOperator {
     replacePrefPayment(opts: ReplacePrefPaymentOptions): Promise<PrefPayment>;
     createPrefClient(opts: CreatePrefClientOptions): Promise<PrefClient>;
     replacePrefClient(opts: ReplacePrefClientOptions): Promise<PrefClient>;
+    getPrefClient(opts: GetPrefClientOptions): Promise<PrefClient>;
+    savePrefClient(opts: SavePrefClientOptions): Promise<PrefClient>;
     createPrefEmployee(opts: CreatePrefEmployeeOptions): Promise<PrefEmployee>;
     replacePrefEmployee(opts: ReplacePrefEmployeeOptions): Promise<PrefEmployee>;
+    getPrefEmployee(opts: GetPrefEmployeeOptions): Promise<PrefEmployee>;
+    savePrefEmployee(opts: SavePrefEmployeeOptions): Promise<PrefEmployee>;
     createPrefCompany(opts: CreatePrefCompanyOptions): Promise<PrefCompany>;
     replacePrefCompany(opts: ReplacePrefCompanyOptions): Promise<PrefCompany>;
+    getPrefCompany(opts: GetPrefCompanyOptions): Promise<PrefCompany>;
+    savePrefCompany(opts: SavePrefCompanyOptions): Promise<PrefCompany>;
     createPrefVisibility(opts: CreatePrefVisibilityOptions): Promise<PrefVisibility>;
     replacePrefVisibility(opts: ReplacePrefVisibilityOptions): Promise<PrefVisibility>;
     createPrefLanguage(opts: CreatePrefLanguageOptions): Promise<PrefLanguage>;
@@ -99,6 +132,9 @@ export declare class PreferencesFX implements PreferencesFXOperator {
     createPrefTutorial(opts: CreatePrefTutorialOptions): Promise<PrefTutorial>;
     replacePrefTutorial(opts: ReplacePrefTutorialOptions): Promise<PrefTutorial>;
     ensurePrefLanguage(opts: EnsurePrefLanguageOptions): Promise<OperationResult>;
+    private queryPrefClient;
+    private queryPrefEmployee;
+    private queryPrefCompany;
     private queryPrefLanguage;
     private findPrefPayment;
     private findPrefClient;

package/dist/src/preferences/preferences.js

@@ -57,6 +57,19 @@ export class PreferencesFX {
         await this.preferences.replaceOnePrefClient(opts);
         return await this.findPrefClient(opts.id);
     }
+    async getPrefClient(opts) {
+        const pref = await this.queryPrefClient(opts.owner_id);
+        if (pref === undefined) {
+            throw errResolveFailed({ resource: resourcePrefClient, msg: msgPrefClientMissing });
+        }
+        return pref;
+    }
+    async savePrefClient(opts) {
+        const input = { ...opts.in, is_default: false };
+        return opts.current.is_default
+            ? await this.createPrefClient({ in: input })
+            : await this.replacePrefClient({ id: opts.current.id, in: input });
+    }
     async createPrefEmployee(opts) {
         const out = await this.preferences.insertOnePrefEmployee(opts);
         const id = requiredOperationID(out, msgCreatedPrefEmployeeIDMissing);
@@ -66,6 +79,22 @@ export class PreferencesFX {
         await this.preferences.replaceOnePrefEmployee(opts);
         return await this.findPrefEmployee(opts.id);
     }
+    async getPrefEmployee(opts) {
+        const pref = await this.queryPrefEmployee(opts.owner_id);
+        if (pref === undefined) {
+            throw errResolveFailed({
+                resource: resourcePrefEmployee,
+                msg: msgPrefEmployeeMissing,
+            });
+        }
+        return pref;
+    }
+    async savePrefEmployee(opts) {
+        const input = { ...opts.in, is_default: false };
+        return opts.current.is_default
+            ? await this.createPrefEmployee({ in: input })
+            : await this.replacePrefEmployee({ id: opts.current.id, in: input });
+    }
     async createPrefCompany(opts) {
         const out = await this.preferences.insertOnePrefCompany(opts);
         const id = requiredOperationID(out, msgCreatedPrefCompanyIDMissing);
@@ -75,6 +104,22 @@ export class PreferencesFX {
         await this.preferences.replaceOnePrefCompany(opts);
         return await this.findPrefCompany(opts.id);
     }
+    async getPrefCompany(opts) {
+        const pref = await this.queryPrefCompany(opts.owner_id);
+        if (pref === undefined) {
+            throw errResolveFailed({
+                resource: resourcePrefCompany,
+                msg: msgPrefCompanyMissing,
+            });
+        }
+        return pref;
+    }
+    async savePrefCompany(opts) {
+        const input = { ...opts.in, is_default: false };
+        return opts.current.is_default
+            ? await this.createPrefCompany({ in: input })
+            : await this.replacePrefCompany({ id: opts.current.id, in: input });
+    }
     async createPrefVisibility(opts) {
         const out = await this.preferences.insertOnePrefVisibility(opts);
         const id = requiredOperationID(out, msgCreatedPrefVisibilityIDMissing);
@@ -148,14 +193,14 @@ export class PreferencesFX {
         return await this.findPrefTutorial(opts.id);
     }
     async ensurePrefLanguage(opts) {
-        const pref = await this.queryPrefLanguage(opts.owner_id);
+        const pref = await this.getPrefLanguage({ owner_id: opts.owner_id });
         const input = {
             is_default: false,
             language: opts.language,
             country: opts.country,
-            speech_to_text_source_language: opts.speech_to_text_source_language ?? opts.language,
+            speech_to_text_source_language: opts.speech_to_text_source_language ?? pref.speech_to_text_source_language,
         };
-        if (!pref || pref.is_default) {
+        if (pref.is_default) {
             return await this.preferences.insertOnePrefLanguage({
                 in: input,
             });
@@ -174,6 +219,24 @@ export class PreferencesFX {
             in: input,
         });
     }
+    async queryPrefClient(owner_id) {
+        const out = await this.preferences.queryPrefClients({
+            query: queryParam(OwnerIDKey, owner_id),
+        });
+        return out.value?.[0];
+    }
+    async queryPrefEmployee(owner_id) {
+        const out = await this.preferences.queryPrefEmployees({
+            query: queryParam(OwnerIDKey, owner_id),
+        });
+        return out.value?.[0];
+    }
+    async queryPrefCompany(owner_id) {
+        const out = await this.preferences.queryPrefCompanies({
+            query: queryParam(OwnerIDKey, owner_id),
+        });
+        return out.value?.[0];
+    }
     async queryPrefLanguage(owner_id) {
         const out = await this.preferences.queryPrefLanguages({
             query: queryParam(OwnerIDKey, owner_id),

package/dist/src/privacy/privacy.d.ts

@@ -1,4 +1,4 @@
-import type { PrivacyOperator } from "@fabriktor/client";
+import { type PrivacyExport, type PrivacyOperator } from "@fabriktor/client";
 import { type AccountLock, type DeletionRequest } from "@fabriktor/schema";
 type DeletionRequestInsertOptions = Parameters<PrivacyOperator["insertOneDeletionRequest"]>[0];
 type DeletionRequestReplaceOptions = Parameters<PrivacyOperator["replaceOneDeletionRequest"]>[0];
@@ -11,8 +11,17 @@ export type ReplaceAccountLockOptions = AccountLockReplaceOptions;
 export type PrivacyFXOptions = {
     privacy: PrivacyOperator;
 };
-export type WatchAccountLockOptions = {
+export type GetAccountLockOptions = {
     owner_id: string;
+};
+export type RequestAccountDeletionOptions = CreateDeletionRequestOptions & {
+    owner_id: string;
+};
+export type AccountDeletion = {
+    request: DeletionRequest;
+    lock: AccountLock;
+};
+export type WatchAccountLockOptions = GetAccountLockOptions & {
     on_lock: (lock: AccountLock) => void;
     on_error?: (err: unknown) => void;
 };
@@ -20,18 +29,25 @@ export type StopAccountLockWatch = () => void;
 export interface PrivacyFXOperator {
     createDeletionRequest(opts: CreateDeletionRequestOptions): Promise<DeletionRequest>;
     replaceDeletionRequest(opts: ReplaceDeletionRequestOptions): Promise<DeletionRequest>;
+    requestAccountDeletion(opts: RequestAccountDeletionOptions): Promise<AccountDeletion>;
     createAccountLock(opts: CreateAccountLockOptions): Promise<AccountLock>;
     replaceAccountLock(opts: ReplaceAccountLockOptions): Promise<AccountLock>;
+    getAccountLock(opts: GetAccountLockOptions): Promise<AccountLock | undefined>;
     watchAccountLock(opts: WatchAccountLockOptions): Promise<StopAccountLockWatch>;
+    exportData(): Promise<PrivacyExport>;
 }
 export declare class PrivacyFX implements PrivacyFXOperator {
     private privacy;
     constructor(opts: PrivacyFXOptions);
     createDeletionRequest(opts: CreateDeletionRequestOptions): Promise<DeletionRequest>;
     replaceDeletionRequest(opts: ReplaceDeletionRequestOptions): Promise<DeletionRequest>;
+    requestAccountDeletion(opts: RequestAccountDeletionOptions): Promise<AccountDeletion>;
     createAccountLock(opts: CreateAccountLockOptions): Promise<AccountLock>;
     replaceAccountLock(opts: ReplaceAccountLockOptions): Promise<AccountLock>;
+    getAccountLock(opts: GetAccountLockOptions): Promise<AccountLock | undefined>;
     watchAccountLock(opts: WatchAccountLockOptions): Promise<StopAccountLockWatch>;
+    exportData(): Promise<PrivacyExport>;
+    private requiredOwnerID;
     private resolveDeletionRequest;
     private resolveAccountLock;
     private findOwnerAccountLock;

package/dist/src/privacy/privacy.js

@@ -3,8 +3,9 @@
 // Licensed under the Apache License, Version 2.0 (the "License"); you may
 // not use this file except in compliance with the License. You may obtain
 // a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
-import { ZeroID, } from "@fabriktor/schema";
-import { errRequired, errResolveFailed, } from "../core/err.js";
+import { queryParam, } from "@fabriktor/client";
+import { OwnerIDKey, ZeroID, } from "@fabriktor/schema";
+import { errRequired, errResolveFailed } from "../core/err.js";
 import { requiredOperationID } from "../core/id.js";
 const accountLockIntervalMs = 60 * 60 * 1000;
 const resourceDeletionRequest = "deletion_request";
@@ -14,6 +15,7 @@ const msgCreatedDeletionRequestIDMissing = "Created deletion request response di
 const msgDeletionRequestMissing = "Deletion request could not be resolved after the mutation.";
 const msgCreatedAccountLockIDMissing = "Created account lock response did not contain an ID.";
 const msgAccountLockMissing = "Account lock could not be resolved after the mutation.";
+const msgDeletionAccountLockMissing = "Account lock could not be resolved after the deletion request.";
 export class PrivacyFX {
     privacy;
     constructor(opts) {
@@ -28,6 +30,18 @@ export class PrivacyFX {
         await this.privacy.replaceOneDeletionRequest(opts);
         return await this.resolveDeletionRequest(opts.id);
     }
+    async requestAccountDeletion(opts) {
+        const owner_id = this.requiredOwnerID(opts.owner_id);
+        const request = await this.createDeletionRequest({ in: opts.in });
+        const lock = await this.findOwnerAccountLock(owner_id);
+        if (lock === undefined) {
+            throw errResolveFailed({
+                resource: resourceAccountLock,
+                msg: msgDeletionAccountLockMissing,
+            });
+        }
+        return { request, lock };
+    }
     async createAccountLock(opts) {
         const out = await this.privacy.insertOneAccountLock(opts);
         const id = requiredOperationID(out, msgCreatedAccountLockIDMissing);
@@ -37,14 +51,11 @@ export class PrivacyFX {
         await this.privacy.replaceOneAccountLock(opts);
         return await this.resolveAccountLock(opts.id);
     }
+    async getAccountLock(opts) {
+        return await this.findOwnerAccountLock(this.requiredOwnerID(opts.owner_id));
+    }
     async watchAccountLock(opts) {
-        const owner_id = opts.owner_id.trim();
-        if (owner_id === "" || owner_id === ZeroID) {
-            throw errRequired({
-                field: "owner_id",
-                msg: msgOwnerIDRequired,
-            });
-        }
+        const owner_id = this.requiredOwnerID(opts.owner_id);
         const initial_lock = await this.findOwnerAccountLock(owner_id);
         if (initial_lock !== undefined) {
             opts.on_lock(initial_lock);
@@ -89,10 +100,21 @@ export class PrivacyFX {
             }
         };
     }
+    async exportData() {
+        return await this.privacy.exportData();
+    }
+    requiredOwnerID(owner_id) {
+        const id = owner_id.trim();
+        if (id === "" || id === ZeroID) {
+            throw errRequired({
+                field: "owner_id",
+                msg: msgOwnerIDRequired,
+            });
+        }
+        return id;
+    }
     async resolveDeletionRequest(id) {
-        const out = await this.privacy.findOneDeletionRequest({
-            id,
-        });
+        const out = await this.privacy.findOneDeletionRequest({ id });
         const deletion_request = out.value;
         if (deletion_request === undefined) {
             throw errResolveFailed({
@@ -103,9 +125,7 @@ export class PrivacyFX {
         return deletion_request;
     }
     async resolveAccountLock(id) {
-        const out = await this.privacy.findOneAccountLock({
-            id,
-        });
+        const out = await this.privacy.findOneAccountLock({ id });
         const account_lock = out.value;
         if (account_lock === undefined) {
             throw errResolveFailed({
@@ -117,9 +137,7 @@ export class PrivacyFX {
     }
     async findOwnerAccountLock(owner_id) {
         const out = await this.privacy.queryAccountLocks({
-            query: {
-                owner_id,
-            },
+            query: queryParam(OwnerIDKey, owner_id),
         });
         return out.value?.[0];
     }

package/package.json

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