@kheopskit/core 5.0.1 → 5.1.1

package/dist/index.d.ts

@@ -1,17 +1,18 @@
-export { c as clearAllCachedObservables } from './getCachedObservable-C4E8dfMp.js';
-import { K as KheopskitPlatform, d as KheopskitConfig, a as WalletId, e as createKheopskitStore, f as KheopskitState } from './types-C7V7DGlg.js';
-export { A as AccountOf, g as AppKitInstance, B as BaseWallet, h as BaseWalletAccount, C as CachedAccount, j as CachedWallet, P as PlatformContext, k as PolkadotAccountType, W as WalletAccountId, l as WalletConnectConfig, m as WalletConnectMetadata, n as WalletConnectProvider, b as WalletConnectWallet, o as WalletOf, p as WalletPlatform, q as WalletType, r as getDefaultStore, s as getWalletAccountId, t as getWalletId, i as isInjectedWallet, u as isValidWalletId, c as isWalletConnectWallet, v as parseWalletAccountId, w as parseWalletId } from './types-C7V7DGlg.js';
-import { Observable } from 'rxjs';
-
+import { C as WalletId, D as WalletAccountId, E as parseWalletId, O as getWalletAccountId, S as isWalletConnectWallet, T as isValidWalletId, _ as WalletConnectWallet, a as CachedAccount, b as WalletType, c as KheopskitPlatform, d as KheopskitStoreData, f as PlatformContext, g as WalletConnectProvider, h as WalletConnectMetadata, i as BaseWalletAccount, k as parseWalletAccountId, l as KheopskitState, m as WalletConnectConfig, n as AppKitInstance, o as CachedWallet, p as PolkadotAccountType, r as BaseWallet, s as KheopskitConfig, t as AccountOf, u as KheopskitStore, v as WalletOf, w as getWalletId, x as isInjectedWallet, y as WalletPlatform } from "./types-Cb-vuEru.js";
+import { t as clearAllCachedObservables } from "./getCachedObservable-LUq9IfEx.js";
+import { Observable } from "rxjs";
+//#region src/utils/isValidAddress.d.ts
 declare const isValidAddress: (address: string) => boolean;
-
+//#endregion
+//#region src/api/appKit.d.ts
 /**
  * Clears the cached AppKit observable.
  * Use when configuration changes or for testing purposes.
  * Note: This does NOT destroy the appKit instance created by Reown.
  */
 declare const resetAppKitCache: () => void;
-
+//#endregion
+//#region src/api/config.d.ts
 /**
  * Default storage key for persisting wallet connection state.
  * Can be overridden via config.storageKey to avoid conflicts
@@ -19,24 +20,25 @@ declare const resetAppKitCache: () => void;
  */
 declare const DEFAULT_STORAGE_KEY = "kheopskit";
 declare const resolveConfig: <const P extends readonly KheopskitPlatform[] = readonly KheopskitPlatform[]>(config?: Partial<KheopskitConfig<P>>) => KheopskitConfig<P>;
-
+//#endregion
+//#region src/api/errors.d.ts
 /**
  * Stable error codes thrown by kheopskit. Catch a {@link KheopskitError} and
  * branch on `error.code` instead of matching message strings.
  */
-type KheopskitErrorCode = 
+type KheopskitErrorCode =
 /** `connect()` called on a wallet that is already connected. */
-"WALLET_ALREADY_CONNECTED"
+"WALLET_ALREADY_CONNECTED" |
 /** `disconnect()` called on a wallet that is not connected. */
- | "WALLET_NOT_CONNECTED"
+"WALLET_NOT_CONNECTED" |
 /** The wallet does not advertise a capability kheopskit needs to proceed. */
- | "FEATURE_NOT_SUPPORTED"
+"FEATURE_NOT_SUPPORTED" |
 /** No active WalletConnect session for the requested operation. */
- | "NO_SESSION"
+"NO_SESSION" |
 /** No provider available for the requested namespace. */
- | "NO_PROVIDER"
+"NO_PROVIDER" |
 /** The requested chain cannot be used for this operation (e.g. a Solana cluster with no CAIP-2 id over WalletConnect). */
- | "UNSUPPORTED_CHAIN";
+"UNSUPPORTED_CHAIN";
 /**
  * Error thrown by kheopskit wallet/account operations. Carries a stable
  * {@link KheopskitErrorCode} and, when relevant, the offending wallet id.
@@ -53,29 +55,89 @@ type KheopskitErrorCode =
  * ```
  */
 declare class KheopskitError extends Error {
-    readonly code: KheopskitErrorCode;
-    /** The wallet id this error relates to, when applicable. */
-    readonly walletId?: WalletId;
-    constructor(code: KheopskitErrorCode, message: string, options?: {
-        walletId?: WalletId;
-        cause?: unknown;
-    });
+  readonly code: KheopskitErrorCode;
+  /** The wallet id this error relates to, when applicable. */
+  readonly walletId?: WalletId;
+  constructor(code: KheopskitErrorCode, message: string, options?: {
+    walletId?: WalletId;
+    cause?: unknown;
+  });
 }
-
+//#endregion
+//#region src/api/store.d.ts
+type CreateKheopskitStoreOptions = {
+  /**
+   * Cookie string for SSR hydration.
+   * When provided, uses cookieStorage instead of localStorage.
+   */
+  ssrCookies?: string;
+  /**
+   * Custom storage key to namespace the stored data.
+   * @default "kheopskit"
+   */
+  storageKey?: string;
+};
+/**
+ * Creates a kheopskit store with the appropriate storage backend.
+ * Uses cookieStorage when ssrCookies is provided (for SSR hydration),
+ * otherwise falls back to safeLocalStorage.
+ *
+ * @param options - Configuration options for the store
+ */
+declare const createKheopskitStore: (options?: CreateKheopskitStoreOptions) => KheopskitStore;
+/**
+ * Gets the default store, creating it on first access.
+ * Uses localStorage on client, noop on server.
+ * Lazily initialized to avoid SSR issues with module-level code.
+ */
+declare const getDefaultStore: () => KheopskitStore;
+//#endregion
+//#region src/api/hydration.d.ts
+/** Result of {@link getHydratedSnapshot}: placeholder wallets and accounts built from the cache. */
+type HydratedSnapshot = {
+  wallets: (BaseWallet | WalletConnectWallet)[];
+  accounts: BaseWalletAccount[];
+};
+type GetHydratedSnapshotOptions = {
+  /**
+   * Enrich wallets that have no icon from the localStorage icon cache.
+   *
+   * Must stay `false` for any snapshot that has to match server-rendered markup
+   * (React's `getServerSnapshot` runs on the client during hydration, where the
+   * icon cache is populated — enriching there would diverge from the server,
+   * which always sees an empty cache).
+   */
+  icons?: boolean;
+};
+/**
+ * Builds the cached-state snapshot every consumer must agree on: read the
+ * store's cached state, hydrate wallets/accounts into placeholders, filter
+ * accounts through each platform plugin's `acceptsCachedAccount` hook, and sort
+ * with the same comparators the live pipeline uses.
+ *
+ * This is the single implementation behind the observable's initial seed and
+ * both React snapshot sources (`serverValue`/`initialValue`). They must produce
+ * the same shape in the same order or the UI flickers/reorders on reload — by
+ * sharing this helper, that agreement holds by construction.
+ */
+declare const getHydratedSnapshot: (store: KheopskitStore, platforms: readonly KheopskitPlatform[], options?: GetHydratedSnapshotOptions) => HydratedSnapshot;
+//#endregion
+//#region src/api/kheopskit.d.ts
 /** Options for {@link getKheopskit$}. */
 type GetKheopskitOptions = {
-    /**
-     * Cookie string for SSR hydration. When provided, state is read from cookies
-     * instead of localStorage so the server can hydrate without a flash. Pass the
-     * request's `cookie` header.
-     */
-    ssrCookies?: string;
-    /**
-     * An existing store to reuse instead of creating one. Advanced escape hatch —
-     * most callers omit it. (`@kheopskit/react` passes its provider-scoped store.)
-     */
-    store?: ReturnType<typeof createKheopskitStore>;
+  /**
+   * Cookie string for SSR hydration. When provided, state is read from cookies
+   * instead of localStorage so the server can hydrate without a flash. Pass the
+   * request's `cookie` header.
+   */
+  ssrCookies?: string;
+  /**
+   * An existing store to reuse instead of creating one. Advanced escape hatch —
+   * most callers omit it. (`@kheopskit/react` passes its provider-scoped store.)
+   */
+  store?: ReturnType<typeof createKheopskitStore>;
 };
 declare const getKheopskit$: <const P extends readonly KheopskitPlatform[] = readonly KheopskitPlatform[]>(config?: Partial<KheopskitConfig<P>>, options?: GetKheopskitOptions) => Observable<KheopskitState<P>>;
-
-export { DEFAULT_STORAGE_KEY, type GetKheopskitOptions, KheopskitConfig, KheopskitError, type KheopskitErrorCode, KheopskitPlatform, KheopskitState, WalletId, createKheopskitStore, getKheopskit$, isValidAddress, resetAppKitCache, resolveConfig };
+//#endregion
+export { AccountOf, AppKitInstance, BaseWallet, BaseWalletAccount, CachedAccount, CachedWallet, DEFAULT_STORAGE_KEY, type GetHydratedSnapshotOptions, GetKheopskitOptions, type HydratedSnapshot, KheopskitConfig, KheopskitError, type KheopskitErrorCode, KheopskitPlatform, KheopskitState, KheopskitStore, KheopskitStoreData, PlatformContext, PolkadotAccountType, type WalletAccountId, WalletConnectConfig, WalletConnectMetadata, WalletConnectProvider, WalletConnectWallet, type WalletId, WalletOf, WalletPlatform, WalletType, clearAllCachedObservables, createKheopskitStore, getDefaultStore, getHydratedSnapshot, getKheopskit$, getWalletAccountId, getWalletId, isInjectedWallet, isValidAddress, isValidWalletId, isWalletConnectWallet, parseWalletAccountId, parseWalletId, resetAppKitCache, resolveConfig };
+//# sourceMappingURL=index.d.ts.map