@capxul/sdk-react 4.20.0-beta.4 → 4.20.0-beta.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -0
- package/dist/{controllers-DXmEHrnw.mjs → controllers-L1UqwWS1.mjs} +5 -2
- package/dist/index.d.mts +99 -32
- package/dist/index.mjs +542 -198
- package/dist/testing/index.mjs +1 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -56,6 +56,8 @@ export function Providers({ children }: { children: React.ReactNode }) {
|
|
|
56
56
|
engine hook stays module-scoped. Both actor paths ship: a personal actor omits
|
|
57
57
|
`.Source` and spends the personal Account; an organization actor holds the
|
|
58
58
|
Budget the payment is drawn from and spends the treasury Account.
|
|
59
|
+
The submitted amount uses the selected registry AssetId and precision. This
|
|
60
|
+
includes 18-decimal WETH.
|
|
59
61
|
- `CapxulContacts` is the compound address-book component. One root owns the
|
|
60
62
|
book behaviour and draws nothing. The `.Summary`, `.List`, and `.Add` region
|
|
61
63
|
parts each hand the screen one finished slice, and a `.List` row carries its
|
|
@@ -75,6 +77,9 @@ export function Providers({ children }: { children: React.ReactNode }) {
|
|
|
75
77
|
and an amount the caller passed in `prefill` wins over it. Both engine hooks
|
|
76
78
|
stay module-scoped.
|
|
77
79
|
|
|
80
|
+
Activity groups use AssetId. The SDK resolves symbols and precision only for
|
|
81
|
+
display and CSV output. Assets with the same peg remain separate.
|
|
82
|
+
|
|
78
83
|
Payroll confirmation restores a saved run before enabling submission. An
|
|
79
84
|
uncertain run keeps its period, amounts, recipients, and SDK request key across
|
|
80
85
|
close/reopen and reload. Its fields remain fixed until Core confirms success or terminal closure.
|
|
@@ -98,6 +103,16 @@ The testing harness uses the real public provider and controllers and imports
|
|
|
98
103
|
its client factory only through `@capxul/sdk/testing`; it owns no renderer or
|
|
99
104
|
parallel identity state.
|
|
100
105
|
|
|
106
|
+
## Activity documents
|
|
107
|
+
|
|
108
|
+
`CapxulActivity.Detail` exposes `documents`, `selectedDocument`, and
|
|
109
|
+
`selectDocument({ documentHash, contentHash })`. Selection defaults to the
|
|
110
|
+
instruction, then the Movement Memo. `renderDocument()` returns safe semantic
|
|
111
|
+
HTML. `downloadDocument()` returns exact bytes for a deliberate download.
|
|
112
|
+
The host owns the panel and download action. Do not log these results.
|
|
113
|
+
Account or Organization changes clear selection and cancel pending reads.
|
|
114
|
+
These methods replace the receipt-only selector and action.
|
|
115
|
+
|
|
101
116
|
## Documentation
|
|
102
117
|
|
|
103
118
|
- [Maintainer context](./CONTEXT.md)
|
|
@@ -565,7 +565,7 @@ function CapxulIdentityProvider({ client, children }) {
|
|
|
565
565
|
if (!active) return;
|
|
566
566
|
state = runtime.snapshot();
|
|
567
567
|
}
|
|
568
|
-
if (state.phase === "authenticated" && state.profileComplete && state.account.at === "unknown") await runtime.send({ _tag: "EnsureAccount" }, { signal: controller.signal });
|
|
568
|
+
if (client._internal.accountSetup !== "explicit" && state.phase === "authenticated" && state.profileComplete && state.account.at === "unknown") await runtime.send({ _tag: "EnsureAccount" }, { signal: controller.signal });
|
|
569
569
|
}).catch(() => void 0);
|
|
570
570
|
return () => {
|
|
571
571
|
active = false;
|
|
@@ -720,6 +720,7 @@ function clearClientScopedQueries(queryClient, ownsQueryClient) {
|
|
|
720
720
|
}
|
|
721
721
|
function CapxulProvider(props) {
|
|
722
722
|
const { publishableKey, client: injectedClient, requirement, signer, observability, bootstrapBaseUrl, queryClient, children } = props;
|
|
723
|
+
const accountSetup = "accountSetup" in props ? props.accountSetup : void 0;
|
|
723
724
|
const [resolvedQueryClient] = useState(() => queryClient ?? makeDefaultQueryClient());
|
|
724
725
|
const [ownsQueryClient] = useState(() => queryClient === void 0);
|
|
725
726
|
const [attempt, setAttempt] = useState(0);
|
|
@@ -731,13 +732,15 @@ function CapxulProvider(props) {
|
|
|
731
732
|
...requirement === void 0 ? {} : { requirement },
|
|
732
733
|
...signer === void 0 ? {} : { signer },
|
|
733
734
|
...observability === void 0 ? {} : { observability },
|
|
734
|
-
...bootstrapBaseUrl === void 0 ? {} : { bootstrapBaseUrl }
|
|
735
|
+
...bootstrapBaseUrl === void 0 ? {} : { bootstrapBaseUrl },
|
|
736
|
+
...accountSetup === void 0 ? {} : { accountSetup }
|
|
735
737
|
}, [
|
|
736
738
|
publishableKey,
|
|
737
739
|
requirement,
|
|
738
740
|
signer,
|
|
739
741
|
observability,
|
|
740
742
|
bootstrapBaseUrl,
|
|
743
|
+
accountSetup,
|
|
741
744
|
attempt
|
|
742
745
|
]);
|
|
743
746
|
const [ownedBootstrap, setOwnedBootstrap] = useState(null);
|
package/dist/index.d.mts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { A as entered, C as CreateOrganizationFailure, D as OrganizationDetails, E as InvocationOptions, F as useCapxulTransitions, M as useCapxulDestination, N as useCapxulIdentity, O as ProfileDetails, P as useCapxulSend, S as CapxulSend, T as Destination, _ as ReadyDestination, a as AuthenticationSlots, b as Slot, c as ControllerAction, d as OnboardingControllerProps, f as OrgFailure, g as ProfileSlotProps, h as PendingAuthState, i as AuthenticatedState, j as useCapxulAuth, k as SendResult, l as FaultedState, m as OtpPendingState, n as AccountProgress, o as CapxulAuthenticationController, p as OrgProgress, r as ActionResult, s as CapxulOnboardingController, t as AccountFailure, u as NavigationAction, v as RetryAction, w as CreateOrganizationSubmission, x as CapxulAuth, y as SignedOutState } from "./controllers-BWmKRFy6.mjs";
|
|
2
2
|
import { ReactNode, RefCallback } from "react";
|
|
3
3
|
import { QueryClient, UseMutationResult, UseQueryResult } from "@tanstack/react-query";
|
|
4
|
-
import { Account, AccountRequirement, ActivityAnnotation, ActivityAnnotationInput, ActivityDetail, ActivityKind, ActivityListParams, ActivityPage, ActivityPhase, ActivityRange, ActivityReference, ActorReference, AddressBookEntry, BudgetId, CapxulClient, CapxulError, CapxulResult, CapxulSigner, CreateOrgInput, CurrentHoldings, HostObservability, IdentityDestination, IdentityState, InviteMemberInput, MemberView, Money, MoneyParseErrorReason, OrgId, OrgView, OrganizationPaymentBatchInput, OrganizationPaymentInput, PartyId, Payment, PaymentDirection, PaymentDocumentRef, PaymentDocumentRender, PaymentStatus, PaymentTiming, PaymentType, PaymentsPayInput, PayrollGroupId, PayrollGroupInput, PayrollRunId, PayrollRunStatus, Permission, PermissionMethods, PermissionReadResult, Profile, RoleView, SubmittedPermissionExecution, isClaimed, isRestoring } from "@capxul/sdk";
|
|
4
|
+
import { Account, AccountRequirement, ActivityAnnotation, ActivityAnnotationInput, ActivityDetail, ActivityKind, ActivityListParams, ActivityPage, ActivityPhase, ActivityRange, ActivityReference, ActivitySummaryTotal, ActorReference, AddressBookEntry, AssetAmount, AssetId, BudgetId, CapxulClient, CapxulError, CapxulResult, CapxulSigner, CreateOrgInput, CurrentHoldings, HostObservability, IdentityDestination, IdentityState, InviteMemberInput, MemberView, Money, MoneyParseErrorReason, OrgId, OrgView, OrganizationAccess, OrganizationPaymentBatchInput, OrganizationPaymentInput, PartyId, Payment, PaymentDirection, PaymentDocumentDownload, PaymentDocumentReadRef, PaymentDocumentRef, PaymentDocumentRender, PaymentStatus, PaymentTiming, PaymentType, PaymentsPayInput, PayrollGroupId, PayrollGroupInput, PayrollRunId, PayrollRunStatus, Permission, PermissionMethods, PermissionReadResult, Profile, RoleView, SubmittedPermissionExecution, isClaimed, isRestoring } from "@capxul/sdk";
|
|
5
5
|
//#region src/provider.d.ts
|
|
6
6
|
type CapxulProviderSharedProps = {
|
|
7
7
|
/** Bring your own QueryClient; otherwise the provider creates one. */
|
|
@@ -28,6 +28,11 @@ type CapxulProviderPublishableKeyProps = CapxulProviderSharedProps & {
|
|
|
28
28
|
* route cross-origin for the publishable key's allowed origins.
|
|
29
29
|
*/
|
|
30
30
|
readonly bootstrapBaseUrl?: string;
|
|
31
|
+
/**
|
|
32
|
+
* AUTH A3. Pass `"explicit"` on `/connect` so restore and OTP do not write
|
|
33
|
+
* Profile, Account, or invitations. Default automatic.
|
|
34
|
+
*/
|
|
35
|
+
readonly accountSetup?: "automatic" | "explicit";
|
|
31
36
|
};
|
|
32
37
|
/**
|
|
33
38
|
* Node / server / test path — a pre-built client is supplied; lifecycle stays
|
|
@@ -77,7 +82,7 @@ declare function useCapxulAccountBalance(options?: UseCapxulAccountBalanceOption
|
|
|
77
82
|
//#region src/hooks/use-capxul-account-fund.d.ts
|
|
78
83
|
type UseCapxulAccountFundReturn = UseMutationResult<{
|
|
79
84
|
readonly txHash: string;
|
|
80
|
-
}, CapxulError,
|
|
85
|
+
}, CapxulError, AssetAmount>;
|
|
81
86
|
declare function useCapxulAccountFund(): UseCapxulAccountFundReturn;
|
|
82
87
|
//#endregion
|
|
83
88
|
//#region src/hooks/use-capxul-money.d.ts
|
|
@@ -143,7 +148,7 @@ declare function useCapxulHoldings(params?: UseCapxulHoldingsParams): UseQueryRe
|
|
|
143
148
|
* List the Organizations that the current user can access. Binds directly to
|
|
144
149
|
* the locked `capxul.orgs()` SDK method.
|
|
145
150
|
*/
|
|
146
|
-
type UseCapxulOrgsReturn = UseQueryResult<readonly
|
|
151
|
+
type UseCapxulOrgsReturn = UseQueryResult<readonly OrganizationAccess[], CapxulError>;
|
|
147
152
|
type UseCapxulOrgsOptions = {
|
|
148
153
|
/**
|
|
149
154
|
* Gate the query on auth readiness. `client.orgs()` is a session-scoped
|
|
@@ -456,7 +461,7 @@ interface CapxulContactsProps {
|
|
|
456
461
|
readonly onFailed: (error: CapxulError, options?: InvocationOptions) => void;
|
|
457
462
|
readonly children: ReactNode;
|
|
458
463
|
}
|
|
459
|
-
declare function Root$
|
|
464
|
+
declare function Root$7({ actor, onAdded, onFailed, children }: CapxulContactsProps): import("react/jsx-runtime").JSX.Element;
|
|
460
465
|
declare function Summary$3({ children }: {
|
|
461
466
|
readonly children: (slice: ContactsSummarySlice) => ReactNode;
|
|
462
467
|
}): import("react/jsx-runtime").JSX.Element;
|
|
@@ -467,7 +472,7 @@ declare function Add({ children }: {
|
|
|
467
472
|
readonly children: (slice: ContactsAddSlice) => ReactNode;
|
|
468
473
|
}): import("react/jsx-runtime").JSX.Element;
|
|
469
474
|
/** The compound shape the app's own design system already uses (`StatusTabs`). */
|
|
470
|
-
declare const CapxulContacts: typeof Root$
|
|
475
|
+
declare const CapxulContacts: typeof Root$7 & {
|
|
471
476
|
Summary: typeof Summary$3;
|
|
472
477
|
List: typeof List;
|
|
473
478
|
Add: typeof Add;
|
|
@@ -520,8 +525,8 @@ type ActivityRow = {
|
|
|
520
525
|
*/
|
|
521
526
|
type SummaryWindow = "all" | "last30days" | ActivityRange;
|
|
522
527
|
/**
|
|
523
|
-
* Finished
|
|
524
|
-
*
|
|
528
|
+
* Finished valuation strings in the display currency. Unrated assets remain
|
|
529
|
+
* separate. All four strings are `null` and `count` is `0`
|
|
525
530
|
* when the window holds no activity — we say there is nothing, the app says it
|
|
526
531
|
* in its own words.
|
|
527
532
|
*/
|
|
@@ -532,6 +537,7 @@ interface ActivitySummarySlice {
|
|
|
532
537
|
readonly moneyOut: string | null;
|
|
533
538
|
readonly net: string | null;
|
|
534
539
|
readonly pending: string | null;
|
|
540
|
+
readonly unrated: readonly ActivitySummaryTotal[];
|
|
535
541
|
/** A count is not money, so it is not formatted. */
|
|
536
542
|
readonly count: number;
|
|
537
543
|
readonly isLoading: boolean;
|
|
@@ -595,9 +601,12 @@ interface ActivityLoadMoreSlice {
|
|
|
595
601
|
interface ActivityDetailSlice {
|
|
596
602
|
/** Current Payment state from the existing detail read; absent for Movements. */
|
|
597
603
|
readonly payment?: Pick<Payment, "status" | "execution">;
|
|
598
|
-
|
|
599
|
-
readonly
|
|
600
|
-
readonly
|
|
604
|
+
readonly documents: readonly PaymentDocumentRef[];
|
|
605
|
+
readonly selectedDocument: PaymentDocumentRef | null;
|
|
606
|
+
readonly selectDocument: (ref: PaymentDocumentReadRef) => void;
|
|
607
|
+
readonly renderDocument: () => Promise<PaymentDocumentRender>;
|
|
608
|
+
/** Return exact bytes on a deliberate action. The host owns the download URL. */
|
|
609
|
+
readonly downloadDocument: () => Promise<PaymentDocumentDownload>;
|
|
601
610
|
readonly isOpeningDocument: boolean;
|
|
602
611
|
readonly memo: string;
|
|
603
612
|
readonly setMemo: (text: string) => void;
|
|
@@ -637,7 +646,7 @@ interface CapxulActivityProps {
|
|
|
637
646
|
readonly pageSize?: number;
|
|
638
647
|
readonly children: ReactNode;
|
|
639
648
|
}
|
|
640
|
-
declare function Root$
|
|
649
|
+
declare function Root$6({ actor, pageSize, children }: CapxulActivityProps): import("react/jsx-runtime").JSX.Element;
|
|
641
650
|
/**
|
|
642
651
|
* The one part that holds a query rather than reading the engine's: it takes a
|
|
643
652
|
* `window` prop, and two placements can ask for different windows, so a single
|
|
@@ -668,7 +677,7 @@ declare function Export({ children }: {
|
|
|
668
677
|
readonly children: (slice: ActivityExportSlice) => ReactNode;
|
|
669
678
|
}): import("react/jsx-runtime").JSX.Element;
|
|
670
679
|
/** The compound shape the app's own design system already uses (`StatusTabs`). */
|
|
671
|
-
declare const CapxulActivity: typeof Root$
|
|
680
|
+
declare const CapxulActivity: typeof Root$6 & {
|
|
672
681
|
Summary: typeof Summary$2;
|
|
673
682
|
Filters: typeof Filters;
|
|
674
683
|
Search: typeof Search;
|
|
@@ -703,7 +712,7 @@ type SentPayment = {
|
|
|
703
712
|
/** The backend payment row. */
|
|
704
713
|
readonly payment: Payment;
|
|
705
714
|
/** What we parsed and sent — `.value` is the comma-stripped major-unit string. */
|
|
706
|
-
readonly amount:
|
|
715
|
+
readonly amount: AssetAmount;
|
|
707
716
|
/** The trimmed text the person typed — the app's success toast interpolates it. */
|
|
708
717
|
readonly recipient: string;
|
|
709
718
|
};
|
|
@@ -711,7 +720,7 @@ type SentPayment = {
|
|
|
711
720
|
* Refusal CODES, never sentences (#1447 ruling 8). The app maps each code to
|
|
712
721
|
* the words it already prints; no English refusal string ships from here.
|
|
713
722
|
*/
|
|
714
|
-
type CapxulSendMoneyBlockedReason = "signer-not-ready" | "amount-invalid" | "recipient-unresolved" | "no-source" | "no-asset";
|
|
723
|
+
type CapxulSendMoneyBlockedReason = "signer-not-ready" | "amount-invalid" | "recipient-unresolved" | "no-source" | "no-asset" | "asset-unnamed";
|
|
715
724
|
/**
|
|
716
725
|
* One Budget the member can spend from — the id the payment carries, and
|
|
717
726
|
* nothing else.
|
|
@@ -736,7 +745,7 @@ interface SendMoneySourceSlice {
|
|
|
736
745
|
readonly isPending: boolean;
|
|
737
746
|
}
|
|
738
747
|
interface SendMoneyAssetOption {
|
|
739
|
-
readonly id:
|
|
748
|
+
readonly id: AssetId;
|
|
740
749
|
readonly symbol: string;
|
|
741
750
|
readonly availableDisplay: string;
|
|
742
751
|
}
|
|
@@ -771,7 +780,7 @@ interface CapxulSendMoneyProps {
|
|
|
771
780
|
readonly onFailed: (error: CapxulError) => void;
|
|
772
781
|
readonly children: ReactNode;
|
|
773
782
|
}
|
|
774
|
-
declare function Root$
|
|
783
|
+
declare function Root$5({ actor, onSent, onFailed, children }: CapxulSendMoneyProps): import("react/jsx-runtime").JSX.Element;
|
|
775
784
|
declare function Source({ children }: {
|
|
776
785
|
readonly children: (slice: SendMoneySourceSlice) => ReactNode;
|
|
777
786
|
}): import("react/jsx-runtime").JSX.Element;
|
|
@@ -788,7 +797,7 @@ declare function Actions$1({ children }: {
|
|
|
788
797
|
readonly children: (slice: SendMoneyActionsSlice) => ReactNode;
|
|
789
798
|
}): import("react/jsx-runtime").JSX.Element;
|
|
790
799
|
/** The compound shape the app's own design system already uses (`StatusTabs`). */
|
|
791
|
-
declare const CapxulSendMoney: typeof Root$
|
|
800
|
+
declare const CapxulSendMoney: typeof Root$5 & {
|
|
792
801
|
Source: typeof Source;
|
|
793
802
|
Asset: typeof Asset$1;
|
|
794
803
|
Amount: typeof Amount;
|
|
@@ -820,7 +829,7 @@ interface CapxulOrgMemberProps {
|
|
|
820
829
|
readonly orgId: OrgId | string | undefined;
|
|
821
830
|
readonly children: ReactNode;
|
|
822
831
|
}
|
|
823
|
-
declare function Root$
|
|
832
|
+
declare function Root$4({ orgId, children }: CapxulOrgMemberProps): import("react/jsx-runtime").JSX.Element;
|
|
824
833
|
/**
|
|
825
834
|
* One part serves all four denial idioms the app already uses: disabled with no
|
|
826
835
|
* explanation, disabled plus a native `title`, a whole-surface swap, and
|
|
@@ -835,7 +844,7 @@ declare function Standing({ children }: {
|
|
|
835
844
|
readonly children: (slice: OrgMemberStandingSlice) => ReactNode;
|
|
836
845
|
}): import("react/jsx-runtime").JSX.Element;
|
|
837
846
|
/** The compound shape the app's own design system already uses (`StatusTabs`). */
|
|
838
|
-
declare const CapxulOrgMember: typeof Root$
|
|
847
|
+
declare const CapxulOrgMember: typeof Root$4 & {
|
|
839
848
|
Can: typeof Can;
|
|
840
849
|
Standing: typeof Standing;
|
|
841
850
|
};
|
|
@@ -871,9 +880,9 @@ interface CapxulDashboardAccessProps {
|
|
|
871
880
|
readonly scope: DashboardScope;
|
|
872
881
|
readonly children: ReactNode;
|
|
873
882
|
}
|
|
874
|
-
declare function Root$
|
|
883
|
+
declare function Root$3({ scope, children }: CapxulDashboardAccessProps): import("react/jsx-runtime").JSX.Element;
|
|
875
884
|
/** Hands nothing — today's app renders `null` here, exactly as it does now. */
|
|
876
|
-
declare function Checking({ children }: {
|
|
885
|
+
declare function Checking$1({ children }: {
|
|
877
886
|
readonly children?: ReactNode;
|
|
878
887
|
}): import("react/jsx-runtime").JSX.Element | null;
|
|
879
888
|
declare function DashboardError({ children }: {
|
|
@@ -892,8 +901,8 @@ declare function Granted({ children }: {
|
|
|
892
901
|
readonly children?: ReactNode;
|
|
893
902
|
}): import("react/jsx-runtime").JSX.Element | null;
|
|
894
903
|
/** The compound shape the app's own design system already uses (`StatusTabs`). */
|
|
895
|
-
declare const CapxulDashboardAccess: typeof Root$
|
|
896
|
-
Checking: typeof Checking;
|
|
904
|
+
declare const CapxulDashboardAccess: typeof Root$3 & {
|
|
905
|
+
Checking: typeof Checking$1;
|
|
897
906
|
Error: typeof DashboardError;
|
|
898
907
|
Redirect: typeof Redirect;
|
|
899
908
|
Granted: typeof Granted;
|
|
@@ -941,7 +950,7 @@ interface CapxulPayrollProps {
|
|
|
941
950
|
readonly orgId: OrgId | undefined;
|
|
942
951
|
readonly children: ReactNode;
|
|
943
952
|
}
|
|
944
|
-
declare function Root$
|
|
953
|
+
declare function Root$2({ orgId, children }: CapxulPayrollProps): import("react/jsx-runtime").JSX.Element;
|
|
945
954
|
declare function Summary$1({ children }: {
|
|
946
955
|
readonly children: (slice: PayrollSummarySlice) => ReactNode;
|
|
947
956
|
}): import("react/jsx-runtime").JSX.Element;
|
|
@@ -953,7 +962,7 @@ declare function Groups({ children }: {
|
|
|
953
962
|
* There is NO `.Runs` part (ruling Q6): no shipped region has the right shape
|
|
954
963
|
* for a run list, and a part without a production caller may not ship.
|
|
955
964
|
*/
|
|
956
|
-
declare const CapxulPayroll: typeof Root$
|
|
965
|
+
declare const CapxulPayroll: typeof Root$2 & {
|
|
957
966
|
Summary: typeof Summary$1;
|
|
958
967
|
Groups: typeof Groups;
|
|
959
968
|
};
|
|
@@ -975,10 +984,10 @@ interface PayrollRecipientOption {
|
|
|
975
984
|
//#region src/headless/payroll/use-payroll-run.d.ts
|
|
976
985
|
/**
|
|
977
986
|
* Refusal CODES, never sentences (ADR-0023 R1). `blockedReason` names the FIRST
|
|
978
|
-
* false fact in the fixed order
|
|
979
|
-
*
|
|
987
|
+
* false fact in the fixed order below, so the same composer state always
|
|
988
|
+
* yields the same code.
|
|
980
989
|
*/
|
|
981
|
-
type CapxulPayrollRunBlockedReason = "signer-not-ready" | "no-source" | "ambiguous-source" | "no-asset" | "no-recipients" | "amount-invalid" | "insufficient-funds";
|
|
990
|
+
type CapxulPayrollRunBlockedReason = "signer-not-ready" | "no-source" | "ambiguous-source" | "no-asset" | "no-recipients" | "amount-invalid" | "insufficient-funds" | "asset-unnamed";
|
|
982
991
|
interface PayrollRunGroupOption {
|
|
983
992
|
readonly id: PayrollGroupId;
|
|
984
993
|
readonly label: string;
|
|
@@ -1005,7 +1014,7 @@ interface PayrollRunAmountEntry {
|
|
|
1005
1014
|
/** True while the value is one we seeded and the employer has not edited. */
|
|
1006
1015
|
readonly prefilled: boolean;
|
|
1007
1016
|
/** The treasury asset's currency. Rows stay absent until this value exists. */
|
|
1008
|
-
readonly currency:
|
|
1017
|
+
readonly currency: string;
|
|
1009
1018
|
}
|
|
1010
1019
|
interface PayrollRunAmountsSlice {
|
|
1011
1020
|
readonly entries: readonly PayrollRunAmountEntry[];
|
|
@@ -1058,7 +1067,7 @@ interface CapxulPayrollRunProps {
|
|
|
1058
1067
|
readonly onFailed: (error: CapxulError) => void;
|
|
1059
1068
|
readonly children: ReactNode;
|
|
1060
1069
|
}
|
|
1061
|
-
declare function Root({ orgId, prefill, onRun, onFailed, children }: CapxulPayrollRunProps): import("react/jsx-runtime").JSX.Element;
|
|
1070
|
+
declare function Root$1({ orgId, prefill, onRun, onFailed, children }: CapxulPayrollRunProps): import("react/jsx-runtime").JSX.Element;
|
|
1062
1071
|
declare function Recipients({ children }: {
|
|
1063
1072
|
readonly children: (slice: PayrollRunRecipientsSlice) => ReactNode;
|
|
1064
1073
|
}): import("react/jsx-runtime").JSX.Element;
|
|
@@ -1075,7 +1084,7 @@ declare function Actions({ children }: {
|
|
|
1075
1084
|
readonly children: (slice: PayrollRunActionsSlice) => ReactNode;
|
|
1076
1085
|
}): import("react/jsx-runtime").JSX.Element;
|
|
1077
1086
|
/** The compound shape the app's own design system already uses (`StatusTabs`). */
|
|
1078
|
-
declare const CapxulPayrollRun: typeof Root & {
|
|
1087
|
+
declare const CapxulPayrollRun: typeof Root$1 & {
|
|
1079
1088
|
Recipients: typeof Recipients;
|
|
1080
1089
|
Amounts: typeof Amounts;
|
|
1081
1090
|
Asset: typeof Asset;
|
|
@@ -1083,6 +1092,64 @@ declare const CapxulPayrollRun: typeof Root & {
|
|
|
1083
1092
|
Actions: typeof Actions;
|
|
1084
1093
|
};
|
|
1085
1094
|
//#endregion
|
|
1095
|
+
//#region src/headless/client-connection/use-client-connection.d.ts
|
|
1096
|
+
interface OtpSlice {
|
|
1097
|
+
readonly email: string;
|
|
1098
|
+
readonly pending: boolean;
|
|
1099
|
+
readonly canResend: boolean;
|
|
1100
|
+
readonly verifyCode: (code: string) => Promise<void>;
|
|
1101
|
+
readonly resend: () => Promise<void>;
|
|
1102
|
+
}
|
|
1103
|
+
interface ConsentSlice {
|
|
1104
|
+
readonly verifiedEmail: string;
|
|
1105
|
+
readonly clientLabel: string;
|
|
1106
|
+
readonly scopeCodes: readonly string[];
|
|
1107
|
+
readonly purpose: "login" | "signup";
|
|
1108
|
+
readonly setupState: "not_required" | "new" | "resumable";
|
|
1109
|
+
readonly pending: boolean;
|
|
1110
|
+
readonly accept: () => Promise<void>;
|
|
1111
|
+
readonly cancel: () => Promise<void>;
|
|
1112
|
+
}
|
|
1113
|
+
interface CompleteSlice {
|
|
1114
|
+
readonly outcome: "connected";
|
|
1115
|
+
}
|
|
1116
|
+
interface FailureSlice {
|
|
1117
|
+
readonly code: string;
|
|
1118
|
+
readonly field?: string;
|
|
1119
|
+
readonly retry: () => Promise<void>;
|
|
1120
|
+
readonly cancel: () => Promise<void>;
|
|
1121
|
+
}
|
|
1122
|
+
//#endregion
|
|
1123
|
+
//#region src/headless/client-connection/client-connection.d.ts
|
|
1124
|
+
interface CapxulClientConnectionProps {
|
|
1125
|
+
readonly client: CapxulClient;
|
|
1126
|
+
readonly requestId: string;
|
|
1127
|
+
readonly children: ReactNode;
|
|
1128
|
+
}
|
|
1129
|
+
declare function Root({ client, requestId, children }: CapxulClientConnectionProps): import("react/jsx-runtime").JSX.Element;
|
|
1130
|
+
declare function Checking({ children }: {
|
|
1131
|
+
readonly children: ReactNode;
|
|
1132
|
+
}): import("react/jsx-runtime").JSX.Element | null;
|
|
1133
|
+
declare function Otp({ children }: {
|
|
1134
|
+
readonly children: (slice: OtpSlice) => ReactNode;
|
|
1135
|
+
}): import("react/jsx-runtime").JSX.Element | null;
|
|
1136
|
+
declare function Consent({ children }: {
|
|
1137
|
+
readonly children: (slice: ConsentSlice) => ReactNode;
|
|
1138
|
+
}): import("react/jsx-runtime").JSX.Element | null;
|
|
1139
|
+
declare function Complete({ children }: {
|
|
1140
|
+
readonly children: (slice: CompleteSlice) => ReactNode;
|
|
1141
|
+
}): import("react/jsx-runtime").JSX.Element | null;
|
|
1142
|
+
declare function Failure({ children }: {
|
|
1143
|
+
readonly children: (slice: FailureSlice) => ReactNode;
|
|
1144
|
+
}): import("react/jsx-runtime").JSX.Element | null;
|
|
1145
|
+
declare const CapxulClientConnection: typeof Root & {
|
|
1146
|
+
Checking: typeof Checking;
|
|
1147
|
+
Otp: typeof Otp;
|
|
1148
|
+
Consent: typeof Consent;
|
|
1149
|
+
Complete: typeof Complete;
|
|
1150
|
+
Failure: typeof Failure;
|
|
1151
|
+
};
|
|
1152
|
+
//#endregion
|
|
1086
1153
|
//#region src/internal/reactivity-keys.d.ts
|
|
1087
1154
|
declare const capxulKeys: {
|
|
1088
1155
|
root: readonly ["capxul"];
|
|
@@ -1113,4 +1180,4 @@ declare const capxulKeys: {
|
|
|
1113
1180
|
payment: (paymentId: string | undefined) => readonly ["capxul", "payments", string];
|
|
1114
1181
|
};
|
|
1115
1182
|
//#endregion
|
|
1116
|
-
export { type AccountFailure, type AccountProgress, type ActionResult, type ActivityDetailSlice, type ActivityExportSlice, type ActivityFilterValues, type ActivityFiltersSlice, type ActivityLoadMoreSlice, type ActivityReceipt, type ActivityRow, type ActivityRowsSlice, type ActivitySearchSlice, type ActivitySummarySlice, type AuthenticatedState, type AuthenticationSlots, type CanReason, CapxulActivity, type CapxulActivityProps, type CapxulAuth, CapxulAuthenticationController, type CapxulBootstrapState, type CapxulBootstrapStatus, CapxulContacts, type CapxulContactsProps, CapxulDashboardAccess, type CapxulDashboardAccessProps, CapxulOnboardingController, CapxulOrgMember, type CapxulOrgMemberProps, CapxulPayroll, type CapxulPayrollProps, CapxulPayrollRun, type CapxulPayrollRunBlockedReason, type CapxulPayrollRunProps, CapxulProvider, type CapxulProviderProps, type CapxulSend, CapxulSendMoney, type CapxulSendMoneyBlockedReason, type CapxulSendMoneyProps, type Contact, type ContactRelationship, type ContactRow, type ContactsActor, type ContactsAddBlockedReason, type ContactsAddError, type ContactsAddSlice, type ContactsListOptions, type ContactsListSlice, type ContactsRefusal, type ContactsSummarySlice, type ControllerAction, type CreateOrganizationFailure, type CreateOrganizationSubmission, type CsvExport, type DashboardAccessErrorSlice, type DashboardAccessPhase, type DashboardAccessProbe, type DashboardAccessRedirectSlice, type DashboardScope, type Destination, type FaultedState, type HandleAvailability, type ImageUploadInput, type ImageUploadTarget, type InvocationOptions, type NavigationAction, type OnboardingControllerProps, type OnboardingIntent, type OnboardingJourney, type OnboardingJourneyPosition, type OnboardingOrigin, type OnboardingStep, type OrgFailure, type OrgMemberAction, type OrgMemberCanSlice, type OrgMemberStanding, type OrgMemberStandingSlice, type OrgProgress, type OrganizationDetails, type OrganizationDraft, type OtpPendingState, type PayoutDraftChain, type PayoutDraftEntry, type PayrollGroupRow, type PayrollGroupsSlice, type PayrollRecipientOption, type PayrollRunActionsSlice, type PayrollRunAmountEntry, type PayrollRunAmountsSlice, type PayrollRunAssetSlice, type PayrollRunGroupOption, type PayrollRunPrefill, type PayrollRunRecipientsSlice, type PayrollRunStatus, type PayrollRunSummarySlice, type PayrollSummarySlice, type PendingAuthState, type ProfileDetails, type ProfileDraft, type ProfileSlotProps, type ReadyDestination, type RetryAction, type SendActor, type SendMoneyActionsSlice, type SendMoneyAmountSlice, type SendMoneyAssetError, type SendMoneyAssetOption, type SendMoneyAssetSlice, type SendMoneyRecipientSlice, type SendMoneyRecipientStatus, type SendMoneySourceError, type SendMoneySourceOption, type SendMoneySourceSlice, type SendResult, type SentPayment, type SentPayrollRun, type SignedOutState, type Slot, type SummaryWindow, type UseCapxulAccountBalanceOptions, type UseCapxulAccountBalanceReturn, type UseCapxulAccountFundReturn, type UseCapxulCreateCommitmentReturn, type UseCapxulCreateOrgReturn, type UseCapxulHandleAvailabilityReturn, type UseCapxulImageUploadReturn, type UseCapxulInviteMemberInput, type UseCapxulInviteMemberReturn, type UseCapxulOrgMembersOptions, type UseCapxulOrgMembersReturn, type UseCapxulOrgRolesOptions, type UseCapxulOrgRolesReturn, type UseCapxulOrgTreasuryOptions, type UseCapxulOrgTreasuryReturn, type UseCapxulOrgsReturn, type UseCapxulPayReturn, type UseCapxulPaymentReturn, type UseCapxulPaymentsReturn, type UseCapxulProfileReturn, type UseCapxulRedirectPaymentReturn, type UseCapxulUploadImageReturn, acknowledgeOnboardingDestination, activeOnboardingRecovery, capxulKeys, clearOnboardingJourney, currentOnboardingJourneyId, entered, invalidateOnboardingJourneyObservation, isClaimed, isRestoring, loadOnboardingJourney, onboardingJourneyPosition, saveOnboardingJourney, startOnboardingJourney, useCapxul, useCapxulAccountBalance, useCapxulAccountFund, useCapxulActivity, useCapxulActivityDetail, useCapxulAnnotateMovement, useCapxulAuth, useCapxulCancelPayment, useCapxulClaimPayment, useCapxulClientOrNull, useCapxulCreateCommitment, useCapxulCreateOrg, useCapxulDestination, useCapxulHandleAvailability, useCapxulHoldings, useCapxulIdentity, useCapxulImageUpload, useCapxulInviteMember, useCapxulOrgMembers, useCapxulOrgRoles, useCapxulOrgTreasury, useCapxulOrganizationPay, useCapxulOrganizationPayBatch, useCapxulOrgs, useCapxulPay, useCapxulPayment, useCapxulPayments, useCapxulPermission, useCapxulPermissionAssign, useCapxulPermissionChange, useCapxulPermissionCreate, useCapxulPermissionReplace, useCapxulPermissionRevoke, useCapxulPermissions, useCapxulProfile, useCapxulRedirectPayment, useCapxulSend, useCapxulTransitions, useCapxulUploadImage };
|
|
1183
|
+
export { type AccountFailure, type AccountProgress, type ActionResult, type ActivityDetailSlice, type ActivityExportSlice, type ActivityFilterValues, type ActivityFiltersSlice, type ActivityLoadMoreSlice, type ActivityReceipt, type ActivityRow, type ActivityRowsSlice, type ActivitySearchSlice, type ActivitySummarySlice, type AuthenticatedState, type AuthenticationSlots, type CanReason, CapxulActivity, type CapxulActivityProps, type CapxulAuth, CapxulAuthenticationController, type CapxulBootstrapState, type CapxulBootstrapStatus, CapxulClientConnection, type CapxulClientConnectionProps, CapxulContacts, type CapxulContactsProps, CapxulDashboardAccess, type CapxulDashboardAccessProps, CapxulOnboardingController, CapxulOrgMember, type CapxulOrgMemberProps, CapxulPayroll, type CapxulPayrollProps, CapxulPayrollRun, type CapxulPayrollRunBlockedReason, type CapxulPayrollRunProps, CapxulProvider, type CapxulProviderProps, type CapxulSend, CapxulSendMoney, type CapxulSendMoneyBlockedReason, type CapxulSendMoneyProps, type CompleteSlice as ClientConnectionCompleteSlice, type ConsentSlice as ClientConnectionConsentSlice, type FailureSlice as ClientConnectionFailureSlice, type OtpSlice as ClientConnectionOtpSlice, type Contact, type ContactRelationship, type ContactRow, type ContactsActor, type ContactsAddBlockedReason, type ContactsAddError, type ContactsAddSlice, type ContactsListOptions, type ContactsListSlice, type ContactsRefusal, type ContactsSummarySlice, type ControllerAction, type CreateOrganizationFailure, type CreateOrganizationSubmission, type CsvExport, type DashboardAccessErrorSlice, type DashboardAccessPhase, type DashboardAccessProbe, type DashboardAccessRedirectSlice, type DashboardScope, type Destination, type FaultedState, type HandleAvailability, type ImageUploadInput, type ImageUploadTarget, type InvocationOptions, type NavigationAction, type OnboardingControllerProps, type OnboardingIntent, type OnboardingJourney, type OnboardingJourneyPosition, type OnboardingOrigin, type OnboardingStep, type OrgFailure, type OrgMemberAction, type OrgMemberCanSlice, type OrgMemberStanding, type OrgMemberStandingSlice, type OrgProgress, type OrganizationDetails, type OrganizationDraft, type OtpPendingState, type PayoutDraftChain, type PayoutDraftEntry, type PayrollGroupRow, type PayrollGroupsSlice, type PayrollRecipientOption, type PayrollRunActionsSlice, type PayrollRunAmountEntry, type PayrollRunAmountsSlice, type PayrollRunAssetSlice, type PayrollRunGroupOption, type PayrollRunPrefill, type PayrollRunRecipientsSlice, type PayrollRunStatus, type PayrollRunSummarySlice, type PayrollSummarySlice, type PendingAuthState, type ProfileDetails, type ProfileDraft, type ProfileSlotProps, type ReadyDestination, type RetryAction, type SendActor, type SendMoneyActionsSlice, type SendMoneyAmountSlice, type SendMoneyAssetError, type SendMoneyAssetOption, type SendMoneyAssetSlice, type SendMoneyRecipientSlice, type SendMoneyRecipientStatus, type SendMoneySourceError, type SendMoneySourceOption, type SendMoneySourceSlice, type SendResult, type SentPayment, type SentPayrollRun, type SignedOutState, type Slot, type SummaryWindow, type UseCapxulAccountBalanceOptions, type UseCapxulAccountBalanceReturn, type UseCapxulAccountFundReturn, type UseCapxulCreateCommitmentReturn, type UseCapxulCreateOrgReturn, type UseCapxulHandleAvailabilityReturn, type UseCapxulImageUploadReturn, type UseCapxulInviteMemberInput, type UseCapxulInviteMemberReturn, type UseCapxulOrgMembersOptions, type UseCapxulOrgMembersReturn, type UseCapxulOrgRolesOptions, type UseCapxulOrgRolesReturn, type UseCapxulOrgTreasuryOptions, type UseCapxulOrgTreasuryReturn, type UseCapxulOrgsReturn, type UseCapxulPayReturn, type UseCapxulPaymentReturn, type UseCapxulPaymentsReturn, type UseCapxulProfileReturn, type UseCapxulRedirectPaymentReturn, type UseCapxulUploadImageReturn, acknowledgeOnboardingDestination, activeOnboardingRecovery, capxulKeys, clearOnboardingJourney, currentOnboardingJourneyId, entered, invalidateOnboardingJourneyObservation, isClaimed, isRestoring, loadOnboardingJourney, onboardingJourneyPosition, saveOnboardingJourney, startOnboardingJourney, useCapxul, useCapxulAccountBalance, useCapxulAccountFund, useCapxulActivity, useCapxulActivityDetail, useCapxulAnnotateMovement, useCapxulAuth, useCapxulCancelPayment, useCapxulClaimPayment, useCapxulClientOrNull, useCapxulCreateCommitment, useCapxulCreateOrg, useCapxulDestination, useCapxulHandleAvailability, useCapxulHoldings, useCapxulIdentity, useCapxulImageUpload, useCapxulInviteMember, useCapxulOrgMembers, useCapxulOrgRoles, useCapxulOrgTreasury, useCapxulOrganizationPay, useCapxulOrganizationPayBatch, useCapxulOrgs, useCapxulPay, useCapxulPayment, useCapxulPayments, useCapxulPermission, useCapxulPermissionAssign, useCapxulPermissionChange, useCapxulPermissionCreate, useCapxulPermissionReplace, useCapxulPermissionRevoke, useCapxulPermissions, useCapxulProfile, useCapxulRedirectPayment, useCapxulSend, useCapxulTransitions, useCapxulUploadImage };
|