@weaverse/core 5.17.1 → 5.18.0

package/dist/index.js

@@ -1473,7 +1473,7 @@ module.exports = __toCommonJS(index_exports);
 var import_react = __toESM(require_react());
 
 // package.json
-var version = "5.17.1";
+var version = "5.18.0";
 
 // src/utils/index.ts
 var isReactNative = typeof navigator === "object" && navigator.product === "ReactNative";
@@ -1517,17 +1517,22 @@ function loadScript(src) {
 
 // src/utils/event-emitter.ts
 var EventEmitter = class {
+  /** Functions called when an update is emitted. */
   listeners;
+  /** Creates an emitter with no listeners. */
   constructor() {
     this.listeners = /* @__PURE__ */ new Set();
   }
+  /** Adds a listener and returns a function that removes it. */
   subscribe = (fn) => {
     this.listeners.add(fn);
     return () => this.unsubscribe(fn);
   };
+  /** Removes a previously subscribed listener. */
   unsubscribe = (fn) => {
     this.listeners.delete(fn);
   };
+  /** Calls every subscribed listener with the supplied data. */
   emit = (data) => {
     for (const fn of this.listeners) {
       fn(data);
@@ -1537,9 +1542,13 @@ var EventEmitter = class {
 
 // src/core.ts
 var WeaverseItemStore = class extends EventEmitter {
+  /** The Core runtime that owns this item. */
   weaverse;
+  /** React ref for the element's rendered HTML node. */
   ref = (0, import_react.createRef)();
+  /** The current serialized state of the element. */
   _store = { id: "", type: "" };
+  /** Creates an item store and registers it with the owning runtime. */
   constructor(initialData, weaverse) {
     super();
     const { type, id } = initialData || {};
@@ -1554,53 +1563,77 @@ var WeaverseItemStore = class extends EventEmitter {
     }
     this._store.css = this.getDefaultCss();
   }
+  /** The element's unique identifier. */
   get _id() {
     return this._store.id;
   }
+  /** The element's current rendered HTML node, if mounted. */
   get _element() {
     return this.ref.current;
   }
+  /** The registered component definition for this element type. */
   get Element() {
     return this.weaverse.elementRegistry.get(this._store.type);
   }
+  /** Returns registered default styles merged with the element's saved styles. */
   getDefaultCss = () => {
     const defaultCss = this.Element?.defaultCss || {};
     const currentCss = this._store.css || {};
     return merge(defaultCss, currentCss);
   };
+  /**
+   * The element's current serialized data. Assigning a value merges it into
+   * the existing data.
+   */
   get data() {
     return this._store;
   }
+  // Setter behavior is documented on the getter, which owns the property's JSDoc.
   set data(update) {
     this._store = { ...this._store, ...update };
   }
+  /** Applies an element data update and notifies subscribers. */
   setData = (update) => {
     this.data = update;
     this.triggerUpdate();
     return this.data;
   };
+  /** Returns the element's current serialized data. */
   getSnapShot = () => this.data;
+  /** Notifies subscribers with the element's current data. */
   triggerUpdate = () => {
     this.emit(this._store);
   };
 };
 var Weaverse = class _Weaverse extends EventEmitter {
+  /** The DOM node containing the rendered project, if mounted. */
   contentRootElement = null;
+  /** Item stores keyed by element identifier. */
   static itemInstances = /* @__PURE__ */ new Map();
+  /** Base URL of the Weaverse Studio host. */
   weaverseHost = "https://studio.weaverse.io";
+  /** Version of the Weaverse runtime. */
   weaverseVersion = version;
+  /** Version of the installed Core SDK. */
   sdkVersion = version;
+  /** Identifier of the project being rendered. */
   projectId = "";
+  /** Whether the runtime is connected to Studio design mode. */
   isDesignMode = false;
+  /** Whether the runtime is rendering a preview. */
   isPreviewMode = false;
+  /** Optional bridge used to communicate with Weaverse Studio. */
   studioBridge;
+  /** Component definitions keyed by element type. */
   static elementRegistry = /* @__PURE__ */ new Map();
+  /** Media queries used for responsive element styles. */
   static mediaBreakPoints = {
     desktop: "all",
     // max-width need to subtract 0.02px to prevent bug
     // ref: https://getbootstrap.com/docs/5.1/layout/breakpoints/#max-width
     mobile: "(max-width: 767.98px)"
   };
+  /** Creates a Core runtime from serialized project data. */
   constructor(params) {
     super();
     for (const param of Object.entries(params)) {
@@ -1609,10 +1642,9 @@ var Weaverse = class _Weaverse extends EventEmitter {
     }
     this.initProject();
   }
+  /** Returns the project's current serialized data. */
   getSnapShot = () => this.data;
-  /**
-   * Create new `WeaverseItemStore` instance for each item in the project.
-   */
+  /** Creates or updates an item store for every serialized project item. */
   initProject = () => {
     const { data } = this;
     const itemInstances = _Weaverse.itemInstances;
@@ -1627,31 +1659,30 @@ var Weaverse = class _Weaverse extends EventEmitter {
       }
     }
   };
+  /** Item stores keyed by element identifier. */
   get itemInstances() {
     return _Weaverse.itemInstances;
   }
+  /** Creates an item store for serialized element data. */
   createItemInstance = (data) => new _Weaverse.ItemConstructor(data, this);
-  /**
-   * Register the custom React Component to Weaverse, store it into Weaverse.elementRegistry
-   */
+  /** Registers a component definition for an element type. */
   static registerElement = registerElement;
+  /** Component definitions keyed by element type. */
   get elementRegistry() {
     return _Weaverse.elementRegistry;
   }
+  /** Replaces the project data reference and notifies subscribers. */
   triggerUpdate = () => {
     this.data = { ...this.data };
     this.emit(this.data);
   };
+  /** Notifies subscribers of every registered item store. */
   refreshAllItems() {
     for (const item of _Weaverse.itemInstances.values()) {
       item.triggerUpdate();
     }
   }
-  /**
-   * Reset the project data and re-initialize all items.
-   * Used when we need to re-render the project with new data (like applying new template)
-   * @param data {WeaverseProjectDataType}
-   */
+  /** Replaces the project data and initializes its item stores. */
   setProjectData = (data) => {
     this.data = data;
     this.initProject();