@openfeature/flagd-provider 0.7.6 → 0.8.0

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@openfeature/flagd-provider",
-  "version": "0.7.6",
+  "version": "0.8.0",
   "scripts": {
     "publish-if-not-exists": "cp $NPM_CONFIG_USERCONFIG .npmrc && if [ \"$(npm show $npm_package_name@$npm_package_version version)\" = \"$(npm run current-version -s)\" ]; then echo 'already published, skipping'; else npm publish --access public; fi",
     "current-version": "echo $npm_package_version"
   },
   "peerDependencies": {
-    "@openfeature/js-sdk": "^1.1.0"
+    "@grpc/grpc-js": "^1.6.0",
+    "@openfeature/js-sdk": ">=1.3.0"
   },
   "module": "./index.js",
   "main": "./index.cjs",
@@ -20,10 +21,7 @@
     }
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.8.13",
-    "@protobuf-ts/grpc-transport": "2.8.3",
-    "@protobuf-ts/runtime": "2.8.3",
-    "@protobuf-ts/runtime-rpc": "2.8.3",
-    "lru-cache": "8.0.5"
+    "@protobuf-ts/runtime-rpc": "2.9.0",
+    "lru-cache": "10.0.0"
   }
 }

package/src/index.d.ts

@@ -1 +1 @@
-export * from './lib/flagd-provider';
+export * from './lib/flagd-provider';

package/src/lib/configuration.d.ts

@@ -1,55 +1,55 @@
-export type CacheOption = 'lru' | 'disabled';
-export interface Config {
-    /**
-     * The domain name or IP address of flagd.
-     *
-     * @default localhost
-     */
-    host: string;
-    /**
-     * The port flagd is listen on.
-     *
-     * @default 8013
-     */
-    port: number;
-    /**
-     * Determines if TLS should be used.
-     *
-     * @default false
-     */
-    tls: boolean;
-    /**
-     * When set, a unix socket connection is used.
-     *
-     * @example "/tmp/flagd.socks"
-     */
-    socketPath?: string;
-    /**
-     * Cache implementation to use (or disabled).
-     *
-     * @default 'lru'
-     */
-    cache?: CacheOption;
-    /**
-     * Max cache size (items).
-     *
-     * @default 1000
-     */
-    maxCacheSize?: number;
-    /**
-     * Amount of times to attempt to reconnect to the event stream.
-     *
-     * @default 5
-     */
-    maxEventStreamRetries?: number;
-}
-export type FlagdProviderOptions = Partial<Config>;
-export declare function getConfig(options?: FlagdProviderOptions): {
-    host: string;
-    port: number;
-    tls: boolean;
-    socketPath?: string | undefined;
-    cache?: CacheOption | undefined;
-    maxCacheSize?: number | undefined;
-    maxEventStreamRetries?: number | undefined;
-};
+export type CacheOption = 'lru' | 'disabled';
+export interface Config {
+    /**
+     * The domain name or IP address of flagd.
+     *
+     * @default localhost
+     */
+    host: string;
+    /**
+     * The port flagd is listen on.
+     *
+     * @default 8013
+     */
+    port: number;
+    /**
+     * Determines if TLS should be used.
+     *
+     * @default false
+     */
+    tls: boolean;
+    /**
+     * When set, a unix socket connection is used.
+     *
+     * @example "/tmp/flagd.socks"
+     */
+    socketPath?: string;
+    /**
+     * Cache implementation to use (or disabled).
+     *
+     * @default 'lru'
+     */
+    cache?: CacheOption;
+    /**
+     * Max cache size (items).
+     *
+     * @default 1000
+     */
+    maxCacheSize?: number;
+    /**
+     * Amount of times to attempt to reconnect to the event stream.
+     *
+     * @default 5
+     */
+    maxEventStreamRetries?: number;
+}
+export type FlagdProviderOptions = Partial<Config>;
+export declare function getConfig(options?: FlagdProviderOptions): {
+    host: string;
+    port: number;
+    tls: boolean;
+    socketPath?: string | undefined;
+    cache?: CacheOption | undefined;
+    maxCacheSize?: number | undefined;
+    maxEventStreamRetries?: number | undefined;
+};

package/src/lib/constants.d.ts

@@ -1,5 +1,5 @@
-export declare const BASE_EVENT_STREAM_RETRY_BACKOFF_MS = 1000;
-export declare const DEFAULT_MAX_EVENT_STREAM_RETRIES = 5;
-export declare const EVENT_CONFIGURATION_CHANGE = "configuration_change";
-export declare const EVENT_PROVIDER_READY = "provider_ready";
-export declare const DEFAULT_MAX_CACHE_SIZE = 1000;
+export declare const BASE_EVENT_STREAM_RETRY_BACKOFF_MS = 1000;
+export declare const DEFAULT_MAX_EVENT_STREAM_RETRIES = 5;
+export declare const EVENT_CONFIGURATION_CHANGE = "configuration_change";
+export declare const EVENT_PROVIDER_READY = "provider_ready";
+export declare const DEFAULT_MAX_CACHE_SIZE = 1000;

package/src/lib/flagd-provider.d.ts

@@ -1,25 +1,32 @@
-import { EvaluationContext, JsonValue, Logger, Provider, ResolutionDetails } from '@openfeature/js-sdk';
-import { FlagdProviderOptions } from './configuration';
-import { Service } from './service/service';
-export declare class FlagdProvider implements Provider {
-    private logger?;
-    metadata: {
-        name: string;
-    };
-    private readonly _service;
-    /**
-     * Promise indicating the gRPC stream is connected.
-     *
-     * Can be used in instances where the provider being connected to the event stream is a prerequisite
-     * to execution (e.g. testing). Not necessary for standard usage.
-     *
-     * @returns true if stream connected successfully, false if connection not enabled.
-     */
-    get streamConnection(): Promise<boolean>;
-    constructor(options?: FlagdProviderOptions, service?: Service, logger?: Logger | undefined);
-    resolveBooleanEvaluation(flagKey: string, _: boolean, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
-    resolveStringEvaluation(flagKey: string, _: string, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
-    resolveNumberEvaluation(flagKey: string, _: number, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
-    resolveObjectEvaluation<T extends JsonValue>(flagKey: string, _: T, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
-    logRejected: (err: Error, flagKey: string, logger: Logger) => never;
-}
+import { EvaluationContext, JsonValue, Logger, OpenFeatureEventEmitter, Provider, ProviderStatus, ResolutionDetails } from '@openfeature/js-sdk';
+import { FlagdProviderOptions } from './configuration';
+import { Service } from './service/service';
+export declare class FlagdProvider implements Provider {
+    private logger?;
+    metadata: {
+        name: string;
+    };
+    get status(): ProviderStatus;
+    get events(): OpenFeatureEventEmitter;
+    private readonly _service;
+    private _status;
+    private _events;
+    /**
+     * Construct a new flagd provider.
+     *
+     * @param options options, see {@link FlagdProviderOptions}
+     * @param logger optional logger, see {@link Logger}
+     * @param service optional internal service implementation, should not be needed for production
+     */
+    constructor(options?: FlagdProviderOptions, logger?: Logger | undefined, service?: Service);
+    initialize(): Promise<void>;
+    onClose(): Promise<void>;
+    resolveBooleanEvaluation(flagKey: string, _: boolean, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
+    resolveStringEvaluation(flagKey: string, _: string, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
+    resolveNumberEvaluation(flagKey: string, _: number, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
+    resolveObjectEvaluation<T extends JsonValue>(flagKey: string, _: T, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
+    logRejected: (err: Error, flagKey: string, logger: Logger) => never;
+    private setReady;
+    private setError;
+    private emitChanged;
+}

package/src/lib/service/grpc/service.d.ts

@@ -1,50 +1,51 @@
-import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/js-sdk';
-import { ServiceClient } from '../../../proto/ts/schema/v1/schema.client';
-import { Config } from '../../configuration';
-import { Service } from '../service';
-interface FlagChange {
-    type: 'delete' | 'write' | 'update';
-    source: string;
-    flagKey: string;
-}
-export interface FlagChangeMessage {
-    flags?: {
-        [key: string]: FlagChange;
-    };
-}
-export declare const Codes: {
-    readonly InvalidArgument: "INVALID_ARGUMENT";
-    readonly NotFound: "NOT_FOUND";
-    readonly DataLoss: "DATA_LOSS";
-    readonly Unavailable: "UNAVAILABLE";
-};
-export declare class GRPCService implements Service {
-    private logger?;
-    private _client;
-    private _cache;
-    private _cacheEnabled;
-    private _streamAlive;
-    private _streamConnectAttempt;
-    private _streamConnectBackoff;
-    private _maxEventStreamRetries;
-    private get _cacheActive();
-    readonly streamConnection: Promise<boolean>;
-    constructor(config: Config, client?: ServiceClient, logger?: Logger | undefined);
-    resolveBoolean(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
-    resolveString(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
-    resolveNumber(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
-    resolveObject<T extends JsonValue>(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
-    private connectStream;
-    private handleProviderReady;
-    private handleFlagsChanged;
-    private handleError;
-    private handleComplete;
-    private objectParser;
-    private booleanParser;
-    private stringParser;
-    private numberParser;
-    private resolve;
-    private convertContext;
-    private onRejected;
-}
-export {};
+import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/js-sdk';
+import { ServiceClient } from '../../../proto/ts/schema/v1/schema';
+import { Config } from '../../configuration';
+import { Service } from '../service';
+interface FlagChange {
+    type: 'delete' | 'write' | 'update';
+    source: string;
+    flagKey: string;
+}
+export interface FlagChangeMessage {
+    flags?: {
+        [key: string]: FlagChange;
+    };
+}
+export declare const Codes: {
+    readonly InvalidArgument: "INVALID_ARGUMENT";
+    readonly NotFound: "NOT_FOUND";
+    readonly DataLoss: "DATA_LOSS";
+    readonly Unavailable: "UNAVAILABLE";
+};
+export declare class GRPCService implements Service {
+    private logger?;
+    private _client;
+    private _cache;
+    private _cacheEnabled;
+    private _streamAlive;
+    private _streamConnectAttempt;
+    private _stream;
+    private _streamConnectBackoff;
+    private _maxEventStreamRetries;
+    private get _cacheActive();
+    constructor(config: Config, client?: ServiceClient, logger?: Logger | undefined);
+    connect(connectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
+    disconnect(): Promise<void>;
+    resolveBoolean(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
+    resolveString(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
+    resolveNumber(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
+    resolveObject<T extends JsonValue>(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
+    private connectStream;
+    private handleProviderReady;
+    private handleFlagsChanged;
+    private handleError;
+    private handleClose;
+    private objectParser;
+    private booleanParser;
+    private stringParser;
+    private numberParser;
+    private resolve;
+    private onRejected;
+}
+export {};

package/src/lib/service/service.d.ts

@@ -1,8 +1,9 @@
-import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/js-sdk';
-export interface Service {
-    readonly streamConnection: Promise<boolean>;
-    resolveBoolean(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
-    resolveString(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
-    resolveNumber(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
-    resolveObject<T extends JsonValue>(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
-}
+import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/js-sdk';
+export interface Service {
+    connect(reconnectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
+    disconnect(): Promise<void>;
+    resolveBoolean(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
+    resolveString(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
+    resolveNumber(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
+    resolveObject<T extends JsonValue>(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
+}

package/src/package.json

@@ -1,3 +1,3 @@
 {
   "module": "commonjs"
-}
+}