@smplkit/sdk 1.3.23 → 1.3.24

package/dist/index.js

@@ -16766,7 +16766,7 @@ var Config = class {
   description;
   /** Parent config UUID, or null if this is a root config. */
   parent;
-  /** Base key-value pairs (unwrapped from typed item definitions). */
+  /** Base key-value pairs. */
   items;
   /**
    * Per-environment overrides.
@@ -17173,9 +17173,7 @@ var ConfigClient = class {
   /**
    * Resolve a config's values for the current environment.
    *
-   * Returns a flat dict of resolved key-value pairs with inherited
-   * values and environment overrides applied.
-   *
+   * Returns the resolved key-value pairs for the given config.
    * Optionally pass a model class to map the resolved values.
    */
   async resolve(key, model) {
@@ -17190,8 +17188,8 @@ var ConfigClient = class {
     return values;
   }
   /**
-   * Subscribe to a config's values — returns a live proxy that
-   * auto-updates when the underlying config changes.
+   * Subscribe to a config's values. Returns a proxy whose properties
+   * always reflect the latest resolved values.
    *
    * Optionally pass a model class to map the resolved values.
    */
@@ -17237,8 +17235,8 @@ var ConfigClient = class {
   // Runtime: refresh
   // ------------------------------------------------------------------
   /**
-   * Re-fetch all configs and re-resolve values.
-   * Fires change listeners for any values that differ.
+   * Refresh all config values from the server.
+   * Fires change listeners for any values that changed.
    */
   async refresh() {
     if (!this._initialized) {
@@ -17416,10 +17414,10 @@ var Flag = class {
     }
   }
   /**
-   * Add a rule to a specific environment (sync local mutation).
+   * Add a rule to a specific environment.
    *
    * The built rule must include an `environment` key (set via
-   * `Rule(...).environment("env_key")`). No HTTP call is made.
+   * `Rule(...).environment("env_key")`). Call `save()` to persist.
    *
    * @returns `this` for chaining.
    */
@@ -17440,7 +17438,7 @@ var Flag = class {
     this.environments = envs;
     return this;
   }
-  /** Enable or disable a flag in a specific environment (sync local mutation). */
+  /** Enable or disable a flag in a specific environment. Call `save()` to persist. */
   setEnvironmentEnabled(envKey, enabled) {
     const envs = { ...this.environments };
     const envData = { ...envs[envKey] ?? { enabled: false, rules: [] } };
@@ -17448,7 +17446,7 @@ var Flag = class {
     envs[envKey] = envData;
     this.environments = envs;
   }
-  /** Set the default value for a specific environment (sync local mutation). */
+  /** Set the default value for a specific environment. Call `save()` to persist. */
   setEnvironmentDefault(envKey, defaultValue) {
     const envs = { ...this.environments };
     const envData = { ...envs[envKey] ?? { enabled: false, rules: [] } };
@@ -17456,7 +17454,7 @@ var Flag = class {
     envs[envKey] = envData;
     this.environments = envs;
   }
-  /** Clear all rules for a specific environment (sync local mutation). */
+  /** Clear all rules for a specific environment. Call `save()` to persist. */
   clearRules(envKey) {
     const envs = { ...this.environments };
     const envData = envs[envKey];
@@ -17466,9 +17464,9 @@ var Flag = class {
     }
   }
   /**
-   * Evaluate the flag locally.
+   * Evaluate the flag and return its current value.
    *
-   * Requires `initialize()` to have been called.
+   * Requires `initialize()` to have been called on the flags client.
    */
   get(options) {
     return this._client._evaluateHandle(this.key, this.default, options?.context ?? null);
@@ -18010,7 +18008,7 @@ var FlagsClient = class {
   // Runtime: initialize / disconnect / refresh
   // ------------------------------------------------------------------
   /**
-   * Initialize the flags runtime: fetch definitions and wire WebSocket.
+   * Initialize the flags runtime.
    *
    * Idempotent — safe to call multiple times. Must be called (and awaited)
    * before using `.get()` on flag handles.
@@ -18025,7 +18023,7 @@ var FlagsClient = class {
     this._wsManager.on("flag_changed", this._handleFlagChanged);
     this._wsManager.on("flag_deleted", this._handleFlagDeleted);
   }
-  /** Disconnect: unregister from WebSocket, flush contexts, clear state. */
+  /** Disconnect the flags runtime and release resources. */
   async disconnect() {
     if (this._wsManager !== null) {
       this._wsManager.off("flag_changed", this._handleFlagChanged);
@@ -18038,30 +18036,30 @@ var FlagsClient = class {
     this._initialized = false;
     this._environment = null;
   }
-  /** Re-fetch all flag definitions and clear cache. */
+  /** Refresh all flag definitions from the server. */
   async refresh() {
     await this._fetchAllFlags();
     this._cache.clear();
     this._fireChangeListenersAll("manual");
   }
-  /** Return the current WebSocket connection status. */
+  /** Return the current real-time connection status. */
   connectionStatus() {
     if (this._wsManager !== null) {
       return this._wsManager.connectionStatus;
     }
     return "disconnected";
   }
-  /** Return cache statistics. */
+  /** Return evaluation statistics. */
   stats() {
     return new FlagStats(this._cache.cacheHits, this._cache.cacheMisses);
   }
   // ------------------------------------------------------------------
-  // Runtime: change listeners (dual-mode)
+  // Runtime: change listeners
   // ------------------------------------------------------------------
   /**
    * Register a change listener.
    *
-   * - `onChange(callback)` — fires for any flag change (global).
+   * - `onChange(callback)` — fires for any flag change.
    * - `onChange(key, callback)` — fires only for the specified flag key.
    */
   onChange(callbackOrKey, callback) {
@@ -18084,8 +18082,7 @@ var FlagsClient = class {
   /**
    * Register context(s) with the server.
    *
-   * Accepts a single Context or an array. Registration is asynchronous
-   * and never blocks. Works before `initialize()` is called.
+   * Accepts a single Context or an array. Works before `initialize()` is called.
    */
   register(context) {
     if (Array.isArray(context)) {
@@ -18103,8 +18100,6 @@ var FlagsClient = class {
   // ------------------------------------------------------------------
   /**
    * Evaluate a flag with an explicit environment and context.
-   *
-   * Stateless — does not use the context provider or cached results.
    */
   async evaluate(key, options) {
     const evalDict = contextsToEvalDict(options.context);
@@ -18353,21 +18348,21 @@ var Logger = class {
     const saved = await this._client._saveLogger(this);
     this._apply(saved);
   }
-  /** Set the base log level (sync local mutation). */
+  /** Set the base log level. Call `save()` to persist. */
   setLevel(level) {
     this.level = level;
   }
-  /** Clear the base log level (sync local mutation). */
+  /** Clear the base log level. Call `save()` to persist. */
   clearLevel() {
     this.level = null;
   }
-  /** Set an environment-specific log level (sync local mutation). */
+  /** Set an environment-specific log level. Call `save()` to persist. */
   setEnvironmentLevel(env, level) {
     const envs = { ...this.environments };
     envs[env] = { ...envs[env] ?? {}, level };
     this.environments = envs;
   }
-  /** Clear an environment-specific log level (sync local mutation). */
+  /** Clear an environment-specific log level. Call `save()` to persist. */
   clearEnvironmentLevel(env) {
     const envs = { ...this.environments };
     if (envs[env]) {
@@ -18377,7 +18372,7 @@ var Logger = class {
       this.environments = envs;
     }
   }
-  /** Clear all environment-specific log levels (sync local mutation). */
+  /** Clear all environment-specific log levels. Call `save()` to persist. */
   clearAllEnvironmentLevels() {
     this.environments = {};
   }
@@ -18438,21 +18433,21 @@ var LogGroup = class {
     const saved = await this._client._saveLogGroup(this);
     this._apply(saved);
   }
-  /** Set the base log level (sync local mutation). */
+  /** Set the base log level. Call `save()` to persist. */
   setLevel(level) {
     this.level = level;
   }
-  /** Clear the base log level (sync local mutation). */
+  /** Clear the base log level. Call `save()` to persist. */
   clearLevel() {
     this.level = null;
   }
-  /** Set an environment-specific log level (sync local mutation). */
+  /** Set an environment-specific log level. Call `save()` to persist. */
   setEnvironmentLevel(env, level) {
     const envs = { ...this.environments };
     envs[env] = { ...envs[env] ?? {}, level };
     this.environments = envs;
   }
-  /** Clear an environment-specific log level (sync local mutation). */
+  /** Clear an environment-specific log level. Call `save()` to persist. */
   clearEnvironmentLevel(env) {
     const envs = { ...this.environments };
     if (envs[env]) {
@@ -18462,7 +18457,7 @@ var LogGroup = class {
       this.environments = envs;
     }
   }
-  /** Clear all environment-specific log levels (sync local mutation). */
+  /** Clear all environment-specific log levels. Call `save()` to persist. */
   clearAllEnvironmentLevels() {
     this.environments = {};
   }
@@ -18548,8 +18543,8 @@ var LoggingClient = class {
   /**
    * Register a logging framework adapter.
    *
-   * Must be called before `start()`. Disables auto-loading of built-in
-   * adapters — only explicitly registered adapters will be used.
+   * Must be called before `start()`. When called, only explicitly
+   * registered adapters will be used.
    */
   registerAdapter(adapter) {
     if (this._started) {
@@ -18776,12 +18771,9 @@ var LoggingClient = class {
   /**
    * Start the logging runtime.
    *
-   * Discovers loggers from registered adapters, syncs them with the
-   * server, applies server-side log levels, and subscribes to live
-   * level updates.
-   *
-   * Idempotent — safe to call multiple times.
-   * Management methods work without start().
+   * Synchronizes loggers with the server and subscribes to live level
+   * updates. Idempotent — safe to call multiple times.
+   * Management methods work without calling `start()`.
    */
   async start() {
     if (this._started) return;
@@ -18822,12 +18814,12 @@ var LoggingClient = class {
     this._started = true;
   }
   // ------------------------------------------------------------------
-  // Runtime: change listeners (dual-mode)
+  // Runtime: change listeners
   // ------------------------------------------------------------------
   /**
    * Register a change listener.
    *
-   * - `onChange(callback)` — fires for any logger change (global).
+   * - `onChange(callback)` — fires for any logger change.
    * - `onChange(key, callback)` — fires only for the specified logger key.
    */
   onChange(callbackOrKey, callback) {