@zenmanage/nextjs 0.0.0-stage → 1.0.1

package/dist/types-CFBzBNpk.d.cts

@@ -0,0 +1,103 @@
+import { FlagValue, ContextData, Context, Logger, DefaultsCollection, Zenmanage, FlagManager } from '@zenmanage/sdk';
+
+declare const DEFAULT_BOOTSTRAP_ELEMENT_ID = "__ZENMANAGE_BOOTSTRAP__";
+/**
+ * Rules are cached in memory for this many seconds. The SDK's own default is an hour, which
+ * would leave a long-running `next start` server on stale rules; a minute keeps flag changes
+ * visible quickly while still sharing one fetch across every request and component.
+ */
+declare const DEFAULT_SERVER_CACHE_TTL = 60;
+/**
+ * Widens a literal (`false`, `'control'`, `1500`) to its primitive type, so a value read with
+ * a literal fallback is `boolean`, `string` or `number` rather than the literal. Object and
+ * array values (JSON flags) pass through unchanged.
+ */
+type WidenFlagValue<T extends FlagValue> = T extends boolean ? boolean : T extends number ? number : T extends string ? string : T;
+interface NextZenmanageClientOptions {
+    /** A server key (`srv_...`). Server and edge runtimes reject client keys. */
+    environmentToken: string;
+    apiEndpoint?: string;
+    /** Seconds to cache rules in memory. Defaults to {@link DEFAULT_SERVER_CACHE_TTL}. */
+    cacheTtl?: number;
+    enableUsageReporting?: boolean;
+    logger?: Logger;
+}
+interface ServerFlagInput extends NextZenmanageClientOptions {
+    key: string;
+    defaultValue?: FlagValue;
+    context?: Context;
+    defaults?: DefaultsCollection;
+}
+interface ServerFlagsInput extends NextZenmanageClientOptions {
+    context?: Context;
+    defaults?: DefaultsCollection;
+}
+interface ServerBootstrapInput extends ServerFlagsInput {
+    /**
+     * The flags to send to the browser. Bootstrapping every flag puts each flag's key and
+     * value in the page source, so list only what client components read.
+     */
+    keys?: string[];
+    /** Include the evaluation context in the payload so the browser evaluates for the same user. */
+    includeContext?: boolean;
+}
+interface BootstrapPayload {
+    version: 1;
+    generatedAt: string;
+    flags: Record<string, FlagValue>;
+    context?: ContextData;
+}
+interface BuildBootstrapPayloadOptions {
+    context?: Context;
+    generatedAt?: Date;
+}
+interface BuildBootstrapScriptOptions {
+    elementId?: string;
+}
+interface RequestCookieValue {
+    value: string;
+}
+interface RequestCookiesLike {
+    get(name: string): RequestCookieValue | string | undefined;
+}
+interface RequestGeoLike {
+    country?: string;
+    region?: string;
+    city?: string;
+}
+interface RequestLike {
+    headers: Headers;
+    cookies?: RequestCookiesLike;
+    nextUrl?: {
+        pathname: string;
+    };
+    url?: string;
+    /** Removed from `NextRequest` in Next.js 15; the forwarding headers are used instead. */
+    ip?: string | null;
+    /** Removed from `NextRequest` in Next.js 15; the Vercel and Cloudflare headers are used instead. */
+    geo?: RequestGeoLike;
+}
+interface BuildRequestContextOptions {
+    contextType?: string;
+    contextName?: string;
+    identifierCookieName?: string;
+    identifierHeaderName?: string;
+    /** Add `country`, `region` and `city` attributes when the platform reports them. Default `true`. */
+    includeGeo?: boolean;
+    /** Add the visitor's IP address as an `ip` attribute. Default `false`: an IP is personal data. */
+    includeIp?: boolean;
+    additionalAttributes?: Record<string, string | string[] | undefined>;
+}
+interface MiddlewareFlagInput extends NextZenmanageClientOptions {
+    request: RequestLike;
+    key: string;
+    defaultValue?: FlagValue;
+    defaults?: DefaultsCollection;
+    requestContext?: BuildRequestContextOptions;
+}
+interface NextFlagsRuntime {
+    client: Zenmanage;
+    manager: FlagManager;
+}
+
+export { type BuildBootstrapPayloadOptions as B, DEFAULT_BOOTSTRAP_ELEMENT_ID as D, type MiddlewareFlagInput as M, type NextFlagsRuntime as N, type RequestCookiesLike as R, type ServerBootstrapInput as S, type WidenFlagValue as W, type BootstrapPayload as a, type BuildBootstrapScriptOptions as b, type BuildRequestContextOptions as c, DEFAULT_SERVER_CACHE_TTL as d, type NextZenmanageClientOptions as e, type RequestGeoLike as f, type RequestLike as g, type ServerFlagInput as h, type ServerFlagsInput as i };

package/dist/types-CFBzBNpk.d.ts

@@ -0,0 +1,103 @@
+import { FlagValue, ContextData, Context, Logger, DefaultsCollection, Zenmanage, FlagManager } from '@zenmanage/sdk';
+
+declare const DEFAULT_BOOTSTRAP_ELEMENT_ID = "__ZENMANAGE_BOOTSTRAP__";
+/**
+ * Rules are cached in memory for this many seconds. The SDK's own default is an hour, which
+ * would leave a long-running `next start` server on stale rules; a minute keeps flag changes
+ * visible quickly while still sharing one fetch across every request and component.
+ */
+declare const DEFAULT_SERVER_CACHE_TTL = 60;
+/**
+ * Widens a literal (`false`, `'control'`, `1500`) to its primitive type, so a value read with
+ * a literal fallback is `boolean`, `string` or `number` rather than the literal. Object and
+ * array values (JSON flags) pass through unchanged.
+ */
+type WidenFlagValue<T extends FlagValue> = T extends boolean ? boolean : T extends number ? number : T extends string ? string : T;
+interface NextZenmanageClientOptions {
+    /** A server key (`srv_...`). Server and edge runtimes reject client keys. */
+    environmentToken: string;
+    apiEndpoint?: string;
+    /** Seconds to cache rules in memory. Defaults to {@link DEFAULT_SERVER_CACHE_TTL}. */
+    cacheTtl?: number;
+    enableUsageReporting?: boolean;
+    logger?: Logger;
+}
+interface ServerFlagInput extends NextZenmanageClientOptions {
+    key: string;
+    defaultValue?: FlagValue;
+    context?: Context;
+    defaults?: DefaultsCollection;
+}
+interface ServerFlagsInput extends NextZenmanageClientOptions {
+    context?: Context;
+    defaults?: DefaultsCollection;
+}
+interface ServerBootstrapInput extends ServerFlagsInput {
+    /**
+     * The flags to send to the browser. Bootstrapping every flag puts each flag's key and
+     * value in the page source, so list only what client components read.
+     */
+    keys?: string[];
+    /** Include the evaluation context in the payload so the browser evaluates for the same user. */
+    includeContext?: boolean;
+}
+interface BootstrapPayload {
+    version: 1;
+    generatedAt: string;
+    flags: Record<string, FlagValue>;
+    context?: ContextData;
+}
+interface BuildBootstrapPayloadOptions {
+    context?: Context;
+    generatedAt?: Date;
+}
+interface BuildBootstrapScriptOptions {
+    elementId?: string;
+}
+interface RequestCookieValue {
+    value: string;
+}
+interface RequestCookiesLike {
+    get(name: string): RequestCookieValue | string | undefined;
+}
+interface RequestGeoLike {
+    country?: string;
+    region?: string;
+    city?: string;
+}
+interface RequestLike {
+    headers: Headers;
+    cookies?: RequestCookiesLike;
+    nextUrl?: {
+        pathname: string;
+    };
+    url?: string;
+    /** Removed from `NextRequest` in Next.js 15; the forwarding headers are used instead. */
+    ip?: string | null;
+    /** Removed from `NextRequest` in Next.js 15; the Vercel and Cloudflare headers are used instead. */
+    geo?: RequestGeoLike;
+}
+interface BuildRequestContextOptions {
+    contextType?: string;
+    contextName?: string;
+    identifierCookieName?: string;
+    identifierHeaderName?: string;
+    /** Add `country`, `region` and `city` attributes when the platform reports them. Default `true`. */
+    includeGeo?: boolean;
+    /** Add the visitor's IP address as an `ip` attribute. Default `false`: an IP is personal data. */
+    includeIp?: boolean;
+    additionalAttributes?: Record<string, string | string[] | undefined>;
+}
+interface MiddlewareFlagInput extends NextZenmanageClientOptions {
+    request: RequestLike;
+    key: string;
+    defaultValue?: FlagValue;
+    defaults?: DefaultsCollection;
+    requestContext?: BuildRequestContextOptions;
+}
+interface NextFlagsRuntime {
+    client: Zenmanage;
+    manager: FlagManager;
+}
+
+export { type BuildBootstrapPayloadOptions as B, DEFAULT_BOOTSTRAP_ELEMENT_ID as D, type MiddlewareFlagInput as M, type NextFlagsRuntime as N, type RequestCookiesLike as R, type ServerBootstrapInput as S, type WidenFlagValue as W, type BootstrapPayload as a, type BuildBootstrapScriptOptions as b, type BuildRequestContextOptions as c, DEFAULT_SERVER_CACHE_TTL as d, type NextZenmanageClientOptions as e, type RequestGeoLike as f, type RequestLike as g, type ServerFlagInput as h, type ServerFlagsInput as i };

package/package.json

@@ -1,6 +1,139 @@
 {
   "name": "@zenmanage/nextjs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.1",
+  "description": "Next.js integration helpers for Zenmanage feature flags: server evaluation, middleware, and hydration-safe client bootstrap",
+  "keywords": [
+    "nextjs",
+    "next.js",
+    "react",
+    "ssr",
+    "app-router",
+    "pages-router",
+    "middleware",
+    "feature-flags",
+    "feature-toggles",
+    "feature-management",
+    "remote-config",
+    "ab-testing",
+    "experiments",
+    "zenmanage"
+  ],
+  "homepage": "https://github.com/zenmanage/zenmanage-nextjs#readme",
+  "bugs": {
+    "url": "https://github.com/zenmanage/zenmanage-nextjs/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zenmanage/zenmanage-nextjs.git"
+  },
+  "license": "MIT",
+  "author": "Zenmanage",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./server": {
+      "import": {
+        "types": "./dist/server.d.ts",
+        "default": "./dist/server.js"
+      },
+      "require": {
+        "types": "./dist/server.d.cts",
+        "default": "./dist/server.cjs"
+      }
+    },
+    "./middleware": {
+      "import": {
+        "types": "./dist/middleware.d.ts",
+        "default": "./dist/middleware.js"
+      },
+      "require": {
+        "types": "./dist/middleware.d.cts",
+        "default": "./dist/middleware.cjs"
+      }
+    },
+    "./client": {
+      "import": {
+        "types": "./dist/client.d.ts",
+        "default": "./dist/client.js"
+      },
+      "require": {
+        "types": "./dist/client.d.cts",
+        "default": "./dist/client.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "rm -rf dist && tsup",
+    "clean": "rm -rf dist coverage",
+    "changeset": "changeset",
+    "version-packages": "changeset version",
+    "release": "changeset publish",
+    "lint": "eslint src tests --ext .ts,.tsx",
+    "lint:fix": "eslint src tests --ext .ts,.tsx --fix",
+    "format": "prettier --write \"src/**/*.{ts,tsx}\" \"tests/**/*.{ts,tsx}\" \"examples/**/*.{ts,tsx}\" \"examples/smoke-app/**/*.{js,jsx}\" \"scripts/**/*.mjs\" \"*.{md,json,yml,yaml,cjs}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,tsx}\" \"tests/**/*.{ts,tsx}\" \"examples/**/*.{ts,tsx}\" \"examples/smoke-app/**/*.{js,jsx}\" \"scripts/**/*.mjs\" \"*.{md,json,yml,yaml,cjs}\"",
+    "type-check": "tsc --noEmit && tsc -p tsconfig.test.json --noEmit && tsc -p tsconfig.examples.json",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:smoke": "npm run build && node scripts/smoke.mjs",
+    "validate": "npm run format:check && npm run lint && npm run type-check && npm run test:coverage && npm run build && npm run test:smoke",
+    "prepublishOnly": "npm run validate"
+  },
+  "peerDependencies": {
+    "@zenmanage/react": "^1.0.0",
+    "@zenmanage/sdk": "^3.5.0",
+    "next": "^13.4.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
+    "react": "^18.2.0 || ^19.0.0"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.28.1",
+    "@testing-library/react": "^16.0.1",
+    "@types/node": "^20.11.0",
+    "@types/react": "^19.2.0",
+    "@types/react-dom": "^19.2.0",
+    "@typescript-eslint/eslint-plugin": "^6.20.0",
+    "@typescript-eslint/parser": "^6.20.0",
+    "@vitest/coverage-v8": "^1.6.0",
+    "@zenmanage/react": "^1.0.0",
+    "@zenmanage/sdk": "^3.5.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "jsdom": "^24.1.1",
+    "next": "^15.5.0",
+    "prettier": "^3.3.3",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "tsup": "^8.2.4",
+    "typescript": "^5.6.2",
+    "vitest": "^1.6.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}