@zcomponent/core 1.14.3 → 1.16.0-beta

package/lib/data/animation.d.ts

@@ -1,23 +1,41 @@
+/**
+ * Type for mapping IDs to objects.
+ */
 export type ByID<T> = {
     [id: string]: T | undefined;
 };
+/**
+ * Type for mapping node properties.
+ */
 export type ByNodeProperty<T> = {
     [id: string]: {
         [id: string]: T | undefined;
     } | undefined;
 };
+/**
+ * Interface defining the structure of an Animation.
+ */
 export interface Animation {
     clips: ByID<Clip>;
     layers: ByID<Layer>;
     curves: ByID<Curve>;
 }
+/**
+ * Type for defining blend methods.
+ */
 export type BlendType = 'overlay' | 'add';
+/**
+ * Interface for fade parameters.
+ */
 export interface FadeParameters {
     time: number;
     pin?: number;
     easing?: Easing;
     reverse?: boolean;
 }
+/**
+ * Interface defining a Layer within an animation.
+ */
 export interface Layer {
     order: string;
     name: string;
@@ -28,6 +46,9 @@ export interface Layer {
     defaultClip?: string | null;
     enabled: boolean;
 }
+/**
+ * Interface defining a LayerClip, a clip within a Layer.
+ */
 export interface LayerClip {
     order: string;
     id: string;
@@ -38,12 +59,24 @@ export interface LayerClip {
     scriptName?: string;
     playAtStart?: boolean;
 }
+/**
+ * Type for mapping active layer clips.
+ */
 export type ActiveLayerClips = ByID<string | undefined>;
+/**
+ * Enum for different types of Clips.
+ */
 export declare enum ClipType {
     Timeline = "timeline",
     State = "state"
 }
+/**
+ * Type for defining clip length types.
+ */
 export type ClipLengthType = 'auto' | 'expand' | 'manual';
+/**
+ * Interface defining a Clip.
+ */
 export interface Clip {
     order: string;
     type: ClipType;
@@ -56,6 +89,9 @@ export interface Clip {
     timeSourceTrack?: string;
     scriptName?: string;
 }
+/**
+ * Interface for a keyframe in an animation.
+ */
 export interface Keyframe {
     id: string;
     v: any;
@@ -63,18 +99,39 @@ export interface Keyframe {
     label?: string;
     easing?: Easing;
 }
+/**
+ * Predefined curves for easing
+ */
 export declare const predefinedCurve: {
     [id: string]: Bezier[];
 };
+/**
+ * Type for easing, which can be a predefined curve name or a custom bezier curve.
+ */
 export type Easing = null | keyof typeof predefinedCurve | string;
+/**
+ * Type representing a point in a Bezier curve.
+ */
 export type Point = [number, number];
+/**
+ * Type representing a Bezier curve.
+ *
+ * @note
+ * Bezier represents the four control points between this keyframe and the next
+ */
 export type Bezier = [Point, Point, Point, Point];
+/**
+ * Type representing a curve, which is a collection of Bezier segments.
+ */
 export type Curve = {
     id: string;
     order?: string;
     name: string;
     curve: Bezier[];
 };
+/**
+ * Enum for different types of Tracks in an animation.
+ */
 export declare enum TrackType {
     Property = "property",
     Clip = "clip",
@@ -86,6 +143,9 @@ export declare enum TrackType {
     Fade = "fade"
 }
 export type Track = PropertyTrack | ClipTrack | StreamTrack | FunctionTrack | LabelTrack;
+/**
+ * Base interface for a track in an animation.
+ */
 export interface BaseTrack {
     order: string;
     id: string;
@@ -117,47 +177,150 @@ export interface ClipTrackEntity {
     s0: number;
     rate: number;
 }
+/**
+ * Represents a stream track, extending the base track with specific properties for streaming.
+ */
 export interface StreamTrack extends BaseTrack {
+    /**
+     * The type of track, defined as 'Stream'.
+     */
     type: TrackType.Stream;
+    /**
+     * The name of the stream track.
+     */
     name: string;
+    /**
+     * The data associated with the stream track, mapped by ID.
+     */
     data: ByID<StreamTrackEntity>;
+    /**
+     * The weight of each stream track entity, mapped by ID.
+     */
     weight: ByID<Keyframe>;
+    /**
+     * An array representing the properties of the stream track.
+     */
     property: (string | number)[];
 }
+/**
+ * Describes the structure of a stream track entity.
+ */
 export interface StreamTrackEntity {
+    /**
+     * Unique identifier for the stream track entity.
+     */
     id: string;
+    /**
+     * Start point on track.
+     */
     t0: number;
+    /**
+     * End point on track.
+     */
     t1?: number;
+    /**
+     * Start point in stream.
+     */
     s0: number;
+    /**
+     * Playback rate of the stream.
+     */
     rate: number;
 }
+/**
+ * Describes the structure of a function track which is an extension of a base track,
+ */
 export interface FunctionTrack extends BaseTrack {
+    /**
+     * Type of track.
+     */
     type: TrackType.Function;
+    /**
+     * The data for the function track.
+     */
     data: ByID<FunctionTrackEntity>;
 }
+/**
+ * Defines a type that represents entities within a function track.
+ */
 export type FunctionTrackEntity = EntityFunctionTrackEntity | ImportFunctionTrackEntity;
+/**
+ * Serves as a base interface for entities within a function track.
+ * Providing common properties independent of the specific function track entity type.
+ */
 export interface BaseFunctionTrackEntity {
+    /**
+     * Unique identifier for the function track entity.
+     */
     id: string;
+    /**
+     * Start point on track.
+     */
     t0: number;
+    /**
+     * The type of function track entity.
+     */
     type: 'entity' | 'import';
     args: ByID<any>;
     runAtDesignTime?: boolean;
 }
+/**
+ * Represents an entity function track entity, extending the base function track entity.
+ */
 export interface EntityFunctionTrackEntity extends BaseFunctionTrackEntity {
+    /**
+     * The type of function track entity, defined as 'entity'.
+     */
     type: 'entity';
+    /**
+     * The ID of the entity associated with the function track.
+     */
     entityID: string;
+    /**
+     * The name of the function to be executed.
+     */
     functionName: string;
 }
+/**
+ * Represents an import function track entity, extending the base function track entity.
+ */
 export interface ImportFunctionTrackEntity extends BaseFunctionTrackEntity {
+    /**
+     * The type of function track entity, defined as 'import'.
+     */
     type: 'import';
+    /**
+     * The import path or identifier.
+     */
     import: string;
 }
+/**
+ * Represents a label track, extending the base track with specific data for labels.
+ */
 export interface LabelTrack extends BaseTrack {
+    /**
+     * The type of track, defined as 'Label'.
+     */
     type: TrackType.Label;
+    /**
+     * The data for the label track, mapped by ID.
+     */
     data: ByID<LabelTrackEntity>;
 }
+/**
+ * Describes the structure of a label track entity.
+ */
 export interface LabelTrackEntity {
+    /**
+     * The order of the label in the track.
+     */
     order: string;
+    /**
+     * The time point of the label on the track.
+     */
     t: number;
+    /**
+     * The text label.
+     */
     label: string;
 }

package/lib/data/animation.js

@@ -1,10 +1,16 @@
 // CLIP
+/**
+ * Enum for different types of Clips.
+ */
 export var ClipType;
 (function (ClipType) {
     ClipType["Timeline"] = "timeline";
     ClipType["State"] = "state";
 })(ClipType || (ClipType = {}));
 // TODO: it's a temporary placement for this object
+/**
+ * Predefined curves for easing
+ */
 export const predefinedCurve = {
     linear: [
         [
@@ -127,6 +133,9 @@ export const predefinedCurve = {
 // 	}
 // ];
 ////// TRACKS
+/**
+ * Enum for different types of Tracks in an animation.
+ */
 export var TrackType;
 (function (TrackType) {
     TrackType["Property"] = "property";

package/lib/data/change.d.ts

@@ -1,44 +1,243 @@
 import { BehaviorByID, BehaviorData, ComputedHierarchy, EntityPropOverride, NodeByID, NodeData, ZComponentData } from './core';
 import { Prop } from '../types';
+/**
+ * Computes and memoizes the hierarchy of nodes.
+ *
+ * @param nodes - A map of node IDs to node data.
+ * @returns The computed hierarchy of nodes.
+ */
 export declare function computeNodeHierarchy(nodes: NodeByID): ComputedHierarchy;
+/**
+ * Computes and memoizes the hierarchy of behaviors.
+ *
+ * @param behaviors - A map of behavior IDs to behavior data.
+ * @returns The computed hierarchy of behaviors.
+ */
 export declare function computeBehaviorHierarchy(behaviors: BehaviorByID): ComputedHierarchy;
+/**
+ * Adds a new node to the specified ZComponentData.
+ *
+ * @param zcomp - The ZComponentData to which the node is added.
+ * @param info - The combined data of the node to be added.
+ */
 export declare function addNode(zcomp: ZComponentData, info: NodeDataCombined): void;
+/**
+ * Adds a new behavior to the specified ZComponentData.
+ *
+ * @param zcomp - The ZComponentData to which the behavior is added.
+ * @param info - The combined data of the behavior to be added.
+ */
 export declare function addBehavior(zcomp: ZComponentData, info: BehaviorDataCombined): void;
+/**
+ * Updates a component property in the ZComponentData.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param prop - The property name to update.
+ * @param isConstructorProp - Indicates if the property is a constructor property.
+ * @param newValue - The new value for the property.
+ * @param newIsConstructorProp - Indicates if the new value is a constructor property.
+ */
 export declare function updateComponentProp(zcomp: ZComponentData, prop: string, isConstructorProp: boolean, newValue: Prop | undefined, newIsConstructorProp: boolean): void;
 export declare function addEntityPropOverride(zcomp: ZComponentData, o: EntityPropOverride): void;
+/**
+ * Deletes an entity property override from the specified ZComponentData.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param id - The ID of the EntityPropOverride to delete.
+ */
 export declare function deleteEntityPropOverride(zcomp: ZComponentData, id: string): void;
+/**
+ * Deep clones the given object.
+ *
+ * @typeParam T - The type of the object to clone.
+ * @param obj - The object to clone.
+ * @returns A deep clone of the object.
+ */
 export declare function clone<T>(obj: T): T;
+/**
+ * Checks if two objects are equal by comparing their JSON string representations.
+ *
+ * @typeParam T - The type of the objects to compare.
+ * @param obj1 - The first object to compare.
+ * @param obj2 - The second object to compare.
+ * @returns True if the objects are equal, otherwise false.
+ */
 export declare function isEqual<T>(obj1: T, obj2: T): boolean;
 export declare function addEntity(zcomp: ZComponentData, id: string, info: EntityDataCombined): void;
+/**
+ * Moves nodes to a new parent within the ZComponentData hierarchy.
+ *
+ * @param zcomp - The ZComponentData containing the nodes.
+ * @param nodeIDs - Array of node IDs to be moved.
+ * @param newParentID - The ID of the new parent node.
+ * @param indx - The index at which to insert the nodes in the new parent's child array.
+ */
 export declare function moveNodes(zcomp: ZComponentData, nodeIDs: string[], newParentID: string, indx: number): void;
+/**
+ * Deletes a node and its child nodes and associated behaviors from ZComponentData.
+ *
+ * @param zcomp - The ZComponentData from which the node will be deleted.
+ * @param id - The ID of the node to delete.
+ */
 export declare function deleteNode(zcomp: ZComponentData, id: string): void;
+/**
+ * Deletes a behavior from ZComponentData.
+ *
+ * @param zcomp - The ZComponentData from which the behavior will be deleted.
+ * @param id - The ID of the behavior to delete.
+ */
 export declare function deleteBehavior(zcomp: ZComponentData, id: string): void;
+/**
+ * Retrieves combined data for a specific node in ZComponentData.
+ *
+ * @param zcomp - The ZComponentData containing the node.
+ * @param id - The ID of the node.
+ * @returns Combined node data or undefined if the node doesn't exist.
+ */
 export declare function getNodeDataCombined(zcomp: ZComponentData, id: string): NodeDataCombined | undefined;
+/**
+ * Retrieves combined data for a specific behavior in ZComponentData.
+ *
+ * @param zcomp - The ZComponentData containing the behavior.
+ * @param id - The ID of the behavior.
+ * @returns Combined behavior data or undefined if the behavior doesn't exist.
+ */
 export declare function getBehaviorDataCombined(zcomp: ZComponentData, id: string): BehaviorDataCombined | undefined;
+/**
+ * Fixes any duplicate index issues in the node hierarchy.
+ *
+ * @param zcomp - The ZComponentData containing the nodes.
+ * @param hierarchy - The computed hierarchy of nodes.
+ * @param nodeID - The ID of the parent node.
+ * @param indx - The index to start checking for duplicates.
+ */
 export declare function fixAnyDuplicateIndex(zcomp: ZComponentData, hierarchy: ComputedHierarchy, nodeID: string, indx: number): void;
+/**
+ * Fixes any duplicate index issues in the behavior hierarchy.
+ *
+ * @param zcomp - The ZComponentData containing the behaviors.
+ * @param behaviors - The computed hierarchy of behaviors.
+ * @param nodeID - The ID of the parent node.
+ * @param indx - The index to start checking for duplicates.
+ */
 export declare function fixAnyDuplicateBehaviorsIndex(zcomp: ZComponentData, behaviors: ComputedHierarchy, nodeID: string, indx: number): void;
+/**
+ * Calculates the order for a node to be placed at a specific index under a parent.
+ *
+ * @param zcomp - The ZComponentData containing the nodes.
+ * @param parentID - The ID of the parent node.
+ * @param indx - The index at which the node is to be placed.
+ * @returns The order string for the node.
+ */
 export declare function nodeOrderForParentIndex(zcomp: ZComponentData, parentID: string, indx?: number): string;
+/**
+ * Calculates the order for a behavior to be placed at a specific index under a parent.
+ *
+ * @param zcomp - The ZComponentData containing the behaviors.
+ * @param parentID - The ID of the parent node.
+ * @param indx - The index at which the behavior is to be placed.
+ * @returns The order string for the behavior.
+ */
 export declare function behaviorOrderForParentIndex(zcomp: ZComponentData, parentID: string, indx?: number): string;
+/**
+ * Adds a node's label to the ZComponentData's label register.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param id - The ID of the node whose label is to be added.
+ */
 export declare function addNodeLabelToRegister(zcomp: ZComponentData, id: string): void;
+/**
+ * Removes a node's label from the ZComponentData's label register.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param id - The ID of the node whose label is to be removed.
+ */
 export declare function removeNodeLabelFromRegister(zcomp: ZComponentData, id: string): void;
+/**
+ * Adds a node's script name to the ZComponentData's script name register.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param id - The ID of the node whose script name is to be added.
+ */
 export declare function addNodeScriptNameToRegister(zcomp: ZComponentData, id: string): void;
+/**
+ * Removes a node's script name from the ZComponentData's script name register.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param id - The ID of the node whose script name is to be removed.
+ */
 export declare function removeNodeScriptNameFromRegister(zcomp: ZComponentData, id: string): void;
+/**
+ * Changes the label of a node in the ZComponentData.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param id - The ID of the node whose label is to be changed.
+ * @param newLabel - The new label for the node.
+ */
 export declare function changeNodeLabel(zcomp: ZComponentData, id: string, newLabel: string | undefined): void;
+/**
+ * Changes the script name of a node in the ZComponentData.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param id - The ID of the node whose script name is to be changed.
+ * @param newScriptName - The new script name for the node.
+ */
 export declare function changeNodeScriptName(zcomp: ZComponentData, id: string, newScriptName: string | undefined): void;
+/**
+ * Deletes an entity and its associated data from ZComponentData.
+ *
+ * @param zcomp - The ZComponentData to update.
+ * @param id - The ID of the entity to delete.
+ */
 export declare function deleteEntity(zcomp: ZComponentData, id: string): void;
+/**
+ * Iterates over each ancestor of a node and executes a function.
+ *
+ * @param zcomp - The ZComponentData containing the node.
+ * @param id - The ID of the node.
+ * @param fn - The function to execute for each ancestor.
+ */
 export declare function forEachNodeAncestor(zcomp: ZComponentData, id: string, fn: (ancestorID: string) => void): void;
+/**
+ * Represents combined entity data, including properties and constructor properties.
+ */
 export interface EntityDataCombined {
+    /**
+     * A map of property identifiers to their values.
+     */
     props: {
         [id: string]: any;
     };
+    /**
+     * A map of constructor property identifiers to their values.
+     */
     constructorProps: {
         [id: string]: any;
     };
 }
+/**
+ * Represents combined node data, including the node data itself, properties, and constructor properties.
+ */
 export interface NodeDataCombined extends EntityDataCombined {
+    /**
+     * The data of the node.
+     */
     data: NodeData;
 }
+/**
+ * Represents combined behavior data, including the behavior data itself, properties, and constructor properties.
+ */
 export interface BehaviorDataCombined extends EntityDataCombined {
+    /**
+     * The data of the behavior.
+     */
     data: BehaviorData;
 }
+/**
+ * Generates a unique label for a node in ZComponentData.
+ *
+ * @param zcomp - The ZComponentData to check for existing labels.
+ * @param label - The base label to make unique.
+ * @returns A unique label for the node.
+ */
 export declare function getUniqueLabel(zcomp: ZComponentData, label: string): string;