@cognite/reveal 3.1.0 → 4.0.0-dev.20221025

package/packages/{modeldata-api/src → data-providers/src/utilities}/applyDefaultModelTransformation.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { File3dFormat } from './types';
-export declare function applyDefaultModelTransformation(matrix: THREE.Matrix4, format: File3dFormat | string): void;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { File3dFormat } from '../types';
+export declare function applyDefaultModelTransformation(matrix: THREE.Matrix4, format: File3dFormat | string): void;

package/packages/{modeldata-api/src/utilities.d.ts → data-providers/src/utilities/fetchWithStatusCheck.d.ts}

@@ -1,7 +1,5 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { Versioned3DFile } from '@cognite/sdk';
-export declare const supportedVersions: number[];
-export declare function getNewestVersionedFile(files: Versioned3DFile[]): Versioned3DFile;
-export declare function fetchWithStatusCheck(url: string): Promise<Response>;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare const supportedVersions: number[];
+export declare function fetchWithStatusCheck(url: string): Promise<Response>;

package/packages/data-source/index.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { DataSource } from './src/DataSource';
-export { CdfDataSource } from './src/CdfDataSource';
-export { LocalDataSource } from './src/LocalDataSource';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { DataSource } from './src/DataSource';
+export { CdfDataSource } from './src/CdfDataSource';
+export { LocalDataSource } from './src/LocalDataSource';

package/packages/data-source/src/CdfDataSource.d.ts

@@ -1,19 +1,19 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CogniteClient } from '@cognite/sdk';
-import { DataSource } from './DataSource';
-import { NodesApiClient } from '../../nodes-api';
-import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
-/**
- * Data source for Cognite Data Fusion.
- */
-export declare class CdfDataSource implements DataSource {
-    private readonly _metadataProvider;
-    private readonly _nodesApiClient;
-    private readonly _modelDataClient;
-    constructor(sdkClient: CogniteClient);
-    getNodesApiClient(): NodesApiClient;
-    getModelDataProvider(): ModelDataProvider;
-    getModelMetadataProvider(): ModelMetadataProvider;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CogniteClient } from '@cognite/sdk';
+import { DataSource } from './DataSource';
+import { NodesApiClient } from '../../nodes-api';
+import { ModelDataProvider, ModelMetadataProvider } from '../../data-providers';
+/**
+ * Data source for Cognite Data Fusion.
+ */
+export declare class CdfDataSource implements DataSource {
+    private readonly _metadataProvider;
+    private readonly _nodesApiClient;
+    private readonly _modelDataClient;
+    constructor(sdkClient: CogniteClient);
+    getNodesApiClient(): NodesApiClient;
+    getModelDataProvider(): ModelDataProvider;
+    getModelMetadataProvider(): ModelMetadataProvider;
+}

package/packages/data-source/src/DataSource.d.ts

@@ -1,25 +1,25 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodesApiClient } from '../../nodes-api';
-import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
-/**
- * Describes how Reveal data is stored, and provides means to create custom storage providers
- * that Reveal will fetch data from.
- */
-export interface DataSource {
-    /**
-     * Gets a node API client that is able to fetch data about
-     * models.
-     */
-    getNodesApiClient(): NodesApiClient;
-    /**
-     * Gets a metadata provider for models.
-     */
-    getModelMetadataProvider(): ModelMetadataProvider;
-    /**
-     * Gets a client that is able to download geometry and other files
-     * for models.
-     */
-    getModelDataProvider(): ModelDataProvider;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodesApiClient } from '../../nodes-api';
+import { ModelDataProvider, ModelMetadataProvider } from '../../data-providers';
+/**
+ * Describes how Reveal data is stored, and provides means to create custom storage providers
+ * that Reveal will fetch data from.
+ */
+export interface DataSource {
+    /**
+     * Gets a node API client that is able to fetch data about
+     * models.
+     */
+    getNodesApiClient(): NodesApiClient;
+    /**
+     * Gets a metadata provider for models.
+     */
+    getModelMetadataProvider(): ModelMetadataProvider;
+    /**
+     * Gets a client that is able to download geometry and other files
+     * for models.
+     */
+    getModelDataProvider(): ModelDataProvider;
+}

package/packages/data-source/src/LocalDataSource.d.ts

@@ -1,15 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodesApiClient } from '../../nodes-api';
-import { ModelDataProvider, ModelMetadataProvider } from '../../modeldata-api';
-import { DataSource } from './DataSource';
-/**
- * Data source for loading models from local storage (i.e. by URL).
- * This implementation is meant for use in development.
- */
-export declare class LocalDataSource implements DataSource {
-    getNodesApiClient(): NodesApiClient;
-    getModelDataProvider(): ModelDataProvider;
-    getModelMetadataProvider(): ModelMetadataProvider;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodesApiClient } from '../../nodes-api';
+import { ModelDataProvider, ModelMetadataProvider } from '../../data-providers';
+import { DataSource } from './DataSource';
+/**
+ * Data source for loading models from local storage (i.e. by URL).
+ * This implementation is meant for use in development.
+ */
+export declare class LocalDataSource implements DataSource {
+    getNodesApiClient(): NodesApiClient;
+    getModelDataProvider(): ModelDataProvider;
+    getModelMetadataProvider(): ModelMetadataProvider;
+}

package/packages/logger/index.d.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import log from './src/Log';
-export default log;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import log from './src/Log';
+export default log;

package/packages/logger/src/Log.d.ts

@@ -1,5 +1,5 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as log from 'loglevel';
-export default log;
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as log from 'loglevel';
+export default log;

package/packages/metrics/index.d.ts

@@ -1,4 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { MetricsLogger } from './src/MetricsLogger';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { MetricsLogger } from './src/MetricsLogger';

package/packages/metrics/src/MetricsLogger.d.ts

@@ -1,21 +1,34 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { TrackedEvents, EventProps } from './types';
-export declare class MetricsLogger {
-    _sessionProps: {
-        VERSION: string;
-        project: string;
-        application: string;
-        sessionId: string;
-    };
-    private constructor();
-    static init(logMetrics: boolean, project: string, applicationId: string, eventProps: EventProps): void;
-    private innerTrackEvent;
-    static trackEvent(eventName: TrackedEvents, eventProps: EventProps): void;
-    static trackCreateTool(toolName: string): void;
-    static trackLoadModel(eventProps: EventProps, modelIdentifier: any, modelVersion: number): void;
-    static trackCadModelStyled(nodeCollectionClassToken: string, appearance: any): void;
-    static trackError(error: Error, eventProps: EventProps): void;
-    static trackCameraNavigation(eventProps: EventProps): void;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+/// <reference types="lodash" />
+import * as THREE from 'three';
+import { TrackedEvents, EventProps } from './types';
+export declare class MetricsLogger {
+    private readonly _sessionProps;
+    private static readonly TrackCameraNavigationThrottleDelay;
+    private static readonly TrackCadNodeTransformOverriddenThrottleDelay;
+    private constructor();
+    static init(logMetrics: boolean, project: string, applicationId: string, eventProps: EventProps): void;
+    private innerTrackEvent;
+    static trackEvent(eventName: TrackedEvents, eventProps: EventProps): void;
+    static trackCreateTool(toolName: string): void;
+    static trackLoadModel(eventProps: EventProps, modelIdentifier: any, modelVersion: number): void;
+    static trackCadModelStyled(nodeCollectionClassToken: string, appearance: any): void;
+    private static readonly trackCadNodeTransformOverriddenVars;
+    /**
+     * Track use of CAD node transform overrides. Note that the metric is throttled and will only trigger
+     * once per second.
+     * @param nodeCount Number of nodes affected by the transform override
+     * @param matrix  Matrix used to override the node transform
+     */
+    static readonly trackCadNodeTransformOverridden: import("lodash").DebouncedFunc<(nodeCount: number, matrix: THREE.Matrix4) => void>;
+    private static trackCadNodeTransformOverriddenImpl;
+    /**
+     * Track camera navigation events. Note that the metric is throttled and will only trigger
+     * once per second.
+     */
+    static readonly trackCameraNavigation: import("lodash").DebouncedFunc<(eventProps: EventProps) => void>;
+    private static trackCameraNavigationImpl;
+    static trackError(error: Error, eventProps: EventProps): void;
+}

package/packages/metrics/src/types.d.ts

@@ -1,7 +1,7 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare type TrackedEvents = 'init' | 'construct3dViewer' | 'loadModel' | 'error' | 'cameraNavigated' | 'toolCreated' | 'cadModelStyleAssigned';
-export declare type EventProps = {
-    [key: string]: any;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare type TrackedEvents = 'init' | 'construct3dViewer' | 'loadModel' | 'error' | 'cameraNavigated' | 'toolCreated' | 'cadModelStyleAssigned' | 'cadNodeTransformOverridden' | 'measurementAdded';
+export declare type EventProps = {
+    [key: string]: any;
+};

package/packages/model-base/index.d.ts

@@ -1,7 +1,7 @@
-/*!
- * Copyright 2022 Cognite AS
- */
-export { IntersectInput, LoadingState } from './src/types';
-export { SupportedModelTypes } from './src/SupportedModelTypes';
-export { CogniteModelBase } from './src/CogniteModelBase';
-export { MetadataRepository } from './src/MetadataRepository';
+/*!
+ * Copyright 2022 Cognite AS
+ */
+export { IntersectInput, LoadingState } from './src/types';
+export { SupportedModelTypes } from './src/SupportedModelTypes';
+export { CogniteModelBase } from './src/CogniteModelBase';
+export { MetadataRepository } from './src/MetadataRepository';

package/packages/model-base/src/CogniteModelBase.d.ts

@@ -1,17 +1,17 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CameraConfiguration } from '../../utilities';
-import { SupportedModelTypes } from './SupportedModelTypes';
-/**
- * Base class for 3D models supported by {@link Cognite3DViewer}.
- * @module @cognite/reveal
- */
-export interface CogniteModelBase {
-    readonly type: SupportedModelTypes;
-    dispose(): void;
-    getModelBoundingBox(outBbox?: THREE.Box3, restrictToMostGeometry?: boolean): THREE.Box3;
-    getCameraConfiguration(): CameraConfiguration | undefined;
-    setModelTransformation(matrix: THREE.Matrix4): void;
-    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CameraConfiguration } from '../../utilities';
+import { SupportedModelTypes } from './SupportedModelTypes';
+/**
+ * Base class for 3D models supported by {@link Cognite3DViewer}.
+ * @module @cognite/reveal
+ */
+export interface CogniteModelBase {
+    readonly type: SupportedModelTypes;
+    dispose(): void;
+    getModelBoundingBox(outBbox?: THREE.Box3, restrictToMostGeometry?: boolean): THREE.Box3;
+    getCameraConfiguration(): CameraConfiguration | undefined;
+    setModelTransformation(matrix: THREE.Matrix4): void;
+    getModelTransformation(out?: THREE.Matrix4): THREE.Matrix4;
+}

package/packages/model-base/src/MetadataRepository.d.ts

@@ -1,7 +1,7 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { ModelIdentifier } from '../../modeldata-api';
-export interface MetadataRepository<Output> {
-    loadData(modelIdentifier: ModelIdentifier): Output;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { ModelIdentifier } from '../../data-providers';
+export interface MetadataRepository<Output> {
+    loadData(modelIdentifier: ModelIdentifier): Output;
+}

package/packages/model-base/src/SupportedModelTypes.d.ts

@@ -1,4 +1,4 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export declare type SupportedModelTypes = 'pointcloud' | 'cad';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export declare type SupportedModelTypes = 'pointcloud' | 'cad';

package/packages/model-base/src/types.d.ts

@@ -1,36 +1,36 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-export interface IntersectInput {
-    normalizedCoords: {
-        x: number;
-        y: number;
-    };
-    camera: THREE.PerspectiveCamera;
-    clippingPlanes: THREE.Plane[];
-    renderer: THREE.WebGLRenderer;
-    domElement: HTMLElement;
-}
-/**
- * State holding information about data being loaded.
- */
-export declare type LoadingState = {
-    /**
-     * Indicates if we are currently loading more data.
-     */
-    isLoading: boolean;
-    /**
-     * Items loaded so far in this batch.
-     */
-    itemsLoaded: number;
-    /**
-     * Totals number of items to load in this batch.
-     */
-    itemsRequested: number;
-    /**
-     * Number of items that has been 'culled' (i.e. deemed not necessary
-     * to load) so far in this batch.
-     */
-    itemsCulled: number;
-};
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+export interface IntersectInput {
+    normalizedCoords: {
+        x: number;
+        y: number;
+    };
+    camera: THREE.PerspectiveCamera;
+    clippingPlanes: THREE.Plane[];
+    renderer: THREE.WebGLRenderer;
+    domElement: HTMLElement;
+}
+/**
+ * State holding information about data being loaded.
+ */
+export declare type LoadingState = {
+    /**
+     * Indicates if we are currently loading more data.
+     */
+    isLoading: boolean;
+    /**
+     * Items loaded so far in this batch.
+     */
+    itemsLoaded: number;
+    /**
+     * Totals number of items to load in this batch.
+     */
+    itemsRequested: number;
+    /**
+     * Number of items that has been 'culled' (i.e. deemed not necessary
+     * to load) so far in this batch.
+     */
+    itemsCulled: number;
+};

package/packages/nodes-api/index.d.ts

@@ -1,6 +1,6 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { NodesApiClient } from './src/NodesApiClient';
-export { NodesCdfClient } from './src/NodesCdfClient';
-export { NodesLocalClient } from './src/NodesLocalClient';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { NodesApiClient } from './src/NodesApiClient';
+export { NodesCdfClient } from './src/NodesCdfClient';
+export { NodesLocalClient } from './src/NodesLocalClient';

package/packages/nodes-api/src/NodesApiClient.d.ts

@@ -1,50 +1,50 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { CogniteInternalId } from '@cognite/sdk';
-/**
- * Client for retrieving metadata information about CAD nodes.
- */
-export interface NodesApiClient {
-    /**
-     * Maps a set of "tree indexes" that identify nodes, to the respective
-     * "node IDs".
-     */
-    mapTreeIndicesToNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
-    /**
-     * Maps a set of "node IDs" that identify nodes, to the respective
-     * "tree indexes".
-     */
-    mapNodeIdsToTreeIndices(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<number[]>;
-    /**
-     * Determines tree index and subtreeSize (i.e. span of the subtree a node is parent
-     * of) given a set of node IDs.
-     */
-    determineTreeIndexAndSubtreeSizesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<{
-        treeIndex: number;
-        subtreeSize: number;
-    }[]>;
-    /**
-     * Determine ancestor subtree span of a given node. If the node doesn't have an
-     * ancestor at the generation given, the span of the root node is returned.
-     * @param modelId       ID of 3D model
-     * @param revisionId    ID of 3D model revision
-     * @param nodeId        Node ID of node
-     * @param generation    Generation to retrieve (0 means node itself, 1 is parent, 2 grand-parent etc).
-     */
-    determineNodeAncestorsByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, generation: number): Promise<{
-        treeIndex: number;
-        subtreeSize: number;
-    }>;
-    /**
-     * Determines the bounds of the individual nodes provided. Note that the returned
-     * boxes will be in "CDF coordinates" and not transformed using
-     * the model transformation for the given model.
-     *
-     * @param modelId       ID of 3D model
-     * @param revisionId    ID of 3D model revision
-     * @param nodeIds       Node IDs of nodes
-     */
-    getBoundingBoxesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<THREE.Box3[]>;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { CogniteInternalId } from '@cognite/sdk';
+/**
+ * Client for retrieving metadata information about CAD nodes.
+ */
+export interface NodesApiClient {
+    /**
+     * Maps a set of "tree indexes" that identify nodes, to the respective
+     * "node IDs".
+     */
+    mapTreeIndicesToNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
+    /**
+     * Maps a set of "node IDs" that identify nodes, to the respective
+     * "tree indexes".
+     */
+    mapNodeIdsToTreeIndices(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<number[]>;
+    /**
+     * Determines tree index and subtreeSize (i.e. span of the subtree a node is parent
+     * of) given a set of node IDs.
+     */
+    determineTreeIndexAndSubtreeSizesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<{
+        treeIndex: number;
+        subtreeSize: number;
+    }[]>;
+    /**
+     * Determine ancestor subtree span of a given node. If the node doesn't have an
+     * ancestor at the generation given, the span of the root node is returned.
+     * @param modelId       ID of 3D model
+     * @param revisionId    ID of 3D model revision
+     * @param nodeId        Node ID of node
+     * @param generation    Generation to retrieve (0 means node itself, 1 is parent, 2 grand-parent etc).
+     */
+    determineNodeAncestorsByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, generation: number): Promise<{
+        treeIndex: number;
+        subtreeSize: number;
+    }>;
+    /**
+     * Determines the bounds of the individual nodes provided. Note that the returned
+     * boxes will be in "CDF coordinates" and not transformed using
+     * the model transformation for the given model.
+     *
+     * @param modelId       ID of 3D model
+     * @param revisionId    ID of 3D model revision
+     * @param nodeIds       Node IDs of nodes
+     */
+    getBoundingBoxesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<THREE.Box3[]>;
+}

package/packages/nodes-api/src/NodesCdfClient.d.ts

@@ -1,24 +1,24 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import * as THREE from 'three';
-import { CogniteClient, CogniteInternalId } from '@cognite/sdk';
-import { NodesApiClient } from './NodesApiClient';
-export declare class NodesCdfClient implements NodesApiClient {
-    private static readonly MaxItemsPerRequest;
-    private readonly _client;
-    constructor(client: CogniteClient);
-    mapTreeIndicesToNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<number[]>;
-    mapNodeIdsToTreeIndices(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
-    determineTreeIndexAndSubtreeSizesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<{
-        treeIndex: number;
-        subtreeSize: number;
-    }[]>;
-    determineNodeAncestorsByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, generation: number): Promise<{
-        treeIndex: number;
-        subtreeSize: number;
-    }>;
-    getBoundingBoxesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<THREE.Box3[]>;
-    private postByTreeIndicesRequest;
-    private postByNodeIdsRequest;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import * as THREE from 'three';
+import { CogniteClient, CogniteInternalId } from '@cognite/sdk';
+import { NodesApiClient } from './NodesApiClient';
+export declare class NodesCdfClient implements NodesApiClient {
+    private static readonly MaxItemsPerRequest;
+    private readonly _client;
+    constructor(client: CogniteClient);
+    mapTreeIndicesToNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<number[]>;
+    mapNodeIdsToTreeIndices(modelId: CogniteInternalId, revisionId: CogniteInternalId, treeIndices: number[]): Promise<CogniteInternalId[]>;
+    determineTreeIndexAndSubtreeSizesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<{
+        treeIndex: number;
+        subtreeSize: number;
+    }[]>;
+    determineNodeAncestorsByNodeId(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeId: CogniteInternalId, generation: number): Promise<{
+        treeIndex: number;
+        subtreeSize: number;
+    }>;
+    getBoundingBoxesByNodeIds(modelId: CogniteInternalId, revisionId: CogniteInternalId, nodeIds: CogniteInternalId[]): Promise<THREE.Box3[]>;
+    private postByTreeIndicesRequest;
+    private postByNodeIdsRequest;
+}