@sme.up/ketchup 8.0.1 → 8.1.0

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

@@ -1,52 +1,52 @@
-import { KupComponent } from '../../types/GenericTypes';
-import { KupLanguageDecode, KupLanguageJSON, KupLanguageKey } from './kup-language-declarations';
-/**
- * Handles the translation to different languages.
- * @module KupLanguage
- */
-export declare class KupLanguage {
-  list: KupLanguageJSON;
-  managedComponents: Set<KupComponent>;
-  name: string;
-  /**
-   * Initializes KupLanguage.
-   * @param {KupLanguageJSON} list - Overrides the default languages.json.
-   * @param {string} name - Starting language. Can be a combination of language and variant (separated by "_").
-   */
-  constructor(list?: KupLanguageJSON, name?: string);
-  /**
-   * Translates the string to the given language.
-   * When translation fails, the key will be displayed in place of the string - this way it will be easier to correct missing string <-> key bounds.
-   * @param {KupLanguageKey} key - Key of a string to be translated.
-   * @param {string} language - Language to translate the string to. When not provided, KupLanguage current language will be used.
-   * @returns {string} Translated string or initial string (when translation failed).
-   */
-  translate(key: KupLanguageKey, language?: string): string;
-  /**
-   * Changes the current Ketchup language to the one provided. If the language argument contains a "_", a combo of language and variant will be assumed.
-   * @param {string} language - The new language. If not present in this.list, this function will keep the previous language.
-   */
-  set(language: string): void;
-  /**
-   * Checks whether the language is a combination of main language and variant (separated by "_"), returning them splitted in an object.
-   * @param {string} language - Language to check.
-   * @returns {KupLanguageDecode} Object containing language and variant.
-   */
-  decodeLanguage(language: string): KupLanguageDecode;
-  /**
-   * Gets the name of available languages and variants.
-   * @returns {Array<string>} Array of languages' names.
-   */
-  getLanguages(): Array<string>;
-  /**
-   * Registers a KupComponent in KupLanguage, in order to be automatically refreshed whenever the language changes.
-   * @param {any} component - The component calling this function.
-   */
-  register(component: any): void;
-  /**
-   * Unregisters a KupComponent, so it won't be refreshed when the language changes.
-   *
-   * @param {any} component - The component calling this function.
-   */
-  unregister(component: any): void;
-}
+import { KupComponent } from '../../types/GenericTypes';
+import { KupLanguageDecode, KupLanguageJSON, KupLanguageKey } from './kup-language-declarations';
+/**
+ * Handles the translation to different languages.
+ * @module KupLanguage
+ */
+export declare class KupLanguage {
+  list: KupLanguageJSON;
+  managedComponents: Set<KupComponent>;
+  name: string;
+  /**
+   * Initializes KupLanguage.
+   * @param {KupLanguageJSON} list - Overrides the default languages.json.
+   * @param {string} name - Starting language. Can be a combination of language and variant (separated by "_").
+   */
+  constructor(list?: KupLanguageJSON, name?: string);
+  /**
+   * Translates the string to the given language.
+   * When translation fails, the key will be displayed in place of the string - this way it will be easier to correct missing string <-> key bounds.
+   * @param {KupLanguageKey} key - Key of a string to be translated.
+   * @param {string} language - Language to translate the string to. When not provided, KupLanguage current language will be used.
+   * @returns {string} Translated string or initial string (when translation failed).
+   */
+  translate(key: KupLanguageKey, language?: string): string;
+  /**
+   * Changes the current Ketchup language to the one provided. If the language argument contains a "_", a combo of language and variant will be assumed.
+   * @param {string} language - The new language. If not present in this.list, this function will keep the previous language.
+   */
+  set(language: string): void;
+  /**
+   * Checks whether the language is a combination of main language and variant (separated by "_"), returning them splitted in an object.
+   * @param {string} language - Language to check.
+   * @returns {KupLanguageDecode} Object containing language and variant.
+   */
+  decodeLanguage(language: string): KupLanguageDecode;
+  /**
+   * Gets the name of available languages and variants.
+   * @returns {Array<string>} Array of languages' names.
+   */
+  getLanguages(): Array<string>;
+  /**
+   * Registers a KupComponent in KupLanguage, in order to be automatically refreshed whenever the language changes.
+   * @param {any} component - The component calling this function.
+   */
+  register(component: any): void;
+  /**
+   * Unregisters a KupComponent, so it won't be refreshed when the language changes.
+   *
+   * @param {any} component - The component calling this function.
+   */
+  unregister(component: any): void;
+}

package/dist/types/managers/kup-manager/kup-manager-declarations.d.ts

@@ -1,162 +1,162 @@
-import type { Interaction } from '@interactjs/core/Interaction';
-import type { ActionMap } from '@interactjs/core/scope';
-import type { RectResolvable } from '@interactjs/types/index';
-import type { KupData } from '../kup-data/kup-data';
-import type { KupDates } from '../kup-dates/kup-dates';
-import type { KupDatesLocales } from '../kup-dates/kup-dates-declarations';
-import type { KupDebug } from '../kup-debug/kup-debug';
-import type { KupDynamicPosition } from '../kup-dynamic-position/kup-dynamic-position';
-import type { KupInteract } from '../kup-interact/kup-interact';
-import type { KupLanguage } from '../kup-language/kup-language';
-import type { KupLanguageJSON } from '../kup-language/kup-language-declarations';
-import type { KupMath } from '../kup-math/kup-math';
-import type { KupObjects } from '../kup-objects/kup-objects';
-import type { KupObjectsJSON } from '../kup-objects/kup-objects-declarations';
-import type { KupScrollOnHover } from '../kup-scroll-on-hover/kup-scroll-on-hover';
-import type { KupSearch } from '../kup-search/kup-search';
-import type { KupTheme } from '../kup-theme/kup-theme';
-import type { KupThemeJSON } from '../kup-theme/kup-theme-declarations';
-import type { KupToolbar } from '../kup-toolbar/kup-toolbar';
-import type { KupTooltip } from '../kup-tooltip/kup-tooltip';
-import type { ResizeObserver } from 'resize-observer';
-import { KupMathLocales } from '../kup-math/kup-math-declarations';
-import { KupTooltipCallbacks } from '../kup-tooltip/kup-tooltip-declarations';
-import { Options } from 'html2canvas';
-/**
- * Interface used to define the HTML element with Ketchup specific properties.
- */
-export interface KupDom extends HTMLHtmlElement {
-  ketchup: KupManager;
-  ketchupInit: KupManagerInitialization;
-}
-/**
- * Interface for the KupManager class
- */
-export interface KupManager {
-  data: KupData;
-  dates: KupDates;
-  debug: KupDebug;
-  dynamicPosition: KupDynamicPosition;
-  interact: KupInteract;
-  language: KupLanguage;
-  magicBox: HTMLKupMagicBoxElement;
-  math: KupMath;
-  objects: KupObjects;
-  overrides?: KupManagerInitialization;
-  resize: ResizeObserver;
-  scrollOnHover: KupScrollOnHover;
-  search: KupSearch;
-  theme: KupTheme;
-  toolbar: KupToolbar;
-  tooltip: KupTooltip;
-  utilities: KupManagerUtilities;
-  showMagicBox: () => void;
-  hideMagicBox: () => void;
-  toggleMagicBox: () => void;
-  setLibraryLocalization: (locale: KupDatesLocales) => void;
-  addClickCallback: (cb: KupManagerClickCb, async?: boolean) => void;
-  getEventPath: (currentEl: unknown, rootElement: HTMLElement) => HTMLElement[];
-  removeClickCallback: (cb: KupManagerClickCb) => void;
-  rasterize: (el: HTMLElement, options?: Partial<Options>) => Promise<HTMLCanvasElement>;
-}
-/**
- * Interface for the KupManager utilities.
- */
-export interface KupManagerUtilities {
-  clickCallbacks?: Set<KupManagerClickCb>;
-  lastPointerDownString?: string;
-}
-/**
- * Interface to declare callbacks automatically invoked on pointer down events.
- */
-export interface KupManagerClickCb {
-  cb: () => unknown;
-  el?: HTMLElement;
-}
-/**
- * Interface for the KupManager override settings.
- */
-export interface KupManagerInitialization {
-  assetsPath?: string;
-  autoSetLocalization?: boolean;
-  dates?: KupManagerDatesSettings;
-  debug?: KupManagerDebugSettings;
-  interact?: KupManagerInteractSettings;
-  language?: KupManagerLanguageSettings;
-  math?: KupManagerMathSettings;
-  objects?: KupManagerObjectsSettings;
-  scrollOnHover?: KupManagerScrollOnHoverSettings;
-  theme?: KupManagerThemeSettings;
-  tooltip?: KupManagerTooltipSettings;
-}
-/**
- * KupDates initialization settings.
- */
-export interface KupManagerDatesSettings {
-  locale?: KupDatesLocales;
-}
-/**
- * KupDebug initialization settings.
- */
-export interface KupManagerDebugSettings {
-  active?: boolean;
-  autoPrint?: boolean;
-  logLimit?: number;
-}
-/**
- * KupDialog initialization settings.
- */
-export interface KupManagerInteractSettings {
-  restrictContainer?: RectResolvable<[
-    number,
-    number,
-    Interaction<keyof ActionMap>
-  ]>;
-  zIndex?: number;
-}
-/**
- * KupLanguage initialization settings.
- */
-export interface KupManagerLanguageSettings {
-  list?: KupLanguageJSON;
-  name?: string;
-}
-/**
- * KupMath initialization settings.
- */
-export interface KupManagerMathSettings {
-  locale?: KupMathLocales;
-}
-/**
- * KupObjects initialization settings.
- */
-export interface KupManagerObjectsSettings {
-  list?: KupObjectsJSON;
-}
-/**
- * KupScrollOnHover initialization settings.
- */
-export interface KupManagerScrollOnHoverSettings {
-  delay?: number;
-  step?: number;
-}
-/**
- * KupTheme initialization settings.
- */
-export interface KupManagerThemeSettings {
-  list?: KupThemeJSON;
-  name?: string;
-}
-/**
- * KupDates initialization settings.
- */
-export interface KupManagerTooltipSettings {
-  fCellCallbacks?: KupTooltipCallbacks;
-  delay?: number;
-}
-/**
- * KupTheme initialization settings.
- */
-export interface KupManagerStringFinderPayload {
-  string: string;
-}
+import type { Interaction } from '@interactjs/core/Interaction';
+import type { ActionMap } from '@interactjs/core/scope';
+import type { RectResolvable } from '@interactjs/types/index';
+import type { KupData } from '../kup-data/kup-data';
+import type { KupDates } from '../kup-dates/kup-dates';
+import type { KupDatesLocales } from '../kup-dates/kup-dates-declarations';
+import type { KupDebug } from '../kup-debug/kup-debug';
+import type { KupDynamicPosition } from '../kup-dynamic-position/kup-dynamic-position';
+import type { KupInteract } from '../kup-interact/kup-interact';
+import type { KupLanguage } from '../kup-language/kup-language';
+import type { KupLanguageJSON } from '../kup-language/kup-language-declarations';
+import type { KupMath } from '../kup-math/kup-math';
+import type { KupObjects } from '../kup-objects/kup-objects';
+import type { KupObjectsJSON } from '../kup-objects/kup-objects-declarations';
+import type { KupScrollOnHover } from '../kup-scroll-on-hover/kup-scroll-on-hover';
+import type { KupSearch } from '../kup-search/kup-search';
+import type { KupTheme } from '../kup-theme/kup-theme';
+import type { KupThemeJSON } from '../kup-theme/kup-theme-declarations';
+import type { KupToolbar } from '../kup-toolbar/kup-toolbar';
+import type { KupTooltip } from '../kup-tooltip/kup-tooltip';
+import type { ResizeObserver } from 'resize-observer';
+import { KupMathLocales } from '../kup-math/kup-math-declarations';
+import { KupTooltipCallbacks } from '../kup-tooltip/kup-tooltip-declarations';
+import { Options } from 'html2canvas';
+/**
+ * Interface used to define the HTML element with Ketchup specific properties.
+ */
+export interface KupDom extends HTMLHtmlElement {
+  ketchup: KupManager;
+  ketchupInit: KupManagerInitialization;
+}
+/**
+ * Interface for the KupManager class
+ */
+export interface KupManager {
+  data: KupData;
+  dates: KupDates;
+  debug: KupDebug;
+  dynamicPosition: KupDynamicPosition;
+  interact: KupInteract;
+  language: KupLanguage;
+  magicBox: HTMLKupMagicBoxElement;
+  math: KupMath;
+  objects: KupObjects;
+  overrides?: KupManagerInitialization;
+  resize: ResizeObserver;
+  scrollOnHover: KupScrollOnHover;
+  search: KupSearch;
+  theme: KupTheme;
+  toolbar: KupToolbar;
+  tooltip: KupTooltip;
+  utilities: KupManagerUtilities;
+  showMagicBox: () => void;
+  hideMagicBox: () => void;
+  toggleMagicBox: () => void;
+  setLibraryLocalization: (locale: KupDatesLocales) => void;
+  addClickCallback: (cb: KupManagerClickCb, async?: boolean) => void;
+  getEventPath: (currentEl: unknown, rootElement: HTMLElement) => HTMLElement[];
+  removeClickCallback: (cb: KupManagerClickCb) => void;
+  rasterize: (el: HTMLElement, options?: Partial<Options>) => Promise<HTMLCanvasElement>;
+}
+/**
+ * Interface for the KupManager utilities.
+ */
+export interface KupManagerUtilities {
+  clickCallbacks?: Set<KupManagerClickCb>;
+  lastPointerDownString?: string;
+}
+/**
+ * Interface to declare callbacks automatically invoked on pointer down events.
+ */
+export interface KupManagerClickCb {
+  cb: () => unknown;
+  el?: HTMLElement;
+}
+/**
+ * Interface for the KupManager override settings.
+ */
+export interface KupManagerInitialization {
+  assetsPath?: string;
+  autoSetLocalization?: boolean;
+  dates?: KupManagerDatesSettings;
+  debug?: KupManagerDebugSettings;
+  interact?: KupManagerInteractSettings;
+  language?: KupManagerLanguageSettings;
+  math?: KupManagerMathSettings;
+  objects?: KupManagerObjectsSettings;
+  scrollOnHover?: KupManagerScrollOnHoverSettings;
+  theme?: KupManagerThemeSettings;
+  tooltip?: KupManagerTooltipSettings;
+}
+/**
+ * KupDates initialization settings.
+ */
+export interface KupManagerDatesSettings {
+  locale?: KupDatesLocales;
+}
+/**
+ * KupDebug initialization settings.
+ */
+export interface KupManagerDebugSettings {
+  active?: boolean;
+  autoPrint?: boolean;
+  logLimit?: number;
+}
+/**
+ * KupDialog initialization settings.
+ */
+export interface KupManagerInteractSettings {
+  restrictContainer?: RectResolvable<[
+    number,
+    number,
+    Interaction<keyof ActionMap>
+  ]>;
+  zIndex?: number;
+}
+/**
+ * KupLanguage initialization settings.
+ */
+export interface KupManagerLanguageSettings {
+  list?: KupLanguageJSON;
+  name?: string;
+}
+/**
+ * KupMath initialization settings.
+ */
+export interface KupManagerMathSettings {
+  locale?: KupMathLocales;
+}
+/**
+ * KupObjects initialization settings.
+ */
+export interface KupManagerObjectsSettings {
+  list?: KupObjectsJSON;
+}
+/**
+ * KupScrollOnHover initialization settings.
+ */
+export interface KupManagerScrollOnHoverSettings {
+  delay?: number;
+  step?: number;
+}
+/**
+ * KupTheme initialization settings.
+ */
+export interface KupManagerThemeSettings {
+  list?: KupThemeJSON;
+  name?: string;
+}
+/**
+ * KupDates initialization settings.
+ */
+export interface KupManagerTooltipSettings {
+  fCellCallbacks?: KupTooltipCallbacks;
+  delay?: number;
+}
+/**
+ * KupTheme initialization settings.
+ */
+export interface KupManagerStringFinderPayload {
+  string: string;
+}

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

@@ -1,95 +1,95 @@
-import type { KupManagerClickCb, KupManagerInitialization, KupManagerUtilities } from './kup-manager-declarations';
-import { KupDebug } from '../kup-debug/kup-debug';
-import { KupDynamicPosition } from '../kup-dynamic-position/kup-dynamic-position';
-import { KupInteract } from '../kup-interact/kup-interact';
-import { KupLanguage } from '../kup-language/kup-language';
-import { KupObjects } from '../kup-objects/kup-objects';
-import { KupScrollOnHover } from '../kup-scroll-on-hover/kup-scroll-on-hover';
-import { KupTheme } from '../kup-theme/kup-theme';
-import { KupToolbar } from '../kup-toolbar/kup-toolbar';
-import { ResizeObserver } from 'resize-observer';
-import { KupData } from '../kup-data/kup-data';
-import { KupDates } from '../kup-dates/kup-dates';
-import { KupDatesLocales } from '../kup-dates/kup-dates-declarations';
-import { KupSearch } from '../kup-search/kup-search';
-import { KupMath } from '../kup-math/kup-math';
-import { KupTooltip } from '../kup-tooltip/kup-tooltip';
-import { Options } from 'html2canvas';
-/**
- * This class controls every other Ketchup utility suite.
- * @module KupManager
- */
-export declare class KupManager {
-  data: KupData;
-  dates: KupDates;
-  debug: KupDebug;
-  dynamicPosition: KupDynamicPosition;
-  interact: KupInteract;
-  language: KupLanguage;
-  magicBox: HTMLKupMagicBoxElement;
-  math: KupMath;
-  objects: KupObjects;
-  overrides?: KupManagerInitialization;
-  resize: ResizeObserver;
-  scrollOnHover: KupScrollOnHover;
-  search: KupSearch;
-  utilities: KupManagerUtilities;
-  theme: KupTheme;
-  toolbar: KupToolbar;
-  tooltip: KupTooltip;
-  /**
-   * Initializes KupManager.
-   */
-  constructor(overrides?: KupManagerInitialization);
-  /**
-   * Creates kup-magic-box component.
-   */
-  showMagicBox(): void;
-  /**
-   * Removes kup-magic-box component.
-   */
-  hideMagicBox(): void;
-  /**
-   * Creates or removes kup-magic-box component depending on its existence.
-   */
-  toggleMagicBox(): void;
-  /**
-   * Sets both locale and language library-wide.
-   * @param {KupDatesLocales} locale - The supported locale.
-   */
-  setLibraryLocalization(locale: KupDatesLocales): void;
-  /**
-   * Adds a new click callback.
-   * @param {KupManagerClickCb} cb - The callback to add.
-   * @param {boolean} async - When true, the callback will be added asynchrounously to prevent instant firing if it was added through a click event.
-   */
-  addClickCallback(cb: KupManagerClickCb, async?: boolean): void;
-  /**
-   * Retrives event path from event.target
-   * @param currentEl event.target
-   * @param rootElement rootElement of component
-   * @returns
-   */
-  getEventPath(currentEl: unknown, rootElement: HTMLElement): HTMLElement[];
-  /**
-   * Rasterizes an HTMLElement, transforming into a canvas.
-   * @param {HTMLElement} el - Element to rasterize.
-   * @returns {HTMLCanvasElement} - Canvas created from the HTMLElement.
-   *
-   * CSS Mask is not supported:
-   * @see https://github.com/niklasvh/html2canvas/issues/2814
-   * Warning in console about sourcemap, claimed to be solved here but...:
-   * @see https://github.com/niklasvh/html2canvas/pull/2787/files
-   */
-  rasterize(el: HTMLElement, options?: Partial<Options>): Promise<HTMLCanvasElement>;
-  /**
-   * Removes the given click callback.
-   * @param {KupManagerClickCb} cb - The callback to remove.
-   */
-  removeClickCallback(cb: KupManagerClickCb): void;
-}
-/**
- * Called by the Ketchup components to retrieve the instance of KupManager (or creating a new one when missing).
- * @returns {KupManager} KupManager instance.
- */
-export declare function kupManagerInstance(): KupManager;
+import type { KupManagerClickCb, KupManagerInitialization, KupManagerUtilities } from './kup-manager-declarations';
+import { KupDebug } from '../kup-debug/kup-debug';
+import { KupDynamicPosition } from '../kup-dynamic-position/kup-dynamic-position';
+import { KupInteract } from '../kup-interact/kup-interact';
+import { KupLanguage } from '../kup-language/kup-language';
+import { KupObjects } from '../kup-objects/kup-objects';
+import { KupScrollOnHover } from '../kup-scroll-on-hover/kup-scroll-on-hover';
+import { KupTheme } from '../kup-theme/kup-theme';
+import { KupToolbar } from '../kup-toolbar/kup-toolbar';
+import { ResizeObserver } from 'resize-observer';
+import { KupData } from '../kup-data/kup-data';
+import { KupDates } from '../kup-dates/kup-dates';
+import { KupDatesLocales } from '../kup-dates/kup-dates-declarations';
+import { KupSearch } from '../kup-search/kup-search';
+import { KupMath } from '../kup-math/kup-math';
+import { KupTooltip } from '../kup-tooltip/kup-tooltip';
+import { Options } from 'html2canvas';
+/**
+ * This class controls every other Ketchup utility suite.
+ * @module KupManager
+ */
+export declare class KupManager {
+  data: KupData;
+  dates: KupDates;
+  debug: KupDebug;
+  dynamicPosition: KupDynamicPosition;
+  interact: KupInteract;
+  language: KupLanguage;
+  magicBox: HTMLKupMagicBoxElement;
+  math: KupMath;
+  objects: KupObjects;
+  overrides?: KupManagerInitialization;
+  resize: ResizeObserver;
+  scrollOnHover: KupScrollOnHover;
+  search: KupSearch;
+  utilities: KupManagerUtilities;
+  theme: KupTheme;
+  toolbar: KupToolbar;
+  tooltip: KupTooltip;
+  /**
+   * Initializes KupManager.
+   */
+  constructor(overrides?: KupManagerInitialization);
+  /**
+   * Creates kup-magic-box component.
+   */
+  showMagicBox(): void;
+  /**
+   * Removes kup-magic-box component.
+   */
+  hideMagicBox(): void;
+  /**
+   * Creates or removes kup-magic-box component depending on its existence.
+   */
+  toggleMagicBox(): void;
+  /**
+   * Sets both locale and language library-wide.
+   * @param {KupDatesLocales} locale - The supported locale.
+   */
+  setLibraryLocalization(locale: KupDatesLocales): void;
+  /**
+   * Adds a new click callback.
+   * @param {KupManagerClickCb} cb - The callback to add.
+   * @param {boolean} async - When true, the callback will be added asynchrounously to prevent instant firing if it was added through a click event.
+   */
+  addClickCallback(cb: KupManagerClickCb, async?: boolean): void;
+  /**
+   * Retrives event path from event.target
+   * @param currentEl event.target
+   * @param rootElement rootElement of component
+   * @returns
+   */
+  getEventPath(currentEl: unknown, rootElement: HTMLElement): HTMLElement[];
+  /**
+   * Rasterizes an HTMLElement, transforming into a canvas.
+   * @param {HTMLElement} el - Element to rasterize.
+   * @returns {HTMLCanvasElement} - Canvas created from the HTMLElement.
+   *
+   * CSS Mask is not supported:
+   * @see https://github.com/niklasvh/html2canvas/issues/2814
+   * Warning in console about sourcemap, claimed to be solved here but...:
+   * @see https://github.com/niklasvh/html2canvas/pull/2787/files
+   */
+  rasterize(el: HTMLElement, options?: Partial<Options>): Promise<HTMLCanvasElement>;
+  /**
+   * Removes the given click callback.
+   * @param {KupManagerClickCb} cb - The callback to remove.
+   */
+  removeClickCallback(cb: KupManagerClickCb): void;
+}
+/**
+ * Called by the Ketchup components to retrieve the instance of KupManager (or creating a new one when missing).
+ * @returns {KupManager} KupManager instance.
+ */
+export declare function kupManagerInstance(): KupManager;