@zcomponent/core 2.0.0-alpha.2 → 2.0.0-alpha.4

package/lib/zcomponent.d.ts

@@ -40,34 +40,41 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
     private _opts;
     /**
      * The id of the component.
+     * @zignore
      */
     readonly id: string;
     /**
      * A map of elements to node IDs.
+     * @zignore
      */
     readonly idByElement: Map<any, string>;
     /**
      * Object that maps node script names to scripts.
      * @default {}
+     * @zignore
      */
     readonly nodes: {
         [id: string]: Component | Component[];
     };
     /**
      * Map of entites  by ID.
+     * @zignore
      */
     readonly entityByID: Map<string, Entity>;
     /**
      * A map of entity labels to components.
+     * @zignore
      */
     readonly entityByLabel: Map<string, Entity>;
     /**
      * A map of node labels to components.
+     * @zignore
      */
     readonly nodeByLabel: Map<string, Component<any, ConstructorProps>>;
     private _constructedResolve;
     /**
      * A promise that is resolved once construction of this component is complete.
+     * @zignore
      */
     constructed: Promise<void>;
     /**
@@ -76,6 +83,7 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
     private _isConstructed;
     /**
      * A boolean indicating if construction of this component is complete.
+     * @zignore
      */
     get isConstructed(): boolean;
     /**
@@ -86,6 +94,7 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
     /**
      * @zstreams layerclipids
      * @default {}
+     * @zignore
      */
     readonly streams: {
         [id: string]: Stream;
@@ -113,11 +122,13 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
      * The node ID is used to identify a node in the graph.
      * If a component constructor is passed as `type`, this function will ensure that the node that's returned
      * is an instance of that component, or return undefined if it is not.
+     * @zignore
      */
     resolveNodeID<T extends Component = Component>(id: string, type?: ConstructorForComponent<T>): T | undefined;
     /**
      * This function returns the behavior with the given ID. If the behavior is not found, it will return undefined.
      * This function is used to get a behavior from a behavior ID, which is a string representation of a behavior.
+     * @zignore
      */
     resolveBehaviorID<T extends Behavior = Behavior>(id: string, type?: ConstructorForBehavior<T>): T | undefined;
     /**
@@ -126,6 +137,7 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
      * @param id - The ID of the entity to resolve.
      * @returns The resolved entity as an instance of T (which extends Entity), or undefined if the entity could not be resolved.
      * @template T The entity type.
+     * @zignore
      */
     resolveEntityID<T extends Entity = Entity>(id: string): T | undefined;
     private _inflateBehaviors;
@@ -135,12 +147,14 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
      * Notifies the component that the properties of certain entities have changed.
      *
      * @param entries - A map where the keys are entity IDs and the values are sets of property names.
+     * @zignore
      */
     notifyPropsChanged(entries: Map<string, Set<string>>): void;
     /**
      * The animation editor will call this function when the user changes
      * the list of clips in the animation. We need to update the clip
      * data for each clip that was changed.
+     * @zignore
      */
     notifyClipsChanged(clips: Set<string>): void;
     private _initializeOverrides;
@@ -150,6 +164,7 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
     private _setEntityPropPath;
     /**
      * Returns the node with the specified ID.
+     * @zignore
      */
     _getNodeById(id: string): Component | undefined;
     /**
@@ -158,6 +173,7 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
      * period, followed by the name of the stream. This function splits the string into
      * parts, and then uses the parts to traverse the entity tree until it finds the
      * named stream.
+     * @zignore
      */
     resolveStreamID(id: string): Stream | undefined;
     /**
@@ -177,10 +193,14 @@ export declare class ZComponent<RootType = any> extends Component<RootType> {
      *
      * @param callback A function that will be called for each component in the traversal. The current component is passed as a parameter to the callback.
      * @param breadthFirst If traversal should be breadth-first. Defaults to `false` (depth-first).
+     * @zignore
      */
     traverse(callback: (comp: Component<any>) => void, breadthFirst?: boolean): void;
     private _traverseBFS;
     private _traverseDFS;
     private _constructTopLevelComponents;
+    /**
+     * @zignore
+     */
     dispose(): never;
 }

package/lib/zcomponent.js

@@ -68,77 +68,134 @@ export class ZComponentContext extends Context {
 let ZComponent = (() => {
     let _classSuper = Component;
     let _instanceExtraInitializers = [];
+    let _id_decorators;
+    let _id_initializers = [];
+    let _id_extraInitializers = [];
+    let _idByElement_decorators;
+    let _idByElement_initializers = [];
+    let _idByElement_extraInitializers = [];
+    let _nodes_decorators;
+    let _nodes_initializers = [];
+    let _nodes_extraInitializers = [];
+    let _entityByID_decorators;
+    let _entityByID_initializers = [];
+    let _entityByID_extraInitializers = [];
+    let _entityByLabel_decorators;
+    let _entityByLabel_initializers = [];
+    let _entityByLabel_extraInitializers = [];
+    let _nodeByLabel_decorators;
+    let _nodeByLabel_initializers = [];
+    let _nodeByLabel_extraInitializers = [];
+    let _constructed_decorators;
+    let _constructed_initializers = [];
+    let _constructed_extraInitializers = [];
+    let _get_isConstructed_decorators;
     let _animation_decorators;
     let _animation_initializers = [];
     let _animation_extraInitializers = [];
+    let _streams_decorators;
+    let _streams_initializers = [];
+    let _streams_extraInitializers = [];
     let _resolveNodeID_decorators;
     let _resolveBehaviorID_decorators;
     let _resolveEntityID_decorators;
     let _notifyPropsChanged_decorators;
     let _notifyClipsChanged_decorators;
+    let __getNodeById_decorators;
     let _resolveStreamID_decorators;
     let _traverse_decorators;
+    let _dispose_decorators;
     return class ZComponent extends _classSuper {
         static {
             const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _id_decorators = [zIgnore()];
+            _idByElement_decorators = [zIgnore()];
+            _nodes_decorators = [zIgnore()];
+            _entityByID_decorators = [zIgnore()];
+            _entityByLabel_decorators = [zIgnore()];
+            _nodeByLabel_decorators = [zIgnore()];
+            _constructed_decorators = [zIgnore()];
+            _get_isConstructed_decorators = [zIgnore()];
             _animation_decorators = [zIgnore()];
+            _streams_decorators = [zIgnore()];
             _resolveNodeID_decorators = [zIgnore()];
             _resolveBehaviorID_decorators = [zIgnore()];
             _resolveEntityID_decorators = [zIgnore()];
             _notifyPropsChanged_decorators = [zIgnore()];
             _notifyClipsChanged_decorators = [zIgnore()];
+            __getNodeById_decorators = [zIgnore()];
             _resolveStreamID_decorators = [zIgnore()];
             _traverse_decorators = [zIgnore()];
+            _dispose_decorators = [zIgnore()];
+            __esDecorate(this, null, _get_isConstructed_decorators, { kind: "getter", name: "isConstructed", static: false, private: false, access: { has: obj => "isConstructed" in obj, get: obj => obj.isConstructed }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _resolveNodeID_decorators, { kind: "method", name: "resolveNodeID", static: false, private: false, access: { has: obj => "resolveNodeID" in obj, get: obj => obj.resolveNodeID }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _resolveBehaviorID_decorators, { kind: "method", name: "resolveBehaviorID", static: false, private: false, access: { has: obj => "resolveBehaviorID" in obj, get: obj => obj.resolveBehaviorID }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _resolveEntityID_decorators, { kind: "method", name: "resolveEntityID", static: false, private: false, access: { has: obj => "resolveEntityID" in obj, get: obj => obj.resolveEntityID }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _notifyPropsChanged_decorators, { kind: "method", name: "notifyPropsChanged", static: false, private: false, access: { has: obj => "notifyPropsChanged" in obj, get: obj => obj.notifyPropsChanged }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _notifyClipsChanged_decorators, { kind: "method", name: "notifyClipsChanged", static: false, private: false, access: { has: obj => "notifyClipsChanged" in obj, get: obj => obj.notifyClipsChanged }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(this, null, __getNodeById_decorators, { kind: "method", name: "_getNodeById", static: false, private: false, access: { has: obj => "_getNodeById" in obj, get: obj => obj._getNodeById }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _resolveStreamID_decorators, { kind: "method", name: "resolveStreamID", static: false, private: false, access: { has: obj => "resolveStreamID" in obj, get: obj => obj.resolveStreamID }, metadata: _metadata }, null, _instanceExtraInitializers);
             __esDecorate(this, null, _traverse_decorators, { kind: "method", name: "traverse", static: false, private: false, access: { has: obj => "traverse" in obj, get: obj => obj.traverse }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(this, null, _dispose_decorators, { kind: "method", name: "dispose", static: false, private: false, access: { has: obj => "dispose" in obj, get: obj => obj.dispose }, metadata: _metadata }, null, _instanceExtraInitializers);
+            __esDecorate(null, null, _id_decorators, { kind: "field", name: "id", static: false, private: false, access: { has: obj => "id" in obj, get: obj => obj.id, set: (obj, value) => { obj.id = value; } }, metadata: _metadata }, _id_initializers, _id_extraInitializers);
+            __esDecorate(null, null, _idByElement_decorators, { kind: "field", name: "idByElement", static: false, private: false, access: { has: obj => "idByElement" in obj, get: obj => obj.idByElement, set: (obj, value) => { obj.idByElement = value; } }, metadata: _metadata }, _idByElement_initializers, _idByElement_extraInitializers);
+            __esDecorate(null, null, _nodes_decorators, { kind: "field", name: "nodes", static: false, private: false, access: { has: obj => "nodes" in obj, get: obj => obj.nodes, set: (obj, value) => { obj.nodes = value; } }, metadata: _metadata }, _nodes_initializers, _nodes_extraInitializers);
+            __esDecorate(null, null, _entityByID_decorators, { kind: "field", name: "entityByID", static: false, private: false, access: { has: obj => "entityByID" in obj, get: obj => obj.entityByID, set: (obj, value) => { obj.entityByID = value; } }, metadata: _metadata }, _entityByID_initializers, _entityByID_extraInitializers);
+            __esDecorate(null, null, _entityByLabel_decorators, { kind: "field", name: "entityByLabel", static: false, private: false, access: { has: obj => "entityByLabel" in obj, get: obj => obj.entityByLabel, set: (obj, value) => { obj.entityByLabel = value; } }, metadata: _metadata }, _entityByLabel_initializers, _entityByLabel_extraInitializers);
+            __esDecorate(null, null, _nodeByLabel_decorators, { kind: "field", name: "nodeByLabel", static: false, private: false, access: { has: obj => "nodeByLabel" in obj, get: obj => obj.nodeByLabel, set: (obj, value) => { obj.nodeByLabel = value; } }, metadata: _metadata }, _nodeByLabel_initializers, _nodeByLabel_extraInitializers);
+            __esDecorate(null, null, _constructed_decorators, { kind: "field", name: "constructed", static: false, private: false, access: { has: obj => "constructed" in obj, get: obj => obj.constructed, set: (obj, value) => { obj.constructed = value; } }, metadata: _metadata }, _constructed_initializers, _constructed_extraInitializers);
             __esDecorate(null, null, _animation_decorators, { kind: "field", name: "animation", static: false, private: false, access: { has: obj => "animation" in obj, get: obj => obj.animation, set: (obj, value) => { obj.animation = value; } }, metadata: _metadata }, _animation_initializers, _animation_extraInitializers);
+            __esDecorate(null, null, _streams_decorators, { kind: "field", name: "streams", static: false, private: false, access: { has: obj => "streams" in obj, get: obj => obj.streams, set: (obj, value) => { obj.streams = value; } }, metadata: _metadata }, _streams_initializers, _streams_extraInitializers);
             if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
         constructorProps = __runInitializers(this, _instanceExtraInitializers);
         _opts;
         /**
          * The id of the component.
+         * @zignore
          */
-        id;
+        id = __runInitializers(this, _id_initializers, void 0);
         /**
          * A map of elements to node IDs.
+         * @zignore
          */
-        idByElement = new Map();
+        idByElement = (__runInitializers(this, _id_extraInitializers), __runInitializers(this, _idByElement_initializers, new Map()));
         /**
          * Object that maps node script names to scripts.
          * @default {}
+         * @zignore
          */
-        nodes = {};
+        nodes = (__runInitializers(this, _idByElement_extraInitializers), __runInitializers(this, _nodes_initializers, {}));
         /**
          * Map of entites  by ID.
+         * @zignore
          */
-        entityByID = new Map();
+        entityByID = (__runInitializers(this, _nodes_extraInitializers), __runInitializers(this, _entityByID_initializers, new Map()));
         /**
          * A map of entity labels to components.
+         * @zignore
          */
-        entityByLabel = new Map();
+        entityByLabel = (__runInitializers(this, _entityByID_extraInitializers), __runInitializers(this, _entityByLabel_initializers, new Map()));
         /**
          * A map of node labels to components.
+         * @zignore
          */
-        nodeByLabel = new Map();
-        _constructedResolve;
+        nodeByLabel = (__runInitializers(this, _entityByLabel_extraInitializers), __runInitializers(this, _nodeByLabel_initializers, new Map()));
+        _constructedResolve = __runInitializers(this, _nodeByLabel_extraInitializers);
         /**
          * A promise that is resolved once construction of this component is complete.
+         * @zignore
          */
-        constructed = new Promise(resolve => {
+        constructed = __runInitializers(this, _constructed_initializers, new Promise(resolve => {
             this._constructedResolve = resolve;
-        });
+        }));
         /**
          * @default false
          */
-        _isConstructed = false;
+        _isConstructed = (__runInitializers(this, _constructed_extraInitializers), false);
         /**
          * A boolean indicating if construction of this component is complete.
+         * @zignore
          */
         get isConstructed() {
             return this._isConstructed;
@@ -151,9 +208,10 @@ let ZComponent = (() => {
         /**
          * @zstreams layerclipids
          * @default {}
+         * @zignore
          */
-        streams = (__runInitializers(this, _animation_extraInitializers), {});
-        _nodesById = new Map();
+        streams = (__runInitializers(this, _animation_extraInitializers), __runInitializers(this, _streams_initializers, {}));
+        _nodesById = (__runInitializers(this, _streams_extraInitializers), new Map());
         /**
          * @default []
          */
@@ -373,6 +431,7 @@ let ZComponent = (() => {
          * The node ID is used to identify a node in the graph.
          * If a component constructor is passed as `type`, this function will ensure that the node that's returned
          * is an instance of that component, or return undefined if it is not.
+         * @zignore
          */
         resolveNodeID(id, type) {
             const entity = this.entityByID.get(id);
@@ -394,6 +453,7 @@ let ZComponent = (() => {
         /**
          * This function returns the behavior with the given ID. If the behavior is not found, it will return undefined.
          * This function is used to get a behavior from a behavior ID, which is a string representation of a behavior.
+         * @zignore
          */
         resolveBehaviorID(id, type) {
             const entity = this.entityByID.get(id);
@@ -418,6 +478,7 @@ let ZComponent = (() => {
          * @param id - The ID of the entity to resolve.
          * @returns The resolved entity as an instance of T (which extends Entity), or undefined if the entity could not be resolved.
          * @template T The entity type.
+         * @zignore
          */
         resolveEntityID(id) {
             const entity = this.entityByID.get(id);
@@ -525,6 +586,7 @@ let ZComponent = (() => {
          * Notifies the component that the properties of certain entities have changed.
          *
          * @param entries - A map where the keys are entity IDs and the values are sets of property names.
+         * @zignore
          */
         notifyPropsChanged(entries) {
             for (const [entityID, propSet] of entries.entries()) {
@@ -546,6 +608,7 @@ let ZComponent = (() => {
          * The animation editor will call this function when the user changes
          * the list of clips in the animation. We need to update the clip
          * data for each clip that was changed.
+         * @zignore
          */
         notifyClipsChanged(clips) {
             for (const clipId of clips.values()) {
@@ -669,6 +732,7 @@ let ZComponent = (() => {
         }
         /**
          * Returns the node with the specified ID.
+         * @zignore
          */
         _getNodeById(id) {
             return this._nodesById.get(id);
@@ -679,6 +743,7 @@ let ZComponent = (() => {
          * period, followed by the name of the stream. This function splits the string into
          * parts, and then uses the parts to traverse the entity tree until it finds the
          * named stream.
+         * @zignore
          */
         resolveStreamID(id) {
             const parts = id.split('.');
@@ -709,6 +774,7 @@ let ZComponent = (() => {
          *
          * @param callback A function that will be called for each component in the traversal. The current component is passed as a parameter to the callback.
          * @param breadthFirst If traversal should be breadth-first. Defaults to `false` (depth-first).
+         * @zignore
          */
         traverse(callback, breadthFirst = false) {
             if (breadthFirst) {
@@ -801,6 +867,9 @@ let ZComponent = (() => {
                 }
             }
         }
+        /**
+         * @zignore
+         */
         dispose() {
             this.animation.dispose();
             for (const [id, entity] of this.entityByID.entries()) {

package/package.json

@@ -1,86 +1,86 @@
 {
-  "name": "@zcomponent/core",
-  "version": "2.0.0-alpha.2",
-  "description": "The core component model and built-in functionality for Mattercraft.",
-  "author": "Zappar Limited",
-  "license": "Proprietary",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "exports": {
-    ".": {
-      "development": "./src/index.ts",
-      "types": "./index.d.ts",
-      "default": "./index.js"
-    },
-    "./*": {
-      "development": "./src/*.ts",
-      "types": "./lib/*.d.ts",
-      "default": "./lib/*.js"
-    },
-    "./lib/*": {
-      "development": "./src/*.ts",
-      "types": "./lib/*.d.ts",
-      "default": "./lib/*.js"
-    }
-  },
-  "type": "module",
-  "engines": {
-    "node": ">=12.0.0",
-    "browsers": "defaults"
-  },
-  "zexports": [
-    "./lib/components/**/*",
-    "./lib/behaviors/**/*",
-    "./lib/contexts/**/*"
-  ],
-  "directories": {
-    "lib": "lib"
-  },
-  "files": [
-    "index.js",
-    "index.d.ts",
-    "lib/**/*",
-    "css/**/*",
-    "assets/**/*"
-  ],
-  "scripts": {
-    "build": "rm -rf lib && tspc && tsc-alias",
-    "watch": "tsc -w",
-    "docs": "typedoc --out docs",
-    "test": "vitest run",
-    "build-animation-tests": "tsc -p ./tsconfig.test.animation.json",
-    "predocs": "npm run ctix",
-    "ctix": "ctix build"
-  },
-  "devDependencies": {
-    "ts-patch": "^3.3.0",
-    "vitest": "3.1.3"
-  },
-  "keywords": [],
-  "release": {
-    "extends": "semantic-release-commit-filter",
-    "ci": true,
-    "branches": [
-      "main",
-      {
-        "name": "beta",
-        "channel": "beta",
-        "prerelease": "beta"
-      },
-      {
-        "name": "alpha",
-        "channel": "alpha",
-        "prerelease": "alpha"
-      }
-    ],
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/changelog",
-      "@semantic-release/npm",
-      "@semantic-release/gitlab",
-      "@semantic-release/git"
-    ],
-    "tagFormat": "@zcomponent/core@${version}"
-  }
+	"name": "@zcomponent/core",
+	"version": "2.0.0-alpha.4",
+	"description": "The core component model and built-in functionality for Mattercraft.",
+	"author": "Zappar Limited",
+	"license": "Proprietary",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"exports": {
+		".": {
+			"development": "./src/index.ts",
+			"types": "./index.d.ts",
+			"default": "./index.js"
+		},
+		"./*": {
+			"development": "./src/*.ts",
+			"types": "./lib/*.d.ts",
+			"default": "./lib/*.js"
+		},
+		"./lib/*": {
+			"development": "./src/*.ts",
+			"types": "./lib/*.d.ts",
+			"default": "./lib/*.js"
+		}
+	},
+	"type": "module",
+	"engines": {
+		"node": ">=12.0.0",
+		"browsers": "defaults"
+	},
+	"zexports": [
+		"./lib/components/**/*",
+		"./lib/behaviors/**/*",
+		"./lib/contexts/**/*"
+	],
+	"directories": {
+		"lib": "lib"
+	},
+	"files": [
+		"index.js",
+		"index.d.ts",
+		"lib/**/*",
+		"css/**/*",
+		"assets/**/*"
+	],
+	"scripts": {
+		"build": "rm -rf lib && tspc && tsc-alias",
+		"watch": "tsc -w",
+		"docs": "typedoc --out docs",
+		"test": "vitest run",
+		"build-animation-tests": "tsc -p ./tsconfig.test.animation.json",
+		"predocs": "npm run ctix",
+		"ctix": "ctix build"
+	},
+	"devDependencies": {
+		"ts-patch": "^3.3.0",
+		"vitest": "3.1.3"
+	},
+	"keywords": [],
+	"release": {
+		"extends": "semantic-release-commit-filter",
+		"ci": true,
+		"branches": [
+			"main",
+			{
+				"name": "beta",
+				"channel": "beta",
+				"prerelease": "beta"
+			},
+			{
+				"name": "alpha",
+				"channel": "alpha",
+				"prerelease": "alpha"
+			}
+		],
+		"plugins": [
+			"@semantic-release/commit-analyzer",
+			"@semantic-release/release-notes-generator",
+			"@semantic-release/changelog",
+			"@semantic-release/npm",
+			"@semantic-release/gitlab",
+			"@semantic-release/git"
+		],
+		"tagFormat": "@zcomponent/core@${version}"
+	}
 }