@ktjs/shared 0.23.11 → 0.23.12

package/dist/index.d.ts

@@ -1,179 +1,199 @@
-/**
- * Mark the attribute as SVG to handle special cases during rendering.
- */
-declare const SVG_ATTR_FLAG = "__kt_svg__";
-/**
- * Mark the attribute as MathML to handle special cases during rendering.
- */
-declare const MATHML_ATTR_FLAG = "__kt_mathml__";
-/**
- * Can be if, else, else-if.
- */
-declare const DIRV_TYPE: unique symbol;
-
-declare const $isArray: (arg: any) => arg is any[];
-declare const $ArrayFrom: {
-    <T>(arrayLike: ArrayLike<T>): T[];
-    <T, U>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
-    <T>(iterable: Iterable<T> | ArrayLike<T>): T[];
-    <T, U>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
-};
-declare const $is: (value1: any, value2: any) => boolean;
-declare const $assign: {
-    <T extends {}, U>(target: T, source: U): T & U;
-    <T extends {}, U, V>(target: T, source1: U, source2: V): T & U & V;
-    <T extends {}, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
-    (target: object, ...sources: any[]): any;
-};
-declare const $hasOwn: (v: PropertyKey) => boolean;
-declare const $toString: () => string;
-declare const $keys: <T>(o: T) => Array<keyof T>;
-declare const $defines: <T>(o: T, properties: PropertyDescriptorMap & ThisType<any>) => T;
-declare const $define: <T>(o: T, p: PropertyKey, attributes: PropertyDescriptor & ThisType<any>) => T;
-declare const $entries: <T>(o: T) => Array<[keyof T, T[keyof T]]>;
-declare const $random: () => number;
-declare const $isThenable: (o: any) => o is Promise<any>;
-
-type otherstring = string & {};
-
-/**
- * Normal HTML tags like `div`, `span`, `a`, etc.
- */
-type HTMLTag = keyof HTMLElementTagNameMap;
-type SVGTag = keyof SVGElementTagNameMap;
-type MathMLTag = keyof MathMLElementTagNameMap;
-
-/**
- * Get the tags that makes HTMLElementTagNameMap[tag] = HTMLElement
- */
-type NonSpecialTags = {
-  [K in keyof HTMLElementTagNameMap]: HTMLElement extends HTMLElementTagNameMap[K] ? K : never;
-}[keyof HTMLElementTagNameMap];
-
-/**
- * This is tested on 15 browsers (most popular ones)
- * - appending a text node to these tags takes no effect.
- *   - No effect means `innerText` does not include the text in the text node.
- * @see {@link src/core/h/no-text-node.ts}
- */
-type NoTextNodeTag =
-  | 'area'
-  | 'audio'
-  | 'base'
-  | 'basefont'
-  | 'br'
-  | 'canvas'
-  | 'datalist'
-  | 'details'
-  | 'dialog'
-  | 'frameset'
-  | 'head'
-  | 'iframe'
-  | 'img'
-  | 'input'
-  | 'link'
-  | 'meta'
-  | 'meter'
-  | 'noembed'
-  | 'noframes'
-  | 'noscript'
-  | 'optgroup'
-  | 'param'
-  | 'progress'
-  | 'rp'
-  | 'select'
-  | 'style'
-  | 'template'
-  | 'textarea'
-  | 'title'
-  | 'video'
-  | 'wbr'
-  | 'embed'
-  | 'frame'
-  | 'keygen'
-  | 'option';
-
-/**
- * These fields of HTMLElement can trigger `change`.
- */
-type ChangeTriggerField = 'value' | 'checked' | 'selected' | 'valueAsDate' | 'valueAsNumber';
-
-type InputElementTag = 'input' | 'select' | 'textarea';
-
-declare const $isNode: (x: any) => x is ChildNode;
-/**
- * Safe replace `oldNode` With `newNode`
- */
-declare const $replaceNode: (oldNode: unknown, newNode: unknown) => void;
-/**
- * & Remove `bind` because it is shockingly slower than wrapper
- * & `window.document` is safe because it is not configurable and its setter is undefined
- */
-declare const $appendChild: <T extends Node>(node: T) => T;
-declare const originAppend: (...nodes: (Node | string)[]) => void;
-declare const $append: typeof originAppend;
-declare const $buttonDisabledGetter: () => any;
-declare const $buttonDisabledSetter: (v: any) => void;
-declare const $parseStyle: (style: unknown) => string;
-type ChangeHandler<T = string> = (value: T, ...args: any[]) => void;
-/**
- * Used for `k-model`
- */
-declare const $applyModel: (element: HTMLElementTagNameMap[InputElementTag], valueRef: {
-    value: unknown;
-    addOnChange: (fn: (newValue: unknown) => void) => void;
-}, propName: "value" | "checked", eventName: "change" | "input") => void;
-
-/**
- * Default empty function
- */
-declare const $emptyFn: (...args: any[]) => any;
-declare const $emptyArray: any[];
-declare const $emptyObject: any;
-declare const $isSame: (a: unknown, b: unknown) => boolean;
-/**
- * Safe and quick forEach implementation that works with array-like objects and handles sparse arrays.
- */
-declare const $forEach: (array: unknown[], callback: (item: unknown, index: number, array: unknown[]) => void) => void;
-/**
- * Async version of $forEach that allows for asynchronous callbacks. It processes items sequentially, awaiting each callback before moving to the next.
- */
-declare const $forEachAsync: (array: unknown[], callback: (item: unknown, index: number, array: unknown[]) => void) => Promise<void>;
-
-/**
- * Normalize path by joining parts and ensuring leading slash
- */
-declare const normalizePath: (...paths: string[]) => string;
-/**
- * Parse query string into object
- */
-declare const parseQuery: (queryString: string) => Record<string, string>;
-/**
- * Build query string from object
- */
-declare const buildQuery: (query: Record<string, string>) => string;
-/**
- * Substitute params into path pattern
- * @example '/user/:id' + {id: '123'} => '/user/123'
- */
-declare const emplaceParams: (path: string, params: Record<string, string>) => string;
-/**
- * Extract dynamic params from path using pattern
- * @example pattern: '/user/:id', path: '/user/123' => {id: '123'}
- */
-declare const extractParams: (pattern: string, path: string) => Record<string, string> | null;
-
-// declare function $throw(message: string): never;
-// declare const $warn: typeof console.warn;
-// declare const $error: typeof console.error;
-// declare const $debug: typeof console.debug;
-declare global {
-  const $throw: (message?: string) => never;
-  const $warn: typeof console.warn;
-  const $log: typeof console.log;
-  const $error: typeof console.error;
-  const $debug: typeof console.debug;
-}
-
-export { $ArrayFrom, $append, $appendChild, $applyModel, $assign, $buttonDisabledGetter, $buttonDisabledSetter, $define, $defines, $emptyArray, $emptyFn, $emptyObject, $entries, $forEach, $forEachAsync, $hasOwn, $is, $isArray, $isNode, $isSame, $isThenable, $keys, $parseStyle, $random, $replaceNode, $toString, DIRV_TYPE, MATHML_ATTR_FLAG, SVG_ATTR_FLAG, buildQuery, emplaceParams, extractParams, normalizePath, parseQuery };
-export type { ChangeHandler, ChangeTriggerField, HTMLTag, InputElementTag, MathMLTag, NoTextNodeTag, NonSpecialTags, SVGTag, otherstring };
+export declare const $append: typeof originAppend;
+
+/**
+ * & Remove `bind` because it is shockingly slower than wrapper
+ * & `window.document` is safe because it is not configurable and its setter is undefined
+ */
+export declare const $appendChild: <T extends Node>(node: T) => T;
+
+/**
+ * Used for `k-model`
+ */
+export declare const $applyModel: (element: HTMLElementTagNameMap[InputElementTag], valueRef: {
+    value: unknown;
+    addOnChange: (fn: (newValue: unknown) => void) => void;
+}, propName: "value" | "checked", eventName: "change" | "input") => void;
+
+export declare const $ArrayFrom: {
+    <T>(arrayLike: ArrayLike<T>): T[];
+    <T, U>(arrayLike: ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
+    <T>(iterable: Iterable<T> | ArrayLike<T>): T[];
+    <T, U>(iterable: Iterable<T> | ArrayLike<T>, mapfn: (v: T, k: number) => U, thisArg?: any): U[];
+};
+
+export declare const $assign: {
+    <T extends {}, U>(target: T, source: U): T & U;
+    <T extends {}, U, V>(target: T, source1: U, source2: V): T & U & V;
+    <T extends {}, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
+    (target: object, ...sources: any[]): any;
+};
+
+export declare const $buttonDisabledGetter: () => any;
+
+export declare const $buttonDisabledSetter: (v: any) => void;
+
+export declare const $define: <T>(o: T, p: PropertyKey, attributes: PropertyDescriptor & ThisType<any>) => T;
+
+export declare const $defines: <T>(o: T, properties: PropertyDescriptorMap & ThisType<any>) => T;
+
+export declare const $emptyArray: any[];
+
+/**
+ * Default empty function
+ */
+export declare const $emptyFn: (...args: any[]) => any;
+
+export declare const $emptyObject: any;
+
+export declare const $entries: <T>(o: T) => Array<[keyof T, T[keyof T]]>;
+
+/**
+ * Safe and quick forEach implementation that works with array-like objects and handles sparse arrays.
+ */
+export declare const $forEach: (array: unknown[], callback: (item: unknown, index: number, array: unknown[]) => void) => void;
+
+/**
+ * Async version of $forEach that allows for asynchronous callbacks. It processes items sequentially, awaiting each callback before moving to the next.
+ */
+export declare const $forEachAsync: (array: unknown[], callback: (item: unknown, index: number, array: unknown[]) => void) => Promise<void>;
+
+export declare const $hasOwn: (v: PropertyKey) => boolean;
+
+export declare const $is: (value1: any, value2: any) => boolean;
+
+export declare const $isArray: (arg: any) => arg is any[];
+
+export declare const $isNode: (x: any) => x is ChildNode;
+
+export declare const $isSame: (a: unknown, b: unknown) => boolean;
+
+export declare const $isThenable: (o: any) => o is Promise<any>;
+
+export declare const $keys: <T>(o: T) => Array<keyof T>;
+
+export declare const $parseStyle: (style: unknown) => string;
+
+export declare const $random: () => number;
+
+/**
+ * Safe replace `oldNode` With `newNode`
+ */
+export declare const $replaceNode: (oldNode: unknown, newNode: unknown) => void;
+
+export declare const $toString: () => string;
+
+/**
+ * Build query string from object
+ */
+export declare const buildQuery: (query: Record<string, string>) => string;
+
+export declare type ChangeHandler<T = string> = (value: T, ...args: any[]) => void;
+
+/**
+ * These fields of HTMLElement can trigger `change`.
+ */
+export declare type ChangeTriggerField = 'value' | 'checked' | 'selected' | 'valueAsDate' | 'valueAsNumber';
+
+/**
+ * Substitute params into path pattern
+ * @example '/user/:id' + {id: '123'} => '/user/123'
+ */
+export declare const emplaceParams: (path: string, params: Record<string, string>) => string;
+
+/**
+ * Extract dynamic params from path using pattern
+ * @example pattern: '/user/:id', path: '/user/123' => {id: '123'}
+ */
+export declare const extractParams: (pattern: string, path: string) => Record<string, string> | null;
+
+export declare type HTMLJSXTag = HTMLTag | ((props?: any) => HTMLElement) | ((props?: any) => Promise<HTMLElement>);
+
+/**
+ * Normal HTML tags like `div`, `span`, `a`, etc.
+ */
+export declare type HTMLTag = keyof HTMLElementTagNameMap;
+
+export declare type InputElementTag = 'input' | 'select' | 'textarea';
+
+export declare type JSXTag = HTMLJSXTag | SVGJSXTag | MathMLJSXTag;
+
+export declare interface KTReactiveLike<T = unknown> {
+    isKT: true;
+    value: T;
+    addOnChange(fn: (newValue: T, oldValue: T) => void): void;
+    removeOnChange?(fn: (newValue: T, oldValue: T) => void): boolean;
+}
+
+export declare type MathMLJSXTag = HTMLTag | ((props?: any) => MathMLElement) | ((props?: any) => Promise<MathMLElement>);
+
+export declare type MathMLTag = keyof MathMLElementTagNameMap;
+
+/**
+ * Get the tags that makes HTMLElementTagNameMap[tag] = HTMLElement
+ */
+export declare type NonSpecialTags = {
+    [K in keyof HTMLElementTagNameMap]: HTMLElement extends HTMLElementTagNameMap[K] ? K : never;
+}[keyof HTMLElementTagNameMap];
+
+/**
+ * Normalize path by joining parts and ensuring leading slash
+ */
+export declare const normalizePath: (...paths: string[]) => string;
+
+/**
+ * This is tested on 15 browsers (most popular ones)
+ * - appending a text node to these tags takes no effect.
+ *   - No effect means `innerText` does not include the text in the text node.
+ * @see {@link src/core/h/no-text-node.ts}
+ */
+export declare type NoTextNodeTag =
+| 'area'
+| 'audio'
+| 'base'
+| 'basefont'
+| 'br'
+| 'canvas'
+| 'datalist'
+| 'details'
+| 'dialog'
+| 'frameset'
+| 'head'
+| 'iframe'
+| 'img'
+| 'input'
+| 'link'
+| 'meta'
+| 'meter'
+| 'noembed'
+| 'noframes'
+| 'noscript'
+| 'optgroup'
+| 'param'
+| 'progress'
+| 'rp'
+| 'select'
+| 'style'
+| 'template'
+| 'textarea'
+| 'title'
+| 'video'
+| 'wbr'
+| 'embed'
+| 'frame'
+| 'keygen'
+| 'option';
+
+declare const originAppend: (...nodes: (Node | string)[]) => void;
+
+export declare type otherstring = string & {};
+
+/**
+ * Parse query string into object
+ */
+export declare const parseQuery: (queryString: string) => Record<string, string>;
+
+export declare type SVGJSXTag = HTMLTag | ((props?: any) => SVGElement) | ((props?: any) => Promise<SVGElement>);
+
+export declare type SVGTag = keyof SVGElementTagNameMap;
+
+export { }