@ringozz/react-godot 1.0.0-4 → 1.0.0-5

package/src/react-hooks.ts

@@ -1,22 +1,25 @@
-/**********************************************************************
- Copyright (c) Vladimir Davidovich. All rights reserved.
-***********************************************************************/
-
-import type { Signal } from '@ringozz/godot';
-import type React from 'react';
-import { useEffect, useRef } from 'react';
-
-export function useMutableCallback<T>(fn: T): React.RefObject<T> {
-  const ref = useRef<T>(fn);
-  useEffect(() => void (ref.current = fn), [fn]);
-  return ref;
-}
-
-export function useSignal<T extends (...args: any[]) => any>(signal: Signal<T>, handler: T): void {
-  const ref = useMutableCallback(handler);
-  useEffect(() => {
-    const fn = ((...args: any[]) => ref.current(...args)) as T;
-    signal.connect(fn);
-    return () => signal.disconnect(fn);
-  }, [signal.getObjectId(), signal.getName()]);
-}
+/**********************************************************************
+ Copyright (c) Vladimir Davidovich. All rights reserved.
+***********************************************************************/
+
+import type { Signal } from '@ringozz/godot';
+import type React from 'react';
+import { useEffect, useRef } from 'react';
+
+export function useMutableCallback<T>(fn: T): React.RefObject<T> {
+  const ref = useRef<T>(fn);
+  useEffect(() => void (ref.current = fn), [fn]);
+  return ref;
+}
+
+export function useSignal<T extends (...args: any[]) => any>(signal: Signal<T>, handler: T): void {
+  const ref = useMutableCallback(handler);
+  useEffect(() => {
+    const fn = ((...args: any[]) => ref.current(...args)) as T;
+    signal.connect(fn);
+    return () => signal.disconnect(fn);
+  // do not specify 'signal' dependency, because it changes often.
+  // specify invariant contents instead.
+  /* oxlint-disable-next-line react-hooks/exhaustive-deps */
+  }, [signal.getObjectId(), signal.getName()]);
+}

package/src/react-jsx.ts

@@ -1,41 +1,45 @@
-/**********************************************************************
- Copyright (c) Vladimir Davidovich. All rights reserved.
-***********************************************************************/
-
-import { jsxDEV as reactJsxDEV } from 'react/jsx-dev-runtime';
-import type * as ReactJSX from 'react/jsx-runtime';
-import { Fragment, jsx as reactJsx, jsxs as reactJsxs } from 'react/jsx-runtime';
-import type { ComponentProps, Instance } from './react-types.ts';
-import { GodotVar } from '@ringozz/godot/runtime';
-
-export function jsx(type: any, props?: any, key?: any) {
-  return reactJsx(GodotVar.isPrototypeOf(type) ? type.name : type, props, key);
-}
-
-export function jsxs(type: any, props?: any, key?: any) {
-  return reactJsxs(GodotVar.isPrototypeOf(type) ? type.name : type, props, key);
-}
-
-export function jsxDEV(type: any, props?: any, key?: any, isStatic?: any, source?: any, self?: any) {
-  return reactJsxDEV(GodotVar.isPrototypeOf(type) ? type.name : type, props, key, isStatic, source, self);
-}
-
-export { Fragment };
-
-declare module '@ringozz/react-godot/jsx-runtime' {
-  export namespace JSX {
-    interface IntrinsicElements extends ReactJSX.JSX.IntrinsicElements { }
-    interface Element extends ReactJSX.JSX.Element { }
-
-    type GodotConstructor = { new(...args: any[]): Instance } & Function;
-
-    type ElementType =
-      | ReactJSX.JSX.ElementType
-      | GodotConstructor;
-
-    type LibraryManagedAttributes<C, P> =
-      C extends GodotConstructor
-      ? ComponentProps<C>
-      : ReactJSX.JSX.LibraryManagedAttributes<C, P>;
-  }
-}
+/**********************************************************************
+ Copyright (c) Vladimir Davidovich. All rights reserved.
+***********************************************************************/
+
+import { jsxDEV as reactJsxDEV } from 'react/jsx-dev-runtime';
+import type * as ReactJSX from 'react/jsx-runtime';
+import { Fragment, jsx as reactJsx, jsxs as reactJsxs } from 'react/jsx-runtime';
+import type { ComponentProps, GodotConstructor } from './react-types.ts';
+import { GodotVar } from '@ringozz/godot/runtime';
+
+export function jsx(type: any, props?: any, key?: any) {
+  return reactJsx(GodotVar.isPrototypeOf(type) ? type.name : type, props, key);
+}
+
+export function jsxs(type: any, props?: any, key?: any) {
+  return reactJsxs(GodotVar.isPrototypeOf(type) ? type.name : type, props, key);
+}
+
+export function jsxDEV(type: any, props?: any, key?: any, isStatic?: any, source?: any, self?: any) {
+  return reactJsxDEV(GodotVar.isPrototypeOf(type) ? type.name : type, props, key, isStatic, source, self);
+}
+
+export { Fragment };
+
+// JSX namespace augmentation: these types are the public JSX contract for the
+// `@ringozz/react-godot/jsx-runtime` import source, consumed by TypeScript in
+// consumer files. They are intentionally not referenced within this module.
+/* oxlint-disable no-unused-vars */
+declare module '@ringozz/react-godot/jsx-runtime' {
+  export namespace JSX {
+    interface IntrinsicAttributes extends ReactJSX.JSX.IntrinsicAttributes { }
+    interface IntrinsicElements extends ReactJSX.JSX.IntrinsicElements { }
+    interface Element extends ReactJSX.JSX.Element { }
+
+    type ElementType =
+      | ReactJSX.JSX.ElementType
+      | GodotConstructor;
+
+    type LibraryManagedAttributes<C, P> =
+      C extends GodotConstructor
+      ? ComponentProps<C>
+      : ReactJSX.JSX.LibraryManagedAttributes<C, P>;
+  }
+}
+/* oxlint-enable no-unused-vars */

package/src/react-types.ts

@@ -1,36 +1,39 @@
-/**********************************************************************
- Copyright (c) Vladimir Davidovich. All rights reserved.
-***********************************************************************/
-
-import type React from 'react';
-import type { Object } from '@ringozz/godot/Object';
-import type { ValueTypes } from '@ringozz/godot';
-
-type FunctionKeys<T> = { [K in keyof T]: T[K] extends Function ? K : never }[keyof T];
-type Properties<T> = Omit<T, FunctionKeys<T>>;
-type Overwrite<P, O> = Properties<P> & O;
-type Mutable<P> = { [K in keyof P]: P[K] | Readonly<P[K]> };
-type ConstructorRepresentation<T = any> = new (...args: any[]) => T;
-
-export type Instance = Object;
-
-export type InstanceProps<T extends Instance = Instance> = {
-  /** An existing instance to render instead of creating a new one. */
-  object?: T;
-  /** Attaches the element to a named property of the parent instead of adding it as a child. */
-  attach?: string;
-};
-
-type ReactProps<P> = React.PropsWithChildren<React.RefAttributes<P>>;
-
-type WidenVT<T> = {
-  [K in keyof T]: T[K] extends ValueTypes ? T[K] | number[] : T[K];
-};
-
-type ElementProps<T extends ConstructorRepresentation, P = InstanceType<T>> = Partial<
-  Overwrite<WidenVT<P>, ReactProps<P>>
->;
-
-export type ComponentProps<T extends ConstructorRepresentation> = Mutable<
-  Overwrite<ElementProps<T>, Omit<InstanceProps<InstanceType<T>>, 'object'>>
->;
+/**********************************************************************
+ Copyright (c) Vladimir Davidovich. All rights reserved.
+***********************************************************************/
+
+import type React from 'react';
+import type { Object } from '@ringozz/godot/Object';
+import type { ValueTypes } from '@ringozz/godot';
+import type { PackedScene } from '@ringozz/godot/PackedScene';
+
+type FunctionKeys<T> = { [K in keyof T]: T[K] extends Function ? K : never }[keyof T];
+type Properties<T> = Omit<T, FunctionKeys<T>>;
+type Overwrite<P, O> = Properties<P> & O;
+type Mutable<P> = { [K in keyof P]: P[K] | Readonly<P[K]> };
+type ConstructorRepresentation<T = any> = new (...args: any[]) => T;
+
+export type Instance = Object;
+
+export type GodotConstructor<T extends Instance = Instance> = ConstructorRepresentation<T> & Function;
+
+export type InstanceProps<T extends Instance = Instance> = {
+  /** An existing instance to render instead of creating a new one. */
+  object?: T | PackedScene;
+  /** Attaches the element to a named property of the parent instead of adding it as a child. */
+  attach?: string;
+};
+
+type ReactProps<P> = React.PropsWithChildren<React.RefAttributes<P>>;
+
+type WidenVT<T> = {
+  [K in keyof T]: T[K] extends ValueTypes ? T[K] | number[] : T[K];
+};
+
+type ElementProps<T extends GodotConstructor, P = InstanceType<T>> = Partial<
+  Overwrite<WidenVT<P>, ReactProps<P>>
+>;
+
+export type ComponentProps<T extends GodotConstructor> = Mutable<
+  Overwrite<ElementProps<T>, InstanceProps<InstanceType<T>>>
+>;