@cognite/reveal 4.2.0-dev.20230410 → 4.2.0-dev.20230412

package/dist/packages/360-images/index.d.ts

@@ -2,10 +2,12 @@
  * Copyright 2022 Cognite AS
  */
 export { Image360 } from './src/entity/Image360';
+export { Image360Revision } from './src/entity/Image360Revision';
 export { Image360Collection } from './src/collection/Image360Collection';
 export { Image360Facade } from './src/Image360Facade';
 export { Image360CollectionFactory } from './src/collection/Image360CollectionFactory';
 export { Image360Entity } from './src/entity/Image360Entity';
+export { Image360RevisionEntity } from './src/entity/Image360RevisionEntity';
 export { Image360Visualization } from './src/entity/Image360Visualization';
 export { Image360EnteredDelegate, Image360ExitedDelegate } from './src/types';
 export { DefaultImage360Collection } from './src/collection/DefaultImage360Collection';

package/dist/packages/360-images/src/Image360Facade.d.ts

@@ -6,6 +6,7 @@ import { Image360Entity } from './entity/Image360Entity';
 import { Image360CollectionFactory } from './collection/Image360CollectionFactory';
 import { DefaultImage360Collection } from './collection/DefaultImage360Collection';
 import { IconCullingScheme } from './icons/IconCollection';
+import { Image360RevisionEntity } from './entity/Image360RevisionEntity';
 export declare class Image360Facade<T> {
     private readonly _entityFactory;
     private readonly _image360Collections;
@@ -18,7 +19,7 @@ export declare class Image360Facade<T> {
     constructor(_entityFactory: Image360CollectionFactory<T>);
     create(dataProviderFilter: T, postTransform?: THREE.Matrix4, preComputedRotation?: boolean): Promise<DefaultImage360Collection>;
     delete(entity: Image360Entity): Promise<void>;
-    preload(entity: Image360Entity, lockDownload?: boolean): Promise<void>;
+    preload(entity: Image360Entity, revision: Image360RevisionEntity, lockDownload?: boolean): Promise<void>;
     getCollectionContainingEntity(entity: Image360Entity): DefaultImage360Collection;
     intersect(coords: THREE.Vector2, camera: THREE.Camera): Image360Entity | undefined;
     dispose(): void;

package/dist/packages/360-images/src/cache/Image360LoadingCache.d.ts

@@ -2,14 +2,17 @@
  * Copyright 2022 Cognite AS
  */
 import { Image360Entity } from '../entity/Image360Entity';
+import { Image360RevisionEntity } from '../entity/Image360RevisionEntity';
 export type DownloadRequest = {
     entity: Image360Entity;
+    revision: Image360RevisionEntity;
     firstCompleted: Promise<void>;
     fullResolutionCompleted: Promise<void>;
     abort: () => void;
 };
 export type Loaded360Image = {
     entity: Image360Entity;
+    revision: Image360RevisionEntity;
     isFullResolution: boolean;
 };
 export declare class Image360LoadingCache {
@@ -18,13 +21,14 @@ export declare class Image360LoadingCache {
     private readonly _loaded360Images;
     private readonly _inProgressDownloads;
     private _lockedDownload;
-    get cachedEntities(): Image360Entity[];
+    get cachedRevisions(): Image360RevisionEntity[];
     get currentlyLoadingEntities(): DownloadRequest[];
-    getDownloadInProgress(entity: Image360Entity): DownloadRequest | undefined;
+    getDownloadInProgress(revision: Image360RevisionEntity): DownloadRequest | undefined;
     constructor(_imageCacheSize?: number, _downloadCacheSize?: number);
-    cachedPreload(entity: Image360Entity, lockDownload?: boolean): Promise<void>;
+    cachedPreload(entity: Image360Entity, revision: Image360RevisionEntity, lockDownload?: boolean): Promise<void>;
     purge(entity: Image360Entity): Promise<void>;
-    private addEntityToCache;
-    private abortLastRecentlyReqestedEntity;
+    private addRevisionToCache;
+    private abortLastRecentlyReqestedRevision;
     private createAbortSignal;
+    private isRevisionVisible;
 }

package/dist/packages/360-images/src/collection/DefaultImage360Collection.d.ts

@@ -15,9 +15,18 @@ export declare class DefaultImage360Collection implements Image360Collection {
      * A list containing all the 360 images in this set.
      */
     readonly image360Entities: Image360Entity[];
+    /**
+     * If defined, any subsequently entered 360 images will load the revision that are closest to the target date.
+     * If undefined, the most recent revision will be loaded.
+     */
+    private _targetRevisionDate;
     private readonly _events;
     private readonly _icons;
     private _isCollectionVisible;
+    private readonly _collectionId;
+    get id(): string;
+    get targetRevisionDate(): Date | undefined;
+    set targetRevisionDate(date: Date | undefined);
     /**
      * The events from the image collection.
      */
@@ -26,7 +35,7 @@ export declare class DefaultImage360Collection implements Image360Collection {
         image360Exited: EventTrigger<Image360ExitedDelegate>;
     };
     get isCollectionVisible(): boolean;
-    constructor(entities: Image360Entity[], icons: IconCollection);
+    constructor(collectionId: string, entities: Image360Entity[], icons: IconCollection);
     /**
      * Subscribes to events on 360 Image datasets. There are several event types:
      * 'image360Entered' - Subscribes to a event for entering 360 image mode.

package/dist/packages/360-images/src/collection/Image360Collection.d.ts

@@ -11,6 +11,11 @@ export interface Image360Collection {
      * A list containing all the 360 images in this set.
      */
     readonly image360Entities: Image360[];
+    /**
+     * If defined, any subsequently entered 360 images will load the revision that are closest to the target date.
+     * If undefined, the most recent revision will be loaded.
+     */
+    targetRevisionDate: Date | undefined;
     /**
      * Specify parameters used to determine the number of icons that are visible when entering 360 Images.
      * @param radius Only icons within the given radius will be made visible.

package/dist/packages/360-images/src/entity/Image360.d.ts

@@ -1,6 +1,7 @@
 /*!
  * Copyright 2022 Cognite AS
  */
+import { Image360Revision } from './Image360Revision';
 import { Image360Visualization } from './Image360Visualization';
 export interface Image360 {
     /**
@@ -14,4 +15,14 @@ export interface Image360 {
      * @returns Image360Visualization
      */
     readonly image360Visualization: Image360Visualization;
+    /**
+     * List all historical images for this entity.
+     * @returns A list of available revisions.
+     */
+    getRevisions(): Image360Revision[];
+    /**
+     * Get the revision that is currently loaded for this entry.
+     * @returns The active revision.
+     */
+    getActiveRevision(): Image360Revision;
 }

package/dist/packages/360-images/src/entity/Image360Entity.d.ts

@@ -1,19 +1,19 @@
 /*!
  * Copyright 2022 Cognite AS
  */
-import * as THREE from 'three';
 import { SceneHandler } from '../../../utilities';
-import { Image360Descriptor, Image360FileProvider } from '../../../data-providers';
+import { Image360FileProvider } from '../../../data-providers';
 import { Image360Icon } from '../icons/Image360Icon';
-import { Image360VisualizationBox } from './Image360VisualizationBox';
 import { Image360 } from './Image360';
+import { Historical360ImageSet } from '../../../data-providers/src/types';
+import { Image360RevisionEntity } from './Image360RevisionEntity';
+import { Image360VisualizationBox } from './Image360VisualizationBox';
 export declare class Image360Entity implements Image360 {
-    private readonly _imageProvider;
-    private readonly _image360Metadata;
+    private readonly _revisions;
     private readonly _transform;
     private readonly _image360Icon;
     private readonly _image360VisualzationBox;
-    private _getFullResolutionTextures;
+    private _activeRevision;
     /**
      * Get a copy of the model-to-world transformation matrix
      * of the given 360 image.
@@ -31,31 +31,28 @@ export declare class Image360Entity implements Image360 {
      * @returns Image360Visualization
      */
     get image360Visualization(): Image360VisualizationBox;
-    constructor(image360Metadata: Image360Descriptor, sceneHandler: SceneHandler, imageProvider: Image360FileProvider, transform: THREE.Matrix4, icon: Image360Icon);
+    constructor(image360Metadata: Historical360ImageSet, sceneHandler: SceneHandler, imageProvider: Image360FileProvider, transform: THREE.Matrix4, icon: Image360Icon);
+    /**
+     * List all historical images for this entity.
+     * @returns A list of available revisions.
+     */
+    getRevisions(): Image360RevisionEntity[];
     /**
-     * Loads the 360 image (6 faces) into the visualization object.
-     *
-     * This will start the download of both low and full resolution images and return one promise for when the first image set is ready
-     * and one promise for when both downloads are completed. If the low resolution images are completed first the full resolution
-     * download and texture loading will continue in the background, and applyFullResolution can be used to apply full resolution textures
-     * to the image360VisualzationBox at a desired time.
-     *
-     * @returns firstCompleted A promise for when the first set om images has been loaded and applied to the image360VisualzationBox.
-     * @returns fullResolutionCompleted A promise for when full resolution images are done loading.
+     * Get the revision that is currently loaded for this entry.
+     * @returns Returns the active revision.
      */
-    load360Image(abortSignal?: AbortSignal): {
-        firstCompleted: Promise<void>;
-        fullResolutionCompleted: Promise<void>;
-    };
+    getActiveRevision(): Image360RevisionEntity;
+    setActiveRevision(revision: Image360RevisionEntity): void;
+    getMostRecentRevision(): Image360RevisionEntity;
     /**
-     * Apply full resolution textures to the image360VisualzationBox. This has no effect if full resolution has already been applied.
+     * Get the revision closest to the provided date.
+     * If all revisions are undated the first available revison is returned.
      */
-    applyFullResolution(): Promise<void>;
+    getRevisionClosestToDate(date: Date): Image360RevisionEntity;
     /**
      * Drops the GPU resources for the 360 image
-     * the icon will be preserved.
      */
-    unload360Image(): void;
+    unloadImage(): void;
     /**
      * @obvious
      */

package/dist/packages/360-images/src/entity/Image360Revision.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+/**
+ * Interface used to manage historical revisions of {@link Image360}.
+ * One instance represents one specific image revision.
+ */
+export interface Image360Revision {
+    /**
+     * The date of this revision. Undefined if the revison is undated.
+     * @returns Date | undefined
+     */
+    readonly date: Date | undefined;
+}

package/dist/packages/360-images/src/entity/Image360RevisionEntity.d.ts

@@ -0,0 +1,46 @@
+/*!
+ * Copyright 2022 Cognite AS
+ */
+import { Image360Descriptor, Image360FileProvider } from '../../../data-providers';
+import { Image360Revision } from './Image360Revision';
+import { Image360VisualizationBox } from './Image360VisualizationBox';
+export declare class Image360RevisionEntity implements Image360Revision {
+    private readonly _imageProvider;
+    private readonly _image360Descriptor;
+    private readonly _image360VisualzationBox;
+    private _textures;
+    private _getFullResolutionTextures;
+    constructor(imageProvider: Image360FileProvider, image360Descriptor: Image360Descriptor, image360VisualzationBox: Image360VisualizationBox);
+    /**
+     * The date of this revision. Undefined if the revison is undated.
+     * @returns Date | undefined
+     */
+    get date(): Date | undefined;
+    /**
+     * Loads the textures needed for the 360 image (6 faces).
+     *
+     * This will start the download of both low and full resolution textures and return one promise for when the first image set is ready
+     * and one promise for when both downloads are completed. If the low resolution images are completed first the full resolution
+     * download and texture loading will continue in the background, and applyFullResolution can be used to apply full resolution textures
+     * to the image360VisualzationBox at a desired time.
+     *
+     * @returns firstCompleted A promise for when the first set of textures has been loaded.
+     * @returns fullResolutionCompleted A promise for when full resolution images are done loading.
+     */
+    loadTextures(abortSignal?: AbortSignal): {
+        firstCompleted: Promise<void>;
+        fullResolutionCompleted: Promise<void>;
+    };
+    /**
+     * Clear the cached textures used by this revision.
+     */
+    clearTextures(): void;
+    /**
+     * Apply cached textures to the image360VisualzationBox.
+     */
+    applyTextures(): void;
+    /**
+     * Apply full resolution textures to the image360VisualzationBox. This has no effect if full resolution has already been applied.
+     */
+    applyFullResolutionTextures(): Promise<void>;
+}

package/dist/packages/360-images/src/entity/Image360VisualizationBox.d.ts

@@ -20,7 +20,7 @@ export declare class Image360VisualizationBox implements Image360Visualization {
     set scale(newScale: THREE.Vector3);
     set renderOrder(newRenderOrder: number);
     constructor(worldTransform: THREE.Matrix4, sceneHandler: SceneHandler);
-    loadImages(textures: Image360Texture[]): Promise<void>;
+    loadImages(textures: Image360Texture[]): void;
     loadFaceTextures(faces: Image360Face[]): Promise<Image360Texture[]>;
     unloadImages(): void;
 }

package/dist/packages/api/src/api-helpers/Image360ApiHelper.d.ts

@@ -2,8 +2,8 @@
  * Copyright 2022 Cognite AS
  */
 import * as THREE from 'three';
-import { CogniteClient } from '@cognite/sdk';
-import { Image360Collection, Image360Entity, Image360 } from '../../../360-images';
+import { CogniteClient, Metadata } from '@cognite/sdk';
+import { Image360Collection, Image360Entity, Image360, Image360RevisionEntity } from '../../../360-images';
 import { BeforeSceneRenderedDelegate, EventTrigger, InputHandler, SceneHandler } from '../../../utilities';
 import { ProxyCameraManager } from '../../../camera-manager';
 export declare class Image360ApiHelper {
@@ -19,17 +19,16 @@ export declare class Image360ApiHelper {
     private readonly _onBeforeSceneRenderedEvent;
     private _cachedCameraManager;
     constructor(cogniteClient: CogniteClient, sceneHandler: SceneHandler, domElement: HTMLElement, activeCameraManager: ProxyCameraManager, inputHandler: InputHandler, requestRedraw: () => void, onBeforeSceneRendered: EventTrigger<BeforeSceneRenderedDelegate>);
-    add360ImageSet(eventFilter: {
-        [key: string]: string;
-    }, collectionTransform: THREE.Matrix4, preMultipliedRotation: boolean): Promise<Image360Collection>;
+    add360ImageSet(eventFilter: Metadata, collectionTransform: THREE.Matrix4, preMultipliedRotation: boolean): Promise<Image360Collection>;
     remove360Images(entities: Image360[]): Promise<void>;
-    enter360Image(image360Entity: Image360Entity): Promise<void>;
+    enter360Image(image360Entity: Image360Entity, revision?: Image360RevisionEntity): Promise<void>;
     private transition;
     private tweenVisualizationAlpha;
     private tweenVisualizationZoom;
     private set360CameraManager;
     exit360Image(): void;
     dispose(): void;
+    private findRevisionIdToEnter;
     private enter360ImageOnIntersect;
     intersect360ImageIcons(offsetX: number, offsetY: number): Image360Entity | undefined;
     private setHoverIconOnIntersect;

package/dist/packages/api/src/public/migration/Cognite3DViewer.d.ts

@@ -10,7 +10,7 @@ import { CogniteModel } from '../types';
 import { ViewerState } from '../../utilities/ViewStateHelper';
 import { CameraManager, CameraChangeDelegate, CameraStopDelegate } from '../../../../camera-manager';
 import { SupportedModelTypes } from '../../../../model-base';
-import { Image360Collection, Image360 } from '../../../../360-images';
+import { Image360Collection, Image360, Image360Revision } from '../../../../360-images';
 /**
  * @example
  * ```js
@@ -284,9 +284,10 @@ export declare class Cognite3DViewer {
     remove360Images(...image360Entities: Image360[]): Promise<void>;
     /**
      * Enter visualization of a 360 image.
-     * @param image360
+     * @param image360 The 360 image to enter.
+     * @param revision The image revision to use. If not provided the newest revision will be shown.
      */
-    enter360Image(image360: Image360): Promise<void>;
+    enter360Image(image360: Image360, revision?: Image360Revision): Promise<void>;
     /**
      * Exit visualization of the 360 image.
      */

package/dist/packages/data-providers/src/image-360-data-providers/Cdf360ImageEventProvider.d.ts

@@ -2,12 +2,12 @@
  * Copyright 2022 Cognite AS
  */
 import { CogniteClient, Metadata } from '@cognite/sdk';
-import { Image360Descriptor, Image360Face, Image360FileDescriptor } from '../types';
+import { Historical360ImageSet, Image360Face, Image360FileDescriptor } from '../types';
 import { Image360Provider } from '../Image360Provider';
 export declare class Cdf360ImageEventProvider implements Image360Provider<Metadata> {
     private readonly _client;
     constructor(client: CogniteClient);
-    get360ImageDescriptors(metadataFilter: Metadata, preMultipliedRotation: boolean): Promise<Image360Descriptor[]>;
+    get360ImageDescriptors(metadataFilter: Metadata, preMultipliedRotation: boolean): Promise<Historical360ImageSet[]>;
     get360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
     getLowResolution360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
     private getFileIds;
@@ -15,7 +15,7 @@ export declare class Cdf360ImageEventProvider implements Image360Provider<Metada
     private mergeDescriptors;
     private listEvents;
     private listFiles;
-    private getNewestFileInfoSet;
+    private sortFileInfoSetByNewest;
     private getFileBuffers;
     getIconBuffers(fileIds: {
         id: number;

package/dist/packages/data-providers/src/image-360-data-providers/Local360ImageProvider.d.ts

@@ -1,9 +1,9 @@
 import { Image360Provider } from '../Image360Provider';
-import { Image360Descriptor, Image360Face, Image360FileDescriptor } from '../types';
+import { Historical360ImageSet, Image360Face, Image360FileDescriptor } from '../types';
 export declare class Local360ImageProvider implements Image360Provider<unknown> {
     private readonly _modelUrl;
     constructor(modelUrl: string);
-    get360ImageDescriptors(): Promise<Image360Descriptor[]>;
+    get360ImageDescriptors(): Promise<Historical360ImageSet[]>;
     get360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
     getLowResolution360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
 }

package/dist/packages/data-providers/src/types.d.ts

@@ -9,13 +9,17 @@ export interface BinaryFileProvider {
     getBinaryFile(baseUrl: string, fileName: string, abortSignal?: AbortSignal): Promise<ArrayBuffer>;
 }
 export interface Image360DescriptorProvider<T> {
-    get360ImageDescriptors(metadataFilter: T, preMultipliedRotation: boolean): Promise<Image360Descriptor[]>;
+    get360ImageDescriptors(metadataFilter: T, preMultipliedRotation: boolean): Promise<Historical360ImageSet[]>;
 }
 export interface Image360FileProvider {
     get360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
     getLowResolution360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
 }
-export type Image360Descriptor = Image360EventDescriptor & {
+export type Historical360ImageSet = Image360EventDescriptor & {
+    imageRevisions: Image360Descriptor[];
+};
+export type Image360Descriptor = {
+    timestamp?: number;
     faceDescriptors: Image360FileDescriptor[];
 };
 export type Image360EventDescriptor = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.2.0-dev.20230410",
+  "version": "4.2.0-dev.20230412",
   "description": "WebGL based 3D viewer for CAD and point clouds processed in Cognite Data Fusion.",
   "homepage": "https://github.com/cognitedata/reveal/tree/master/viewer",
   "repository": {
@@ -78,7 +78,7 @@
     "three-stdlib": "2.21.8"
   },
   "devDependencies": {
-    "@azure/msal-browser": "2.34.0",
+    "@azure/msal-browser": "2.35.0",
     "@cognite/sdk": "8.0.0",
     "@microsoft/api-extractor": "^7.33.6",
     "@types/dat.gui": "0.7.9",
@@ -96,12 +96,12 @@
     "@types/stats": "0.16.30",
     "@types/three": "0.150.0",
     "@types/tween.js": "18.5.1",
-    "@typescript-eslint/eslint-plugin": "5.57.0",
-    "@typescript-eslint/parser": "5.57.0",
-    "concurrently": "7.6.0",
+    "@typescript-eslint/eslint-plugin": "5.57.1",
+    "@typescript-eslint/parser": "5.57.1",
+    "concurrently": "8.0.1",
     "cross-env": "7.0.3",
     "dat.gui": "0.7.9",
-    "eslint": "8.37.0",
+    "eslint": "8.38.0",
     "eslint-config-prettier": "8.8.0",
     "eslint-plugin-header": "3.1.1",
     "eslint-plugin-jsdoc": "40.1.1",
@@ -110,7 +110,7 @@
     "eslint-plugin-unused-imports": "2.0.0",
     "file-loader": "6.2.0",
     "gl": "6.0.2",
-    "glob": "9.3.2",
+    "glob": "9.3.4",
     "glslify-loader": "2.0.0",
     "html-webpack-plugin": "5.5.0",
     "jest": "29.5.0",
@@ -132,12 +132,12 @@
     "shx": "0.3.4",
     "stats.js": "0.17.0",
     "three": "0.150.1",
-    "ts-jest": "29.0.5",
+    "ts-jest": "29.1.0",
     "ts-loader": "9.4.2",
     "tsc-alias": "1.8.5",
-    "typescript": "5.0.3",
+    "typescript": "5.0.4",
     "wasm-pack": "0.10.3",
-    "webpack": "5.77.0",
+    "webpack": "5.78.0",
     "webpack-cli": "5.0.1",
     "webpack-dev-server": "4.13.2",
     "webpack-node-externals": "3.0.0",