@zcomponent/core 1.14.3 → 1.16.0-beta

package/lib/behavior.js

@@ -1,4 +1,13 @@
 import { Entity } from './entity';
+/**
+ * Base class for all behaviors.
+ *
+ * Behaviors are a versatile way to add interactivity to your experience. They’re often used to:
+ * - Listen to the events emitted by a node and then perform an action, such as playing an animation or calling a function in a context.
+ * - Change the behavior or properties of the node they're attached to.
+ *
+ * @link [custom-behaviors](https://docs.zap.works/mattercraft/scripting/custom-behaviors/)
+ */
 export class Behavior extends Entity {
     /**
      * Constructs this behavior
@@ -27,9 +36,21 @@ export class Behavior extends Entity {
     }
 }
 const behaviorsToRunAtDesignTime = new Set();
+/**
+ * Checks if a specified Behavior should run at design time.
+ *
+ * @param b - The BehaviorConstructor to check.
+ * @returns A boolean indicating whether the behavior should run at design time.
+ */
 export function shouldBehaviorRunAtDesignTime(b) {
     return behaviorsToRunAtDesignTime.has(b);
 }
+/**
+ * Registers a Behavior to run at design time.
+ *
+ * @param b - The BehaviorConstructor to register.
+ * @returns The updated Set containing all registered BehaviorConstructors.
+ */
 export function registerBehaviorRunAtDesignTime(b) {
     return behaviorsToRunAtDesignTime.add(b);
 }

package/lib/behaviors/ActivateState.d.ts

@@ -1,7 +1,8 @@
-import { ActionBehavior, ActionBehaviorConstructorProps } from "../actionbehavior";
-import { Component } from "../component";
-import { ContextManager } from "../context";
+import { ActionBehavior, ActionBehaviorConstructorProps } from '../actionbehavior';
+import { Component } from '../component';
+import { ContextManager } from '../context';
 /**
+ * Behavior to activate a specific animation state.
  * @zbehavior
  * @zicon play_circle
  * @zgroup Animation Actions
@@ -9,6 +10,7 @@ import { ContextManager } from "../context";
 export declare class ActivateState extends ActionBehavior {
     private zcomponent;
     /**
+     * The ID of the animation state to be activated.
      * @zprop
      * @zgroup Activate State Settings
      * @zgrouppriority 20
@@ -16,6 +18,7 @@ export declare class ActivateState extends ActionBehavior {
      */
     state: string | undefined;
     /**
+     * Override time for the fade transition.
      * @zprop
      * @zgroup Override Fade
      * @zgrouppriority 10
@@ -30,6 +33,7 @@ export declare class ActivateState extends ActionBehavior {
      */
     pin?: Pin | number;
     /**
+     * Easing function for the fade transition.
      * @zprop
      * @zgroup Override Fade
      * @zgrouppriority 10
@@ -43,6 +47,9 @@ export declare class ActivateState extends ActionBehavior {
     /** @zui */
     preview(): void;
 }
+/**
+ * Enum for specifying the pin point of the animation.
+ */
 export declare enum Pin {
     Start = 0,
     Middle = 0.5,

package/lib/behaviors/ActivateState.js

@@ -1,6 +1,7 @@
-import { ActionBehavior, } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
 /**
+ * Behavior to activate a specific animation state.
  * @zbehavior
  * @zicon play_circle
  * @zgroup Animation Actions
@@ -21,8 +22,8 @@ export class ActivateState extends ActionBehavior {
             fade: {
                 time: this.fadeTime,
                 pin: this.pin,
-                easing: this.easing
-            }
+                easing: this.easing,
+            },
         };
         layerclip.play(opts);
     }
@@ -31,6 +32,9 @@ export class ActivateState extends ActionBehavior {
         this.perform();
     }
 }
+/**
+ * Enum for specifying the pin point of the animation.
+ */
 export var Pin;
 (function (Pin) {
     Pin[Pin["Start"] = 0] = "Start";

package/lib/behaviors/CallFunction.d.ts

@@ -1,4 +1,4 @@
-import { ActionBehavior } from "../actionbehavior";
+import { ActionBehavior } from '../actionbehavior';
 /**
  * Calls an exposed function on a context
  *

package/lib/behaviors/CallFunction.js

@@ -1,5 +1,5 @@
-import { ActionBehavior } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
 /**
  * Calls an exposed function on a context
  *

package/lib/behaviors/ConsoleLog.d.ts

@@ -1,4 +1,4 @@
-import { ActionBehavior } from "../actionbehavior";
+import { ActionBehavior } from '../actionbehavior';
 /**
  * Outputs a message to the console log.
  *

package/lib/behaviors/ConsoleLog.js

@@ -1,5 +1,5 @@
-import { ActionBehavior } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
 /**
  * Outputs a message to the console log.
  *

package/lib/behaviors/DownloadSnapshot.d.ts

@@ -4,14 +4,17 @@ import { ContextManager } from '../context';
 import { Event } from '../event';
 export type DownloadSnapshotProps = ActionBehaviorConstructorProps;
 /**
- * Downloads the captured canvas as an image.
+ * Behavior for downloading a captured canvas snapshot as an image.
  *
  * @zbehavior
  * @zicon download
  * @zgroup Actions
  */
 export declare class DownloadSnapshot extends ActionBehavior<DownloadSnapshotProps> {
-    /** @zui */
+    /**
+     * Event triggered when a snapshot is saved.
+     * @zui
+     */
     onSave: Event<[]>;
     constructor(contextManager: ContextManager, instance: Component, props: DownloadSnapshotProps);
     /** @zprop */

package/lib/behaviors/DownloadSnapshot.js

@@ -3,7 +3,7 @@ import { registerBehaviorRunAtDesignTime } from '../behavior';
 import { SnapshotContext } from '../contexts/snapshotContext';
 import { Event } from '../event';
 /**
- * Downloads the captured canvas as an image.
+ * Behavior for downloading a captured canvas snapshot as an image.
  *
  * @zbehavior
  * @zicon download
@@ -12,7 +12,10 @@ import { Event } from '../event';
 export class DownloadSnapshot extends ActionBehavior {
     constructor(contextManager, instance, props) {
         super(contextManager, instance, props);
-        /** @zui */
+        /**
+         * Event triggered when a snapshot is saved.
+         * @zui
+         */
         this.onSave = new Event();
         this.download = () => {
             const snapshotContext = this.contextManager.get(SnapshotContext);

package/lib/behaviors/LaunchURL.d.ts

@@ -1,4 +1,4 @@
-import { ActionBehavior } from "../actionbehavior";
+import { ActionBehavior } from '../actionbehavior';
 /**
  * Navigates the user to the provided URL.
  *

package/lib/behaviors/LaunchURL.js

@@ -1,4 +1,4 @@
-import { ActionBehavior } from "../actionbehavior";
+import { ActionBehavior } from '../actionbehavior';
 /**
  * Navigates the user to the provided URL.
  *

package/lib/behaviors/LogAnalyticsEvent.d.ts

@@ -1,4 +1,4 @@
-import { ActionBehavior } from "../actionbehavior";
+import { ActionBehavior } from '../actionbehavior';
 /**
  * Logs an event through the currently configured analytics provider(s).
  *

package/lib/behaviors/LogAnalyticsEvent.js

@@ -1,5 +1,5 @@
-import { ActionBehavior } from "../actionbehavior";
-import { logEvent } from "../contexts/analyticscontext";
+import { ActionBehavior } from '../actionbehavior';
+import { logEvent } from '../contexts/analyticscontext';
 /**
  * Logs an event through the currently configured analytics provider(s).
  *

package/lib/behaviors/PauseLayerClip.d.ts

@@ -1,7 +1,8 @@
-import { ActionBehavior, ActionBehaviorConstructorProps } from "../actionbehavior";
-import { Component } from "../component";
-import { ContextManager } from "../context";
+import { ActionBehavior, ActionBehaviorConstructorProps } from '../actionbehavior';
+import { Component } from '../component';
+import { ContextManager } from '../context';
 /**
+ * Behavior to pause a specific layer clip animation.
  * @zbehavior
  * @zicon pause_circle
  * @zgroup Animation Actions
@@ -9,6 +10,7 @@ import { ContextManager } from "../context";
 export declare class PauseLayerClip extends ActionBehavior {
     private zcomponent;
     /**
+     * The ID of the layer clip to be paused.
      * @zprop
      * @zvalues layerclipids
      */

package/lib/behaviors/PauseLayerClip.js

@@ -1,6 +1,7 @@
-import { ActionBehavior, } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
 /**
+ * Behavior to pause a specific layer clip animation.
  * @zbehavior
  * @zicon pause_circle
  * @zgroup Animation Actions

package/lib/behaviors/PlayLayerClip.d.ts

@@ -1,7 +1,8 @@
-import { ActionBehavior, ActionBehaviorConstructorProps } from "../actionbehavior";
-import { Component } from "../component";
-import { ContextManager } from "../context";
+import { ActionBehavior, ActionBehaviorConstructorProps } from '../actionbehavior';
+import { Component } from '../component';
+import { ContextManager } from '../context';
 /**
+ * Behavior to play a specified layer clip animation.
  * @zbehavior
  * @zicon play_circle
  * @zgroup Animation Actions
@@ -9,6 +10,7 @@ import { ContextManager } from "../context";
 export declare class PlayLayerClip extends ActionBehavior {
     private zcomponent;
     /**
+     * The ID of the layer clip to be played.
      * @zprop
      * @zgroup Play Settings
      * @zgrouppriority 20
@@ -16,6 +18,7 @@ export declare class PlayLayerClip extends ActionBehavior {
      */
     layerClip: string | undefined;
     /**
+     * Whether the layer clip should loop.
      * @zprop
      * @zgroup Play Settings
      * @zgrouppriority 20
@@ -23,6 +26,7 @@ export declare class PlayLayerClip extends ActionBehavior {
      */
     loop?: boolean;
     /**
+     * The playback speed of the layer clip.
      * @zprop
      * @zgroup Play Settings
      * @zgrouppriority 20
@@ -30,6 +34,7 @@ export declare class PlayLayerClip extends ActionBehavior {
      */
     speed?: number;
     /**
+     * Whether to queue the layer clip in the animation sequence.
      * @zprop
      * @zgroup Play Settings
      * @zgrouppriority 20
@@ -37,7 +42,7 @@ export declare class PlayLayerClip extends ActionBehavior {
      */
     queue: boolean;
     /**
-     * Seek the clip to the start before playing
+     * Whether to seek the layer clip to the start before playing.
      *
      * @zprop
      * @zgroup Play Settings
@@ -46,6 +51,7 @@ export declare class PlayLayerClip extends ActionBehavior {
      */
     fromStart: boolean;
     /**
+     *  Override time for the fade transition.
      * @zprop
      * @zgroup Override Fade
      * @zgrouppriority 10

package/lib/behaviors/PlayLayerClip.js

@@ -1,6 +1,7 @@
-import { ActionBehavior, } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
 /**
+ * Behavior to play a specified layer clip animation.
  * @zbehavior
  * @zicon play_circle
  * @zgroup Animation Actions
@@ -10,6 +11,7 @@ export class PlayLayerClip extends ActionBehavior {
         super(contextManager, instance, props);
         this.zcomponent = this.getZComponentInstance();
         /**
+         * Whether to queue the layer clip in the animation sequence.
          * @zprop
          * @zgroup Play Settings
          * @zgrouppriority 20
@@ -17,7 +19,7 @@ export class PlayLayerClip extends ActionBehavior {
          */
         this.queue = false;
         /**
-         * Seek the clip to the start before playing
+         * Whether to seek the layer clip to the start before playing.
          *
          * @zprop
          * @zgroup Play Settings
@@ -39,8 +41,8 @@ export class PlayLayerClip extends ActionBehavior {
             fade: {
                 time: this.fadeTime,
                 pin: this.pin,
-                easing: this.easing
-            }
+                easing: this.easing,
+            },
         };
         if (this.fromStart ?? false)
             layerclip.seek(0, { dontActivateLayer: true });

package/lib/behaviors/PlaySound.d.ts

@@ -1,7 +1,7 @@
-import { ActionBehavior, ActionBehaviorConstructorProps } from "../actionbehavior";
-import { Component } from "../component";
-import { ContextManager } from "../context";
-import { Observable } from "../observable";
+import { ActionBehavior, ActionBehaviorConstructorProps } from '../actionbehavior';
+import { Component } from '../component';
+import { ContextManager } from '../context';
+import { Observable } from '../observable';
 export interface PlaySoundProps extends ActionBehaviorConstructorProps {
     /** @zprop
      * @zvalues files *.+(mp3|wav)

package/lib/behaviors/PlaySound.js

@@ -1,7 +1,7 @@
-import { ActionBehavior, } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
-import { Audio } from "../components/Audio";
-import { Observable } from "../observable";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
+import { Audio } from '../components/Audio';
+import { Observable } from '../observable';
 /**
  * Plays a sound
  *

package/lib/behaviors/SetLayerOff.d.ts

@@ -1,7 +1,8 @@
-import { ActionBehavior, ActionBehaviorConstructorProps } from "../actionbehavior";
-import { Component } from "../component";
-import { ContextManager } from "../context";
+import { ActionBehavior, ActionBehaviorConstructorProps } from '../actionbehavior';
+import { Component } from '../component';
+import { ContextManager } from '../context';
 /**
+ * Sets a leye clip to be inactive.
  * @zbehavior
  * @zicon toggle_off
  * @zgroup Animation Actions

package/lib/behaviors/SetLayerOff.js

@@ -1,6 +1,7 @@
-import { ActionBehavior, } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
 /**
+ * Sets a leye clip to be inactive.
  * @zbehavior
  * @zicon toggle_off
  * @zgroup Animation Actions

package/lib/behaviors/ShowTextAlert.d.ts

@@ -1,5 +1,5 @@
-import { ActionBehavior } from "../actionbehavior";
-import { Observable } from "../observable";
+import { ActionBehavior } from '../actionbehavior';
+import { Observable } from '../observable';
 /**
  * Displays a pop-up text alert on screen.
  *

package/lib/behaviors/ShowTextAlert.js

@@ -1,7 +1,7 @@
-import { ActionBehavior } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
-import { showTextAlert } from "../contexts/textalertcontext";
-import { Observable } from "../observable";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
+import { showTextAlert } from '../contexts/textalertcontext';
+import { Observable } from '../observable';
 /**
  * Displays a pop-up text alert on screen.
  *
@@ -69,7 +69,7 @@ export class ShowTextAlert extends ActionBehavior {
             backgroundColor: this.backgroundColor.value,
             textColor: this.textColor.value,
             classNames: this.classNames.value,
-            timeout: this.timeout.value
+            timeout: this.timeout.value,
         });
     }
     /** @zui */

package/lib/behaviors/ToggleLayerClips.d.ts

@@ -1,7 +1,8 @@
-import { ActionBehavior, ActionBehaviorConstructorProps } from "../actionbehavior";
-import { Component } from "../component";
-import { ContextManager } from "../context";
+import { ActionBehavior, ActionBehaviorConstructorProps } from '../actionbehavior';
+import { Component } from '../component';
+import { ContextManager } from '../context';
 /**
+ * Toggles between two layer clips.
  * @zbehavior
  * @zicon play_circle
  * @zgroup Animation Actions

package/lib/behaviors/ToggleLayerClips.js

@@ -1,6 +1,7 @@
-import { ActionBehavior, } from "../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../behavior";
+import { ActionBehavior } from '../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../behavior';
 /**
+ * Toggles between two layer clips.
  * @zbehavior
  * @zicon play_circle
  * @zgroup Animation Actions
@@ -36,8 +37,8 @@ export class ToggleLayerClips extends ActionBehavior {
             fade: {
                 time: this.fadeTime,
                 pin: this.pin,
-                easing: this.easing
-            }
+                easing: this.easing,
+            },
         };
         const layerID = this.isA ? this.layerOffA : this.layerOffB;
         const layerClipID = this.isA ? this.layerClipA : this.layerClipB;

package/lib/behaviors/stream/PauseStream.d.ts

@@ -1,7 +1,8 @@
-import { ActionBehavior, ActionBehaviorConstructorProps } from "../../actionbehavior";
-import { Component } from "../../component";
-import { ContextManager } from "../../context";
+import { ActionBehavior, ActionBehaviorConstructorProps } from '../../actionbehavior';
+import { Component } from '../../component';
+import { ContextManager } from '../../context';
 /**
+ *  Behavior to pause a specific stream.
  * @zbehavior
  * @zicon pause_circle
  * @zgroup Stream Actions
@@ -9,15 +10,26 @@ import { ContextManager } from "../../context";
 export declare class PauseStream extends ActionBehavior {
     private zcomponent;
     /**
+     * The ID of the stream to be paused.
      * @zprop
      * @zgroup Pause Settings
      * @zgrouppriority 20
      * @zvalues streamids
      */
     stream: string | undefined;
+    /**
+     * Creates an instance of PauseStream.
+     * @param contextManager
+     * @param instance
+     * @param props
+     */
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
+    /**
+     * Executes the action to pause the stream.
+     */
     perform(): void;
     /**
+     * Provides a preview of the pause action within the UI.
      * @zprop
      * @zui
      */

package/lib/behaviors/stream/PauseStream.js

@@ -1,15 +1,25 @@
-import { ActionBehavior, } from "../../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../../behavior";
+import { ActionBehavior } from '../../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../../behavior';
 /**
+ *  Behavior to pause a specific stream.
  * @zbehavior
  * @zicon pause_circle
  * @zgroup Stream Actions
  */
 export class PauseStream extends ActionBehavior {
+    /**
+     * Creates an instance of PauseStream.
+     * @param contextManager
+     * @param instance
+     * @param props
+     */
     constructor(contextManager, instance, props) {
         super(contextManager, instance, props);
         this.zcomponent = this.getZComponentInstance();
     }
+    /**
+     * Executes the action to pause the stream.
+     */
     perform() {
         if (!this.stream)
             return;
@@ -19,6 +29,7 @@ export class PauseStream extends ActionBehavior {
         stream.pause();
     }
     /**
+     * Provides a preview of the pause action within the UI.
      * @zprop
      * @zui
      */

package/lib/behaviors/stream/PlayStream.d.ts

@@ -1,7 +1,8 @@
-import { ActionBehavior, ActionBehaviorConstructorProps } from "../../actionbehavior";
-import { Component } from "../../component";
-import { ContextManager } from "../../context";
+import { ActionBehavior, ActionBehaviorConstructorProps } from '../../actionbehavior';
+import { Component } from '../../component';
+import { ContextManager } from '../../context';
 /**
+ * Behavior to play a specified stream.
  * @zbehavior
  * @zicon play_circle
  * @zgroup Stream Actions
@@ -9,6 +10,7 @@ import { ContextManager } from "../../context";
 export declare class PlayStream extends ActionBehavior {
     private zcomponent;
     /**
+     * The ID of the stream to be played.
      * @zprop
      * @zgroup Play Settings
      * @zgrouppriority 20
@@ -16,6 +18,7 @@ export declare class PlayStream extends ActionBehavior {
      */
     stream: string | undefined;
     /**
+     * Whether the stream should loop.
      * @zprop
      * @zgroup Play Settings
      * @zgrouppriority 20
@@ -23,6 +26,7 @@ export declare class PlayStream extends ActionBehavior {
      */
     loop?: boolean;
     /**
+     * The playback speed of the stream.
      * @zprop
      * @zgroup Play Settings
      * @zgrouppriority 20
@@ -30,7 +34,7 @@ export declare class PlayStream extends ActionBehavior {
      */
     speed?: number;
     /**
-     * Seek the clip to the start before playing
+     * Whether to seek the stream to the start before playing.
      *
      * @zprop
      * @zgroup Play Settings
@@ -38,6 +42,12 @@ export declare class PlayStream extends ActionBehavior {
      * @zdefault false
      */
     fromStart: boolean;
+    /**
+     * Creates an instance of PlayStream.
+     * @param contextManager - The current ContextManager
+     * @param instance - The instance of the component that this behavior is attached to
+     * @param props - The constructor properties.
+     */
     constructor(contextManager: ContextManager, instance: Component, props: ActionBehaviorConstructorProps);
     /** @zprop */
     perform(): void;

package/lib/behaviors/stream/PlayStream.js

@@ -1,16 +1,23 @@
-import { ActionBehavior, } from "../../actionbehavior";
-import { registerBehaviorRunAtDesignTime } from "../../behavior";
+import { ActionBehavior } from '../../actionbehavior';
+import { registerBehaviorRunAtDesignTime } from '../../behavior';
 /**
+ * Behavior to play a specified stream.
  * @zbehavior
  * @zicon play_circle
  * @zgroup Stream Actions
  */
 export class PlayStream extends ActionBehavior {
+    /**
+     * Creates an instance of PlayStream.
+     * @param contextManager - The current ContextManager
+     * @param instance - The instance of the component that this behavior is attached to
+     * @param props - The constructor properties.
+     */
     constructor(contextManager, instance, props) {
         super(contextManager, instance, props);
         this.zcomponent = this.getZComponentInstance();
         /**
-         * Seek the clip to the start before playing
+         * Whether to seek the stream to the start before playing.
          *
          * @zprop
          * @zgroup Play Settings