@openfeature/core - npm Package Compare versions

Comparing version 0.0.24 to 0.0.25

dist/types.d.ts

@@ -131,2 +131,40 @@ type FlagValueType = 'boolean' | 'string' | 'number' | 'object';
 
+interface Logger {
+    error(...args: unknown[]): void;
+    warn(...args: unknown[]): void;
+    info(...args: unknown[]): void;
+    debug(...args: unknown[]): void;
+}
+interface ManageLogger<T> {
+    /**
+     * Sets a logger on this receiver. This logger supersedes to the global logger
+     * and is passed to various components in the SDK.
+     * The logger configured on the global API object will be used for all evaluations,
+     * unless overridden in a particular client.
+     * @template T The type of the receiver
+     * @param {Logger} logger The logger to be used
+     * @returns {T} The receiver (this object)
+     */
+    setLogger(logger: Logger): T;
+}
+
+declare class DefaultLogger implements Logger {
+    error(...args: unknown[]): void;
+    warn(...args: unknown[]): void;
+    info(): void;
+    debug(): void;
+}
+
+declare const LOG_LEVELS: Array<keyof Logger>;
+declare class SafeLogger implements Logger {
+    private readonly logger;
+    private readonly fallbackLogger;
+    constructor(logger: Logger);
+    error(...args: unknown[]): void;
+    warn(...args: unknown[]): void;
+    info(...args: unknown[]): void;
+    debug(...args: unknown[]): void;
+    private log;
+}
+
 /**
@@ -185,11 +223,2 @@ * An enumeration of possible events for server-sdk providers.
 
-/**
- * Returns true if the provider's status corresponds to the event.
- * If the provider's status is not defined, it matches READY.
- * @param {AnyProviderEvent} event event to match
- * @param {ProviderStatus} status  status of provider
- * @returns {boolean} boolean indicating if the provider status corresponds to the event.
- */
-declare const statusMatchesEvent: <T extends AnyProviderEvent>(event: T, status?: ProviderStatus) => boolean;
-
 type EventMetadata = {
@@ -244,40 +273,23 @@ [key: string]: string | boolean | number;
 
-interface Logger {
-    error(...args: unknown[]): void;
-    warn(...args: unknown[]): void;
-    info(...args: unknown[]): void;
-    debug(...args: unknown[]): void;
+/**
+ * Event emitter to be optionally implemented by providers.
+ * Implemented by @see OpenFeatureEventEmitter.
+ */
+interface ProviderEventEmitter<E extends AnyProviderEvent, AdditionalContext extends Record<string, unknown> = Record<string, unknown>> extends ManageLogger<ProviderEventEmitter<E, AdditionalContext>> {
+    emit(eventType: E, context?: EventContext): void;
+    addHandler(eventType: AnyProviderEvent, handler: EventHandler): void;
+    removeHandler(eventType: AnyProviderEvent, handler: EventHandler): void;
+    removeAllHandlers(eventType?: AnyProviderEvent): void;
+    getHandlers(eventType: AnyProviderEvent): EventHandler[];
 }
-interface ManageLogger<T> {
-    /**
-     * Sets a logger on this receiver. This logger supersedes to the global logger
-     * and is passed to various components in the SDK.
-     * The logger configured on the global API object will be used for all evaluations,
-     * unless overridden in a particular client.
-     * @template T The type of the receiver
-     * @param {Logger} logger The logger to be used
-     * @returns {T} The receiver (this object)
-     */
-    setLogger(logger: Logger): T;
-}
 
-declare class DefaultLogger implements Logger {
-    error(...args: unknown[]): void;
-    warn(...args: unknown[]): void;
-    info(): void;
-    debug(): void;
-}
+/**
+ * Returns true if the provider's status corresponds to the event.
+ * If the provider's status is not defined, it matches READY.
+ * @param {AnyProviderEvent} event event to match
+ * @param {ProviderStatus} status  status of provider
+ * @returns {boolean} boolean indicating if the provider status corresponds to the event.
+ */
+declare const statusMatchesEvent: <T extends AnyProviderEvent>(event: T, status?: ProviderStatus) => boolean;
 
-declare const LOG_LEVELS: Array<keyof Logger>;
-declare class SafeLogger implements Logger {
-    private readonly logger;
-    private readonly fallbackLogger;
-    constructor(logger: Logger);
-    error(...args: unknown[]): void;
-    warn(...args: unknown[]): void;
-    info(...args: unknown[]): void;
-    debug(...args: unknown[]): void;
-    private log;
-}
-
 /**
@@ -287,3 +299,3 @@ * The GenericEventEmitter should only be used within the SDK. It supports additional properties that can be included
  */
-declare abstract class GenericEventEmitter<E extends AnyProviderEvent, AdditionalContext extends Record<string, unknown> = Record<string, unknown>> implements ManageLogger<GenericEventEmitter<E, AdditionalContext>> {
+declare abstract class GenericEventEmitter<E extends AnyProviderEvent, AdditionalContext extends Record<string, unknown> = Record<string, unknown>> implements ProviderEventEmitter<E>, ManageLogger<GenericEventEmitter<E, AdditionalContext>> {
     private readonly globalLogger?;
@@ -381,3 +393,3 @@ protected abstract readonly eventEmitter: PlatformEventEmitter;
      */
-    events?: GenericEventEmitter<AnyProviderEvent>;
+    events?: ProviderEventEmitter<AnyProviderEvent>;
     /**
@@ -642,2 +654,2 @@ * A function used to shut down the provider.
 
-export { ClientProviderEvents as AllProviderEvents, AnyProviderEvent, BaseHook, BeforeHookContext, ClientMetadata, ClientProviderEvents, CommonEventDetails, CommonProvider, ConfigChangeEvent, DefaultLogger, ErrorCode, ErrorEvent, EvaluationContext, EvaluationContextValue, EvaluationDetails, EvaluationLifeCycle, EventContext, EventDetails, EventHandler, EventMetadata, Eventing, FlagMetadata, FlagNotFoundError, FlagValue, FlagValueType, GeneralError, GenericEventEmitter, HookContext, HookHints, InvalidContextError, JsonArray, JsonObject, JsonValue, LOG_LEVELS, Logger, ManageContext, ManageLogger, Metadata, OpenFeatureCommonAPI, OpenFeatureError, Paradigm, ParseError, PrimitiveValue, ProviderMetadata, ProviderNotReadyError, ProviderStatus, ReadyEvent, ResolutionDetails, ResolutionReason, SafeLogger, ServerProviderEvents, StaleEvent, StandardResolutionReasons, TargetingKeyMissingError, TypeMismatchError, isObject, isString, objectOrUndefined, statusMatchesEvent, stringOrUndefined };
+export { ClientProviderEvents as AllProviderEvents, AnyProviderEvent, BaseHook, BeforeHookContext, ClientMetadata, ClientProviderEvents, CommonEventDetails, CommonProvider, ConfigChangeEvent, DefaultLogger, ErrorCode, ErrorEvent, EvaluationContext, EvaluationContextValue, EvaluationDetails, EvaluationLifeCycle, EventContext, EventDetails, EventHandler, EventMetadata, Eventing, FlagMetadata, FlagNotFoundError, FlagValue, FlagValueType, GeneralError, GenericEventEmitter, HookContext, HookHints, InvalidContextError, JsonArray, JsonObject, JsonValue, LOG_LEVELS, Logger, ManageContext, ManageLogger, Metadata, OpenFeatureCommonAPI, OpenFeatureError, Paradigm, ParseError, PrimitiveValue, ProviderEventEmitter, ProviderMetadata, ProviderNotReadyError, ProviderStatus, ReadyEvent, ResolutionDetails, ResolutionReason, SafeLogger, ServerProviderEvents, StaleEvent, StandardResolutionReasons, TargetingKeyMissingError, TypeMismatchError, isObject, isString, objectOrUndefined, statusMatchesEvent, stringOrUndefined };

package.json

 {
   "name": "@openfeature/core",
-  "version": "0.0.24",
+  "version": "0.0.25",
   "description": "Shared OpenFeature JS components (server and web)",
@@ -5,0 +5,0 @@ "main": "./dist/cjs/index.js",

No alert changes

Improved metrics

Total package byte prevSize

172078

increased by0.52%

Lines of code

1729

increased by0.64%

No dependency changes