@flagsync/nextjs-sdk 0.2.6

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,288 @@
+# FlagSync Adapter for Vercel Flags
+
+[FlagSync](https://www.flagsync.com) brings affordable, user-friendly feature flags and A/B testing to indie hackers and growing businesses. This adapter integrates FlagSync with [Vercel Flags](https://vercel.com/docs/flags) in Next.js apps. [Get started](https://docs.flagsync.com/getting-started/set-up-flagsync) today!
+
+[![npm version](https://badge.fury.io/js/%40flagsync%2Fvercel-flags-sdk.svg)](https://badge.fury.io/js/%40flagsync%2Fvercel-flags-sdk)
+[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/flagsync.svg?style=social&label=Follow%20%40flagsync)](https://twitter.com/flagsync)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+---
+
+## Getting Started
+
+Refer to the [SDK documentation](https://docs.flagsync.com/sdks/next.js) for more information on how to use this library.
+
+### Compatibility
+
+- Requires [Next.js](https://nextjs.org/) 14+
+- Compatible with Node.js 16+ and ES5.
+- TypeScript is fully supported.
+- **Note:** This SDK is optimized for Next.js App Router. For non-Next.js Node.js apps, use the [FlagSync Node SDK](https://github.com/flagsync/node-client) instead.
+
+### Prerequisites
+- Install the SDK: `npm install @flagsync/vercel-flags-sdk flags/next`
+- Set the `FLAGSYNC_SDK_KEY` environment variable in your `.env` file.
+
+## Basic Setup
+
+FlagSync lets you toggle features and personalize experiences in your Next.js App Router application. Follow these steps to set it up.
+
+### Step 1: Create the FlagSync client singleton
+
+Initialize the client with your server-side SDK key:
+
+```typescript
+// lib/flagsync.ts
+import { createFlagSyncClient } from '@flagsync/vercel-flags-sdk';
+
+export const client = createFlagSyncClient({
+  sdkKey: process.env.FLAGSYNC_SDK_KEY!,
+});
+```
+
+### Step 2: Set up user identification
+
+> [!NOTE]
+> Feature flags in FlagSync use user context (e.g. via `identify`) to enable personalized experiences.
+
+The `identify` function defines how users are identified (e.g., via cookies, headers, or session data). See [Identify](#identify) for more details.
+
+```typescript
+// lib/flagsync.ts
+import {
+  createIdentify,
+  createFlagSyncClient,
+} from '@flagsync/vercel-flags-sdk';
+
+export const identify = createIdentify(({ cookies }) => {
+  const userId = cookies.get('user-id')?.value;       // Authenticated user ID
+  const visitorId = cookies.get('visitor-id')?.value; // Unauthenticated visitor ID
+  return {
+    key: userId ?? visitorId ?? 'anonymous'           // Fallback to 'anonymous'
+  };
+});
+```
+> [!CAUTION]
+> While `anonymous` user contexts are supported, always provide a unique identifier (even for unauthenticated users) to ensure consistent flag evaluation.
+> 
+> See [Identify](#identify) for more details.
+
+### Step 3: Define a feature flag
+
+Create a flag definition using the shared `client` and `identify` function:
+
+```typescript
+// app/dashboard/flags.ts
+import { flag } from 'flags/next';
+import { client, identify } from '@/lib/flagsync';
+import { createStringFlagAdaptor } from '@flagsync/vercel-flags-sdk';
+
+export const dashboardFlag = flag<string>({
+  identify,                                 // Links flag to user context
+  key: 'dashboardFlag',                     // Unique flag key
+  adapter: createStringFlagAdaptor(client), // Retrieves the flag with type safety
+});
+```
+
+### Step 4: Use the flag in your app
+
+Now you can use `dashboardFlag` in your Server Components:
+
+```typescript jsx
+// app/dashboard/page.tsx
+
+import { dashboardFlag } from '@/app/dashboard/flags';
+
+export default async function DashboardPage() {
+  const dashboard = await dashboardFlag();
+
+  return (
+    <div>The value of {dashboardFlag.key} is {dashboard}</div>
+  );
+}
+```
+
+## Type-Safe Feature Flags
+
+FlagSync supports multiple flag types for different use cases. Use the type-specific adapter depending on your flag type: 
+
+- `createBoolFlagAdaptor`: For boolean flags
+- `createStringFlagAdaptor`: For string flags
+- `createNumberFlagAdaptor`: For numeric flags
+- `createJsonFlagAdaptor`: For JSON object flags
+
+```typescript
+// app/<route>/flags.ts
+import { client, identify } from '@/lib/flagsync';
+import {
+  createBoolFlagAdaptor,
+  createJsonFlagAdaptor,
+  createNumberFlagAdaptor,
+  createStringFlagAdaptor,
+} from '@flagsync/vercel-flags-sdk';
+import { flag } from '@vercel/flags';
+
+// Boolean flag for feature toggles
+export const betaFeatureFlag = flag<boolean>({
+  identify,
+  key: 'beta-feature-enabled',
+  adapter: createBoolFlagAdaptor(client),
+});
+
+// String flag for UI variants
+export const heroCtaFlag = flag<string>({
+  identify,
+  key: 'hero-cta',
+  adapter: createStringFlagAdaptor(client),
+});
+
+// Number flag for pricing tiers
+export const discountFlag = flag<number>({
+  identify,
+  key: 'price-discount',
+  adapter: createNumberFlagAdaptor(client),
+});
+
+// JSON flag for complex configurations
+export const featureConfigFlag = flag<{
+  enabled: boolean;
+  limits: { requests: number; storage: number };
+}>({
+  identify,
+  key: 'feature-config',
+  adapter: createJsonFlagAdaptor(client),
+});
+```
+
+## Identify
+
+The `identify` function links feature flags to user contexts in FlagSync by returning an `FsUserContext` object.
+
+```typescript
+type FsUserContext = {
+  key: string;  // Unique identifier for the user
+  attributes?: Record<string, string | number | boolean>; // Optional custom data (used in individual targeting)
+};
+```
+* `key`: A unique ID for the user (required)
+* `attributes`: Optional metadata (e.g., user agent, region, role, department) to personalize flag evaluations.
+
+> [!IMPORTANT]
+> User contexts enable personalized flag evaluations via [Individual Targeting](https://docs.flagsync.com/sdks/sdk-concepts/flag-evaluation#does-the-flag-have-any-individual-targeting-rules), and consistent experiences during [Percentage Rollouts](https://docs.flagsync.com/sdks/sdk-concepts/flag-evaluation#does-the-flag-have-a-percentage-rollout).
+
+We recommend:
+1. Using a helper function (getFlagSyncUserContext) to build the full context.
+2. Setting cookies in middleware for the key.
+
+Here's how:
+
+### Step 1: Define a helper function
+
+Create a utility to build the user context:
+
+```typescript
+// lib/flagsync.user-context.ts
+import type { ReadonlyRequestCookies, ReadonlyHeaders } from 'flags';
+import { dedupe } from 'flags/next';
+import { nanoid } from 'nanoid';
+import type { NextRequest } from 'next/server';
+
+const generateId = dedupe(async () => nanoid());
+
+export const getFlagSyncUserContext = async (
+  cookies: ReadonlyRequestCookies | NextRequest['cookies'],
+  headers: ReadonlyHeaders | NextRequest['headers'],
+) => {
+  const userId = cookies.get('user-id')?.value; // Authenticated user
+  const visitorId = cookies.get('visitor-id')?.value; // Anonymous visitor
+
+  return {
+    key: userId ?? visitorId ?? (await generateId()), // Fallback to new ID
+    attributes: {
+      userAgent: headers.get('user-agent') || 'unknown', // Browser info
+      region: headers.get('x-region-code') || 'default', // Custom header
+    },
+  };
+};
+
+```
+### Step 2: Set up identification
+
+Use the helper in `identify`:
+
+```typescript
+// lib/flagsync.ts
+import { createIdentify, createFlagSyncClient } from '@flagsync/vercel-flags-sdk';
+import { getFlagSyncUserContext } from '@lib/flagsync.user-context';
+
+export const identify = createIdentify(({ cookies, headers }) => {
+  return getFlagSyncUserContext(cookies, headers);
+});
+
+export const client = createFlagSyncClient({
+  sdkKey: process.env.FLAGSYNC_SDK_KEY!,
+});
+```
+
+### Step 3: Handle cookies in middleware
+
+```typescript
+// middleware.ts
+import { NextRequest, NextResponse } from 'next/server';
+import { nanoid } from 'nanoid';
+
+export async function middleware(request: NextRequest) {
+  const response = NextResponse.next();
+
+  // Example: Get userId from a JWT or API call (replace with your logic)
+  const jwt = request.cookies.get('jwt')?.value;
+  let userId: string | undefined;
+  if (jwt) {
+    userId = 'user@example.com'; // Stub: e.g., await decodeJwt(jwt).email
+  }
+
+  if (userId) {
+    response.cookies.set('user-id', userId, { maxAge: 60 * 60 * 24 * 7 });
+  } else {
+    const visitorId = request.cookies.get('visitor-id')?.value ?? nanoid();
+    response.cookies.set('visitor-id', visitorId, { maxAge: 60 * 60 * 24 * 365 });
+  }
+
+  return response;
+}
+
+export const config = {
+  matcher: [
+    /*
+     * Match all request paths except for the ones starting with:
+     * - api (API routes)
+     * - _next/static (static files)
+     * - _next/image (image optimization files)
+     * - favicon.ico (favicon file)
+     */
+    {
+      source: '/((?!api|_next/static|_next/image|favicon.ico).*)',
+      missing: [
+        { type: 'header', key: 'next-router-prefetch' },
+        { type: 'header', key: 'purpose', value: 'prefetch' },
+      ],
+    },
+  ],
+};
+
+```
+
+## Next Steps
+
+- Configure flags in the [FlagSync dashboard](https://www.flagsync.com/dashboard).
+- Explore the [Docs](https://docs.flagsync.com/) for information on how to use FlagSync.
+
+## Environment Variables
+
+Required environment variables:
+
+- `FLAGSYNC_SDK_KEY`: Your server-side FlagSync SDK key (required)
+
+### License
+
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

package/dist/index.cjs

@@ -0,0 +1,89 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  SyncType: () => import_node_sdk2.SyncType,
+  createBoolFlagAdaptor: () => createBoolFlagAdaptor,
+  createFlagSyncAdapter: () => createFlagSyncAdapter,
+  createFlagSyncClient: () => createFlagSyncClient,
+  createIdentify: () => createIdentify,
+  createJsonFlagAdaptor: () => createJsonFlagAdaptor,
+  createNumberFlagAdaptor: () => createNumberFlagAdaptor,
+  createStringFlagAdaptor: () => createStringFlagAdaptor
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_sdk2 = require("@flagsync/node-sdk");
+
+// src/adapter.ts
+var import_node_sdk = require("@flagsync/node-sdk");
+function createFlagSyncClient(config) {
+  const instance = (0, import_node_sdk.FlagSyncFactory)({
+    ...config,
+    metadata: {
+      sdkName: "@flagsync/nextjs-sdk",
+      sdkVersion: "0.2.6"
+    }
+  });
+  return instance.client();
+}
+function createFlagSyncAdapter(client) {
+  let isReady = false;
+  const ensureReady = async () => {
+    if (!isReady) {
+      await client.waitForReady();
+      isReady = true;
+    }
+  };
+  return function flagSyncAdapter() {
+    return {
+      /**
+       * Evaluates a feature flag for a given context and returns its value.
+       */
+      async decide({ key, entities }) {
+        await ensureReady();
+        const userContext = {
+          key: "anonymous",
+          ...entities ?? {}
+        };
+        return client.flag(userContext, key);
+      }
+    };
+  };
+}
+var createStringFlagAdaptor = (client) => createFlagSyncAdapter(client)();
+var createBoolFlagAdaptor = (client) => createFlagSyncAdapter(client)();
+var createNumberFlagAdaptor = (client) => createFlagSyncAdapter(client)();
+var createJsonFlagAdaptor = (client) => createFlagSyncAdapter(client)();
+
+// src/identify.ts
+var createIdentify = (callback) => (params) => callback(params);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  SyncType,
+  createBoolFlagAdaptor,
+  createFlagSyncAdapter,
+  createFlagSyncClient,
+  createIdentify,
+  createJsonFlagAdaptor,
+  createNumberFlagAdaptor,
+  createStringFlagAdaptor
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/adapter.ts","../src/identify.ts"],"sourcesContent":["export type {\n  CustomAttributes,\n  CustomAttributeValue,\n  FsConfig,\n  FsClient,\n  LogLevel,\n  FsUserContext,\n} from '@flagsync/node-sdk';\n\nexport { SyncType } from '@flagsync/node-sdk';\n\nexport type { JsonObject } from './types';\n\nexport {\n  createFlagSyncClient,\n  createFlagSyncAdapter,\n  createBoolFlagAdaptor,\n  createStringFlagAdaptor,\n  createJsonFlagAdaptor,\n  createNumberFlagAdaptor,\n} from './adapter';\n\nexport { createIdentify } from './identify';\n","import {\n  FlagSyncFactory,\n  FsClient,\n  type FsConfig,\n  type FsUserContext,\n} from '@flagsync/node-sdk';\nimport type { Adapter } from '@vercel/flags';\n\nimport { JsonObject } from './types';\n\n/**\n * Creates a FlagSync client instance that can be used across multiple feature flags.\n * This function should be called once to create a singleton client for your application.\n */\nexport function createFlagSyncClient(config: FsConfig): FsClient {\n  const instance = FlagSyncFactory({\n    ...config,\n    metadata: {\n      sdkName: '@flagsync/nextjs-sdk',\n      sdkVersion: '0.2.6',\n    },\n  });\n  return instance.client();\n}\n\n/**\n * Creates an adapter factory that integrates FlagSync with Vercel's feature flag system.\n * This adapter handles the communication between your application and the FlagSync service.\n */\nexport function createFlagSyncAdapter(client: FsClient) {\n  let isReady = false;\n\n  /**\n   * Ensures the FlagSync client is ready before making any flag decisions.\n   * This is called internally before each flag evaluation.\n   */\n  const ensureReady = async () => {\n    if (!isReady) {\n      await client.waitForReady();\n      isReady = true;\n    }\n  };\n\n  /**\n   * Creates a typed adapter instance for a specific flag value type.\n   */\n  return function flagSyncAdapter<ValueType>(): Adapter<\n    ValueType,\n    FsUserContext\n  > {\n    return {\n      /**\n       * Evaluates a feature flag for a given context and returns its value.\n       */\n      async decide({ key, entities }) {\n        await ensureReady();\n\n        const userContext: FsUserContext = {\n          key: 'anonymous',\n          ...(entities ?? {}),\n        };\n\n        return client.flag<ValueType>(userContext, key);\n      },\n    };\n  };\n}\n\n/** Creates an adapter for string-typed flags */\nexport const createStringFlagAdaptor = (\n  client: FsClient,\n): Adapter<string, FsUserContext> => createFlagSyncAdapter(client)<string>();\n\n/** Creates an adapter for boolean-typed flags */\nexport const createBoolFlagAdaptor = (\n  client: FsClient,\n): Adapter<boolean, FsUserContext> => createFlagSyncAdapter(client)<boolean>();\n\n/** Creates an adapter for number-typed flags */\nexport const createNumberFlagAdaptor = (\n  client: FsClient,\n): Adapter<number, FsUserContext> => createFlagSyncAdapter(client)<number>();\n\n/** Creates an adapter for JSON object-typed flags */\nexport const createJsonFlagAdaptor = (\n  client: FsClient,\n): Adapter<JsonObject, FsUserContext> =>\n  createFlagSyncAdapter(client)<JsonObject>();\n","import { FsUserContext } from '@flagsync/node-sdk';\nimport { Identify } from '@vercel/flags';\n\ntype ExtractParams<T> = T extends (params: infer P) => any ? P : never;\n\nexport const createIdentify =\n  (\n    callback: (\n      params: ExtractParams<Identify<FsUserContext>>,\n    ) => Promise<FsUserContext> | FsUserContext,\n  ): Identify<FsUserContext> =>\n  (params) =>\n    callback(params);\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AASA,IAAAA,mBAAyB;;;ACTzB,sBAKO;AASA,SAAS,qBAAqB,QAA4B;AAC/D,QAAM,eAAW,iCAAgB;AAAA,IAC/B,GAAG;AAAA,IACH,UAAU;AAAA,MACR,SAAS;AAAA,MACT,YAAY;AAAA,IACd;AAAA,EACF,CAAC;AACD,SAAO,SAAS,OAAO;AACzB;AAMO,SAAS,sBAAsB,QAAkB;AACtD,MAAI,UAAU;AAMd,QAAM,cAAc,YAAY;AAC9B,QAAI,CAAC,SAAS;AACZ,YAAM,OAAO,aAAa;AAC1B,gBAAU;AAAA,IACZ;AAAA,EACF;AAKA,SAAO,SAAS,kBAGd;AACA,WAAO;AAAA;AAAA;AAAA;AAAA,MAIL,MAAM,OAAO,EAAE,KAAK,SAAS,GAAG;AAC9B,cAAM,YAAY;AAElB,cAAM,cAA6B;AAAA,UACjC,KAAK;AAAA,UACL,GAAI,YAAY,CAAC;AAAA,QACnB;AAEA,eAAO,OAAO,KAAgB,aAAa,GAAG;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AACF;AAGO,IAAM,0BAA0B,CACrC,WACmC,sBAAsB,MAAM,EAAU;AAGpE,IAAM,wBAAwB,CACnC,WACoC,sBAAsB,MAAM,EAAW;AAGtE,IAAM,0BAA0B,CACrC,WACmC,sBAAsB,MAAM,EAAU;AAGpE,IAAM,wBAAwB,CACnC,WAEA,sBAAsB,MAAM,EAAc;;;AClFrC,IAAM,iBACX,CACE,aAIF,CAAC,WACC,SAAS,MAAM;","names":["import_node_sdk"]}

package/dist/index.d.cts

@@ -0,0 +1,34 @@
+import { FsConfig, FsClient, FsUserContext } from '@flagsync/node-sdk';
+export { CustomAttributeValue, CustomAttributes, FsClient, FsConfig, FsUserContext, LogLevel, SyncType } from '@flagsync/node-sdk';
+import { Adapter, Identify } from '@vercel/flags';
+
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+type JsonArray = Array<JsonValue>;
+interface JsonObject {
+    [key: string]: JsonValue;
+}
+
+/**
+ * Creates a FlagSync client instance that can be used across multiple feature flags.
+ * This function should be called once to create a singleton client for your application.
+ */
+declare function createFlagSyncClient(config: FsConfig): FsClient;
+/**
+ * Creates an adapter factory that integrates FlagSync with Vercel's feature flag system.
+ * This adapter handles the communication between your application and the FlagSync service.
+ */
+declare function createFlagSyncAdapter(client: FsClient): <ValueType>() => Adapter<ValueType, FsUserContext>;
+/** Creates an adapter for string-typed flags */
+declare const createStringFlagAdaptor: (client: FsClient) => Adapter<string, FsUserContext>;
+/** Creates an adapter for boolean-typed flags */
+declare const createBoolFlagAdaptor: (client: FsClient) => Adapter<boolean, FsUserContext>;
+/** Creates an adapter for number-typed flags */
+declare const createNumberFlagAdaptor: (client: FsClient) => Adapter<number, FsUserContext>;
+/** Creates an adapter for JSON object-typed flags */
+declare const createJsonFlagAdaptor: (client: FsClient) => Adapter<JsonObject, FsUserContext>;
+
+type ExtractParams<T> = T extends (params: infer P) => any ? P : never;
+declare const createIdentify: (callback: (params: ExtractParams<Identify<FsUserContext>>) => Promise<FsUserContext> | FsUserContext) => Identify<FsUserContext>;
+
+export { type JsonObject, createBoolFlagAdaptor, createFlagSyncAdapter, createFlagSyncClient, createIdentify, createJsonFlagAdaptor, createNumberFlagAdaptor, createStringFlagAdaptor };

package/dist/index.d.ts

@@ -0,0 +1,34 @@
+import { FsConfig, FsClient, FsUserContext } from '@flagsync/node-sdk';
+export { CustomAttributeValue, CustomAttributes, FsClient, FsConfig, FsUserContext, LogLevel, SyncType } from '@flagsync/node-sdk';
+import { Adapter, Identify } from '@vercel/flags';
+
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+type JsonArray = Array<JsonValue>;
+interface JsonObject {
+    [key: string]: JsonValue;
+}
+
+/**
+ * Creates a FlagSync client instance that can be used across multiple feature flags.
+ * This function should be called once to create a singleton client for your application.
+ */
+declare function createFlagSyncClient(config: FsConfig): FsClient;
+/**
+ * Creates an adapter factory that integrates FlagSync with Vercel's feature flag system.
+ * This adapter handles the communication between your application and the FlagSync service.
+ */
+declare function createFlagSyncAdapter(client: FsClient): <ValueType>() => Adapter<ValueType, FsUserContext>;
+/** Creates an adapter for string-typed flags */
+declare const createStringFlagAdaptor: (client: FsClient) => Adapter<string, FsUserContext>;
+/** Creates an adapter for boolean-typed flags */
+declare const createBoolFlagAdaptor: (client: FsClient) => Adapter<boolean, FsUserContext>;
+/** Creates an adapter for number-typed flags */
+declare const createNumberFlagAdaptor: (client: FsClient) => Adapter<number, FsUserContext>;
+/** Creates an adapter for JSON object-typed flags */
+declare const createJsonFlagAdaptor: (client: FsClient) => Adapter<JsonObject, FsUserContext>;
+
+type ExtractParams<T> = T extends (params: infer P) => any ? P : never;
+declare const createIdentify: (callback: (params: ExtractParams<Identify<FsUserContext>>) => Promise<FsUserContext> | FsUserContext) => Identify<FsUserContext>;
+
+export { type JsonObject, createBoolFlagAdaptor, createFlagSyncAdapter, createFlagSyncClient, createIdentify, createJsonFlagAdaptor, createNumberFlagAdaptor, createStringFlagAdaptor };

package/dist/index.js

@@ -0,0 +1,59 @@
+// src/index.ts
+import { SyncType } from "@flagsync/node-sdk";
+
+// src/adapter.ts
+import {
+  FlagSyncFactory
+} from "@flagsync/node-sdk";
+function createFlagSyncClient(config) {
+  const instance = FlagSyncFactory({
+    ...config,
+    metadata: {
+      sdkName: "@flagsync/nextjs-sdk",
+      sdkVersion: "0.2.6"
+    }
+  });
+  return instance.client();
+}
+function createFlagSyncAdapter(client) {
+  let isReady = false;
+  const ensureReady = async () => {
+    if (!isReady) {
+      await client.waitForReady();
+      isReady = true;
+    }
+  };
+  return function flagSyncAdapter() {
+    return {
+      /**
+       * Evaluates a feature flag for a given context and returns its value.
+       */
+      async decide({ key, entities }) {
+        await ensureReady();
+        const userContext = {
+          key: "anonymous",
+          ...entities ?? {}
+        };
+        return client.flag(userContext, key);
+      }
+    };
+  };
+}
+var createStringFlagAdaptor = (client) => createFlagSyncAdapter(client)();
+var createBoolFlagAdaptor = (client) => createFlagSyncAdapter(client)();
+var createNumberFlagAdaptor = (client) => createFlagSyncAdapter(client)();
+var createJsonFlagAdaptor = (client) => createFlagSyncAdapter(client)();
+
+// src/identify.ts
+var createIdentify = (callback) => (params) => callback(params);
+export {
+  SyncType,
+  createBoolFlagAdaptor,
+  createFlagSyncAdapter,
+  createFlagSyncClient,
+  createIdentify,
+  createJsonFlagAdaptor,
+  createNumberFlagAdaptor,
+  createStringFlagAdaptor
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/adapter.ts","../src/identify.ts"],"sourcesContent":["export type {\n  CustomAttributes,\n  CustomAttributeValue,\n  FsConfig,\n  FsClient,\n  LogLevel,\n  FsUserContext,\n} from '@flagsync/node-sdk';\n\nexport { SyncType } from '@flagsync/node-sdk';\n\nexport type { JsonObject } from './types';\n\nexport {\n  createFlagSyncClient,\n  createFlagSyncAdapter,\n  createBoolFlagAdaptor,\n  createStringFlagAdaptor,\n  createJsonFlagAdaptor,\n  createNumberFlagAdaptor,\n} from './adapter';\n\nexport { createIdentify } from './identify';\n","import {\n  FlagSyncFactory,\n  FsClient,\n  type FsConfig,\n  type FsUserContext,\n} from '@flagsync/node-sdk';\nimport type { Adapter } from '@vercel/flags';\n\nimport { JsonObject } from './types';\n\n/**\n * Creates a FlagSync client instance that can be used across multiple feature flags.\n * This function should be called once to create a singleton client for your application.\n */\nexport function createFlagSyncClient(config: FsConfig): FsClient {\n  const instance = FlagSyncFactory({\n    ...config,\n    metadata: {\n      sdkName: '@flagsync/nextjs-sdk',\n      sdkVersion: '0.2.6',\n    },\n  });\n  return instance.client();\n}\n\n/**\n * Creates an adapter factory that integrates FlagSync with Vercel's feature flag system.\n * This adapter handles the communication between your application and the FlagSync service.\n */\nexport function createFlagSyncAdapter(client: FsClient) {\n  let isReady = false;\n\n  /**\n   * Ensures the FlagSync client is ready before making any flag decisions.\n   * This is called internally before each flag evaluation.\n   */\n  const ensureReady = async () => {\n    if (!isReady) {\n      await client.waitForReady();\n      isReady = true;\n    }\n  };\n\n  /**\n   * Creates a typed adapter instance for a specific flag value type.\n   */\n  return function flagSyncAdapter<ValueType>(): Adapter<\n    ValueType,\n    FsUserContext\n  > {\n    return {\n      /**\n       * Evaluates a feature flag for a given context and returns its value.\n       */\n      async decide({ key, entities }) {\n        await ensureReady();\n\n        const userContext: FsUserContext = {\n          key: 'anonymous',\n          ...(entities ?? {}),\n        };\n\n        return client.flag<ValueType>(userContext, key);\n      },\n    };\n  };\n}\n\n/** Creates an adapter for string-typed flags */\nexport const createStringFlagAdaptor = (\n  client: FsClient,\n): Adapter<string, FsUserContext> => createFlagSyncAdapter(client)<string>();\n\n/** Creates an adapter for boolean-typed flags */\nexport const createBoolFlagAdaptor = (\n  client: FsClient,\n): Adapter<boolean, FsUserContext> => createFlagSyncAdapter(client)<boolean>();\n\n/** Creates an adapter for number-typed flags */\nexport const createNumberFlagAdaptor = (\n  client: FsClient,\n): Adapter<number, FsUserContext> => createFlagSyncAdapter(client)<number>();\n\n/** Creates an adapter for JSON object-typed flags */\nexport const createJsonFlagAdaptor = (\n  client: FsClient,\n): Adapter<JsonObject, FsUserContext> =>\n  createFlagSyncAdapter(client)<JsonObject>();\n","import { FsUserContext } from '@flagsync/node-sdk';\nimport { Identify } from '@vercel/flags';\n\ntype ExtractParams<T> = T extends (params: infer P) => any ? P : never;\n\nexport const createIdentify =\n  (\n    callback: (\n      params: ExtractParams<Identify<FsUserContext>>,\n    ) => Promise<FsUserContext> | FsUserContext,\n  ): Identify<FsUserContext> =>\n  (params) =>\n    callback(params);\n"],"mappings":";AASA,SAAS,gBAAgB;;;ACTzB;AAAA,EACE;AAAA,OAIK;AASA,SAAS,qBAAqB,QAA4B;AAC/D,QAAM,WAAW,gBAAgB;AAAA,IAC/B,GAAG;AAAA,IACH,UAAU;AAAA,MACR,SAAS;AAAA,MACT,YAAY;AAAA,IACd;AAAA,EACF,CAAC;AACD,SAAO,SAAS,OAAO;AACzB;AAMO,SAAS,sBAAsB,QAAkB;AACtD,MAAI,UAAU;AAMd,QAAM,cAAc,YAAY;AAC9B,QAAI,CAAC,SAAS;AACZ,YAAM,OAAO,aAAa;AAC1B,gBAAU;AAAA,IACZ;AAAA,EACF;AAKA,SAAO,SAAS,kBAGd;AACA,WAAO;AAAA;AAAA;AAAA;AAAA,MAIL,MAAM,OAAO,EAAE,KAAK,SAAS,GAAG;AAC9B,cAAM,YAAY;AAElB,cAAM,cAA6B;AAAA,UACjC,KAAK;AAAA,UACL,GAAI,YAAY,CAAC;AAAA,QACnB;AAEA,eAAO,OAAO,KAAgB,aAAa,GAAG;AAAA,MAChD;AAAA,IACF;AAAA,EACF;AACF;AAGO,IAAM,0BAA0B,CACrC,WACmC,sBAAsB,MAAM,EAAU;AAGpE,IAAM,wBAAwB,CACnC,WACoC,sBAAsB,MAAM,EAAW;AAGtE,IAAM,0BAA0B,CACrC,WACmC,sBAAsB,MAAM,EAAU;AAGpE,IAAM,wBAAwB,CACnC,WAEA,sBAAsB,MAAM,EAAc;;;AClFrC,IAAM,iBACX,CACE,aAIF,CAAC,WACC,SAAS,MAAM;","names":[]}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@flagsync/nextjs-sdk",
+  "version": "0.2.6",
+  "description": "FlagSync adapter for Vercel's Flags SDK",
+  "author": "Mike Chabot",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/flagsync/nextjs-sdk"
+  },
+  "homepage": "https://www.flagsync.com",
+  "type": "module",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "package.json"
+  ],
+  "engines": {
+    "node": ">=16",
+    "npm": ">=6"
+  },
+  "peerDependencies": {
+    "@vercel/flags": "^3.1.1"
+  },
+  "dependencies": {
+    "@flagsync/node-sdk": "^0.2.1"
+  },
+  "devDependencies": {
+    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
+    "@types/node": "^20.14.2",
+    "@types/semver": "^7.5.8",
+    "@typescript-eslint/eslint-plugin": "^8.26.1",
+    "@typescript-eslint/parser": "^8.26.1",
+    "@vercel/flags": "^3.1.1",
+    "eslint": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "prettier": "^3.5.3",
+    "replace-in-file": "^7.2.0",
+    "semver": "^7.7.1",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "vite": "^6.2.1",
+    "vitest": "^3.0.8"
+  },
+  "scripts": {
+    "build": "tsup",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint \"src/**/*.ts\" --fix",
+    "test": "vitest"
+  }
+}