@inglorious/web 6.1.1 → 6.2.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,6 +1,6 @@
 {
   "name": "@inglorious/web",
-  "version": "6.1.1",
+  "version": "6.2.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)",
   "license": "MIT",
@@ -30,6 +30,10 @@
       "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"

package/src/compass/handlers.js

@@ -19,11 +19,8 @@ export function create(entity) {
   entity.isSupported = isCompassSupported()
   entity.manualOffset ??= 0
   entity._absoluteListener ??= null
+  entity._cancelTimeout ??= null
   entity._orientationListener ??= null
-  // True once a deviceorientationabsolute event fires; used to drop the
-  // fallback deviceorientation listener so only one path updates heading.
-  entity._isUsingAbsolute ??= false
-  entity.compassTimeout ??= NO_TIMEOUT
 }
 
 export function destroy(entity) {
@@ -44,16 +41,15 @@ export function compassUnwatch(entity) {
     )
   }
 
-  if (entity.compassTimeout !== NO_TIMEOUT) {
-    clearTimeout(entity.compassTimeout)
+  if (entity._cancelTimeout) {
+    entity._cancelTimeout()
   }
 
   entity.isLoading = false
   entity.isActive = false
-  entity.compassTimeout = NO_TIMEOUT
   entity._orientationListener = null
   entity._absoluteListener = null
-  entity._isUsingAbsolute = false
+  entity._cancelTimeout = null
 }
 
 export function compassError(entity, error) {
@@ -101,12 +97,30 @@ export function compassPermissionsGrant(entity) {
 }
 
 export function compassWatch(entity, _, api) {
-  entity._isUsingAbsolute = false
+  // Snapshot values from the entity while the proxy is still live.
+  // Closures must not access `entity` after this handler returns, as
+  // Mutative revokes the draft proxy at that point.
+  const manualOffset = entity.manualOffset
+
+  let isUsingAbsolute = false
+  let timeoutId = NO_TIMEOUT
+
+  const cancelTimeout = () => {
+    if (timeoutId !== NO_TIMEOUT) {
+      clearTimeout(timeoutId)
+      timeoutId = NO_TIMEOUT
+    }
+  }
+
+  const orientationListener = createOrientationChangeListener(
+    cancelTimeout,
+    manualOffset,
+    api,
+  )
 
-  const orientationListener = createOrientationChangeListener(entity, api)
   const absoluteListener = (event) => {
-    if (!entity._isUsingAbsolute) {
-      entity._isUsingAbsolute = true
+    if (!isUsingAbsolute) {
+      isUsingAbsolute = true
       getWindow()?.removeEventListener("deviceorientation", orientationListener)
     }
 
@@ -115,23 +129,16 @@ export function compassWatch(entity, _, api) {
 
   entity._orientationListener = orientationListener
   entity._absoluteListener = absoluteListener
+  entity._cancelTimeout = cancelTimeout
 
   const win = getWindow()
   win?.addEventListener("deviceorientationabsolute", absoluteListener)
   win?.addEventListener("deviceorientation", orientationListener)
 
-  entity.compassTimeout = globalThis.setTimeout(
-    () => checkTimeout(entity, api),
-    COMPASS_TIMEOUT,
-  )
-}
-
-function checkTimeout(entity, api) {
-  entity.compassTimeout = NO_TIMEOUT
-
-  if (!entity.heading) {
+  timeoutId = globalThis.setTimeout(() => {
+    timeoutId = NO_TIMEOUT
     api.notify("compassActiveChange", false)
-  }
+  }, COMPASS_TIMEOUT)
 }
 
 export function compassActiveChange(entity, value) {
@@ -143,22 +150,18 @@ export function compassHeadingChange(entity, value) {
   entity.heading = value
 }
 
-function createOrientationChangeListener(entity, api) {
+function createOrientationChangeListener(cancelTimeout, manualOffset, api) {
   return (event) => {
     const heading = event?.alpha
     if (typeof heading !== "number") {
       return
     }
 
-    if (entity.compassTimeout !== NO_TIMEOUT) {
-      clearTimeout(entity.compassTimeout)
-      entity.compassTimeout = NO_TIMEOUT
-    }
+    cancelTimeout()
 
     const screenAngle = getScreenAngle()
     const adjustedHeading =
-      (((heading - screenAngle + entity.manualOffset) % FULL_CIRCLE) +
-        FULL_CIRCLE) %
+      (((heading - screenAngle + manualOffset) % FULL_CIRCLE) + FULL_CIRCLE) %
       FULL_CIRCLE
 
     api.notify("compassActiveChange", true)

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/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/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>
 
   /**