@kizmann/pico-js 1.0.13 → 2.0.0

package/types/utils/Dom.d.ts

@@ -0,0 +1,138 @@
+/**
+ * @returns {typeof PicoDom}
+ */
+export function PicoDomBuilder(): typeof PicoDom;
+export const PicoDomPlugins: ((self: any) => typeof import("./Dom.js").PicoDom)[];
+/**
+ * @class PicoDom
+ *
+ * @typedef {import('#src/dom/DomFinder.js').PicoDomFinderInstance} PicoDomFinderInstance
+ * @typedef {import('#src/dom/DomGlobal.js').PicoDomGlobalStatic} PicoDomGlobalStatic
+ * @typedef {import('#src/dom/DomGlobal.js').PicoDomGlobalInstance} PicoDomGlobalInstance
+ * @typedef {import('#src/dom/DomEvent.js').PicoDomEventStatic} PicoDomEventStatic
+ * @typedef {import('#src/dom/DomEvent.js').PicoDomEventInstance} PicoDomEventInstance
+ * @typedef {import('#src/dom/DomBuilder.js').PicoDomBuilderStatic} PicoDomBuilderStatic
+ * @typedef {import('#src/dom/DomBuilder.js').PicoDomBuilderInstance} PicoDomBuilderInstance
+ * @typedef {import('#src/dom/DomRectangle.js').PicoDomRectangleStatic} PicoDomRectangleStatic
+ * @typedef {import('#src/dom/DomRectangle.js').PicoDomRectangleInstance} PicoDomRectangleInstance
+ * @typedef {import('#src/dom/DomAttribute.js').PicoDomAttributeStatic} PicoDomAttributeStatic
+ * @typedef {import('#src/dom/DomAttribute.js').PicoDomAttributeInstance} PicoDomAttributeInstance
+ * @typedef {import('#src/dom/DomInview.js').PicoDomInviewStatic} PicoDomInviewStatic
+ * @typedef {import('#src/dom/DomInview.js').PicoDomInviewInstance} PicoDomInviewInstance
+ * @typedef {import('#src/dom/DomMeta.js').PicoDomMetaStatic} PicoDomMetaStatic
+ * @typedef {import('#src/dom/DomMeta.js').PicoDomMetaInstance} PicoDomMetaInstance
+ * @typedef {import('#src/dom/DomObserver.js').PicoDomObserverStatic} PicoDomObserverStatic
+ * @typedef {import('#src/dom/DomObserver.js').PicoDomObserverInstance} PicoDomObserverInstance
+ *
+ * @mixes PicoDomFinderStatic
+ * @mixes PicoDomGlobalStatic
+ * @mixes PicoDomFormStatic
+ * @mixes PicoDomEventStatic
+ * @mixes PicoDomBuilderStatic
+ * @mixes PicoDomRectangleStatic
+ * @mixes PicoDomAttributeStatic
+ * @mixes PicoDomInviewStatic
+ * @mixes PicoDomMetaStatic
+ * @mixes PicoDomObserverStatic
+ *
+ * @extends PicoDomFinderInstance
+ * @extends PicoDomGlobalInstance
+ * @extends PicoDomFormInstance
+ * @extends PicoDomEventInstance
+ * @extends PicoDomBuilderInstance
+ * @extends PicoDomRectangleInstance
+ * @extends PicoDomAttributeInstance
+ * @extends PicoDomInviewInstance
+ * @extends PicoDomMetaInstance
+ * @extends PicoDomObserverInstance
+ */
+export class PicoDom {
+    /**
+     * Init hooks for constructor
+     *
+     * @type {Array<function>}
+     */
+    static init: Array<Function>;
+    /**
+     * Create new Dom wrapper
+     *
+     * @example Dom.find("body") // => Dom
+     *
+     * @param {any} el Element or selector
+     * @param {...any} args Plugin args
+     * @returns {PicoDom} Dom wrapper
+     */
+    static find(el: any, ...args: any[]): PicoDom;
+    /**
+     * Extend Dom with a plugin
+     *
+     * @example Dom.extend(fn)
+     *
+     * @param {function} plugin Plugin function
+     * @returns {void} No return value
+     */
+    static extend(plugin: Function): void;
+    /**
+     * Get window or empty object
+     *
+     * @example Dom.win().innerWidth // => number|undefined
+     *
+     * @returns {any} Window or {}
+     */
+    static win(): any;
+    /**
+     * Get document or empty object
+     *
+     * @example Dom.doc().body // => HTMLElement|undefined
+     *
+     * @returns {any} Document or {}
+     */
+    static doc(): any;
+    /**
+     * Get document.body or empty
+     *
+     * @example Dom.body().nodeType // => 1|undefined
+     *
+     * @returns {any} Body or {}
+     */
+    static body(): any;
+    /**
+     * Create Dom wrapper from input
+     *
+     * @example new Dom("body").get(0) // => HTMLElement
+     *
+     * @param {any} el Element or selector
+     * @param {...any} args Plugin args
+     */
+    constructor(el: any, ...args: any[]);
+    /**
+     * First selected element
+     *
+     * @type {HTMLElement}
+     */
+    el: HTMLElement;
+    /**
+     * All selected elements
+     *
+     * @type {Array<HTMLElement>}
+     */
+    els: Array<HTMLElement>;
+}
+export default PicoDomBuilder;
+export type PicoDomFinderInstance = import("#src/dom/DomFinder.js").PicoDomFinderInstance;
+export type PicoDomGlobalStatic = import("#src/dom/DomGlobal.js").PicoDomGlobalStatic;
+export type PicoDomGlobalInstance = import("#src/dom/DomGlobal.js").PicoDomGlobalInstance;
+export type PicoDomEventStatic = import("#src/dom/DomEvent.js").PicoDomEventStatic;
+export type PicoDomEventInstance = import("#src/dom/DomEvent.js").PicoDomEventInstance;
+export type PicoDomBuilderStatic = import("#src/dom/DomBuilder.js").PicoDomBuilderStatic;
+export type PicoDomBuilderInstance = import("#src/dom/DomBuilder.js").PicoDomBuilderInstance;
+export type PicoDomRectangleStatic = import("#src/dom/DomRectangle.js").PicoDomRectangleStatic;
+export type PicoDomRectangleInstance = import("#src/dom/DomRectangle.js").PicoDomRectangleInstance;
+export type PicoDomAttributeStatic = import("#src/dom/DomAttribute.js").PicoDomAttributeStatic;
+export type PicoDomAttributeInstance = import("#src/dom/DomAttribute.js").PicoDomAttributeInstance;
+export type PicoDomInviewStatic = import("#src/dom/DomInview.js").PicoDomInviewStatic;
+export type PicoDomInviewInstance = import("#src/dom/DomInview.js").PicoDomInviewInstance;
+export type PicoDomMetaStatic = import("#src/dom/DomMeta.js").PicoDomMetaStatic;
+export type PicoDomMetaInstance = import("#src/dom/DomMeta.js").PicoDomMetaInstance;
+export type PicoDomObserverStatic = import("#src/dom/DomObserver.js").PicoDomObserverStatic;
+export type PicoDomObserverInstance = import("#src/dom/DomObserver.js").PicoDomObserverInstance;

package/types/utils/Event.d.ts

@@ -0,0 +1,58 @@
+export class PicoEvent {
+    static $events: any[];
+    /**
+     * Bind callback to event name
+     *
+     * @example Event.bind("x", cb) // => Event
+     * @example Event.bind(["a","b"], cb) // => Event
+     *
+     * @param {any} event Event name(s)
+     * @param {function} cb Event callback
+     * @param {any} [options] Listener options
+     * @param {boolean} [paused] Start paused
+     * @returns {typeof PicoEvent} Event class
+     */
+    static bind(event: any, cb: Function, options?: any, paused?: boolean): typeof PicoEvent;
+    /**
+     * Unbind callback(s) from event
+     *
+     * @example Event.unbind("x") // => Event
+     * @example Event.unbind(["a","b"]) // => Event
+     *
+     * @param {any} event Event name(s)
+     * @param {any} [options] Listener options
+     * @returns {typeof PicoEvent} Event class
+     */
+    static unbind(event: any, options?: any): typeof PicoEvent;
+    /**
+     * Fire event with arguments
+     *
+     * @example Event.fire("x", 1) // => Event
+     *
+     * @param {string} event Event name
+     * @param {...any} [args] Event args
+     * @returns {typeof PicoEvent} Event class
+     */
+    static fire(event: string, ...args?: any[]): typeof PicoEvent;
+    /**
+     * Pause listeners for event
+     *
+     * @example Event.pause("x") // => Event
+     *
+     * @param {any} event Event name(s)
+     * @param {any} [options] Listener options
+     * @returns {typeof PicoEvent} Event class
+     */
+    static pause(event: any, options?: any): typeof PicoEvent;
+    /**
+     * Unpause listeners for event
+     *
+     * @example Event.unpause("x") // => Event
+     *
+     * @param {any} event Event name(s)
+     * @param {any} [options] Listener options
+     * @returns {typeof PicoEvent} Event class
+     */
+    static unpause(event: any, options?: any): typeof PicoEvent;
+}
+export default PicoEvent;

package/types/utils/Format.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @returns {typeof PicoFormat}
+ */
+export function PicoFormatBuilder(): typeof PicoFormat;
+export const PicoFormatPlugins: ((self: any) => typeof import("./Format.js").PicoFormat)[];
+/**
+ * @class PicoFormat
+ *
+ * @typedef {import('#src/format/FormatParser.js').PicoFormatParserStatic} PicoFormatParserStatic
+ * @typedef {import('#src/format/FormatParam.js').PicoFormatParamStatic} PicoFormatParamStatic
+ * @typedef {import('#src/format/FormatOption.js').PicoFormatOptionStatic} PicoFormatOptionStatic
+ * @typedef {import('#src/format/FormatUrl.js').PicoFormatUrlStatic} PicoFormatUrlStatic
+ * @typedef {import('#src/format/FormatFile.js').PicoFormatFileStatic} PicoFormatFileStatic
+ *
+ * @mixes PicoFormatParserStatic
+ * @mixes PicoFormatParamStatic
+ * @mixes PicoFormatOptionStatic
+ * @mixes PicoFormatUrlStatic
+ * @mixes PicoFormatFileStatic
+ */
+export class PicoFormat {
+    /**
+     * Extend format with a plugin
+     *
+     * @example For.extend(fn)
+     *
+     * @param {function} plugin Plugin function
+     * @returns {void} No return value
+     */
+    static extend(plugin: Function): void;
+}
+export default PicoFormatBuilder;
+export type PicoFormatParserStatic = import("#src/format/FormatParser.js").PicoFormatParserStatic;
+export type PicoFormatParamStatic = import("#src/format/FormatParam.js").PicoFormatParamStatic;
+export type PicoFormatOptionStatic = import("#src/format/FormatOption.js").PicoFormatOptionStatic;
+export type PicoFormatUrlStatic = import("#src/format/FormatUrl.js").PicoFormatUrlStatic;
+export type PicoFormatFileStatic = import("#src/format/FormatFile.js").PicoFormatFileStatic;

package/types/utils/Hash.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @var {Array<string>} RADIX_NUMBER Radix from 0 to 9
+ */
+export const RADIX_NUMBER: string[];
+/**
+ * @var {Array<string>} RADIX_LETTER_LC Radix from a to z
+ */
+export const RADIX_LETTER_LC: string[];
+/**
+ * @var {Array<string>} RADIX_LETTER_UC Radix from A to Z
+ */
+export const RADIX_LETTER_UC: string[];
+/**
+ * @var {Array<string>} RADIX_UUID Radix from 0-9, a-f and A-F
+ */
+export const RADIX_UUID: string[];
+/**
+ * @var {Array<string>} RADIX_UP19 Radix with 8, 9, a and b
+ */
+export const RADIX_UP19: string[];
+/**
+ * @var {Array<string>} radix_symbol_pass Radix for passwords
+ */
+export const radix_symbol_pass: string[];
+export class PicoHash {
+    /**
+     * @var {Array<string>} RADIX
+     */
+    static RADIX: string[];
+    /**
+     * Get random char from radix
+     *
+     * @example Hash.radix(2, ['R', 'f']) // => 'R' or 'f'
+     *
+     * @param {number} [limit=60] Maximum radix char index
+     * @param {Array<string>} [radix=null] A defined radix or null for default
+     * @returns {string} Returns random char from radix
+     */
+    static radix(limit?: number, radix?: Array<string>): string;
+    /**
+     * Get random number
+     *
+     * @example Hash.number(20, 18) // => 18, 19 or 20
+     *
+     * @param {number} [limit=1024] Maximum value
+     * @param {number} [start=0] Minimum value
+     * @returns {number} Returns a random number between start and limit
+     */
+    static number(limit?: number, start?: number): number;
+    /**
+     * Get a random hash with given options
+     *
+     * @example Hash.make(4, 32, { 0: '?' }) // => '?8Wj'
+     *
+     * @param {number} [length] Length of generated hash
+     * @param {number} [radix] Maximum radix char index (10 for 0-9, 36 incl. a-z, 62 incl. A-Z)
+     * @param {Record<number, string>} [map] Remap for generated string
+     * @returns {string} Returns a random hash with fixed length
+     */
+    static make(length?: number, radix?: number, map?: Record<number, string>): string;
+    /**
+     * Get a valid v4 UUID
+     *
+     * @example Hash.uuid() // => 'FBbA001F-0a01-4bE8-b29C-A9c47fA090f'
+     *
+     * @param {string|number} [version] UUID version number
+     * @returns {string} Returns a valid UUID
+     */
+    static uuid(version?: string | number): string;
+    /**
+     * Generate a password with or without symbols
+     *
+     * @example Hash.password(12, ['%', '&']) // => '0unJ%VDi2RJX'
+     *
+     * @param {number} [length=24] Length of password
+     * @param {Array<string>} [symbols=null] Defined symbols or null for default
+     * @returns {string} A random password with fixed length
+     */
+    static password(length?: number, symbols?: Array<string>): string;
+}
+export default PicoHash;

package/types/utils/Locale.d.ts

@@ -0,0 +1,115 @@
+export class PicoLocale {
+    /**
+     * Translation dictionary
+     *
+     * @type {Record<any, any>}
+     */
+    static $text: Record<any, any>;
+    /**
+     * Cached collator instance
+     *
+     * @type {Intl.Collator|null}
+     */
+    static $sort: Intl.Collator | null;
+    /**
+     * Active locale code
+     *
+     * @type {string}
+     */
+    static $code: string;
+    /**
+     * Check if translation key exists
+     *
+     * @example Locale.has("known.key") // => true
+     * @example Locale.has("unknown.key") // => false
+     *
+     * @param {any} [key] Translation key
+     * @returns {boolean} True if exists
+     */
+    static has(key?: any): boolean;
+    /**
+     * Get translation value or map
+     *
+     * @example Locale.get("known.key") // => "value"
+     * @example Locale.get() // => object
+     *
+     * @param {any} [key] Translation key
+     * @param {any} [fallback] Fallback value
+     * @returns {any} Translation value
+     */
+    static get(key?: any, fallback?: any): any;
+    /**
+     * Set translation key or map
+     *
+     * @example Locale.set({foo:"bar"})
+     * @example Locale.set("unknown", "nix")
+     *
+     * @param {any} [key] Key or map
+     * @param {any} [value] Value to set
+     * @returns {any} Updated map
+     */
+    static set(key?: any, value?: any): any;
+    /**
+     * Get or set locale code
+     *
+     * @example Locale.code() // => "en"
+     * @example Locale.code("de") // => "de"
+     *
+     * @param {string|null} [code] Locale code
+     * @returns {string} Active code
+     */
+    static code(code?: string | null): string;
+    /**
+     * Get Intl.Collator for sorting
+     *
+     * @example Locale.collator().compare("a","b")
+     *
+     * @returns {Intl.Collator} Collator instance
+     */
+    static collator(): Intl.Collator;
+    /**
+     * Replace :tokens in text
+     *
+     * @example Locale.replace("Hi :x", {x:"Bob"}) // => "Hi Bob"
+     * @example Locale.replace("Hi", null) // => "Hi"
+     *
+     * @param {string} text Input text
+     * @param {any} [replace] Replace map
+     * @returns {string} Replaced text
+     */
+    static replace(text: string, replace?: any): string;
+    /**
+     * Translate key with replace map
+     *
+     * @example Locale.trans("known.key") // => "..."
+     * @example Locale.trans("Hi :x", {x:"Bob"}) // => "Hi Bob"
+     *
+     * @param {string} text Key or text
+     * @param {any} [replace] Replace map
+     * @returns {string} Translated text
+     */
+    static trans(text: string, replace?: any): string;
+    /**
+     * Translate plural choice by count
+     *
+     * @example Locale.choice("items", 2) // => "..."
+     * @example Locale.choice("items", 1, {x:"y"}) // => "..."
+     *
+     * @param {string} text Key or text
+     * @param {number} [count] Choice count
+     * @param {any} [replace] Replace map
+     * @returns {string} Chosen text
+     */
+    static choice(text: string, count?: number, replace?: any): string;
+    /**
+     * Pick plural variant from list
+     *
+     * @example Locale.countpick(["a","b"], 2) // => "b"
+     *
+     * @param {Array<string>} splits Variant list
+     * @param {number} count Choice count
+     * @returns {string} Picked text
+     */
+    static countpick(splits: Array<string>, count: number): string;
+}
+export default PicoLocale;