@flags-sdk/vercel 0.1.0

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Vercel, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# `@flags-sdk/vercel`

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { FlagsClient } from '@vercel/flags-core';
+import { FlagDeclaration, Adapter } from 'flags';
+
+type VercelAdapterDeclaration<ValueType, EntitiesType> = Omit<FlagDeclaration<ValueType, EntitiesType>, 'decide' | 'origin'>;
+/**
+ * Allows creating a custom Vercel adapter for feature flags
+ */
+declare function createVercelAdapter(connectionStringOrFlagsClient: string | FlagsClient): <ValueType, EntitiesType>() => Adapter<ValueType, EntitiesType>;
+/**
+ * Internal function for testing purposes
+ */
+declare function resetDefaultVercelAdapter(): void;
+/**
+ * A default Vercel adapter for feature flags
+ *
+ */
+declare function vercelAdapter<ValueType, EntitiesType>(): Adapter<ValueType, EntitiesType>;
+
+export { type VercelAdapterDeclaration, createVercelAdapter, resetDefaultVercelAdapter, vercelAdapter };

package/dist/index.js

@@ -0,0 +1,52 @@
+// src/index.ts
+import {
+  createClientFromConnectionString,
+  getDefaultFlagsClient,
+  Reason,
+  store
+} from "@vercel/flags-core";
+function createVercelAdapter(connectionStringOrFlagsClient) {
+  const flagsClient = typeof connectionStringOrFlagsClient === "string" ? createClientFromConnectionString(connectionStringOrFlagsClient) : connectionStringOrFlagsClient;
+  return function vercelAdapter2() {
+    return {
+      origin: {
+        provider: "vercel",
+        projectId: flagsClient.dataSource.projectId,
+        env: flagsClient.environment
+      },
+      config: { reportValue: false },
+      async decide({ key, entities, headers }) {
+        const evaluationResultPromise = store.run(headers, async () => {
+          return flagsClient.evaluate(
+            key,
+            void 0,
+            entities
+          );
+        });
+        const evaluationResult = await evaluationResultPromise;
+        if (evaluationResult.value === void 0) {
+          throw new Error(
+            evaluationResult.reason === Reason.ERROR && evaluationResult.errorMessage ? `flags: Could not evaluate flag "${key}". ${evaluationResult.errorMessage}` : `flags: Could not evaluate flag "${key}"`
+          );
+        }
+        return evaluationResult.value;
+      }
+    };
+  };
+}
+var defaultVercelAdapter;
+function resetDefaultVercelAdapter() {
+  defaultVercelAdapter = void 0;
+}
+function vercelAdapter() {
+  if (!defaultVercelAdapter) {
+    defaultVercelAdapter = createVercelAdapter(getDefaultFlagsClient());
+  }
+  return defaultVercelAdapter();
+}
+export {
+  createVercelAdapter,
+  resetDefaultVercelAdapter,
+  vercelAdapter
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n  createClientFromConnectionString,\n  type FlagsClient,\n  getDefaultFlagsClient,\n  Reason,\n  store,\n} from '@vercel/flags-core';\nimport type { Adapter, FlagDeclaration } from 'flags';\n\nexport type VercelAdapterDeclaration<ValueType, EntitiesType> = Omit<\n  FlagDeclaration<ValueType, EntitiesType>,\n  'decide' | 'origin'\n>;\n\n/**\n * Allows creating a custom Vercel adapter for feature flags\n */\nexport function createVercelAdapter(\n  // usually a connection string, but can also be a pre-configured FlagsClient\n  connectionStringOrFlagsClient: string | FlagsClient,\n) {\n  const flagsClient =\n    typeof connectionStringOrFlagsClient === 'string'\n      ? createClientFromConnectionString(connectionStringOrFlagsClient)\n      : connectionStringOrFlagsClient;\n\n  return function vercelAdapter<ValueType, EntitiesType>(): Adapter<\n    ValueType,\n    EntitiesType\n  > {\n    return {\n      origin: {\n        provider: 'vercel',\n        projectId: flagsClient.dataSource.projectId,\n        env: flagsClient.environment,\n      },\n      config: { reportValue: false },\n      async decide({ key, entities, headers }): Promise<ValueType> {\n        const evaluationResultPromise = store.run(headers, async () => {\n          return flagsClient.evaluate<ValueType, EntitiesType>(\n            key,\n            undefined,\n            entities,\n          );\n        });\n\n        const evaluationResult = await evaluationResultPromise;\n        if (evaluationResult.value === undefined) {\n          // if there was no defaultValue we need to throw\n          throw new Error(\n            evaluationResult.reason === Reason.ERROR &&\n              evaluationResult.errorMessage\n              ? `flags: Could not evaluate flag \"${key}\". ${evaluationResult.errorMessage}`\n              : `flags: Could not evaluate flag \"${key}\"`,\n          );\n        }\n\n        // runs when the flag evaluates successfully or\n        // when there was an error but the defaultValue was set\n        return evaluationResult.value;\n      },\n    };\n  };\n}\n\nlet defaultVercelAdapter: ReturnType<typeof createVercelAdapter> | undefined;\n\n/**\n * Internal function for testing purposes\n */\nexport function resetDefaultVercelAdapter() {\n  defaultVercelAdapter = undefined;\n}\n\n/**\n * A default Vercel adapter for feature flags\n *\n */\n// This is initialized lazily to avoid warning when it is not actually used and env vars are missing.\nexport function vercelAdapter<ValueType, EntitiesType>(): Adapter<\n  ValueType,\n  EntitiesType\n> {\n  if (!defaultVercelAdapter) {\n    defaultVercelAdapter = createVercelAdapter(getDefaultFlagsClient());\n  }\n\n  return defaultVercelAdapter<ValueType, EntitiesType>();\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAWA,SAAS,oBAEd,+BACA;AACA,QAAM,cACJ,OAAO,kCAAkC,WACrC,iCAAiC,6BAA6B,IAC9D;AAEN,SAAO,SAASA,iBAGd;AACA,WAAO;AAAA,MACL,QAAQ;AAAA,QACN,UAAU;AAAA,QACV,WAAW,YAAY,WAAW;AAAA,QAClC,KAAK,YAAY;AAAA,MACnB;AAAA,MACA,QAAQ,EAAE,aAAa,MAAM;AAAA,MAC7B,MAAM,OAAO,EAAE,KAAK,UAAU,QAAQ,GAAuB;AAC3D,cAAM,0BAA0B,MAAM,IAAI,SAAS,YAAY;AAC7D,iBAAO,YAAY;AAAA,YACjB;AAAA,YACA;AAAA,YACA;AAAA,UACF;AAAA,QACF,CAAC;AAED,cAAM,mBAAmB,MAAM;AAC/B,YAAI,iBAAiB,UAAU,QAAW;AAExC,gBAAM,IAAI;AAAA,YACR,iBAAiB,WAAW,OAAO,SACjC,iBAAiB,eACf,mCAAmC,GAAG,MAAM,iBAAiB,YAAY,KACzE,mCAAmC,GAAG;AAAA,UAC5C;AAAA,QACF;AAIA,eAAO,iBAAiB;AAAA,MAC1B;AAAA,IACF;AAAA,EACF;AACF;AAEA,IAAI;AAKG,SAAS,4BAA4B;AAC1C,yBAAuB;AACzB;AAOO,SAAS,gBAGd;AACA,MAAI,CAAC,sBAAsB;AACzB,2BAAuB,oBAAoB,sBAAsB,CAAC;AAAA,EACpE;AAEA,SAAO,qBAA8C;AACvD;","names":["vercelAdapter"]}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@flags-sdk/vercel",
+  "version": "0.1.0",
+  "description": "",
+  "keywords": [],
+  "license": "MIT",
+  "author": "",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "dist/*.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "dependencies": {
+    "jose": "5.2.1",
+    "js-xxhash": "4.0.0",
+    "@vercel/edge-config": "^1.4.2",
+    "@vercel/flags-core": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "20.11.17",
+    "@vercel/edge-config": "1.4.2",
+    "msw": "2.6.4",
+    "next": "15.0.3",
+    "tsup": "8.0.1",
+    "typescript": "5.6.3",
+    "vite": "6.0.3",
+    "vitest": "2.1.8",
+    "flags": "4.0.1",
+    "tsconfig": "0.0.0"
+  },
+  "peerDependencies": {
+    "@vercel/edge-config": "^1.2.0",
+    "flags": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "check": "biome check",
+    "test": "vitest --run",
+    "test:watch": "vitest",
+    "type-check": "tsc --noEmit"
+  }
+}