@openfeature/flagd-provider 0.6.0 → 0.7.1

package/package.json

@@ -1,26 +1,19 @@
 {
   "name": "@openfeature/flagd-provider",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "type": "module",
   "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": "~0.5.0"
+    "@openfeature/js-sdk": "^1.0.0"
   },
   "module": "./index.js",
   "main": "./index.cjs",
-  "types": "./index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js",
-      "require": "./index.cjs"
-    }
-  },
+  "types": "./src/index.d.ts",
   "dependencies": {
-    "@protobuf-ts/grpc-transport": "^2.7.0",
-    "@grpc/grpc-js": "^1.6.7"
+    "@protobuf-ts/runtime-rpc": "2.8.2",
+    "@grpc/grpc-js": "1.8.0"
   }
 }

package/{lib → src/lib}/configuration.d.ts

@@ -24,7 +24,7 @@ export interface Config {
      */
     socketPath?: string;
 }
-export declare type FlagdProviderOptions = Partial<Config>;
+export type FlagdProviderOptions = Partial<Config>;
 export declare function getConfig(options?: FlagdProviderOptions): {
     host: string;
     port: number;

package/{proto → src/proto}/ts/schema/v1/schema.client.d.ts

@@ -1,5 +1,8 @@
 import type { RpcTransport } from "@protobuf-ts/runtime-rpc";
 import type { ServiceInfo } from "@protobuf-ts/runtime-rpc";
+import type { EventStreamResponse } from "./schema";
+import type { EventStreamRequest } from "./schema";
+import type { ServerStreamingCall } from "@protobuf-ts/runtime-rpc";
 import type { ResolveObjectResponse } from "./schema";
 import type { ResolveObjectRequest } from "./schema";
 import type { ResolveIntResponse } from "./schema";
@@ -13,6 +16,8 @@ import type { ResolveBooleanRequest } from "./schema";
 import type { UnaryCall } from "@protobuf-ts/runtime-rpc";
 import type { RpcOptions } from "@protobuf-ts/runtime-rpc";
 /**
+ * Service defines the exposed rpcs of flagd
+ *
  * @generated from protobuf service schema.v1.Service
  */
 export interface IServiceClient {
@@ -36,8 +41,14 @@ export interface IServiceClient {
      * @generated from protobuf rpc: ResolveObject(schema.v1.ResolveObjectRequest) returns (schema.v1.ResolveObjectResponse);
      */
     resolveObject(input: ResolveObjectRequest, options?: RpcOptions): UnaryCall<ResolveObjectRequest, ResolveObjectResponse>;
+    /**
+     * @generated from protobuf rpc: EventStream(schema.v1.EventStreamRequest) returns (stream schema.v1.EventStreamResponse);
+     */
+    eventStream(input: EventStreamRequest, options?: RpcOptions): ServerStreamingCall<EventStreamRequest, EventStreamResponse>;
 }
 /**
+ * Service defines the exposed rpcs of flagd
+ *
  * @generated from protobuf service schema.v1.Service
  */
 export declare class ServiceClient implements IServiceClient, ServiceInfo {
@@ -68,4 +79,8 @@ export declare class ServiceClient implements IServiceClient, ServiceInfo {
      * @generated from protobuf rpc: ResolveObject(schema.v1.ResolveObjectRequest) returns (schema.v1.ResolveObjectResponse);
      */
     resolveObject(input: ResolveObjectRequest, options?: RpcOptions): UnaryCall<ResolveObjectRequest, ResolveObjectResponse>;
+    /**
+     * @generated from protobuf rpc: EventStream(schema.v1.EventStreamRequest) returns (stream schema.v1.EventStreamResponse);
+     */
+    eventStream(input: EventStreamRequest, options?: RpcOptions): ServerStreamingCall<EventStreamRequest, EventStreamResponse>;
 }

package/{proto → src/proto}/ts/schema/v1/schema.d.ts

@@ -7,178 +7,254 @@ import type { PartialMessage } from "@protobuf-ts/runtime";
 import { MessageType } from "@protobuf-ts/runtime";
 import { Struct } from "../../google/protobuf/struct";
 /**
- * @generated from protobuf message schema.v1.ErrorResponse
- */
-export interface ErrorResponse {
-    /**
-     * @generated from protobuf field: string error_code = 1;
-     */
-    errorCode: string;
-    /**
-     * @generated from protobuf field: string reason = 2;
-     */
-    reason: string;
-}
-/**
+ * Request body for boolean flag evaluation, used by the ResolveBoolean rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveBooleanRequest
  */
 export interface ResolveBooleanRequest {
     /**
+     * Flag key of the requested flag.
+     *
      * @generated from protobuf field: string flag_key = 1;
      */
     flagKey: string;
     /**
+     * Object structure describing the EvaluationContext used in the flag evaluation, see https://docs.openfeature.dev/docs/reference/concepts/evaluation-context
+     *
      * @generated from protobuf field: google.protobuf.Struct context = 2;
      */
     context?: Struct;
 }
 /**
+ * Response body for boolean flag evaluation. used by the ResolveBoolean rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveBooleanResponse
  */
 export interface ResolveBooleanResponse {
     /**
+     * The response value of the boolean flag evaluation, will be unset in the case of error.
+     *
      * @generated from protobuf field: bool value = 1;
      */
     value: boolean;
     /**
+     * The reason for the given return value, see https://docs.openfeature.dev/docs/specification/types#resolution-details
+     *
      * @generated from protobuf field: string reason = 2;
      */
     reason: string;
     /**
+     * The variant name of the returned flag value.
+     *
      * @generated from protobuf field: string variant = 3;
      */
     variant: string;
 }
 /**
+ * Request body for string flag evaluation, used by the ResolveString rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveStringRequest
  */
 export interface ResolveStringRequest {
     /**
+     * Flag key of the requested flag.
+     *
      * @generated from protobuf field: string flag_key = 1;
      */
     flagKey: string;
     /**
+     * Object structure describing the EvaluationContext used in the flag evaluation, see https://docs.openfeature.dev/docs/reference/concepts/evaluation-context
+     *
      * @generated from protobuf field: google.protobuf.Struct context = 2;
      */
     context?: Struct;
 }
 /**
+ * Response body for string flag evaluation. used by the ResolveString rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveStringResponse
  */
 export interface ResolveStringResponse {
     /**
+     * The response value of the string flag evaluation, will be unset in the case of error.
+     *
      * @generated from protobuf field: string value = 1;
      */
     value: string;
     /**
+     * The reason for the given return value, see https://docs.openfeature.dev/docs/specification/types#resolution-details
+     *
      * @generated from protobuf field: string reason = 2;
      */
     reason: string;
     /**
+     * The variant name of the returned flag value.
+     *
      * @generated from protobuf field: string variant = 3;
      */
     variant: string;
 }
 /**
+ * Request body for float flag evaluation, used by the ResolveFloat rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveFloatRequest
  */
 export interface ResolveFloatRequest {
     /**
+     * Flag key of the requested flag.
+     *
      * @generated from protobuf field: string flag_key = 1;
      */
     flagKey: string;
     /**
+     * Object structure describing the EvaluationContext used in the flag evaluation, see https://docs.openfeature.dev/docs/reference/concepts/evaluation-context
+     *
      * @generated from protobuf field: google.protobuf.Struct context = 2;
      */
     context?: Struct;
 }
 /**
+ * Response body for float flag evaluation. used by the ResolveFloat rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveFloatResponse
  */
 export interface ResolveFloatResponse {
     /**
+     * The response value of the float flag evaluation, will be empty in the case of error.
+     *
      * @generated from protobuf field: double value = 1;
      */
     value: number;
     /**
+     * The reason for the given return value, see https://docs.openfeature.dev/docs/specification/types#resolution-details
+     *
      * @generated from protobuf field: string reason = 2;
      */
     reason: string;
     /**
+     * The variant name of the returned flag value.
+     *
      * @generated from protobuf field: string variant = 3;
      */
     variant: string;
 }
 /**
+ * Request body for int flag evaluation, used by the ResolveInt rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveIntRequest
  */
 export interface ResolveIntRequest {
     /**
+     * Flag key of the requested flag.
+     *
      * @generated from protobuf field: string flag_key = 1;
      */
     flagKey: string;
     /**
+     * Object structure describing the EvaluationContext used in the flag evaluation, see https://docs.openfeature.dev/docs/reference/concepts/evaluation-context
+     *
      * @generated from protobuf field: google.protobuf.Struct context = 2;
      */
     context?: Struct;
 }
 /**
+ * Response body for int flag evaluation. used by the ResolveInt rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveIntResponse
  */
 export interface ResolveIntResponse {
     /**
+     * The response value of the int flag evaluation, will be unset in the case of error.
+     *
      * @generated from protobuf field: int64 value = 1;
      */
     value: string;
     /**
+     * The reason for the given return value, see https://docs.openfeature.dev/docs/specification/types#resolution-details
+     *
      * @generated from protobuf field: string reason = 2;
      */
     reason: string;
     /**
+     * The variant name of the returned flag value.
+     *
      * @generated from protobuf field: string variant = 3;
      */
     variant: string;
 }
 /**
+ * Request body for object flag evaluation, used by the ResolveObject rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveObjectRequest
  */
 export interface ResolveObjectRequest {
     /**
+     * Flag key of the requested flag.
+     *
      * @generated from protobuf field: string flag_key = 1;
      */
     flagKey: string;
     /**
+     * Object structure describing the EvaluationContext used in the flag evaluation, see https://docs.openfeature.dev/docs/reference/concepts/evaluation-context
+     *
      * @generated from protobuf field: google.protobuf.Struct context = 2;
      */
     context?: Struct;
 }
 /**
+ * Response body for object flag evaluation. used by the ResolveObject rpc.
+ *
  * @generated from protobuf message schema.v1.ResolveObjectResponse
  */
 export interface ResolveObjectResponse {
     /**
+     * The response value of the object flag evaluation, will be unset in the case of error.
+     *
+     * NOTE: This structure will need to be decoded from google/protobuf/struct.proto before it is returned to the SDK
+     *
      * @generated from protobuf field: google.protobuf.Struct value = 1;
      */
     value?: Struct;
     /**
+     * The reason for the given return value, see https://docs.openfeature.dev/docs/specification/types#resolution-details
+     *
      * @generated from protobuf field: string reason = 2;
      */
     reason: string;
     /**
+     * The variant name of the returned flag value.
+     *
      * @generated from protobuf field: string variant = 3;
      */
     variant: string;
 }
-declare class ErrorResponse$Type extends MessageType<ErrorResponse> {
-    constructor();
-    create(value?: PartialMessage<ErrorResponse>): ErrorResponse;
-    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: ErrorResponse): ErrorResponse;
-    internalBinaryWrite(message: ErrorResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+/**
+ * Response body for the EventStream stream response
+ *
+ * @generated from protobuf message schema.v1.EventStreamResponse
+ */
+export interface EventStreamResponse {
+    /**
+     * String key indicating the type of event that is being received, for example, provider_ready or configuration_change
+     *
+     * @generated from protobuf field: string type = 1;
+     */
+    type: string;
+    /**
+     * Object structure for use when sending relevant metadata to provide context to the event.
+     * Can be left unset when it is not required.
+     *
+     * @generated from protobuf field: google.protobuf.Struct data = 2;
+     */
+    data?: Struct;
 }
 /**
- * @generated MessageType for protobuf message schema.v1.ErrorResponse
+ * Empty stream request body
+ *
+ * @generated from protobuf message schema.v1.EventStreamRequest
  */
-export declare const ErrorResponse: ErrorResponse$Type;
+export interface EventStreamRequest {
+}
 declare class ResolveBooleanRequest$Type extends MessageType<ResolveBooleanRequest> {
     constructor();
     create(value?: PartialMessage<ResolveBooleanRequest>): ResolveBooleanRequest;
@@ -279,6 +355,26 @@ declare class ResolveObjectResponse$Type extends MessageType<ResolveObjectRespon
  * @generated MessageType for protobuf message schema.v1.ResolveObjectResponse
  */
 export declare const ResolveObjectResponse: ResolveObjectResponse$Type;
+declare class EventStreamResponse$Type extends MessageType<EventStreamResponse> {
+    constructor();
+    create(value?: PartialMessage<EventStreamResponse>): EventStreamResponse;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: EventStreamResponse): EventStreamResponse;
+    internalBinaryWrite(message: EventStreamResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message schema.v1.EventStreamResponse
+ */
+export declare const EventStreamResponse: EventStreamResponse$Type;
+declare class EventStreamRequest$Type extends MessageType<EventStreamRequest> {
+    constructor();
+    create(value?: PartialMessage<EventStreamRequest>): EventStreamRequest;
+    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: EventStreamRequest): EventStreamRequest;
+    internalBinaryWrite(message: EventStreamRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
+}
+/**
+ * @generated MessageType for protobuf message schema.v1.EventStreamRequest
+ */
+export declare const EventStreamRequest: EventStreamRequest$Type;
 /**
  * @generated ServiceType for protobuf service schema.v1.Service
  */