@xyo-network/xl1-react-client-sdk 1.28.0

package/dist/browser/client/context/providers/WalletGatewayProvider.d.ts

@@ -0,0 +1,34 @@
+import React from 'react';
+import type { GatewayProviderProps } from '../GatewayProviderProps.ts';
+/**
+ * Publishes a `GatewayContext` backed exclusively by the injected XL1 Wallet
+ * extension (i.e. `globalThis.xyo`). This is the provider to use when the
+ * host app is a browser UI that expects the user to bring their own wallet,
+ * rather than running an in-page gateway.
+ *
+ * The requested `gatewayName` is forwarded to `useGatewayFromWallet`, whose
+ * returned gateway uses a three-state contract (`undefined` = still
+ * resolving, `null` = wallet confirmed absent / timed out,
+ * `XyoGatewayRunner` = ready). That tri-state is passed through to
+ * consumers unchanged as `defaultGateway` / `gateways.walletGateway`, so
+ * downstream hooks can distinguish "loading" from "missing".
+ *
+ * The published `GatewayContextState` shape:
+ * - `defaultGateway` — the wallet gateway, used when consumers don't
+ *   specify which gateway they want.
+ * - `gateways.walletGateway` — same instance as `defaultGateway`.
+ * - `gateways.inPageGateway` — always `null` here; this provider does not
+ *   stand up an in-page client. Pair with a different provider if you need
+ *   both.
+ * - `error` — surfaced from `useGatewayFromWallet` (detection / timeout /
+ *   wallet errors). Also rendered inline via `ErrorRender` above `children`
+ *   so mount-time failures are visible even if no consumer reads `error`.
+ * - `provided: true` — lets descendants detect that a real provider (not
+ *   the default empty context) is in the tree.
+ *
+ * The `defaultGateway`, `gateways`, and context `value` are memoized so
+ * consumers only re-render when the underlying wallet gateway reference or
+ * error actually changes.
+ */
+export declare const WalletGatewayProvider: React.FC<GatewayProviderProps>;
+//# sourceMappingURL=WalletGatewayProvider.d.ts.map

package/dist/browser/client/context/providers/WalletGatewayProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WalletGatewayProvider.d.ts","sourceRoot":"","sources":["../../../../../src/client/context/providers/WalletGatewayProvider.tsx"],"names":[],"mappings":"AACA,OAAO,KAAkB,MAAM,OAAO,CAAA;AAItC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AAGtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,qBAAqB,EAAE,KAAK,CAAC,EAAE,CAAC,oBAAoB,CAoChE,CAAA"}

package/dist/browser/client/context/providers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './GatewayProvider.tsx';
+export * from './WalletGatewayProvider.tsx';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/client/context/providers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/client/context/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,6BAA6B,CAAA"}

package/dist/browser/client/context/providers/story/GatewayStatus.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+/**
+ * Consumer that reads `useProvidedGateway` and renders the resolved
+ * state in a way that interaction tests can query. Headings (`Gateway
+ * loaded`, `Gateway not available`, etc.) are stable strings so `play`
+ * functions can assert on them without depending on ARIA roles.
+ */
+export declare const GatewayStatus: React.FC;
+//# sourceMappingURL=GatewayStatus.d.ts.map

package/dist/browser/client/context/providers/story/GatewayStatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatewayStatus.d.ts","sourceRoot":"","sources":["../../../../../../src/client/context/providers/story/GatewayStatus.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAA;AAIzB;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EA8CjC,CAAA"}

package/dist/browser/client/context/useProvidedGateway.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The sole consumer entry point for gateway state. Reads the nearest
+ * `GatewayContext` in the tree, regardless of which provider published
+ * it — this is the decoupling that lets a component work unchanged when
+ * the surrounding app swaps `WalletGatewayProvider` for
+ * `GatewayProvider` (or a test double).
+ *
+ * @param required - When `true` (default), throws if no gateway provider
+ *   is mounted above — use this when the component is meaningless
+ *   without a gateway. When `false`, returns default state (all fields
+ *   undefined) so the component can render a graceful fallback.
+ */
+export declare const useProvidedGateway: (required?: boolean) => Omit<import("./GatewayProviderState.ts").GatewayStateFields & {
+    provided: true;
+}, "provided"> | Omit<import("@xylabs/react-shared").NotProvidedContextExState<import("./GatewayProviderState.ts").GatewayContextState>, "provided">;
+//# sourceMappingURL=useProvidedGateway.d.ts.map

package/dist/browser/client/context/useProvidedGateway.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useProvidedGateway.d.ts","sourceRoot":"","sources":["../../../../src/client/context/useProvidedGateway.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,kBAAkB,GAAI,kBAAe;;oJAAsD,CAAA"}

package/dist/browser/client/hooks/client/helpers/findCaveat.d.ts

@@ -0,0 +1,3 @@
+import type { CaveatTypes, ParentCapability, XyoPermissions } from '@xyo-network/xl1-sdk';
+export declare const findCaveat: (permissions: XyoPermissions, targetCapability: ParentCapability, targetCaveatType: CaveatTypes) => Promise<{}>;
+//# sourceMappingURL=findCaveat.d.ts.map

package/dist/browser/client/hooks/client/helpers/findCaveat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findCaveat.d.ts","sourceRoot":"","sources":["../../../../../../src/client/hooks/client/helpers/findCaveat.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAC9C,MAAM,sBAAsB,CAAA;AAE7B,eAAO,MAAM,UAAU,GACrB,aAAa,cAAc,EAC3B,kBAAkB,gBAAgB,EAClC,kBAAkB,WAAW,gBAW9B,CAAA"}

package/dist/browser/client/hooks/client/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './findCaveat.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/client/hooks/client/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/client/hooks/client/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA"}

package/dist/browser/client/hooks/client/index.d.ts

@@ -0,0 +1,5 @@
+export * from './helpers/index.ts';
+export * from './permissions/index.ts';
+export * from './useClientFromWallet.ts';
+export * from './useGatewayFromWallet.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/client/hooks/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/client/hooks/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA;AAClC,cAAc,wBAAwB,CAAA;AACtC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA"}

package/dist/browser/client/hooks/client/permissions/index.d.ts

@@ -0,0 +1,3 @@
+export * from './usePermissions.ts';
+export * from './usePermissionsAccounts.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/client/hooks/client/permissions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/client/hooks/client/permissions/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA"}

package/dist/browser/client/hooks/client/permissions/usePermissions.d.ts

@@ -0,0 +1,7 @@
+export declare const usePermissions: () => {
+    permissions: import("@xyo-network/xl1-protocol-lib").XyoPermissions | undefined;
+    isLoading: boolean;
+    error: Error | null;
+    timedout: boolean;
+};
+//# sourceMappingURL=usePermissions.d.ts.map

package/dist/browser/client/hooks/client/permissions/usePermissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePermissions.d.ts","sourceRoot":"","sources":["../../../../../../src/client/hooks/client/permissions/usePermissions.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,cAAc;;;;;CAW1B,CAAA"}

package/dist/browser/client/hooks/client/permissions/usePermissionsAccounts.d.ts

@@ -0,0 +1,2 @@
+export declare const useAccountPermissions: () => [readonly string[] | undefined, Error | undefined, import("@xylabs/react-promise").UsePromiseState | undefined];
+//# sourceMappingURL=usePermissionsAccounts.d.ts.map

package/dist/browser/client/hooks/client/permissions/usePermissionsAccounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePermissionsAccounts.d.ts","sourceRoot":"","sources":["../../../../../../src/client/hooks/client/permissions/usePermissionsAccounts.ts"],"names":[],"mappings":"AAsBA,eAAO,MAAM,qBAAqB,uHAejC,CAAA"}

package/dist/browser/client/hooks/client/story/GatewayFromWalletStatus.d.ts

@@ -0,0 +1,7 @@
+import type { GatewayName } from '@xyo-network/xl1-sdk';
+import React from 'react';
+export interface GatewayFromWalletStatusProps {
+    gatewayName?: GatewayName;
+}
+export declare const GatewayFromWalletStatus: React.FC<GatewayFromWalletStatusProps>;
+//# sourceMappingURL=GatewayFromWalletStatus.d.ts.map

package/dist/browser/client/hooks/client/story/GatewayFromWalletStatus.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GatewayFromWalletStatus.d.ts","sourceRoot":"","sources":["../../../../../../src/client/hooks/client/story/GatewayFromWalletStatus.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AACvD,OAAO,KAAK,MAAM,OAAO,CAAA;AAIzB,MAAM,WAAW,4BAA4B;IAC3C,WAAW,CAAC,EAAE,WAAW,CAAA;CAC1B;AAaD,eAAO,MAAM,uBAAuB,EAAE,KAAK,CAAC,EAAE,CAAC,4BAA4B,CAkC1E,CAAA"}

package/dist/browser/client/hooks/client/story/mockWalletDecorator.d.ts

@@ -0,0 +1,3 @@
+import type { Decorator } from '@storybook/react-vite';
+export declare const WithMockWallet: Decorator;
+//# sourceMappingURL=mockWalletDecorator.d.ts.map

package/dist/browser/client/hooks/client/story/mockWalletDecorator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mockWalletDecorator.d.ts","sourceRoot":"","sources":["../../../../../../src/client/hooks/client/story/mockWalletDecorator.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAuGtD,eAAO,MAAM,cAAc,EAAE,SAa5B,CAAA"}

package/dist/browser/client/hooks/client/useClientFromWallet.d.ts

@@ -0,0 +1,12 @@
+import type { XyoClient } from '@xyo-network/xl1-sdk';
+interface ClientState {
+    client?: XyoClient | null;
+    error: Error | null;
+    isLoading: boolean;
+    timedout: boolean;
+}
+export declare const useClientFromWallet: (timeout?: number) => ClientState;
+/** @deprecated - use useClientFromWallet instead */
+export declare const useClient: (timeout?: number) => ClientState;
+export {};
+//# sourceMappingURL=useClientFromWallet.d.ts.map

package/dist/browser/client/hooks/client/useClientFromWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useClientFromWallet.d.ts","sourceRoot":"","sources":["../../../../../src/client/hooks/client/useClientFromWallet.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAKrD,UAAU,WAAW;IACnB,MAAM,CAAC,EAAE,SAAS,GAAG,IAAI,CAAA;IACzB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;IACnB,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,EAAE,OAAO,CAAA;CAClB;AASD,eAAO,MAAM,mBAAmB,GAAI,UAAU,MAAM,KAAG,WAqDtD,CAAA;AAED,oDAAoD;AACpD,eAAO,MAAM,SAAS,aAxDwB,MAAM,KAAG,WAwDX,CAAA"}

package/dist/browser/client/hooks/client/useGatewayFromWallet.d.ts

@@ -0,0 +1,20 @@
+import type { GatewayName } from '@xyo-network/xl1-sdk';
+import type { GatewayFromWallet } from '../../types/index.ts';
+/**
+ * Resolves a gateway from the injected XL1 Wallet extension.
+ *
+ * The returned `gateway` uses a three-state contract:
+ * - `undefined` — wallet detection is still in progress (isLoading=true),
+ *   or no gatewayName was provided. Consumers should treat this as "not yet known"
+ *   and avoid committing to either a present or absent UI state.
+ * - `null` — wallet is definitively absent. Either globalThis.xyo was never set,
+ *   or detection timed out. Safe to show fallback UI (e.g. "Get XL1 Wallet").
+ *   A late-recovery listener may still transition this to a real gateway if
+ *   the extension loads after the timeout.
+ * - `XyoGatewayRunner` — wallet is present and exposes this gateway for the
+ *   requested network. Ready to use for transactions and queries.
+ */
+export declare const useGatewayFromWallet: (gatewayName?: GatewayName, timeout?: number) => GatewayFromWallet;
+/** @deprecated - useGatewayFromWallet */
+export declare const useGateway: (gatewayName?: GatewayName, timeout?: number) => GatewayFromWallet;
+//# sourceMappingURL=useGatewayFromWallet.d.ts.map

package/dist/browser/client/hooks/client/useGatewayFromWallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useGatewayFromWallet.d.ts","sourceRoot":"","sources":["../../../../../src/client/hooks/client/useGatewayFromWallet.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAEvD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AAG7D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,oBAAoB,GAAI,cAAc,WAAW,EAAE,UAAU,MAAM,KAAG,iBAoBlF,CAAA;AAED,yCAAyC;AACzC,eAAO,MAAM,UAAU,iBAvB4B,WAAW,YAAY,MAAM,KAAG,iBAuBrC,CAAA"}

package/dist/browser/client/hooks/helpers/getXyoClient.d.ts

@@ -0,0 +1,6 @@
+import type { XyoClient } from '@xyo-network/xl1-sdk';
+export declare const listenForClientInjection: (onClientReady: () => void, timeout: number, onTimeout: () => void) => void;
+type ReturnType = XyoClient | undefined | null;
+export declare function getXyoClient(timeout?: number): Promise<ReturnType>;
+export {};
+//# sourceMappingURL=getXyoClient.d.ts.map

package/dist/browser/client/hooks/helpers/getXyoClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getXyoClient.d.ts","sourceRoot":"","sources":["../../../../../src/client/hooks/helpers/getXyoClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAQrD,eAAO,MAAM,wBAAwB,GAAI,eAAe,MAAM,IAAI,EAAE,SAAS,MAAM,EAAE,WAAW,MAAM,IAAI,SAazG,CAAA;AAED,KAAK,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI,CAAA;AAE9C,wBAAsB,YAAY,CAAC,OAAO,SAA0B,GAAG,OAAO,CAAC,UAAU,CAAC,CAmBzF"}

package/dist/browser/client/hooks/helpers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './getXyoClient.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/client/hooks/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/client/hooks/helpers/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA"}

package/dist/browser/client/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './client/index.ts';
+export * from './helpers/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/client/hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/client/hooks/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA"}

package/dist/browser/client/index.d.ts

@@ -0,0 +1,5 @@
+export * from './components/index.ts';
+export * from './context/index.ts';
+export * from './hooks/index.ts';
+export * from './types/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA;AACrC,cAAc,oBAAoB,CAAA;AAClC,cAAc,kBAAkB,CAAA;AAChC,cAAc,kBAAkB,CAAA"}