statsig-node-vercel 0.4.0 → 0.5.0

package/EdgeConfigDataAdapter.ts

@@ -1,55 +1,28 @@
-import { AdapterResponse, IDataAdapter } from "statsig-node";
-import type { EdgeConfigClient } from "@vercel/edge-config";
+import { AdapterResponse, IDataAdapter } from 'statsig-node';
+import { createClient, EdgeConfigClient } from '@vercel/edge-config';
 
 export class EdgeConfigDataAdapter implements IDataAdapter {
-  /**
-   * The key under which Statisg specs are stored in Edge Config
-   */
-  private edgeConfigItemKey: string;
-  /**
-   * A fully configured Edge Config client
-   */
+  private configSpecsKey: string;
   private edgeConfigClient: EdgeConfigClient;
   private supportConfigSpecPolling: boolean = false;
 
-  public constructor(options: {
-    /**
-     * The key under which Statsig specs are stored in Edge Config
-     */
-    edgeConfigItemKey: string;
-    /**
-     * A fully configured Edge Config client.
-     *
-     * @example <caption>Creating an Edge Config client</caption>
-     *
-     * ```js
-     * import { createClient } from "@vercel/edge-config";
-     *
-     * createClient(process.env.EDGE_CONFIG)
-     * ```
-     */
-    edgeConfigClient: EdgeConfigClient;
-  }) {
-    this.edgeConfigItemKey = options.edgeConfigItemKey;
-    this.edgeConfigClient = options.edgeConfigClient;
+  public constructor(key: string, connectionString: string = process.env.EDGE_CONFIG!) {
+    this.configSpecsKey = key; 
+    this.edgeConfigClient = createClient(connectionString);
   }
 
   // eslint-disable-next-line @typescript-eslint/require-await
   public async get(key: string): Promise<AdapterResponse> {
     if (key !== "statsig.cache") {
-      return {
-        error: new Error(`Edge Config Adapter Only Supports Config Specs`),
-      };
+      return { error: new Error(`Edge Config Adapter Only Supports Config Specs`) };
     }
 
-    const data = await this.edgeConfigClient.get(this.edgeConfigItemKey);
+    const data = await this.edgeConfigClient.get(this.configSpecsKey);
     if (data == null) {
       return { error: new Error(`key (${key}) does not exist`) };
     }
     if (typeof data !== "object") {
-      return {
-        error: new Error(`Edge Config value expected to be an object or array`),
-      };
+      return { error: new Error(`Edge Config value expected to be an object or array`) };
     }
     return { result: data };
   }
@@ -58,13 +31,13 @@ export class EdgeConfigDataAdapter implements IDataAdapter {
   public async set(
     key: string,
     value: string,
-    time?: number | undefined
+    time?: number | undefined,
   ): Promise<void> {
     // no-op. Statsig's Edge Config integration keeps config specs synced through Statsig's service
   }
 
   public async initialize(): Promise<void> {
-    const data = await this.edgeConfigClient.get(this.edgeConfigItemKey);
+    const data = await this.edgeConfigClient.get(this.configSpecsKey);
 
     if (data) {
       this.supportConfigSpecPolling = true;
@@ -72,7 +45,9 @@ export class EdgeConfigDataAdapter implements IDataAdapter {
   }
 
   // eslint-disable-next-line @typescript-eslint/require-await
-  public async shutdown(): Promise<void> {}
+  public async shutdown(): Promise<void> {
+    
+  }
 
   public supportsPollingUpdatesFor(key: string): boolean {
     if (key === "statsig.cache") {

package/README.md

@@ -1,43 +1,30 @@
 # Statsig Node Server SDK - Edge Config Adapter
-
-[![npm version](https://badge.fury.io/js/statsig-node-vercel.svg)](https://badge.fury.io/js/statsig-node-vercel)
+[![npm version](https://badge.fury.io/js/statsig-node-vercel.svg)](https://badge.fury.io/js/statsig-node-vercel) 
 
 A first party Edge Config integration with the [Statsig server-side Node.js SDK](https://github.com/statsig-io/node-js-server-sdk).
 
 ## Quick Setup
-
 1. Install the Statsig Node SDK
-
-```sh
+```
 npm install statsig-node@5.3.0
 ```
-
-2. Install this package and the Edge Config SDK
-
-```sh
-npm install statsig-node-vercel @vercel/edge-config
+2. Install this package
+```
+npm install statsig-node-vercel
 ```
-
 3. Install the [Statsig Vercel Integration](https://vercel.com/integrations/statsig)
-4. Import the packages
-
-```js
-import { EdgeConfigDataAdapter } from "statsig-node-vercel";
-import { createClient } from "@vercel/edge-config";
+4. Import the package
+```
+import { EdgeConfigDataAdapter } from 'statsig-node-vercel'
 ```
-
 5. Create an instance of the `EdgeConfigDataAdapter`
-
-```js
-const edgeConfigClient = createClient(process.env.EDGE_CONFIG);
-const dataAdapter = new EdgeConfigDataAdapter({
-  edgeConfigClient: edgeConfigClient,
-  edgeConfigItemKey: "ITEM_KEY_FROM_INSTALLATION", // something like "statsig-5FSfBpWM9kUPqeKRlZPkod"
-})
 ```
-
-6. When initializing the `statsig` sdk, add the adapter to options, along with the initStrategyForIDLists and disableIdListsSync options to avoid a blocking network call for ID Lists. However, if you are using Statsig ID lists for evaluation, you'll need to omit those options and incur a network request to grab ID lists. 
-
-```js
-await statsig.initialize("server-secret-key", { dataAdapter: dataAdapter, initStrategyForIDLists: 'none', disableIdListsSync: true });
+const dataAdapter = new EdgeConfigDataAdapter('KEY_FROM_INSTALLATION');
+```
+6. When initializing the `statsig` sdk, add the adapter to options
+```
+await statsig.initialize(
+    'server-secret-key',
+    { dataAdapter: dataAdapter },
+);
 ```

package/__tests__/EdgeConfigDataAdapter.test.ts

@@ -1,29 +1,26 @@
-import { EdgeConfigDataAdapter } from "../EdgeConfigDataAdapter";
-import { createClient } from "@vercel/edge-config";
-import fetchMock from "jest-fetch-mock";
+import { EdgeConfigDataAdapter } from '../EdgeConfigDataAdapter';
+import fetchMock from "jest-fetch-mock"
 
-describe("Validate edge config adapter functionality", () => {
-  const edgeConfigClient = createClient(process.env.EDGE_CONFIG);
-  const dataAdapter = new EdgeConfigDataAdapter({
-    edgeConfigItemKey: "statsig-companyid",
-    edgeConfigClient,
-  });
+describe('Validate edge config adapter functionality', () => {
+  const dataAdapter = new EdgeConfigDataAdapter(
+    'statsig-companyid'
+  );
 
   beforeEach(async () => {
-    fetchMock.enableMocks();
+    fetchMock.enableMocks()
     fetchMock.mockResponse('"test123"');
     await dataAdapter.initialize();
-  });
+  }); 
 
   afterEach(async () => {
     await dataAdapter.shutdown();
   });
 
-  test("Simple get", async () => {
+  test('Simple get', async () => {
     const { result: gates } = await dataAdapter.get("statsig.cache");
     if (gates == null) {
       return;
     }
     expect(gates).toEqual('"test123"');
   });
-});
+})

package/dist/EdgeConfigDataAdapter.d.ts

@@ -1,33 +1,9 @@
-import { AdapterResponse, IDataAdapter } from "statsig-node";
-import type { EdgeConfigClient } from "@vercel/edge-config";
+import { AdapterResponse, IDataAdapter } from 'statsig-node';
 export declare class EdgeConfigDataAdapter implements IDataAdapter {
-    /**
-     * The key under which Statisg specs are stored in Edge Config
-     */
-    private edgeConfigItemKey;
-    /**
-     * A fully configured Edge Config client
-     */
+    private configSpecsKey;
     private edgeConfigClient;
     private supportConfigSpecPolling;
-    constructor(options: {
-        /**
-         * The key under which Statsig specs are stored in Edge Config
-         */
-        edgeConfigItemKey: string;
-        /**
-         * A fully configured Edge Config client.
-         *
-         * @example <caption>Creating an Edge Config client</caption>
-         *
-         * ```js
-         * import { createClient } from "@vercel/edge-config";
-         *
-         * createClient(process.env.EDGE_CONFIG)
-         * ```
-         */
-        edgeConfigClient: EdgeConfigClient;
-    });
+    constructor(key: string, connectionString?: string);
     get(key: string): Promise<AdapterResponse>;
     set(key: string, value: string, time?: number | undefined): Promise<void>;
     initialize(): Promise<void>;

package/dist/EdgeConfigDataAdapter.js

@@ -10,28 +10,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EdgeConfigDataAdapter = void 0;
+const edge_config_1 = require("@vercel/edge-config");
 class EdgeConfigDataAdapter {
-    constructor(options) {
+    constructor(key, connectionString = process.env.EDGE_CONFIG) {
         this.supportConfigSpecPolling = false;
-        this.edgeConfigItemKey = options.edgeConfigItemKey;
-        this.edgeConfigClient = options.edgeConfigClient;
+        this.configSpecsKey = key;
+        this.edgeConfigClient = (0, edge_config_1.createClient)(connectionString);
     }
     // eslint-disable-next-line @typescript-eslint/require-await
     get(key) {
         return __awaiter(this, void 0, void 0, function* () {
             if (key !== "statsig.cache") {
-                return {
-                    error: new Error(`Edge Config Adapter Only Supports Config Specs`),
-                };
+                return { error: new Error(`Edge Config Adapter Only Supports Config Specs`) };
             }
-            const data = yield this.edgeConfigClient.get(this.edgeConfigItemKey);
+            const data = yield this.edgeConfigClient.get(this.configSpecsKey);
             if (data == null) {
                 return { error: new Error(`key (${key}) does not exist`) };
             }
             if (typeof data !== "object") {
-                return {
-                    error: new Error(`Edge Config value expected to be an object or array`),
-                };
+                return { error: new Error(`Edge Config value expected to be an object or array`) };
             }
             return { result: data };
         });
@@ -44,7 +41,7 @@ class EdgeConfigDataAdapter {
     }
     initialize() {
         return __awaiter(this, void 0, void 0, function* () {
-            const data = yield this.edgeConfigClient.get(this.edgeConfigItemKey);
+            const data = yield this.edgeConfigClient.get(this.configSpecsKey);
             if (data) {
                 this.supportConfigSpecPolling = true;
             }
@@ -52,7 +49,8 @@ class EdgeConfigDataAdapter {
     }
     // eslint-disable-next-line @typescript-eslint/require-await
     shutdown() {
-        return __awaiter(this, void 0, void 0, function* () { });
+        return __awaiter(this, void 0, void 0, function* () {
+        });
     }
     supportsPollingUpdatesFor(key) {
         if (key === "statsig.cache") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "statsig-node-vercel",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -27,4 +27,4 @@
     "jest": "^29.0.0",
     "jest-fetch-mock": "^3.0.3"
   }
-}
+}