feat: expose streamer objects

packages/core/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thatopen/components",
   "description": "Collection of core functionalities to author BIM apps.",
-  "version": "2.0.17",
+  "version": "2.0.18",
   "author": "That Open Company",
   "contributors": [
     "Antonio Gonzalez Viegas (https://github.com/agviegas)",

packages/core/src/core/Components/index.ts

@@ -14,7 +14,7 @@ export class Components implements Disposable {
   /**
    * The version of the @thatopen/components library.
    */
-  static readonly release = "2.0.14";
+  static readonly release = "2.0.18";
 
   /** {@link Disposable.onDisposed} */
   readonly onDisposed = new Event<void>();

packages/front/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@thatopen/components-front",
   "description": "Collection of frontend tools to author BIM apps.",
-  "version": "2.0.16",
+  "version": "2.0.17",
   "author": "That Open Company",
   "contributors": [
     "Antonio Gonzalez Viegas (https://github.com/agviegas)",

packages/front/src/fragments/IfcStreamer/index.ts

@@ -10,6 +10,8 @@ import {
   StreamLoaderSettings,
 } from "./src";
 
+export * from "./src";
+
 /**
  * The IfcStreamer component is responsible for managing and streaming tiled IFC data. It provides methods for loading, removing, and managing IFC models, as well as handling visibility and caching. 📕 [Tutorial](https://docs.thatopen.com/Tutorials/Components/Front/IfcStreamer). 📘 [API](https://docs.thatopen.com/api/@thatopen/components-front/classes/IfcStreamer).
  */

packages/front/src/fragments/IfcStreamer/src/streamer-db.ts

@@ -1,13 +1,29 @@
 import Dexie from "dexie";
 
+/**
+ * Interface representing a streamed file.
+ */
 interface IStreamedFile {
+  /**
+   * Unique identifier for the file.
+   */
   id: string;
+
+  /**
+   * The file content as a Uint8Array.
+   */
   file: Uint8Array;
 }
 
+/**
+ * A class representing a database for storing streamed files. It extends Dexie, a minimalistic wrapper for IndexedDB.
+ */
 export class StreamFileDatabase extends Dexie {
-  // Declare implicit table properties.
-  // (just to inform Typescript. Instantiated by Dexie in stores() method)
+  /**
+   * Declare implicit table properties.
+   * (Just to inform Typescript. Instantiated by Dexie in stores() method)
+   * @type {Dexie.Table<IStreamedFile, string>}
+   */
   files!: Dexie.Table<IStreamedFile, string>; // number = type of the primkey
 
   constructor() {

packages/front/src/fragments/IfcStreamer/src/types.ts

@@ -1,21 +1,66 @@
 import * as OBC from "@thatopen/components";
 
+/**
+ * Represents an instance of a streamed object.
+ */
 export interface StreamedInstance {
+  /**
+   * Unique identifier of the instance.
+   */
   id: number;
+
+  /**
+   * Color of the instance.
+   */
   color: number[];
+
+  /**
+   * Transformation matrix of the instance.
+   */
   transformation: number[];
 }
 
+/**
+ * A map of streamed instances, grouped by their unique identifier.
+ */
 export type StreamedInstances = Map<number, StreamedInstance[]>;
 
+/**
+ * Settings for the stream loader.
+ */
 export interface StreamLoaderSettings {
+  /**
+   * Array of streamed assets.
+   */
   assets: OBC.StreamedAsset[];
+
+  /**
+   * Streamed geometries.
+   */
   geometries: OBC.StreamedGeometries;
+
+  /**
+   * Identifier of the global data file.
+   */
   globalDataFileId: string;
 }
 
+/**
+ * Settings for the stream properties.
+ */
 export interface StreamPropertiesSettings {
+  /**
+   * Map of identifiers to numbers.
+   */
   ids: { [id: number]: number };
+
+  /**
+   * Map of types to arrays of numbers.
+   */
   types: { [type: number]: number[] };
+
+  /**
+   * Identifier of the indexes file.
+   */
   indexesFile: string;
 }