@flags-sdk/vercel 1.4.1 → 1.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @flags-sdk/vercel
2
2
 
3
+ ## 1.4.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [#402](https://github.com/vercel/flags/pull/402) [`2cb0b49`](https://github.com/vercel/flags/commit/2cb0b49698019779859181f7825b0956bf7e629a) Thanks [@dferber90](https://github.com/dferber90)! - Calling `vercelAdapter()` multiple times now returns the same adapter instance instead of creating a new one each time, which improves performance and memory usage.
8
+
3
9
  ## 1.4.1
4
10
 
5
11
  ### Patch Changes
package/dist/index.cjs CHANGED
@@ -7,33 +7,38 @@ var _flagscore = require('@vercel/flags-core');
7
7
  function createVercelAdapter(sdkKeyOrFlagsClient) {
8
8
  const flagsClient2 = typeof sdkKeyOrFlagsClient === "string" || sdkKeyOrFlagsClient === void 0 ? _flagscore.createClient.call(void 0, sdkKeyOrFlagsClient) : sdkKeyOrFlagsClient;
9
9
  const adapterId = /* @__PURE__ */ Symbol("vercelAdapter");
10
- return function vercelAdapter2() {
11
- return {
12
- adapterId,
13
- origin: flagsClient2.origin,
14
- config: { reportValue: false },
15
- async decide({ key, entities }) {
16
- const evaluationResult = await flagsClient2.evaluate(key, void 0, entities);
17
- if (evaluationResult.value === void 0) {
18
- throw new Error(
19
- evaluationResult.reason === _flagscore.Reason.ERROR && evaluationResult.errorMessage ? `flags: Could not evaluate flag "${key}". ${evaluationResult.errorMessage}` : `flags: Could not evaluate flag "${key}"`
20
- );
21
- }
22
- return evaluationResult.value;
23
- },
24
- async bulkDecide({ flags, entities }) {
25
- const results = await flagsClient2.bulkEvaluate(
26
- flags,
27
- entities
10
+ const adapter = {
11
+ adapterId,
12
+ origin: flagsClient2.origin,
13
+ config: { reportValue: false },
14
+ async decide({ key, entities }) {
15
+ const evaluationResult = await flagsClient2.evaluate(
16
+ key,
17
+ void 0,
18
+ entities
19
+ );
20
+ if (evaluationResult.value === void 0) {
21
+ throw new Error(
22
+ evaluationResult.reason === _flagscore.Reason.ERROR && evaluationResult.errorMessage ? `flags: Could not evaluate flag "${key}". ${evaluationResult.errorMessage}` : `flags: Could not evaluate flag "${key}"`
28
23
  );
29
- const out = {};
30
- for (const key in results) {
31
- const r = results[key];
32
- if (r.value !== void 0) out[key] = r.value;
33
- }
34
- return out;
35
24
  }
36
- };
25
+ return evaluationResult.value;
26
+ },
27
+ async bulkDecide({ flags, entities }) {
28
+ const results = await flagsClient2.bulkEvaluate(
29
+ flags,
30
+ entities
31
+ );
32
+ const out = {};
33
+ for (const key in results) {
34
+ const r = results[key];
35
+ if (r.value !== void 0) out[key] = r.value;
36
+ }
37
+ return out;
38
+ }
39
+ };
40
+ return function vercelAdapter2() {
41
+ return adapter;
37
42
  };
38
43
  }
39
44
  var defaultVercelAdapter;
@@ -1 +1 @@
1
- {"version":3,"sources":["/home/runner/work/flags/flags/packages/adapter-vercel/dist/index.cjs","../src/index.ts"],"names":["flagsClient","vercelAdapter"],"mappings":"AAAA;ACAA;AACE;AAEA;AACA;AAAA,+CACK;AAkBA,SAAS,mBAAA,CAEd,mBAAA,EACA;AACA,EAAA,MAAMA,aAAAA,EACJ,OAAO,oBAAA,IAAwB,SAAA,GAAY,oBAAA,IAAwB,KAAA,EAAA,EAC/D,qCAAA,mBAAgC,EAAA,EAChC,mBAAA;AAMN,EAAA,MAAM,UAAA,kBAAY,MAAA,CAAO,eAAe,CAAA;AAExC,EAAA,OAAO,SAASC,cAAAA,CAAAA,EAGd;AACA,IAAA,OAAO;AAAA,MACL,SAAA;AAAA,MACA,MAAA,EAAQD,YAAAA,CAAY,MAAA;AAAA,MACpB,MAAA,EAAQ,EAAE,WAAA,EAAa,MAAM,CAAA;AAAA,MAC7B,MAAM,MAAA,CAAO,EAAE,GAAA,EAAK,SAAS,CAAA,EAAuB;AAClD,QAAA,MAAM,iBAAA,EAAmB,MAAMA,YAAAA,CAAY,QAAA,CAGzC,GAAA,EAAK,KAAA,CAAA,EAAW,QAAQ,CAAA;AAE1B,QAAA,GAAA,CAAI,gBAAA,CAAiB,MAAA,IAAU,KAAA,CAAA,EAAW;AAExC,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,gBAAA,CAAiB,OAAA,IAAW,iBAAA,CAAO,MAAA,GACjC,gBAAA,CAAiB,aAAA,EACf,CAAA,gCAAA,EAAmC,GAAG,CAAA,GAAA,EAAM,gBAAA,CAAiB,YAAY,CAAA,EAAA;AAE/E,UAAA;AACF,QAAA;AAIwB,QAAA;AAC1B,MAAA;AACsC,MAAA;AAKF,QAAA;AAChC,UAAA;AACA,UAAA;AACF,QAAA;AACwC,QAAA;AACb,QAAA;AACJ,UAAA;AAGmB,UAAA;AAC1C,QAAA;AACO,QAAA;AACT,MAAA;AACF,IAAA;AACF,EAAA;AACF;AAEI;AAKwC;AACnB,EAAA;AACzB;AAUE;AAC2B,EAAA;AAC6B,IAAA;AACxD,EAAA;AAEqD,EAAA;AACvD;AAE8D;AAML;AACnB,EAAA;AACvB,EAAA;AACiB,IAAA;AACG,IAAA;AACjC,EAAA;AACO,EAAA;AACT;AAIqD;AAKA,EAAA;AAErD;AAQyB;AAGyC,EAAA;AAGpB,EAAA;AAClB,EAAA;AACM,IAAA;AACD,MAAA;AAC7B,IAAA;AACF,EAAA;AAE8D,EAAA;AAChD,EAAA;AAC8B,IAAA;AACD,MAAA;AACnC,MAAA;AACgD,QAAA;AACF,QAAA;AAC1C,MAAA;AACoC,QAAA;AACM,QAAA;AAClD,MAAA;AACD,IAAA;AACH,EAAA;AAEqE,EAAA;AAC7B,IAAA;AAEiB,IAAA;AAC1C,IAAA;AACA,MAAA;AACH,MAAA;AACI,QAAA;AACV,QAAA;AACF,MAAA;AACe,MAAA;AACC,MAAA;AACA,MAAA;AAClB,IAAA;AAEO,IAAA;AACJ,EAAA;AAE2B,EAAA;AAClC;AD7FkK;AACA;AACA;AACA;AACA;AACA","file":"/home/runner/work/flags/flags/packages/adapter-vercel/dist/index.cjs","sourcesContent":[null,"import {\n createClient,\n type FlagsClient,\n flagsClient,\n Reason,\n} from '@vercel/flags-core';\nimport type {\n Adapter,\n FlagDeclaration,\n FlagDefinitionsType,\n FlagDefinitionType,\n ProviderData,\n} from 'flags';\nimport type { KeyedFlagDefinitionType } from 'flags/next';\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 sdkKeyOrFlagsClient?: string | FlagsClient,\n) {\n const flagsClient =\n typeof sdkKeyOrFlagsClient === 'string' || sdkKeyOrFlagsClient === undefined\n ? createClient(sdkKeyOrFlagsClient)\n : sdkKeyOrFlagsClient;\n\n // Stable identity for this adapter's underlying flagsClient. Captured in\n // the closure so every adapter object the factory below returns shares it,\n // letting `evaluate()` group flags from multiple `vercelAdapter()` calls\n // into a single `bulkDecide` invocation.\n const adapterId = Symbol('vercelAdapter');\n\n return function vercelAdapter<ValueType, EntitiesType>(): Adapter<\n ValueType,\n EntitiesType\n > {\n return {\n adapterId,\n origin: flagsClient.origin,\n config: { reportValue: false },\n async decide({ key, entities }): Promise<ValueType> {\n const evaluationResult = await flagsClient.evaluate<\n ValueType,\n EntitiesType\n >(key, undefined, entities);\n\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 async bulkDecide({ flags, entities }) {\n // `flags` is typed `{ key: string; defaultValue?: unknown }[]` on\n // `Adapter.bulkDecide` (to keep `ValueType` covariant). The client\n // here narrows it back to `ValueType`; `defaultValue` is shuttled\n // through opaquely so the cast is safe.\n const results = await flagsClient.bulkEvaluate<ValueType, EntitiesType>(\n flags as { key: string; defaultValue?: ValueType }[],\n entities,\n );\n const out: Record<string, ValueType> = {};\n for (const key in results) {\n const r = results[key]!;\n // Omit undefined so the SDK applies the per-flag `defaultValue`\n // fallback (matches single-decide semantics).\n if (r.value !== undefined) out[key] = r.value;\n }\n return out;\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(flagsClient);\n }\n\n return defaultVercelAdapter<ValueType, EntitiesType>();\n}\n\nconst flagsClients = new Map<string | undefined, FlagsClient>();\n\n/**\n * Ensures we only ever create a single client per SDK Key\n * When undefined is passed, due to OIDC being used, then we return a single client too.\n **/\nfunction getOrCreateClient(sdkKey?: string): FlagsClient {\n let client = flagsClients.get(sdkKey);\n if (!client) {\n client = createClient(sdkKey);\n flagsClients.set(sdkKey, client);\n }\n return client;\n}\n\nfunction isVercelOrigin(\n origin: unknown,\n): origin is { provider: 'vercel'; sdkKey?: string } {\n return (\n typeof origin === 'object' &&\n origin !== null &&\n 'provider' in origin &&\n (origin as Record<string, unknown>).provider === 'vercel'\n );\n}\n\nexport async function getProviderData(\n flags: Record<\n string,\n // accept an unknown array\n KeyedFlagDefinitionType | readonly unknown[]\n >,\n): Promise<ProviderData> {\n const flagDefs = Object.values(flags)\n // filter out precomputed arrays\n .filter((i): i is KeyedFlagDefinitionType => !Array.isArray(i));\n\n // Collect unique sdkKeys and resolve their projectIds\n const sdkKeys = new Set<string | undefined>();\n for (const d of flagDefs) {\n if (isVercelOrigin(d.origin)) {\n sdkKeys.add(d.origin.sdkKey);\n }\n }\n\n const projectIdBySdkKey = new Map<string | undefined, string>();\n await Promise.all(\n Array.from(sdkKeys).map(async (sdkKey) => {\n const client = getOrCreateClient(sdkKey);\n try {\n const fallback = await client.getFallbackDatafile();\n projectIdBySdkKey.set(sdkKey, fallback.projectId);\n } catch {\n const datafile = await client.getDatafile();\n projectIdBySdkKey.set(sdkKey, datafile.projectId);\n }\n }),\n );\n\n const definitions = flagDefs.reduce<FlagDefinitionsType>((acc, d) => {\n if (!isVercelOrigin(d.origin)) return acc;\n\n const projectId = projectIdBySdkKey.get(d.origin.sdkKey)!;\n acc[d.key] = {\n options: d.options,\n origin: {\n provider: 'vercel',\n projectId,\n },\n description: d.description,\n defaultValue: d.defaultValue,\n declaredInCode: true,\n } satisfies FlagDefinitionType;\n\n return acc;\n }, {});\n\n return { definitions, hints: [] };\n}\n"]}
1
+ {"version":3,"sources":["/home/runner/work/flags/flags/packages/adapter-vercel/dist/index.cjs","../src/index.ts"],"names":["flagsClient"],"mappings":"AAAA;ACAA;AACE;AAEA;AACA;AAAA,+CACK;AAkBA,SAAS,mBAAA,CAEd,mBAAA,EACA;AACA,EAAA,MAAMA,aAAAA,EACJ,OAAO,oBAAA,IAAwB,SAAA,GAAY,oBAAA,IAAwB,KAAA,EAAA,EAC/D,qCAAA,mBAAgC,EAAA,EAChC,mBAAA;AAMN,EAAA,MAAM,UAAA,kBAAY,MAAA,CAAO,eAAe,CAAA;AAExC,EAAA,MAAM,QAAA,EAAqC;AAAA,IACzC,SAAA;AAAA,IACA,MAAA,EAAQA,YAAAA,CAAY,MAAA;AAAA,IACpB,MAAA,EAAQ,EAAE,WAAA,EAAa,MAAM,CAAA;AAAA,IAC7B,MAAM,MAAA,CAAO,EAAE,GAAA,EAAK,SAAS,CAAA,EAAG;AAC9B,MAAA,MAAM,iBAAA,EAAmB,MAAMA,YAAAA,CAAY,QAAA;AAAA,QACzC,GAAA;AAAA,QACA,KAAA,CAAA;AAAA,QACA;AAAA,MACF,CAAA;AAEA,MAAA,GAAA,CAAI,gBAAA,CAAiB,MAAA,IAAU,KAAA,CAAA,EAAW;AAExC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,gBAAA,CAAiB,OAAA,IAAW,iBAAA,CAAO,MAAA,GACjC,gBAAA,CAAiB,aAAA,EACf,CAAA,gCAAA,EAAmC,GAAG,CAAA,GAAA,EAAM,gBAAA,CAAiB,YAAY,CAAA,EAAA;AAE/E,QAAA;AACF,MAAA;AAIwB,MAAA;AAC1B,IAAA;AACsC,IAAA;AAKF,MAAA;AAChC,QAAA;AACA,QAAA;AACF,MAAA;AACsC,MAAA;AACX,MAAA;AACJ,QAAA;AAGmB,QAAA;AAC1C,MAAA;AACO,MAAA;AACT,IAAA;AACF,EAAA;AAKE,EAAA;AACO,IAAA;AACT,EAAA;AACF;AAEI;AAKwC;AACnB,EAAA;AACzB;AAUE;AAC2B,EAAA;AAC6B,IAAA;AACxD,EAAA;AAEqD,EAAA;AACvD;AAE8D;AAML;AACnB,EAAA;AACvB,EAAA;AACiB,IAAA;AACG,IAAA;AACjC,EAAA;AACO,EAAA;AACT;AAIqD;AAKA,EAAA;AAErD;AAQyB;AAGyC,EAAA;AAGpB,EAAA;AAClB,EAAA;AACM,IAAA;AACD,MAAA;AAC7B,IAAA;AACF,EAAA;AAE8D,EAAA;AAChD,EAAA;AAC8B,IAAA;AACD,MAAA;AACnC,MAAA;AACgD,QAAA;AACF,QAAA;AAC1C,MAAA;AACoC,QAAA;AACM,QAAA;AAClD,MAAA;AACD,IAAA;AACH,EAAA;AAEqE,EAAA;AAC7B,IAAA;AAEiB,IAAA;AAC1C,IAAA;AACA,MAAA;AACH,MAAA;AACI,QAAA;AACV,QAAA;AACF,MAAA;AACe,MAAA;AACC,MAAA;AACA,MAAA;AAClB,IAAA;AAEO,IAAA;AACJ,EAAA;AAE2B,EAAA;AAClC;AD3FgK;AACA;AACA;AACA;AACA;AACA","file":"/home/runner/work/flags/flags/packages/adapter-vercel/dist/index.cjs","sourcesContent":[null,"import {\n createClient,\n type FlagsClient,\n flagsClient,\n Reason,\n} from '@vercel/flags-core';\nimport type {\n Adapter,\n FlagDeclaration,\n FlagDefinitionsType,\n FlagDefinitionType,\n ProviderData,\n} from 'flags';\nimport type { KeyedFlagDefinitionType } from 'flags/next';\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 sdkKeyOrFlagsClient?: string | FlagsClient,\n) {\n const flagsClient =\n typeof sdkKeyOrFlagsClient === 'string' || sdkKeyOrFlagsClient === undefined\n ? createClient(sdkKeyOrFlagsClient)\n : sdkKeyOrFlagsClient;\n\n // Stable identity for this adapter's underlying flagsClient. Captured in\n // the closure so every adapter object the factory below returns shares it,\n // letting `evaluate()` group flags from multiple `vercelAdapter()` calls\n // into a single `bulkDecide` invocation.\n const adapterId = Symbol('vercelAdapter');\n\n const adapter: Adapter<unknown, unknown> = {\n adapterId,\n origin: flagsClient.origin,\n config: { reportValue: false },\n async decide({ key, entities }) {\n const evaluationResult = await flagsClient.evaluate<unknown, unknown>(\n key,\n undefined,\n entities,\n );\n\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 async bulkDecide({ flags, entities }) {\n // `flags` is typed `{ key: string; defaultValue?: unknown }[]` on\n // `Adapter.bulkDecide` (to keep `ValueType` covariant). The client\n // here narrows it back to `ValueType`; `defaultValue` is shuttled\n // through opaquely so the cast is safe.\n const results = await flagsClient.bulkEvaluate<unknown, unknown>(\n flags as { key: string; defaultValue?: unknown }[],\n entities,\n );\n const out: Record<string, unknown> = {};\n for (const key in results) {\n const r = results[key]!;\n // Omit undefined so the SDK applies the per-flag `defaultValue`\n // fallback (matches single-decide semantics).\n if (r.value !== undefined) out[key] = r.value;\n }\n return out;\n },\n };\n\n return function vercelAdapter<ValueType, EntitiesType>(): Adapter<\n ValueType,\n EntitiesType\n > {\n return adapter as Adapter<ValueType, EntitiesType>;\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(flagsClient);\n }\n\n return defaultVercelAdapter<ValueType, EntitiesType>();\n}\n\nconst flagsClients = new Map<string | undefined, FlagsClient>();\n\n/**\n * Ensures we only ever create a single client per SDK Key\n * When undefined is passed, due to OIDC being used, then we return a single client too.\n **/\nfunction getOrCreateClient(sdkKey?: string): FlagsClient {\n let client = flagsClients.get(sdkKey);\n if (!client) {\n client = createClient(sdkKey);\n flagsClients.set(sdkKey, client);\n }\n return client;\n}\n\nfunction isVercelOrigin(\n origin: unknown,\n): origin is { provider: 'vercel'; sdkKey?: string } {\n return (\n typeof origin === 'object' &&\n origin !== null &&\n 'provider' in origin &&\n (origin as Record<string, unknown>).provider === 'vercel'\n );\n}\n\nexport async function getProviderData(\n flags: Record<\n string,\n // accept an unknown array\n KeyedFlagDefinitionType | readonly unknown[]\n >,\n): Promise<ProviderData> {\n const flagDefs = Object.values(flags)\n // filter out precomputed arrays\n .filter((i): i is KeyedFlagDefinitionType => !Array.isArray(i));\n\n // Collect unique sdkKeys and resolve their projectIds\n const sdkKeys = new Set<string | undefined>();\n for (const d of flagDefs) {\n if (isVercelOrigin(d.origin)) {\n sdkKeys.add(d.origin.sdkKey);\n }\n }\n\n const projectIdBySdkKey = new Map<string | undefined, string>();\n await Promise.all(\n Array.from(sdkKeys).map(async (sdkKey) => {\n const client = getOrCreateClient(sdkKey);\n try {\n const fallback = await client.getFallbackDatafile();\n projectIdBySdkKey.set(sdkKey, fallback.projectId);\n } catch {\n const datafile = await client.getDatafile();\n projectIdBySdkKey.set(sdkKey, datafile.projectId);\n }\n }),\n );\n\n const definitions = flagDefs.reduce<FlagDefinitionsType>((acc, d) => {\n if (!isVercelOrigin(d.origin)) return acc;\n\n const projectId = projectIdBySdkKey.get(d.origin.sdkKey)!;\n acc[d.key] = {\n options: d.options,\n origin: {\n provider: 'vercel',\n projectId,\n },\n description: d.description,\n defaultValue: d.defaultValue,\n declaredInCode: true,\n } satisfies FlagDefinitionType;\n\n return acc;\n }, {});\n\n return { definitions, hints: [] };\n}\n"]}
package/dist/index.js CHANGED
@@ -7,33 +7,38 @@ import {
7
7
  function createVercelAdapter(sdkKeyOrFlagsClient) {
8
8
  const flagsClient2 = typeof sdkKeyOrFlagsClient === "string" || sdkKeyOrFlagsClient === void 0 ? createClient(sdkKeyOrFlagsClient) : sdkKeyOrFlagsClient;
9
9
  const adapterId = /* @__PURE__ */ Symbol("vercelAdapter");
10
- return function vercelAdapter2() {
11
- return {
12
- adapterId,
13
- origin: flagsClient2.origin,
14
- config: { reportValue: false },
15
- async decide({ key, entities }) {
16
- const evaluationResult = await flagsClient2.evaluate(key, void 0, entities);
17
- if (evaluationResult.value === void 0) {
18
- throw new Error(
19
- evaluationResult.reason === Reason.ERROR && evaluationResult.errorMessage ? `flags: Could not evaluate flag "${key}". ${evaluationResult.errorMessage}` : `flags: Could not evaluate flag "${key}"`
20
- );
21
- }
22
- return evaluationResult.value;
23
- },
24
- async bulkDecide({ flags, entities }) {
25
- const results = await flagsClient2.bulkEvaluate(
26
- flags,
27
- entities
10
+ const adapter = {
11
+ adapterId,
12
+ origin: flagsClient2.origin,
13
+ config: { reportValue: false },
14
+ async decide({ key, entities }) {
15
+ const evaluationResult = await flagsClient2.evaluate(
16
+ key,
17
+ void 0,
18
+ entities
19
+ );
20
+ if (evaluationResult.value === void 0) {
21
+ throw new Error(
22
+ evaluationResult.reason === Reason.ERROR && evaluationResult.errorMessage ? `flags: Could not evaluate flag "${key}". ${evaluationResult.errorMessage}` : `flags: Could not evaluate flag "${key}"`
28
23
  );
29
- const out = {};
30
- for (const key in results) {
31
- const r = results[key];
32
- if (r.value !== void 0) out[key] = r.value;
33
- }
34
- return out;
35
24
  }
36
- };
25
+ return evaluationResult.value;
26
+ },
27
+ async bulkDecide({ flags, entities }) {
28
+ const results = await flagsClient2.bulkEvaluate(
29
+ flags,
30
+ entities
31
+ );
32
+ const out = {};
33
+ for (const key in results) {
34
+ const r = results[key];
35
+ if (r.value !== void 0) out[key] = r.value;
36
+ }
37
+ return out;
38
+ }
39
+ };
40
+ return function vercelAdapter2() {
41
+ return adapter;
37
42
  };
38
43
  }
39
44
  var defaultVercelAdapter;
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n createClient,\n type FlagsClient,\n flagsClient,\n Reason,\n} from '@vercel/flags-core';\nimport type {\n Adapter,\n FlagDeclaration,\n FlagDefinitionsType,\n FlagDefinitionType,\n ProviderData,\n} from 'flags';\nimport type { KeyedFlagDefinitionType } from 'flags/next';\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 sdkKeyOrFlagsClient?: string | FlagsClient,\n) {\n const flagsClient =\n typeof sdkKeyOrFlagsClient === 'string' || sdkKeyOrFlagsClient === undefined\n ? createClient(sdkKeyOrFlagsClient)\n : sdkKeyOrFlagsClient;\n\n // Stable identity for this adapter's underlying flagsClient. Captured in\n // the closure so every adapter object the factory below returns shares it,\n // letting `evaluate()` group flags from multiple `vercelAdapter()` calls\n // into a single `bulkDecide` invocation.\n const adapterId = Symbol('vercelAdapter');\n\n return function vercelAdapter<ValueType, EntitiesType>(): Adapter<\n ValueType,\n EntitiesType\n > {\n return {\n adapterId,\n origin: flagsClient.origin,\n config: { reportValue: false },\n async decide({ key, entities }): Promise<ValueType> {\n const evaluationResult = await flagsClient.evaluate<\n ValueType,\n EntitiesType\n >(key, undefined, entities);\n\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 async bulkDecide({ flags, entities }) {\n // `flags` is typed `{ key: string; defaultValue?: unknown }[]` on\n // `Adapter.bulkDecide` (to keep `ValueType` covariant). The client\n // here narrows it back to `ValueType`; `defaultValue` is shuttled\n // through opaquely so the cast is safe.\n const results = await flagsClient.bulkEvaluate<ValueType, EntitiesType>(\n flags as { key: string; defaultValue?: ValueType }[],\n entities,\n );\n const out: Record<string, ValueType> = {};\n for (const key in results) {\n const r = results[key]!;\n // Omit undefined so the SDK applies the per-flag `defaultValue`\n // fallback (matches single-decide semantics).\n if (r.value !== undefined) out[key] = r.value;\n }\n return out;\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(flagsClient);\n }\n\n return defaultVercelAdapter<ValueType, EntitiesType>();\n}\n\nconst flagsClients = new Map<string | undefined, FlagsClient>();\n\n/**\n * Ensures we only ever create a single client per SDK Key\n * When undefined is passed, due to OIDC being used, then we return a single client too.\n **/\nfunction getOrCreateClient(sdkKey?: string): FlagsClient {\n let client = flagsClients.get(sdkKey);\n if (!client) {\n client = createClient(sdkKey);\n flagsClients.set(sdkKey, client);\n }\n return client;\n}\n\nfunction isVercelOrigin(\n origin: unknown,\n): origin is { provider: 'vercel'; sdkKey?: string } {\n return (\n typeof origin === 'object' &&\n origin !== null &&\n 'provider' in origin &&\n (origin as Record<string, unknown>).provider === 'vercel'\n );\n}\n\nexport async function getProviderData(\n flags: Record<\n string,\n // accept an unknown array\n KeyedFlagDefinitionType | readonly unknown[]\n >,\n): Promise<ProviderData> {\n const flagDefs = Object.values(flags)\n // filter out precomputed arrays\n .filter((i): i is KeyedFlagDefinitionType => !Array.isArray(i));\n\n // Collect unique sdkKeys and resolve their projectIds\n const sdkKeys = new Set<string | undefined>();\n for (const d of flagDefs) {\n if (isVercelOrigin(d.origin)) {\n sdkKeys.add(d.origin.sdkKey);\n }\n }\n\n const projectIdBySdkKey = new Map<string | undefined, string>();\n await Promise.all(\n Array.from(sdkKeys).map(async (sdkKey) => {\n const client = getOrCreateClient(sdkKey);\n try {\n const fallback = await client.getFallbackDatafile();\n projectIdBySdkKey.set(sdkKey, fallback.projectId);\n } catch {\n const datafile = await client.getDatafile();\n projectIdBySdkKey.set(sdkKey, datafile.projectId);\n }\n }),\n );\n\n const definitions = flagDefs.reduce<FlagDefinitionsType>((acc, d) => {\n if (!isVercelOrigin(d.origin)) return acc;\n\n const projectId = projectIdBySdkKey.get(d.origin.sdkKey)!;\n acc[d.key] = {\n options: d.options,\n origin: {\n provider: 'vercel',\n projectId,\n },\n description: d.description,\n defaultValue: d.defaultValue,\n declaredInCode: true,\n } satisfies FlagDefinitionType;\n\n return acc;\n }, {});\n\n return { definitions, hints: [] };\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EAEA;AAAA,EACA;AAAA,OACK;AAkBA,SAAS,oBAEd,qBACA;AACA,QAAMA,eACJ,OAAO,wBAAwB,YAAY,wBAAwB,SAC/D,aAAa,mBAAmB,IAChC;AAMN,QAAM,YAAY,uBAAO,eAAe;AAExC,SAAO,SAASC,iBAGd;AACA,WAAO;AAAA,MACL;AAAA,MACA,QAAQD,aAAY;AAAA,MACpB,QAAQ,EAAE,aAAa,MAAM;AAAA,MAC7B,MAAM,OAAO,EAAE,KAAK,SAAS,GAAuB;AAClD,cAAM,mBAAmB,MAAMA,aAAY,SAGzC,KAAK,QAAW,QAAQ;AAE1B,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,MACA,MAAM,WAAW,EAAE,OAAO,SAAS,GAAG;AAKpC,cAAM,UAAU,MAAMA,aAAY;AAAA,UAChC;AAAA,UACA;AAAA,QACF;AACA,cAAM,MAAiC,CAAC;AACxC,mBAAW,OAAO,SAAS;AACzB,gBAAM,IAAI,QAAQ,GAAG;AAGrB,cAAI,EAAE,UAAU,OAAW,KAAI,GAAG,IAAI,EAAE;AAAA,QAC1C;AACA,eAAO;AAAA,MACT;AAAA,IACF;AAAA,EACF;AACF;AAEA,IAAI;AAKG,SAAS,4BAA4B;AAC1C,yBAAuB;AACzB;AAOO,SAAS,gBAGd;AACA,MAAI,CAAC,sBAAsB;AACzB,2BAAuB,oBAAoB,WAAW;AAAA,EACxD;AAEA,SAAO,qBAA8C;AACvD;AAEA,IAAM,eAAe,oBAAI,IAAqC;AAM9D,SAAS,kBAAkB,QAA8B;AACvD,MAAI,SAAS,aAAa,IAAI,MAAM;AACpC,MAAI,CAAC,QAAQ;AACX,aAAS,aAAa,MAAM;AAC5B,iBAAa,IAAI,QAAQ,MAAM;AAAA,EACjC;AACA,SAAO;AACT;AAEA,SAAS,eACP,QACmD;AACnD,SACE,OAAO,WAAW,YAClB,WAAW,QACX,cAAc,UACb,OAAmC,aAAa;AAErD;AAEA,eAAsB,gBACpB,OAKuB;AACvB,QAAM,WAAW,OAAO,OAAO,KAAK,EAEjC,OAAO,CAAC,MAAoC,CAAC,MAAM,QAAQ,CAAC,CAAC;AAGhE,QAAM,UAAU,oBAAI,IAAwB;AAC5C,aAAW,KAAK,UAAU;AACxB,QAAI,eAAe,EAAE,MAAM,GAAG;AAC5B,cAAQ,IAAI,EAAE,OAAO,MAAM;AAAA,IAC7B;AAAA,EACF;AAEA,QAAM,oBAAoB,oBAAI,IAAgC;AAC9D,QAAM,QAAQ;AAAA,IACZ,MAAM,KAAK,OAAO,EAAE,IAAI,OAAO,WAAW;AACxC,YAAM,SAAS,kBAAkB,MAAM;AACvC,UAAI;AACF,cAAM,WAAW,MAAM,OAAO,oBAAoB;AAClD,0BAAkB,IAAI,QAAQ,SAAS,SAAS;AAAA,MAClD,QAAQ;AACN,cAAM,WAAW,MAAM,OAAO,YAAY;AAC1C,0BAAkB,IAAI,QAAQ,SAAS,SAAS;AAAA,MAClD;AAAA,IACF,CAAC;AAAA,EACH;AAEA,QAAM,cAAc,SAAS,OAA4B,CAAC,KAAK,MAAM;AACnE,QAAI,CAAC,eAAe,EAAE,MAAM,EAAG,QAAO;AAEtC,UAAM,YAAY,kBAAkB,IAAI,EAAE,OAAO,MAAM;AACvD,QAAI,EAAE,GAAG,IAAI;AAAA,MACX,SAAS,EAAE;AAAA,MACX,QAAQ;AAAA,QACN,UAAU;AAAA,QACV;AAAA,MACF;AAAA,MACA,aAAa,EAAE;AAAA,MACf,cAAc,EAAE;AAAA,MAChB,gBAAgB;AAAA,IAClB;AAEA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AAEL,SAAO,EAAE,aAAa,OAAO,CAAC,EAAE;AAClC;","names":["flagsClient","vercelAdapter"]}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {\n createClient,\n type FlagsClient,\n flagsClient,\n Reason,\n} from '@vercel/flags-core';\nimport type {\n Adapter,\n FlagDeclaration,\n FlagDefinitionsType,\n FlagDefinitionType,\n ProviderData,\n} from 'flags';\nimport type { KeyedFlagDefinitionType } from 'flags/next';\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 sdkKeyOrFlagsClient?: string | FlagsClient,\n) {\n const flagsClient =\n typeof sdkKeyOrFlagsClient === 'string' || sdkKeyOrFlagsClient === undefined\n ? createClient(sdkKeyOrFlagsClient)\n : sdkKeyOrFlagsClient;\n\n // Stable identity for this adapter's underlying flagsClient. Captured in\n // the closure so every adapter object the factory below returns shares it,\n // letting `evaluate()` group flags from multiple `vercelAdapter()` calls\n // into a single `bulkDecide` invocation.\n const adapterId = Symbol('vercelAdapter');\n\n const adapter: Adapter<unknown, unknown> = {\n adapterId,\n origin: flagsClient.origin,\n config: { reportValue: false },\n async decide({ key, entities }) {\n const evaluationResult = await flagsClient.evaluate<unknown, unknown>(\n key,\n undefined,\n entities,\n );\n\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 async bulkDecide({ flags, entities }) {\n // `flags` is typed `{ key: string; defaultValue?: unknown }[]` on\n // `Adapter.bulkDecide` (to keep `ValueType` covariant). The client\n // here narrows it back to `ValueType`; `defaultValue` is shuttled\n // through opaquely so the cast is safe.\n const results = await flagsClient.bulkEvaluate<unknown, unknown>(\n flags as { key: string; defaultValue?: unknown }[],\n entities,\n );\n const out: Record<string, unknown> = {};\n for (const key in results) {\n const r = results[key]!;\n // Omit undefined so the SDK applies the per-flag `defaultValue`\n // fallback (matches single-decide semantics).\n if (r.value !== undefined) out[key] = r.value;\n }\n return out;\n },\n };\n\n return function vercelAdapter<ValueType, EntitiesType>(): Adapter<\n ValueType,\n EntitiesType\n > {\n return adapter as Adapter<ValueType, EntitiesType>;\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(flagsClient);\n }\n\n return defaultVercelAdapter<ValueType, EntitiesType>();\n}\n\nconst flagsClients = new Map<string | undefined, FlagsClient>();\n\n/**\n * Ensures we only ever create a single client per SDK Key\n * When undefined is passed, due to OIDC being used, then we return a single client too.\n **/\nfunction getOrCreateClient(sdkKey?: string): FlagsClient {\n let client = flagsClients.get(sdkKey);\n if (!client) {\n client = createClient(sdkKey);\n flagsClients.set(sdkKey, client);\n }\n return client;\n}\n\nfunction isVercelOrigin(\n origin: unknown,\n): origin is { provider: 'vercel'; sdkKey?: string } {\n return (\n typeof origin === 'object' &&\n origin !== null &&\n 'provider' in origin &&\n (origin as Record<string, unknown>).provider === 'vercel'\n );\n}\n\nexport async function getProviderData(\n flags: Record<\n string,\n // accept an unknown array\n KeyedFlagDefinitionType | readonly unknown[]\n >,\n): Promise<ProviderData> {\n const flagDefs = Object.values(flags)\n // filter out precomputed arrays\n .filter((i): i is KeyedFlagDefinitionType => !Array.isArray(i));\n\n // Collect unique sdkKeys and resolve their projectIds\n const sdkKeys = new Set<string | undefined>();\n for (const d of flagDefs) {\n if (isVercelOrigin(d.origin)) {\n sdkKeys.add(d.origin.sdkKey);\n }\n }\n\n const projectIdBySdkKey = new Map<string | undefined, string>();\n await Promise.all(\n Array.from(sdkKeys).map(async (sdkKey) => {\n const client = getOrCreateClient(sdkKey);\n try {\n const fallback = await client.getFallbackDatafile();\n projectIdBySdkKey.set(sdkKey, fallback.projectId);\n } catch {\n const datafile = await client.getDatafile();\n projectIdBySdkKey.set(sdkKey, datafile.projectId);\n }\n }),\n );\n\n const definitions = flagDefs.reduce<FlagDefinitionsType>((acc, d) => {\n if (!isVercelOrigin(d.origin)) return acc;\n\n const projectId = projectIdBySdkKey.get(d.origin.sdkKey)!;\n acc[d.key] = {\n options: d.options,\n origin: {\n provider: 'vercel',\n projectId,\n },\n description: d.description,\n defaultValue: d.defaultValue,\n declaredInCode: true,\n } satisfies FlagDefinitionType;\n\n return acc;\n }, {});\n\n return { definitions, hints: [] };\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EAEA;AAAA,EACA;AAAA,OACK;AAkBA,SAAS,oBAEd,qBACA;AACA,QAAMA,eACJ,OAAO,wBAAwB,YAAY,wBAAwB,SAC/D,aAAa,mBAAmB,IAChC;AAMN,QAAM,YAAY,uBAAO,eAAe;AAExC,QAAM,UAAqC;AAAA,IACzC;AAAA,IACA,QAAQA,aAAY;AAAA,IACpB,QAAQ,EAAE,aAAa,MAAM;AAAA,IAC7B,MAAM,OAAO,EAAE,KAAK,SAAS,GAAG;AAC9B,YAAM,mBAAmB,MAAMA,aAAY;AAAA,QACzC;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAEA,UAAI,iBAAiB,UAAU,QAAW;AAExC,cAAM,IAAI;AAAA,UACR,iBAAiB,WAAW,OAAO,SACjC,iBAAiB,eACf,mCAAmC,GAAG,MAAM,iBAAiB,YAAY,KACzE,mCAAmC,GAAG;AAAA,QAC5C;AAAA,MACF;AAIA,aAAO,iBAAiB;AAAA,IAC1B;AAAA,IACA,MAAM,WAAW,EAAE,OAAO,SAAS,GAAG;AAKpC,YAAM,UAAU,MAAMA,aAAY;AAAA,QAChC;AAAA,QACA;AAAA,MACF;AACA,YAAM,MAA+B,CAAC;AACtC,iBAAW,OAAO,SAAS;AACzB,cAAM,IAAI,QAAQ,GAAG;AAGrB,YAAI,EAAE,UAAU,OAAW,KAAI,GAAG,IAAI,EAAE;AAAA,MAC1C;AACA,aAAO;AAAA,IACT;AAAA,EACF;AAEA,SAAO,SAASC,iBAGd;AACA,WAAO;AAAA,EACT;AACF;AAEA,IAAI;AAKG,SAAS,4BAA4B;AAC1C,yBAAuB;AACzB;AAOO,SAAS,gBAGd;AACA,MAAI,CAAC,sBAAsB;AACzB,2BAAuB,oBAAoB,WAAW;AAAA,EACxD;AAEA,SAAO,qBAA8C;AACvD;AAEA,IAAM,eAAe,oBAAI,IAAqC;AAM9D,SAAS,kBAAkB,QAA8B;AACvD,MAAI,SAAS,aAAa,IAAI,MAAM;AACpC,MAAI,CAAC,QAAQ;AACX,aAAS,aAAa,MAAM;AAC5B,iBAAa,IAAI,QAAQ,MAAM;AAAA,EACjC;AACA,SAAO;AACT;AAEA,SAAS,eACP,QACmD;AACnD,SACE,OAAO,WAAW,YAClB,WAAW,QACX,cAAc,UACb,OAAmC,aAAa;AAErD;AAEA,eAAsB,gBACpB,OAKuB;AACvB,QAAM,WAAW,OAAO,OAAO,KAAK,EAEjC,OAAO,CAAC,MAAoC,CAAC,MAAM,QAAQ,CAAC,CAAC;AAGhE,QAAM,UAAU,oBAAI,IAAwB;AAC5C,aAAW,KAAK,UAAU;AACxB,QAAI,eAAe,EAAE,MAAM,GAAG;AAC5B,cAAQ,IAAI,EAAE,OAAO,MAAM;AAAA,IAC7B;AAAA,EACF;AAEA,QAAM,oBAAoB,oBAAI,IAAgC;AAC9D,QAAM,QAAQ;AAAA,IACZ,MAAM,KAAK,OAAO,EAAE,IAAI,OAAO,WAAW;AACxC,YAAM,SAAS,kBAAkB,MAAM;AACvC,UAAI;AACF,cAAM,WAAW,MAAM,OAAO,oBAAoB;AAClD,0BAAkB,IAAI,QAAQ,SAAS,SAAS;AAAA,MAClD,QAAQ;AACN,cAAM,WAAW,MAAM,OAAO,YAAY;AAC1C,0BAAkB,IAAI,QAAQ,SAAS,SAAS;AAAA,MAClD;AAAA,IACF,CAAC;AAAA,EACH;AAEA,QAAM,cAAc,SAAS,OAA4B,CAAC,KAAK,MAAM;AACnE,QAAI,CAAC,eAAe,EAAE,MAAM,EAAG,QAAO;AAEtC,UAAM,YAAY,kBAAkB,IAAI,EAAE,OAAO,MAAM;AACvD,QAAI,EAAE,GAAG,IAAI;AAAA,MACX,SAAS,EAAE;AAAA,MACX,QAAQ;AAAA,QACN,UAAU;AAAA,QACV;AAAA,MACF;AAAA,MACA,aAAa,EAAE;AAAA,MACf,cAAc,EAAE;AAAA,MAChB,gBAAgB;AAAA,IAClB;AAEA,WAAO;AAAA,EACT,GAAG,CAAC,CAAC;AAEL,SAAO,EAAE,aAAa,OAAO,CAAC,EAAE;AAClC;","names":["flagsClient","vercelAdapter"]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@flags-sdk/vercel",
3
- "version": "1.4.1",
3
+ "version": "1.4.2",
4
4
  "description": "A Flags SDK adapter for Vercel Flags",
5
5
  "keywords": [
6
6
  "vercel",
@@ -47,7 +47,7 @@
47
47
  "typescript": "5.6.3",
48
48
  "vite": "6.4.1",
49
49
  "vitest": "2.1.9",
50
- "flags": "4.1.1"
50
+ "flags": "4.2.0"
51
51
  },
52
52
  "peerDependencies": {
53
53
  "flags": "*"