regor 1.1.8 → 1.2.0

package/dist/regor.d.ts

@@ -1,7 +1,7 @@
 // Generated by dts-bundle-generator v9.5.1
 
-export declare class ComponentHead<TProps = Record<any, any>> {
-	props: TProps;
+export declare class ComponentHead<TContext = IRegorContext> {
+	props: TContext;
 	start: Comment;
 	end: Comment;
 	ctx: IRegorContext[];
@@ -10,7 +10,7 @@ export declare class ComponentHead<TProps = Record<any, any>> {
 	autoProps: boolean;
 	/** When both autoProps and entangle are enabled,
 	 * the refs defined in the component context (without using head.props)
-	 * become entangled with the head.props refs. (parent[ref] <==> component[ref])
+	 * become entangled with the head.props refs. (parent[ref] `<==>` component[ref])
 	 * This means that changes to parent[ref] reflect in component[ref], and vice versa.
 	 * Disable this flag to isolate refs created within the component context.
 	 * Default: true */
@@ -20,18 +20,18 @@ export declare class ComponentHead<TProps = Record<any, any>> {
 	enableSwitch: boolean;
 	/** A callback invoked after auto props get assigned to the component context. */
 	onAutoPropsAssigned?: () => void;
-	constructor(props: TProps, element: Element, ctx: IRegorContext[], start: Comment, end: Comment);
+	constructor(props: TContext, element: Element, ctx: IRegorContext[], start: Comment, end: Comment);
 	/** use arrow syntax to be called without using head.emit.bind(head) in Binder.ts. */
-	emit: (event: string, args: Record<any, any>) => void;
+	emit: (event: string, args: Record<string, unknown>) => void;
 	unmount(): void;
 }
 export declare class RegorConfig {
 	static getDefault(): RegorConfig;
 	forGrowThreshold: number;
-	globalContext: Record<string, any>;
+	globalContext: Record<string, unknown>;
 	useInterpolation: boolean;
-	constructor(globalContext?: Record<any, any>);
-	addComponent<TProps = Record<any, any>>(...components: Array<Component<TProps>>): void;
+	constructor(globalContext?: Record<string, unknown>);
+	addComponent<TContext = IRegorContext>(...components: Array<Component<TContext>>): void;
 	setDirectives(prefix: string): void;
 	updateDirectives(updater: (directiveMap: Record<string, Directive>, builtInNames: Record<string, string>) => void): void;
 }
@@ -76,8 +76,8 @@ export type FlattenRef<TRef> = TRef extends Array<infer V1> ? Array<FlattenRef<V
 export type Flat<TValueType> = Equals<RefParam<TValueType>, FlattenRef<TValueType>> extends true ? RefParam<TValueType> : FlattenRef<TValueType>;
 export type ObserveCallback<TValueType> = (newValue: TValueType, eventSource?: any) => void;
 export type StopObserving = () => void;
-export declare interface IRegorContext extends Record<any, any> {
-	components?: Record<string, Component<any>>;
+export declare interface IRegorContext extends Record<string, unknown> {
+	components?: Record<string, Component>;
 	mounted?: () => void;
 	unmounted?: () => void;
 }
@@ -97,14 +97,14 @@ export interface Directive {
 }
 export interface BindData {
 	unbinders: Unbinder[];
-	data: Record<any, any>;
+	data: Record<string, unknown>;
 }
 export type Unbinder = () => void;
 export interface ParseResult {
 	value: SRef<unknown[]>;
 	stop: StopObserving;
 	refs: Array<AnyRef | undefined>;
-	context: Record<any, any>;
+	context: Record<string, unknown>;
 }
 export type OnCleanup = (cleanup: () => void) => void;
 export interface JSONTemplate {
@@ -166,16 +166,16 @@ export interface App<TRegorContext extends IRegorContext> {
 /**
  * Represents a component in the Regor framework.
  *
- * @typeparam TProps - The type of props accepted by the component.
+ * @typeparam TContext - The type of context accepted by the component.
  */
-export interface Component<TProps = Record<any, any>> {
+export interface Component<TContext = IRegorContext> {
 	/**
 	 * A function that returns the Regor context associated with the component.
 	 *
 	 * @param head - Provides information on component mount.
-	 * @returns The Regor context.
+	 * @returns The component context.
 	 */
-	context: (head: ComponentHead<TProps>) => IRegorContext;
+	context: (head: ComponentHead<TContext>) => TContext;
 	/**
 	 * The template for the component.
 	 */
@@ -196,18 +196,18 @@ export interface Component<TProps = Record<any, any>> {
 }
 export type OnMounted = () => void;
 export type OnUnmounted = () => void;
-export interface CreateComponentOptions {
+export interface CreateComponentOptions<TContext = IRegorContext> {
 	useInterpolation?: boolean;
 	config?: RegorConfig;
 	/**
 	 * A function that defines the Regor context for the component.
 	 */
-	context?: (head: ComponentHead<any>) => IRegorContext;
+	context?: (head: ComponentHead<TContext>) => TContext;
 	inheritAttrs?: boolean;
 	/**
 	 * Notes on component props:
 	 * The props defined in the props list can be used with :foo or r-bind:foo syntax.
-	 * <MyComponent :prop-kebab-1="1" r-bind:prop-kebab-2="x ? 1 : 0" :props="{ propFoo3: true, propFoo4: x ? 'a' : 'b' }></MyComponent>
+	 * `<MyComponent :prop-kebab-1="1" r-bind:prop-kebab-2="x ? 1 : 0" :props="{ propFoo3: true, propFoo4: x ? 'a' : 'b' }></MyComponent>`
 	 * It is required to define prop-kebab-1 and prop-kebab-2 in the props list camelized.
 	 * It is not required to define propFoo3 and propFoo4 in the props list because it uses :props binding. :props binding enables binding to any property of component regardless it is explicitly defined in props list.
 	 */
@@ -221,15 +221,19 @@ export interface Scope<TRegorContext> {
 	context: TRegorContext;
 	unmount: () => void;
 	[ScopeSymbol]: true;
+	[key: string]: unknown;
 }
 export declare const createApp: <TRegorContext extends IRegorContext>(context: TRegorContext | Scope<TRegorContext>, template?: Template | string, config?: RegorConfig) => App<TRegorContext>;
-export declare const createComponent: <TProps = Record<any, any>>(template: Template | string, options?: CreateComponentOptions | string[]) => Component<TProps>;
+export declare const createComponent: <TContext = IRegorContext>(template: Template | string, options?: CreateComponentOptions<TContext> | string[]) => Component<TContext>;
 export declare const toFragment: (json: JSONTemplate | JSONTemplate[], isSVG?: boolean, config?: RegorConfig) => DocumentFragment;
 export declare const toJsonTemplate: (node: Element | Element[]) => JSONTemplate | JSONTemplate[];
 export declare const addUnbinder: (node: Node, unbinder: Unbinder) => void;
 export declare const getBindData: (node: any) => BindData;
 export declare const removeNode: (node: ChildNode) => void;
 export declare const unbind: (node: Node) => void;
+export declare const onMounted: (onMounted: OnMounted) => void;
+export declare const onUnmounted: (onUnmounted: OnUnmounted, noThrow?: boolean) => void;
+export declare const useScope: <TRegorContext extends IRegorContext>(context: () => TRegorContext) => Scope<TRegorContext>;
 export declare const computed: <TReturnType>(compute: () => TReturnType) => ComputedRef<UnwrapRef<TReturnType>>;
 export declare const computeMany: <TReturnType>(sources: AnyRef[], compute: (...values: any[]) => TReturnType) => ComputedRef<UnwrapRef<TReturnType>>;
 export declare const computeRef: <TValueType extends AnyRef, TReturnType>(source: TValueType, compute: (value: UnwrapRef<TValueType>) => TReturnType) => ComputedRef<UnwrapRef<TReturnType>>;
@@ -239,6 +243,9 @@ export declare const collectRefs: <TReturnType>(action: () => TReturnType) => {
 	value: TReturnType;
 	refs: AnyRef[];
 };
+export declare const warningHandler: {
+	warning: (...data: any[]) => void;
+};
 export declare const flatten: <TValueType>(reference: TValueType | Ref<TValueType> | SRef<TValueType> | ComputedRef<TValueType>) => Flat<TValueType>;
 export declare const isRaw: (value: any) => boolean;
 export type Raw<TValueType> = TValueType & RawMarker;
@@ -252,6 +259,7 @@ export declare const observerCount: <TValueType extends AnyRef>(source: TValueTy
 export declare const batch: (updater: () => void) => void;
 export declare const startBatch: () => void;
 export declare const endBatch: () => void;
+export declare const entangle: (r1: AnyRef, r2: AnyRef) => StopObserving;
 export declare const isDeepRef: (value: unknown) => value is AnyRef;
 export declare const isRef: (value: unknown) => value is AnyRef;
 export declare const pause: <TValueType extends AnyRef>(source: TValueType) => void;
@@ -274,7 +282,7 @@ export declare const pause: <TValueType extends AnyRef>(source: TValueType) => v
  * @param value - Any value to be converted into a ref object.
  * @returns A ref object representing the input value and its nested properties.
  */
-export declare const ref: <TValueType>(value?: TValueType | RefContent<TValueType> | RefParam<TValueType> | (TValueType extends Ref<infer V1> ? Ref<RefParam<V1>> : never) | (TValueType extends SRef<infer V2> ? SRef<UnwrapRef<V2>> : never) | (TValueType extends (infer V1_1)[] ? V1_1[] : never) | null | undefined) => IsNull<TValueType> extends true ? Ref<unknown> : Ref<RefParam<TValueType>>;
+export declare const ref: <TValueType>(value?: TValueType | RefContent<TValueType> | (TValueType extends Ref<infer V1> ? Ref<RefParam<V1>> : never) | (TValueType extends SRef<infer V2> ? SRef<UnwrapRef<V2>> : never) | RefParam<TValueType> | (TValueType extends Array<infer V1> ? V1[] : never) | null) => IsNull<TValueType> extends true ? Ref<unknown> : Ref<RefParam<TValueType>>;
 export declare const resume: <TValueType extends AnyRef>(source: TValueType) => void;
 /**
  * Converts the given value to an sref object and returns the sref.
@@ -295,18 +303,8 @@ export declare const resume: <TValueType extends AnyRef>(source: TValueType) =>
  * @param value - Any value to be converted into an sref object.
  * @returns An sref object representing the input value.
  */
-export declare const sref: <TValueType>(value?: TValueType | (TValueType extends SRef<infer V2> ? SRef<UnwrapRef<V2>> : never) | (TValueType extends (infer V1)[] ? V1[] : never) | null | undefined) => IsNull<TValueType> extends true ? SRef<unknown> : SRef<SRefContent<TValueType>>;
+export declare const sref: <TValueType>(value?: TValueType | (TValueType extends SRef<infer V2> ? SRef<UnwrapRef<V2>> : never) | (TValueType extends Array<infer V1> ? V1[] : never) | null) => IsNull<TValueType> extends true ? SRef<unknown> : SRef<SRefContent<TValueType>>;
 export declare const trigger: <TValueType extends AnyRef>(source: TValueType, eventSource?: any, isRecursive?: boolean) => void;
 export declare const unref: <TValueType>(value: TValueType) => UnwrapRef<TValueType>;
-export declare const entangle: (r1: AnyRef, r2: AnyRef) => StopObserving;
-export declare const useScope: <TRegorContext extends IRegorContext>(context: () => TRegorContext) => Scope<TRegorContext>;
-export declare const onMounted: (onMounted: OnMounted) => void;
-export declare const onUnmounted: (onUnmounted: OnUnmounted, noThrow?: boolean) => void;
-export declare const warningHandler: {
-	warning: {
-		(...data: any[]): void;
-		(message?: any, ...optionalParams: any[]): void;
-	};
-};
 
 export {};