@capxul/sdk 3.1.0 → 3.2.0

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 CHANGED
@@ -90,14 +90,20 @@ governed PostHog ingest origin, public project token, and environment. The SDK
90
90
  derives endpoints, service, producer, and version. Missing or invalid policy
91
91
  disables engineering export without failing client creation.
92
92
 
93
- Onboarding uses explicit domain objects. Personal completion accepts
94
- `{ profile }`; Organization completion accepts independently validated
95
- `{ profile, organization }`. The latter makes the Member Profile and personal
96
- Account/Safe ready before the first Organization write, then returns the exact
97
- `orgId` and its `OrgLifecycle`. A failed lifecycle after creation is returned
98
- with that `orgId`; Organization-list timing is not a success gate.
99
- Public Profile reads include the durable `onboarded` flag and optional
100
- `withdrawalAddress`, and `toEvmAddress` validates form-sourced withdrawal values.
93
+ Person onboarding is one Core SDK journey. It requires a normalized, globally
94
+ unique username before it writes the Profile or starts Account setup:
95
+
96
+ ```ts
97
+ const onboarded = await client.onboarding.completePerson({
98
+ displayName: "Ada Lovelace",
99
+ country: "GH",
100
+ username: "ada_lovelace",
101
+ });
102
+ ```
103
+
104
+ The backend remains the authority for reserved names and global uniqueness.
105
+ The method returns only after the client requirement reaches a ready Account.
106
+ The React frontend does not use this journey yet.
101
107
 
102
108
  ## Published entry points
103
109
 
@@ -105,7 +111,7 @@ The packed npm package exposes only:
105
111
 
106
112
  - `@capxul/sdk` — the client factory, public method and value types, signers,
107
113
  host observability helper, and immutable Base Sepolia Payment contract
108
- identity.
114
+ identity. It also re-exports the canonical Capxul operation vocabulary.
109
115
  - `@capxul/sdk/node` — Node-only signer and runtime helpers.
110
116
  - `@capxul/sdk/testing` — the real identity runtime assembled over
111
117
  deterministic in-memory ports, with OTP, advance-only clock, transition,
@@ -1,4 +1,4 @@
1
- import { F as toEmail, I as toEpochMs, K as toSessionToken, L as toEpochSeconds, R as toJwtToken, Z as Errors, c as ClockError, k as toAuthUserId, l as ClockPortTag, t as readClockNow, u as authClientPortFromPromiseAdapter } from "./clock-m_aHLaNm.mjs";
1
+ import { F as toEmail, I as toEpochMs, K as toSessionToken, L as toEpochSeconds, R as toJwtToken, Z as Errors, c as ClockError, k as toAuthUserId, l as ClockPortTag, t as readClockNow, u as authClientPortFromPromiseAdapter } from "./clock-CWpcQlLy.mjs";
2
2
  import { Effect, Layer } from "effect";
3
3
  //#region src/adapters/clock/SystemClockAdapter.ts
4
4
  var SystemClockAdapter = class {
@@ -1,4 +1,4 @@
1
- import { _ as ClockPort, v as AuthClientPort } from "./signer-BpjdawiY.mjs";
1
+ import { _ as ClockPort, v as AuthClientPort } from "./signer-DOqb8M1Y.mjs";
2
2
  //#region src/adapters/auth-client/OAuthBearerAuthClient.d.ts
3
3
  interface OAuthBearerAuthClientInput {
4
4
  /** The exchange endpoint: `{authBaseUrl}/api/auth/agent/exchange`. */