@cognite/reveal 2.1.2 → 2.2.0

package/packages/cad-styling/src/NodeAppearanceProvider.d.ts

@@ -1,29 +1,29 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodeAppearance } from './NodeAppearance';
-import { NodeCollectionBase } from './NodeCollectionBase';
-import { IndexSet } from '../../utilities';
-/**
- * Delegate for applying styles in {@see NodeStyleProvider}.
- * @param treeIndices Set of tree indices that the style is applied to.
- * @param appearance  Style to be applied to the nodes.
- */
-export declare type ApplyStyleDelegate = (treeIndices: IndexSet, appearance: NodeAppearance) => void;
-export declare class NodeAppearanceProvider {
-    private readonly _styledCollections;
-    private _lastFiredLoadingState?;
-    private readonly _events;
-    on(event: 'changed', listener: () => void): void;
-    on(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
-    off(event: 'changed', listener: () => void): void;
-    off(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
-    assignStyledNodeCollection(nodeCollection: NodeCollectionBase, appearance: NodeAppearance): void;
-    unassignStyledNodeCollection(nodeCollection: NodeCollectionBase): void;
-    applyStyles(applyCb: ApplyStyleDelegate): void;
-    clear(): void;
-    get isLoading(): boolean;
-    private notifyChanged;
-    private notifyLoadingStateChanged;
-    private handleNodeCollectionChanged;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodeAppearance } from './NodeAppearance';
+import { NodeCollectionBase } from './NodeCollectionBase';
+import { IndexSet } from '../../utilities';
+/**
+ * Delegate for applying styles in {@see NodeStyleProvider}.
+ * @param treeIndices Set of tree indices that the style is applied to.
+ * @param appearance  Style to be applied to the nodes.
+ */
+export declare type ApplyStyleDelegate = (treeIndices: IndexSet, appearance: NodeAppearance) => void;
+export declare class NodeAppearanceProvider {
+    private readonly _styledCollections;
+    private _lastFiredLoadingState?;
+    private readonly _events;
+    on(event: 'changed', listener: () => void): void;
+    on(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
+    off(event: 'changed', listener: () => void): void;
+    off(event: 'loadingStateChanged', listener: (isLoading: boolean) => void): void;
+    assignStyledNodeCollection(nodeCollection: NodeCollectionBase, appearance: NodeAppearance): void;
+    unassignStyledNodeCollection(nodeCollection: NodeCollectionBase): void;
+    applyStyles(applyCb: ApplyStyleDelegate): void;
+    clear(): void;
+    get isLoading(): boolean;
+    private notifyChanged;
+    private notifyLoadingStateChanged;
+    private handleNodeCollectionChanged;
+}

package/packages/cad-styling/src/NodeCollectionBase.d.ts

@@ -1,47 +1,47 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { IndexSet } from '../../utilities';
-export declare type SerializedNodeCollection = {
-    token: string;
-    state: any;
-    options?: any;
-};
-/**
- * Abstract class for implementing a set of nodes to be styled.
- */
-export declare abstract class NodeCollectionBase {
-    private readonly _changedEvent;
-    private readonly _classToken;
-    protected constructor(classToken: string);
-    get classToken(): string;
-    /**
-     * Subscribe a listener to events about the set changing, i.e.
-     * when nodes are added or removed to the set.
-     */
-    on(event: 'changed', listener: () => void): void;
-    /**
-     * Unsubscribe a listener to events about the set changing, i.e.
-     * when nodes are added or removed to the set.
-     */
-    off(event: 'changed', listener: () => void): void;
-    /**
-     * Returns true when the set currently is running an operation
-     * for loading the full set of nodes contained by the set.
-     */
-    abstract get isLoading(): boolean;
-    /**
-     * Returns the {@link IndexSet} that holds the tree indices
-     * of the nodes contained by the set.
-     */
-    abstract getIndexSet(): IndexSet;
-    /**
-     * Clears the set, making it empty.
-     */
-    abstract clear(): void;
-    /**
-     * Triggers the changed-event.
-     */
-    protected notifyChanged(): void;
-    abstract serialize(): SerializedNodeCollection;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { IndexSet } from '../../utilities';
+export declare type SerializedNodeCollection = {
+    token: string;
+    state: any;
+    options?: any;
+};
+/**
+ * Abstract class for implementing a set of nodes to be styled.
+ */
+export declare abstract class NodeCollectionBase {
+    private readonly _changedEvent;
+    private readonly _classToken;
+    protected constructor(classToken: string);
+    get classToken(): string;
+    /**
+     * Subscribe a listener to events about the set changing, i.e.
+     * when nodes are added or removed to the set.
+     */
+    on(event: 'changed', listener: () => void): void;
+    /**
+     * Unsubscribe a listener to events about the set changing, i.e.
+     * when nodes are added or removed to the set.
+     */
+    off(event: 'changed', listener: () => void): void;
+    /**
+     * Returns true when the set currently is running an operation
+     * for loading the full set of nodes contained by the set.
+     */
+    abstract get isLoading(): boolean;
+    /**
+     * Returns the {@link IndexSet} that holds the tree indices
+     * of the nodes contained by the set.
+     */
+    abstract getIndexSet(): IndexSet;
+    /**
+     * Clears the set, making it empty.
+     */
+    abstract clear(): void;
+    /**
+     * Triggers the changed-event.
+     */
+    protected notifyChanged(): void;
+    abstract serialize(): SerializedNodeCollection;
+}

package/packages/cad-styling/src/TreeIndexNodeCollection.d.ts

@@ -1,23 +1,23 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NumericRange, IndexSet } from '../../utilities';
-import { NodeCollectionBase, SerializedNodeCollection } from './NodeCollectionBase';
-/**
- * Node collection that holds a set of nodes defined by a set of tree indices.
- */
-export declare class TreeIndexNodeCollection extends NodeCollectionBase {
-    static readonly classToken = "TreeIndexNodeCollection";
-    private _treeIndices;
-    constructor(treeIndexSet?: IndexSet);
-    constructor(treeIndices?: Iterable<number>);
-    constructor(treeIndexRange?: NumericRange);
-    updateSet(treeIndices: IndexSet): void;
-    /**
-     * Sets this set to hold an empty set.
-     */
-    clear(): void;
-    getIndexSet(): IndexSet;
-    get isLoading(): boolean;
-    serialize(): SerializedNodeCollection;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NumericRange, IndexSet } from '../../utilities';
+import { NodeCollectionBase, SerializedNodeCollection } from './NodeCollectionBase';
+/**
+ * Node collection that holds a set of nodes defined by a set of tree indices.
+ */
+export declare class TreeIndexNodeCollection extends NodeCollectionBase {
+    static readonly classToken = "TreeIndexNodeCollection";
+    private _treeIndices;
+    constructor(treeIndexSet?: IndexSet);
+    constructor(treeIndices?: Iterable<number>);
+    constructor(treeIndexRange?: NumericRange);
+    updateSet(treeIndices: IndexSet): void;
+    /**
+     * Sets this set to hold an empty set.
+     */
+    clear(): void;
+    getIndexSet(): IndexSet;
+    get isLoading(): boolean;
+    serialize(): SerializedNodeCollection;
+}

package/packages/cad-styling/src/UnionNodeCollection.d.ts

@@ -1,15 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { NodeCollectionBase, SerializedNodeCollection } from './NodeCollectionBase';
-import { CombineNodeCollectionBase } from './CombineNodeCollectionBase';
-import { IndexSet } from '../../utilities';
-/**
- * Node collection that takes the set union of multiple node collections.
- */
-export declare class UnionNodeCollection extends CombineNodeCollectionBase {
-    static readonly classToken = "UnionNodeCollection";
-    constructor(nodeCollections?: NodeCollectionBase[]);
-    serialize(): SerializedNodeCollection;
-    protected createCombinedIndexSet(): IndexSet;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { NodeCollectionBase, SerializedNodeCollection } from './NodeCollectionBase';
+import { CombineNodeCollectionBase } from './CombineNodeCollectionBase';
+import { IndexSet } from '../../utilities';
+/**
+ * Node collection that takes the set union of multiple node collections.
+ */
+export declare class UnionNodeCollection extends CombineNodeCollectionBase {
+    static readonly classToken = "UnionNodeCollection";
+    constructor(nodeCollections?: NodeCollectionBase[]);
+    serialize(): SerializedNodeCollection;
+    protected createCombinedIndexSet(): IndexSet;
+}

package/packages/camera-manager/index.d.ts

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

package/packages/camera-manager/src/ComboControls.d.ts

@@ -1,83 +1,84 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { EventDispatcher, Vector3, PerspectiveCamera, OrthographicCamera } from 'three';
-export default class ComboControls extends EventDispatcher {
-    enabled: boolean;
-    enableDamping: boolean;
-    dampingFactor: number;
-    dynamicTarget: boolean;
-    minDistance: number;
-    maxDistance: number;
-    dollyFactor: number;
-    minPolarAngle: number;
-    maxPolarAngle: number;
-    minAzimuthAngle: number;
-    maxAzimuthAngle: number;
-    panDollyMinDistanceFactor: number;
-    firstPersonRotationFactor: number;
-    pointerRotationSpeedAzimuth: number;
-    pointerRotationSpeedPolar: number;
-    enableKeyboardNavigation: boolean;
-    keyboardRotationSpeedAzimuth: number;
-    keyboardRotationSpeedPolar: number;
-    mouseFirstPersonRotationSpeed: number;
-    keyboardDollySpeed: number;
-    keyboardPanSpeed: number;
-    keyboardSpeedFactor: number;
-    pinchEpsilon: number;
-    pinchPanSpeed: number;
-    EPSILON: number;
-    dispose: () => void;
-    minZoom: number;
-    maxZoom: number;
-    orthographicCameraDollyFactor: number;
-    private temporarilyDisableDamping;
-    private camera;
-    private firstPersonMode;
-    private reusableCamera;
-    private reusableVector3;
-    private _accumulatedMouseMove;
-    private domElement;
-    private target;
-    private targetEnd;
-    private spherical;
-    private sphericalEnd;
-    private deltaTarget;
-    private keyboard;
-    private offsetVector;
-    private panVector;
-    private raycaster;
-    private targetFPS;
-    private targetFPSOverActualFPS;
-    private isFocused;
-    constructor(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement);
-    update: (deltaTime: number) => boolean;
-    getState: () => {
-        target: Vector3;
-        position: Vector3;
-    };
-    setState: (position: Vector3, target: Vector3) => void;
-    triggerCameraChangeEvent: () => void;
-    private onMouseDown;
-    private onMouseUp;
-    private onMouseWheel;
-    private onTouchStart;
-    private onFocusChanged;
-    private onContextMenu;
-    private rotate;
-    private startMouseRotation;
-    private startMousePan;
-    private startTouchRotation;
-    private startTouchPinch;
-    private handleKeyboard;
-    private rotateSpherical;
-    private rotateFirstPersonMode;
-    private pan;
-    private dollyOrthographicCamera;
-    private dollyPerspectiveCamera;
-    private dolly;
-    private getDollyDeltaDistance;
-    private panLeft;
-    private panUp;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { EventDispatcher, Vector3, PerspectiveCamera, OrthographicCamera } from 'three';
+export default class ComboControls extends EventDispatcher {
+    enabled: boolean;
+    enableDamping: boolean;
+    dampingFactor: number;
+    dynamicTarget: boolean;
+    minDistance: number;
+    maxDistance: number;
+    dollyFactor: number;
+    minPolarAngle: number;
+    maxPolarAngle: number;
+    minAzimuthAngle: number;
+    maxAzimuthAngle: number;
+    panDollyMinDistanceFactor: number;
+    firstPersonRotationFactor: number;
+    pointerRotationSpeedAzimuth: number;
+    pointerRotationSpeedPolar: number;
+    enableKeyboardNavigation: boolean;
+    keyboardRotationSpeedAzimuth: number;
+    keyboardRotationSpeedPolar: number;
+    mouseFirstPersonRotationSpeed: number;
+    keyboardDollySpeed: number;
+    keyboardPanSpeed: number;
+    keyboardSpeedFactor: number;
+    pinchEpsilon: number;
+    pinchPanSpeed: number;
+    EPSILON: number;
+    dispose: () => void;
+    minZoom: number;
+    maxZoom: number;
+    orthographicCameraDollyFactor: number;
+    private temporarilyDisableDamping;
+    private readonly camera;
+    private firstPersonMode;
+    private readonly reusableCamera;
+    private readonly reusableVector3;
+    private readonly _accumulatedMouseMove;
+    private readonly domElement;
+    private readonly target;
+    private readonly targetEnd;
+    private readonly spherical;
+    private sphericalEnd;
+    private readonly deltaTarget;
+    private keyboard;
+    private readonly offsetVector;
+    private readonly panVector;
+    private readonly raycaster;
+    private readonly targetFPS;
+    private targetFPSOverActualFPS;
+    private isFocused;
+    constructor(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement);
+    update: (deltaTime: number) => boolean;
+    getState: () => {
+        target: Vector3;
+        position: Vector3;
+    };
+    setState: (position: Vector3, target: Vector3) => void;
+    triggerCameraChangeEvent: () => void;
+    private calculateShortestDeltaTheta;
+    private readonly onMouseDown;
+    private readonly onMouseUp;
+    private readonly onMouseWheel;
+    private readonly onTouchStart;
+    private readonly onFocusChanged;
+    private readonly onContextMenu;
+    private readonly rotate;
+    private readonly startMouseRotation;
+    private readonly startMousePan;
+    private readonly startTouchRotation;
+    private readonly startTouchPinch;
+    private readonly handleKeyboard;
+    private readonly rotateSpherical;
+    private readonly rotateFirstPersonMode;
+    private readonly pan;
+    private readonly dollyOrthographicCamera;
+    private readonly dollyPerspectiveCamera;
+    private readonly dolly;
+    private readonly getDollyDeltaDistance;
+    private readonly panLeft;
+    private readonly panUp;
+}

package/packages/camera-manager/src/Keyboard.d.ts

@@ -1,14 +1,14 @@
-export default class Keyboard {
-    private keys;
-    private _disabled;
-    get disabled(): boolean;
-    set disabled(isDisabled: boolean);
-    constructor();
-    isPressed: (key: string) => boolean;
-    comsumePressed: (key: string) => boolean;
-    private addEventListeners;
-    private removeEventListeners;
-    private onKeydown;
-    private onKeyup;
-    private clearPressedKeys;
-}
+export default class Keyboard {
+    private keys;
+    private _disabled;
+    get disabled(): boolean;
+    set disabled(isDisabled: boolean);
+    constructor();
+    isPressed: (key: string) => boolean;
+    comsumePressed: (key: string) => boolean;
+    private readonly addEventListeners;
+    private readonly removeEventListeners;
+    private readonly onKeydown;
+    private readonly onKeyup;
+    private readonly clearPressedKeys;
+}

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

@@ -0,0 +1,6 @@
+/*!
+ * 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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,26 @@
+/*!
+ * 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.
+ * @version New since 2.2
+ */
+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

@@ -0,0 +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;
+}

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

@@ -0,0 +1,5 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { MetricsLogger } from './src/MetricsLogger';
+export { EventProps, TrackedEvents } from './src/types';

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

@@ -0,0 +1,21 @@
+/*!
+ * 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): void;
+    static trackCadModelStyled(nodeCollectionClassToken: string, appearance: any): void;
+    static trackError(error: Error, eventProps: EventProps): void;
+    static trackCameraNavigation(eventProps: EventProps): void;
+}

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

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

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

@@ -1,8 +1,13 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-export { CdfModelDataClient } from './src/CdfModelDataClient';
-export { CdfModelMetadataProvider } from './src/CdfModelMetadataProvider';
-export { LocalModelDataClient } from './src/LocalModelDataClient';
-export { LocalModelMetadataProvider } from './src/LocalModelMetadataProvider';
-export { ModelDataClient, LocalModelIdentifier, CdfModelIdentifier, BinaryFileProvider, HttpHeadersProvider, ModelMetadataProvider, File3dFormat } from './src/types';
+/*!
+ * Copyright 2021 Cognite AS
+ */
+export { CdfModelDataProvider } from './src/CdfModelDataProvider';
+export { CdfModelIdentifier } from './src/CdfModelIdentifier';
+export { CdfModelMetadataProvider } from './src/CdfModelMetadataProvider';
+export { CdfModelOutputsProvider } from './src/CdfModelOutputsProvider';
+export { LocalModelDataProvider } from './src/LocalModelDataProvider';
+export { LocalModelIdentifier } from './src/LocalModelIdentifier';
+export { LocalModelMetadataProvider } from './src/LocalModelMetadataProvider';
+export { ModelIdentifier } from './src/ModelIdentifier';
+export { ModelMetadataProvider } from './src/ModelMetadataProvider';
+export { BinaryFileProvider, File3dFormat, HttpHeadersProvider, ModelDataProvider } from './src/types';

package/packages/modeldata-api/src/{CdfModelDataClient.d.ts → CdfModelDataProvider.d.ts}

@@ -1,17 +1,15 @@
-/*!
- * Copyright 2021 Cognite AS
- */
-import { CogniteClient } from '@cognite/sdk';
-import { ModelDataClient } from './types';
-/**
- * Provides 3D V2 specific extensions for the standard CogniteClient used by Reveal.
- */
-export declare class CdfModelDataClient implements ModelDataClient {
-    private readonly client;
-    private appId;
-    constructor(client: CogniteClient);
-    get headers(): import("@cognite/sdk").HttpHeaders;
-    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
-    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
-    getApplicationIdentifier(): string;
-}
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { CogniteClient } from '@cognite/sdk';
+import { ModelDataProvider } from './types';
+/**
+ * Provides 3D V2 specific extensions for the standard CogniteClient used by Reveal.
+ */
+export declare class CdfModelDataProvider implements ModelDataProvider {
+    private readonly client;
+    constructor(client: CogniteClient);
+    get headers(): import("@cognite/sdk").HttpHeaders;
+    getBinaryFile(baseUrl: string, fileName: string): Promise<ArrayBuffer>;
+    getJsonFile(baseUrl: string, fileName: string): Promise<any>;
+}

package/packages/modeldata-api/src/CdfModelIdentifier.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * Copyright 2021 Cognite AS
+ */
+import { ModelIdentifier } from '..';
+import { File3dFormat } from './types';
+/**
+ * Identifies a 3D model stored in CDF by the combination of a modelId, a revisionId
+ * and a format.
+ */
+export declare class CdfModelIdentifier implements ModelIdentifier {
+    readonly revealInternalId: symbol;
+    readonly modelFormat: File3dFormat;
+    readonly modelId: number;
+    readonly revisionId: number;
+    constructor(modelId: number, revisionId: number, modelFormat: File3dFormat);
+    toString(): string;
+}