Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/brave-rooms-go.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@vercel/flags-core": patch
"@flags-sdk/vercel": patch
---

Loosen the type restrictions on the `Evaluation` type as the previous implementation would only work with `interface` but not with `type` that lead to an accidental breaking change.
17 changes: 16 additions & 1 deletion packages/adapter-vercel/src/index.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { flagsClient, resetDefaultFlagsClient } from '@vercel/flags-core';
import type { Origin, ProviderData } from 'flags';
import type { Adapter, Origin, ProviderData } from 'flags';
import { flag } from 'flags/next';
import { HttpResponse, http } from 'msw';
import { setupServer } from 'msw/node';
Expand All @@ -10,6 +10,7 @@ import {
beforeEach,
describe,
expect,
expectTypeOf,
it,
vi,
} from 'vitest';
Expand Down Expand Up @@ -102,6 +103,20 @@ describe('createVercelAdapter', () => {
sdkKey: 'vf_my_sdk_key',
} satisfies Origin);
});

it('has correct types', () => {
const adapter = createVercelAdapter(flagsClient);
type SampleValue = boolean;
type SampleEvaluationContext = { user: { id: string } };
const instance = adapter<SampleValue, SampleEvaluationContext>();
expectTypeOf(instance).toEqualTypeOf<
Adapter<SampleValue, SampleEvaluationContext>
>();
expectTypeOf(instance.decide)
.parameter(0)
.toHaveProperty('entities')
.toEqualTypeOf<SampleEvaluationContext | undefined>();
});
});

describe('when used with getProviderData', () => {
Expand Down
12 changes: 6 additions & 6 deletions packages/adapter-vercel/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ export function createVercelAdapter(
? createClient(sdkKeyOrFlagsClient)
: sdkKeyOrFlagsClient;

return function vercelAdapter<
return function vercelAdapter<ValueType, EntitiesType>(): Adapter<
ValueType,
EntitiesType extends Record<string, unknown>,
>(): Adapter<ValueType, EntitiesType> {
EntitiesType
> {
return {
origin: flagsClient.origin,
config: { reportValue: false },
Expand Down Expand Up @@ -75,10 +75,10 @@ export function resetDefaultVercelAdapter() {
*
*/
// This is initialized lazily to avoid warning when it is not actually used and env vars are missing.
export function vercelAdapter<
export function vercelAdapter<ValueType, EntitiesType>(): Adapter<
ValueType,
EntitiesType extends Record<string, unknown>,
>(): Adapter<ValueType, EntitiesType> {
EntitiesType
> {
if (!defaultVercelAdapter) {
defaultVercelAdapter = createVercelAdapter(flagsClient);
}
Expand Down
4 changes: 1 addition & 3 deletions packages/vercel-flags-core/src/types.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import type { ControllerInstance } from './controller-fns';

/**
* Options for stream connection behavior
*/
Expand Down Expand Up @@ -138,7 +136,7 @@ export type FlagsClient<Entities = Record<string, unknown>> = {
* @param entities
* @returns
*/
evaluate: <T = Value, E extends Entities = Entities>(
evaluate: <T = Value, E = Entities>(
flagKey: string,
defaultValue?: T,
entities?: E,
Expand Down
Loading