@ecency/sdk 2.3.62 → 2.3.64

package/dist/browser/index.d.ts

@@ -960,6 +960,18 @@ declare function withTimeoutSignal(timeoutMs: number, signal?: AbortSignal): Abo
 declare const INTERNAL_API_TIMEOUT_MS = 10000;
 declare const CONFIG: {
     privateApiHost: string;
+    /**
+     * Observer used for bridge calls when nobody is logged in. The bridge applies
+     * this account's mute list to the response, marking muted authors' posts and
+     * comments `stats.gray` so clients can dim or collapse them. Anonymous
+     * visitors therefore inherit Ecency's moderation instead of seeing an
+     * unfiltered firehose. Apps may override via `ConfigManager.setDefaultObserver`,
+     * which expects a real account rather than "" (see that setter).
+     *
+     * Note this only *marks* content: the bridge still returns muted authors'
+     * posts, so an observer never shortens a feed.
+     */
+    defaultObserver: string;
     /**
      * First-party client identifier sent as the `X-Ecency-Client` header on
      * search/private API requests. Lets the origin distinguish Ecency's own
@@ -973,6 +985,13 @@ declare const CONFIG: {
     /** Current Hive RPC nodes. Reads from the unified hive-tx config. */
     readonly hiveNodes: string[];
     heliusApiKey: string | undefined;
+    /**
+     * The React Query client all SDK code reads through `getQueryClient()`.
+     * Backed by a resolver so an SSR host can scope it per request — see the
+     * `queryClientResolver` note above. Assigning replaces the resolver with one
+     * that always returns the assigned client, preserving the previous
+     * "one client, set once" behaviour for browser and native hosts.
+     */
     queryClient: QueryClient;
     pollsApiHost: string;
     plausibleHost: string;
@@ -990,6 +1009,25 @@ type DmcaListsInput = {
 };
 declare namespace ConfigManager {
     function setQueryClient(client: QueryClient): void;
+    /**
+     * Register how the SDK should obtain its React Query client, for hosts where
+     * a single shared instance is wrong — principally SSR, where one process
+     * serves many requests and a shared cache both leaks memory and risks serving
+     * one request's data to another.
+     *
+     * `resolve` is called on every SDK cache access and should return the client
+     * belonging to the request currently being handled. In a Next.js App Router
+     * host that means wrapping the factory in React's `cache()`, which memoises
+     * per request:
+     *
+     * ```ts
+     * ConfigManager.setQueryClientResolver(() => getQueryClient());
+     * ```
+     *
+     * Registering a resolver supersedes any client previously passed to
+     * `setQueryClient`; assigning a client afterwards supersedes the resolver.
+     */
+    function setQueryClientResolver(resolve: () => QueryClient): void;
     /**
      * Set the private API host
      * @param host - The private API host URL (e.g., "https://ecency.com" or "" for relative URLs)
@@ -1003,6 +1041,20 @@ declare namespace ConfigManager {
      * @param clientId - Short client label
      */
     function setClientId(clientId: string): void;
+    /**
+     * Set the observer used for bridge calls made without a logged-in user.
+     * Defaults to "ecency"; a third-party integrator should point this at their
+     * own moderation account.
+     *
+     * Must be a real account. An empty value is rejected rather than treated as
+     * an opt-out: consumers resolve the observer with `||`, and `getDiscussion`
+     * separately falls back to the post author, so "" would not disable mute
+     * marking. It would silently observe as someone else while being cached under
+     * "", leaving the request and its cache key describing different things.
+     * @param observer - Hive account whose mute list applies to anonymous reads
+     * @throws If given an empty or whitespace-only value
+     */
+    function setDefaultObserver(observer: string): void;
     /**
      * Get a validated base URL for API requests
      * Returns a valid base URL that can be used with new URL(path, baseUrl)
@@ -1191,6 +1243,11 @@ declare function isInfoError(error: any): boolean;
  */
 declare function isNetworkError(error: any): boolean;
 
+/**
+ * Builds a client with the SDK's defaults. It is only a factory — request
+ * scoping is the host's job, via `ConfigManager.setQueryClientResolver`, since
+ * only the host knows where one request ends and the next begins.
+ */
 declare function makeQueryClient(): QueryClient;
 declare const getQueryClient: () => QueryClient;
 declare namespace EcencyQueriesManager {