architwin 1.12.4 → 1.12.5

package/ONBOARDING.md

@@ -0,0 +1,115 @@
+# ArchiTwin Library Onboarding
+
+Welcome to the ArchiTwin library! This document provides an introduction to the codebase for new developers.
+
+## Introduction
+
+The ArchiTwin library is a powerful tool that enhances the Matterport Bundle SDK with additional features and a ready-to-use UI. It simplifies the development process by providing pre-built methods for interacting with the Matterport SDK, as well as the Zoom SDK. The library also includes custom Three.js loaders for Matterport, enabling advanced 3D object manipulation.
+
+The main goal of this library is to provide a comprehensive solution for developers working with the Matterport SDK, offering both a robust API and a user-friendly interface.
+
+## Getting Started
+
+To start working with the ArchiTwin library, you will need to have Node.js and npm installed on your machine. Once you have cloned the repository, you can install the dependencies by running the following command:
+
+```bash
+npm install
+```
+
+After the installation is complete, you can build the project by running:
+
+```bash
+npm run build
+```
+
+This will compile the TypeScript code and create the necessary JavaScript files in the `lib` directory.
+
+## Codebase Structure
+
+The ArchiTwin library is organized into the following directories:
+
+- **`bundle`**: Contains the Matterport Bundle SDK and other third-party libraries.
+- **`lib`**: Contains the compiled JavaScript code.
+- **`node_modules`**: Contains the project's dependencies.
+- **`src`**: Contains the TypeScript source code.
+- **`static`**: Contains static assets such as images and CSS files.
+
+### `src` Directory
+
+The `src` directory is where most of the development work takes place. It is further divided into the following subdirectories:
+
+- **`atwinui`**: Contains the UI components of the library.
+- **`loaders`**: Contains the custom Three.js loaders for Matterport.
+- **`math`**: Contains math-related utility functions.
+- **`meeting`**: Contains the Zoom SDK integration.
+
+## Development Guidelines
+
+To maintain a consistent code style and quality, please follow these guidelines when working on the ArchiTwin library:
+
+- **Coding Style**: Follow the existing coding style and patterns in the codebase.
+- **JSDoc Comments**: Write JSDoc comments for all new functions and methods.
+- **Type Checking**: Use TypeScript to ensure type safety.
+- **Linting**: Run the linter before committing your changes.
+
+## UI Development
+
+The UI components of the ArchiTwin library are located in the `src/atwinui` directory. When creating new UI components, please follow these guidelines:
+
+- **Component Structure**: Each UI component should be in its own directory, with a TypeScript file for the component's logic. Styles should be handled via CSS classes.
+- **Component Naming**: Use a consistent naming convention for your components.
+- **Component Registration**: Register your new components in the `initToolbarUI` function in `src/atwinui/index.ts`.
+- **CSS Styling**: Before creating new CSS classes, always check `static/atwinui.css` and `static/utility.css` to see if an existing class already serves your purpose. 
+- **CSS Variables**: Make use of the CSS variables defined in `static/atwinui.css` as much as possible to maintain a consistent look and feel across the UI. 
+- **Utility Classes**: For general-purpose styling, use the utility classes in `static/utility.css`. For component-specific styles, create new classes in `static/atwinui.css`.
+
+### Creating a New UI Component
+
+To create a new UI component, you can follow these steps:
+
+1.  Create a new directory for your component in `src/atwinui`.
+2.  Create a TypeScript file for your component's logic.
+3.  If needed, add new CSS classes to `static/atwinui.css` or `static/utility.css`, making sure to use existing CSS variables and classes as much as possible.
+4.  Register your new component in the `initToolbarUI` function in `src/atwinui/index.ts`.
+
+## Loaders
+
+The custom Three.js loaders for Matterport are located in the `src/loaders` directory. These loaders are responsible for loading and parsing 3D models and other assets.
+
+**Notice**: Before working on any of the files in the `loaders` directory, you must have a good understanding of Three.js.
+
+## Available Scripts
+
+The following scripts are available in the `package.json` file:
+
+- **`build`**: Builds the project.
+- **`deploy:package`**: Deploys the package (ONLY FOR PERSON RESPONSIBLE FOR PUBLISHING TO NPM).
+
+## Dependencies
+
+The ArchiTwin library uses the following dependencies:
+
+- **`@aws-sdk/client-s3`**: AWS SDK for S3 (no longer in use).
+- **`@mdi/font`**: Material Design Icons font.
+- **`@superviz/matterport-plugin`**: SuperViz Matterport plugin.
+- **`@superviz/sdk`**: SuperViz SDK (no longer in use, package abandoned by devs).
+- **`@zoom/videosdk`**: Zoom Video SDK.
+- **`axios`**: Promise-based HTTP client (library no longer makes application specific api calls and should never do so).
+- **`buffer`**: Buffer implementation for the browser.
+- **`date-fns`**: Modern JavaScript date utility library.
+- **`i18next`**: Internationalization framework.
+- **`i18next-browser-languagedetector`**: i18next language detector.
+- **`i18next-http-backend`**: i18next HTTP backend.
+- **`jsrsasign`**: JavaScript RSA signing library.
+- **`jsrsasign-util`**: Utility library for jsrsasign.
+- **`jszip`**: Library for creating, reading and editing .zip files.
+- **`jszip-utils`**: Utility functions for JSZip.
+- **`lit`**: Simple library for building fast, lightweight web components.
+- **`loglevel`**: Minimal lightweight logging for JavaScript.
+- **`merge-images`**: Merge images together.
+- **`notyf`**: A minimalistic, responsive, vanilla JavaScript library to show toast notifications.
+- **`pdfjs-dist`**: PDF.js is a Portable Document Format (PDF) viewer that is built with HTML5.
+- **`short-unique-id`**: A fast and simple library for generating short, unique IDs.
+- **`socket.io-client`**: Socket.IO client.
+- **`ts-loader`**: TypeScript loader for webpack.
+- **`tweakpane`**: A compact pane to tweak parameters and see results in real-time.

package/lib/architwin.d.ts

@@ -604,6 +604,7 @@ declare function renderTag(payload: {
 }, addTo_tags?: boolean, iframeId?: string): Promise<MpSdk.Tag.TagData>;
 declare function addTag(tagData: MpSdk.Tag.TagData): ITag;
 declare function getMpTags(): ITag[];
+declare function getTagDataCollection(): MpSdk.Dictionary<MpSdk.Tag.TagData>;
 declare function disposeTag(payload: {
     tagId: string;
 }): Promise<void>;
@@ -616,7 +617,7 @@ declare function disposeTags(iframeId?: string): Promise<void>;
 declare function attachTagMedia(payload: {
     tagId: string;
     attachments: string[];
-}): Promise<void>;
+}): Promise<string[]>;
 declare function detachTagMedia(payload: {
     tagId: string;
     attachmentIds: string[];
@@ -761,4 +762,4 @@ declare function setSpaceMetadata(payload: SpaceMetadata | null): void;
  * @returns
  */
 declare function getSpaceMetadata(): SpaceMetadata;
-export { _atwin, _config, _mpConfig, tags, sweeps, selectedObject, previousObjTransform, currentObjTransform, actionHistory, state, _tags, _tagCategories, _tagMessageRecepients, _space, _spaceId, _api, _pointerCoord, _3DXObjects, _meetingParticipants, _generatedObjectIds, tagColors, domMousePosition, isFitScreenOccupied, isCdnMapDataAvailable, minimap, _modelDetails, _onMouseClickInstance, transformHistory, _partitionNodes, initAtwinApi, getAtwinSdk, connectSpace, disconnectSpace, clearActionHistory, getSweeps, getCurrentSweep, getCurrentSweepPosition, moveToSweep, getNearbySweeps, getAllSweeps, getCurrentCameraPose, getCurrentCameraZoom, getCameraPosition, getCurrentFloor, moveInDirection, cameraLookAt, cameraPan, cameraRotate, cameraSetRotation, getViewMode, setViewMode, captureSpaceScreenshot, captureScreenshotAndCameraDetails, captureCurrentView, cameraZoomBy, cameraZoomReset, cameraZoomTo, getNearbyObjects, setTransformMode, setSelectedObject, clearSelectedObject, revertTransform, setTransformControls, removeTransformControls, setRenderDistance, addObject, getObject, addObjectToSpace, addMediaScreen, attachMediaScreenContent, updateObject, updateShowcaseObject, deleteObject, deleteShowcaseObject, copyObject, replaceObject, getTargetPosition, setObjectTransformation, setPointerCoordinates, addTextMarkupScreen, setTextMarkupScreenContent, goTo3dx, goToModel, hasTimeElapsed, getSelectedObject, renderAvatar, setSpaceAvatar, get3DXObjects, clear3DXObjects, setLibrary, getLibrary, disposeModel, disposeAllModels, renderInSpaceMediaScreen, goToPosition, goToParticipant, getNearestSweepFromObject, cancelModelPlacement, renderViewpointMarker, toggleViewpointVisibility, convertDegRotationToEuler, isToolbarFeatureEnabled, goToMPOrigin, pauseVideo, playVideo, setVideoPlayback, setAnimationState, showMinimap, hideMinimap, getMapConfig, addTag, getTags, gotoTag, renderTag, disposeTag, disposeTags, getMpTags, getMpTag, showTags, attachTagMedia, detachTagMedia, moveTag, editTagLabel, editTagDescription, editTagStem, editTagIcon, editTagColor, saveTag, rotateCameraToObject, setModelVisibility, tagStateSubscriber, setTagIcon, setTagCategories, setUserAssignedCategories, getUserAssignedCategories, setTagMessageRecepients, getTagMessageRecepients, setTagMessages, getTagMessages, setSelectedTagUuid, getSelectedTagUuid, setCurrentSpace, toggleFitToScreen, getFloors, getLabels, renderMeetingSidebar, createMeetingTemplate, joinMeetingTemplate, meet, dispatchSpaceEvent, subscribeSpaceEvent, unsubscribeSpaceEvent, registerCustomSpaceEvent, clearSpaceEventQueue, initSocketIo, socketEmit, getParticipants, followParticipant, unFollowParticipant, enableHUD, disableHUD, getMediaScreenHUDs, canSetHud, saveMediaScreenHud, removeMediaScreenHud, enableFitScreen, disableFitScreen, initToolbarUI, themeManager, convertToEuler, disableSweeps, enableSweep, disableSweep, tubeLineType, _sceneObject, _tubes, drawPath, toggleSpaceNavigation, startDraw, exitDraw, cancelDraw, setPolygonPath, setTubeLinePath, getCurrentTubeLine, renderPolygon, toggleWallVisibility, toggleMeshChildrenVisibility, toggleFloorVisibility, getChildrenOfModel, toggleVerticeRingVisibility, setPolygonFloorOffset, getPolygonFloorOffset, setFloorBaseHeight, clearFloorBaseHeight, enableVerticeControls, deleteEdge, disposePathLine, getFloorBaseHeight, setMeshChildrenMaterialProperty, undoDrawAction, redoDrawAction, addUndoDrawActions, setWallBaseHeight, getWallBaseHeight, clearWallBaseHeight, setSpacePartitionNodes, setCurrentPolygon, getSpaceId, getCurrentPolygon, getPathBetweenSweeps, moveAlongPath, _atwinConnections, convertZupToYup, convertYupToZup, getRelativePosition, getOriginalWorldPosition, setSpaceMetadata, getSpaceMetadata, getAssetUrl };
+export { _atwin, _config, _mpConfig, tags, sweeps, selectedObject, previousObjTransform, currentObjTransform, actionHistory, state, _tags, _tagCategories, _tagMessageRecepients, _space, _spaceId, _api, _pointerCoord, _3DXObjects, _meetingParticipants, _generatedObjectIds, tagColors, domMousePosition, isFitScreenOccupied, isCdnMapDataAvailable, minimap, _modelDetails, _onMouseClickInstance, transformHistory, _partitionNodes, initAtwinApi, getAtwinSdk, connectSpace, disconnectSpace, clearActionHistory, getSweeps, getCurrentSweep, getCurrentSweepPosition, moveToSweep, getNearbySweeps, getAllSweeps, getCurrentCameraPose, getCurrentCameraZoom, getCameraPosition, getCurrentFloor, moveInDirection, cameraLookAt, cameraPan, cameraRotate, cameraSetRotation, getViewMode, setViewMode, captureSpaceScreenshot, captureScreenshotAndCameraDetails, captureCurrentView, cameraZoomBy, cameraZoomReset, cameraZoomTo, getNearbyObjects, setTransformMode, setSelectedObject, clearSelectedObject, revertTransform, setTransformControls, removeTransformControls, setRenderDistance, addObject, getObject, addObjectToSpace, addMediaScreen, attachMediaScreenContent, updateObject, updateShowcaseObject, deleteObject, deleteShowcaseObject, copyObject, replaceObject, getTargetPosition, setObjectTransformation, setPointerCoordinates, addTextMarkupScreen, setTextMarkupScreenContent, goTo3dx, goToModel, hasTimeElapsed, getSelectedObject, renderAvatar, setSpaceAvatar, get3DXObjects, clear3DXObjects, setLibrary, getLibrary, disposeModel, disposeAllModels, renderInSpaceMediaScreen, goToPosition, goToParticipant, getNearestSweepFromObject, cancelModelPlacement, renderViewpointMarker, toggleViewpointVisibility, convertDegRotationToEuler, isToolbarFeatureEnabled, goToMPOrigin, pauseVideo, playVideo, setVideoPlayback, setAnimationState, showMinimap, hideMinimap, getMapConfig, addTag, getTags, gotoTag, renderTag, disposeTag, disposeTags, getMpTags, getTagDataCollection, getMpTag, showTags, attachTagMedia, detachTagMedia, moveTag, editTagLabel, editTagDescription, editTagStem, editTagIcon, editTagColor, saveTag, rotateCameraToObject, setModelVisibility, tagStateSubscriber, setTagIcon, setTagCategories, setUserAssignedCategories, getUserAssignedCategories, setTagMessageRecepients, getTagMessageRecepients, setTagMessages, getTagMessages, setSelectedTagUuid, getSelectedTagUuid, setCurrentSpace, toggleFitToScreen, getFloors, getLabels, renderMeetingSidebar, createMeetingTemplate, joinMeetingTemplate, meet, dispatchSpaceEvent, subscribeSpaceEvent, unsubscribeSpaceEvent, registerCustomSpaceEvent, clearSpaceEventQueue, initSocketIo, socketEmit, getParticipants, followParticipant, unFollowParticipant, enableHUD, disableHUD, getMediaScreenHUDs, canSetHud, saveMediaScreenHud, removeMediaScreenHud, enableFitScreen, disableFitScreen, initToolbarUI, themeManager, convertToEuler, disableSweeps, enableSweep, disableSweep, tubeLineType, _sceneObject, _tubes, drawPath, toggleSpaceNavigation, startDraw, exitDraw, cancelDraw, setPolygonPath, setTubeLinePath, getCurrentTubeLine, renderPolygon, toggleWallVisibility, toggleMeshChildrenVisibility, toggleFloorVisibility, getChildrenOfModel, toggleVerticeRingVisibility, setPolygonFloorOffset, getPolygonFloorOffset, setFloorBaseHeight, clearFloorBaseHeight, enableVerticeControls, deleteEdge, disposePathLine, getFloorBaseHeight, setMeshChildrenMaterialProperty, undoDrawAction, redoDrawAction, addUndoDrawActions, setWallBaseHeight, getWallBaseHeight, clearWallBaseHeight, setSpacePartitionNodes, setCurrentPolygon, getSpaceId, getCurrentPolygon, getPathBetweenSweeps, moveAlongPath, _atwinConnections, convertZupToYup, convertYupToZup, getRelativePosition, getOriginalWorldPosition, setSpaceMetadata, getSpaceMetadata, getAssetUrl };