@inglorious/web 6.1.2 → 6.3.0

package/LICENSE

@@ -1,9 +1,9 @@
-The MIT License (MIT)
-
-Copyright © 2025 Inglorious Coderz Srl.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright © 2025 Inglorious Coderz Srl.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,8 +1,15 @@
 {
   "name": "@inglorious/web",
-  "version": "6.1.2",
+  "version": "6.3.0",
   "description": "A new web framework that leverages the power of the Inglorious Store combined with the performance and simplicity of lit-html.",
-  "author": "IceOnFire <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
+  "author": "Matteo Antony Mistretta <antony.mistretta@gmail.com> (https://ingloriouscoderz.it)",
+  "contributors": [
+    {
+      "name": "Luis Cruz",
+      "email": "stackbuilder1228@gmail.com",
+      "url": "https://topstar-ai.github.io/"
+    }
+  ],
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -30,10 +37,18 @@
       "types": "./types/compass.d.ts",
       "import": "./src/compass/index.js"
     },
+    "./decorators/with-debounce": {
+      "types": "./types/decorators/with-debounce.d.ts",
+      "import": "./src/decorators/with-debounce/index.js"
+    },
     "./directives/*": {
       "types": "./types/directives/*.d.ts",
       "import": "./src/directives/*.js"
     },
+    "./element-size": {
+      "types": "./types/element-size.d.ts",
+      "import": "./src/element-size/index.js"
+    },
     "./form": {
       "types": "./types/form.d.ts",
       "import": "./src/form/index.js"

package/src/decorators/with-debounce/index.js

@@ -0,0 +1,85 @@
+import { debounce } from "@inglorious/utils/functions/functions.js"
+
+/**
+ * Wraps selected event handlers of a type with debouncing, scoped per-entity.
+ *
+ * IMPORTANT: because state is managed with `mutative`, the `entity` object
+ * passed into a handler is a draft proxy that gets revoked as soon as the
+ * current update tick finishes. Debounced calls fire *later*, on their own
+ * timer, well after that draft is dead. So we must never close over `entity`
+ * itself across the debounce boundary — only its primitive `id`. When the
+ * debounced callback actually runs, we re-fetch a live entity from the
+ * current state via `api.getEntity(entityId)`. Primitives and `payload` are safe to
+ * hold onto as-is; only draft/entity references are not.
+ *
+ * @param {number|Object} config - Either a single delay (ms) applied to all
+ *   handlers listed in `handlerNames`, or a map of handlerName -> delay (ms).
+ * @param {string[]} [handlerNames] - Handler names to debounce. Required when
+ *   `config` is a single number; ignored when `config` is a map (its keys
+ *   are used instead).
+ *
+ * @example
+ * // same delay for every listed handler
+ * const types = {
+ *   AutosaveForm: [Form, withDebounce(500, ["saveData"])],
+ * }
+ *
+ * @example
+ * // per-handler delays
+ * const types = {
+ *   SearchBox: [Combobox, withDebounce({ optionsLoad: 300, saveQuery: 800 })],
+ * }
+ */
+export function withDebounce(config, handlerNames) {
+  const delays =
+    typeof config === "number"
+      ? Object.fromEntries(handlerNames.map((name) => [name, config]))
+      : config
+
+  return (type) => {
+    // one debounced-fn map per entity, so instances don't share timers
+    const debouncedByEntity = new Map()
+
+    const behavior = {}
+
+    for (const handlerName of Object.keys(delays)) {
+      const originalHandler = type[handlerName]
+      if (!originalHandler) continue // nothing to wrap if the base type doesn't define it
+
+      behavior[handlerName] = (entity, payload, api) => {
+        const entityId = entity.id // capture the primitive now, while the draft is live
+
+        let perEntity = debouncedByEntity.get(entityId)
+        if (!perEntity) {
+          perEntity = {}
+          debouncedByEntity.set(entityId, perEntity)
+        }
+
+        if (!perEntity[handlerName]) {
+          perEntity[handlerName] = debounce((entityId, payload, api) => {
+            const liveEntity = api.getEntity(entityId) // fresh, live reference
+            if (!liveEntity) return // entity was destroyed before the debounce fired
+            originalHandler(liveEntity, payload, api)
+          }, delays[handlerName])
+        }
+
+        perEntity[handlerName](entityId, payload, api)
+      }
+    }
+
+    // clean up any pending timers when the entity is destroyed
+    behavior.destroy = (entity, payload, api) => {
+      const entityId = entity.id // same rule applies here: capture before it's gone
+
+      const perEntity = debouncedByEntity.get(entityId)
+      if (perEntity) {
+        Object.values(perEntity).forEach((d) => d.cancel())
+        debouncedByEntity.delete(entityId)
+      }
+
+      type.destroy?.(entity, payload, api)
+    }
+
+    return behavior
+  }
+}

package/src/element-size/handlers.js

@@ -0,0 +1,108 @@
+/**
+ * @typedef {import("../../types/element-size.js").ElementSizeEntity} ElementSizeEntity
+ * @typedef {import("../../types/element-size.js").ElementSizeSize} ElementSizeSize
+ */
+
+// Observers aren't serializable, so they're kept here by id, not on the entity.
+const observers = new Map()
+
+/**
+ * Initializes the entity state and starts observing the target element's size.
+ * @param {ElementSizeEntity} entity - The element size entity.
+ * @param {{ notify: Function }} api - The store API.
+ */
+export function create(entity, _, api) {
+  entity.width ??= null
+  entity.height ??= null
+  entity.isWatching ??= false
+
+  elementSizeWatch(entity, _, api)
+}
+
+/**
+ * Disconnects the observer before the entity is destroyed.
+ * @param {ElementSizeEntity} entity - The element size entity.
+ */
+export function destroy(entity) {
+  elementSizeUnwatch(entity)
+}
+
+/**
+ * Starts observing the target element for size changes.
+ * @param {ElementSizeEntity} entity - The element size entity.
+ * @param {{ notify: Function }} api - The store API.
+ */
+export function elementSizeWatch(entity, _, api) {
+  entity.isSupported = isSupported()
+
+  if (!entity.isSupported || observers.has(entity.id)) {
+    return
+  }
+
+  const element = getElement(entity)
+
+  if (!element) {
+    return
+  }
+
+  // Snapshot the id while the draft proxy is still live: the callback below
+  // runs after this handler returns, when Mutative has revoked the draft.
+  const id = entity.id
+
+  const observer = new globalThis.ResizeObserver((entries) => {
+    api.notify(`#${id}:elementSizeChange`, getSize(entries))
+  })
+  observer.observe(element)
+
+  observers.set(id, observer)
+  entity.isWatching = true
+}
+
+/**
+ * Stores the latest observed dimensions.
+ * @param {ElementSizeEntity} entity - The element size entity.
+ * @param {ElementSizeSize} size - The observed dimensions.
+ */
+export function elementSizeChange(entity, size) {
+  entity.width = size.width
+  entity.height = size.height
+}
+
+/**
+ * Stops observing size changes and drops the observer from the registry.
+ * @param {ElementSizeEntity} entity - The element size entity.
+ */
+export function elementSizeUnwatch(entity) {
+  const observer = observers.get(entity.id)
+
+  if (observer) {
+    observer.disconnect()
+    observers.delete(entity.id)
+  }
+
+  entity.isWatching = false
+}
+
+function getSize(entries) {
+  const [entry] = entries
+  const rect = entry.contentRect
+  return { width: rect.width, height: rect.height }
+}
+
+function getElement(entity) {
+  const doc = globalThis.document
+
+  if (!doc) {
+    return null
+  }
+
+  const selected = entity.selector ? doc.querySelector(entity.selector) : null
+  return selected ?? doc.documentElement
+}
+
+function isSupported() {
+  return (
+    typeof globalThis.ResizeObserver !== "undefined" &&
+    Boolean(globalThis.document?.documentElement)
+  )
+}

package/src/element-size/index.js

@@ -0,0 +1,3 @@
+import * as handlers from "./handlers.js"
+
+export const ElementSize = { ...handlers }

package/types/decorators/with-debounce.d.ts

@@ -0,0 +1,13 @@
+import { Api } from "../mount"
+
+export interface DebounceBehavior {
+  destroy?: (entity: any, payload?: any, api?: Api) => void
+  [handlerName: string]:
+    | ((entity: any, payload?: any, api?: Api) => void)
+    | undefined
+}
+
+export declare function withDebounce(
+  config: number | Record<string, number>,
+  handlerNames?: string[],
+): <T extends Record<string, any>>(type: T) => DebounceBehavior

package/types/element-size.d.ts

@@ -0,0 +1,26 @@
+import { Api } from "./mount"
+
+export interface ElementSizeEntity {
+  height: number | null
+  id: string | number
+  isSupported: boolean
+  isWatching: boolean
+  selector?: string | null
+  type?: "ElementSize"
+  width: number | null
+}
+
+export interface ElementSizeSize {
+  height: number
+  width: number
+}
+
+export interface ElementSizeType {
+  create(entity: ElementSizeEntity, payload: unknown, api: Api): void
+  destroy(entity: ElementSizeEntity): void
+  elementSizeChange(entity: ElementSizeEntity, size: ElementSizeSize): void
+  elementSizeWatch(entity: ElementSizeEntity, payload: unknown, api: Api): void
+  elementSizeUnwatch(entity: ElementSizeEntity): void
+}
+
+export declare const ElementSize: ElementSizeType

package/types/form.d.ts

@@ -1,3 +1,5 @@
+import { Api } from "./mount"
+
 /**
  * Represents the structure of form values, which can be a nested object.
  */
@@ -286,7 +288,7 @@ export interface FormType {
   validateAsync<T extends FormValues>(
     entity: FormEntity<T>,
     payload: FormValidateAsyncPayload<T>,
-    api: any,
+    api: Api,
   ): Promise<void>
 
   /**