element-vir 14.0.1 → 14.0.3

package/README.md

@@ -678,7 +678,7 @@ export const MyWithAsyncProp = defineElement<{endpoint: string}>()({
          */
         updateState({
             data: {
-                trigger: inputs,
+                serializableTrigger: inputs,
             },
         });
 

package/dist/declarative-element/directives/async-prop.d.ts

@@ -1,28 +1,24 @@
-import { JsonCompatibleValue, UnPromise } from '@augment-vir/common';
+import { UnPromise } from '@augment-vir/common';
 import { PickAndBlockOthers } from '../../augments/type';
 import { ObservablePropertyHandlerCreator, ObservablePropertyHandlerInstance, observablePropertyHandlerInstanceMarkerKey, ObservablePropertyListener } from '../properties/observable-property/observable-property-handler';
 export type AsyncProp<ValueGeneric> = Error | UnPromise<ValueGeneric> | Promise<UnPromise<ValueGeneric>>;
 declare const notSetSymbol: unique symbol;
-type JsonCompatibleObjectWithFunctionsAllowedAtTopLevel = Partial<{
-    readonly [key: string | number]: JsonCompatibleValue | Readonly<JsonCompatibleValue> | ((...args: any[]) => void);
-}> | Partial<{
-    [key: string | number]: JsonCompatibleValue | Readonly<JsonCompatibleValue> | ((...args: any[]) => void);
-}>;
-export type AsyncPropTriggerInputBase = JsonCompatibleObjectWithFunctionsAllowedAtTopLevel | undefined;
+export type AsyncPropTriggerInputBase = object | undefined;
 type AllSetValueProperties<ValueGeneric, TriggerInput extends AsyncPropTriggerInputBase> = {
     /** Set a new value directly without using any promises. */
     resolvedValue: UnPromise<ValueGeneric>;
     /**
-     * A value that, if it changes from one assignment to another, triggers the asyncProp to
-     * re-evaluate itself. Must be a JSON-compatible object for quick equality checks. Functions are
-     * also be allowed at the top level, but they are ignored for the equality checking.
+     * An object that, if it changes from one assignment to another, triggers the asyncProp to
+     * re-evaluate itself: calling its defined updateCallback and going through the asyncProp
+     * process again. Note that only serializable (JSON compatible) properties in this object are
+     * used for equality checking.
      */
-    trigger: TriggerInput;
+    serializableTrigger: TriggerInput;
     newPromise: Promise<UnPromise<ValueGeneric>>;
-    /** Clear the current value and trigger updateCallback to get called again on the next render. */
+    /** Clear the asyncProp's currently stored value and trigger updateCallback to get called again. */
     forceUpdate: true;
 };
-export type AsyncPropSetValue<ValueGeneric, TriggerInput extends AsyncPropTriggerInputBase> = (undefined extends TriggerInput ? never : PickAndBlockOthers<AllSetValueProperties<ValueGeneric, TriggerInput>, 'trigger'>) | PickAndBlockOthers<AllSetValueProperties<ValueGeneric, TriggerInput>, 'newPromise'> | PickAndBlockOthers<AllSetValueProperties<ValueGeneric, TriggerInput>, 'forceUpdate'> | PickAndBlockOthers<AllSetValueProperties<ValueGeneric, TriggerInput>, 'resolvedValue'>;
+export type AsyncPropSetValue<ValueGeneric, TriggerInput extends AsyncPropTriggerInputBase> = (undefined extends TriggerInput ? never : PickAndBlockOthers<AllSetValueProperties<ValueGeneric, TriggerInput>, 'serializableTrigger'>) | PickAndBlockOthers<AllSetValueProperties<ValueGeneric, TriggerInput>, 'newPromise'> | PickAndBlockOthers<AllSetValueProperties<ValueGeneric, TriggerInput>, 'forceUpdate'> | PickAndBlockOthers<AllSetValueProperties<ValueGeneric, TriggerInput>, 'resolvedValue'>;
 export declare class AsyncObservablePropertyHandler<ValueGeneric, TriggerInput extends AsyncPropTriggerInputBase> implements ObservablePropertyHandlerInstance<AsyncPropSetValue<ValueGeneric, TriggerInput>, AsyncProp<ValueGeneric>> {
     private lastTrigger;
     private resolutionValue;

package/dist/declarative-element/directives/async-prop.js

@@ -86,23 +86,21 @@ export class AsyncObservablePropertyHandler {
         this.waitingForValuePromise = createDeferredPromiseWrapper();
     }
     setValue(setInputs) {
-        if (typedHasProperty(setInputs, 'trigger')) {
+        if (typedHasProperty(setInputs, 'serializableTrigger')) {
             /**
              * This will expand proxies so that `inputs` or `state` can be used directly as a
-             * trigger without issues.
+             * serializableTrigger without issues.
              */
-            const expandedNewTrigger = { ...setInputs.trigger };
+            const expandedTrigger = { ...setInputs.serializableTrigger };
             if (this.lastTrigger === notSetSymbol ||
-                /**
-                 * No need to explicitly remove function properties here before the equality check:
-                 * JSON.stringify (which areJsonEqual is based on) will automatically do that.
-                 */
-                !areJsonEqual(expandedNewTrigger, this.lastTrigger)) {
-                this.lastTrigger = expandedNewTrigger;
+                !areJsonEqual(expandedTrigger, this.lastTrigger, {
+                    ignoreNonSerializableProperties: true,
+                })) {
+                this.lastTrigger = expandedTrigger;
                 if (!this.promiseUpdater) {
-                    throw new Error(`got trigger input to updateState for asyncProp but no updateCallback has been defined.`);
+                    throw new Error(`got serializableTrigger input to updateState for asyncProp but no updateCallback has been defined.`);
                 }
-                const newValue = this.promiseUpdater(expandedNewTrigger);
+                const newValue = this.promiseUpdater(expandedTrigger);
                 this.setPromise(newValue);
                 this.fireListeners();
             }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "element-vir",
-    "version": "14.0.1",
+    "version": "14.0.3",
     "keywords": [
         "custom",
         "web",
@@ -39,14 +39,14 @@
         "test:types": "tsc --noEmit"
     },
     "dependencies": {
-        "@augment-vir/browser": "^15.1.0",
-        "@augment-vir/common": "^15.1.0",
+        "@augment-vir/browser": "^15.2.0",
+        "@augment-vir/common": "^15.2.0",
         "lit": "2.7.5",
         "lit-css-vars": "^2.0.3"
     },
     "devDependencies": {
-        "@augment-vir/browser-testing": "^15.1.0",
-        "@augment-vir/node-js": "^15.1.0",
+        "@augment-vir/browser-testing": "^15.2.0",
+        "@augment-vir/node-js": "^15.2.0",
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
         "@open-wc/testing": "^3.2.0",
         "@types/chai": "^4.3.5",