@aegis-framework/artemis 0.3.29 → 0.4.0

package/dist/types/DOM.d.ts

@@ -0,0 +1,383 @@
+/**
+ * ==============================
+ * DOM
+ * ==============================
+ */
+/**
+ * Type for elements that can be used as a selector
+ */
+export type DOMSelector = string | Element | Element[] | NodeList | NodeListOf<Element> | HTMLElement[] | DOM | null;
+/**
+ * Type for style properties object
+ */
+export type StyleProperties = Record<string, string | number>;
+/**
+ * Type for offset object
+ */
+export interface DOMOffset {
+    top: number;
+    left: number;
+}
+/**
+ * Event callback type
+ */
+export type EventCallback = (event: Event) => void;
+/**
+ * Element callback type
+ */
+export type ElementCallback = (element: Element) => void;
+/**
+ * Simple DOM manipulation functions
+ */
+export declare class DOM {
+    collection: Element[] | NodeListOf<Element>;
+    length: number;
+    _selector: DOMSelector;
+    /**
+     * Create a new DOM object
+     *
+     * @param selector - Selector or DOM element to use
+     */
+    constructor(selector: DOMSelector);
+    /**
+     * Hide elements by setting their `display` property to 'none'.
+     *
+     * @returns Current instance
+     */
+    hide(): this;
+    /**
+     * Show elements by setting their `display` property to the given value.
+     *
+     * @param display - Display property to set
+     * @returns Current instance
+     */
+    show(display?: string): this;
+    /**
+     * Add a class to the classList object
+     *
+     * @param newClass - Class name to add
+     * @returns Current instance
+     */
+    addClass(newClass: string): this;
+    /**
+     * Remove a given class from the classList object
+     *
+     * @param oldClass - Class to remove. If it's empty or null, all classes will be removed
+     * @returns Current instance
+     */
+    removeClass(oldClass?: string | null): this;
+    /**
+     * Toggle between two classes
+     *
+     * @param classes - Space separated class names
+     * @returns Current instance
+     */
+    toggleClass(classes: string): this;
+    /**
+     * Check if ALL elements in the collection have the given class
+     *
+     * @param classToCheck - Class name to check for
+     * @returns Whether all elements have the class
+     */
+    hasClass(classToCheck: string): boolean;
+    /**
+     * Get or set the value from the elements
+     *
+     * @param value - Value to set to the elements
+     * @returns If a value is provided, returns current instance. Otherwise returns the value(s) - single value if one element, array if multiple.
+     */
+    value(value?: string): this | string | string[] | undefined;
+    /**
+     * Focus on the first element matching the selector
+     *
+     * @returns Current instance
+     */
+    focus(): this;
+    /**
+     * Add a callback for the 'click' event on every element matching the selector
+     *
+     * @param callback - Callback function to run when the event is triggered
+     * @returns Current instance
+     */
+    click(callback: EventCallback): this;
+    /**
+     * Add a callback for the 'keyup' event on every element matching the selector
+     *
+     * @param callback - Callback function to run when the event is triggered
+     * @returns Current instance
+     */
+    keyup(callback: EventCallback): this;
+    /**
+     * Add a callback for the 'keydown' event on every element matching the selector
+     *
+     * @param callback - Callback function to run when the event is triggered
+     * @returns Current instance
+     */
+    keydown(callback: EventCallback): this;
+    /**
+     * Add a callback for the 'submit' event on every element matching the selector
+     *
+     * @param callback - Callback function to run when the event is triggered
+     * @returns Current instance
+     */
+    submit(callback: EventCallback): this;
+    /**
+     * Add a callback for the 'change' event on every element matching the selector
+     *
+     * @param callback - Callback function to run when the event is triggered
+     * @returns Current instance
+     */
+    change(callback: EventCallback): this;
+    /**
+     * Add a callback for the 'scroll' event on every element matching the selector
+     *
+     * @param callback - Callback function to run when the event is triggered
+     * @returns Current instance
+     */
+    scroll(callback: EventCallback): this;
+    /**
+     * Add a callback function to a given event
+     *
+     * @param event - Event to add the listener to
+     * @param target - Target element on which to detect the event or callback function
+     * @param callback - Callback function to run when the event is triggered
+     * @returns Current instance
+     */
+    on(event: string, target: string | EventCallback, callback?: EventCallback): this;
+    /**
+     * Filter from the current collection to only those matching the new selector
+     * Applies to ALL elements in the collection
+     *
+     * @param selector - Selector to filter the collection with
+     * @returns New DOM instance with the filtered collection
+     */
+    filter(selector: string): DOM;
+    /**
+     * Check if there are any elements that match the selector.
+     *
+     * @returns Whether elements matching the selector existed or not
+     */
+    exists(): boolean;
+    /**
+     * Get or set a `data` property
+     *
+     * @param name - Name of the data property
+     * @param value - Value of the property
+     * @returns If no value is provided, returns the value(s) - single value if one element, array if multiple.
+     */
+    data(name: string, value?: string): this | string | string[] | undefined;
+    /**
+     * Remove a data property from all the elements on the collection given its name.
+     *
+     * @param name - Name of the data property to remove
+     * @returns Current instance
+     */
+    removeData(name: string): this;
+    /**
+     * Get or set the text of elements
+     *
+     * @param value - Value to set the text to
+     * @returns If no value is provided, returns the text(s) - single value if one element, array if multiple.
+     */
+    text(value?: string): this | string | (string | null)[] | null | undefined;
+    /**
+     * Get or set the inner HTML of elements
+     *
+     * @param value - Value to set the HTML to
+     * @returns If no value is provided, returns the HTML(s) - single value if one element, array if multiple.
+     */
+    html(value?: string): this | string | string[] | undefined;
+    /**
+     * Append an element to ALL elements in the collection
+     *
+     * @param element - String representation of the element to add or an Element
+     * @returns Current instance
+     */
+    append(element: string | Element): this;
+    /**
+     * Prepend an element to ALL elements in the collection
+     *
+     * @param element - String representation of the element to add or an Element
+     * @returns Current instance
+     */
+    prepend(element: string | Element): this;
+    /**
+     * Iterate over the collection of elements matching the selector
+     *
+     * @param callback - Callback to run for every element
+     * @returns Current instance
+     */
+    each(callback: ElementCallback): this;
+    /**
+     * Get an element from the collection given its index
+     *
+     * @param index - Index of the element to retrieve
+     * @returns HTML Element in the position indicated by the index
+     */
+    get(index: number): Element | undefined;
+    /**
+     * Get the first element in the collection
+     *
+     * @returns DOM instance with the first element
+     */
+    first(): DOM;
+    /**
+     * Get the last element in the collection
+     *
+     * @returns DOM instance with the last element
+     */
+    last(): DOM;
+    /**
+     * Check if any element in the collection is visible by checking their
+     * display, offsetWidth and offsetHeight properties
+     *
+     * @returns Whether any element is visible
+     */
+    isVisible(): boolean;
+    /**
+     * Get the parents of ALL elements in the collection
+     *
+     * @returns DOM instance of the parent elements
+     */
+    parent(): DOM;
+    /**
+     * Find elements that match the given selector in ALL elements of the collection
+     *
+     * @param selector - Selector to find elements with
+     * @returns DOM instance with found elements
+     */
+    find(selector: string): DOM;
+    /**
+     * Get the top and left offsets of elements in the collection
+     *
+     * @returns Single offset object if one element, array of offset objects if multiple
+     */
+    offset(): DOMOffset | DOMOffset[] | undefined;
+    /**
+     * Find the closest element matching the given selector for ALL elements.
+     * This bubbles up from the initial object and then follows to its parents.
+     *
+     * @param selector - Selector to match the closest element with
+     * @returns DOM instance with the closest HTML elements matching the selector
+     */
+    closest(selector: string): DOM;
+    /**
+     * Find the closest parent element matching the given selector. This bubbles up
+     * from the initial object and then follows to its parents.
+     *
+     * @param selector - Selector to match the closest element with
+     * @param limit - Selector for limit element. If the limit is reached and no element matching the provided selector was found, it will cause an early return.
+     * @returns DOM instance with the closest HTML element matching the selector
+     */
+    closestParent(selector: string, limit?: string): DOM;
+    /**
+     * Get or set the value of a given attribute
+     *
+     * @param attribute - Attribute's name
+     * @param value - Value to set the attribute to
+     * @returns If no value is provided, returns the attribute value(s) - single value if one element, array if multiple.
+     */
+    attribute(attribute: string, value?: string | number): this | string | (string | null)[] | null | undefined;
+    /**
+     * Check whether ALL elements have an attribute
+     *
+     * @param attribute - The name of the attribute to check existence for
+     * @returns Whether all elements have the attribute
+     */
+    hasAttribute(attribute: string): boolean;
+    /**
+     * Insert content after all elements in the collection
+     *
+     * @param content - String representation of the content to add
+     * @returns Current instance
+     */
+    after(content: string): this;
+    /**
+     * Insert content before all elements in the collection
+     *
+     * @param content - String representation of the content to add
+     * @returns Current instance
+     */
+    before(content: string): this;
+    /**
+     * Get or modify the `style` properties of the elements matching the selector
+     *
+     * @param properties - Properties to change or get. Can be either an individual property or a JSON object with key-value pairs
+     * @param value - Value to set the property to when only changing one property
+     * @returns If a property is given but not a value for it, returns the style value(s) - single value if one element, array if multiple.
+     */
+    style(properties: string | StyleProperties, value?: string): this | string | string[] | undefined;
+    /**
+     * Animate the given `style` properties on all elements in the collection
+     * with a given time duration
+     *
+     * @param style - JSON object with the key-value pairs of properties to animate
+     * @param time - Time in milliseconds during which the properties will be animated
+     * @returns Current instance
+     */
+    animate(style: Record<string, number>, time: number): this;
+    /**
+     * Use a fade in animation on ALL elements in the collection
+     *
+     * @param time - Time duration for the animation
+     * @param callback - Callback function to run once all animations are over
+     * @returns Current instance
+     */
+    fadeIn(time?: number, callback?: () => void): this;
+    /**
+     * Use a fade out animation on ALL elements in the collection
+     *
+     * @param time - Time duration for the animation
+     * @param callback - Callback function to run once all animations are over
+     * @returns Current instance
+     */
+    fadeOut(time?: number, callback?: () => void): this;
+    /**
+     * Check if ALL elements in the collection match a given selector
+     *
+     * @param selector - Selector to match
+     * @returns Whether all elements match the selector
+     */
+    matches(selector: string): boolean;
+    /**
+     * Remove all elements in the collection
+     *
+     * @returns Current instance
+     */
+    remove(): this;
+    /**
+     * Replace ALL elements in the collection with a new element
+     *
+     * @param newElement - The replacement element or HTML string
+     * @returns Current instance
+     */
+    replaceWith(newElement: string | Element): this;
+    /**
+     * Reset every element in the collection (for form elements)
+     *
+     * @returns Current instance
+     */
+    reset(): this;
+    /**
+     * Get or set a property for elements in the collection
+     *
+     * @param property - Property name to set or get
+     * @param value - Value to set the property to
+     * @returns If no value is provided, returns the property value(s) - single value if one element, array if multiple.
+     */
+    property<T = unknown>(property: string, value?: T): this | T | T[] | undefined;
+}
+/**
+ * Simple wrapper function to use the DOM library
+ *
+ * @param selector - Selector or DOM element to use
+ * @returns DOM instance
+ */
+export declare function $_(selector: DOMSelector): DOM;
+/**
+ * Utility function to attach the 'load' listener to the window
+ *
+ * @param callback - Callback function to run when the window is ready
+ */
+export declare function $_ready(callback: EventListener): void;
+//# sourceMappingURL=DOM.d.ts.map

package/dist/types/DOM.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DOM.d.ts","sourceRoot":"","sources":["../../src/DOM.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,EAAE,GAAG,QAAQ,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,WAAW,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;AAErH;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AAEzD;;GAEG;AACH,qBAAa,GAAG;IACR,UAAU,EAAE,OAAO,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,WAAW,CAAC;IAE9B;;;;OAIG;gBACS,QAAQ,EAAE,WAAW;IAmCjC;;;;OAIG;IACH,IAAI,IAAI,IAAI;IAOZ;;;;;OAKG;IACH,IAAI,CAAC,OAAO,GAAE,MAAgB,GAAG,IAAI;IAOrC;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAOhC;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,GAAE,MAAM,GAAG,IAAW,GAAG,IAAI;IAkBjD;;;;;OAKG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAUlC;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IASvC;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS;IAqB3D;;;;OAIG;IACH,KAAK,IAAI,IAAI;IAOb;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOpC;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOpC;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOtC;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOrC;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOrC;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI;IAOrC;;;;;;;OAOG;IACH,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE,QAAQ,CAAC,EAAE,aAAa,GAAG,IAAI;IA0BjF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG;IAU7B;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAIjB;;;;;;OAMG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS;IAqBxE;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAO9B;;;;;OAKG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS;IAqB1E;;;;;OAKG;IACH,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS;IAqB1D;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI;IAevC;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI;IAuBxC;;;;;OAKG;IACH,IAAI,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI;IAOrC;;;;;OAKG;IACH,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAIvC;;;;OAIG;IACH,KAAK,IAAI,GAAG;IAOZ;;;;OAIG;IACH,IAAI,IAAI,GAAG;IAOX;;;;;OAKG;IACH,SAAS,IAAI,OAAO;IAUpB;;;;OAIG;IACH,MAAM,IAAI,GAAG;IAUb;;;;;OAKG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG;IAa3B;;;;OAIG;IACH,MAAM,IAAI,SAAS,GAAG,SAAS,EAAE,GAAG,SAAS;IAsB7C;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG;IAW9B;;;;;;;OAOG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG;IAsBpD;;;;;;OAMG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS;IAqB3G;;;;;OAKG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IASxC;;;;;OAKG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAO5B;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAO7B;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS;IA8BjG;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAqC1D;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,GAAE,MAAY,EAAE,QAAQ,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;IA8BvD;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,GAAE,MAAY,EAAE,QAAQ,CAAC,EAAE,MAAM,IAAI,GAAG,IAAI;IA4BxD;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAclC;;;;OAIG;IACH,MAAM,IAAI,IAAI;IAOd;;;;;OAKG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI;IAiB/C;;;;OAIG;IACH,KAAK,IAAI,IAAI;IASb;;;;;;OAMG;IACH,QAAQ,CAAC,CAAC,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,SAAS;CAoB9E;AAED;;;;;GAKG;AACH,wBAAgB,EAAE,CAAC,QAAQ,EAAE,WAAW,GAAG,GAAG,CAE7C;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,aAAa,GAAG,IAAI,CAErD"}

package/dist/types/Debug.d.ts

@@ -0,0 +1,118 @@
+/**
+ * ==============================
+ * Debug
+ * ==============================
+ */
+/**
+ * Debug level enum
+ */
+export declare enum DebugLevel {
+    NONE = 0,
+    ERROR = 1,
+    WARNING = 2,
+    INFO = 3,
+    DEBUG = 4,
+    ALL = 5
+}
+/**
+ * This class acts as a proxy for the console. It shares the same methods as the
+ * web console but they are conditioned to a debug level.
+ */
+export declare class Debug {
+    private static _level;
+    /**
+     * Set or get the log level
+     *
+     * @param level - The debug level to use
+     * @returns The current debug level
+     */
+    static level(level?: DebugLevel): DebugLevel;
+    /**
+     * Log the given elements.
+     * Logs will only be made if the level is set to DEBUG or above
+     *
+     * @param args - Arguments to log
+     */
+    static log(...args: unknown[]): void;
+    /**
+     * Show a debugging log
+     * Logs will only be made if the level is set DEBUG or above
+     *
+     * @param args - Arguments to log
+     */
+    static debug(...args: unknown[]): void;
+    /**
+     * Show an info log
+     * Logs will only be made if the level is set to INFO or above
+     *
+     * @param args - Arguments to log
+     */
+    static info(...args: unknown[]): void;
+    /**
+     * Show an error log
+     * Logs will only be made if the level is set to ERROR or above
+     *
+     * @param args - Arguments to log
+     */
+    static error(...args: unknown[]): void;
+    /**
+     * Show a warning log
+     * Logs will only be made if the level is set to WARNING or above
+     *
+     * @param args - Arguments to log
+     */
+    static warning(...args: unknown[]): void;
+    /**
+     * Show data as a table
+     * Table will only be made if the level is set to DEBUG or above
+     *
+     * @param args - Arguments to display as table
+     */
+    static table(...args: unknown[]): void;
+    /**
+     * Start an indented group
+     *
+     * @param args - Group label arguments
+     */
+    static group(...args: unknown[]): void;
+    /**
+     * Start an indented group collapsed by default
+     *
+     * @param args - Group label arguments
+     */
+    static groupCollapsed(...args: unknown[]): void;
+    /**
+     * End a previously started group
+     */
+    static groupEnd(): void;
+    /**
+     * Start a timer
+     * The timer will only start if the level is set to DEBUG or above
+     *
+     * @param label - Timer label
+     */
+    static time(label?: string): void;
+    /**
+     * Log the time a timer has been running for
+     * The time will only be logged if the level is set to DEBUG or above
+     *
+     * @param label - Timer label
+     * @param args - Additional arguments to log
+     */
+    static timeLog(label?: string, ...args: unknown[]): void;
+    /**
+     * End a timer
+     * The timer will only be available if the level is set to DEBUG or above
+     *
+     * @param label - Timer label
+     */
+    static timeEnd(label?: string): void;
+    /**
+     * Show the stack trace
+     * The stack trace will only be available if the level is set to DEBUG or above
+     *
+     * @param args - Arguments to log with trace
+     */
+    static trace(...args: unknown[]): void;
+}
+//# sourceMappingURL=Debug.d.ts.map

package/dist/types/Debug.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Debug.d.ts","sourceRoot":"","sources":["../../src/Debug.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH;;GAEG;AACH,oBAAY,UAAU;IACrB,IAAI,IAAI;IACR,KAAK,IAAI;IACT,OAAO,IAAI;IACX,IAAI,IAAI;IACR,KAAK,IAAI;IACT,GAAG,IAAI;CACP;AAED;;;GAGG;AACH,qBAAa,KAAK;IACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CAA+B;IAEpD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,UAAU;IAO5C;;;;;OAKG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMpC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMtC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMrC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMtC;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMxC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMtC;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMtC;;;;OAIG;IACH,MAAM,CAAC,cAAc,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAM/C;;OAEG;IACH,MAAM,CAAC,QAAQ,IAAI,IAAI;IAMvB;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAMjC;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAMxD;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAMpC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;CAKtC"}

package/dist/types/FileSystem.d.ts

@@ -0,0 +1,69 @@
+/**
+ * ==============================
+ * File System
+ * ==============================
+ */
+import { RequestOptions } from './Request';
+/**
+ * File read type options
+ */
+export type FileReadType = 'text' | 'base64' | 'buffer';
+/**
+ * File read result type based on read type
+ */
+export interface FileReadResult {
+    event: ProgressEvent<FileReader>;
+    content: string | ArrayBuffer | null;
+}
+/**
+ * A simple class wrapper for the File and FileReader web API, while this class
+ * doesn't actually provide access to the host file system, it does provide useful
+ * utilities for form file inputs and remote content loading.
+ */
+export declare class FileSystem {
+    /**
+     * Read a file from a remote location given a URL. This function will fetch
+     * the file blob using the Request class and then use the read() function
+     * to read the blob in the format required.
+     *
+     * @param url - URL to fetch the file from
+     * @param type - Type of data to be read, values can be 'text', 'base64' and 'buffer'
+     * @param props - Props to send to the Request object
+     * @returns Content of the file. The format depends on the type parameter used.
+     */
+    static readRemote(url: string, type?: FileReadType, props?: RequestOptions): Promise<FileReadResult>;
+    /**
+     * Read a given File or Blob object.
+     *
+     * @param file - File to read
+     * @param type - Type of data to be read, values can be 'text', 'base64' and 'buffer'
+     * @returns Promise that resolves to the load event and content of the file
+     */
+    static read(file: File | Blob, type?: FileReadType): Promise<FileReadResult>;
+    /**
+     * Create a new File, this uses the File API and will not actually create
+     * a file in the user's file system, however using it with other features,
+     * that may be possible
+     *
+     * @param name - Name of the file (Including extension)
+     * @param content - Content to save in the file
+     * @param type - Mime Type for the file
+     * @returns Promise resolving to the created File
+     */
+    static create(name: string, content: BlobPart, type?: string): Promise<File>;
+    /**
+     * Returns the extension of a file given its file name.
+     *
+     * @param name - Name or full path of the file
+     * @returns File extension without the leading dot (.)
+     */
+    static extension(name: string): string;
+    /**
+     * Check if a file is an image by its extension.
+     *
+     * @param name - Name or full path of the file
+     * @returns Whether the file is an image
+     */
+    static isImage(name: string): boolean;
+}
+//# sourceMappingURL=FileSystem.d.ts.map

package/dist/types/FileSystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystem.d.ts","sourceRoot":"","sources":["../../src/FileSystem.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAW,cAAc,EAAE,MAAM,WAAW,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,KAAK,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC;IACjC,OAAO,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI,CAAC;CACrC;AAED;;;;GAIG;AACH,qBAAa,UAAU;IACtB;;;;;;;;;OASG;IACH,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,YAAuB,EAAE,KAAK,GAAE,cAAmB,GAAG,OAAO,CAAC,cAAc,CAAC;IAMlH;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,IAAI,GAAE,YAAqB,GAAG,OAAO,CAAC,cAAc,CAAC;IA0BpF;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,GAAE,MAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1F;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAItC;;;;;OAKG;IACH,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;CAIrC"}

package/dist/types/Form.d.ts

@@ -0,0 +1,32 @@
+/**
+ * ==============================
+ * Form
+ * ==============================
+ */
+/**
+ * Form data object type
+ */
+export type FormData = Record<string, string | File | FileList | undefined>;
+/**
+ * Utility class that provides simple functions for filling and retrieving values
+ * from forms. This class requires the use of the `data-form` attribute.
+ */
+export declare class Form {
+    /**
+     * Fill a form's inputs with the given values. Each key in the provided object
+     * must match the `name` attribute of the input to fill.
+     *
+     * @param name - Form name. Must match the `data-form` attribute of the Form.
+     * @param data - JSON object with key-value pairs to fill the inputs.
+     */
+    static fill(name: string, data: Record<string, string>): void;
+    /**
+     * Get all the values from a form's inputs. The keys are mapped using the
+     * `name` attribute of each input.
+     *
+     * @param name - Form name. Must match the `data-form` attribute of the Form.
+     * @returns Key-value JSON object
+     */
+    static values(name: string): FormData;
+}
+//# sourceMappingURL=Form.d.ts.map

package/dist/types/Form.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Form.d.ts","sourceRoot":"","sources":["../../src/Form.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,QAAQ,GAAG,SAAS,CAAC,CAAC;AAE5E;;;GAGG;AACH,qBAAa,IAAI;IAChB;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAkB7D;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ;CAwBrC"}