@lunora/flags 0.0.1 → 1.0.0-alpha.10

package/LICENSE.md

@@ -0,0 +1,111 @@
+# Functional Source License, Version 1.1, Apache 2.0 Future License
+
+## Abbreviation
+
+FSL-1.1-Apache-2.0
+
+## Notice
+
+Copyright 2026 anolilab and contributors
+
+## Terms and Conditions
+
+### Licensor ("We")
+
+The party offering the Software under these Terms and Conditions.
+
+### The Software
+
+The "Software" is each version of the software that we make available under
+these Terms and Conditions, as indicated by our inclusion of these Terms and
+Conditions with the Software.
+
+### License Grant
+
+Subject to your compliance with this License Grant and the Patents,
+Redistribution and Trademark clauses below, we hereby grant you the right to
+use, copy, modify, create derivative works, publicly perform, publicly display
+and redistribute the Software for any Permitted Purpose identified below.
+
+### Permitted Purpose
+
+A Permitted Purpose is any purpose other than a Competing Use. A Competing Use
+means making the Software available to others in a commercial product or service
+that:
+
+1. substitutes for the Software;
+
+2. substitutes for any other product or service we offer using the Software that
+   exists as of the date we make the Software available; or
+
+3. offers the same or substantially similar functionality as the Software.
+
+Permitted Purposes specifically include using the Software:
+
+1. for your internal use and access;
+
+2. for non-commercial education;
+
+3. for non-commercial research; and
+
+4. in connection with professional services that you provide to a licensee using
+   the Software in accordance with these Terms and Conditions.
+
+### Patents
+
+To the extent your use for a Permitted Purpose would necessarily infringe our
+patents, the license grant above includes a license under our patents. If you
+make a claim against any party that the Software infringes or contributes to the
+infringement of any patent, then your patent license to the Software ends
+immediately.
+
+### Redistribution
+
+The Terms and Conditions apply to all copies, modifications and derivatives of
+the Software.
+
+If you redistribute any copies, modifications or derivatives of the Software,
+you must include a copy of or a link to these Terms and Conditions and not
+remove any copyright notices provided in or with the Software.
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTIES OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF FITNESS FOR A PARTICULAR
+PURPOSE, MERCHANTABILITY, TITLE OR NON-INFRINGEMENT.
+
+IN NO EVENT WILL WE HAVE ANY LIABILITY TO YOU ARISING OUT OF OR RELATED TO THE
+SOFTWARE, INCLUDING INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES, EVEN
+IF WE HAVE BEEN INFORMED OF THEIR POSSIBILITY IN ADVANCE.
+
+### Trademarks
+
+Except for displaying the License Details and identifying us as the origin of
+the Software, you have no right under these Terms and Conditions to use our
+trademarks, trade names, service marks or product names.
+
+## Grant of Future License
+
+We hereby irrevocably grant you an additional license to use the Software under
+the Apache License, Version 2.0 that is effective on the second anniversary of
+the date we make the Software available. On or after that date, you may use the
+Software under the Apache License, Version 2.0, in which case the following will
+apply:
+
+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.
+
+<!-- DEPENDENCIES -->
+<!-- /DEPENDENCIES -->
+
+<!-- TYPE_DEPENDENCIES -->
+<!-- /TYPE_DEPENDENCIES -->

package/README.md

@@ -1,45 +1,97 @@
 # @lunora/flags
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+<!-- START_PACKAGE_OG_IMAGE_PLACEHOLDER -->
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+<a href="https://www.anolilab.com/open-source" align="center">
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+  <img src="__assets__/package-og.svg" alt="flags" />
 
-## Purpose
+</a>
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@lunora/flags`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+<h3 align="center">OpenFeature-based feature flags for Lunora — ctx.flags, useFlag, and a first-class Cloudflare Flagship provider with any OpenFeature provider pluggable</h3>
 
-## What is OIDC Trusted Publishing?
+<!-- END_PACKAGE_OG_IMAGE_PLACEHOLDER -->
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+OpenFeature-based feature flags for [Lunora](https://lunora.sh). Configure one
+OpenFeature provider in `lunora/flags.ts` and Lunora wires `ctx.flags` onto every
+handler — Cloudflare [Flagship](https://github.com/cloudflare/flagship) is the
+first-class default, but any OpenFeature provider plugs in unchanged.
 
-## Setup Instructions
+## Install
 
-To properly configure OIDC trusted publishing for this package:
+```bash
+pnpm add @lunora/flags @openfeature/server-sdk
+# Flagship provider (default):
+pnpm add @cloudflare/flagship
+```
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+## Configure
 
-## DO NOT USE THIS PACKAGE
+```ts
+// lunora/flags.ts
+import { defineFlags } from "@lunora/flags";
+import { flagshipProvider } from "@lunora/flags/providers/flagship";
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+export default defineFlags({
+    provider: flagshipProvider({ binding: "FLAGS" }), // Workers binding mode — no HTTP, no token
+    identify: (auth) => auth.userId ?? undefined, // default targetingKey
+});
+```
 
-## More Information
+Binding mode reads `env.FLAGS`; configure it in `wrangler.jsonc`:
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+```jsonc
+{ "flagship": [{ "binding": "FLAGS", "app_id": "<your-app-id>" }] }
+```
 
----
+HTTP mode (non-binding environments): `flagshipProvider({ appId, accountId, authToken })`.
 
-**Maintained for OIDC setup purposes only**
+Any OpenFeature provider works in place of Flagship:
+
+```ts
+export default defineFlags({ provider: (env) => new SomeOpenFeatureProvider(env.SOME_KEY) });
+```
+
+Two zero-dependency providers ship in the box for tests, local defaults, and
+binding-driven flags:
+
+```ts
+import { memoryProvider } from "@lunora/flags/providers/memory";
+import { envProvider } from "@lunora/flags/providers/env";
+
+// Static key → value map (booleans, strings, numbers, JSON objects):
+export default defineFlags({ provider: memoryProvider({ "dark-mode": true, "page-size": 25 }) });
+
+// Read from the Worker env — `dark-mode` → `env.FLAG_DARK_MODE` (override with `prefix` / `name`):
+export default defineFlags({ provider: envProvider() });
+```
+
+## Evaluate
+
+```ts
+export const listPosts = query(async (ctx) => {
+    if (await ctx.flags.boolean("new-ranking", false)) {
+        /* ... */
+    }
+    const hero = await ctx.flags.string("homepage-hero", "control", { plan: "premium" });
+    const details = await ctx.flags.details.boolean("new-ranking", false); // value + reason + variant
+});
+```
+
+`ctx.flags` never throws: a missing flag, type mismatch, or provider error resolves
+with the `defaultValue`. The default `targetingKey` (from `identify`) is merged under
+any per-call context, and identical evaluations within one request are memoized.
+
+## Exports
+
+| Export                             | Contents                                        | Peer dependency                                |
+| ---------------------------------- | ----------------------------------------------- | ---------------------------------------------- |
+| `@lunora/flags`                    | `defineFlags`, `createFlags`, types             | `@openfeature/server-sdk`                      |
+| `@lunora/flags/providers/flagship` | `flagshipProvider` (Cloudflare Flagship)        | `@cloudflare/flagship`                         |
+| `@lunora/flags/providers/memory`   | `memoryProvider` (static `key → value` map)     | — (zero extra deps)                            |
+| `@lunora/flags/providers/env`      | `envProvider` (reads flags from the Worker env) | — (zero extra deps)                            |
+| `@lunora/flags/web`                | `FlagshipClientProvider` (browser escape hatch) | `@openfeature/web-sdk`, `@cloudflare/flagship` |
+
+## License
+
+[FSL-1.1-Apache-2.0](./LICENSE.md)