chore: upgrade Cognite SDK in viewer to v10 (#5025)

* chore: upgrade SDK to v10 in viewer

* chore: bump viewer version

Author: haakonflatval-cognite

viewer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/reveal",
-  "version": "4.23.4",
+  "version": "4.24.0",
   "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": {
@@ -81,7 +81,7 @@
   },
   "devDependencies": {
     "@azure/msal-browser": "^3.13.0",
-    "@cognite/sdk": "^9.12.0",
+    "@cognite/sdk": "^10.0.0",
     "@microsoft/api-extractor": "^7.43.1",
     "@types/dat.gui": "^0.7.13",
     "@types/gl": "^6.0.5",
@@ -145,7 +145,7 @@
     "workerize-loader": "^2.0.2"
   },
   "peerDependencies": {
-    "@cognite/sdk": "^7.16.0 || ^8.0.0",
+    "@cognite/sdk": "^10.0.0",
     "three": "0.174.0"
   },
   "glslify": {

viewer/packages/360-images/src/annotation/ImageAnnotationObject.ts

@@ -2,7 +2,7 @@
  * Copyright 2023 Cognite AS
  */
 
-import { AnnotationsCogniteAnnotationTypesImagesAssetLink, AnnotationsObjectDetection } from '@cognite/sdk';
+import { AnnotationsObjectDetection, AnnotationsTypesImagesAssetLink } from '@cognite/sdk';
 import { CoreDmImage360Annotation, DataSourceType, Image360FileDescriptor } from '@reveal/data-providers';
 
 import { Color, Matrix4, Vector3, Mesh, MeshBasicMaterial, DoubleSide, Object3D, Group, Raycaster } from 'three';
@@ -82,7 +82,7 @@ export class ImageAnnotationObject<T extends DataSourceType> implements Image360
   }
 
   private static createAssetLinkAnnotationData(
-    assetLink: AnnotationsCogniteAnnotationTypesImagesAssetLink
+    assetLink: AnnotationsTypesImagesAssetLink
   ): ImageAnnotationObjectGeometryData | undefined {
     const objectRegion = assetLink.objectRegion;
     if (objectRegion === undefined) {

viewer/packages/360-images/src/annotation/typeGuards.ts

@@ -3,8 +3,8 @@
  */
 import {
   AnnotationData,
-  AnnotationsCogniteAnnotationTypesImagesAssetLink,
   AnnotationsObjectDetection,
+  AnnotationsTypesImagesAssetLink,
   AnnotationType
 } from '@cognite/sdk';
 import { DataSourceType, DMDataSourceType } from '@reveal/data-providers';
@@ -33,7 +33,7 @@ export function isAnnotationsObjectDetection(
 export function isAnnotationAssetLink(
   annotationType: AnnotationType,
   annotation: AnnotationData
-): annotation is AnnotationsCogniteAnnotationTypesImagesAssetLink {
-  const link = annotation as AnnotationsCogniteAnnotationTypesImagesAssetLink;
+): annotation is AnnotationsTypesImagesAssetLink {
+  const link = annotation as AnnotationsTypesImagesAssetLink;
   return annotationType === 'images.AssetLink' && link.text !== undefined && link.textRegion !== undefined;
 }

viewer/packages/cad-styling/src/AssetNodeCollection.ts

@@ -16,6 +16,7 @@ import { AssetMapping3D, CogniteClient } from '@cognite/sdk';
 
 import cloneDeep from 'lodash/cloneDeep';
 import { CdfModelNodeCollectionDataProvider } from './CdfModelNodeCollectionDataProvider';
+import { isCdfAssetMapping } from '@reveal/utilities';
 
 /**
  * Represents a set of nodes associated with an [asset in Cognite Fusion]{@link https://docs.cognite.com/api/v1/#tag/Assets}
@@ -59,7 +60,10 @@ export class AssetNodeCollection extends NodeCollection {
       this._fetchResultHelper.interrupt();
     }
     const fetchResultHelper = new PopulateIndexSetFromPagedResponseHelper<AssetMapping3D>(
-      assetMappings => assetMappings.map(mapping => new NumericRange(mapping.treeIndex, mapping.subtreeSize)),
+      assetMappings =>
+        assetMappings
+          .filter(isCdfAssetMapping)
+          .map(mapping => new NumericRange(mapping.treeIndex, mapping.subtreeSize)),
       mappings => this.fetchBoundingBoxesForAssetMappings(mappings),
       () => this.notifyChanged()
     );

viewer/packages/data-providers/src/image-360-data-providers/Cdf360ImageAnnotationProvider.ts

@@ -9,11 +9,11 @@ import {
   CogniteClient,
   IdEither,
   CogniteInternalId,
-  AnnotationsCogniteAnnotationTypesImagesAssetLink,
   AnnotationFilterProps,
   AnnotationsAssetRef,
   InternalId,
-  ExternalId
+  ExternalId,
+  AnnotationsTypesImagesAssetLink
 } from '@cognite/sdk';
 import {
   Image360AnnotationFilterDelegate,
@@ -77,7 +77,7 @@ export class Cdf360ImageAnnotationProvider implements Image360AnnotationProvider
       const annotations = await revision.getAnnotations();
 
       return annotations.filter(a => {
-        const assetLink = a.annotation.data as AnnotationsCogniteAnnotationTypesImagesAssetLink;
+        const assetLink = a.annotation.data as AnnotationsTypesImagesAssetLink;
         return assetLink.assetRef !== undefined && matchesAssetRef(assetLink, asset);
       });
     }
@@ -208,7 +208,7 @@ export class Cdf360ImageAnnotationProvider implements Image360AnnotationProvider
   }
 }
 
-function matchesAssetRef(assetLink: AnnotationsCogniteAnnotationTypesImagesAssetLink, matchRef: IdEither): boolean {
+function matchesAssetRef(assetLink: AnnotationsTypesImagesAssetLink, matchRef: IdEither): boolean {
   return (
     ((matchRef as InternalId).id !== undefined && assetLink.assetRef.id === (matchRef as InternalId).id) ||
     ((matchRef as ExternalId).externalId !== undefined &&

viewer/packages/data-providers/src/image-360-data-providers/Cdf360ImageFileProvider.ts

@@ -4,7 +4,7 @@
 import zipWith from 'lodash/zipWith';
 import { Image360Face, Image360FileDescriptor, Image360FileProvider } from '../types';
 import { CdfImageFileProvider } from './CdfImageFileProvider';
-import { CogniteClient, InternalId } from '@cognite/sdk/dist/src';
+import { CogniteClient, InternalId } from '@cognite/sdk';
 
 export class Cdf360ImageFileProvider implements Image360FileProvider {
   private readonly _imageFileProvider: CdfImageFileProvider;

viewer/packages/data-providers/src/image-360-data-providers/CoreDm360ImageAnnotationProvider.ts

@@ -17,7 +17,7 @@ import {
 } from '@reveal/360-images';
 import { isSameImage360RevisionId } from './shared';
 import { fetchCoreDm360AnnotationsForRevision } from './cdm/fetchCoreDm360AnnotationsForRevision';
-import { CogniteClient } from '@cognite/sdk/dist/src';
+import { CogniteClient } from '@cognite/sdk';
 import { fetchAnnotationsForInstance, Image360AnnotationsForInstanceResult } from './cdm/fetchAnnotationsForInstance';
 import { fetchCoreDm360AnnotationsForCollection } from './cdm/fetchCoreDm360AnnotationsForCollection';
 import { DMInstanceKey, dmInstanceRefToKey } from '@reveal/utilities';

viewer/packages/data-providers/src/image-360-data-providers/shared.ts

@@ -3,12 +3,7 @@
  */
 import { Image360RevisionId, ImageAssetLinkAnnotationInfo } from '../types';
 import { DataSourceType } from '../DataSourceType';
-import {
-  AnnotationData,
-  AnnotationModel,
-  AnnotationsCogniteAnnotationTypesImagesAssetLink,
-  Metadata
-} from '@cognite/sdk';
+import { AnnotationData, AnnotationModel, AnnotationsTypesImagesAssetLink, Metadata } from '@cognite/sdk';
 import {
   Image360DataModelIdentifier,
   Image360LegacyDataModelIdentifier
@@ -69,9 +64,7 @@ export function isImageAssetLinkAnnotation(annotation: AnnotationModel): annotat
   return isAssetLinkAnnotationData(annotation.data);
 }
 
-function isAssetLinkAnnotationData(
-  annotationData: AnnotationData
-): annotationData is AnnotationsCogniteAnnotationTypesImagesAssetLink {
-  const data = annotationData as AnnotationsCogniteAnnotationTypesImagesAssetLink;
+function isAssetLinkAnnotationData(annotationData: AnnotationData): annotationData is AnnotationsTypesImagesAssetLink {
+  const data = annotationData as AnnotationsTypesImagesAssetLink;
   return data.text !== undefined && data.textRegion !== undefined && data.assetRef !== undefined;
 }

viewer/packages/data-providers/src/pointcloud-stylable-object-providers/CdfPointCloudStylableObjectProvider.ts

@@ -6,7 +6,7 @@ import {
   CogniteClient,
   AnnotationData,
   AnnotationsBoundingVolume,
-  AnnotationsCogniteAnnotationTypesPrimitivesGeometry3DGeometry as AnnotationsGeometry
+  AnnotationsTypesPrimitivesGeometry3DGeometry as AnnotationsGeometry
 } from '@cognite/sdk';
 import { IShape, Box, Cylinder } from '@reveal/utilities';
 import assert from 'assert';

viewer/packages/data-providers/src/types.ts

@@ -1,7 +1,7 @@
 /*!
  * Copyright 2021 Cognite AS
  */
-import { AnnotationModel, AnnotationsCogniteAnnotationTypesImagesAssetLink, IdEither } from '@cognite/sdk';
+import { AnnotationModel, AnnotationsTypesImagesAssetLink, IdEither } from '@cognite/sdk';
 import * as THREE from 'three';
 import { ClassicDataSourceType, DataSourceType, DMDataSourceType } from './DataSourceType';
 import {
@@ -103,7 +103,7 @@ export type ImageAssetLinkAnnotationInfo = Omit<AnnotationModel, 'data'> & {
   /**
    * The data associated with the image asset link
    */
-  data: AnnotationsCogniteAnnotationTypesImagesAssetLink;
+  data: AnnotationsTypesImagesAssetLink;
 };
 
 export type Historical360ImageSet<T extends DataSourceType> = Image360RevisionDescriptor<T> & {

viewer/packages/data-providers/src/utilities/utils.ts

@@ -2,7 +2,7 @@
  * Copyright 2024 Cognite AS
  */
 
-import { TableExpressionEqualsFilterV3 } from '@cognite/sdk/dist/src';
+import { TableExpressionEqualsFilterV3 } from '@cognite/sdk';
 import { PointCloudObject, PointCloudObjectMetadata } from '../pointcloud-stylable-object-providers/types';
 import { StylableObject } from '../pointcloud-stylable-object-providers/StylableObject';
 import { ClassicDataSourceType, DMDataSourceType, DataSourceType } from '../DataSourceType';

viewer/packages/utilities/index.ts

@@ -87,6 +87,7 @@ export { createUint8View } from './src/createUint8View';
 export * from './src/workers/workerize-transferable';
 
 export * from './src/fdm';
+export * from './src/assetMappings';
 
 export * from './src/shapes';
 export * from './src/linalg';

viewer/packages/utilities/src/assetMappings/index.ts

@@ -0,0 +1,5 @@
+/*!
+ * Copyright 2025 Cognite AS
+ */
+export { isCdfAssetMapping } from './isCdfAssetMapping';
+export { CdfAssetMapping } from './types';

viewer/packages/utilities/src/assetMappings/isCdfAssetMapping.test.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2025 Cognite AS
+ */
+import { isCdfAssetMapping } from './isCdfAssetMapping';
+
+describe(isCdfAssetMapping.name, () => {
+  test('correctly recognizes a CDF asset mapping', () => {
+    expect(
+      isCdfAssetMapping({
+        assetId: 123,
+        nodeId: 345,
+        treeIndex: 3,
+        subtreeSize: 2
+      })
+    ).toBe(true);
+  });
+
+  test('correctly recognizes that an incomplete mapping is not a CDF asset mapping', () => {
+    expect(
+      isCdfAssetMapping({
+        assetId: 123,
+        nodeId: 234
+      })
+    ).toBe(false);
+  });
+});

viewer/packages/utilities/src/assetMappings/isCdfAssetMapping.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2025 Cognite AS
+ */
+import { AssetMapping3D } from '@cognite/sdk';
+import { CdfAssetMapping } from './types';
+
+/**
+ * Type guard checking whether the asset mapping contains treeIndex and subtreeSize
+ */
+export function isCdfAssetMapping(assetMapping: AssetMapping3D): assetMapping is CdfAssetMapping {
+  return assetMapping.treeIndex !== undefined && assetMapping.subtreeSize !== undefined;
+}

viewer/packages/utilities/src/assetMappings/types.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright 2025 Cognite AS
+ */
+import { CogniteInternalId, UnitDMSUniqueIdentifier } from '@cognite/sdk';
+
+/**
+ * A CAD asset mapping that is guaranteed to contain treeIndex and subtreeSize. The only CAD asset
+ * mappings that don't satisfy this rule are from very old CAD models (about pre-2023).
+ */
+export type CdfAssetMapping = {
+  /**
+   * Tree index of the mapped node
+   */
+  treeIndex: number;
+  /**
+   * Size of the subtree with the mapped node as root
+   */
+  subtreeSize: number;
+  /**
+   * The node id of the mapped node
+   */
+  nodeId: CogniteInternalId;
+  /**
+   * The id of the asset mapped to the node
+   */
+  assetId: CogniteInternalId;
+  /**
+   * The ID of the associated Cognite Asset instance from Core Data Model.
+   */
+  assetInstanceId?: UnitDMSUniqueIdentifier;
+};

viewer/reveal.api.md

@@ -6,8 +6,8 @@
 
 import { AnnotationModel } from '@cognite/sdk';
 import { AnnotationsAssetRef } from '@cognite/sdk';
-import { AnnotationsCogniteAnnotationTypesImagesAssetLink } from '@cognite/sdk';
 import { AnnotationStatus } from '@cognite/sdk';
+import { AnnotationsTypesImagesAssetLink } from '@cognite/sdk';
 import { Box3 } from 'three';
 import { Camera } from 'three';
 import { CogniteClient } from '@cognite/sdk';
@@ -1390,7 +1390,7 @@ export type Image360WithCollection<T extends DataSourceType = ClassicDataSourceT
 
 // @public
 export type ImageAssetLinkAnnotationInfo = Omit<AnnotationModel, 'data'> & {
-    data: AnnotationsCogniteAnnotationTypesImagesAssetLink;
+    data: AnnotationsTypesImagesAssetLink;
 };
 
 // @public (undocumented)