@openfeature/web-sdk 0.4.13 → 0.4.14

package/dist/types.d.ts

@@ -1,7 +1,7 @@
-import { BaseHook, HookHints, EvaluationDetails, JsonValue, EvaluationLifeCycle, ManageLogger, Eventing, ClientMetadata, ProviderStatus, ClientProviderEvents, GenericEventEmitter, CommonEventDetails, FlagValue, CommonProvider, EvaluationContext, Logger, ResolutionDetails, EventHandler, OpenFeatureCommonAPI, ManageContext } from '@openfeature/core';
+import * as _openfeature_core from '@openfeature/core';
+import { BaseHook, HookHints, EvaluationDetails, JsonValue, FlagValue, CommonProvider, ClientProviderStatus, EvaluationContext, Logger, ResolutionDetails, ClientProviderEvents, GenericEventEmitter, EvaluationLifeCycle, ManageLogger, Eventing, ClientMetadata, CommonEventDetails, EventHandler, OpenFeatureCommonAPI, ManageContext, ProviderWrapper } from '@openfeature/core';
 export * from '@openfeature/core';
-export { ClientProviderEvents as ProviderEvents } from '@openfeature/core';
-import EventEmitter from 'events';
+export { ClientProviderEvents as ProviderEvents, ClientProviderStatus as ProviderStatus } from '@openfeature/core';
 
 interface FlagEvaluationOptions {
     hooks?: BaseHook[];
@@ -86,39 +86,6 @@ interface Features {
     getObjectDetails<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): EvaluationDetails<T>;
 }
 
-interface Client extends EvaluationLifeCycle<Client>, Features, ManageLogger<Client>, Eventing {
-    readonly metadata: ClientMetadata;
-    /**
-     * Returns the status of the associated provider.
-     */
-    readonly providerStatus: ProviderStatus;
-}
-
-/**
- * A subset of events that can be directly emitted by providers.
- */
-type ProviderEmittableEvents = Exclude<ClientProviderEvents, ClientProviderEvents.ContextChanged>;
-
-/**
- * The OpenFeatureEventEmitter can be used by provider developers to emit
- * events at various parts of the provider lifecycle.
- *
- * NOTE: Ready and error events are automatically emitted by the SDK based on
- * the result of the initialize method.
- */
-declare class OpenFeatureEventEmitter extends GenericEventEmitter<ProviderEmittableEvents> {
-    protected readonly eventEmitter: EventEmitter;
-    constructor();
-}
-
-/**
- * The InternalEventEmitter is not exported publicly and should only be used within the SDK. It extends the
- * OpenFeatureEventEmitter to include additional properties that can be included
- * in the event details.
- */
-declare abstract class InternalEventEmitter extends GenericEventEmitter<ClientProviderEvents, CommonEventDetails> {
-}
-
 type Hook = BaseHook<FlagValue, void, void>;
 
 /**
@@ -127,7 +94,7 @@ type Hook = BaseHook<FlagValue, void, void>;
  *
  * Implementation for resolving all the required flag types must be defined.
  */
-interface Provider extends CommonProvider {
+interface Provider extends CommonProvider<ClientProviderStatus> {
     /**
      * A provider hook exposes a mechanism for provider authors to register hooks
      * to tap into various stages of the flag evaluation lifecycle. These hooks can
@@ -167,7 +134,6 @@ declare class NoopFeatureProvider implements Provider {
     readonly metadata: {
         readonly name: "No-op Provider";
     };
-    get status(): ProviderStatus;
     resolveBooleanEvaluation(_: string, defaultValue: boolean): ResolutionDetails<boolean>;
     resolveStringEvaluation(_: string, defaultValue: string): ResolutionDetails<string>;
     resolveNumberEvaluation(_: string, defaultValue: number): ResolutionDetails<number>;
@@ -176,6 +142,46 @@ declare class NoopFeatureProvider implements Provider {
 }
 declare const NOOP_PROVIDER: NoopFeatureProvider;
 
+type Listener = (...args: any[]) => void;
+
+declare class EventEmitter {
+    static listenerCount(emitter: EventEmitter, type: string | number): number;
+    static defaultMaxListeners: number;
+
+    eventNames(): Array<string | number>;
+    setMaxListeners(n: number): this;
+    getMaxListeners(): number;
+    emit(type: string | number, ...args: any[]): boolean;
+    addListener(type: string | number, listener: Listener): this;
+    on(type: string | number, listener: Listener): this;
+    once(type: string | number, listener: Listener): this;
+    prependListener(type: string | number, listener: Listener): this;
+    prependOnceListener(type: string | number, listener: Listener): this;
+    removeListener(type: string | number, listener: Listener): this;
+    off(type: string | number, listener: Listener): this;
+    removeAllListeners(type?: string | number): this;
+    listeners(type: string | number): Listener[];
+    listenerCount(type: string | number): number;
+    rawListeners(type: string | number): Listener[];
+}
+
+/**
+ * A subset of events that can be directly emitted by providers.
+ */
+type ProviderEmittableEvents = Exclude<ClientProviderEvents, ClientProviderEvents.ContextChanged>;
+
+/**
+ * The OpenFeatureEventEmitter can be used by provider developers to emit
+ * events at various parts of the provider lifecycle.
+ *
+ * NOTE: Ready and error events are automatically emitted by the SDK based on
+ * the result of the initialize method.
+ */
+declare class OpenFeatureEventEmitter extends GenericEventEmitter<ProviderEmittableEvents> {
+    protected readonly eventEmitter: EventEmitter;
+    constructor();
+}
+
 /**
  * Don't export types from this file publicly.
  * It might cause confusion since these types are not a part of the general API,
@@ -216,7 +222,6 @@ type FlagConfiguration = Record<string, Flag>;
 declare class InMemoryProvider implements Provider {
     readonly events: OpenFeatureEventEmitter;
     readonly runsOn = "client";
-    status: ProviderStatus;
     readonly metadata: {
         readonly name: "in-memory";
     };
@@ -238,6 +243,22 @@ declare class InMemoryProvider implements Provider {
     private lookupFlagValue;
 }
 
+interface Client extends EvaluationLifeCycle<Client>, Features, ManageLogger<Client>, Eventing<ClientProviderEvents> {
+    readonly metadata: ClientMetadata;
+    /**
+     * Returns the status of the associated provider.
+     */
+    readonly providerStatus: ClientProviderStatus;
+}
+
+/**
+ * The InternalEventEmitter is not exported publicly and should only be used within the SDK. It extends the
+ * OpenFeatureEventEmitter to include additional properties that can be included
+ * in the event details.
+ */
+declare abstract class InternalEventEmitter extends GenericEventEmitter<ClientProviderEvents, CommonEventDetails> {
+}
+
 type OpenFeatureClientOptions = {
     /**
      * @deprecated Use `domain` instead.
@@ -248,17 +269,18 @@ type OpenFeatureClientOptions = {
 };
 declare class OpenFeatureClient implements Client {
     private readonly providerAccessor;
+    private readonly providerStatusAccessor;
     private readonly emitterAccessor;
     private readonly globalLogger;
     private readonly options;
     private _hooks;
     private _clientLogger?;
-    constructor(providerAccessor: () => Provider, emitterAccessor: () => InternalEventEmitter, globalLogger: () => Logger, options: OpenFeatureClientOptions);
+    constructor(providerAccessor: () => Provider, providerStatusAccessor: () => ClientProviderStatus, emitterAccessor: () => InternalEventEmitter, globalLogger: () => Logger, options: OpenFeatureClientOptions);
     get metadata(): ClientMetadata;
-    get providerStatus(): ProviderStatus;
+    get providerStatus(): ClientProviderStatus;
     addHandler(eventType: ClientProviderEvents, handler: EventHandler): void;
     removeHandler(notificationType: ClientProviderEvents, handler: EventHandler): void;
-    getHandlers(eventType: ClientProviderEvents): EventHandler[];
+    getHandlers(eventType: ClientProviderEvents): EventHandler<ClientProviderEvents | _openfeature_core.ServerProviderEvents>[];
     setLogger(logger: Logger): this;
     addHooks(...hooks: Hook[]): this;
     getHooks(): Hook[];
@@ -280,9 +302,11 @@ declare class OpenFeatureClient implements Client {
     private get _logger();
 }
 
-declare class OpenFeatureAPI extends OpenFeatureCommonAPI<Provider, Hook> implements ManageContext<Promise<void>> {
-    protected _events: GenericEventEmitter<ClientProviderEvents>;
-    protected _defaultProvider: Provider;
+declare class OpenFeatureAPI extends OpenFeatureCommonAPI<ClientProviderStatus, Provider, Hook> implements ManageContext<Promise<void>> {
+    protected _statusEnumType: typeof ClientProviderStatus;
+    protected _apiEmitter: GenericEventEmitter<ClientProviderEvents>;
+    protected _defaultProvider: ProviderWrapper<Provider, ClientProviderStatus>;
+    protected _domainScopedProviders: Map<string, ProviderWrapper<Provider, ClientProviderStatus>>;
     protected _createEventEmitter: () => OpenFeatureEventEmitter;
     private constructor();
     /**
@@ -291,6 +315,7 @@ declare class OpenFeatureAPI extends OpenFeatureCommonAPI<Provider, Hook> implem
      * @returns {OpenFeatureAPI} OpenFeature API
      */
     static getInstance(): OpenFeatureAPI;
+    private getProviderStatus;
     /**
      * Sets the evaluation context globally.
      * This will be used by all providers that have not bound to a domain.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/web-sdk",
-  "version": "0.4.13",
+  "version": "0.4.14",
   "description": "OpenFeature SDK for Web",
   "main": "./dist/cjs/index.js",
   "files": [
@@ -46,9 +46,9 @@
   },
   "homepage": "https://github.com/open-feature/js-sdk#readme",
   "peerDependencies": {
-    "@openfeature/core": "0.0.26"
+    "@openfeature/core": "0.0.27"
   },
   "devDependencies": {
-    "@openfeature/core": "0.0.26"
+    "@openfeature/core": "0.0.27"
   }
 }