@thatopen/components 3.4.1 → 3.4.2

package/dist/index.cjs

@@ -7484,6 +7484,20 @@ const _FragmentsManager = class _FragmentsManager extends Component {
     __publicField(this, "_core");
     this.components.add(_FragmentsManager.uuid, this);
   }
+  /**
+   * Returns a blob URL for the fragments worker matching the installed
+   * `@thatopen/fragments` version. Delegates to {@link FRAGS.FragmentsModels.getWorker}.
+   * This is the recommended way to obtain the URL passed to {@link FragmentsManager.init}.
+   *
+   * @example
+   * ```ts
+   * const fragments = components.get(OBC.FragmentsManager);
+   * fragments.init(await OBC.FragmentsManager.getWorker());
+   * ```
+   */
+  static getWorker() {
+    return FRAGS.FragmentsModels.getWorker();
+  }
   get initialized() {
     return !!this._core;
   }
@@ -7515,6 +7529,13 @@ const _FragmentsManager = class _FragmentsManager extends Component {
     this.onDisposed.trigger();
     this.onDisposed.reset();
   }
+  /**
+   * Initializes the fragments core with the given worker URL.
+   * The recommended way to obtain the URL is {@link FragmentsManager.getWorker}:
+   * ```ts
+   * fragments.init(await OBC.FragmentsManager.getWorker());
+   * ```
+   */
   init(workerURL, options) {
     this._core = new FRAGS.FragmentsModels(workerURL, options);
     this.core.onModelLoaded.add(async () => {

package/dist/index.d.ts

@@ -3125,9 +3125,21 @@ export declare class FirstPersonMode implements NavigationMode {
 export declare function formatSlope(slope: number, format: SlopeFormat): string;
 
 /**
- * Component to load, delete and manage [fragments](https://github.com/ThatOpen/engine_fragment) efficiently. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/FragmentsManager). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/FragmentsManager).
+ * Component to load, delete and manage [fragments](https://github.com/ThatOpen/engine_fragment) efficiently. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Core/FragmentsManager). 📘 [API](https://docs.thatopen.com/api/@thatopen/components/classes/FragmentsManager). Before calling {@link FragmentsManager.init}, you need a URL for the fragments worker. The recommended way to get it is {@link FragmentsManager.getWorker}, which fetches the version-matched worker from unpkg.
  */
 export declare class FragmentsManager extends Component implements Disposable_2 {
+    /**
+     * Returns a blob URL for the fragments worker matching the installed
+     * `@thatopen/fragments` version. Delegates to {@link FRAGS.FragmentsModels.getWorker}.
+     * This is the recommended way to obtain the URL passed to {@link FragmentsManager.init}.
+     *
+     * @example
+     * ```ts
+     * const fragments = components.get(OBC.FragmentsManager);
+     * fragments.init(await OBC.FragmentsManager.getWorker());
+     * ```
+     */
+    static getWorker(): Promise<string>;
     /**
      * A unique identifier for the component.
      * This UUID is used to register the component within the Components system.
@@ -3156,6 +3168,13 @@ export declare class FragmentsManager extends Component implements Disposable_2
     constructor(components: Components);
     /** {@link Disposable.dispose} */
     dispose(): void;
+    /**
+     * Initializes the fragments core with the given worker URL.
+     * The recommended way to obtain the URL is {@link FragmentsManager.getWorker}:
+     * ```ts
+     * fragments.init(await OBC.FragmentsManager.getWorker());
+     * ```
+     */
     init(workerURL: string, options?: {
         classicWorker?: boolean;
     }): void;