@ops-ai/react-router-toggly 1.0.0 → 1.1.0

package/dist/client.d.ts

@@ -27,6 +27,10 @@ type EvaluationMode = 'local' | 'remote';
  * Configuration options for Toggly
  */
 interface TogglyConfig {
+    /** Enable compact browser telemetry (default: true with an app key). */
+    enableTelemetry?: boolean;
+    /** Browser telemetry interval, 30000–60000 ms (default: 45000). */
+    telemetryFlushIntervalMs?: number;
     /** Toggly application key */
     appKey?: string;
     /** Environment name (e.g., 'Production', 'Staging') */
@@ -61,6 +65,8 @@ interface TogglyConfig {
     localGates?: LocalGate[];
     /** Optional SDK error callback for reporting fetch/evaluation failures. */
     onError?: (message: string, error?: unknown) => void;
+    /** Host-minted browser capability; takes precedence over client identity targeting. */
+    instanceId?: string;
     /** Initial browser identity; hydrated server identity takes precedence. */
     identity?: string;
     /** User groups for targeting */
@@ -68,7 +74,7 @@ interface TogglyConfig {
     /** Custom claims for targeting */
     claims?: Record<string, string>;
     /**
-     * Base URL for usage/metrics transport (default: https://app.toggly.io/).
+     * Base URL for usage/metrics transport (default: https://metrics.toggly.io/).
      * Separate from `baseUrl`, which is for definitions/JWKS.
      */
     metricsBaseUrl?: string;
@@ -117,6 +123,8 @@ interface TogglyConfig {
  * User identity context for feature targeting
  */
 interface IdentityContext {
+    /** Browser capability. An empty value clears the token; omitted identity updates use client targeting. */
+    instanceId?: string;
     /** Unique user identifier */
     identity?: string;
     /** User groups for targeting */
@@ -242,10 +250,18 @@ declare const HEADERS: {
 /** Meta key for loader data */
 declare const TOGGLY_LOADER_KEY: "__toggly";
 
+interface FrontendTelemetry {
+    recordUsage(featureKey: string, variant?: string): void;
+    recordView(featureKey: string, variant?: string): void;
+    incrementCounter(metricKey: string, value?: number): void;
+    setGauge(metricKey: string, value: number): void;
+    flushTelemetry(): Promise<void>;
+}
+
 /**
  * Toggly context value
  */
-interface TogglyContextValue {
+interface TogglyContextValue extends FrontendTelemetry {
     /** Current feature flags */
     flags: FeatureFlags;
     /** Whether the client is initialized */
@@ -298,7 +314,7 @@ declare const TogglyContext: react.Context<TogglyContextValue | undefined>;
 /**
  * Toggly Provider component
  */
-declare function TogglyProvider({ children, serverContext, config, enableRefresh, refreshInterval, onFlagsChange, }: TogglyProviderProps): ReactElement;
+declare function TogglyProvider(props: Readonly<TogglyProviderProps>): ReactElement;
 /**
  * Hook to access Toggly context
  */
@@ -600,4 +616,4 @@ declare function TogglyScript({ serverContext, nonce, }: {
  */
 declare function getWindowTogglyData(): ServerFeatureContext | undefined;
 
-export { type EvaluationResult, type EvaluationSeriesData, Feature, FeatureDisabled, type FeatureDisabledProps, FeatureEnabled, type FeatureEnabledProps, type FeatureFlags, FeatureGate, type FeatureGateProps, type FeatureProps, type FeatureRequirement, FeatureSwitch, type FeatureSwitchProps, HEADERS, type HookMetadata, type IdentityContext, type IdentitySeriesData, type LoaderDataWithToggly, RouterTogglyProvider, type RouterTogglyProviderProps, STORAGE_KEYS, type ServerFeatureContext, TOGGLY_LOADER_KEY, type TogglyConfig, TogglyConfigError, TogglyContext, type TogglyContextValue, TogglyError, type TogglyHook, TogglyNetworkError, TogglyProvider, type TogglyProviderProps, TogglyScript, TogglyTimeoutError, extractServerContext, getWindowTogglyData, hasTogglyContext, useABTest, useFeature, useFeatureCallback, useFeatureChange, useFeatureDisabled, useFeatureFlags, useFeatureGate, useFeatureRender, useFeatureValue, useFeatureWithLoading, useFeatures, useIdentity, useRefreshFlags, useToggly, useTogglyContext, useTogglyLoaderData, useTogglyReady, useTogglyRouteLoaderData };
+export { type EvaluationResult, type EvaluationSeriesData, Feature, FeatureDisabled, type FeatureDisabledProps, FeatureEnabled, type FeatureEnabledProps, type FeatureFlags, FeatureGate, type FeatureGateProps, type FeatureProps, type FeatureRequirement, FeatureSwitch, type FeatureSwitchProps, type FrontendTelemetry, HEADERS, type HookMetadata, type IdentityContext, type IdentitySeriesData, type LoaderDataWithToggly, RouterTogglyProvider, type RouterTogglyProviderProps, STORAGE_KEYS, type ServerFeatureContext, TOGGLY_LOADER_KEY, type TogglyConfig, TogglyConfigError, TogglyContext, type TogglyContextValue, TogglyError, type TogglyHook, TogglyNetworkError, TogglyProvider, type TogglyProviderProps, TogglyScript, TogglyTimeoutError, extractServerContext, getWindowTogglyData, hasTogglyContext, useABTest, useFeature, useFeatureCallback, useFeatureChange, useFeatureDisabled, useFeatureFlags, useFeatureGate, useFeatureRender, useFeatureValue, useFeatureWithLoading, useFeatures, useIdentity, useRefreshFlags, useToggly, useTogglyContext, useTogglyLoaderData, useTogglyReady, useTogglyRouteLoaderData };