essor 0.0.6-beta.9 → 0.0.6

package/dist/essor.d.cts

@@ -1,19 +1,41 @@
+import { ExcludeType } from 'essor-shared';
 import * as csstype from 'csstype';
 
+declare const __essor_version = "0.0.6-beta.16";
+
 type EffectFn = () => void;
+/**
+ * Signal class representing a reactive value.
+ */
 declare class Signal$1<T> {
     private _value;
+    private _reactive;
+    private __activeEffect;
     constructor(value: T);
     valueOf(): T;
     toString(): string;
     toJSON(): T;
     get value(): T;
+    __triggerObject(): void;
     set value(newValue: T);
     peek(): T;
     update(): void;
 }
+/**
+ * Creates a Signal object.
+ * @param value - The initial value for the Signal.
+ * @returns A Signal object.
+ */
 declare function useSignal<T>(value?: T): Signal$1<T>;
+/**
+ * Checks if a value is a Signal.
+ * @param value - The value to check.
+ * @returns True if the value is a Signal, otherwise false.
+ */
 declare function isSignal<T>(value: any): value is Signal$1<T>;
+/**
+ * Computed class representing a computed reactive value.
+ */
 declare class Computed<T> {
     private readonly fn;
     private _value;
@@ -23,31 +45,60 @@ declare class Computed<T> {
     run(): void;
     get value(): T;
 }
+/**
+ * Creates a Computed object.
+ * @param fn - The function to compute the value.
+ * @returns A Computed object.
+ */
 declare function useComputed<T>(fn: () => T): Computed<T>;
+/**
+ * Checks if a value is a Computed object.
+ * @param value - The value to check.
+ * @returns True if the value is a Computed object, otherwise false.
+ */
 declare function isComputed<T>(value: any): value is Computed<T>;
+/**
+ * Registers an effect function that runs whenever its dependencies change.
+ * @param fn - The effect function to register.
+ * @returns A function to unregister the effect.
+ */
 declare function useEffect(fn: EffectFn): () => void;
 type SignalObject<T> = {
     [K in keyof T]: Signal$1<T[K]> | T[K];
 };
 /**
  * Creates a SignalObject from the given initialValues, excluding specified keys.
- *
- * @param {T extends Object} initialValues - The initial values for the SignalObject.
- * @param {(key: string) => boolean | string[]} exclude - A function that determines which keys to exclude from the SignalObject.
- * @return {SignalObject<T>} The created SignalObject.
+ * @param initialValues - The initial values for the SignalObject.
+ * @param exclude - A function or array that determines which keys to exclude from the SignalObject.
+ * @returns The created SignalObject.
  */
-declare function signalObject<T extends object>(initialValues: T, exclude?: ((key: string) => boolean) | string[]): SignalObject<T>;
+declare function signalObject<T extends object>(initialValues: T, exclude?: ExcludeType): SignalObject<T>;
 /**
  * Returns the current value of a signal, signal object, or plain object, excluding specified keys.
- *
- * @param {SignalObject<T> | T | Signal<T>} signal - The signal, signal object, or plain object to unwrap.
- * @param {(key: string) => boolean | string[]} [exclude] - A function that determines which keys to exclude from the unwrapped object.
- * @return {T} The unwrapped value of the signal, signal object, or plain object.
+ * @param signal - The signal, signal object, or plain object to unwrap.
+ * @param exclude - A function or array that determines which keys to exclude from the unwrapped object.
+ * @returns The unwrapped value of the signal, signal object, or plain object.
+ */
+declare function unSignal<T>(signal: SignalObject<T> | T | Signal$1<T>, exclude?: ExcludeType): T;
+/**
+ * Checks if an object is reactive.
+ * @param obj - The object to check.
+ * @returns True if the object is reactive, otherwise false.
+ */
+declare function isReactive(obj: any): boolean;
+/**
+ * Creates a shallow copy of a reactive object.
+ * @param obj - The reactive object to copy.
+ * @returns A shallow copy of the reactive object.
  */
-declare function unSignal<T>(signal: SignalObject<T> | T | Signal$1<T>, exclude?: ((key: string) => boolean) | string[]): T;
-declare function isReactive(obj: any): any;
 declare function unReactive(obj: any): any;
-declare function useReactive<T extends object>(initialValue: T): T;
+/**
+ * Creates a reactive object.
+ * @param initialValue - The initial value for the reactive object.
+ * @param exclude - A function or array that determines which keys to exclude from the reactive object.
+ * @returns A reactive object.
+ */
+declare function useReactive<T extends object>(initialValue: T, exclude?: ExcludeType): T;
 
 type WatchSource<T = any> = Signal$1<T> | Computed<T> | (() => T);
 type WatchCallback<V = any, OV = any> = (value: V, oldValue: OV) => any;
@@ -94,8 +145,9 @@ interface Output<T> {
   type: 'output';
 }
 
-type EssorComponent = (props: Record<string, unknown>) => TemplateNode;
-type Hook$1 = 'destroy' | 'create' | 'mounted' | 'update';
+type EssorComponent = (props: Record<string, unknown>) => JSX.Element | TemplateNode;
+type Hook$1 = 'mounted' | 'destroy';
+
 interface NodeTrack {
   cleanup: () => void;
   isRoot?: boolean;
@@ -266,9 +318,6 @@ declare global {
     }
     interface CustomAttributes<T> {
       ref?: Signal<T> | ((el: T) => void);
-      classList?: {
-        [k: string]: boolean | undefined;
-      };
       key?: string | number | symbol;
     }
     type Accessor<T> = () => T;
@@ -276,7 +325,11 @@ declare global {
     interface DirectiveFunctions {
       [x: string]: (el: DOMElement, accessor: Accessor<any>) => void;
     }
-    interface ExplicitProperties {}
+    interface ExplicitProperties<T> {
+      value: Signal<T>;
+      updateValue: (value: T) => void;
+    }
+
     interface ExplicitAttributes {}
     interface CustomEvents {}
     interface CustomCaptureEvents {}
@@ -286,12 +339,12 @@ declare global {
         CustomCaptureEvents[Key]
       >;
     };
-    type BindAttributes = {
-      [Key in string | number | symbol as `bind:${Key}`]?: ExplicitAttributes[Key];
+    type PropAttributes<T> = {
+      [Key in keyof ExplicitProperties]?: ExplicitProperties<T>[Key];
     };
     interface DOMAttributes<T>
       extends CustomAttributes<T>,
-        BindAttributes,
+        PropAttributes<T>,
         OnCaptureAttributes<T>,
         CustomEventHandlersCamelCase<T>,
         CustomEventHandlersLowerCase<T> {
@@ -2299,7 +2352,7 @@ declare global {
   }
 }
 
-declare class TemplateNode implements JSX.Element {
+declare class TemplateNode$1 implements JSX.Element {
     template: HTMLTemplateElement;
     props: Record<string, unknown>;
     key?: string | undefined;
@@ -2319,7 +2372,7 @@ declare class TemplateNode implements JSX.Element {
     mapNodeTree(parent: Node, tree: Node): void;
     patchNodes(props: any): void;
     getNodeTrack(trackKey: string, trackLastNodes?: boolean, isRoot?: boolean): NodeTrack;
-    inheritNode(node: TemplateNode): void;
+    inheritNode(node: TemplateNode$1): void;
     patchNode(key: any, node: any, props: any, isRoot: any): void;
 }
 
@@ -2338,7 +2391,7 @@ declare class ComponentNode$1 implements JSX.Element {
     context: Record<symbol | string | number, any>;
     emitter: Set<Function>;
     mounted: boolean;
-    rootNode: TemplateNode | null;
+    rootNode: TemplateNode$1 | null;
     hooks: Record<Hook, Set<() => void>>;
     private trackMap;
     get firstChild(): Node | null;
@@ -2353,7 +2406,7 @@ declare class ComponentNode$1 implements JSX.Element {
     patchProps(props: Record<string, any>): void;
 }
 
-declare function h(template: EssorComponent | HTMLTemplateElement, props: Record<string, any>, key?: string): JSX.Element;
+declare function h<K extends keyof HTMLElementTagNameMap>(_template: EssorComponent | HTMLTemplateElement | K, props: Record<string, any>, key?: string): JSX.Element;
 declare function isJsxElement(node: unknown): node is EssorNode;
 declare function template(html: string): HTMLTemplateElement;
 declare function Fragment(props: {
@@ -2379,20 +2432,15 @@ declare function useRef<T>(): {
     current: T | null;
 };
 
-declare const __essor_version = "0.0.6-beta.8";
-
-interface TemplateMap {
-    [key: number]: {
-        template: string;
-        prop?: Record<string, any>;
-    };
-}
 type Props = Record<string, any>;
-declare function ssrtmpl(templates?: string[]): TemplateMap;
-declare function ssr(template: TemplateMap | EssorNode | ((props: Props) => string), props: Props): string;
+declare function renderTemplate(template: string[] | EssorNode | Function, props: Props): string;
+/**
+ * Renders the component to a string.
+ * @param component - The component function.
+ * @param props - The properties to pass to the component.
+ * @returns The rendered component as a string.
+ */
 declare function renderToString(component: (...args: any[]) => string, props: Props): string;
-declare function ssgRender(component: {
-    mount: (root: HTMLElement) => void;
-}, root: HTMLElement): void;
+declare function ssgRender(component: any, root: HTMLElement, props?: Props): void;
 
-export { ComponentNode$1 as ComponentNode, Computed, type EssorComponent, type EssorNode, Fragment, type Hook$1 as Hook, type InjectionKey, type NodeTrack, type Output, Signal$1 as Signal, type StoreActions, TemplateNode, __essor_version, createStore, h, isComputed, isJsxElement, isReactive, isSignal, nextTick, onDestroy, onMount, renderToString, signalObject, ssgRender, ssr, ssrtmpl, template, unReactive, unSignal, useComputed, useEffect, useInject, useProvide, useReactive, useRef, useSignal, useWatch };
+export { ComponentNode$1 as ComponentNode, Computed, type EssorComponent, type EssorNode, Fragment, type Hook$1 as Hook, type InjectionKey, type NodeTrack, type Output, Signal$1 as Signal, type StoreActions, TemplateNode$1 as TemplateNode, __essor_version, createStore, h, isComputed, isJsxElement, isReactive, isSignal, nextTick, onDestroy, onMount, renderTemplate, renderToString, signalObject, ssgRender, template, unReactive, unSignal, useComputed, useEffect, useInject, useProvide, useReactive, useRef, useSignal, useWatch };

package/dist/essor.d.ts

@@ -1,19 +1,41 @@
+import { ExcludeType } from 'essor-shared';
 import * as csstype from 'csstype';
 
+declare const __essor_version = "0.0.6-beta.16";
+
 type EffectFn = () => void;
+/**
+ * Signal class representing a reactive value.
+ */
 declare class Signal$1<T> {
     private _value;
+    private _reactive;
+    private __activeEffect;
     constructor(value: T);
     valueOf(): T;
     toString(): string;
     toJSON(): T;
     get value(): T;
+    __triggerObject(): void;
     set value(newValue: T);
     peek(): T;
     update(): void;
 }
+/**
+ * Creates a Signal object.
+ * @param value - The initial value for the Signal.
+ * @returns A Signal object.
+ */
 declare function useSignal<T>(value?: T): Signal$1<T>;
+/**
+ * Checks if a value is a Signal.
+ * @param value - The value to check.
+ * @returns True if the value is a Signal, otherwise false.
+ */
 declare function isSignal<T>(value: any): value is Signal$1<T>;
+/**
+ * Computed class representing a computed reactive value.
+ */
 declare class Computed<T> {
     private readonly fn;
     private _value;
@@ -23,31 +45,60 @@ declare class Computed<T> {
     run(): void;
     get value(): T;
 }
+/**
+ * Creates a Computed object.
+ * @param fn - The function to compute the value.
+ * @returns A Computed object.
+ */
 declare function useComputed<T>(fn: () => T): Computed<T>;
+/**
+ * Checks if a value is a Computed object.
+ * @param value - The value to check.
+ * @returns True if the value is a Computed object, otherwise false.
+ */
 declare function isComputed<T>(value: any): value is Computed<T>;
+/**
+ * Registers an effect function that runs whenever its dependencies change.
+ * @param fn - The effect function to register.
+ * @returns A function to unregister the effect.
+ */
 declare function useEffect(fn: EffectFn): () => void;
 type SignalObject<T> = {
     [K in keyof T]: Signal$1<T[K]> | T[K];
 };
 /**
  * Creates a SignalObject from the given initialValues, excluding specified keys.
- *
- * @param {T extends Object} initialValues - The initial values for the SignalObject.
- * @param {(key: string) => boolean | string[]} exclude - A function that determines which keys to exclude from the SignalObject.
- * @return {SignalObject<T>} The created SignalObject.
+ * @param initialValues - The initial values for the SignalObject.
+ * @param exclude - A function or array that determines which keys to exclude from the SignalObject.
+ * @returns The created SignalObject.
  */
-declare function signalObject<T extends object>(initialValues: T, exclude?: ((key: string) => boolean) | string[]): SignalObject<T>;
+declare function signalObject<T extends object>(initialValues: T, exclude?: ExcludeType): SignalObject<T>;
 /**
  * Returns the current value of a signal, signal object, or plain object, excluding specified keys.
- *
- * @param {SignalObject<T> | T | Signal<T>} signal - The signal, signal object, or plain object to unwrap.
- * @param {(key: string) => boolean | string[]} [exclude] - A function that determines which keys to exclude from the unwrapped object.
- * @return {T} The unwrapped value of the signal, signal object, or plain object.
+ * @param signal - The signal, signal object, or plain object to unwrap.
+ * @param exclude - A function or array that determines which keys to exclude from the unwrapped object.
+ * @returns The unwrapped value of the signal, signal object, or plain object.
+ */
+declare function unSignal<T>(signal: SignalObject<T> | T | Signal$1<T>, exclude?: ExcludeType): T;
+/**
+ * Checks if an object is reactive.
+ * @param obj - The object to check.
+ * @returns True if the object is reactive, otherwise false.
+ */
+declare function isReactive(obj: any): boolean;
+/**
+ * Creates a shallow copy of a reactive object.
+ * @param obj - The reactive object to copy.
+ * @returns A shallow copy of the reactive object.
  */
-declare function unSignal<T>(signal: SignalObject<T> | T | Signal$1<T>, exclude?: ((key: string) => boolean) | string[]): T;
-declare function isReactive(obj: any): any;
 declare function unReactive(obj: any): any;
-declare function useReactive<T extends object>(initialValue: T): T;
+/**
+ * Creates a reactive object.
+ * @param initialValue - The initial value for the reactive object.
+ * @param exclude - A function or array that determines which keys to exclude from the reactive object.
+ * @returns A reactive object.
+ */
+declare function useReactive<T extends object>(initialValue: T, exclude?: ExcludeType): T;
 
 type WatchSource<T = any> = Signal$1<T> | Computed<T> | (() => T);
 type WatchCallback<V = any, OV = any> = (value: V, oldValue: OV) => any;
@@ -94,8 +145,9 @@ interface Output<T> {
   type: 'output';
 }
 
-type EssorComponent = (props: Record<string, unknown>) => TemplateNode;
-type Hook$1 = 'destroy' | 'create' | 'mounted' | 'update';
+type EssorComponent = (props: Record<string, unknown>) => JSX.Element | TemplateNode;
+type Hook$1 = 'mounted' | 'destroy';
+
 interface NodeTrack {
   cleanup: () => void;
   isRoot?: boolean;
@@ -266,9 +318,6 @@ declare global {
     }
     interface CustomAttributes<T> {
       ref?: Signal<T> | ((el: T) => void);
-      classList?: {
-        [k: string]: boolean | undefined;
-      };
       key?: string | number | symbol;
     }
     type Accessor<T> = () => T;
@@ -276,7 +325,11 @@ declare global {
     interface DirectiveFunctions {
       [x: string]: (el: DOMElement, accessor: Accessor<any>) => void;
     }
-    interface ExplicitProperties {}
+    interface ExplicitProperties<T> {
+      value: Signal<T>;
+      updateValue: (value: T) => void;
+    }
+
     interface ExplicitAttributes {}
     interface CustomEvents {}
     interface CustomCaptureEvents {}
@@ -286,12 +339,12 @@ declare global {
         CustomCaptureEvents[Key]
       >;
     };
-    type BindAttributes = {
-      [Key in string | number | symbol as `bind:${Key}`]?: ExplicitAttributes[Key];
+    type PropAttributes<T> = {
+      [Key in keyof ExplicitProperties]?: ExplicitProperties<T>[Key];
     };
     interface DOMAttributes<T>
       extends CustomAttributes<T>,
-        BindAttributes,
+        PropAttributes<T>,
         OnCaptureAttributes<T>,
         CustomEventHandlersCamelCase<T>,
         CustomEventHandlersLowerCase<T> {
@@ -2299,7 +2352,7 @@ declare global {
   }
 }
 
-declare class TemplateNode implements JSX.Element {
+declare class TemplateNode$1 implements JSX.Element {
     template: HTMLTemplateElement;
     props: Record<string, unknown>;
     key?: string | undefined;
@@ -2319,7 +2372,7 @@ declare class TemplateNode implements JSX.Element {
     mapNodeTree(parent: Node, tree: Node): void;
     patchNodes(props: any): void;
     getNodeTrack(trackKey: string, trackLastNodes?: boolean, isRoot?: boolean): NodeTrack;
-    inheritNode(node: TemplateNode): void;
+    inheritNode(node: TemplateNode$1): void;
     patchNode(key: any, node: any, props: any, isRoot: any): void;
 }
 
@@ -2338,7 +2391,7 @@ declare class ComponentNode$1 implements JSX.Element {
     context: Record<symbol | string | number, any>;
     emitter: Set<Function>;
     mounted: boolean;
-    rootNode: TemplateNode | null;
+    rootNode: TemplateNode$1 | null;
     hooks: Record<Hook, Set<() => void>>;
     private trackMap;
     get firstChild(): Node | null;
@@ -2353,7 +2406,7 @@ declare class ComponentNode$1 implements JSX.Element {
     patchProps(props: Record<string, any>): void;
 }
 
-declare function h(template: EssorComponent | HTMLTemplateElement, props: Record<string, any>, key?: string): JSX.Element;
+declare function h<K extends keyof HTMLElementTagNameMap>(_template: EssorComponent | HTMLTemplateElement | K, props: Record<string, any>, key?: string): JSX.Element;
 declare function isJsxElement(node: unknown): node is EssorNode;
 declare function template(html: string): HTMLTemplateElement;
 declare function Fragment(props: {
@@ -2379,20 +2432,15 @@ declare function useRef<T>(): {
     current: T | null;
 };
 
-declare const __essor_version = "0.0.6-beta.8";
-
-interface TemplateMap {
-    [key: number]: {
-        template: string;
-        prop?: Record<string, any>;
-    };
-}
 type Props = Record<string, any>;
-declare function ssrtmpl(templates?: string[]): TemplateMap;
-declare function ssr(template: TemplateMap | EssorNode | ((props: Props) => string), props: Props): string;
+declare function renderTemplate(template: string[] | EssorNode | Function, props: Props): string;
+/**
+ * Renders the component to a string.
+ * @param component - The component function.
+ * @param props - The properties to pass to the component.
+ * @returns The rendered component as a string.
+ */
 declare function renderToString(component: (...args: any[]) => string, props: Props): string;
-declare function ssgRender(component: {
-    mount: (root: HTMLElement) => void;
-}, root: HTMLElement): void;
+declare function ssgRender(component: any, root: HTMLElement, props?: Props): void;
 
-export { ComponentNode$1 as ComponentNode, Computed, type EssorComponent, type EssorNode, Fragment, type Hook$1 as Hook, type InjectionKey, type NodeTrack, type Output, Signal$1 as Signal, type StoreActions, TemplateNode, __essor_version, createStore, h, isComputed, isJsxElement, isReactive, isSignal, nextTick, onDestroy, onMount, renderToString, signalObject, ssgRender, ssr, ssrtmpl, template, unReactive, unSignal, useComputed, useEffect, useInject, useProvide, useReactive, useRef, useSignal, useWatch };
+export { ComponentNode$1 as ComponentNode, Computed, type EssorComponent, type EssorNode, Fragment, type Hook$1 as Hook, type InjectionKey, type NodeTrack, type Output, Signal$1 as Signal, type StoreActions, TemplateNode$1 as TemplateNode, __essor_version, createStore, h, isComputed, isJsxElement, isReactive, isSignal, nextTick, onDestroy, onMount, renderTemplate, renderToString, signalObject, ssgRender, template, unReactive, unSignal, useComputed, useEffect, useInject, useProvide, useReactive, useRef, useSignal, useWatch };