Refactor SettingColumns and Modal Logic (#160)

- Added new `SettingColumn` base class
- Updated `Button`, `DisplayField`, `Dropdown`, `Input`, and `TagSearch` to extend `SettingColumn`
- Standardized settings and elements definitions across setting column classes
- Removed `ISettingColumn` interface and associated file
- Introduced `IToggleSettings` and `IToggleElements` interfaces
- Refactored `Input`, `Toggle`, and `TagSearch` classes for improved structure
- Enhanced modal logic to include required fields validation
- Added `Notice` import and usage for user notifications
- Updated ESLint configuration for naming conventions
- Removed unnecessary type imports and cleaned up code structure

Author: 0xMax42

.eslintrc

@@ -67,6 +67,18 @@
           "match": true
         }
       },
+      {
+        "selector": "classProperty",
+        "modifiers": [
+          "private",
+          "readonly"
+        ],
+        "format": [],
+        "custom": {
+          "regex": "^(_{1,2}I[A-Z][a-zA-Z0-9]*_?|_{1,2}[a-z][a-zA-Z0-9]*|_{2}[a-zA-Z][a-zA-Z0-9]*)$",
+          "match": true
+        }
+      },
       {
         "selector": "classProperty",
         "modifiers": [
@@ -109,7 +121,7 @@
         ],
         "leadingUnderscore": "forbid",
         "filter": {
-          "regex": "^(Events|Styles|Classes|Then|TextContent)$",
+          "regex": "^(Events|Styles|Classes|Then|TextContent|El)$",
           "match": false
         }
       },
@@ -137,7 +149,7 @@
           "camelCase"
         ],
         "filter": {
-          "regex": ".*-event$|^(Events|Styles|Classes|Then|TextContent)$",
+          "regex": ".*-event$|^(Events|Styles|Classes|Then|TextContent|El)$",
           "match": false
         }
       }

.gitignore

@@ -40,3 +40,6 @@ src/auto-imports.ts
 
 .locale
 isolate-*-v8.log
+
+ait.config.json
+ait.*.config.json

manifest.json

@@ -1,7 +1,7 @@
 {
   "id": "prj",
   "name": "Prj Plugin",
-  "version": "0.6.26",
+  "version": "0.6.27",
   "minAppVersion": "0.15.0",
   "description": "Prj Plugin - Project, Document, and Task Management",
   "author": "M. Passarello",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "obsidian-prj-plugin",
-  "version": "0.6.26",
+  "version": "0.6.27",
   "description": "Prj Plugin - Project, Document, and Task Management",
   "main": "main.js",
   "scripts": {

src/classes/decorators/Implements.ts

@@ -0,0 +1,25 @@
+/**
+ * Decorator to enforce **static** implementation of an interface.
+ * @returns A decorator function
+ * ---
+ * **Will be checked at compile time.**
+ * @see {@link Implements} for instance implementation type checking.
+ */
+export function ImplementsStatic<I>() {
+    return <T extends I>(constructor: T, ...args: unknown[]) => {};
+}
+
+export { ImplementsStatic as Implements_ };
+
+/**
+ * Decorator to enforce **instance** implementation of an interface.
+ * @returns A decorator function
+ * ---
+ * **Will be checked at compile time.**
+ * @see {@link ImplementsStatic} for static implementation type checking.
+ */
+export function Implements<I>() {
+    return <T extends new (...args: unknown[]) => I>(
+        constructor: T,
+    ): void => {};
+}

src/classes/decorators/ImplementsStatic.ts

@@ -1,7 +1 @@
-/**
- * Decorator to enforce static implementation of an interface
- * @returns A decorator function
- */
-export function ImplementsStatic<I>() {
-    return <T extends I>(constructor: T, ...args: unknown[]) => {};
-}
+export { ImplementsStatic } from './Implements';

src/libs/DIComponent/types/EventTypes.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
+import { ValidatorDelegate } from 'src/libs/Settings/SettingColumns/types/General';
 import { IDIComponent } from '../interfaces/IDIComponent';
 
 /**
@@ -29,6 +30,11 @@ export type EventRegistry = Record<EventKey, (EventCallback | undefined)[]>;
 export type InjectDelegate = (ctx: IDIComponent & unknown) => void;
 
 export type SpecificEventMap = {
+    /**
+     * The event is broadcasted to all children
+     * after the parent and children are loaded.
+     */
+    loaded: [];
     /**
      * All indipendent Windows should have this classes.
      * The parent will emit this event to all children
@@ -40,6 +46,11 @@ export type SpecificEventMap = {
      * key of the result and the result itself.
      */
     result: [string, unknown];
+    /**
+     * A child can emit this event to the parent with the
+     * key of the result and a boolean value or a validator delegate.
+     */
+    'required-results': [string, boolean | ValidatorDelegate | undefined];
 };
 
 export type SpecificEventCallback<K extends keyof SpecificEventMap> = (

src/libs/HTMLFlow/Flow.ts

@@ -2,8 +2,13 @@ import { ImplementsStatic } from 'src/classes/decorators/ImplementsStatic';
 import type { ILogger, ILogger_ } from 'src/interfaces/ILogger';
 import { Register } from 'ts-injex';
 import { Inject } from 'ts-injex';
-import type { IFlow, IFlowApiType, ISetValueType } from './interfaces/IFlow';
-import { IFlow_, IFlowApi } from './interfaces/IFlow';
+import {
+    IFlow_,
+    IFlow,
+    IFlowApiType,
+    IFlowApi,
+    ISetValueType,
+} from './interfaces/IFlow';
 import type { IFlowTag } from './interfaces/IFlowTag';
 import { IFlowSymbol, isIFlowTagged } from './interfaces/IFlowTag';
 import {
@@ -18,8 +23,7 @@ import type {
     IFlowEventCallback,
     IFlowThenCallback,
 } from './types/IFlowDelegates';
-import { DIComponent } from '../DIComponent/DIComponent';
-import { shouldRemoveOnUnload, isLoaded } from '../DIComponent/types/IDIComponentSymbols';
+import { DIComponent, isLoaded, shouldRemoveOnUnload } from '../DIComponent';
 
 /**
  * A HTML Fluent API class.
@@ -558,6 +562,9 @@ export class Flow<Tag extends keyof HTMLElementTagNameMap>
                             this.addEventListener(events);
                         }
                         break;
+                    case 'El':
+                        this.getEl(value[key]);
+                        break;
                     case 'Styles':
                         this.setStyles(value[key]);
                         break;

src/libs/HTMLFlow/Opts.ts

@@ -9,6 +9,7 @@ import {
 /**
  * Options inspector factory.
  * @see {@link Opts.inspect}
+ * @deprecated This class is deprecated and will be removed in the next **MINOR** version.
  */
 @Register('Opts')
 export class Opts {

src/libs/HTMLFlow/interfaces/IFlow.ts

@@ -7,6 +7,7 @@ import {
     StylesParameters,
     ClassesParameters,
     AddEventsParameters,
+    GetElParameters,
 } from '../types/IFlow';
 import {
     IFlowConfig,
@@ -263,7 +264,9 @@ export interface IFlowApi<
     //# Set generic methods
 
     /**
-     * Sets the **Atrributes**, **Classes**, **Styles** and **Events** of the element.
+     * Sets the **Atrributes**, **Classes**, **Styles** and **Events** of the element
+     * an let you get the **El**ement.
+     * @see {@link ISetValueType}
      * @param value The values to set.
      * @returns The Flow instance.
      */
@@ -285,6 +288,11 @@ export interface ISetValueType<
      */
     [key: string]: string | unknown;
 
+    /**
+     * Element to get.
+     */
+    El?: TupleToUnion<GetElParameters<Tag>>;
+
     /**
      * Events to add to the element.
      */