@capxul/sdk-react 0.0.0-rc-2cdddbb91

package/dist/onboarding-controller-DrJiYWfY.d.mts

@@ -0,0 +1,205 @@
+import { ReactNode } from "react";
+import { CapxulClient, CapxulError, CapxulErrorCode, IdentityDestination, IdentityEvent, IdentityProfileDetails, IdentityState, IdentityTransition, OrgLane, Readiness } from "@capxul/sdk";
+//#region src/platform/identity-contract.d.ts
+type Destination = IdentityDestination;
+interface InvocationOptions {
+  readonly correlationId?: string;
+  readonly journeyId?: string;
+  readonly timeoutMs?: number;
+  readonly deadlineMs?: number;
+  readonly signal?: AbortSignal;
+}
+type SendResult = {
+  readonly ok: true;
+  readonly state: IdentityState;
+} | {
+  readonly ok: false;
+  readonly refused: CapxulErrorCode;
+  readonly state: IdentityState;
+};
+type CapxulSend = (event: IdentityEvent, options?: InvocationOptions) => Promise<SendResult>;
+type ProfileDetails = IdentityProfileDetails;
+interface OrganizationDetails {
+  readonly name: string;
+  readonly handle: string;
+  readonly country: string;
+  readonly bio?: string;
+  readonly size?: string;
+  /**
+   * #1955: the storage id `useCapxulUploadImage` handed back on file pick. The
+   * create call carries it, so the backend records the logo on the `orgs`
+   * insert instead of the app binding it afterwards.
+   */
+  readonly logoStorageId?: string;
+}
+interface CreateOrganizationSubmission {
+  readonly profileDetails: ProfileDetails;
+  readonly organization: OrganizationDetails;
+}
+/** A refused facade call: its code, and the whole error when one was raised. */
+type FacadeFailure = {
+  readonly ok: false;
+  readonly reason: CapxulErrorCode;
+  readonly error?: CapxulError;
+};
+type CreateOrganizationFailure = FacadeFailure & {
+  readonly error: CapxulError;
+};
+type EmptyResult = {
+  readonly ok: true;
+} | FacadeFailure;
+interface CapxulAuth {
+  readonly requestCode: (email: string, options?: InvocationOptions) => Promise<{
+    readonly ok: true;
+    readonly requestedAt: number;
+  } | FacadeFailure>;
+  readonly verifyCode: (otp: string, options?: InvocationOptions) => Promise<{
+    readonly ok: true;
+    readonly authUserId: string;
+    readonly profileComplete: boolean;
+  } | FacadeFailure>;
+  readonly signOut: (options?: InvocationOptions) => Promise<EmptyResult>;
+  readonly createOrganization: (submission: CreateOrganizationSubmission, options?: InvocationOptions) => Promise<{
+    readonly ok: true;
+    readonly orgId: string;
+  } | CreateOrganizationFailure>;
+  readonly completePersonal: (profileDetails: ProfileDetails, options?: InvocationOptions) => Promise<EmptyResult>;
+  readonly retry: (options?: InvocationOptions) => Promise<EmptyResult>;
+}
+type TransitionListener = (record: IdentityTransition, state: IdentityState) => void;
+//#endregion
+//#region src/access/controllers.d.ts
+type Slot<P> = (props: P) => ReactNode;
+type ActionResult = {
+  readonly ok: true;
+} | {
+  readonly ok: false;
+  readonly reason: import("@capxul/sdk").CapxulErrorCode;
+};
+type ControllerAction = () => Promise<ActionResult>;
+type RetryAction = (options: InvocationOptions) => Promise<ActionResult>;
+type NavigationAction = () => void;
+type SignedOutState = Extract<IdentityState, {
+  phase: "signed_out";
+}>;
+type OtpPendingState = Extract<IdentityState, {
+  phase: "otp_pending";
+}>;
+type PendingAuthState = Extract<IdentityState, {
+  phase: "restoring" | "otp_sending" | "otp_verifying" | "signing_out";
+}>;
+type FaultedState = Extract<IdentityState, {
+  phase: "faulted";
+}>;
+type AuthenticatedState = Extract<IdentityState, {
+  phase: "authenticated";
+}>;
+type AccountProgress = Exclude<Readiness, {
+  at: "failed";
+} | {
+  at: "claimed";
+}>;
+type AccountFailure = Extract<Readiness, {
+  at: "failed";
+}>;
+type OrgProgress = OrgLane;
+type OrgFailure = OrgLane;
+type ReadyDestination = Extract<IdentityDestination, {
+  to: "dashboardPersonal" | "dashboardOrganization";
+}>;
+interface AuthenticationSlots {
+  readonly email: Slot<{
+    state: SignedOutState;
+    requestCode: CapxulAuth["requestCode"];
+  }>;
+  readonly otp: Slot<{
+    state: OtpPendingState;
+    verifyCode: CapxulAuth["verifyCode"];
+    back: ControllerAction;
+  }>;
+  readonly pending: Slot<{
+    state: PendingAuthState;
+  }>;
+  readonly failure: Slot<{
+    state: FaultedState;
+    recover: ControllerAction;
+    back: ControllerAction;
+  }>;
+  readonly success: Slot<{
+    state: AuthenticatedState;
+    destination: IdentityDestination | null;
+  }>;
+}
+declare function CapxulAuthenticationController({ slots }: {
+  readonly slots: AuthenticationSlots;
+}): ReactNode;
+type ProfileSlotProps = {
+  readonly intent: "personal";
+  readonly state: AuthenticatedState;
+  readonly completePersonal: CapxulAuth["completePersonal"];
+  readonly cancel: NavigationAction;
+} | {
+  readonly intent: "organization";
+  readonly state: AuthenticatedState;
+  readonly continueOrganization: (profile: ProfileDetails) => void;
+  readonly cancel: NavigationAction;
+};
+//#endregion
+//#region src/access/onboarding-controller.d.ts
+interface OnboardingControllerProps {
+  readonly intent: "personal" | "organization" | null;
+  readonly organizationProfile: ProfileDetails | null;
+  readonly submittedOrganization: CreateOrganizationSubmission | null;
+  readonly recoveryOptions?: () => InvocationOptions;
+  readonly onIntent: (intent: "personal" | "organization") => void;
+  readonly onOrganizationProfile: (profile: ProfileDetails | null) => void;
+  readonly onSubmittedOrganization: (submission: CreateOrganizationSubmission | null) => void;
+  readonly navigation: {
+    readonly selectorBack: NavigationAction;
+    readonly profileCancel: NavigationAction;
+    readonly organizationBack: NavigationAction;
+    readonly organizationCancel: NavigationAction;
+  };
+  readonly slots: {
+    readonly intent: Slot<{
+      state: AuthenticatedState;
+      select: OnboardingControllerProps["onIntent"];
+      back: NavigationAction;
+    }>;
+    readonly profile: Slot<ProfileSlotProps>;
+    readonly organization: Slot<{
+      state: AuthenticatedState;
+      profileDetails: ProfileDetails;
+      submitted: CreateOrganizationSubmission | null;
+      pinnedHandle: string | null;
+      submit: (organization: OrganizationDetails, options: InvocationOptions) => ReturnType<CapxulAuth["createOrganization"]>;
+      back: NavigationAction;
+      cancel: NavigationAction;
+    }>;
+    readonly accountProgress: Slot<{
+      state: AuthenticatedState;
+      account: AccountProgress;
+    }>;
+    readonly accountFailure: Slot<{
+      state: AuthenticatedState;
+      account: AccountFailure;
+      retry?: RetryAction;
+    }>;
+    readonly organizationProgress: Slot<{
+      state: AuthenticatedState;
+      org: OrgProgress;
+    }>;
+    readonly organizationFailure: Slot<{
+      state: AuthenticatedState;
+      org: OrgFailure;
+      retry?: RetryAction;
+    }>;
+    readonly ready: Slot<{
+      state: AuthenticatedState;
+      destination: ReadyDestination;
+    }>;
+  };
+}
+declare function CapxulOnboardingController(props: OnboardingControllerProps): import("react").ReactNode;
+//#endregion
+export { TransitionListener as A, CreateOrganizationFailure as C, OrganizationDetails as D, InvocationOptions as E, ProfileDetails as O, CapxulSend as S, Destination as T, ReadyDestination as _, ActionResult as a, Slot as b, CapxulAuthenticationController as c, NavigationAction as d, OrgFailure as f, ProfileSlotProps as g, PendingAuthState as h, AccountProgress as i, SendResult as k, ControllerAction as l, OtpPendingState as m, OnboardingControllerProps as n, AuthenticatedState as o, OrgProgress as p, AccountFailure as r, AuthenticationSlots as s, CapxulOnboardingController as t, FaultedState as u, RetryAction as v, CreateOrganizationSubmission as w, CapxulAuth as x, SignedOutState as y };

package/dist/testing/index.d.mts

@@ -0,0 +1,19 @@
+import { n as OnboardingControllerProps, s as AuthenticationSlots } from "../onboarding-controller-DrJiYWfY.mjs";
+import * as React from "react";
+import { ReactNode } from "react";
+import { CapxulTestClient, CapxulTestClock, CapxulTestObservation, CreateCapxulTestClientOptions, SeedTestIdentityInput, createCapxulTestClient } from "@capxul/sdk/testing";
+//#region src/testing/index.d.ts
+export interface CreateCapxulReactTestHarnessOptions extends CreateCapxulTestClientOptions {
+  readonly testing?: CapxulTestClient;
+}
+export interface CapxulReactTestHarness {
+  readonly testing: CapxulTestClient;
+  readonly client: CapxulTestClient["client"];
+  readonly provider: (children: ReactNode) => React.JSX.Element;
+  readonly authentication: (slots: AuthenticationSlots) => React.JSX.Element;
+  readonly onboarding: (props: OnboardingControllerProps) => React.JSX.Element;
+}
+/** Build renderer-neutral React test elements over the real SDK testing client. */
+export declare function createCapxulReactTestHarness(options?: CreateCapxulReactTestHarnessOptions): CapxulReactTestHarness;
+//#endregion
+export { type CapxulTestClient, type CapxulTestClock, type CapxulTestObservation, type CreateCapxulTestClientOptions, type SeedTestIdentityInput, createCapxulTestClient };

package/dist/testing/index.mjs

@@ -0,0 +1,22 @@
+import { i as CapxulProvider, n as CapxulAuthenticationController, t as CapxulOnboardingController } from "../onboarding-controller-DWuvVuC8.mjs";
+import "react";
+import { jsx } from "react/jsx-runtime";
+import { createCapxulTestClient } from "@capxul/sdk/testing";
+//#region src/testing/index.tsx
+/** Build renderer-neutral React test elements over the real SDK testing client. */
+function createCapxulReactTestHarness(options = {}) {
+	const { testing: suppliedTesting, ...clientOptions } = options;
+	const testing = suppliedTesting ?? createCapxulTestClient(clientOptions);
+	return {
+		testing,
+		client: testing.client,
+		provider: (children) => /* @__PURE__ */ jsx(CapxulProvider, {
+			client: testing.client,
+			children
+		}),
+		authentication: (slots) => /* @__PURE__ */ jsx(CapxulAuthenticationController, { slots }),
+		onboarding: (props) => /* @__PURE__ */ jsx(CapxulOnboardingController, { ...props })
+	};
+}
+//#endregion
+export { createCapxulReactTestHarness, createCapxulTestClient };

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@capxul/sdk-react",
+  "version": "0.0.0-rc-2cdddbb91",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Xelmar-tech/infrastructure.git",
+    "directory": "packages/sdk-react"
+  },
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "type": "module",
+  "imports": {
+    "#access": "./src/access/index.ts",
+    "#access/client-connection": "./src/access/client-connection.tsx",
+    "#access/controllers": "./src/access/controllers.tsx",
+    "#access/dashboard-access": "./src/access/dashboard-access.tsx",
+    "#access/onboarding-controller": "./src/access/onboarding-controller.tsx",
+    "#accounts": "./src/accounts/index.ts",
+    "#activity": "./src/activity/index.ts",
+    "#activity/activity": "./src/activity/activity.tsx",
+    "#media": "./src/media/index.ts",
+    "#organizations": "./src/organizations/index.ts",
+    "#organizations/org-member": "./src/organizations/org-member.tsx",
+    "#package.json": "./package.json",
+    "#parties": "./src/parties/index.ts",
+    "#parties/contacts": "./src/parties/contacts.tsx",
+    "#payments": "./src/payments/index.ts",
+    "#payments/send-money": "./src/payments/send-money.tsx",
+    "#payroll": "./src/payroll/index.ts",
+    "#payroll/payroll": "./src/payroll/payroll.tsx",
+    "#payroll/payroll-run": "./src/payroll/payroll-run.tsx",
+    "#permissions": "./src/permissions/index.ts",
+    "#platform/bootstrap-context": "./src/platform/bootstrap-context.tsx",
+    "#platform/client-context": "./src/platform/client-context.tsx",
+    "#platform/identity": "./src/platform/identity.tsx",
+    "#platform/provider": "./src/platform/provider.tsx",
+    "#platform/tests/render-hook-with-capxul": "./src/platform/tests/render-hook-with-capxul.tsx",
+    "#profiles": "./src/profiles/index.ts",
+    "#testing": "./src/testing/index.tsx",
+    "#*": "./src/*.ts"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./testing": {
+      "types": "./dist/testing/index.d.mts",
+      "import": "./dist/testing/index.mjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@capxul/sdk": "0.0.0-rc-2cdddbb91"
+  },
+  "devDependencies": {
+    "@tanstack/react-query": "^5.66.9",
+    "@testing-library/react": "^16.3.2",
+    "@total-typescript/shoehorn": "0.1.2",
+    "@types/jsdom": "^28.0.3",
+    "@types/react": "^19.2.15",
+    "@typescript/native": "npm:typescript@7.0.2",
+    "@vitest/coverage-v8": "5.0.1",
+    "ink": "^7.0.3",
+    "ink-testing-library": "^4.0.0",
+    "jsdom": "^29.1.1",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6",
+    "typescript": "npm:@typescript/typescript6@6.0.2",
+    "vite": "npm:@voidzero-dev/vite-plus-core@1.0.0",
+    "vite-plus": "1.0.0",
+    "vitest": "5.0.1",
+    "@capxul/typescript-config": "0.0.0",
+    "@capxul/protocol": "0.2.0-beta.5"
+  },
+  "peerDependencies": {
+    "@tanstack/react-query": "^5.66.9",
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "check-types": "vp exec ../../node_modules/@typescript/native/bin/tsc -p tsconfig.json --noEmit",
+    "lint": "vp lint -c ../../.oxlintrc.json .",
+    "build": "vp pack",
+    "_vp-tasks-allowed": "vp-allowed: `test` + `test:coverage` are vp tasks in vite.config.ts so vitest self-writes don't bust cache (#205)."
+  }
+}