@sme.up/ketchup 8.0.2 → 8.1.0

package/dist/types/managers/kup-debug/kup-debug.d.ts

@@ -1,95 +1,95 @@
-import type { GenericObject } from '../../types/GenericTypes';
-import { KupDebugCategory, KupDebugLog } from './kup-debug-declarations';
-/**
- * Debugging suite, used to log messages and statuses from the Ketchup components.
- * @module KupDebug
- */
-export declare class KupDebug {
-  #private;
-  active: boolean;
-  autoPrint: boolean;
-  container: HTMLElement;
-  logLimit: number;
-  logs: KupDebugLog[];
-  /**
-   * Initializes KupDebug.
-   * @param {boolean} active - When true, the debug is active on initialization.
-   * @param {boolean} autoprint - When true, logs will be automatically printed inside the debug widget.
-   * @param {number} logLimit - Maximum amount of logs stored, when they exceed the number specified in logLimit the cache will be automatically cleared.
-   */
-  constructor(active?: boolean, autoprint?: boolean, logLimit?: number);
-  /**
-   * Allows the download of props by creating a temporary clickable anchor element.
-   */
-  private downloadProps;
-  /**
-   * Creates the debug widget.
-   */
-  private showWidget;
-  /**
-   * Listens the card events and handles the related actions.
-   * @param {CustomEvent<KupCardEventPayload>} e - kup-card-event.
-   * @param {KupDebug} kupDebug - Instance of the KupDebug class.
-   */
-  private handleEvents;
-  /**
-   * Closes the debug widget.
-   */
-  private hideWidget;
-  /**
-   * Clears all the printed logs inside the debug widget.
-   */
-  private widgetClear;
-  /**
-   * Prints the stored logs inside the debug widget.
-   */
-  private widgetPrint;
-  /**
-   * Dumps the stored logs.
-   */
-  dump(): void;
-  /**
-   * Displays a table with debug information inside the browser's console.
-   */
-  print(): void;
-  /**
-   * Function used to set the status of the debug.
-   * If no argument is provided, this method will work as a toggler.
-   * @param {boolean} value - If this argument is provided, the debug status will be forced to its value.
-   */
-  toggle(value?: boolean): void;
-  /**
-   * Function used to check whether the debug is active or not.
-   * @returns {boolean} Status of the debug.
-   */
-  isDebug(): boolean;
-  /**
-   * Retrieves the information for every component in this.logs by invoking the getProps public method of each component.
-   * 'tag' will contain the props of the component's html tag (i.e.: <kup-chip>).
-   * 'props' will contain the developer defined props of the component, making it handy for test purposes.
-   * @param {boolean} detail - If provided and true, the returned object will contain additional information (i.e.: className, id).
-   * @returns {GenericObject} Props of the components.
-   */
-  getProps(detail?: boolean): Promise<GenericObject>;
-  /**
-   * Displays a timestamped message in the browser's console when the kupDebug property on document.documentElement is true.
-   * Warnings and errors will be displayed even when kupDebug !== true.
-   * @param {any} comp - The component calling this function or a string.
-   * @param {string} message - The actual message that will be printed.
-   * @param {KupDebugCategory} category - The type of console message, defaults to log but warning and error can be used as well.
-   */
-  logMessage(comp: any, message: string, category?: KupDebugCategory): void;
-  /**
-   * Function used to time the loading times of a component.
-   * @param {any} comp - The component calling this function or a string.
-   * @param {boolean} didLoad - Must be set to false when called inside a componentWillLoad() lifecycle hook and true when called inside componentDidLoad().
-   */
-  logLoad(comp: any, didLoad: boolean): void;
-  /**
-   * Function used to time the render times of a component.
-   * @param {any} comp - The component calling this function or a string.
-   * @param {boolean} didRender - Must be set to false when called inside a componentWillRender() lifecycle hook and true when called inside componentDidRender().
-   * @param {string} breakpoint - When present, this log is supposedly between a willRender and didRender hook. Used to time single features of the render lifecycle.
-   */
-  logRender(comp: any, didRender: boolean, breakpoint?: string): void;
-}
+import type { GenericObject } from '../../types/GenericTypes';
+import { KupDebugCategory, KupDebugLog } from './kup-debug-declarations';
+/**
+ * Debugging suite, used to log messages and statuses from the Ketchup components.
+ * @module KupDebug
+ */
+export declare class KupDebug {
+  #private;
+  active: boolean;
+  autoPrint: boolean;
+  container: HTMLElement;
+  logLimit: number;
+  logs: KupDebugLog[];
+  /**
+   * Initializes KupDebug.
+   * @param {boolean} active - When true, the debug is active on initialization.
+   * @param {boolean} autoprint - When true, logs will be automatically printed inside the debug widget.
+   * @param {number} logLimit - Maximum amount of logs stored, when they exceed the number specified in logLimit the cache will be automatically cleared.
+   */
+  constructor(active?: boolean, autoprint?: boolean, logLimit?: number);
+  /**
+   * Allows the download of props by creating a temporary clickable anchor element.
+   */
+  private downloadProps;
+  /**
+   * Creates the debug widget.
+   */
+  private showWidget;
+  /**
+   * Listens the card events and handles the related actions.
+   * @param {CustomEvent<KupCardEventPayload>} e - kup-card-event.
+   * @param {KupDebug} kupDebug - Instance of the KupDebug class.
+   */
+  private handleEvents;
+  /**
+   * Closes the debug widget.
+   */
+  private hideWidget;
+  /**
+   * Clears all the printed logs inside the debug widget.
+   */
+  private widgetClear;
+  /**
+   * Prints the stored logs inside the debug widget.
+   */
+  private widgetPrint;
+  /**
+   * Dumps the stored logs.
+   */
+  dump(): void;
+  /**
+   * Displays a table with debug information inside the browser's console.
+   */
+  print(): void;
+  /**
+   * Function used to set the status of the debug.
+   * If no argument is provided, this method will work as a toggler.
+   * @param {boolean} value - If this argument is provided, the debug status will be forced to its value.
+   */
+  toggle(value?: boolean): void;
+  /**
+   * Function used to check whether the debug is active or not.
+   * @returns {boolean} Status of the debug.
+   */
+  isDebug(): boolean;
+  /**
+   * Retrieves the information for every component in this.logs by invoking the getProps public method of each component.
+   * 'tag' will contain the props of the component's html tag (i.e.: <kup-chip>).
+   * 'props' will contain the developer defined props of the component, making it handy for test purposes.
+   * @param {boolean} detail - If provided and true, the returned object will contain additional information (i.e.: className, id).
+   * @returns {GenericObject} Props of the components.
+   */
+  getProps(detail?: boolean): Promise<GenericObject>;
+  /**
+   * Displays a timestamped message in the browser's console when the kupDebug property on document.documentElement is true.
+   * Warnings and errors will be displayed even when kupDebug !== true.
+   * @param {any} comp - The component calling this function or a string.
+   * @param {string} message - The actual message that will be printed.
+   * @param {KupDebugCategory} category - The type of console message, defaults to log but warning and error can be used as well.
+   */
+  logMessage(comp: any, message: string, category?: KupDebugCategory): void;
+  /**
+   * Function used to time the loading times of a component.
+   * @param {any} comp - The component calling this function or a string.
+   * @param {boolean} didLoad - Must be set to false when called inside a componentWillLoad() lifecycle hook and true when called inside componentDidLoad().
+   */
+  logLoad(comp: any, didLoad: boolean): void;
+  /**
+   * Function used to time the render times of a component.
+   * @param {any} comp - The component calling this function or a string.
+   * @param {boolean} didRender - Must be set to false when called inside a componentWillRender() lifecycle hook and true when called inside componentDidRender().
+   * @param {string} breakpoint - When present, this log is supposedly between a willRender and didRender hook. Used to time single features of the render lifecycle.
+   */
+  logRender(comp: any, didRender: boolean, breakpoint?: string): void;
+}

package/dist/types/managers/kup-dynamic-position/kup-dynamic-position-declarations.d.ts

@@ -1,50 +1,50 @@
-/**
- * HTML attribute attached to dynamically positioned elements.
- */
-export declare const kupDynamicPositionAttribute = "kup-dynamic-position";
-/**
- * HTML attribute attached to dynamically positioned elements' anchor point.
- */
-export declare const kupDynamicPositionAnchorAttribute = "kup-dynamic-position-anchor";
-/**
- * CSS class attached to dynamically positioned elements when the script is running.
- */
-export declare const kupDynamicPositionActiveClass = "kup-dynamic-position-active";
-/**
- * Master type extending all subtypes of available anchor points.
- */
-export type KupDynamicPositionAnchor = HTMLElement | KupDynamicPositionCoordinates;
-/**
- * Fixed position element.
- */
-export interface KupDynamicPositionElement extends HTMLElement {
-  kupDynamicPosition?: {
-    anchor: KupDynamicPositionAnchor;
-    detach: boolean;
-    margin: number;
-    originalPath: HTMLElement[];
-    placement: KupDynamicPositionPlacement;
-    rAF: number;
-  };
-}
-/**
- * Coordinates for fixed positioning.
- */
-export interface KupDynamicPositionCoordinates {
-  x: number;
-  y: number;
-}
-/**
- * Available placements.
- */
-export declare enum KupDynamicPositionPlacement {
-  AUTO = "",
-  BOTTOM = "b",
-  BOTTOM_LEFT = "bl",
-  BOTTOM_RIGHT = "br",
-  LEFT = "l",
-  RIGHT = "r",
-  TOP = "t",
-  TOP_LEFT = "tl",
-  TOP_RIGHT = "tr"
-}
+/**
+ * HTML attribute attached to dynamically positioned elements.
+ */
+export declare const kupDynamicPositionAttribute = "kup-dynamic-position";
+/**
+ * HTML attribute attached to dynamically positioned elements' anchor point.
+ */
+export declare const kupDynamicPositionAnchorAttribute = "kup-dynamic-position-anchor";
+/**
+ * CSS class attached to dynamically positioned elements when the script is running.
+ */
+export declare const kupDynamicPositionActiveClass = "kup-dynamic-position-active";
+/**
+ * Master type extending all subtypes of available anchor points.
+ */
+export type KupDynamicPositionAnchor = HTMLElement | KupDynamicPositionCoordinates;
+/**
+ * Fixed position element.
+ */
+export interface KupDynamicPositionElement extends HTMLElement {
+  kupDynamicPosition?: {
+    anchor: KupDynamicPositionAnchor;
+    detach: boolean;
+    margin: number;
+    originalPath: HTMLElement[];
+    placement: KupDynamicPositionPlacement;
+    rAF: number;
+  };
+}
+/**
+ * Coordinates for fixed positioning.
+ */
+export interface KupDynamicPositionCoordinates {
+  x: number;
+  y: number;
+}
+/**
+ * Available placements.
+ */
+export declare enum KupDynamicPositionPlacement {
+  AUTO = "",
+  BOTTOM = "b",
+  BOTTOM_LEFT = "bl",
+  BOTTOM_RIGHT = "br",
+  LEFT = "l",
+  RIGHT = "r",
+  TOP = "t",
+  TOP_LEFT = "tl",
+  TOP_RIGHT = "tr"
+}

package/dist/types/managers/kup-dynamic-position/kup-dynamic-position.d.ts

@@ -1,61 +1,61 @@
-import { KupDynamicPositionAnchor, KupDynamicPositionElement } from './kup-dynamic-position-declarations';
-import { KupDynamicPositionPlacement } from './kup-dynamic-position-declarations';
-/**
- * This class is used to dynamically reposition HTML elements.
- * @module KupDynamicPosition
- */
-export declare class KupDynamicPosition {
-  container: HTMLElement;
-  managedElements: Set<KupDynamicPositionElement>;
-  /**
-   * Initializes KupDynamicPosition.
-   */
-  constructor();
-  /**
-   * Function used to check whether the anchor point is an HTMLElement or a set of coordinates.
-   * @param {KupDynamicPositionAnchor} anchor - Anchor point.
-   * @returns {anchor is HTMLElement} Returns true when the anchor point is an HTMLElement.
-   */
-  anchorIsHTMLElement(anchor: KupDynamicPositionAnchor): anchor is HTMLElement;
-  /**
-   * Watches the element eligible to dynamic positioning.
-   * @param {KupDynamicPositionElement} el - Element to reposition.
-   * @param {KupDynamicPositionAnchor} anchorEl - "el" position will be anchored to this element or to these coordinates.
-   * @param {number} margin - "el" distance from its parent in pixels.
-   * @param {KupDynamicPositionPlacement} placement - "el" placement.
-   * @param {boolean} detach - When true, the function won't be recursive but it will be executed only once. "el" will be detached from its original parent and it will be appended to this.container.
-   */
-  register(el: KupDynamicPositionElement, anchorEl: KupDynamicPositionAnchor, margin?: number, placement?: KupDynamicPositionPlacement, detach?: boolean): void;
-  /**
-   * Changes the anchor point of the given element.
-   * @param {KupDynamicPositionElement} elements - Dynamically positioned element previously registered.
-   * @param {KupDynamicPositionAnchor} anchorEl - New anchor point.
-   */
-  changeAnchor(el: KupDynamicPositionElement, anchorEl: KupDynamicPositionAnchor): void;
-  /**
-   * Removes the element from dynamic position management.
-   * @param {KupDynamicPositionElement[]} elements - Elements to remove from the managed elements set.
-   */
-  unregister(elements: KupDynamicPositionElement[]): void;
-  /**
-   * Returns whether an element was previously registered or not.
-   * @param {KupDynamicPositionElement} el - Element to test.
-   * @returns {boolean} True if the element was registered.
-   */
-  isRegistered(el: KupDynamicPositionElement): boolean;
-  /**
-   * Starts the process of dynamically reposition the element (which must be firstly initialized through this.setup()).
-   * @param {KupDynamicPositionElement} el - Element to reposition.
-   */
-  start(el: KupDynamicPositionElement): void;
-  /**
-   * Ends the process of dynamically reposition the element.
-   * @param {KupDynamicPositionElement} el - Element to reposition.
-   */
-  stop(el: KupDynamicPositionElement): void;
-  /**
-   * This function calculates where to place the element in order to correctly display it attached to its anchor point.
-   * @param {KupDynamicPositionElement} el - Element to reposition.
-   */
-  run(el: KupDynamicPositionElement): void;
-}
+import { KupDynamicPositionAnchor, KupDynamicPositionElement } from './kup-dynamic-position-declarations';
+import { KupDynamicPositionPlacement } from './kup-dynamic-position-declarations';
+/**
+ * This class is used to dynamically reposition HTML elements.
+ * @module KupDynamicPosition
+ */
+export declare class KupDynamicPosition {
+  container: HTMLElement;
+  managedElements: Set<KupDynamicPositionElement>;
+  /**
+   * Initializes KupDynamicPosition.
+   */
+  constructor();
+  /**
+   * Function used to check whether the anchor point is an HTMLElement or a set of coordinates.
+   * @param {KupDynamicPositionAnchor} anchor - Anchor point.
+   * @returns {anchor is HTMLElement} Returns true when the anchor point is an HTMLElement.
+   */
+  anchorIsHTMLElement(anchor: KupDynamicPositionAnchor): anchor is HTMLElement;
+  /**
+   * Watches the element eligible to dynamic positioning.
+   * @param {KupDynamicPositionElement} el - Element to reposition.
+   * @param {KupDynamicPositionAnchor} anchorEl - "el" position will be anchored to this element or to these coordinates.
+   * @param {number} margin - "el" distance from its parent in pixels.
+   * @param {KupDynamicPositionPlacement} placement - "el" placement.
+   * @param {boolean} detach - When true, the function won't be recursive but it will be executed only once. "el" will be detached from its original parent and it will be appended to this.container.
+   */
+  register(el: KupDynamicPositionElement, anchorEl: KupDynamicPositionAnchor, margin?: number, placement?: KupDynamicPositionPlacement, detach?: boolean): void;
+  /**
+   * Changes the anchor point of the given element.
+   * @param {KupDynamicPositionElement} elements - Dynamically positioned element previously registered.
+   * @param {KupDynamicPositionAnchor} anchorEl - New anchor point.
+   */
+  changeAnchor(el: KupDynamicPositionElement, anchorEl: KupDynamicPositionAnchor): void;
+  /**
+   * Removes the element from dynamic position management.
+   * @param {KupDynamicPositionElement[]} elements - Elements to remove from the managed elements set.
+   */
+  unregister(elements: KupDynamicPositionElement[]): void;
+  /**
+   * Returns whether an element was previously registered or not.
+   * @param {KupDynamicPositionElement} el - Element to test.
+   * @returns {boolean} True if the element was registered.
+   */
+  isRegistered(el: KupDynamicPositionElement): boolean;
+  /**
+   * Starts the process of dynamically reposition the element (which must be firstly initialized through this.setup()).
+   * @param {KupDynamicPositionElement} el - Element to reposition.
+   */
+  start(el: KupDynamicPositionElement): void;
+  /**
+   * Ends the process of dynamically reposition the element.
+   * @param {KupDynamicPositionElement} el - Element to reposition.
+   */
+  stop(el: KupDynamicPositionElement): void;
+  /**
+   * This function calculates where to place the element in order to correctly display it attached to its anchor point.
+   * @param {KupDynamicPositionElement} el - Element to reposition.
+   */
+  run(el: KupDynamicPositionElement): void;
+}