@openfeature/flagd-provider 0.8.3 → 0.9.0

package/README.md

@@ -13,7 +13,7 @@ $ npm install @openfeature/flagd-provider
 Required peer dependencies
 
 ```
-$ npm install @openfeature/js-sdk
+$ npm install @openfeature/server-sdk
 ```
 
 ## Usage

package/index.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";

package/index.cjs.default.js

@@ -0,0 +1 @@
+exports._default = require('./index.cjs.js').default;

package/{index.cjs → index.cjs.js}

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var jsSdk = require('@openfeature/js-sdk');
+var serverSdk = require('@openfeature/server-sdk');
 var grpcJs = require('@grpc/grpc-js');
 var lruCache = require('lru-cache');
 var util$6 = require('util');
@@ -2682,7 +2682,7 @@ function newError(name) {
             configurable: true,
         },
         name: {
-            get() { return name; },
+            get: function get() { return name; },
             set: undefined,
             enumerable: false,
             // configurable: false would accurately preserve the behavior of
@@ -2692,7 +2692,7 @@ function newError(name) {
             configurable: true,
         },
         toString: {
-            value() { return this.name + ": " + this.message; },
+            value: function value() { return this.name + ": " + this.message; },
             writable: true,
             enumerable: false,
             configurable: true,
@@ -3695,9 +3695,14 @@ Reader$1.prototype.bytes = function read_bytes() {
     this.pos += length;
     if (Array.isArray(this.buf)) // plain array
         return this.buf.slice(start, end);
-    return start === end // fix for IE 10/Win8 and others' subarray returning array of size 1
-        ? new this.buf.constructor(0)
-        : this._slice.call(this.buf, start, end);
+
+    if (start === end) { // fix for IE 10/Win8 and others' subarray returning array of size 1
+        var nativeBuffer = util$2.Buffer;
+        return nativeBuffer
+            ? nativeBuffer.alloc(0)
+            : new this.buf.constructor(0);
+    }
+    return this._slice.call(this.buf, start, end);
 };
 
 /**
@@ -5833,43 +5838,19 @@ class GRPCService {
         this._streamConnectAttempt = 0;
         this._stream = undefined;
         this._streamConnectBackoff = BASE_EVENT_STREAM_RETRY_BACKOFF_MS;
-        this.objectParser = (struct) => {
-            if (struct) {
-                return struct;
-            }
-            return {};
-        };
-        this.booleanParser = (value) => {
-            if (value) {
-                return value;
-            }
-            return false;
-        };
-        this.stringParser = (value) => {
-            if (value) {
-                return value;
-            }
-            return '';
-        };
-        this.numberParser = (value) => {
-            if (value) {
-                return value;
-            }
-            return 0;
-        };
         this.onRejected = (err) => {
             // map the errors
             switch (err === null || err === void 0 ? void 0 : err.code) {
                 case grpcJs.status.DATA_LOSS:
-                    throw new jsSdk.ParseError(err.details);
+                    throw new serverSdk.ParseError(err.details);
                 case grpcJs.status.INVALID_ARGUMENT:
-                    throw new jsSdk.TypeMismatchError(err.details);
+                    throw new serverSdk.TypeMismatchError(err.details);
                 case grpcJs.status.NOT_FOUND:
-                    throw new jsSdk.FlagNotFoundError(err.details);
+                    throw new serverSdk.FlagNotFoundError(err.details);
                 case grpcJs.status.UNAVAILABLE:
-                    throw new jsSdk.FlagNotFoundError(err.details);
+                    throw new serverSdk.FlagNotFoundError(err.details);
                 default:
-                    throw new jsSdk.GeneralError(err === null || err === void 0 ? void 0 : err.details);
+                    throw new serverSdk.GeneralError(err === null || err === void 0 ? void 0 : err.details);
             }
         };
         const { host, port, tls, socketPath } = config;
@@ -5895,22 +5876,22 @@ class GRPCService {
     }
     resolveBoolean(flagKey, context, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.resolve(this._client.resolveBoolean, flagKey, context, logger, this.booleanParser);
+            return this.resolve(this._client.resolveBoolean, flagKey, context, logger);
         });
     }
     resolveString(flagKey, context, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.resolve(this._client.resolveString, flagKey, context, logger, this.stringParser);
+            return this.resolve(this._client.resolveString, flagKey, context, logger);
         });
     }
     resolveNumber(flagKey, context, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.resolve(this._client.resolveFloat, flagKey, context, logger, this.numberParser);
+            return this.resolve(this._client.resolveFloat, flagKey, context, logger);
         });
     }
     resolveObject(flagKey, context, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.resolve(this._client.resolveObject, flagKey, context, logger, this.objectParser);
+            return this.resolve(this._client.resolveObject, flagKey, context, logger);
         });
     }
     connectStream(connectCallback, changedCallback, disconnectCallback) {
@@ -5998,14 +5979,14 @@ class GRPCService {
         (_b = this._cache) === null || _b === void 0 ? void 0 : _b.clear();
         this._streamAlive = false;
     }
-    resolve(promise, flagKey, context, logger, parser) {
+    resolve(promise, flagKey, context, logger) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const resolver = util$6.promisify(promise);
             if (this._cacheActive) {
                 const cached = (_a = this._cache) === null || _a === void 0 ? void 0 : _a.get(flagKey);
                 if (cached) {
-                    return Object.assign(Object.assign({}, cached), { reason: jsSdk.StandardResolutionReasons.CACHED });
+                    return Object.assign(Object.assign({}, cached), { reason: serverSdk.StandardResolutionReasons.CACHED });
                 }
             }
             // invoke the passed resolver method
@@ -6013,14 +5994,13 @@ class GRPCService {
                 .call(this._client, { flagKey, context })
                 .then((resolved) => resolved, this.onRejected);
             const resolved = {
-                // invoke the parser method if passed
-                value: parser.call(this, response.value),
+                value: response.value,
                 reason: response.reason,
                 variant: response.variant,
                 flagMetadata: response.metadata,
             };
             logger.debug(`${FlagdProvider.name}: resolved flag with key: ${resolved.value}, variant: ${response.variant}, reason: ${response.reason}`);
-            if (this._cacheActive && response.reason === jsSdk.StandardResolutionReasons.STATIC) {
+            if (this._cacheActive && response.reason === serverSdk.StandardResolutionReasons.STATIC) {
                 // cache this static value
                 (_b = this._cache) === null || _b === void 0 ? void 0 : _b.set(flagKey, resolved);
             }
@@ -6048,8 +6028,9 @@ class FlagdProvider {
         this.metadata = {
             name: 'flagd Provider',
         };
-        this._status = jsSdk.ProviderStatus.NOT_READY;
-        this._events = new jsSdk.OpenFeatureEventEmitter();
+        this.runsOn = 'server';
+        this._status = serverSdk.ProviderStatus.NOT_READY;
+        this._events = new serverSdk.OpenFeatureEventEmitter();
         this.logRejected = (err, flagKey, logger) => {
             logger.error(`Error resolving flag ${flagKey}: ${err === null || err === void 0 ? void 0 : err.message}`);
             logger.error(err === null || err === void 0 ? void 0 : err.stack);
@@ -6063,11 +6044,11 @@ class FlagdProvider {
             .then(() => {
             var _a;
             (_a = this.logger) === null || _a === void 0 ? void 0 : _a.debug(`${this.metadata.name}: ready`);
-            this._status = jsSdk.ProviderStatus.READY;
+            this._status = serverSdk.ProviderStatus.READY;
         })
             .catch((err) => {
             var _a;
-            this._status = jsSdk.ProviderStatus.ERROR;
+            this._status = serverSdk.ProviderStatus.ERROR;
             (_a = this.logger) === null || _a === void 0 ? void 0 : _a.error(`${this.metadata.name}: error during initialization: ${err.message}, ${err.stack}`);
             throw err;
         });
@@ -6098,13 +6079,13 @@ class FlagdProvider {
             .catch((err) => this.logRejected(err, flagKey, logger));
     }
     setReady() {
-        this._status = jsSdk.ProviderStatus.READY;
+        this._status = serverSdk.ProviderStatus.READY;
     }
     setError() {
-        this._status = jsSdk.ProviderStatus.ERROR;
+        this._status = serverSdk.ProviderStatus.ERROR;
     }
     emitChanged(flagsChanged) {
-        this._events.emit(jsSdk.ProviderEvents.ConfigurationChanged, { flagsChanged });
+        this._events.emit(serverSdk.ProviderEvents.ConfigurationChanged, { flagsChanged });
     }
 }
 

package/index.cjs.mjs

@@ -0,0 +1,2 @@
+export * from './index.cjs.js';
+export { _default as default } from './index.cjs.default.js';

package/{index.js → index.esm.js}

@@ -1,4 +1,4 @@
-import { GeneralError, FlagNotFoundError, TypeMismatchError, ParseError, StandardResolutionReasons, ProviderStatus, OpenFeatureEventEmitter, ProviderEvents } from '@openfeature/js-sdk';
+import { GeneralError, FlagNotFoundError, TypeMismatchError, ParseError, StandardResolutionReasons, ProviderStatus, OpenFeatureEventEmitter, ProviderEvents } from '@openfeature/server-sdk';
 import { makeGenericClientConstructor, status, credentials } from '@grpc/grpc-js';
 import { LRUCache } from 'lru-cache';
 import { promisify } from 'util';
@@ -2678,7 +2678,7 @@ function newError(name) {
             configurable: true,
         },
         name: {
-            get() { return name; },
+            get: function get() { return name; },
             set: undefined,
             enumerable: false,
             // configurable: false would accurately preserve the behavior of
@@ -2688,7 +2688,7 @@ function newError(name) {
             configurable: true,
         },
         toString: {
-            value() { return this.name + ": " + this.message; },
+            value: function value() { return this.name + ": " + this.message; },
             writable: true,
             enumerable: false,
             configurable: true,
@@ -3691,9 +3691,14 @@ Reader$1.prototype.bytes = function read_bytes() {
     this.pos += length;
     if (Array.isArray(this.buf)) // plain array
         return this.buf.slice(start, end);
-    return start === end // fix for IE 10/Win8 and others' subarray returning array of size 1
-        ? new this.buf.constructor(0)
-        : this._slice.call(this.buf, start, end);
+
+    if (start === end) { // fix for IE 10/Win8 and others' subarray returning array of size 1
+        var nativeBuffer = util$2.Buffer;
+        return nativeBuffer
+            ? nativeBuffer.alloc(0)
+            : new this.buf.constructor(0);
+    }
+    return this._slice.call(this.buf, start, end);
 };
 
 /**
@@ -5829,30 +5834,6 @@ class GRPCService {
         this._streamConnectAttempt = 0;
         this._stream = undefined;
         this._streamConnectBackoff = BASE_EVENT_STREAM_RETRY_BACKOFF_MS;
-        this.objectParser = (struct) => {
-            if (struct) {
-                return struct;
-            }
-            return {};
-        };
-        this.booleanParser = (value) => {
-            if (value) {
-                return value;
-            }
-            return false;
-        };
-        this.stringParser = (value) => {
-            if (value) {
-                return value;
-            }
-            return '';
-        };
-        this.numberParser = (value) => {
-            if (value) {
-                return value;
-            }
-            return 0;
-        };
         this.onRejected = (err) => {
             // map the errors
             switch (err === null || err === void 0 ? void 0 : err.code) {
@@ -5891,22 +5872,22 @@ class GRPCService {
     }
     resolveBoolean(flagKey, context, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.resolve(this._client.resolveBoolean, flagKey, context, logger, this.booleanParser);
+            return this.resolve(this._client.resolveBoolean, flagKey, context, logger);
         });
     }
     resolveString(flagKey, context, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.resolve(this._client.resolveString, flagKey, context, logger, this.stringParser);
+            return this.resolve(this._client.resolveString, flagKey, context, logger);
         });
     }
     resolveNumber(flagKey, context, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.resolve(this._client.resolveFloat, flagKey, context, logger, this.numberParser);
+            return this.resolve(this._client.resolveFloat, flagKey, context, logger);
         });
     }
     resolveObject(flagKey, context, logger) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.resolve(this._client.resolveObject, flagKey, context, logger, this.objectParser);
+            return this.resolve(this._client.resolveObject, flagKey, context, logger);
         });
     }
     connectStream(connectCallback, changedCallback, disconnectCallback) {
@@ -5994,7 +5975,7 @@ class GRPCService {
         (_b = this._cache) === null || _b === void 0 ? void 0 : _b.clear();
         this._streamAlive = false;
     }
-    resolve(promise, flagKey, context, logger, parser) {
+    resolve(promise, flagKey, context, logger) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const resolver = promisify(promise);
@@ -6009,8 +5990,7 @@ class GRPCService {
                 .call(this._client, { flagKey, context })
                 .then((resolved) => resolved, this.onRejected);
             const resolved = {
-                // invoke the parser method if passed
-                value: parser.call(this, response.value),
+                value: response.value,
                 reason: response.reason,
                 variant: response.variant,
                 flagMetadata: response.metadata,
@@ -6044,6 +6024,7 @@ class FlagdProvider {
         this.metadata = {
             name: 'flagd Provider',
         };
+        this.runsOn = 'server';
         this._status = ProviderStatus.NOT_READY;
         this._events = new OpenFeatureEventEmitter();
         this.logRejected = (err, flagKey, logger) => {

package/package.json

@@ -1,27 +1,27 @@
 {
   "name": "@openfeature/flagd-provider",
-  "version": "0.8.3",
+  "version": "0.9.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.3.0"
+    "@openfeature/server-sdk": ">=1.6.0"
   },
-  "module": "./index.js",
-  "main": "./index.cjs",
-  "type": "module",
-  "types": "./src/index.d.ts",
   "exports": {
+    "./package.json": "./package.json",
     ".": {
-      "types": "./src/index.d.ts",
-      "import": "./index.js",
-      "require": "./index.cjs"
+      "module": "./index.esm.js",
+      "import": "./index.cjs.mjs",
+      "default": "./index.cjs.js"
     }
   },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js",
   "dependencies": {
     "@protobuf-ts/runtime-rpc": "2.9.0",
-    "lru-cache": "10.0.0"
+    "lru-cache": "10.0.1",
+    "util": "0.12.5"
   }
 }

package/src/e2e/jest.config.d.ts

@@ -0,0 +1,9 @@
+declare const _default: {
+    displayName: string;
+    clearMocks: boolean;
+    setupFiles: string[];
+    preset: string;
+    verbose: boolean;
+    silent: boolean;
+};
+export default _default;

package/src/e2e/setup.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,4 @@
-import { EvaluationContext, JsonValue, Logger, OpenFeatureEventEmitter, Provider, ProviderStatus, ResolutionDetails } from '@openfeature/js-sdk';
+import { EvaluationContext, JsonValue, Logger, OpenFeatureEventEmitter, Provider, ProviderStatus, ResolutionDetails } from '@openfeature/server-sdk';
 import { FlagdProviderOptions } from './configuration';
 import { Service } from './service/service';
 export declare class FlagdProvider implements Provider {
@@ -6,6 +6,7 @@ export declare class FlagdProvider implements Provider {
     metadata: {
         name: string;
     };
+    readonly runsOn = "server";
     get status(): ProviderStatus;
     get events(): OpenFeatureEventEmitter;
     private readonly _service;

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

@@ -1,4 +1,4 @@
-import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/js-sdk';
+import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/server-sdk';
 import { ServiceClient } from '../../../proto/ts/schema/v1/schema';
 import { Config } from '../../configuration';
 import { Service } from '../service';
@@ -41,10 +41,6 @@ export declare class GRPCService implements Service {
     private handleFlagsChanged;
     private handleError;
     private handleClose;
-    private objectParser;
-    private booleanParser;
-    private stringParser;
-    private numberParser;
     private resolve;
     private onRejected;
 }

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

@@ -1,4 +1,4 @@
-import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/js-sdk';
+import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/server-sdk';
 export interface Service {
     connect(reconnectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
     disconnect(): Promise<void>;

package/src/proto/ts/schema/v1/schema.d.ts

@@ -2,6 +2,13 @@
 import { CallOptions, ChannelCredentials, Client, ClientOptions, ClientReadableStream, ClientUnaryCall, handleServerStreamingCall, handleUnaryCall, Metadata, ServiceError, UntypedServiceImplementation } from "@grpc/grpc-js";
 import _m0 from "protobufjs/minimal";
 export declare const protobufPackage = "schema.v1";
+/**
+ * Flag evaluation API
+ *
+ * This proto forms the basis of a flag-evaluation API.
+ * It supports single and bulk evaluation RPCs, and flags of various types, as well as establishing a stream for getting notifications about changes in a flag definition.
+ * It supports the inclusion of a "context" with each evaluation, which may contain arbitraty attributes relevant to flag evaluation.
+ */
 /** Request body for bulk flag evaluation, used by the ResolveAll rpc. */
 export interface ResolveAllRequest {
     /** Object structure describing the EvaluationContext used in the flag evaluation, see https://openfeature.dev/docs/reference/concepts/evaluation-context */

package/src/proto/ts/sync/v1/sync_service.d.ts

@@ -2,6 +2,12 @@
 import { CallOptions, ChannelCredentials, Client, ClientOptions, ClientReadableStream, ClientUnaryCall, handleServerStreamingCall, handleUnaryCall, Metadata, ServiceError, UntypedServiceImplementation } from "@grpc/grpc-js";
 import _m0 from "protobufjs/minimal";
 export declare const protobufPackage = "sync.v1";
+/**
+ * Flag definition sync API
+ *
+ * This proto defines a simple API to synchronize a feature flag definition.
+ * It supports establishing a stream for getting notifications about changes in a flag definition.
+ */
 /**
  * SyncState conveys the state of the payload. These states are related to flagd isync.go type definitions but
  * contains extras to optimize grpc use case. Refer - https://github.com/open-feature/flagd/blob/main/pkg/sync/isync.go