@openfeature/flagd-provider 0.7.7 → 0.8.0

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@openfeature/flagd-provider",
-  "version": "0.7.7",
+  "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": {
     "@grpc/grpc-js": "^1.6.0",
-    "@openfeature/js-sdk": "^1.1.0"
+    "@openfeature/js-sdk": ">=1.3.0"
   },
   "module": "./index.js",
   "main": "./index.cjs",
@@ -21,7 +21,6 @@
     }
   },
   "dependencies": {
-    "@protobuf-ts/grpc-transport": "2.9.0",
     "@protobuf-ts/runtime-rpc": "2.9.0",
     "lru-cache": "10.0.0"
   }

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

@@ -1,4 +1,4 @@
-import { EvaluationContext, JsonValue, Logger, Provider, ResolutionDetails } from '@openfeature/js-sdk';
+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 {
@@ -6,20 +6,27 @@ export declare class FlagdProvider implements Provider {
     metadata: {
         name: string;
     };
+    get status(): ProviderStatus;
+    get events(): OpenFeatureEventEmitter;
     private readonly _service;
+    private _status;
+    private _events;
     /**
-     * Promise indicating the gRPC stream is connected.
+     * Construct a new flagd provider.
      *
-     * 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.
+     * @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
      */
-    get streamConnection(): Promise<boolean>;
-    constructor(options?: FlagdProviderOptions, service?: Service, logger?: Logger | undefined);
+    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,5 +1,5 @@
 import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/js-sdk';
-import { ServiceClient } from '../../../proto/ts/schema/v1/schema.client';
+import { ServiceClient } from '../../../proto/ts/schema/v1/schema';
 import { Config } from '../../configuration';
 import { Service } from '../service';
 interface FlagChange {
@@ -25,11 +25,13 @@ export declare class GRPCService implements Service {
     private _cacheEnabled;
     private _streamAlive;
     private _streamConnectAttempt;
+    private _stream;
     private _streamConnectBackoff;
     private _maxEventStreamRetries;
     private get _cacheActive();
-    readonly streamConnection: Promise<boolean>;
     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>>;
@@ -38,13 +40,12 @@ export declare class GRPCService implements Service {
     private handleProviderReady;
     private handleFlagsChanged;
     private handleError;
-    private handleComplete;
+    private handleClose;
     private objectParser;
     private booleanParser;
     private stringParser;
     private numberParser;
     private resolve;
-    private convertContext;
     private onRejected;
 }
 export {};

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

@@ -1,6 +1,7 @@
 import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/js-sdk';
 export interface Service {
-    readonly streamConnection: Promise<boolean>;
+    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>>;

package/src/proto/ts/google/protobuf/struct.d.ts

@@ -1,12 +1,18 @@
-import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
-import type { IBinaryWriter } from "@protobuf-ts/runtime";
-import type { BinaryReadOptions } from "@protobuf-ts/runtime";
-import type { IBinaryReader } from "@protobuf-ts/runtime";
-import type { PartialMessage } from "@protobuf-ts/runtime";
-import type { JsonValue } from "@protobuf-ts/runtime";
-import type { JsonReadOptions } from "@protobuf-ts/runtime";
-import type { JsonWriteOptions } from "@protobuf-ts/runtime";
-import { MessageType } from "@protobuf-ts/runtime";
+import _m0 from "protobufjs/minimal";
+export declare const protobufPackage = "google.protobuf";
+/**
+ * `NullValue` is a singleton enumeration to represent the null value for the
+ * `Value` type union.
+ *
+ *  The JSON representation for `NullValue` is JSON `null`.
+ */
+export declare enum NullValue {
+    /** NULL_VALUE - Null value. */
+    NULL_VALUE = 0,
+    UNRECOGNIZED = -1
+}
+export declare function nullValueFromJSON(object: any): NullValue;
+export declare function nullValueToJSON(object: NullValue): string;
 /**
  * `Struct` represents a structured data value, consisting of fields
  * which map to dynamically typed values. In some languages, `Struct`
@@ -16,19 +22,17 @@ import { MessageType } from "@protobuf-ts/runtime";
  * with the proto support for the language.
  *
  * The JSON representation for `Struct` is JSON object.
- *
- * @generated from protobuf message google.protobuf.Struct
  */
 export interface Struct {
-    /**
-     * Unordered map of dynamically typed values.
-     *
-     * @generated from protobuf field: map<string, google.protobuf.Value> fields = 1;
-     */
+    /** Unordered map of dynamically typed values. */
     fields: {
-        [key: string]: Value;
+        [key: string]: any | undefined;
     };
 }
+export interface Struct_FieldsEntry {
+    key: string;
+    value: any | undefined;
+}
 /**
  * `Value` represents a dynamically typed value which can be either
  * null, a number, a string, a boolean, a recursive struct value, or a
@@ -36,149 +40,162 @@ export interface Struct {
  * variants. Absence of any variant indicates an error.
  *
  * The JSON representation for `Value` is JSON value.
- *
- * @generated from protobuf message google.protobuf.Value
  */
 export interface Value {
-    /**
-     * @generated from protobuf oneof: kind
-     */
-    kind: {
-        oneofKind: "nullValue";
-        /**
-         * Represents a null value.
-         *
-         * @generated from protobuf field: google.protobuf.NullValue null_value = 1;
-         */
-        nullValue: NullValue;
-    } | {
-        oneofKind: "numberValue";
-        /**
-         * Represents a double value.
-         *
-         * @generated from protobuf field: double number_value = 2;
-         */
-        numberValue: number;
-    } | {
-        oneofKind: "stringValue";
-        /**
-         * Represents a string value.
-         *
-         * @generated from protobuf field: string string_value = 3;
-         */
-        stringValue: string;
-    } | {
-        oneofKind: "boolValue";
-        /**
-         * Represents a boolean value.
-         *
-         * @generated from protobuf field: bool bool_value = 4;
-         */
-        boolValue: boolean;
-    } | {
-        oneofKind: "structValue";
-        /**
-         * Represents a structured value.
-         *
-         * @generated from protobuf field: google.protobuf.Struct struct_value = 5;
-         */
-        structValue: Struct;
-    } | {
-        oneofKind: "listValue";
-        /**
-         * Represents a repeated `Value`.
-         *
-         * @generated from protobuf field: google.protobuf.ListValue list_value = 6;
-         */
-        listValue: ListValue;
-    } | {
-        oneofKind: undefined;
-    };
+    /** Represents a null value. */
+    nullValue?: NullValue | undefined;
+    /** Represents a double value. */
+    numberValue?: number | undefined;
+    /** Represents a string value. */
+    stringValue?: string | undefined;
+    /** Represents a boolean value. */
+    boolValue?: boolean | undefined;
+    /** Represents a structured value. */
+    structValue?: {
+        [key: string]: any;
+    } | undefined;
+    /** Represents a repeated `Value`. */
+    listValue?: Array<any> | undefined;
 }
 /**
  * `ListValue` is a wrapper around a repeated field of values.
  *
  * The JSON representation for `ListValue` is JSON array.
- *
- * @generated from protobuf message google.protobuf.ListValue
  */
 export interface ListValue {
-    /**
-     * Repeated field of dynamically typed values.
-     *
-     * @generated from protobuf field: repeated google.protobuf.Value values = 1;
-     */
-    values: Value[];
-}
-/**
- * `NullValue` is a singleton enumeration to represent the null value for the
- * `Value` type union.
- *
- *  The JSON representation for `NullValue` is JSON `null`.
- *
- * @generated from protobuf enum google.protobuf.NullValue
- */
-export declare enum NullValue {
-    /**
-     * Null value.
-     *
-     * @generated from protobuf enum value: NULL_VALUE = 0;
-     */
-    NULL_VALUE = 0
-}
-declare class Struct$Type extends MessageType<Struct> {
-    constructor();
-    /**
-     * Encode `Struct` to JSON object.
-     */
-    internalJsonWrite(message: Struct, options: JsonWriteOptions): JsonValue;
-    /**
-     * Decode `Struct` from JSON object.
-     */
-    internalJsonRead(json: JsonValue, options: JsonReadOptions, target?: Struct): Struct;
-    create(value?: PartialMessage<Struct>): Struct;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Struct): Struct;
-    private binaryReadMap1;
-    internalBinaryWrite(message: Struct, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
-}
-/**
- * @generated MessageType for protobuf message google.protobuf.Struct
- */
-export declare const Struct: Struct$Type;
-declare class Value$Type extends MessageType<Value> {
-    constructor();
-    /**
-     * Encode `Value` to JSON value.
-     */
-    internalJsonWrite(message: Value, options: JsonWriteOptions): JsonValue;
-    /**
-     * Decode `Value` from JSON value.
-     */
-    internalJsonRead(json: JsonValue, options: JsonReadOptions, target?: Value): Value;
-    create(value?: PartialMessage<Value>): Value;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: Value): Value;
-    internalBinaryWrite(message: Value, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
-}
-/**
- * @generated MessageType for protobuf message google.protobuf.Value
- */
-export declare const Value: Value$Type;
-declare class ListValue$Type extends MessageType<ListValue> {
-    constructor();
-    /**
-     * Encode `ListValue` to JSON array.
-     */
-    internalJsonWrite(message: ListValue, options: JsonWriteOptions): JsonValue;
-    /**
-     * Decode `ListValue` from JSON array.
-     */
-    internalJsonRead(json: JsonValue, options: JsonReadOptions, target?: ListValue): ListValue;
-    create(value?: PartialMessage<ListValue>): ListValue;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ListValue): ListValue;
-    internalBinaryWrite(message: ListValue, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+    /** Repeated field of dynamically typed values. */
+    values: any[];
 }
-/**
- * @generated MessageType for protobuf message google.protobuf.ListValue
- */
-export declare const ListValue: ListValue$Type;
+export declare const Struct: {
+    encode(message: Struct, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Struct;
+    fromJSON(object: any): Struct;
+    toJSON(message: Struct): unknown;
+    create<I extends {
+        fields?: {
+            [x: string]: any;
+        } | undefined;
+    } & {
+        fields?: ({
+            [x: string]: any;
+        } & {
+            [x: string]: any;
+        } & { [K in Exclude<keyof I["fields"], string | number>]: never; }) | undefined;
+    } & { [K_1 in Exclude<keyof I, "fields">]: never; }>(base?: I | undefined): Struct;
+    fromPartial<I_1 extends {
+        fields?: {
+            [x: string]: any;
+        } | undefined;
+    } & {
+        fields?: ({
+            [x: string]: any;
+        } & {
+            [x: string]: any;
+        } & { [K_2 in Exclude<keyof I_1["fields"], string | number>]: never; }) | undefined;
+    } & { [K_3 in Exclude<keyof I_1, "fields">]: never; }>(object: I_1): Struct;
+    wrap(object: {
+        [key: string]: any;
+    } | undefined): Struct;
+    unwrap(message: Struct): {
+        [key: string]: any;
+    };
+};
+export declare const Struct_FieldsEntry: {
+    encode(message: Struct_FieldsEntry, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Struct_FieldsEntry;
+    fromJSON(object: any): Struct_FieldsEntry;
+    toJSON(message: Struct_FieldsEntry): unknown;
+    create<I extends {
+        key?: string | undefined;
+        value?: any | undefined;
+    } & {
+        key?: string | undefined;
+        value?: any | undefined;
+    } & { [K in Exclude<keyof I, keyof Struct_FieldsEntry>]: never; }>(base?: I | undefined): Struct_FieldsEntry;
+    fromPartial<I_1 extends {
+        key?: string | undefined;
+        value?: any | undefined;
+    } & {
+        key?: string | undefined;
+        value?: any | undefined;
+    } & { [K_1 in Exclude<keyof I_1, keyof Struct_FieldsEntry>]: never; }>(object: I_1): Struct_FieldsEntry;
+};
+export declare const Value: {
+    encode(message: Value, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Value;
+    fromJSON(object: any): Value;
+    toJSON(message: Value): unknown;
+    create<I extends {
+        nullValue?: NullValue | undefined;
+        numberValue?: number | undefined;
+        stringValue?: string | undefined;
+        boolValue?: boolean | undefined;
+        structValue?: {
+            [x: string]: any;
+        } | undefined;
+        listValue?: any[] | undefined;
+    } & {
+        nullValue?: NullValue | undefined;
+        numberValue?: number | undefined;
+        stringValue?: string | undefined;
+        boolValue?: boolean | undefined;
+        structValue?: ({
+            [x: string]: any;
+        } & {
+            [x: string]: any;
+        } & { [K in Exclude<keyof I["structValue"], string | number>]: never; }) | undefined;
+        listValue?: (any[] & any[] & { [K_1 in Exclude<keyof I["listValue"], keyof any[]>]: never; }) | undefined;
+    } & { [K_2 in Exclude<keyof I, keyof Value>]: never; }>(base?: I | undefined): Value;
+    fromPartial<I_1 extends {
+        nullValue?: NullValue | undefined;
+        numberValue?: number | undefined;
+        stringValue?: string | undefined;
+        boolValue?: boolean | undefined;
+        structValue?: {
+            [x: string]: any;
+        } | undefined;
+        listValue?: any[] | undefined;
+    } & {
+        nullValue?: NullValue | undefined;
+        numberValue?: number | undefined;
+        stringValue?: string | undefined;
+        boolValue?: boolean | undefined;
+        structValue?: ({
+            [x: string]: any;
+        } & {
+            [x: string]: any;
+        } & { [K_3 in Exclude<keyof I_1["structValue"], string | number>]: never; }) | undefined;
+        listValue?: (any[] & any[] & { [K_4 in Exclude<keyof I_1["listValue"], keyof any[]>]: never; }) | undefined;
+    } & { [K_5 in Exclude<keyof I_1, keyof Value>]: never; }>(object: I_1): Value;
+    wrap(value: any): Value;
+    unwrap(message: any): string | number | boolean | Object | null | Array<any> | undefined;
+};
+export declare const ListValue: {
+    encode(message: ListValue, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): ListValue;
+    fromJSON(object: any): ListValue;
+    toJSON(message: ListValue): unknown;
+    create<I extends {
+        values?: any[] | undefined;
+    } & {
+        values?: (any[] & any[] & { [K in Exclude<keyof I["values"], keyof any[]>]: never; }) | undefined;
+    } & { [K_1 in Exclude<keyof I, "values">]: never; }>(base?: I | undefined): ListValue;
+    fromPartial<I_1 extends {
+        values?: any[] | undefined;
+    } & {
+        values?: (any[] & any[] & { [K_2 in Exclude<keyof I_1["values"], keyof any[]>]: never; }) | undefined;
+    } & { [K_3 in Exclude<keyof I_1, "values">]: never; }>(object: I_1): ListValue;
+    wrap(array: Array<any> | undefined): ListValue;
+    unwrap(message: ListValue): Array<any>;
+};
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
 export {};