@capxul/sdk 1.0.0-alpha.12 → 1.0.0-alpha.13

package/dist/index-D0SflScT.d.mts

@@ -0,0 +1,157 @@
+//#region ../errors/src/errors.d.ts
+declare const CAPXUL_ERROR_CODES: readonly ["NOT_AUTHENTICATED", "EMAIL_DELIVERY_FAILED", "PROFILE_NOT_FOUND", "SMART_ACCOUNT_MISSING", "PLAYER_NOT_FOUND", "ACCOUNT_NOT_FOUND", "PROVIDER_ERROR", "INVALID_INPUT", "ENV_MISSING", "NOT_IMPLEMENTED", "VERIFICATION_REQUIRED", "INSUFFICIENT_BALANCE", "INVALID_RECIPIENT", "ROLE_PERMISSION_DENIED", "TRANSACTION_FAILED", "RATE_LIMITED", "NETWORK_ERROR", "UNKNOWN", "OTP_EXPIRED", "SIGNER_REJECTED", "CANCELLED", "WRONG_STATE"];
+type CapxulErrorCode = (typeof CAPXUL_ERROR_CODES)[number];
+/**
+ * Why an auth/provider call failed — a flat CAUSE enum. The *where* (which
+ * OpenFort operation) stays in the separate `operation` detail field; this
+ * names the root cause so a single `$exception` can be triaged without
+ * parsing the message. Five members, no free strings:
+ *
+ * - `auth-origin-mismatch`: OTP cookies live on `localhost:PORT` but OpenFort
+ *   hits the Convex host → no session reaches the provider.
+ * - `stale-openfort-cache`: an old `userId` in scoped storage makes the SDK
+ *   skip re-auth → 401 on `v2/accounts`.
+ * - `app-env-allowlist`: missing `VITE_CAPXUL_CONVEX_SITE_URL` / the origin is
+ *   not allowlisted → 401.
+ * - `no-secure-context`: sandboxed/headless browser with no Web Crypto, so
+ *   `getAddress`/`configure` can never produce an address. Previously vanished
+ *   into `unknown`; the signer's secure-context probe now names it.
+ * - `unknown`: catch-all when no cause could be determined.
+ */
+type FailureMode = "auth-origin-mismatch" | "stale-openfort-cache" | "app-env-allowlist" | "no-secure-context" | "unknown";
+type CapxulErrorDetails = Record<string, unknown>;
+type CapxulErrorOptions = {
+  readonly cause?: unknown;
+  readonly details?: CapxulErrorDetails;
+  readonly correlationId?: string;
+  readonly layer?: string;
+};
+declare class CapxulError extends Error {
+  readonly code: CapxulErrorCode;
+  readonly details?: CapxulErrorDetails;
+  readonly correlationId?: string;
+  readonly layer?: string;
+  constructor(code: CapxulErrorCode, message: string, options?: CapxulErrorOptions);
+}
+declare function isCapxulError(value: unknown): value is CapxulError;
+//#endregion
+//#region ../types/src/brand.d.ts
+/**
+ * Nominal type helper. `Brand<T, B>` is structurally a `T` at runtime but
+ * distinct at compile time, preventing accidental swaps between primitives.
+ *
+ * @internal
+ */
+declare const brand: unique symbol;
+type Brand<T, B extends string> = T & {
+  readonly [brand]: B;
+};
+//#endregion
+//#region ../types/src/index.d.ts
+type Address = Brand<string, "Address">;
+type Email = Brand<string, "Email">;
+type Profile = {
+  readonly authUserId: AuthUserId;
+  readonly email: Email;
+  readonly displayName: string | null;
+  readonly country: CountryCode | null;
+  readonly kycTier: KycTier;
+  readonly createdAt: EpochMs;
+  readonly updatedAt: EpochMs;
+};
+type SmartAccount = {
+  readonly authUserId: AuthUserId;
+  readonly signerAddress: Address | null;
+  readonly smartAccountAddress: Address;
+  readonly chainId: ChainId;
+  readonly deployedAt: EpochMs | null;
+  readonly claimedAt: EpochMs | null;
+  readonly createdAt: EpochMs;
+};
+type Money = {
+  readonly currency: CurrencyCode;
+  readonly value: string;
+  readonly decimals: number;
+};
+type Account = {
+  readonly id: AccountId;
+  readonly balance: Money;
+  readonly available: Money;
+};
+/** Named bucket partitioning a logical Account (canon §9). */
+type SubAccount = {
+  readonly id: SubAccountId;
+  readonly accountId: AccountId;
+  readonly name: string;
+  readonly balance: Money;
+  readonly createdAt: EpochMs;
+};
+type AuthUserId = Brand<string, "AuthUserId">;
+type AnonymousDistinctId = Brand<string, "AnonymousDistinctId">;
+type AccountId = Brand<string, "AccountId">;
+type SubAccountId = Brand<string, "SubAccountId">;
+type OrgId = Brand<string, "OrgId">;
+type AppId = Brand<string, "AppId">;
+type AllowedOrigin = Brand<string, "AllowedOrigin">;
+type PublishableKey = Brand<string, "PublishableKey">;
+type PublishableKeyId = Brand<string, "PublishableKeyId">;
+type DurationMs = Brand<number, "DurationMs">;
+type DeveloperApplication = {
+  readonly id: AppId;
+  readonly authUserId: AuthUserId;
+  readonly name: string;
+  readonly allowedOrigins: readonly AllowedOrigin[];
+  readonly createdAt: EpochMs;
+  readonly archivedAt: EpochMs | null;
+};
+type PublishableKeyRecord = {
+  readonly id: PublishableKeyId;
+  readonly applicationId: AppId;
+  readonly activeFromMs: EpochMs;
+  readonly gracePeriodEndsMs: EpochMs | null;
+  readonly revokedAt: EpochMs | null;
+};
+type TxHash = Brand<string, "TxHash">;
+type DocumentHash = Brand<string, "DocumentHash">;
+type EpochMs = Brand<number, "EpochMs">;
+type EpochSeconds = Brand<number, "EpochSeconds">;
+type ChainId = Brand<number, "ChainId">;
+type CountryCode = Brand<string, "CountryCode">;
+type CurrencyCode = Brand<SupportedCurrencyCode, "CurrencyCode">;
+type KycTier = Brand<0 | 1 | 2 | 3, "KycTier">;
+type BlockNumber = Brand<number, "BlockNumber">;
+type RunId = Brand<string, "RunId">;
+type RoleKey = Brand<string, "RoleKey">;
+type SessionToken = Brand<string, "SessionToken">;
+type JwtToken = Brand<string, "JwtToken">;
+type AuthSession = {
+  readonly authUserId: AuthUserId;
+  readonly email: Email;
+  readonly token: SessionToken;
+  readonly expiresAt: EpochMs;
+};
+declare const SUPPORTED_CURRENCIES: readonly [{
+  readonly code: "USD";
+  readonly symbol: "$";
+  readonly name: "US Dollar";
+}, {
+  readonly code: "NGN";
+  readonly symbol: "NGN";
+  readonly name: "Nigerian Naira";
+}, {
+  readonly code: "GHS";
+  readonly symbol: "GHS";
+  readonly name: "Ghanaian Cedi";
+}, {
+  readonly code: "KES";
+  readonly symbol: "KSh";
+  readonly name: "Kenyan Shilling";
+}, {
+  readonly code: "UGX";
+  readonly symbol: "USh";
+  readonly name: "Ugandan Shilling";
+}];
+type SupportedCurrencyCode = (typeof SUPPORTED_CURRENCIES)[number]["code"];
+//#endregion
+export { SubAccount as A, PublishableKey as C, RunId as D, RoleKey as E, CapxulErrorDetails as F, FailureMode as I, isCapxulError as L, TxHash as M, CapxulError as N, SessionToken as O, CapxulErrorCode as P, Profile as S, PublishableKeyRecord as T, EpochMs as _, AnonymousDistinctId as a, Money as b, AuthUserId as c, CountryCode as d, CurrencyCode as f, Email as g, DurationMs as h, AllowedOrigin as i, SubAccountId as j, SmartAccount as k, BlockNumber as l, DocumentHash as m, AccountId as n, AppId as o, DeveloperApplication as p, Address as r, AuthSession as s, Account as t, ChainId as u, EpochSeconds as v, PublishableKeyId as w, OrgId as x, JwtToken as y };
+//# sourceMappingURL=index-D0SflScT.d.mts.map

package/dist/index-D0SflScT.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-D0SflScT.d.mts","names":[],"sources":["../../errors/src/errors.ts","../../types/src/brand.ts","../../types/src/index.ts"],"mappings":";cAKa,kBAAA;AAAA,KAyBD,eAAA,WAA0B,kBAAkB;;;;AAF9C;AAEV;;;;AAAwD;AAmBxD;;;;AAAuB;AAOvB;;;KAPY,WAAA;AAAA,KAOA,kBAAA,GAAqB,MAAM;AAAA,KAgB3B,kBAAA;EAAA,SACD,KAAA;EAAA,SACA,OAAA,GAAU,kBAAkB;EAAA,SAC5B,aAAA;EAAA,SACA,KAAA;AAAA;AAAA,cAGE,WAAA,SAAoB,KAAA;EAAA,SACtB,IAAA,EAAM,eAAA;EAAA,SACN,OAAA,GAAU,kBAAA;EAAA,SACV,aAAA;EAAA,SACA,KAAA;cAEG,IAAA,EAAM,eAAA,EAAiB,OAAA,UAAiB,OAAA,GAAS,kBAAA;AAAA;AAAA,iBAgB/C,aAAA,CAAc,KAAA,YAAiB,KAAA,IAAS,WAAW;;;;AAhGnE;;;;AAuBU;cCtBI,KAAA;AAAA,KAEF,KAAA,wBAA6B,CAAA;EAAA,UAAgB,KAAA,GAAQ,CAAA;AAAA;;;KCHrD,OAAA,GAAU,KAAK;AAAA,KACf,KAAA,GAAQ,KAAK;AAAA,KAMb,OAAA;EAAA,SACD,UAAA,EAAY,UAAA;EAAA,SACZ,KAAA,EAAO,KAAA;EAAA,SACP,WAAA;EAAA,SACA,OAAA,EAAS,WAAA;EAAA,SACT,OAAA,EAAS,OAAA;EAAA,SACT,SAAA,EAAW,OAAA;EAAA,SACX,SAAA,EAAW,OAAA;AAAA;AAAA,KASV,YAAA;EAAA,SACD,UAAA,EAAY,UAAA;EAAA,SACZ,aAAA,EAAe,OAAA;EAAA,SACf,mBAAA,EAAqB,OAAA;EAAA,SACrB,OAAA,EAAS,OAAA;EAAA,SACT,UAAA,EAAY,OAAA;EAAA,SACZ,SAAA,EAAW,OAAA;EAAA,SACX,SAAA,EAAW,OAAA;AAAA;AAAA,KAQV,KAAA;EAAA,SACD,QAAA,EAAU,YAAY;EAAA,SACtB,KAAA;EAAA,SACA,QAAA;AAAA;AAAA,KAQC,OAAA;EAAA,SACD,EAAA,EAAI,SAAA;EAAA,SACJ,OAAA,EAAS,KAAA;EAAA,SACT,SAAA,EAAW,KAAA;AAAA;;KAIV,UAAA;EAAA,SACD,EAAA,EAAI,YAAA;EAAA,SACJ,SAAA,EAAW,SAAA;EAAA,SACX,IAAA;EAAA,SACA,OAAA,EAAS,KAAA;EAAA,SACT,SAAA,EAAW,OAAA;AAAA;AAAA,KAGV,UAAA,GAAa,KAAK;AAAA,KAClB,mBAAA,GAAsB,KAAK;AAAA,KAE3B,SAAA,GAAY,KAAK;AAAA,KACjB,YAAA,GAAe,KAAK;AAAA,KACpB,KAAA,GAAQ,KAAK;AAAA,KACb,KAAA,GAAQ,KAAK;AAAA,KACb,aAAA,GAAgB,KAAK;AAAA,KACrB,cAAA,GAAiB,KAAK;AAAA,KACtB,gBAAA,GAAmB,KAAK;AAAA,KACxB,UAAA,GAAa,KAAK;AAAA,KAMlB,oBAAA;EAAA,SACD,EAAA,EAAI,KAAA;EAAA,SACJ,UAAA,EAAY,UAAA;EAAA,SACZ,IAAA;EAAA,SACA,cAAA,WAAyB,aAAA;EAAA,SACzB,SAAA,EAAW,OAAA;EAAA,SACX,UAAA,EAAY,OAAA;AAAA;AAAA,KAEX,oBAAA;EAAA,SACD,EAAA,EAAI,gBAAA;EAAA,SACJ,aAAA,EAAe,KAAA;EAAA,SACf,YAAA,EAAc,OAAA;EAAA,SACd,iBAAA,EAAmB,OAAA;EAAA,SACnB,SAAA,EAAW,OAAA;AAAA;AAAA,KAEV,MAAA,GAAS,KAAK;AAAA,KACd,YAAA,GAAe,KAAK;AAAA,KACpB,OAAA,GAAU,KAAK;AAAA,KACf,YAAA,GAAe,KAAK;AAAA,KACpB,OAAA,GAAU,KAAK;AAAA,KACf,WAAA,GAAc,KAAK;AAAA,KACnB,YAAA,GAAe,KAAK,CAAC,qBAAA;AAAA,KACrB,OAAA,GAAU,KAAK;AAAA,KACf,WAAA,GAAc,KAAK;AAAA,KAKnB,KAAA,GAAQ,KAAK;AAAA,KACb,OAAA,GAAU,KAAK;AAAA,KAEf,YAAA,GAAe,KAAK;AAAA,KACpB,QAAA,GAAW,KAAK;AAAA,KAOhB,WAAA;EAAA,SACD,UAAA,EAAY,UAAA;EAAA,SACZ,KAAA,EAAO,KAAA;EAAA,SACP,KAAA,EAAO,YAAA;EAAA,SACP,SAAA,EAAW,OAAA;AAAA;AAAA,cAMT,oBAAA;EAAA;;;;;;;;;;;;;;;;;;;;KAQR,qBAAA,WAAgC,oBAAoB"}