@simple-reporting/base 0.1.111 → 1.0.0

package/{dev/nswow → srl/srl}/ArticleAutoloader.ts

@@ -1,100 +1,100 @@
-import ArticleLoader from './ArticleLoader'
-import { camelCase } from 'cheerio/utils'
-
-type AutoloadList = string | string[]
-
-/**
- * Class representing an ArticleAutoloader.
- * @class
- */
-class ArticleAutoloader {
-  classes: { [key: string]: { new (node: HTMLElement, options: any): any } }
-  selector: string
-
-  /**
-   * Constructor for the class.
-   * Initializes the "classes" and "selector" properties.
-   *
-   * @constructor
-   */
-  constructor() {
-    this.classes = {}
-    this.selector = '[data-autoload]'
-  }
-
-  /**
-   * Initializes the Autoload feature on the specified HTMLElement.
-   *
-   * @param {HTMLElement} obj - The HTMLElement on which to initialize Autoload.
-   * @return {void}
-   */
-  init(obj: HTMLElement) {
-    const nodes: NodeListOf<Element> = obj.querySelectorAll(this.selector)
-    if (nodes) {
-      for (let index = 0; index < nodes.length; index++) {
-        this._initAutoload(nodes[index] as HTMLElement)
-      }
-    }
-  }
-
-  /**
-   * Registers the provided object class with the given class name.
-   *
-   * @param {ArticleLoader} objClass - The object class to register.
-   * @param {string} className - The name to associate with the object class.
-   */
-  register(objClass: ArticleLoader, className: string) {
-    this.classes[camelCase(className)] = objClass
-  }
-
-  /**
-   * Creates an instance of a class based on the given class name and initializes it with the provided options.
-   *
-   * @param {HTMLElement} node - The HTML element to which the class instance will be attached.
-   * @param {Object} options - The options to be passed to the class instance during initialization.
-   * @param {string} className - The name of the class to be instantiated.
-   *
-   * @return {void} - This method does not return any value.
-   */
-  _createInstance(node: HTMLElement, options: any, className: string) {
-    if (this.classes[className] !== undefined) {
-      new this.classes[className](node, options)
-    }
-  }
-
-  /**
-   * Initializes the autoload feature for the given node.
-   *
-   * @param {HTMLElement} node - The node for which to initialize the autoload feature.
-   */
-  _initAutoload(node: HTMLElement): void {
-    let load: AutoloadList = node.dataset.autoload
-
-    // Converting to array in case of single string for uniform processing
-    try {
-      load = JSON.parse(load)
-    } catch (e) {
-      load = load.split(' ')
-    }
-
-    if (typeof load === 'string') {
-      load = [load]
-    }
-    // check if it's a single string or a list
-    if (load.length === 1) {
-      const options = node.dataset.options || {}
-      this._createInstance(node, options, camelCase(load[0]))
-    } else {
-      const optionsDataSet = JSON.parse(node.dataset.options || '{}')
-      for (const className of load) {
-        if (className !== '') {
-          const options = optionsDataSet[className] || {}
-          this._createInstance(node, options, camelCase(className))
-        }
-      }
-    }
-  }
-}
-
-export default ArticleAutoloader
-export { ArticleAutoloader }
+import { camelCase } from '#utils';
+import ArticleLoader from './ArticleLoader';
+
+type AutoloadList = string | string[];
+
+/**
+ * Class representing an ArticleAutoloader.
+ * @class
+ */
+class ArticleAutoloader {
+  classes: { [key: string]: { new (node: HTMLElement, options: any): any } };
+  selector: string;
+
+  /**
+   * Constructor for the class.
+   * Initializes the "classes" and "selector" properties.
+   *
+   * @constructor
+   */
+  constructor() {
+    this.classes = {};
+    this.selector = '[data-autoload]';
+  }
+
+  /**
+   * Initializes the Autoload feature on the specified HTMLElement.
+   *
+   * @param {HTMLElement} obj - The HTMLElement on which to initialize Autoload.
+   * @return {void}
+   */
+  init(obj: HTMLElement) {
+    const nodes: NodeListOf<Element> = obj.querySelectorAll(this.selector);
+    if (nodes) {
+      for (let index = 0; index < nodes.length; index++) {
+        this._initAutoload(nodes[index] as HTMLElement);
+      }
+    }
+  }
+
+  /**
+   * Registers the provided object class with the given class name.
+   *
+   * @param {ArticleLoader} objClass - The object class to register.
+   * @param {string} className - The name to associate with the object class.
+   */
+  register(objClass: ArticleLoader, className: string) {
+    this.classes[camelCase(className)] = objClass;
+  }
+
+  /**
+   * Creates an instance of a class based on the given class name and initializes it with the provided options.
+   *
+   * @param {HTMLElement} node - The HTML element to which the class instance will be attached.
+   * @param {Object} options - The options to be passed to the class instance during initialization.
+   * @param {string} className - The name of the class to be instantiated.
+   *
+   * @return {void} - This method does not return any value.
+   */
+  _createInstance(node: HTMLElement, options: any, className: string) {
+    if (this.classes[className] !== undefined) {
+      new this.classes[className](node, options);
+    }
+  }
+
+  /**
+   * Initializes the autoload feature for the given node.
+   *
+   * @param {HTMLElement} node - The node for which to initialize the autoload feature.
+   */
+  _initAutoload(node: HTMLElement): void {
+    let load: AutoloadList = node.dataset.autoload;
+
+    // Converting to array in case of single string for uniform processing
+    try {
+      load = JSON.parse(load);
+    } catch (e) {
+      load = load.split(' ');
+    }
+
+    if (typeof load === 'string') {
+      load = [load];
+    }
+    // check if it's a single string or a list
+    if (load.length === 1) {
+      const options = node.dataset.options || {};
+      this._createInstance(node, options, camelCase(load[0]));
+    } else {
+      const optionsDataSet = JSON.parse(node.dataset.options || '{}');
+      for (const className of load) {
+        if (className !== '') {
+          const options = optionsDataSet[className] || {};
+          this._createInstance(node, options, camelCase(className));
+        }
+      }
+    }
+  }
+}
+
+export default ArticleAutoloader;
+export { ArticleAutoloader };

package/{dev/nswow → srl/srl}/ArticleLoader.ts

@@ -1,91 +1,98 @@
-/**
- * A class for loading articles into elements.
- * @class
- */
-abstract class ArticleLoader {
-  protected element: HTMLElement
-  protected options: { key: string; value: any }
-
-  /**
-   * Constructs a new instance of the class.
-   *
-   * @param {string | Node} selector - The CSS selector or Node object to initialize the class with.
-   * @param {any} options - Optional options to pass to the class.
-   * @constructor
-   */
-  protected constructor(selector: string | Node, options: { key: string; value: any } | undefined) {
-    if (typeof selector === 'string' || selector instanceof NodeList) {
-      this._initializeNodeList(selector, options)
-    } else if (selector instanceof Node) {
-      this.element = selector as HTMLElement
-      this.element[this.constructor.name] = this
-      this._initializeNode(selector, options)
-    }
-  }
-
-  /**
-   * Initializes a node list with a given selector or NodeList object.
-   *
-   * @param {string | NodeList} selector - The selector or NodeList object used to initialize the node list.
-   * @param {unknown} options - Optional options to be passed to the constructor of each node in the node list.
-   *
-   * @return {void} - No return value.
-   */
-  private _initializeNodeList(selector: string | NodeList, options: unknown) {
-    const nodeList = typeof selector === 'string' ? document.querySelectorAll(selector) : selector
-    Array.from(nodeList).forEach((node) => new this.constructor(node, options))
-  }
-
-  /**
-   * Initializes a Node object with given options.
-   *
-   * @param {Node} node - The Node to initialize.
-   * @param {unknown} options - The options to assign to the Node.
-   * @return {void}
-   */
-  private _initializeNode(node: Node, options: unknown) {
-    this._assignOptions(options)
-    this._create()
-  }
-
-  /**
-   * Assigns options to a class property.
-   *
-   * @param {unknown} options - The options to be assigned.
-   * @return {void}
-   */
-  private _assignOptions(options: unknown) {
-    if (options !== undefined) {
-      this.options = typeof options === 'string' ? JSON.parse(options) : options
-    } else {
-      this.options = {}
-    }
-  }
-
-  /**
-   * Returns the options assigned to the class.
-   * @return { key: string, value: any }
-   */
-  public getOptions() {
-    return this.options
-  }
-
-  /**
-   * Returns the element assigned to the class.
-   * @return {HTMLElement}
-   */
-  public getElement() {
-    return this.element
-  }
-
-  /**
-   * Abstract method _create.
-   *
-   * This must be defined in any class extending ArticleLoader. It serves as the
-   * entry point for the initialization of the abstraction.
-   */
-  abstract _create(): void
-}
-
-export default ArticleLoader
-export { ArticleLoader }
+/**
+ * A class for loading articles into elements.
+ * @class
+ */
+abstract class ArticleLoader {
+  protected element: HTMLElement;
+  protected options: { key: string; value: any };
+
+  /**
+   * Constructs a new instance of the class.
+   *
+   * @param {string | Node} selector - The CSS selector or Node object to initialize the class with.
+   * @param {any} options - Optional options to pass to the class.
+   * @constructor
+   */
+  protected constructor(
+    selector: string | Node,
+    options: { key: string; value: any } | undefined,
+  ) {
+    if (typeof selector === 'string' || selector instanceof NodeList) {
+      this._initializeNodeList(selector, options);
+    } else if (selector instanceof Node) {
+      this.element = selector as HTMLElement;
+      this.element[this.constructor.name] = this;
+      this._initializeNode(selector, options);
+    }
+  }
+
+  /**
+   * Initializes a node list with a given selector or NodeList object.
+   *
+   * @param {string | NodeList} selector - The selector or NodeList object used to initialize the node list.
+   * @param {unknown} options - Optional options to be passed to the constructor of each node in the node list.
+   *
+   * @return {void} - No return value.
+   */
+  private _initializeNodeList(selector: string | NodeList, options: unknown) {
+    const nodeList =
+      typeof selector === 'string'
+        ? document.querySelectorAll(selector)
+        : selector;
+    Array.from(nodeList).forEach((node) => new this.constructor(node, options));
+  }
+
+  /**
+   * Initializes a Node object with given options.
+   *
+   * @param {Node} node - The Node to initialize.
+   * @param {unknown} options - The options to assign to the Node.
+   * @return {void}
+   */
+  private _initializeNode(node: Node, options: unknown) {
+    this._assignOptions(options);
+    this._create();
+  }
+
+  /**
+   * Assigns options to a class property.
+   *
+   * @param {unknown} options - The options to be assigned.
+   * @return {void}
+   */
+  private _assignOptions(options: unknown) {
+    if (options !== undefined) {
+      this.options =
+        typeof options === 'string' ? JSON.parse(options) : options;
+    } else {
+      this.options = {};
+    }
+  }
+
+  /**
+   * Returns the options assigned to the class.
+   * @return { key: string, value: any }
+   */
+  public getOptions() {
+    return this.options;
+  }
+
+  /**
+   * Returns the element assigned to the class.
+   * @return {HTMLElement}
+   */
+  public getElement() {
+    return this.element;
+  }
+
+  /**
+   * Abstract method _create.
+   *
+   * This must be defined in any class extending ArticleLoader. It serves as the
+   * entry point for the initialization of the abstraction.
+   */
+  abstract _create(): void;
+}
+
+export default ArticleLoader;
+export { ArticleLoader };