@usenagi/core 0.2.0 → 0.4.0

package/types/core/component.d.ts

@@ -1,28 +1,15 @@
-import type { ComponentSetup, RefElement } from "../types";
-export declare enum LifecycleHooks {
-    MOUNTED = "Mounted",
-    UNMOUNTED = "Unmounted"
-}
-export declare class ComponentContext<T = any> {
-    #private;
-    private [LifecycleHooks.MOUNTED];
-    private [LifecycleHooks.UNMOUNTED];
-    parent: ComponentContext<T> | null;
-    readonly uid: string;
-    readonly name: string;
-    current: ReturnType<ComponentSetup<T>["setup"]>;
-    props: Parameters<ComponentSetup<T>["setup"]>[1];
-    element: RefElement;
-    provides: Map<symbol, unknown>;
-    constructor(element: RefElement, name: string);
-    onMount: () => void;
-    onUnmount: () => void;
-    addChild: (child: ComponentContext) => void;
-    removeChild: (child: ComponentContext) => void;
-    get childElements(): RefElement[];
-}
-export declare function defineComponent<Context extends Record<string, unknown>>(): <SetupResult extends Record<string, unknown> | void>(opts: {
+import type { ComponentProps, ComponentSetup, RefElement } from "../types";
+export declare function defineComponent<SetupResult extends Record<string, unknown> | void, Props extends Record<string, unknown>>(opts: {
     name: string;
-    setup(el: RefElement, context: Context): SetupResult;
-}) => (context: Context) => ComponentSetup<SetupResult>;
-export declare function defineComponent<SetupResult extends Record<string, unknown> | void, Props extends Record<string, unknown>>(opts: ComponentSetup<SetupResult, Props>): ComponentSetup<SetupResult, Props>;
+    props: Props;
+    setup(el: RefElement, props: ComponentProps<Props>): SetupResult;
+}): ComponentSetup<SetupResult, Props>;
+export declare function defineComponent<SetupResult extends Record<string, unknown> | void, Props extends Record<string, unknown>>(opts: {
+    name: string;
+    setup(el: RefElement, props: ComponentProps<Props>): SetupResult;
+}): ComponentSetup<SetupResult, Props>;
+export declare function defineComponent<SetupResult extends Record<string, unknown> | void>(opts: {
+    name: string;
+    setup(el: RefElement): SetupResult;
+}): ComponentSetup<SetupResult, Record<string, never>>;
+export declare function defineComponent(opts: ComponentSetup): ComponentSetup;

package/types/core/error.d.ts

@@ -1,5 +1,5 @@
 import type { RefElement } from "../types";
-import type { ComponentContext } from "./component";
+import type { ComponentContextImpl } from "./_internal/component";
 export type LifecycleErrorDetails = {
     phase: "setup" | "mount" | "unmount" | "removeChild";
     name: string;
@@ -11,10 +11,9 @@ export type LifecycleErrorDetails = {
     props?: unknown;
     cause: unknown;
 };
-export declare function traceComponentTree(context: ComponentContext): string;
 export declare class LifecycleError extends Error {
     readonly details: LifecycleErrorDetails;
     constructor(details: LifecycleErrorDetails);
-    static create(phase: LifecycleErrorDetails["phase"], target: ComponentContext, cause: unknown, parent?: ComponentContext | null | undefined, extra?: Partial<LifecycleErrorDetails>): LifecycleError;
+    static create(phase: LifecycleErrorDetails["phase"], target: ComponentContextImpl, cause: unknown, parent?: ComponentContextImpl | null | undefined, extra?: Partial<LifecycleErrorDetails>): LifecycleError;
 }
 export declare function isLifecycleError(error: unknown): error is LifecycleError;

package/types/core/props.d.ts

@@ -0,0 +1,2 @@
+/** Type-only marker for component props. Runtime value is unused. */
+export declare function propTypes<T extends Record<string, unknown>>(): T;

package/types/core/runtime.d.ts

@@ -1,4 +1,5 @@
-import { ComponentContext } from "./component";
+import { ComponentContextImpl } from "./_internal/component";
 import type { ComponentSetup, RefElement } from "../types";
-export declare function getCurrentComponent(hookName: string): ComponentContext;
-export declare function createComponent(wrap: ComponentSetup, root: RefElement, props: Record<string, any>): ComponentContext<any>;
+declare function getCurrentComponent(hookName: string): ComponentContextImpl;
+declare function createComponent<S extends ComponentSetup>(wrap: S, root: RefElement, props?: Record<string, any>): ComponentContextImpl<ReturnType<S["setup"]>>;
+export {};

package/types/hooks/{useDomRef.d.ts → core/useDomRef.d.ts}

@@ -1,4 +1,4 @@
-import type { RefElement } from "../types";
+import type { RefElement } from "../../types";
 export declare function useDomRef<T extends Record<string, RefElement | RefElement[] | null>>(): {
     refs: T;
 };

package/types/hooks/core/useSlot.d.ts

@@ -0,0 +1,5 @@
+import type { ComponentContext, ComponentSetup, ExposedSetup, RefElement } from "../../types";
+export declare function useSlot(): {
+    addChild<Child extends ComponentSetup>(targetOrTargets: RefElement | RefElement[], child: Child, props?: Partial<Parameters<Child["setup"]>[1]>): ComponentContext<ExposedSetup<ReturnType<Child["setup"]>>>[];
+    removeChild(children: ComponentContext[]): void;
+};

package/types/main.d.ts

@@ -1,16 +1,18 @@
+export { defineAddon } from "./core/addon";
 export { create } from "./core/app";
 export { defineComponent } from "./core/component";
+export { createContext, withContext } from "./core/context";
 export { isLifecycleError, LifecycleError } from "./core/error";
 export { useMount, useUnmount } from "./core/lifecycle";
+export { propTypes } from "./core/props";
 export { readonly, signal, useComputed, useWatch } from "./core/reactivity";
-export { createContext, withContext } from "./hooks/createContext";
-export { useDomRef } from "./hooks/useDomRef";
+export { useDomRef } from "./hooks/core/useDomRef";
+export { useSlot } from "./hooks/core/useSlot";
 export { useEvent } from "./hooks/useEvent";
 export { useIntersectionWatch } from "./hooks/useIntersectionWatch";
 export { useMediaQuery } from "./hooks/useMediaQuery";
-export { useSlot } from "./hooks/useSlot";
-export type { ComponentContext } from "./core/component";
+export type { Addon, AddonContext, MountOptions } from "./core/addon";
+export type { Provider } from "./core/context";
 export type { LifecycleErrorDetails } from "./core/error";
 export type { ReadonlySignal, Signal } from "./core/reactivity";
-export type { Provider } from "./hooks/createContext";
-export type { ComponentSetup, Cue, IComponent, RefElement, SchedulePriority, Scheduler, } from "./types";
+export type { Cleanup, ComponentContext, ComponentSetup, Cue, RefElement, SchedulePriority, } from "./types";

package/types/types.d.ts

@@ -1,18 +1,20 @@
 export type RefElement = HTMLElement | SVGElement;
 export type ComponentProps<Props> = Readonly<Props>;
-export type ComponentSetup<SetupResult = void | Record<string, unknown>, Props = Record<string, unknown>> = {
+type IsAny<T> = 0 extends 1 & T ? true : false;
+/** Normalize the return value of setup to the type stored in `current` (void / undefined → empty object). */
+export type ExposedSetup<T> = IsAny<T> extends true ? Record<string, unknown> : [T] extends [void | undefined] ? Record<string, never> : T extends Record<string, unknown> ? T : Record<string, never>;
+export type ComponentSetup<SetupResult = void | Record<string, unknown>, Props extends Record<string, unknown> = Record<string, unknown>> = {
     name: string;
     setup(el: RefElement, props: ComponentProps<Props>): SetupResult;
 };
-/** @deprecated Use `ComponentSetup` instead. */
-export type IComponent<SetupResult = void | Record<string, unknown>, Props = Record<string, unknown>> = ComponentSetup<SetupResult, Props>;
+/** Mounted component instance exposed to app / hook callers. */
+export type ComponentContext<Exposed extends Record<string, unknown> = Record<string, never>> = {
+    readonly current: Exposed;
+    readonly element: RefElement;
+    readonly name: string;
+};
 export type Cleanup = () => void;
 export type LifecycleHandler = () => void | Cleanup;
 export type SchedulePriority = "user-blocking" | "user-visible" | "background";
-export type Scheduler = {
-    schedule(task: () => void, options?: {
-        priority?: SchedulePriority;
-        signal?: AbortSignal;
-    }): void;
-};
 export type Cue = (el: RefElement, signal: AbortSignal) => Promise<void>;
+export {};

package/types/addons/scheduler/task.d.ts

@@ -1,2 +0,0 @@
-import type { SchedulePriority } from "../../types";
-export declare function scheduleTask(task: () => void, priority: SchedulePriority, signal?: AbortSignal): void;

package/types/core/internal/pending.d.ts

@@ -1,11 +0,0 @@
-import type { RefElement } from "../../types";
-export type PendingMountTask = {
-    readonly signal: AbortSignal;
-    complete(): boolean;
-    abort(): void;
-};
-export type PendingMountTasks = {
-    add(el: RefElement): PendingMountTask;
-    abort(el: RefElement): void;
-};
-export declare function createPendingMountTasks(): PendingMountTasks;

package/types/core/internal/registry.d.ts

@@ -1,4 +0,0 @@
-import type { RefElement } from "../../types";
-import type { ComponentContext } from "../component";
-export declare const DOM_COMPONENT_INSTANCE: WeakMap<RefElement, ComponentContext<any>>;
-export declare function bindDOMNodeToComponent(el: RefElement, component: ComponentContext): void;

package/types/hooks/domRefs.d.ts

@@ -1,2 +0,0 @@
-import type { RefElement } from "../types";
-export declare function domRefs<T extends Record<string, RefElement | RefElement[] | null>>(scope: RefElement, getBoundaries: () => RefElement[]): T;

package/types/hooks/useSlot.d.ts

@@ -1,6 +0,0 @@
-import type { ComponentContext } from "../core/component";
-import type { ComponentSetup, RefElement } from "../types";
-export declare function useSlot(): {
-    addChild<Child extends ComponentSetup>(targetOrTargets: RefElement | RefElement[], child: Child, props?: Parameters<Child["setup"]>[1]): ComponentContext<ReturnType<Child["setup"]>>[];
-    removeChild(children: ComponentContext[]): void;
-};

package/types/utils/isAbortError.d.ts

@@ -1 +0,0 @@
-export declare function isAbortError(error: unknown): boolean;