@lunora/flags 0.0.1 → 1.0.0-alpha.2

package/dist/providers/flagship.d.ts

@@ -0,0 +1,62 @@
+import { F as FlagsProviderFactory } from "../packem_shared/types.d-BWygZiSc.js";
+import '@openfeature/server-sdk';
+/**
+* Flagship provider in **binding mode** (recommended for Workers): evaluations
+* go through the wrangler binding — no HTTP, no auth token.
+*/
+interface FlagshipBindingOptions {
+  /**
+  * The name of the Flagship binding on the Worker `env` (e.g. `"FLAGS"`). The
+  * factory resolves `env[binding]` at request time. Configure a matching
+  * `flagship` binding in `wrangler.jsonc` with this binding name and your app id.
+  */
+  binding: string;
+  /** Max cached entries when `cacheTtl` is set (default 1000). */
+  cacheMaxSize?: number;
+  /** Opt-in per-context TTL cache, in ms. Enables caching when greater than 0. */
+  cacheTtl?: number;
+  /** Surface Flagship SDK logs (default false). */
+  logging?: boolean;
+}
+/**
+* Flagship provider in **HTTP mode** (non-binding Workers or other server
+* runtimes): evaluations go to the Flagship API over HTTP.
+*/
+interface FlagshipHttpOptions {
+  /** Account id for multi-tenant routing (required with `appId`). */
+  accountId?: string;
+  /** Flagship app id; the SDK builds the evaluation URL (mutually exclusive with `endpoint`). */
+  appId?: string;
+  /** Bearer token added as an `Authorization: Bearer` header to every request. */
+  authToken?: string;
+  /** Base URL override (only used with `appId`). */
+  baseUrl?: string;
+  cacheMaxSize?: number;
+  cacheTtl?: number;
+  /** Full evaluation URL (mutually exclusive with `appId`). */
+  endpoint?: string;
+  logging?: boolean;
+  /** Retry attempts on transient errors (default 1, max 10). */
+  retries?: number;
+  /** Delay between retries in ms (default 1000, max 30000). */
+  retryDelay?: number;
+  /** Request timeout in ms (default 5000). */
+  timeout?: number;
+}
+/** Options for `flagshipProvider` — binding mode or HTTP mode. */
+type FlagshipProviderOptions = FlagshipBindingOptions | FlagshipHttpOptions;
+/**
+* Builds a Cloudflare Flagship OpenFeature provider for `defineFlags({ provider })`.
+* Flagship is Lunora's first-class default; the same `defineFlags` accepts any
+* OpenFeature provider, so apps can swap it out without touching call sites.
+*
+* ```ts
+* // Binding mode (recommended) — reads env.FLAGS at request time:
+* flagshipProvider({ binding: "FLAGS" })
+*
+* // HTTP mode:
+* flagshipProvider({ appId: "app-abc", accountId: "acct", authToken: "tok" })
+* ```
+*/
+declare const flagshipProvider: (options: FlagshipProviderOptions) => FlagsProviderFactory;
+export { type FlagshipBindingOptions, type FlagshipHttpOptions, type FlagshipProviderOptions, flagshipProvider };

package/dist/providers/flagship.mjs

@@ -0,0 +1,20 @@
+import { FlagshipServerProvider } from '@cloudflare/flagship/server';
+
+const isBindingOptions = (options) => "binding" in options && typeof options.binding === "string";
+const flagshipProvider = (options) => {
+  if (isBindingOptions(options)) {
+    const { binding: bindingName, ...rest } = options;
+    return (env) => {
+      const binding = env[bindingName];
+      if (binding === void 0 || binding === null) {
+        throw new Error(
+          `flagshipProvider: no binding "${bindingName}" found on env. Add a \`flagship\` binding to wrangler.jsonc, e.g. { "flagship": [{ "binding": "${bindingName}", "app_id": "your-app-id" }] }.`
+        );
+      }
+      return new FlagshipServerProvider({ binding, ...rest });
+    };
+  }
+  return () => new FlagshipServerProvider(options);
+};
+
+export { flagshipProvider };

package/dist/providers/memory.d.mts

@@ -0,0 +1,37 @@
+import { JsonValue } from '@openfeature/server-sdk';
+import { F as FlagsProviderFactory } from "../packem_shared/types.d-BWygZiSc.mjs";
+/**
+* The value a static memory flag can hold — any JSON value (OpenFeature boolean /
+* number / string / structured object). Alias of `JsonValue` for naming clarity.
+*/
+type MemoryFlagValue = JsonValue;
+/**
+* A static, in-memory OpenFeature provider for `defineFlags({ provider })`, built
+* on OpenFeature's own in-memory provider (no extra install). Pass a plain
+* `key → value` map; every read resolves the configured value (reason `STATIC`)
+* or, for an unknown key, the call's default.
+*
+* Ideal for tests, local development, and apps with a handful of static flags
+* checked into the repo — no external flag service, no binding.
+*
+* ```ts
+* import { defineFlags } from "@lunora/flags";
+* import { memoryProvider } from "@lunora/flags/providers/memory";
+*
+* export default defineFlags({
+*     provider: memoryProvider({
+*         "dark-mode": true,
+*         "page-size": 25,
+*         "homepage-hero": "control",
+*         "rollout": { percent: 10, regions: ["us", "eu"] },
+*     }),
+* });
+* ```
+*
+* Targeting (per-context variants) is out of scope for this static provider; for
+* that, wire a real provider (e.g. `flagshipProvider`) or construct a
+* `TypedInMemoryProvider` with `contextEvaluator`s directly via the `defineFlags`
+* escape hatch (`provider: () => new TypedInMemoryProvider(config)`).
+*/
+declare const memoryProvider: (flags: Record<string, MemoryFlagValue>) => FlagsProviderFactory;
+export { type MemoryFlagValue, memoryProvider };

package/dist/providers/memory.d.ts

@@ -0,0 +1,37 @@
+import { JsonValue } from '@openfeature/server-sdk';
+import { F as FlagsProviderFactory } from "../packem_shared/types.d-BWygZiSc.js";
+/**
+* The value a static memory flag can hold — any JSON value (OpenFeature boolean /
+* number / string / structured object). Alias of `JsonValue` for naming clarity.
+*/
+type MemoryFlagValue = JsonValue;
+/**
+* A static, in-memory OpenFeature provider for `defineFlags({ provider })`, built
+* on OpenFeature's own in-memory provider (no extra install). Pass a plain
+* `key → value` map; every read resolves the configured value (reason `STATIC`)
+* or, for an unknown key, the call's default.
+*
+* Ideal for tests, local development, and apps with a handful of static flags
+* checked into the repo — no external flag service, no binding.
+*
+* ```ts
+* import { defineFlags } from "@lunora/flags";
+* import { memoryProvider } from "@lunora/flags/providers/memory";
+*
+* export default defineFlags({
+*     provider: memoryProvider({
+*         "dark-mode": true,
+*         "page-size": 25,
+*         "homepage-hero": "control",
+*         "rollout": { percent: 10, regions: ["us", "eu"] },
+*     }),
+* });
+* ```
+*
+* Targeting (per-context variants) is out of scope for this static provider; for
+* that, wire a real provider (e.g. `flagshipProvider`) or construct a
+* `TypedInMemoryProvider` with `contextEvaluator`s directly via the `defineFlags`
+* escape hatch (`provider: () => new TypedInMemoryProvider(config)`).
+*/
+declare const memoryProvider: (flags: Record<string, MemoryFlagValue>) => FlagsProviderFactory;
+export { type MemoryFlagValue, memoryProvider };

package/dist/providers/memory.mjs

@@ -0,0 +1,16 @@
+import { TypedInMemoryProvider } from '@openfeature/server-sdk';
+
+const memoryProvider = (flags) => {
+  const configuration = {};
+  for (const [key, value] of Object.entries(flags)) {
+    configuration[key] = {
+      defaultVariant: "default",
+      disabled: false,
+      variants: { default: value }
+    };
+  }
+  const provider = new TypedInMemoryProvider(configuration);
+  return (_environment) => provider;
+};
+
+export { memoryProvider };

package/dist/web.d.mts

@@ -0,0 +1 @@
+export { FlagshipClientProvider, type FlagshipClientProviderOptions } from '@cloudflare/flagship/web';

package/dist/web.d.ts

@@ -0,0 +1 @@
+export { FlagshipClientProvider, type FlagshipClientProviderOptions } from '@cloudflare/flagship/web';

package/dist/web.mjs

@@ -0,0 +1 @@
+export { FlagshipClientProvider } from '@cloudflare/flagship/web';

package/package.json

@@ -1,10 +1,80 @@
 {
   "name": "@lunora/flags",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @lunora/flags",
+  "version": "1.0.0-alpha.2",
+  "description": "OpenFeature-based feature flags for Lunora — ctx.flags, useFlag, and a first-class Cloudflare Flagship provider with any OpenFeature provider pluggable",
   "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+    "cloudflare",
+    "feature-flags",
+    "flagship",
+    "lunora",
+    "openfeature",
+    "workers"
+  ],
+  "homepage": "https://lunora.sh",
+  "bugs": "https://github.com/anolilab/lunora/issues",
+  "license": "FSL-1.1-Apache-2.0",
+  "author": {
+    "name": "Daniel Bannert",
+    "email": "d.bannert@anolilab.de"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anolilab/lunora.git",
+    "directory": "packages/flags"
+  },
+  "files": [
+    "./dist",
+    "README.md",
+    "LICENSE.md",
+    "__assets__"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    },
+    "./providers/flagship": {
+      "types": "./dist/providers/flagship.d.ts",
+      "import": "./dist/providers/flagship.mjs"
+    },
+    "./providers/memory": {
+      "types": "./dist/providers/memory.d.ts",
+      "import": "./dist/providers/memory.mjs"
+    },
+    "./providers/env": {
+      "types": "./dist/providers/env.d.ts",
+      "import": "./dist/providers/env.mjs"
+    },
+    "./web": {
+      "types": "./dist/web.d.ts",
+      "import": "./dist/web.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@openfeature/server-sdk": "^1.20.2"
+  },
+  "peerDependencies": {
+    "@cloudflare/flagship": "^0.4.2",
+    "@openfeature/web-sdk": "^1.7.3"
+  },
+  "peerDependenciesMeta": {
+    "@cloudflare/flagship": {
+      "optional": true
+    },
+    "@openfeature/web-sdk": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": "^22.15.0 || >=24.11.0"
+  }
+}