@bgub/fig-reconciler 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Ben Gubler
+
+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,12 @@
+# @bgub/fig-reconciler
+
+Fig host-config reconciler.
+
+## Installation
+
+```bash
+pnpm add @bgub/fig-reconciler
+```
+
+Fig packages are ESM-only and require Node `^20.19.0 || >=22.12.0` for Node runtime entry
+points.

package/dist/devtools.d.ts

@@ -0,0 +1,69 @@
+import { DependencyList, ElementType, FigContext, Props } from "@bgub/fig";
+import { DataStoreEntrySnapshot } from "@bgub/fig/internal";
+//#region src/devtools.d.ts
+type FigDevtoolsFiberKind = "root" | "host" | "text" | "function" | "fragment" | "assets" | "context-provider" | "suspense" | "error-boundary" | "portal" | "activity" | "view-transition";
+type FigDevtoolsHookKind = "state" | "action-state" | "id" | "deferred-value" | "external-store" | "memo" | "transition" | "stable-event" | "reactive" | "before-paint" | "before-layout";
+type FigDevtoolsEffectPhase = "reactive" | "before-paint" | "before-layout";
+type FigDevtoolsWorkLabel = "sync" | "input" | "default" | "gesture" | "transition" | "retry" | "idle" | "offscreen" | "deferred" | "selective-hydration";
+interface FigDevtoolsHookSnapshot {
+  id: number;
+  kind: FigDevtoolsHookKind;
+  state?: unknown;
+  deps?: DependencyList | null;
+  phase?: FigDevtoolsEffectPhase;
+  active?: boolean;
+}
+interface FigDevtoolsFiberSnapshot {
+  id: number;
+  parentId: number | null;
+  name: string;
+  kind: FigDevtoolsFiberKind;
+  key: string | number | null;
+  index: number;
+  props: Props;
+  pendingWork: FigDevtoolsWorkLabel[];
+  childWork: FigDevtoolsWorkLabel[];
+  hooks: FigDevtoolsHookSnapshot[];
+  contextDependencies: string[];
+  host?: FigDevtoolsHostSnapshot;
+  capturedError?: unknown;
+  componentStack?: string;
+  children: FigDevtoolsFiberSnapshot[];
+}
+interface FigDevtoolsHostSnapshot {
+  kind: "element" | "text";
+  tagName?: string;
+  attributes?: Record<string, string>;
+  text?: string;
+}
+interface FigDevtoolsRootSnapshot {
+  id: number;
+  rendererId: number;
+  committedAt: number;
+  dataResources: DataStoreEntrySnapshot[];
+  pendingWork: FigDevtoolsWorkLabel[];
+  suspendedWork: FigDevtoolsWorkLabel[];
+  pingedWork: FigDevtoolsWorkLabel[];
+  expiredWork: FigDevtoolsWorkLabel[];
+  tree: FigDevtoolsFiberSnapshot;
+}
+interface FigDevtoolsElementInspection {
+  rootId: number;
+  fiberId: number;
+}
+interface FigDevtoolsCommitInspection {
+  inspectElement(target: unknown): FigDevtoolsElementInspection | null;
+  elementForFiber(fiberId: number): unknown;
+}
+interface FigDevtoolsRendererInfo {
+  name: string;
+  packageName: string;
+}
+interface FigDevtoolsGlobalHook {
+  inject(renderer: FigDevtoolsRendererInfo): number;
+  onCommitRoot(rendererId: number, snapshot: FigDevtoolsRootSnapshot, inspection?: FigDevtoolsCommitInspection): void;
+}
+declare function devtoolsTypeName(type: ElementType | FigContext<unknown> | null, fallback: string): string;
+declare function getFigDevtoolsGlobalHook(): FigDevtoolsGlobalHook | null;
+//#endregion
+export { FigDevtoolsCommitInspection, FigDevtoolsEffectPhase, FigDevtoolsElementInspection, FigDevtoolsFiberKind, FigDevtoolsFiberSnapshot, FigDevtoolsGlobalHook, FigDevtoolsHookKind, FigDevtoolsHookSnapshot, FigDevtoolsHostSnapshot, FigDevtoolsRendererInfo, FigDevtoolsRootSnapshot, FigDevtoolsWorkLabel, devtoolsTypeName, getFigDevtoolsGlobalHook };

package/dist/devtools.js

@@ -0,0 +1,22 @@
+import { Fragment } from "@bgub/fig";
+//#region src/devtools.ts
+function devtoolsTypeName(type, fallback) {
+	if (typeof type === "string") return type;
+	if (type === Fragment) return "Fragment";
+	if (typeof type !== "function") return fallback;
+	const namedType = type;
+	if (typeof namedType.displayName === "string" && namedType.displayName !== "") return namedType.displayName;
+	if (typeof namedType.name === "string" && namedType.name !== "") return namedType.name;
+	return fallback;
+}
+function getFigDevtoolsGlobalHook() {
+	const hook = globalThis.__FIG_DEVTOOLS_GLOBAL_HOOK__;
+	if (typeof hook !== "object" || hook === null || !("inject" in hook) || !("onCommitRoot" in hook)) return null;
+	const candidate = hook;
+	if (typeof candidate.inject !== "function" || typeof candidate.onCommitRoot !== "function") return null;
+	return candidate;
+}
+//#endregion
+export { devtoolsTypeName, getFigDevtoolsGlobalHook };
+
+//# sourceMappingURL=devtools.js.map

package/dist/devtools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devtools.js","names":["globalWithHook"],"sources":["../src/devtools.ts"],"sourcesContent":["import {\n  type DependencyList,\n  type ElementType,\n  type FigContext,\n  Fragment,\n  type Props,\n} from \"@bgub/fig\";\nimport type { DataStoreEntrySnapshot } from \"@bgub/fig/internal\";\n\nexport type FigDevtoolsFiberKind =\n  | \"root\"\n  | \"host\"\n  | \"text\"\n  | \"function\"\n  | \"fragment\"\n  | \"assets\"\n  | \"context-provider\"\n  | \"suspense\"\n  | \"error-boundary\"\n  | \"portal\"\n  | \"activity\"\n  | \"view-transition\";\n\nexport type FigDevtoolsHookKind =\n  | \"state\"\n  | \"action-state\"\n  | \"id\"\n  | \"deferred-value\"\n  | \"external-store\"\n  | \"memo\"\n  | \"transition\"\n  | \"stable-event\"\n  | \"reactive\"\n  | \"before-paint\"\n  | \"before-layout\";\n\nexport type FigDevtoolsEffectPhase =\n  | \"reactive\"\n  | \"before-paint\"\n  | \"before-layout\";\n\nexport type FigDevtoolsWorkLabel =\n  | \"sync\"\n  | \"input\"\n  | \"default\"\n  | \"gesture\"\n  | \"transition\"\n  | \"retry\"\n  | \"idle\"\n  | \"offscreen\"\n  | \"deferred\"\n  | \"selective-hydration\";\n\nexport interface FigDevtoolsHookSnapshot {\n  id: number;\n  kind: FigDevtoolsHookKind;\n  state?: unknown;\n  deps?: DependencyList | null;\n  phase?: FigDevtoolsEffectPhase;\n  active?: boolean;\n}\n\nexport interface FigDevtoolsFiberSnapshot {\n  id: number;\n  parentId: number | null;\n  name: string;\n  kind: FigDevtoolsFiberKind;\n  key: string | number | null;\n  index: number;\n  props: Props;\n  pendingWork: FigDevtoolsWorkLabel[];\n  childWork: FigDevtoolsWorkLabel[];\n  hooks: FigDevtoolsHookSnapshot[];\n  contextDependencies: string[];\n  host?: FigDevtoolsHostSnapshot;\n  capturedError?: unknown;\n  componentStack?: string;\n  children: FigDevtoolsFiberSnapshot[];\n}\n\nexport interface FigDevtoolsHostSnapshot {\n  kind: \"element\" | \"text\";\n  tagName?: string;\n  attributes?: Record<string, string>;\n  text?: string;\n}\n\nexport interface FigDevtoolsRootSnapshot {\n  id: number;\n  rendererId: number;\n  committedAt: number;\n  dataResources: DataStoreEntrySnapshot[];\n  pendingWork: FigDevtoolsWorkLabel[];\n  suspendedWork: FigDevtoolsWorkLabel[];\n  pingedWork: FigDevtoolsWorkLabel[];\n  expiredWork: FigDevtoolsWorkLabel[];\n  tree: FigDevtoolsFiberSnapshot;\n}\n\nexport interface FigDevtoolsElementInspection {\n  rootId: number;\n  fiberId: number;\n}\n\nexport interface FigDevtoolsCommitInspection {\n  inspectElement(target: unknown): FigDevtoolsElementInspection | null;\n  elementForFiber(fiberId: number): unknown;\n}\n\nexport interface FigDevtoolsRendererInfo {\n  name: string;\n  packageName: string;\n}\n\nexport interface FigDevtoolsGlobalHook {\n  inject(renderer: FigDevtoolsRendererInfo): number;\n  onCommitRoot(\n    rendererId: number,\n    snapshot: FigDevtoolsRootSnapshot,\n    inspection?: FigDevtoolsCommitInspection,\n  ): void;\n}\n\nexport function devtoolsTypeName(\n  type: ElementType | FigContext<unknown> | null,\n  fallback: string,\n): string {\n  if (typeof type === \"string\") return type;\n  if (type === Fragment) return \"Fragment\";\n  if (typeof type !== \"function\") return fallback;\n\n  const namedType = type as {\n    displayName?: unknown;\n    name?: unknown;\n  };\n\n  if (typeof namedType.displayName === \"string\" && namedType.displayName !== \"\")\n    return namedType.displayName;\n  if (typeof namedType.name === \"string\" && namedType.name !== \"\")\n    return namedType.name;\n\n  return fallback;\n}\n\nexport function getFigDevtoolsGlobalHook(): FigDevtoolsGlobalHook | null {\n  const globalWithHook = globalThis as typeof globalThis & {\n    __FIG_DEVTOOLS_GLOBAL_HOOK__?: unknown;\n  };\n  const hook = globalWithHook.__FIG_DEVTOOLS_GLOBAL_HOOK__;\n\n  if (\n    typeof hook !== \"object\" ||\n    hook === null ||\n    !(\"inject\" in hook) ||\n    !(\"onCommitRoot\" in hook)\n  ) {\n    return null;\n  }\n\n  const candidate = hook as Partial<FigDevtoolsGlobalHook>;\n  if (\n    typeof candidate.inject !== \"function\" ||\n    typeof candidate.onCommitRoot !== \"function\"\n  ) {\n    return null;\n  }\n\n  return candidate as FigDevtoolsGlobalHook;\n}\n"],"mappings":";;AA2HA,SAAgB,iBACd,MACA,UACQ;CACR,IAAI,OAAO,SAAS,UAAU,OAAO;CACrC,IAAI,SAAS,UAAU,OAAO;CAC9B,IAAI,OAAO,SAAS,YAAY,OAAO;CAEvC,MAAM,YAAY;CAKlB,IAAI,OAAO,UAAU,gBAAgB,YAAY,UAAU,gBAAgB,IACzE,OAAO,UAAU;CACnB,IAAI,OAAO,UAAU,SAAS,YAAY,UAAU,SAAS,IAC3D,OAAO,UAAU;CAEnB,OAAO;AACT;AAEA,SAAgB,2BAAyD;CAIvE,MAAM,OAAOA,WAAe;CAE5B,IACE,OAAO,SAAS,YAChB,SAAS,QACT,EAAE,YAAY,SACd,EAAE,kBAAkB,OAEpB,OAAO;CAGT,MAAM,YAAY;CAClB,IACE,OAAO,UAAU,WAAW,cAC5B,OAAO,UAAU,iBAAiB,YAElC,OAAO;CAGT,OAAO;AACT"}

package/dist/index.d.ts

@@ -0,0 +1,125 @@
+import { RefreshUpdate } from "./refresh.js";
+import { DataResourceKeyInput, ErrorInfo, FigDataHydrationEntry, FigDataStoreHandle, FigNode, Props } from "@bgub/fig";
+//#region src/scheduler.d.ts
+declare function act<T>(callback: () => T | PromiseLike<T>): Promise<Awaited<T>>;
+//#endregion
+//#region src/index.d.ts
+type EventPriority = "default" | "continuous" | "discrete";
+declare function runWithEventPriority<T>(priority: EventPriority, callback: () => T): T;
+type HostNode<Instance, TextInstance> = Instance | TextInstance;
+type Parent<Container, Instance> = Container | Instance;
+interface DehydratedSuspenseError {
+  digest?: string;
+  message?: string;
+}
+interface DehydratedSuspenseBoundary<Instance = unknown, TextInstance = unknown> {
+  error?: DehydratedSuspenseError | null;
+  id: string | null;
+  start: HostNode<Instance, TextInstance>;
+  end: HostNode<Instance, TextInstance>;
+  status: "completed" | "pending" | "client-rendered";
+  forceClientRender: boolean;
+}
+type ViewTransitionCommitResult = false | "committed" | "deferred";
+interface ViewTransitionSurfaceMeasurement {
+  absolutelyPositioned: boolean;
+  height: number;
+  inViewport: boolean;
+  width: number;
+  x: number;
+  y: number;
+}
+interface ViewTransitionMutationResult {
+  canceledNames: string[];
+  cancelRootSnapshot: boolean;
+}
+interface ViewTransitionHostConfig<Container, Instance> {
+  commit(this: void, container: Container, prepareSnapshot: () => void, mutate: () => ViewTransitionMutationResult, cleanup: () => void): ViewTransitionCommitResult;
+  apply(this: void, instance: Instance, name: string, className: string | null): void;
+  restore(this: void, instance: Instance, props: Props): void;
+  measure?(this: void, instance: Instance): ViewTransitionSurfaceMeasurement | null;
+  suspend?(this: void, container: Container, onFinished: () => void): boolean;
+}
+interface HostConfig<Container, Instance, TextInstance> {
+  createInstance(type: string, props: Props, parent: Parent<Container, Instance>): Instance;
+  createTextInstance(text: string): TextInstance;
+  validateInstanceNesting?(type: string, props: Props, ancestors: readonly string[]): void;
+  validateTextNesting?(text: string, ancestors: readonly string[]): void;
+  containerType?(container: Parent<Container, Instance>): string | null;
+  appendInitialChild?(parent: Instance, child: HostNode<Instance, TextInstance>): void;
+  finalizeInitialInstance?(instance: Instance, props: Props): void;
+  setTextContent?(instance: Instance, text: string): void;
+  getFirstHydratableChild?(parent: Parent<Container, Instance>, props?: Props): HostNode<Instance, TextInstance> | null;
+  getNextHydratableSibling?(node: HostNode<Instance, TextInstance>): HostNode<Instance, TextInstance> | null;
+  canHydrateInstance?(node: HostNode<Instance, TextInstance>, type: string, props: Props): boolean;
+  canHydrateTextInstance?(node: HostNode<Instance, TextInstance>, text: string, suppressHydrationWarning?: boolean): boolean;
+  isHoistedInstance?(type: string, props: Props): boolean;
+  commitHoistedInstance?(instance: Instance): Instance | void;
+  removeHoistedInstance?(instance: Instance): void;
+  updateHoistedInstance?(instance: Instance, previousProps: Props, nextProps: Props): Instance;
+  shouldCommitUpdate?(type: string, previousProps: Props, nextProps: Props): boolean;
+  clearContainer?(container: Container): void;
+  insertBefore(parent: Parent<Container, Instance>, child: HostNode<Instance, TextInstance>, before: HostNode<Instance, TextInstance> | null): void;
+  removeChild(parent: Parent<Container, Instance>, child: HostNode<Instance, TextInstance>): void;
+  commitUpdate(instance: Instance, previousProps: Props, nextProps: Props): void;
+  commitHydratedInstance?(instance: Instance, nextProps: Props): void;
+  getActivityBoundary?(node: HostNode<Instance, TextInstance>): Instance | null;
+  getFirstActivityHydratable?(boundary: Instance): HostNode<Instance, TextInstance> | null;
+  commitHydratedActivityBoundary?(boundary: Instance): void;
+  hideInstance?(instance: Instance): void;
+  unhideInstance?(instance: Instance, props: Props): void;
+  hideTextInstance?(instance: TextInstance): void;
+  unhideTextInstance?(instance: TextInstance, text: string): void;
+  getSuspenseBoundary?(node: HostNode<Instance, TextInstance>): DehydratedSuspenseBoundary<Instance, TextInstance> | null;
+  getEnclosingSuspenseBoundaryStart?(target: unknown): HostNode<Instance, TextInstance> | null;
+  isTargetWithinSuspenseBoundary?(target: unknown, boundary: DehydratedSuspenseBoundary<Instance, TextInstance>): boolean;
+  registerSuspenseBoundaryRetry?(boundary: DehydratedSuspenseBoundary<Instance, TextInstance>, retry: () => void): void;
+  commitHydratedSuspenseBoundary?(boundary: DehydratedSuspenseBoundary<Instance, TextInstance>): void;
+  completeRootHydration?(container: Container): void;
+  removeDehydratedSuspenseBoundary?(boundary: DehydratedSuspenseBoundary<Instance, TextInstance>): void;
+  preparePortalContainer?(container: Parent<Container, Instance>, root: Container, logicalParent: Parent<Container, Instance>): void;
+  removePortalContainer?(container: Parent<Container, Instance>): void;
+  viewTransition?: ViewTransitionHostConfig<Container, Instance>;
+  commitTextUpdate(text: TextInstance, value: string): void;
+}
+type HostRenderConfig<Container, Instance, TextInstance> = Pick<HostConfig<Container, Instance, TextInstance>, "createInstance" | "createTextInstance" | "appendInitialChild" | "finalizeInitialInstance" | "setTextContent" | "insertBefore" | "removeChild" | "commitUpdate" | "commitTextUpdate" | "shouldCommitUpdate" | "clearContainer">;
+type HostValidationConfig<Container, Instance, TextInstance> = Pick<HostConfig<Container, Instance, TextInstance>, "validateInstanceNesting" | "validateTextNesting" | "containerType">;
+type HostHydrationConfig<Container, Instance, TextInstance> = Required<Pick<HostConfig<Container, Instance, TextInstance>, "getFirstHydratableChild" | "getNextHydratableSibling" | "canHydrateInstance" | "canHydrateTextInstance" | "clearContainer">> & Pick<HostConfig<Container, Instance, TextInstance>, "commitHydratedInstance">;
+type HostActivityConfig<Container, Instance, TextInstance> = Required<Pick<HostConfig<Container, Instance, TextInstance>, "getActivityBoundary" | "getFirstActivityHydratable" | "commitHydratedActivityBoundary" | "hideInstance" | "unhideInstance" | "hideTextInstance" | "unhideTextInstance">>;
+type HostSuspenseHydrationConfig<Container, Instance, TextInstance> = Required<Pick<HostConfig<Container, Instance, TextInstance>, "getSuspenseBoundary" | "getEnclosingSuspenseBoundaryStart" | "isTargetWithinSuspenseBoundary" | "registerSuspenseBoundaryRetry" | "commitHydratedSuspenseBoundary" | "completeRootHydration" | "removeDehydratedSuspenseBoundary">>;
+type HostPortalConfig<Container, Instance, TextInstance> = Required<Pick<HostConfig<Container, Instance, TextInstance>, "preparePortalContainer" | "removePortalContainer">>;
+type HostHoistedAssetConfig<Container, Instance, TextInstance> = Required<Pick<HostConfig<Container, Instance, TextInstance>, "isHoistedInstance" | "commitHoistedInstance" | "removeHoistedInstance" | "updateHoistedInstance">>;
+interface FigRoot {
+  data: FigDataStoreHandle;
+  render(children: FigNode): void;
+  unmount(): void;
+}
+interface FigRootOptions {
+  dataPartition?: DataResourceKeyInput;
+  initialData?: readonly FigDataHydrationEntry[];
+  identifierPrefix?: string;
+  devtools?: boolean;
+  onRecoverableError?: (error: unknown, info: RecoverableErrorInfo) => void;
+  onUncaughtError?: (error: unknown, info: ErrorInfo) => void;
+}
+interface RecoverableErrorInfo extends ErrorInfo {
+  actual?: string;
+  boundaryId?: string;
+  componentStack: string;
+  digest?: string;
+  expected?: string;
+  recovery: "root" | "suspense";
+  source: "hydration" | "server";
+}
+type HydrationTargetResult = "none" | "hydrated" | "blocked";
+interface FigRenderer<Container> {
+  batchedUpdates<T>(this: void, callback: () => T): T;
+  createRoot(this: void, container: Container, options?: FigRootOptions): FigRoot;
+  hydrateRoot(this: void, container: Container, children: FigNode, options?: FigRootOptions): FigRoot;
+  hydrateTarget(this: void, container: Container, target: unknown, priority?: EventPriority): HydrationTargetResult;
+  flushSync<T>(this: void, callback: () => T): T;
+  scheduleRefresh(this: void, update: RefreshUpdate): void;
+}
+declare function createRenderer<Container, Instance, TextInstance>(host: HostConfig<Container, Instance, TextInstance>): FigRenderer<Container>;
+//#endregion
+export { DehydratedSuspenseBoundary, DehydratedSuspenseError, EventPriority, FigRenderer, FigRoot, FigRootOptions, HostActivityConfig, HostConfig, HostHoistedAssetConfig, HostHydrationConfig, HostPortalConfig, HostRenderConfig, HostSuspenseHydrationConfig, HostValidationConfig, HydrationTargetResult, RecoverableErrorInfo, type RefreshUpdate, ViewTransitionCommitResult, ViewTransitionHostConfig, ViewTransitionMutationResult, ViewTransitionSurfaceMeasurement, act, createRenderer, runWithEventPriority };