@flagdown/react 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kieran Bond
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# @flagdown/react
+
+React bindings for [Flagdown](https://github.com/flagdown/flagdown) feature
+flags.
+
+## Installation
+
+```bash
+npm install @flagdown/react
+```
+
+## Current bootstrap API
+
+Wrap the part of the React tree that reads flags in `FlagdownProvider`, then
+read a flag with `useFlag`:
+
+```tsx
+import { FlagdownProvider, useFlag } from "@flagdown/react";
+
+function BetaFeature() {
+  return useFlag("beta-feature") ? <p>Enabled</p> : null;
+}
+
+export function App() {
+  return (
+    <FlagdownProvider>
+      <BetaFeature />
+    </FlagdownProvider>
+  );
+}
+```
+
+This initial provider returns `false` for every flag. A future release will
+provide an adapter generated from Flagdown's OpenAPI contract.
+
+For tests or custom adapters, supply a `FlagEvaluator` implementation:
+
+```tsx
+<FlagdownProvider evaluator={{ isEnabled: (key) => key === "beta-feature" }}>
+  <BetaFeature />
+</FlagdownProvider>
+```

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import * as react from 'react';
+import { PropsWithChildren } from 'react';
+
+/** A port for resolving a feature flag's enabled state. */
+interface FlagEvaluator {
+    isEnabled(flagKey: string): boolean;
+}
+/**
+ * Temporary adapter used until the SDK is connected to the Flagdown API.
+ *
+ * It deliberately keeps every flag disabled so applications can install the
+ * provider and hook safely before remote evaluation is available.
+ */
+declare const disabledFlagEvaluator: FlagEvaluator;
+
+interface FlagdownProviderProps extends PropsWithChildren {
+    /**
+     * Optional evaluation port. This enables a future Flagdown API adapter and
+     * keeps consumers independent from the transport that supplies flag values.
+     */
+    evaluator?: FlagEvaluator;
+}
+declare function FlagdownProvider({ children, evaluator, }: FlagdownProviderProps): react.JSX.Element;
+
+declare function useFlag(flagKey: string): boolean;
+
+export { type FlagEvaluator, FlagdownProvider, type FlagdownProviderProps, disabledFlagEvaluator, useFlag };

package/dist/index.js

@@ -0,0 +1,29 @@
+// src/FlagdownContext.tsx
+import { createContext, useContext } from "react";
+var FlagdownContext = createContext(void 0);
+function useFlag(flagKey) {
+  const evaluator = useContext(FlagdownContext);
+  if (!evaluator) {
+    throw new Error("useFlag must be used within a FlagdownProvider");
+  }
+  return evaluator.isEnabled(flagKey);
+}
+
+// src/flags.ts
+var disabledFlagEvaluator = {
+  isEnabled: () => false
+};
+
+// src/FlagdownProvider.tsx
+import { jsx } from "react/jsx-runtime";
+function FlagdownProvider({
+  children,
+  evaluator = disabledFlagEvaluator
+}) {
+  return /* @__PURE__ */ jsx(FlagdownContext.Provider, { value: evaluator, children });
+}
+export {
+  FlagdownProvider,
+  disabledFlagEvaluator,
+  useFlag
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@flagdown/react",
+  "version": "0.0.1",
+  "license": "MIT",
+  "type": "module",
+  "description": "React SDK for evaluating Flagdown feature flags.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flagdown/flagdown.git",
+    "directory": "packages/sdk"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": ["dist", "README.md", "LICENSE"],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "devDependencies": {
+    "@types/react": "^18",
+    "react": "^18",
+    "react-dom": "^18",
+    "tsup": "^8",
+    "typescript": "^5"
+  }
+}