@cognite/reveal 4.22.0-dev.20250117 → 4.22.0-dev.20250121

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,7 +7,7 @@ import { Image360Entity } from '../entity/Image360Entity';
7
7
  import { Image360EnteredDelegate, Image360ExitedDelegate } from '../types';
8
8
  import { IconCollection, IconCullingScheme } from '../icons/IconCollection';
9
9
  import { Image360AnnotationAppearance } from '../annotation/types';
10
- import { DataSourceType, Image360FileDescriptor, Image360Provider } from '../../../data-providers';
10
+ import { ClassicDataSourceType, DataSourceType, DMDataSourceType, Image360FileDescriptor, Image360Provider } from '../../../data-providers';
11
11
  import { Image360AnnotationFilter } from '../annotation/Image360AnnotationFilter';
12
12
  import { Matrix4 } from 'three';
13
13
  import { InstanceReference } from '../../../data-providers/src/types';
@@ -95,6 +95,8 @@ export declare class DefaultImage360Collection<T extends DataSourceType> impleme
95
95
  setDefaultAnnotationStyle(defaultStyle: Image360AnnotationAppearance): void;
96
96
  findImageAnnotations(filter: Image360AnnotationAssetFilter<T>): Promise<Image360AnnotationAssetQueryResult<T>[]>;
97
97
  getAssetIds(): Promise<InstanceReference<T>[]>;
98
- getAnnotationsInfo(): Promise<AssetAnnotationImage360Info<T>[]>;
98
+ getAnnotationsInfo(source: 'assets'): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>;
99
+ getAnnotationsInfo(source: 'cdm'): Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>;
100
+ getAnnotationsInfo(source: 'all'): Promise<AssetAnnotationImage360Info<DataSourceType>[]>;
99
101
  getAllFileDescriptors(): Image360FileDescriptor[];
100
102
  }
@@ -7,9 +7,9 @@ import { Image360AnnotationAppearance } from '../annotation/types';
7
7
  import { Image360Revision } from '../entity/Image360Revision';
8
8
  import { IdEither } from '@cognite/sdk';
9
9
  import { Image360Annotation } from '../annotation/Image360Annotation';
10
- import { ClassicDataSourceType, DataSourceType } from '../../../data-providers';
10
+ import { ClassicDataSourceType, DataSourceType, DMDataSourceType } from '../../../data-providers';
11
11
  import { Matrix4 } from 'three';
12
- import { ImageAssetLinkAnnotationInfo, InstanceReference } from '../../../data-providers/src/types';
12
+ import { ImageAssetLinkAnnotationInfo, InstanceReference } from '../../../data-providers';
13
13
  /**
14
14
  * Annotation type that may be linked to assets. Only relevant for classic annotations, where some
15
15
  * annotation types are visible in Reveal, but not linkable to assets
@@ -171,10 +171,22 @@ export interface Image360Collection<T extends DataSourceType = ClassicDataSource
171
171
  */
172
172
  getAssetIds(): Promise<IdEither[]>;
173
173
  /**
174
- * Get IDs of all CDF assets and related image/revision associated with this
175
- * 360 image collection through CDF annotations
174
+ * Fetches annotations from all available sources
175
+ */
176
+ getAnnotationsInfo(source: 'all'): Promise<AssetAnnotationImage360Info<DataSourceType>[]>;
177
+ /**
178
+ * Fetches annotations from the CDF Annotation APIs, which are linked to CDF assets
179
+ */
180
+ getAnnotationsInfo(source: 'assets'): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>;
181
+ /**
182
+ * Fetches annotations from the CDF Core Data Model
183
+ */
184
+ getAnnotationsInfo(source: 'cdm'): Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>;
185
+ /**
186
+ * Get info of assets and annotations associated with this
187
+ * 360 image collection through various sources
176
188
  *
177
- * @param source What source data to pull the annotation info from
189
+ * @param source What source data to pull the annotation info from. Must be `'asset'`, `'cdm'` or `'all'`
178
190
  */
179
- getAnnotationsInfo(source: 'assets'): Promise<AssetAnnotationImage360Info<T>[]>;
191
+ getAnnotationsInfo(source: 'assets' | 'cdm' | 'all'): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[] | AssetAnnotationImage360Info<DMDataSourceType> | AssetAnnotationImage360Info<DataSourceType>[]>;
180
192
  }
@@ -2,7 +2,7 @@
2
2
  * Copyright 2025 Cognite AS
3
3
  */
4
4
  import { Image360Provider } from './Image360Provider';
5
- import { DataSourceType } from './DataSourceType';
5
+ import { ClassicDataSourceType, DataSourceType, DMDataSourceType } from './DataSourceType';
6
6
  import { Historical360ImageSet, Image360AnnotationFilterDelegate, Image360AnnotationProvider, Image360AnnotationSpecifier, Image360DescriptorProvider, Image360Face, Image360FileDescriptor, Image360FileProvider, InstanceReference } from './types';
7
7
  import { AssetAnnotationImage360Info, DefaultImage360Collection, Image360AnnotationAssetQueryResult } from '../../360-images';
8
8
  export declare class Image360ProviderCombiner<T extends DataSourceType> implements Image360Provider<T> {
@@ -15,5 +15,7 @@ export declare class Image360ProviderCombiner<T extends DataSourceType> implemen
15
15
  getLowResolution360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
16
16
  getRelevant360ImageAnnotations(annotationSpecifier: Image360AnnotationSpecifier<T>): Promise<T['image360AnnotationType'][]>;
17
17
  findImageAnnotationsForInstance(instanceFilter: InstanceReference<T>, collection: DefaultImage360Collection<T>): Promise<Image360AnnotationAssetQueryResult<T>[]>;
18
- getAllImage360AnnotationInfos(collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<T>[]>;
18
+ getAllImage360AnnotationInfos(source: 'assets', collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>;
19
+ getAllImage360AnnotationInfos(source: 'cdm', collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>;
20
+ getAllImage360AnnotationInfos(source: 'all', collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<DataSourceType>[]>;
19
21
  }
@@ -3,7 +3,7 @@
3
3
  */
4
4
  import { CogniteClient } from '@cognite/sdk';
5
5
  import { Image360AnnotationFilterDelegate, Image360AnnotationProvider, Image360AnnotationSpecifier, InstanceReference } from '../types';
6
- import { ClassicDataSourceType } from '../DataSourceType';
6
+ import { ClassicDataSourceType, DataSourceType, DMDataSourceType } from '../DataSourceType';
7
7
  import { AssetAnnotationImage360Info, DefaultImage360Collection, Image360AnnotationAssetQueryResult } from '../../../360-images';
8
8
  export declare class Cdf360ImageAnnotationProvider implements Image360AnnotationProvider<ClassicDataSourceType> {
9
9
  private readonly _client;
@@ -11,7 +11,9 @@ export declare class Cdf360ImageAnnotationProvider implements Image360Annotation
11
11
  findImageAnnotationsForInstance(asset: InstanceReference<ClassicDataSourceType>, collection: DefaultImage360Collection<ClassicDataSourceType>): Promise<Image360AnnotationAssetQueryResult<ClassicDataSourceType>[]>;
12
12
  getRelevant360ImageAnnotations(annotationSpecifier: Image360AnnotationSpecifier<ClassicDataSourceType>): Promise<ClassicDataSourceType['image360AnnotationType'][]>;
13
13
  private getFilesByAssetRef;
14
- getAllImage360AnnotationInfos(collection: DefaultImage360Collection<ClassicDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<ClassicDataSourceType>): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>;
14
+ getAllImage360AnnotationInfos(source: 'assets', collection: DefaultImage360Collection<ClassicDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<ClassicDataSourceType>): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>;
15
+ getAllImage360AnnotationInfos(source: 'cdm', collection: DefaultImage360Collection<ClassicDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<ClassicDataSourceType>): Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>;
16
+ getAllImage360AnnotationInfos(source: 'all', collection: DefaultImage360Collection<ClassicDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<ClassicDataSourceType>): Promise<AssetAnnotationImage360Info<DataSourceType>[]>;
15
17
  private createFileIdToEntityRevisionMap;
16
18
  private fetchAllAnnotations;
17
19
  private listFileAnnotations;
@@ -1,7 +1,7 @@
1
1
  /*!
2
2
  * Copyright 2025 Cognite AS
3
3
  */
4
- import { DMDataSourceType } from '../DataSourceType';
4
+ import { ClassicDataSourceType, DataSourceType, DMDataSourceType } from '../DataSourceType';
5
5
  import { Image360AnnotationFilterDelegate, Image360AnnotationProvider, Image360AnnotationSpecifier, InstanceReference } from '../types';
6
6
  import { AssetAnnotationImage360Info, DefaultImage360Collection, Image360AnnotationAssetQueryResult } from '../../../360-images';
7
7
  import { CogniteClient } from '@cognite/sdk/dist/src';
@@ -10,5 +10,7 @@ export declare class CoreDm360ImageAnnotationProvider implements Image360Annotat
10
10
  constructor(client: CogniteClient);
11
11
  getRelevant360ImageAnnotations(annotationSpecifier: Image360AnnotationSpecifier<DMDataSourceType>): Promise<DMDataSourceType['image360AnnotationType'][]>;
12
12
  findImageAnnotationsForInstance(instanceFilter: InstanceReference<DMDataSourceType>, collection: DefaultImage360Collection<DMDataSourceType>): Promise<Image360AnnotationAssetQueryResult<DMDataSourceType>[]>;
13
- getAllImage360AnnotationInfos(collection: DefaultImage360Collection<DMDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<DMDataSourceType>): Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>;
13
+ getAllImage360AnnotationInfos(source: 'assets', collection: DefaultImage360Collection<DMDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<DMDataSourceType>): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>;
14
+ getAllImage360AnnotationInfos(source: 'cdm', collection: DefaultImage360Collection<DMDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<DMDataSourceType>): Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>;
15
+ getAllImage360AnnotationInfos(source: 'all', collection: DefaultImage360Collection<DMDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<DMDataSourceType>): Promise<AssetAnnotationImage360Info<DataSourceType>[]>;
14
16
  }
@@ -1,7 +1,7 @@
1
1
  import { Image360Provider } from '../Image360Provider';
2
2
  import { Historical360ImageSet, Image360AnnotationFilterDelegate, Image360AnnotationSpecifier, Image360Face, Image360FileDescriptor, InstanceReference } from '../types';
3
3
  import { CogniteInternalId, IdEither } from '@cognite/sdk';
4
- import { ClassicDataSourceType } from '../DataSourceType';
4
+ import { ClassicDataSourceType, DataSourceType, DMDataSourceType } from '../DataSourceType';
5
5
  import { AssetAnnotationImage360Info, DefaultImage360Collection, Image360AnnotationAssetQueryResult } from '../../../360-images';
6
6
  export declare class Local360ImageProvider implements Image360Provider<ClassicDataSourceType> {
7
7
  private readonly _modelUrl;
@@ -12,5 +12,7 @@ export declare class Local360ImageProvider implements Image360Provider<ClassicDa
12
12
  get360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
13
13
  getLowResolution360ImageFiles(image360FaceDescriptors: Image360FileDescriptor[], abortSignal?: AbortSignal): Promise<Image360Face[]>;
14
14
  getFilesByAssetRef(_assetId: IdEither): Promise<CogniteInternalId[]>;
15
- getAllImage360AnnotationInfos(_collection: DefaultImage360Collection<ClassicDataSourceType>, _annotationFilter: Image360AnnotationFilterDelegate<ClassicDataSourceType>): Promise<AssetAnnotationImage360Info[]>;
15
+ getAllImage360AnnotationInfos(source: 'assets', collection: DefaultImage360Collection<ClassicDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<ClassicDataSourceType>): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>;
16
+ getAllImage360AnnotationInfos(source: 'cdm', collection: DefaultImage360Collection<ClassicDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<ClassicDataSourceType>): Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>;
17
+ getAllImage360AnnotationInfos(source: 'all', collection: DefaultImage360Collection<ClassicDataSourceType>, annotationFilter: Image360AnnotationFilterDelegate<ClassicDataSourceType>): Promise<AssetAnnotationImage360Info<DataSourceType>[]>;
16
18
  }
@@ -32,7 +32,10 @@ export type InstanceReference<T extends DataSourceType> = T extends ClassicDataS
32
32
  export interface Image360AnnotationProvider<T extends DataSourceType> {
33
33
  getRelevant360ImageAnnotations(annotationSpecifier: Image360AnnotationSpecifier<T>): Promise<T['image360AnnotationType'][]>;
34
34
  findImageAnnotationsForInstance(instanceFilter: InstanceReference<T>, collection: DefaultImage360Collection<T>): Promise<Image360AnnotationAssetQueryResult<T>[]>;
35
- getAllImage360AnnotationInfos(collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<T>[]>;
35
+ getAllImage360AnnotationInfos(source: 'assets', collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[]>;
36
+ getAllImage360AnnotationInfos(source: 'cdm', collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<DMDataSourceType>[]>;
37
+ getAllImage360AnnotationInfos(source: 'all', collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<DataSourceType>[]>;
38
+ getAllImage360AnnotationInfos(source: 'assets' | 'cdm' | 'all', collection: DefaultImage360Collection<T>, annotationFilter: Image360AnnotationFilterDelegate<T>): Promise<AssetAnnotationImage360Info<ClassicDataSourceType>[] | AssetAnnotationImage360Info<DMDataSourceType>[] | AssetAnnotationImage360Info<DataSourceType>[]>;
36
39
  }
37
40
  export interface Image360DescriptorProvider<T extends DataSourceType> {
38
41
  get360ImageDescriptors(metadataFilter: T['image360Identifier'], preMultipliedRotation: boolean): Promise<Historical360ImageSet<T>[]>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cognite/reveal",
3
- "version": "4.22.0-dev.20250117",
3
+ "version": "4.22.0-dev.20250121",
4
4
  "description": "WebGL based 3D viewer for CAD and point clouds processed in Cognite Data Fusion.",
5
5
  "homepage": "https://github.com/cognitedata/reveal/tree/master/viewer",
6
6
  "repository": {