@infaris/flags 0.0.0-stage → 0.1.0

package/dist/react.d.cts

@@ -0,0 +1,17 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+import { BrowserFlags } from './client.cjs';
+import { C as ConfigValue, E as EvaluatedFlags } from './types-DMIusvFt.cjs';
+
+declare function FlagsProvider({ client, children }: {
+    client: BrowserFlags;
+    children?: ReactNode;
+}): react.FunctionComponentElement<react.ProviderProps<BrowserFlags | null>>;
+/** One flag; `defaultValue` until Hosting answered, or for a flag the publishable key may not see. */
+declare function useFlag(key: string, defaultValue?: boolean): boolean;
+/** Every client-visible flag and value. */
+declare function useFlags(): EvaluatedFlags;
+/** One client-visible Edge Config value. */
+declare function useConfig<T extends ConfigValue = ConfigValue>(key: string, defaultValue?: T): T | undefined;
+
+export { FlagsProvider, useConfig, useFlag, useFlags };

package/dist/react.d.ts

@@ -0,0 +1,17 @@
+import * as react from 'react';
+import { ReactNode } from 'react';
+import { BrowserFlags } from './client.js';
+import { C as ConfigValue, E as EvaluatedFlags } from './types-DMIusvFt.js';
+
+declare function FlagsProvider({ client, children }: {
+    client: BrowserFlags;
+    children?: ReactNode;
+}): react.FunctionComponentElement<react.ProviderProps<BrowserFlags | null>>;
+/** One flag; `defaultValue` until Hosting answered, or for a flag the publishable key may not see. */
+declare function useFlag(key: string, defaultValue?: boolean): boolean;
+/** Every client-visible flag and value. */
+declare function useFlags(): EvaluatedFlags;
+/** One client-visible Edge Config value. */
+declare function useConfig<T extends ConfigValue = ConfigValue>(key: string, defaultValue?: T): T | undefined;
+
+export { FlagsProvider, useConfig, useFlag, useFlags };

package/dist/react.js

@@ -0,0 +1,34 @@
+import "./chunk-TRTQSARU.js";
+
+// src/react.ts
+import { createContext, createElement, useContext, useSyncExternalStore } from "react";
+var FlagsContext = createContext(null);
+function FlagsProvider({ client, children }) {
+  return createElement(FlagsContext.Provider, { value: client }, children);
+}
+function useFlagsState() {
+  const client = useContext(FlagsContext);
+  if (!client) throw new Error("useFlag needs a <FlagsProvider client={\u2026}> above it");
+  return useSyncExternalStore(
+    (onChange) => client.subscribe(onChange),
+    () => client.snapshot(),
+    () => client.snapshot()
+  );
+}
+function useFlag(key, defaultValue = false) {
+  const state = useFlagsState();
+  return Object.prototype.hasOwnProperty.call(state.flags, key) ? state.flags[key] : defaultValue;
+}
+function useFlags() {
+  return useFlagsState();
+}
+function useConfig(key, defaultValue) {
+  const state = useFlagsState();
+  return Object.prototype.hasOwnProperty.call(state.items, key) ? state.items[key] : defaultValue;
+}
+export {
+  FlagsProvider,
+  useConfig,
+  useFlag,
+  useFlags
+};

package/dist/types-DMIusvFt.d.cts

@@ -0,0 +1,86 @@
+/** Common base of the SDK-specific errors. Existing error names and constructors remain supported. */
+declare class InfarisError extends Error {
+    static [Symbol.hasInstance](value: unknown): boolean;
+    readonly code: string;
+    readonly status: number | null | undefined;
+    constructor(message: string, code?: string, status?: number | null | undefined);
+}
+
+/**
+ * Evaluatie van een feature flag, zonder afhankelijkheden: dezelfde code draait in de hosting-api (beheer-API en de
+ * publieke sleutel) en in `@infaris/flags` (`packages/infaris-flags/src/evaluate.ts` is een kopie; de test daar
+ * vergelijkt beide bestanden, zodat een gebruiker op de server en in de browser in dezelfde groep valt).
+ *
+ * Volgorde: kill-switch → omgeving uit → regels (de eerste die past wint) → uitrol. De uitrol is vast per gebruiker:
+ * `fnv1a32("<flag>:<userId>") % 10000` tegen `percentage × 100`. Wie bij 10% meedoet, doet bij 25% nog steeds mee.
+ */
+type EvalEnvironment = 'production' | 'preview' | 'development';
+type EvalAttribute = 'userId' | 'email' | 'emailDomain' | 'org' | 'role';
+type EvalReason = 'killed' | 'off' | 'rule' | 'rollout' | 'fallthrough' | 'no_user';
+interface EvalRule {
+    attribute: EvalAttribute;
+    operator: 'in' | 'not_in' | 'ends_with';
+    values: readonly string[];
+    serve: boolean;
+}
+interface EvalFlag {
+    key: string;
+    killed: boolean;
+    environments: Partial<Record<EvalEnvironment, {
+        enabled: boolean;
+        rollout: number | null;
+        rules: readonly EvalRule[];
+    }>>;
+}
+interface EvalContext {
+    userId?: string;
+    email?: string;
+    org?: string;
+    role?: string;
+}
+/** FNV-1a (32 bit) over de UTF-8-bytes. Snel, synchroon en overal gelijk (ook in edge-runtimes zonder `node:crypto`). */
+declare function fnv1a32(input: string): number;
+/** De groep (0 tot 9999) van een gebruiker voor een flag. */
+declare function rolloutBucket(flagKey: string, userId: string): number;
+/** Een ontbrekend kenmerk past bij geen enkele regel, ook niet bij `not_in`. */
+declare function ruleMatches(rule: EvalRule, ctx: EvalContext): boolean;
+declare function evaluateFlag(flag: EvalFlag, environment: EvalEnvironment, ctx: EvalContext): {
+    value: boolean;
+    reason: EvalReason;
+};
+
+type FlagEnvironment = EvalEnvironment;
+type FlagReason = EvalReason;
+/** Who is looking. On the server free to fill in; in the browser targeting comes from the Infaris Auth token only. */
+type FlagContext = EvalContext;
+/** `fetch` as far as this package uses it (also fits Bun's and Node's). */
+type FetchLike = (input: string, init?: RequestInit) => Promise<Response>;
+type ConfigValue = string | number | boolean | null | ConfigValue[] | {
+    [key: string]: ConfigValue;
+};
+interface FlagDefinition extends EvalFlag {
+    description: string;
+    clientVisible: boolean;
+}
+/** What the secret key gets from `GET /flags/v1/<ref>/snapshot`. */
+interface FlagsSnapshot {
+    ref: string;
+    version: number;
+    flags: FlagDefinition[];
+    items: Record<string, ConfigValue>;
+}
+/** What `POST /flags/v1/<ref>/evaluate` returns: only client-visible flags and values for a publishable key. */
+interface EvaluatedFlags {
+    version: number;
+    flags: Record<string, boolean>;
+    items: Record<string, ConfigValue>;
+}
+declare class FlagsError extends InfarisError {
+    readonly status: number | null;
+    readonly code: string;
+    constructor(message: string, status: number | null, code: string);
+}
+/** Environment of this process: `INFARIS_ENV`, then `VERCEL_ENV`, then `NODE_ENV` (`production` stays production). */
+declare function detectEnvironment(env?: Record<string, string | undefined> | undefined): FlagEnvironment;
+
+export { type ConfigValue as C, type EvaluatedFlags as E, type FlagContext as F, InfarisError as I, type FlagEnvironment as a, type FetchLike as b, type FlagReason as c, type FlagDefinition as d, FlagsError as e, type FlagsSnapshot as f, detectEnvironment as g, evaluateFlag as h, fnv1a32 as i, ruleMatches as j, rolloutBucket as r };

package/dist/types-DMIusvFt.d.ts

@@ -0,0 +1,86 @@
+/** Common base of the SDK-specific errors. Existing error names and constructors remain supported. */
+declare class InfarisError extends Error {
+    static [Symbol.hasInstance](value: unknown): boolean;
+    readonly code: string;
+    readonly status: number | null | undefined;
+    constructor(message: string, code?: string, status?: number | null | undefined);
+}
+
+/**
+ * Evaluatie van een feature flag, zonder afhankelijkheden: dezelfde code draait in de hosting-api (beheer-API en de
+ * publieke sleutel) en in `@infaris/flags` (`packages/infaris-flags/src/evaluate.ts` is een kopie; de test daar
+ * vergelijkt beide bestanden, zodat een gebruiker op de server en in de browser in dezelfde groep valt).
+ *
+ * Volgorde: kill-switch → omgeving uit → regels (de eerste die past wint) → uitrol. De uitrol is vast per gebruiker:
+ * `fnv1a32("<flag>:<userId>") % 10000` tegen `percentage × 100`. Wie bij 10% meedoet, doet bij 25% nog steeds mee.
+ */
+type EvalEnvironment = 'production' | 'preview' | 'development';
+type EvalAttribute = 'userId' | 'email' | 'emailDomain' | 'org' | 'role';
+type EvalReason = 'killed' | 'off' | 'rule' | 'rollout' | 'fallthrough' | 'no_user';
+interface EvalRule {
+    attribute: EvalAttribute;
+    operator: 'in' | 'not_in' | 'ends_with';
+    values: readonly string[];
+    serve: boolean;
+}
+interface EvalFlag {
+    key: string;
+    killed: boolean;
+    environments: Partial<Record<EvalEnvironment, {
+        enabled: boolean;
+        rollout: number | null;
+        rules: readonly EvalRule[];
+    }>>;
+}
+interface EvalContext {
+    userId?: string;
+    email?: string;
+    org?: string;
+    role?: string;
+}
+/** FNV-1a (32 bit) over de UTF-8-bytes. Snel, synchroon en overal gelijk (ook in edge-runtimes zonder `node:crypto`). */
+declare function fnv1a32(input: string): number;
+/** De groep (0 tot 9999) van een gebruiker voor een flag. */
+declare function rolloutBucket(flagKey: string, userId: string): number;
+/** Een ontbrekend kenmerk past bij geen enkele regel, ook niet bij `not_in`. */
+declare function ruleMatches(rule: EvalRule, ctx: EvalContext): boolean;
+declare function evaluateFlag(flag: EvalFlag, environment: EvalEnvironment, ctx: EvalContext): {
+    value: boolean;
+    reason: EvalReason;
+};
+
+type FlagEnvironment = EvalEnvironment;
+type FlagReason = EvalReason;
+/** Who is looking. On the server free to fill in; in the browser targeting comes from the Infaris Auth token only. */
+type FlagContext = EvalContext;
+/** `fetch` as far as this package uses it (also fits Bun's and Node's). */
+type FetchLike = (input: string, init?: RequestInit) => Promise<Response>;
+type ConfigValue = string | number | boolean | null | ConfigValue[] | {
+    [key: string]: ConfigValue;
+};
+interface FlagDefinition extends EvalFlag {
+    description: string;
+    clientVisible: boolean;
+}
+/** What the secret key gets from `GET /flags/v1/<ref>/snapshot`. */
+interface FlagsSnapshot {
+    ref: string;
+    version: number;
+    flags: FlagDefinition[];
+    items: Record<string, ConfigValue>;
+}
+/** What `POST /flags/v1/<ref>/evaluate` returns: only client-visible flags and values for a publishable key. */
+interface EvaluatedFlags {
+    version: number;
+    flags: Record<string, boolean>;
+    items: Record<string, ConfigValue>;
+}
+declare class FlagsError extends InfarisError {
+    readonly status: number | null;
+    readonly code: string;
+    constructor(message: string, status: number | null, code: string);
+}
+/** Environment of this process: `INFARIS_ENV`, then `VERCEL_ENV`, then `NODE_ENV` (`production` stays production). */
+declare function detectEnvironment(env?: Record<string, string | undefined> | undefined): FlagEnvironment;
+
+export { type ConfigValue as C, type EvaluatedFlags as E, type FlagContext as F, InfarisError as I, type FlagEnvironment as a, type FetchLike as b, type FlagReason as c, type FlagDefinition as d, FlagsError as e, type FlagsSnapshot as f, detectEnvironment as g, evaluateFlag as h, fnv1a32 as i, ruleMatches as j, rolloutBucket as r };

package/package.json

@@ -1,6 +1,105 @@
 {
   "name": "@infaris/flags",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Edge Config and feature flags for Hosting by Infaris: an in-memory client for servers and edge runtimes with push invalidation, a browser client, a React hook and an adapter for the Vercel flags SDK. Bundles the shared Infaris error contract.",
+  "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"
+      }
+    },
+    "./client": {
+      "import": {
+        "types": "./dist/client.d.ts",
+        "default": "./dist/client.js"
+      },
+      "require": {
+        "types": "./dist/client.d.cts",
+        "default": "./dist/client.cjs"
+      }
+    },
+    "./react": {
+      "import": {
+        "types": "./dist/react.d.ts",
+        "default": "./dist/react.js"
+      },
+      "require": {
+        "types": "./dist/react.d.cts",
+        "default": "./dist/react.cjs"
+      }
+    },
+    "./adapter": {
+      "import": {
+        "types": "./dist/adapter.d.ts",
+        "default": "./dist/adapter.js"
+      },
+      "require": {
+        "types": "./dist/adapter.d.cts",
+        "default": "./dist/adapter.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "bun run build",
+    "typecheck": "tsgo --noEmit",
+    "typecheck:legacy": "tsc --noEmit",
+    "test": "bun test src",
+    "lint": "echo \"(no lint configured for flags)\""
+  },
+  "devDependencies": {
+    "@happy-dom/global-registrator": "^21.0.4",
+    "@types/bun": "^1.3.14",
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0",
+    "typescript": "5.9.3",
+    "tsup": "^8.5.1",
+    "@infaris/hosting-sdk": "0.1.0"
+  },
+  "keywords": [
+    "infaris",
+    "feature-flags",
+    "edge-config",
+    "flags",
+    "rollout",
+    "react"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/InfarisHQ/monorepo.git",
+    "directory": "packages/infaris-flags"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  }
+}