@ringozz/react-godot 4.7.2-612 → 4.7.2-616

package/src/react-fiber.ts

@@ -1,315 +1,331 @@
-/**********************************************************************
- Copyright (c) Vladimir Davidovich. All rights reserved.
-***********************************************************************/
-
-import { ClassDB } from '@ringozz/godot/ClassDB';
-import { Node } from '@ringozz/godot/Node';
-import { Object as Instance } from '@ringozz/godot/Object';
-import { PackedScene } from '@ringozz/godot/PackedScene';
-import { RefCounted } from '@ringozz/godot/RefCounted';
-import type Reconciler from 'react-reconciler';
-import Constants from 'react-reconciler/constants.js';
-import pkg from '../package.json' with { type: 'json' };
-import type { InstanceProps } from './react-types.ts';
-
-/* eslint-disable @typescript-eslint/no-unused-vars */
-
-export const rendererPackageName = pkg.name;
-export const rendererVersion = pkg.version;
-export const supportsMutation = true;
-export const supportsPersistence = false;
-export const supportsHydration = false;
-export const isPrimaryRenderer = true;
-
-type Type = string;
-type Props = InstanceProps & Record<string, unknown>;
-type Container = Instance;
-type TextInstance = Instance;
-type SuspenseInstance = Instance;
-type PublicInstance = Instance;
-type HostContext = unknown;
-
-const EMPTY = Object.freeze({});
-const attachments = new WeakMap<Instance, string>();
-
-export function createInstance<T extends Instance>(type: Type, props: Props, root: Container, hostContext: HostContext, internalHandle: Reconciler.OpaqueHandle): T {
-  let { attach, object, ...rest } = props;
-  if (object instanceof PackedScene)
-    object = object.instantiate();
-  else if (object instanceof RefCounted)
-    object.reference();
-
-  const instance = (object ?? ClassDB.instantiate(type)) as T;
-  if (attach)
-    attachments.set(instance, attach);
-
-  commitUpdate(instance, type, EMPTY, rest, internalHandle);
-  return instance;
-}
-
-export function createTextInstance(text: string, root: Container, hostContext: HostContext, internalHandle: Reconciler.OpaqueHandle): TextInstance {
-  throw new Error('Text nodes are not supported: use a text prop, or a single string/all-string children (they are flattened into the node\'s `text` property).');
-}
-
-export const appendInitialChild = appendChild;
-
-export function finalizeInitialChildren(instance: Instance, type: Type, props: Props, root: Container, hostContext: HostContext): boolean {
-  return false;
-}
-
-export function shouldSetTextContent(type: Type, props: Props): boolean {
-  const c = props.children;
-  if (typeof c === 'string' || typeof c === 'number')
-    return true;
-  return Array.isArray(c) && c.every((v) => typeof v === 'string' || typeof v === 'number');
-}
-
-export function getRootHostContext(root: Container): HostContext | null {
-  return EMPTY;
-}
-
-export function getChildHostContext(parentHostContext: HostContext, type: Type, root: Container): HostContext {
-  return parentHostContext;
-}
-
-export function getPublicInstance(instance: Instance | TextInstance): PublicInstance {
-  return instance;
-}
-
-export function prepareForCommit(containerInfo: Container): Props | null {
-  return null;
-}
-
-export function resetAfterCommit(containerInfo: Container): void {
-}
-
-export function preparePortalMount(containerInfo: Container): void {
-  // No-op: portal children attach to their target Node via appendChildToContainer.
-  // Mirrors ReactDOM's empty implementation.
-}
-
-export const noTimeout = -1;
-export const scheduleTimeout = setTimeout;
-export const cancelTimeout = clearTimeout;
-export const supportsMicrotasks = true;
-export const scheduleMicrotask = queueMicrotask;
-
-let currentUpdatePriority = Constants.NoEventPriority;
-export function setCurrentUpdatePriority(newPriority: Reconciler.EventPriority) {
-  currentUpdatePriority = newPriority;
-}
-
-export function getCurrentUpdatePriority(): Reconciler.EventPriority {
-  return currentUpdatePriority;
-}
-
-const currentEvent = () => globalThis.window?.event;
-
-export function resolveUpdatePriority(): Reconciler.EventPriority {
-  if (currentUpdatePriority)
-    return currentUpdatePriority;
-  const event = currentEvent();
-  switch (event?.type) {
-    case 'click':
-    case 'contextmenu':
-    case 'keydown':
-    case 'keypress':
-    case 'keyup':
-    case 'pointercancel':
-    case 'pointerdown':
-    case 'pointerup':
-      return Constants.DiscreteEventPriority;
-    case 'pointerenter':
-    case 'pointerleave':
-    case 'pointermove':
-    case 'pointerout':
-    case 'pointerover':
-    case 'resize':
-    case 'wheel':
-      return Constants.ContinuousEventPriority;
-    default:
-      return Constants.DefaultEventPriority;
-  }
-}
-
-let schedulerEvent: Event | undefined = undefined;
-export function trackSchedulerEvent() {
-  schedulerEvent = currentEvent();
-}
-
-export function resolveEventType(): null | string {
-  const event = currentEvent();
-  return event && event !== schedulerEvent ? event.type : null;
-}
-
-export function resolveEventTimeStamp(): number {
-  const event = currentEvent();
-  return event && event !== schedulerEvent ? event.timeStamp : -1.1;
-}
-
-export function requestPostPaintCallback() {
-}
-
-export function resetFormInstance() {
-}
-
-export const NotPendingTransition = null;
-export const HostTransitionContext = null as never;
-
-export function shouldAttemptEagerTransition() {
-  return false;
-}
-
-export function getInstanceFromNode(node: unknown): Reconciler.Fiber | null | undefined {
-  return null;
-}
-
-export function beforeActiveInstanceBlur(): void {
-}
-
-export function afterActiveInstanceBlur(): void {
-}
-
-export function prepareScopeUpdate(scopeInstance: unknown, instance: unknown): void {
-}
-
-export function getInstanceFromScope(scopeInstance: unknown): Instance | null {
-  return null;
-}
-
-export function detachDeletedInstance(node: Instance): void {
-  if (node instanceof Node)
-    node.queueFree();
-  else
-    node.free();
-}
-
-export function maySuspendCommit(type: Type, props: Props) {
-  return false;
-}
-
-export function preloadInstance(type: Type, props: Props) {
-  return true; // Return true to indicate it's already loaded
-}
-
-export function startSuspendingCommit() {
-}
-
-export function suspendInstance(type: Type, props: Props) {
-}
-
-export function waitForCommitToBeReady() {
-  return null;
-}
-
-export function appendChild(parentInstance: Instance, child: Instance | TextInstance): void {
-  const attached = attachments.get(child);
-  if (attached) {
-    Instance.assign(parentInstance, { [attached]: child });
-    return;
-  }
-  (parentInstance as Node).addChild(child as Node);
-}
-
-export function appendChildToContainer(container: Container, child: Instance | TextInstance): void {
-  appendChild(container, child);
-}
-
-export function insertBefore(parentInstance: Instance, child: Instance | TextInstance, beforeChild: Instance | TextInstance | SuspenseInstance): void {
-  const attached = attachments.get(child);
-  if (attached) {
-    Instance.assign(parentInstance, { [attached]: child });
-    return;
-  }
-  if ((child as Node).getParent() !== null) {
-    (parentInstance as Node).removeChild(child as Node);
-  }
-  (parentInstance as Node).addChild(child as Node);
-  (parentInstance as Node).moveChild(child as Node, (beforeChild as Node).getIndex());
-}
-
-export function insertInContainerBefore(container: Container, child: Instance | TextInstance, beforeChild: Instance | TextInstance | SuspenseInstance): void {
-  insertBefore(container, child, beforeChild);
-}
-
-export function removeChild(parentInstance: Instance, child: Instance | TextInstance | SuspenseInstance): void {
-  const attached = attachments.get(child);
-  if (attached) {
-    Instance.assign(parentInstance, { [attached]: undefined });
-    return;
-  }
-  (parentInstance as Node).removeChild(child as Node);
-}
-
-export function removeChildFromContainer(container: Container, child: Instance | TextInstance | SuspenseInstance): void {
-  removeChild(container, child);
-}
-
-export function resetTextContent(instance: Instance): void {
-  instance.set('text', undefined);
-}
-
-export function commitTextUpdate(instance: TextInstance, oldText: string, newText: string): void {
-  instance.set('text', newText);
-}
-
-export function commitMount(instance: Instance, type: Type, props: Props, internalInstanceHandle: Reconciler.OpaqueHandle): void {
-}
-
-function isEqual(a: unknown, b: unknown) {
-  if (a === b) return true;
-
-  const i1 = (a as Iterable<unknown> | undefined)?.[Symbol.iterator]?.();
-  const i2 = (b as Iterable<unknown> | undefined)?.[Symbol.iterator]?.();
-  while (i1 && i2) {
-    const n1 = i1.next();
-    const n2 = i2.next();
-    if (n1.done !== n2.done) return false;   // Different lengths
-    if (n1.done) return true;                // Both finished
-    if (n1.value !== n2.value) return false; // Values mismatch
-  }
-}
-
-export function commitUpdate(instance: Instance, type: Type, prevProps: Props, nextProps: Props, internalHandle: Reconciler.OpaqueHandle): void {
-  const { attach: attachOld, object: objectOld, ref: refOld, children: childrenOld, ...restOld } = prevProps;
-  const { attach: attachNew, object: objectNew, ref: refNew, children: childrenNew, ...restNew } = nextProps;
-  if (attachOld !== attachNew)
-    throw new Error(`Cannot change attachment ${attachOld} to ${attachNew}`);
-  if (objectOld !== objectNew)
-    throw new Error(`Cannot change the \`object\` of a mounted instance (${objectOld} -> ${objectNew}); remount with a new key`);
-
-  const toText = (c: unknown) => Array.isArray(c) ? c.join('') : c as string;
-  if (shouldSetTextContent(type, prevProps)) restOld['text'] = toText(childrenOld);
-  if (shouldSetTextContent(type, nextProps)) restNew['text'] = toText(childrenNew);
-
-  for (const [key, oldVal] of Object.entries(restOld)) {
-    const newVal = restNew[key];
-    if (isEqual(oldVal, newVal))
-      delete restNew[key];
-    else if (newVal === undefined)
-      restNew[key] = undefined;
-  }
-
-  Instance.assign(instance, restNew);
-}
-
-export function hideInstance(instance: Instance | TextInstance): void {
-  instance.set('visible', false);
-}
-
-export const hideTextInstance = hideInstance;
-
-export function unhideInstance(instance: Instance | TextInstance): void {
-  instance.set('visible', true);
-}
-
-export const unhideTextInstance = unhideInstance;
-
-export function clearContainer(container: Container): void {
-  // No-op: Godot containers (e.g. the SceneTree root) can hold non-React
-  // children such as portal targets. The reconciler calls this on every
-  // initial mount; queue-freeing the container's children here would destroy
-  // those foreign nodes and leave React fibers referencing freed instances.
-  // React-managed children are removed by the reconciler's deletion path.
-}
-
+/**********************************************************************
+ Copyright (c) Vladimir Davidovich. All rights reserved.
+***********************************************************************/
+
+import { ClassDB } from '@ringozz/godot/ClassDB';
+import { Node } from '@ringozz/godot/Node';
+import { Object as Instance } from '@ringozz/godot/Object';
+import { PackedScene } from '@ringozz/godot/PackedScene';
+import { RefCounted } from '@ringozz/godot/RefCounted';
+import type Reconciler from 'react-reconciler';
+import Constants from 'react-reconciler/constants.js';
+import pkg from '../package.json' with { type: 'json' };
+import type { InstanceProps } from './react-types.ts';
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+export const rendererPackageName = pkg.name;
+export const rendererVersion = pkg.version;
+export const supportsMutation = true;
+export const supportsPersistence = false;
+export const supportsHydration = false;
+export const isPrimaryRenderer = true;
+
+type Type = string;
+type Props = InstanceProps & Record<string, unknown>;
+type Container = Instance;
+type TextInstance = Instance;
+type SuspenseInstance = Instance;
+type PublicInstance = Instance;
+type HostContext = unknown;
+
+const EMPTY = Object.freeze({});
+const attachments = new WeakMap<Instance, string>();
+
+export function createInstance<T extends Instance>(type: Type, props: Props, root: Container, hostContext: HostContext, internalHandle: Reconciler.OpaqueHandle): T {
+  let { attach, object, script, ...rest } = props;
+  if (object instanceof PackedScene)
+    object = object.instantiate();
+  else if (object instanceof RefCounted)
+    object.reference();
+
+  const instance = (object ?? ClassDB.instantiate(type)) as T;
+  if (attach)
+    attachments.set(instance, attach);
+
+  if (script)
+    instance.setScript(script);
+
+  commitUpdate(instance, type, EMPTY, rest, internalHandle);
+  return instance;
+}
+
+export function createTextInstance(text: string, root: Container, hostContext: HostContext, internalHandle: Reconciler.OpaqueHandle): TextInstance {
+  throw new Error('Text nodes are not supported: use a text prop, or a single string/all-string children (they are flattened into the node\'s `text` property).');
+}
+
+export const appendInitialChild = appendChild;
+
+export function finalizeInitialChildren(instance: Instance, type: Type, props: Props, root: Container, hostContext: HostContext): boolean {
+  return false;
+}
+
+export function shouldSetTextContent(type: Type, props: Props): boolean {
+  const c = props.children;
+  if (typeof c === 'string' || typeof c === 'number')
+    return true;
+  return Array.isArray(c) && c.every((v) => typeof v === 'string' || typeof v === 'number');
+}
+
+export function getRootHostContext(root: Container): HostContext | null {
+  return EMPTY;
+}
+
+export function getChildHostContext(parentHostContext: HostContext, type: Type, root: Container): HostContext {
+  return parentHostContext;
+}
+
+export function getPublicInstance(instance: Instance | TextInstance): PublicInstance {
+  return instance;
+}
+
+export function prepareForCommit(containerInfo: Container): Props | null {
+  return null;
+}
+
+export function resetAfterCommit(containerInfo: Container): void {
+}
+
+export function preparePortalMount(containerInfo: Container): void {
+  // No-op: portal children attach to their target Node via appendChildToContainer.
+  // Mirrors ReactDOM's empty implementation.
+}
+
+export const noTimeout = -1;
+export const scheduleTimeout = setTimeout;
+export const cancelTimeout = clearTimeout;
+export const supportsMicrotasks = true;
+export const scheduleMicrotask = queueMicrotask;
+
+let currentUpdatePriority = Constants.NoEventPriority;
+export function setCurrentUpdatePriority(newPriority: Reconciler.EventPriority) {
+  currentUpdatePriority = newPriority;
+}
+
+export function getCurrentUpdatePriority(): Reconciler.EventPriority {
+  return currentUpdatePriority;
+}
+
+const currentEvent = () => globalThis.window?.event;
+
+export function resolveUpdatePriority(): Reconciler.EventPriority {
+  if (currentUpdatePriority)
+    return currentUpdatePriority;
+  const event = currentEvent();
+  switch (event?.type) {
+    case 'click':
+    case 'contextmenu':
+    case 'keydown':
+    case 'keypress':
+    case 'keyup':
+    case 'pointercancel':
+    case 'pointerdown':
+    case 'pointerup':
+      return Constants.DiscreteEventPriority;
+    case 'pointerenter':
+    case 'pointerleave':
+    case 'pointermove':
+    case 'pointerout':
+    case 'pointerover':
+    case 'resize':
+    case 'wheel':
+      return Constants.ContinuousEventPriority;
+    default:
+      return Constants.DefaultEventPriority;
+  }
+}
+
+let schedulerEvent: Event | undefined = undefined;
+export function trackSchedulerEvent() {
+  schedulerEvent = currentEvent();
+}
+
+export function resolveEventType(): null | string {
+  const event = currentEvent();
+  return event && event !== schedulerEvent ? event.type : null;
+}
+
+export function resolveEventTimeStamp(): number {
+  const event = currentEvent();
+  return event && event !== schedulerEvent ? event.timeStamp : -1.1;
+}
+
+export function requestPostPaintCallback() {
+}
+
+export function resetFormInstance() {
+}
+
+export const NotPendingTransition = null;
+export const HostTransitionContext = null as never;
+
+export function shouldAttemptEagerTransition() {
+  return false;
+}
+
+export function getInstanceFromNode(node: unknown): Reconciler.Fiber | null | undefined {
+  return null;
+}
+
+export function beforeActiveInstanceBlur(): void {
+}
+
+export function afterActiveInstanceBlur(): void {
+}
+
+export function prepareScopeUpdate(scopeInstance: unknown, instance: unknown): void {
+}
+
+export function getInstanceFromScope(scopeInstance: unknown): Instance | null {
+  return null;
+}
+
+export function detachDeletedInstance(node: Instance): void {
+  if (node instanceof Node)
+    node.queueFree();
+  else
+    node.free();
+}
+
+export function maySuspendCommit(type: Type, props: Props) {
+  return false;
+}
+
+export function preloadInstance(type: Type, props: Props) {
+  return true; // Return true to indicate it's already loaded
+}
+
+export function startSuspendingCommit() {
+}
+
+export function suspendInstance(type: Type, props: Props) {
+}
+
+export function suspendOnActiveViewTransition() {
+}
+
+export function waitForCommitToBeReady() {
+  return null;
+}
+
+export function appendChild(parentInstance: Instance, child: Instance | TextInstance): void {
+  insertBefore(parentInstance, child, null);
+}
+
+export function appendChildToContainer(container: Container, child: Instance | TextInstance): void {
+  appendChild(container, child);
+}
+
+export function insertBefore(parentInstance: Instance, child: Instance | TextInstance, beforeChild: Instance | TextInstance | SuspenseInstance | null): void {
+  const attached = attachments.get(child);
+  if (attached) {
+    Instance.assign(parentInstance, { [attached]: child });
+    return;
+  }
+  const parent = parentInstance as Node;
+  const node = child as Node;
+  const oldParent = node.getParent();
+  if (oldParent != parent) {
+    oldParent?.removeChild(node);
+    parent.addChild(node);
+  }
+  // A negative index counts from the end, so -1 is the append case — one native
+  // call, no anchor to look up.
+  if (!beforeChild) {
+    parent.moveChild(node, -1);
+    return;
+  }
+  // move_child() inserts into the list *after* removing the node, so an anchor
+  // sitting after the node shifts down by one.
+  const from = node.getIndex();
+  const to = (beforeChild as Node).getIndex();
+  parent.moveChild(node, to > from ? to - 1 : to);
+}
+
+export function insertInContainerBefore(container: Container, child: Instance | TextInstance, beforeChild: Instance | TextInstance | SuspenseInstance): void {
+  insertBefore(container, child, beforeChild);
+}
+
+export function removeChild(parentInstance: Instance, child: Instance | TextInstance | SuspenseInstance): void {
+  const attached = attachments.get(child);
+  if (attached) {
+    Instance.assign(parentInstance, { [attached]: undefined });
+    return;
+  }
+  (parentInstance as Node).removeChild(child as Node);
+}
+
+export function removeChildFromContainer(container: Container, child: Instance | TextInstance | SuspenseInstance): void {
+  removeChild(container, child);
+}
+
+export function resetTextContent(instance: Instance): void {
+  instance.set('text', undefined);
+}
+
+export function commitTextUpdate(instance: TextInstance, oldText: string, newText: string): void {
+  instance.set('text', newText);
+}
+
+export function commitMount(instance: Instance, type: Type, props: Props, internalInstanceHandle: Reconciler.OpaqueHandle): void {
+}
+
+function isEqual(a: unknown, b: unknown) {
+  if (a === b) return true;
+
+  const i1 = (a as Iterable<unknown> | undefined)?.[Symbol.iterator]?.();
+  const i2 = (b as Iterable<unknown> | undefined)?.[Symbol.iterator]?.();
+  while (i1 && i2) {
+    const n1 = i1.next();
+    const n2 = i2.next();
+    if (n1.done !== n2.done) return false;   // Different lengths
+    if (n1.done) return true;                // Both finished
+    if (n1.value !== n2.value) return false; // Values mismatch
+  }
+}
+
+export function commitUpdate(instance: Instance, type: Type, prevProps: Props, nextProps: Props, internalHandle: Reconciler.OpaqueHandle): void {
+  const { attach: attachOld, object: objectOld, script: scriptOld, ref: refOld, children: childrenOld, ...restOld } = prevProps;
+  const { attach: attachNew, object: objectNew, script: scriptNew, ref: refNew, children: childrenNew, ...restNew } = nextProps;
+  if (attachOld !== attachNew)
+    throw new Error(`Cannot change attachment ${attachOld} to ${attachNew}`);
+  if (objectOld !== objectNew)
+    throw new Error(`Cannot change the \`object\` of a mounted instance (${objectOld} -> ${objectNew}); remount with a new key`);
+  if (scriptOld !== scriptNew)
+    throw new Error(`Cannot change the \`script\` of a mounted instance (${scriptOld} -> ${scriptNew}); remount with a new key`);
+
+  const toText = (c: unknown) => Array.isArray(c) ? c.join('') : c as string;
+  if (shouldSetTextContent(type, prevProps)) restOld['text'] = toText(childrenOld);
+  if (shouldSetTextContent(type, nextProps)) restNew['text'] = toText(childrenNew);
+
+  for (const [key, oldVal] of Object.entries(restOld)) {
+    const newVal = restNew[key];
+    if (isEqual(oldVal, newVal))
+      delete restNew[key];
+    else if (newVal === undefined)
+      restNew[key] = undefined;
+  }
+
+  Instance.assign(instance, restNew);
+}
+
+export function hideInstance(instance: Instance | TextInstance): void {
+  instance.set('visible', false);
+}
+
+export const hideTextInstance = hideInstance;
+
+export function unhideInstance(instance: Instance | TextInstance): void {
+  instance.set('visible', true);
+}
+
+export const unhideTextInstance = unhideInstance;
+
+export function clearContainer(container: Container): void {
+  // No-op: Godot containers (e.g. the SceneTree root) can hold non-React
+  // children such as portal targets. The reconciler calls this on every
+  // initial mount; queue-freeing the container's children here would destroy
+  // those foreign nodes and leave React fibers referencing freed instances.
+  // React-managed children are removed by the reconciler's deletion path.
+}
+