@toggld/react 0.0.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -0,0 +1,52 @@
+# @toggld/react
+
+React bindings for [`@toggld/browser`](../browser): a provider and hooks built on
+`useSyncExternalStore`. React 18 and 19. No dependencies beyond its peers
+(`react`, `@toggld/browser`).
+
+## Install
+
+```bash
+pnpm add @toggld/react @toggld/browser
+```
+
+## Use
+
+```tsx
+import { ToggldClient } from "@toggld/browser"
+import { ToggldProvider, useFlag } from "@toggld/react"
+
+const flags = new ToggldClient({ publicToken: "ffp_…", context: { targetingKey: userId } })
+
+export function App() {
+  return (
+    <ToggldProvider client={flags}>
+      <Checkout />
+    </ToggldProvider>
+  )
+}
+
+function Checkout() {
+  const newCheckout = useFlag("new-checkout", false) // type follows the default
+  return newCheckout ? <NewCheckout /> : <OldCheckout />
+}
+```
+
+| Hook | Returns |
+| --- | --- |
+| `useFlag(key, default)` | The value (default on any error) |
+| `useFlagDetails(key, default)` | Full evaluation details |
+| `useToggldStatus()` | `"loading" \| "ready" \| "reconciling" \| "error"` |
+| `useToggldSnapshot()` | The full client state (re-renders on every change) |
+| `useToggldClient()` | The client, e.g. for `setContext` |
+
+A component re-renders only when **its** flag's result changes.
+
+## Server-side rendering
+
+Create the client in the root component with `useState(() => new ToggldClient({
+…, bootstrap }))`, where `bootstrap` is `@toggld/js`'s `evaluateAll(context)`
+from the server. Server output and hydration match, and the browser sends no
+first request.
+
+Docs: [docs.toggld.io/sdks/react](https://docs.toggld.io/sdks/react).

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+import { ReactNode } from "react";
+import { ClientSnapshot, ClientSnapshot as ClientSnapshot$1, ClientStatus, ClientStatus as ClientStatus$1, ErrorCode, EvaluationContext, EvaluationDetails, EvaluationDetails as EvaluationDetails$1, FlagMetadata, FlagValue, FlagValue as FlagValue$1, Reason, ToggldClient, ToggldClient as ToggldClient$1, ToggldClientOptions } from "@toggld/browser";
+export interface ToggldProviderProps {
+  /**
+   * The client the hooks below read. Create it once, outside render (module
+   * scope, or `useState(() => new ToggldClient(…))` for server rendering). The
+   * provider does not close it.
+   */
+  readonly client: ToggldClient$1;
+  readonly children?: ReactNode;
+}
+/** Makes a {@link ToggldClient} available to the hooks in its subtree. */
+export declare function ToggldProvider({ client, children }: ToggldProviderProps): import("react").FunctionComponentElement<import("react").ProviderProps<ToggldClient$1 | null>>;
+/** The client from the nearest {@link ToggldProvider}, e.g. to call `setContext`. */
+export declare function useToggldClient(): ToggldClient$1;
+/**
+ * The client's full state. Re-renders on **every** change; prefer
+ * {@link useFlag} or {@link useToggldStatus} where they suffice.
+ */
+export declare function useToggldSnapshot(): ClientSnapshot$1;
+/** The client's {@link ClientStatus}. Re-renders only when the status changes. */
+export declare function useToggldStatus(): ClientStatus$1;
+/**
+ * Full evaluation details for one flag. The flag type follows the default
+ * value: `false` reads a boolean flag, `""` a string flag, `0` a number flag,
+ * and an object or array an object flag. A wrong type returns the default with
+ * `TYPE_MISMATCH`. Never throws.
+ */
+export declare function useFlagDetails(key: string, defaultValue: boolean): EvaluationDetails$1<boolean>;
+export declare function useFlagDetails(key: string, defaultValue: string): EvaluationDetails$1<string>;
+export declare function useFlagDetails(key: string, defaultValue: number): EvaluationDetails$1<number>;
+export declare function useFlagDetails<T extends FlagValue$1>(key: string, defaultValue: T): EvaluationDetails$1<T>;
+/**
+ * One flag's value, or the default on any error. The type follows the default
+ * value; see {@link useFlagDetails}.
+ *
+ * ```tsx
+ * const theme = useFlag("theme", "light") // string
+ * const limits = useFlag("limits", { seats: 1 }) // object
+ * ```
+ */
+export declare function useFlag(key: string, defaultValue: boolean): boolean;
+export declare function useFlag(key: string, defaultValue: string): string;
+export declare function useFlag(key: string, defaultValue: number): number;
+export declare function useFlag<T extends FlagValue$1>(key: string, defaultValue: T): T;
+export type { ClientSnapshot, ClientStatus, ErrorCode, EvaluationContext, EvaluationDetails, FlagMetadata, FlagValue, Reason, ToggldClient, ToggldClientOptions };

package/dist/index.js

@@ -0,0 +1,107 @@
+import { createContext, createElement, useContext, useEffect, useRef, useSyncExternalStore } from "react";
+import { ToggldClient } from "@toggld/browser";
+// src/index.ts
+/**
+* `@toggld/react` — React bindings for `@toggld/browser`.
+*
+* ```tsx
+* import { ToggldClient } from "@toggld/browser"
+* import { ToggldProvider, useFlag } from "@toggld/react"
+*
+* // Once per page, outside any component.
+* const client = new ToggldClient({ publicToken: "ffp_…", context: { targetingKey: userId } })
+*
+* export function App() {
+*   return (
+*     <ToggldProvider client={client}>
+*       <Checkout />
+*     </ToggldProvider>
+*   )
+* }
+*
+* function Checkout() {
+*   const newCheckout = useFlag("new-checkout", false)
+*   return newCheckout ? <NewCheckout /> : <OldCheckout />
+* }
+* ```
+*
+* The hooks read from the client's memory, so they never fetch. A component
+* re-renders only when **its** flag's result changes: the client keeps results
+* that did not change by identity, and the hooks compare by identity. Built on
+* `useSyncExternalStore`, so server rendering and hydration work when the
+* client is created with a `bootstrap`.
+*
+* For Analytics, a hook counts one read when its component mounts with a
+* value, and one more each time its result changes, not one per render.
+*/
+const ClientContext = createContext(null);
+ClientContext.displayName = "ToggldClient";
+/** Makes a {@link ToggldClient} available to the hooks in its subtree. */
+function ToggldProvider({ client, children }) {
+	return createElement(ClientContext.Provider, { value: client }, children);
+}
+/** The client from the nearest {@link ToggldProvider}, e.g. to call `setContext`. */
+function useToggldClient() {
+	const client = useContext(ClientContext);
+	if (client === null) throw new Error("[toggld] useToggldClient and the flag hooks must be used inside a <ToggldProvider>.");
+	return client;
+}
+/**
+* The client's full state. Re-renders on **every** change; prefer
+* {@link useFlag} or {@link useToggldStatus} where they suffice.
+*/
+function useToggldSnapshot() {
+	const client = useToggldClient();
+	return useSyncExternalStore(client.subscribe, client.getSnapshot, client.getSnapshot);
+}
+/** The client's {@link ClientStatus}. Re-renders only when the status changes. */
+function useToggldStatus() {
+	const client = useToggldClient();
+	const getStatus = () => client.getSnapshot().status;
+	return useSyncExternalStore(client.subscribe, getStatus, getStatus);
+}
+const INTERNAL = Symbol.for("toggld.browser.internal");
+const internalOf = (client) => client[INTERNAL];
+/** Evaluate with the getter that matches the default value's type. */
+const evaluateTyped = (client, key, defaultValue) => {
+	switch (typeof defaultValue) {
+		case "boolean": return client.getBooleanDetails(key, defaultValue);
+		case "string": return client.getStringDetails(key, defaultValue);
+		case "number": return client.getNumberDetails(key, defaultValue);
+		default: return client.getObjectDetails(key, defaultValue);
+	}
+};
+const sameMetadata = (a, b) => {
+	if (a === b) return true;
+	const keys = Object.keys(a);
+	return keys.length === Object.keys(b).length && keys.every((k) => Object.is(a[k], b[k]));
+};
+/**
+* Whether two results are the same for a reader. Successful results are the
+* client's own (identity-stable) objects; error results are built per read, so
+* they are compared field by field.
+*/
+const sameDetails = (a, b) => a === b || a.flagKey === b.flagKey && Object.is(a.value, b.value) && a.variant === b.variant && a.reason === b.reason && a.errorCode === b.errorCode && a.errorMessage === b.errorMessage && sameMetadata(a.flagMetadata, b.flagMetadata);
+function useFlagDetails(key, defaultValue) {
+	const client = useToggldClient();
+	const internal = internalOf(client);
+	const cache = useRef(null);
+	const counted = useRef(null);
+	const get = () => {
+		const details = internal?.peek(key, defaultValue) ?? evaluateTyped(client, key, defaultValue);
+		if (cache.current !== null && sameDetails(cache.current, details)) return cache.current;
+		cache.current = details;
+		return details;
+	};
+	const details = useSyncExternalStore(client.subscribe, get, get);
+	useEffect(() => {
+		if (counted.current === details) return;
+		counted.current = details;
+		internal?.record(details);
+	}, [details, internal]);
+	return details;
+}
+function useFlag(key, defaultValue) {
+	return useFlagDetails(key, defaultValue).value;
+}
+export { ToggldClient, ToggldProvider, useFlag, useFlagDetails, useToggldClient, useToggldSnapshot, useToggldStatus };

package/package.json

@@ -1,6 +1,57 @@
 {
   "name": "@toggld/react",
-  "version": "0.0.0",
-  "description": "Placeholder that reserves the package name. The first real release is 0.1.0.",
-  "license": "Apache-2.0"
-}
+  "version": "0.2.0",
+  "description": "React bindings for the Toggld browser SDK — a provider and hooks that re-render only when a flag's value changes. Server-rendering friendly.",
+  "license": "Apache-2.0",
+  "homepage": "https://toggld.io",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/toggld/toggld.git",
+    "directory": "packages/react"
+  },
+  "bugs": {
+    "url": "https://github.com/toggld/toggld/issues"
+  },
+  "keywords": [
+    "feature-flags",
+    "openfeature",
+    "toggld",
+    "react",
+    "hooks"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "@toggld/browser": "^0.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.3.0",
+    "@types/react-dom": "^19.3.0",
+    "happy-dom": "^21.0.4",
+    "react": "^19.3.1",
+    "react-dom": "^19.3.1",
+    "tsdown": "^0.23.2",
+    "typescript": "6.0.3",
+    "@toggld/browser": "0.2.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}