@ic-reactor/react 3.12.4 → 3.13.0

package/src/ownedAuthentication.ts

@@ -0,0 +1,81 @@
+/**
+ * Which `AuthenticationManager`s a `createReactorProvider` value owns, for the
+ * provider to dispose when its tree unmounts. Not part of the public API.
+ *
+ * A value owns the managers built for it: those constructed while its factory
+ * ran, and those a `defineReactor` or `defineDisplayReactor` result in it
+ * builds later, on first use. A manager built elsewhere and handed in, such as
+ * an app-wide one every provider shares, belongs to whoever built it, and
+ * disposing it on each remount would stop its client following the session.
+ *
+ * A result's `authentication` is a getter that builds the manager on first
+ * read, and building one loads the optional `@icp-sdk/auth` peer in a browser.
+ * A provider that read it to release the manager would build one only to
+ * dispose it, for every reactor whose tree never signed in. Each result
+ * registers a reader here instead, which answers without building anything.
+ *
+ * Kept apart from `defineReactorShared.ts` so that the provider does not pull
+ * that module's reactor setup into an app that builds its reactors by hand.
+ */
+import type { AuthenticationManager } from "./auth/authentication-manager.js"
+
+const readers = new WeakMap<object, () => AuthenticationManager | undefined>()
+
+/** The managers constructed during a running {@link collectAuthentication}. */
+let collecting: Set<AuthenticationManager> | undefined
+
+/**
+ * Records how to read the manager `owner` built, once it has built one.
+ *
+ * @internal
+ */
+export function registerAuthentication(
+  owner: object,
+  read: () => AuthenticationManager | undefined
+): void {
+  readers.set(owner, read)
+}
+
+/**
+ * The manager a registered result built, or `undefined` for one that has not
+ * built one yet, for one that was handed a manager, and for anything that was
+ * never registered.
+ *
+ * @internal
+ */
+export function authenticationOf(
+  owner: object
+): AuthenticationManager | undefined {
+  return readers.get(owner)?.()
+}
+
+/**
+ * Called by each `AuthenticationManager` as it is constructed.
+ *
+ * @internal
+ */
+export function recordAuthentication(manager: AuthenticationManager): void {
+  collecting?.add(manager)
+}
+
+/**
+ * Runs `build` and returns what it returned, with every manager constructed
+ * while it ran. `build` runs synchronously, so a server rendering several
+ * requests at once cannot interleave another request's managers.
+ *
+ * @internal
+ */
+export function collectAuthentication<T>(build: () => T): {
+  value: T
+  built: AuthenticationManager[]
+} {
+  const outer = collecting
+  const built = new Set<AuthenticationManager>()
+  collecting = built
+  try {
+    const value = build()
+    return { value, built: [...built] }
+  } finally {
+    collecting = outer
+  }
+}

package/src/server.ts

@@ -0,0 +1,23 @@
+/**
+ * The `react-server` entry of `@ic-reactor/react`.
+ *
+ * React Server Components are bundled with the `react-server` export
+ * condition, and `package.json` routes that condition here instead of to
+ * `index.ts`. The main entry also loads every hook, and a bundler rejects a
+ * hook import anywhere in the server graph, so a server component that
+ * imported only `Reactor` from it failed to build.
+ *
+ * This entry carries the core runtime (`Reactor`, `DisplayReactor`,
+ * `ClientManager`, the error classes and utilities) and the framework-free
+ * validation helpers, and nothing that imports React. A hook or a hook factory
+ * imported in a server component is therefore a missing export at build time,
+ * which is the error to get: those only run in a `"use client"` module.
+ *
+ * TypeScript does not read the `react-server` condition, so types still come
+ * from the main entry.
+ */
+export * from "@ic-reactor/core"
+
+// Plain functions over `ValidationError`, useful in a server action that maps
+// a rejected call onto form field errors.
+export * from "./validation.js"

package/src/testing.ts

@@ -0,0 +1,18 @@
+/**
+ * `@ic-reactor/react/testing`: the testing utilities of
+ * `@ic-reactor/core/testing`, re-exported for an app that depends on
+ * `@ic-reactor/react` alone. The main entry re-exports `@ic-reactor/core` the
+ * same way, but a package manager that installs strictly does not let such an
+ * app import `@ic-reactor/core/testing` itself.
+ *
+ * Nothing here imports React, and neither the main entry nor the
+ * `react-server` entry imports this one, so none of it reaches an app bundle.
+ *
+ * @example
+ * ```typescript
+ * import { createTestCanister, installFakeReplica } from "@ic-reactor/react/testing"
+ * ```
+ *
+ * @packageDocumentation
+ */
+export * from "@ic-reactor/core/testing"