feat: Evaluation Details (#62)

Author: greghuels

docs/node-server-sdk.getinstance.md

@@ -9,11 +9,11 @@ Used to access a singleton SDK client instance. Use the method after calling ini
 **Signature:**
 
 ```typescript
-export declare function getInstance(): IEppoClient;
+export declare function getInstance(): EppoClient;
 ```
 **Returns:**
 
-IEppoClient
+EppoClient
 
 a singleton client instance
 

docs/node-server-sdk.init.md

@@ -9,7 +9,7 @@ Initializes the Eppo client with configuration parameters. This method should be
 **Signature:**
 
 ```typescript
-export declare function init(config: IClientConfig): Promise<IEppoClient>;
+export declare function init(config: IClientConfig): Promise<EppoClient>;
 ```
 
 ## Parameters
@@ -20,5 +20,5 @@ export declare function init(config: IClientConfig): Promise<IEppoClient>;
 
 **Returns:**
 
-Promise&lt;IEppoClient&gt;
+Promise&lt;EppoClient&gt;
 

node-server-sdk.api.md

@@ -4,14 +4,17 @@
 
 ```ts
 
+import { EppoClient } from '@eppo/js-client-sdk-common';
+import { IAssignmentDetails } from '@eppo/js-client-sdk-common';
 import { IAssignmentEvent } from '@eppo/js-client-sdk-common';
 import { IAssignmentLogger } from '@eppo/js-client-sdk-common';
 import { IBanditEvent } from '@eppo/js-client-sdk-common';
 import { IBanditLogger } from '@eppo/js-client-sdk-common';
-import { IEppoClient } from '@eppo/js-client-sdk-common';
 
 // @public
-export function getInstance(): IEppoClient;
+export function getInstance(): EppoClient;
+
+export { IAssignmentDetails }
 
 export { IAssignmentEvent }
 
@@ -35,7 +38,7 @@ export interface IClientConfig {
 }
 
 // @public
-export function init(config: IClientConfig): Promise<IEppoClient>;
+export function init(config: IClientConfig): Promise<EppoClient>;
 
 // (No @packageDocumentation comment for this package)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eppo/node-server-sdk",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "Eppo node server SDK",
   "main": "dist/index.js",
   "files": [
@@ -29,7 +29,7 @@
   },
   "homepage": "https://github.com/Eppo-exp/node-server-sdk#readme",
   "dependencies": {
-    "@eppo/js-client-sdk-common": "3.6.0",
+    "@eppo/js-client-sdk-common": "4.0.0",
     "lru-cache": "^10.0.1"
   },
   "devDependencies": {
@@ -59,4 +59,4 @@
     "node": ">=18.x",
     "yarn": "1.x"
   }
-}
+}

src/index.ts

@@ -2,7 +2,6 @@ import {
   IAssignmentLogger,
   validation,
   EppoClient,
-  IEppoClient,
   FlagConfigurationRequestParameters,
   MemoryOnlyConfigurationStore,
   Flag,
@@ -69,13 +68,14 @@ export interface IClientConfig {
 }
 
 export {
+  IAssignmentDetails,
   IAssignmentEvent,
   IAssignmentLogger,
   IBanditEvent,
   IBanditLogger,
 } from '@eppo/js-client-sdk-common';
 
-let clientInstance: IEppoClient;
+let clientInstance: EppoClient;
 
 /**
  * Initializes the Eppo client with configuration parameters.
@@ -84,7 +84,7 @@ let clientInstance: IEppoClient;
  * @param config client configuration
  * @public
  */
-export async function init(config: IClientConfig): Promise<IEppoClient> {
+export async function init(config: IClientConfig): Promise<EppoClient> {
   validation.validateNotBlank(config.apiKey, 'API key required');
 
   const requestConfiguration: FlagConfigurationRequestParameters = {
@@ -131,7 +131,7 @@ export async function init(config: IClientConfig): Promise<IEppoClient> {
  * Use the method after calling init() to initialize the client.
  * @returns a singleton client instance
  */
-export function getInstance(): IEppoClient {
+export function getInstance(): EppoClient {
   if (!clientInstance) {
     throw Error('Expected init() to be called to initialize a client instance');
   }

yarn.lock

@@ -460,10 +460,10 @@
   resolved "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz"
   integrity sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==
 
-"@eppo/js-client-sdk-common@3.6.0":
-  version "3.6.0"
-  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-3.6.0.tgz#b67cff89809f10df8a1b5619c4e6bec701f6d2c8"
-  integrity sha512-9G43xdGUwLJPiwvO6OUTqwFuko6nvD6FgrsCUroRVPQbHrOnWbyylAE8h2vwbxIhSTlLwxS0xRqWO+WEYiWepA==
+"@eppo/js-client-sdk-common@4.0.0":
+  version "4.0.0"
+  resolved "https://registry.yarnpkg.com/@eppo/js-client-sdk-common/-/js-client-sdk-common-4.0.0.tgz#39dea02745b641915fa4e925d75a12ca5b1e9503"
+  integrity sha512-aMru8KESyNJDU/fm5jVENUhpa1jB88FUncT/xnjgiWPuTLLrpi10Qshoj7Lloi8IjlwFSFMjDjtpuQoLKPpQXA==
   dependencies:
     js-base64 "^3.7.7"
     md5 "^2.3.0"
@@ -3856,10 +3856,10 @@ pidtree@^0.5.0:
   resolved "https://registry.npmjs.org/pidtree/-/pidtree-0.5.0.tgz"
   integrity sha512-9nxspIM7OpZuhBxPg73Zvyq7j1QMPMPsGKTqRc2XOaFQauDvoNz9fM1Wdkjmeo7l9GXOZiRs97sPkuayl39wjA==
 
-pino-abstract-transport@v1.1.0:
-  version "1.1.0"
-  resolved "https://registry.yarnpkg.com/pino-abstract-transport/-/pino-abstract-transport-1.1.0.tgz#083d98f966262164504afb989bccd05f665937a8"
-  integrity sha512-lsleG3/2a/JIWUtf9Q5gUNErBqwIu1tUKTT3dUzaf5DySw9ra1wcqKjJjLX1VTY64Wk1eEOYsVGSaGfCK85ekA==
+pino-abstract-transport@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/pino-abstract-transport/-/pino-abstract-transport-1.2.0.tgz#97f9f2631931e242da531b5c66d3079c12c9d1b5"
+  integrity sha512-Guhh8EZfPCfH+PMXAb6rKOjGQEoy0xlAIn+irODG5kgfYV+BQ0rGYYWTIel3P5mmyXqkYkPmdIkywsn6QKUR1Q==
   dependencies:
     readable-stream "^4.0.0"
     split2 "^4.0.0"
@@ -3870,21 +3870,21 @@ pino-std-serializers@^6.0.0:
   integrity sha512-cHjPPsE+vhj/tnhCy/wiMh3M3z3h/j15zHQX+S9GkTBgqJuTuJzYJ4gUyACLhDaJ7kk9ba9iRDmbH2tJU03OiA==
 
 pino@^8.19.0:
-  version "8.19.0"
-  resolved "https://registry.yarnpkg.com/pino/-/pino-8.19.0.tgz#ccc15ef736f103ec02cfbead0912bc436dc92ce4"
-  integrity sha512-oswmokxkav9bADfJ2ifrvfHUwad6MLp73Uat0IkQWY3iAw5xTRoznXbXksZs8oaOUMpmhVWD+PZogNzllWpJaA==
+  version "8.21.0"
+  resolved "https://registry.yarnpkg.com/pino/-/pino-8.21.0.tgz#e1207f3675a2722940d62da79a7a55a98409f00d"
+  integrity sha512-ip4qdzjkAyDDZklUaZkcRFb2iA118H9SgRh8yzTkSQK8HilsOJF7rSY8HoW5+I0M46AZgX/pxbprf2vvzQCE0Q==
   dependencies:
     atomic-sleep "^1.0.0"
     fast-redact "^3.1.1"
     on-exit-leak-free "^2.1.0"
-    pino-abstract-transport v1.1.0
+    pino-abstract-transport "^1.2.0"
     pino-std-serializers "^6.0.0"
     process-warning "^3.0.0"
     quick-format-unescaped "^4.0.3"
     real-require "^0.2.0"
     safe-stable-stringify "^2.3.1"
     sonic-boom "^3.7.0"
-    thread-stream "^2.0.0"
+    thread-stream "^2.6.0"
 
 pirates@^4.0.4:
   version "4.0.5"
@@ -4520,10 +4520,10 @@ theredoc@^1.0.0:
   resolved "https://registry.yarnpkg.com/theredoc/-/theredoc-1.0.0.tgz#bcace376af6feb1873efbdd0f91ed026570ff062"
   integrity sha512-KU3SA3TjRRM932jpNfD3u4Ec3bSvedyo5ITPI7zgWYnKep7BwQQaxlhI9qbO+lKJoRnoAbEVfMcAHRuKVYikDA==
 
-thread-stream@^2.0.0:
-  version "2.4.1"
-  resolved "https://registry.yarnpkg.com/thread-stream/-/thread-stream-2.4.1.tgz#6d588b14f0546e59d3f306614f044bc01ce43351"
-  integrity sha512-d/Ex2iWd1whipbT681JmTINKw0ZwOUBZm7+Gjs64DHuX34mmw8vJL2bFAaNacaW72zYiTJxSHi5abUuOi5nsfg==
+thread-stream@^2.6.0:
+  version "2.7.0"
+  resolved "https://registry.yarnpkg.com/thread-stream/-/thread-stream-2.7.0.tgz#d8a8e1b3fd538a6cca8ce69dbe5d3d097b601e11"
+  integrity sha512-qQiRWsU/wvNolI6tbbCKd9iKaTnCXsTwVxhhKM6nctPdujTyztjlbUkUTUymidWcMnZ5pWR0ej4a0tjsW021vw==
   dependencies:
     real-require "^0.2.0"