@cognite/reveal-components 1.0.0

package/dist/utilities/queryKeys.js

@@ -0,0 +1,108 @@
+import { createFdmKey as e } from "../data-providers/cache/idAndKeyTranslation.js";
+import { createInstanceReferenceKey as t } from "./instanceIds/toKey.js";
+import "./instanceIds/index.js";
+import { getModelKeys as n } from "./getModelKeys.js";
+//#region libs/shared/reveal-components/src/utilities/queryKeys.ts
+var r = {
+	all: ["cdf"],
+	all3DResources: () => [...r.all, "all-3d-resources"],
+	assetsById: (e) => [...i, e],
+	assetsByIdsWithFilter: (e, t) => [...r.assetsById(e), t],
+	dmNodesById: (t) => [...a, t.map(e).sort()],
+	poiCommentsById: (e) => [...s, e],
+	timeseriesById: (e) => [...c, e],
+	timeseriesLatestDatapoint: () => [...c, "latest-datapoints"],
+	timeseriesLinkedToAssets: () => [...c, "timeseries-linked-assets"],
+	assetsAndTimeseriesLinkageData: (e, t, n) => [
+		...c,
+		"assets-and-timeseries-linkage-data",
+		e,
+		t,
+		n
+	],
+	fdmConnectionWithNode: (t, r) => [
+		"fdm-connection-with-node",
+		t.map(e).sort(),
+		n(r).sort()
+	],
+	pointCloudAnnotationMappings: (e) => [
+		...l,
+		"point-cloud-annotation-mappings",
+		e
+	],
+	pointCloudAnnotationForAssetInstances: (e, t) => [
+		...l,
+		...i,
+		"point-cloud-all-annotations",
+		e,
+		t
+	],
+	pointCloudAnnotationForAssetId: (e, t) => [
+		...l,
+		...i,
+		"asset-annotation-mapping-for-a-model",
+		e,
+		t
+	],
+	pointCloudDMVolumeMappings: (e) => [
+		...l,
+		"point-cloud-dm-volume-mappings",
+		e
+	],
+	pointCloudDMVolumeAssetMappings: (e, t) => [
+		...l,
+		...o,
+		"point-cloud-dm-volume-asset-mappings",
+		e,
+		t
+	],
+	pointCloudDMModelIdRevisionIds: (e) => [
+		...l,
+		"point-cloud-dm-model-id-revision-ids",
+		e
+	],
+	pointCloudDMVolumeAssetMappingsWithViews: (e) => [
+		...i,
+		"point-cloud-dm-volume-asset-mappings-with-views",
+		e
+	],
+	modelRevisionId: (e) => [
+		...u,
+		"model-revision-id",
+		e
+	],
+	timeseriesFromRelationship: () => [...c, "timeseries-relationship"],
+	modelsForAssetPerInstanceReference: (e) => [
+		"react-components",
+		"models-for-assets-per-instance-reference",
+		e ? t(e) : void 0
+	],
+	hybridDmAssetMappingsForInstances: (t, n) => [
+		"react-components",
+		"hybrid-dm-asset-mappings-for-instances",
+		t,
+		n.map(e).sort()
+	],
+	image360AnnotationMappingsForInstanceReferences: (e = [], n = []) => [
+		"reveal",
+		"react-components",
+		"image360-annotations-info",
+		...e.map(t).sort(),
+		...n.sort()
+	],
+	image360AnnotationsMappings: (e = [], n = [], r = []) => [
+		"image360",
+		"annotations-mappings",
+		...e.map(t).sort(),
+		...n,
+		...r.sort()
+	],
+	scenes: () => [
+		"reveal-components",
+		...r.all,
+		"3d",
+		"scenes"
+	]
+}, i = [...r.all, "assets"], a = [...r.all, "dm"], o = [...r.all, "asset-instance-refs"], s = [...r.all, "pois"], c = [...r.all, "timeseries"], l = [...r.all, "models"], u = [...r.all, "revisions"];
+//#endregion
+export { r as queryKeys };

package/dist/utilities/removeEmptyProperties.d.ts

@@ -0,0 +1,2 @@
+import { NodeItem } from '../data-providers/FdmSDK';
+export declare function removeEmptyProperties(queryResultNode: NodeItem): NodeItem;

package/dist/utilities/removeEmptyProperties.js

@@ -0,0 +1,12 @@
+//#region libs/shared/reveal-components/src/utilities/removeEmptyProperties.ts
+function e(e) {
+	return Object.keys(e.properties).forEach((t) => {
+		let n = e.properties[t], r = {};
+		Object.keys(n).forEach((e) => {
+			let t = n[e];
+			Object.keys(t).length !== 0 && (r[e] = t);
+		}), e.properties[t] = r;
+	}), e;
+}
+//#endregion
+export { e as removeEmptyProperties };

package/dist/utilities/resourceSettings.d.ts

@@ -0,0 +1,14 @@
+import { PointColorType, PointShape } from '@cognite/reveal';
+import { RevealSettingsController } from '../domains/reveal/RevealSettingsController';
+import { RevealRenderTarget } from '../foundation/renderTarget/RevealRenderTarget';
+import { QualitySettings } from '../foundation/utilities/quality/QualitySettings';
+import { SceneQualitySettings } from '../ui/components/SceneContainer/sceneTypes';
+export declare const DEFAULT_POINT_SIZE = 2;
+export declare const DEFAULT_POINT_SHAPE: PointShape;
+export declare const DEFAULT_POINT_COLOR_TYPE: PointColorType;
+export declare function applyResourceSettings(settingsController: RevealSettingsController, qualitySettings: SceneQualitySettings): void;
+export declare function mapPointShape(shapeString: string): PointShape;
+export declare function mapPointColorType(colorString: string): PointColorType;
+export declare function applyQualitySettingsToRenderTarget(renderTarget: RevealRenderTarget, qualitySettings: SceneQualitySettings): void;
+export declare function mergeQualitySettings(defaultSettings: QualitySettings, incoming: SceneQualitySettings): QualitySettings;
+export declare function resetRevealQualitySettings(renderTarget: RevealRenderTarget): void;

package/dist/utilities/resourceSettings.js

@@ -0,0 +1,57 @@
+import { DEFAULT_REVEAL_QUALITY_SETTINGS as e } from "../domains/reveal/constants.js";
+import { PointColorType as t, PointShape as n } from "@cognite/reveal";
+var r = n.Circle, i = t.Rgb;
+function a(e, t) {
+	if (t.pointCloudPointSize === void 0 ? e.pointSize(2) : e.pointSize(t.pointCloudPointSize), t.pointCloudPointShape !== void 0) {
+		let n = o(t.pointCloudPointShape);
+		e.pointShape(n);
+	}
+	if (t.pointCloudColor !== void 0) {
+		let n = s(t.pointCloudColor);
+		e.pointColorType(n);
+	}
+	t.image360Transparency !== void 0 && e.imagesOpacity(t.image360Transparency), t.image360MarkerAlpha !== void 0 && e.iconsOpacity(t.image360MarkerAlpha), t.image360MarkerVisible !== void 0 && e.isIconsVisible(t.image360MarkerVisible), t.image360XRay !== void 0 && e.isOccludedIconsVisible(t.image360XRay);
+}
+function o(e) {
+	switch (e) {
+		case "Circle": return n.Circle;
+		case "Square": return n.Square;
+		case "Paraboloid": return n.Paraboloid;
+		default: return n.Circle;
+	}
+}
+function s(e) {
+	switch (e) {
+		case "Rgb": return t.Rgb;
+		case "Depth": return t.Depth;
+		case "Height": return t.Height;
+		case "Intensity": return t.Intensity;
+		case "Lod": return t.Lod;
+		case "PointIndex": return t.PointIndex;
+		case "Classification": return t.Classification;
+		default: return t.Rgb;
+	}
+}
+function c(t, n) {
+	let r = t.revealSettingsController, i = l(e, n);
+	r.qualitySettings(i);
+}
+function l(e, t) {
+	return {
+		cadBudget: {
+			maximumRenderCost: t.cadBudget ?? e.cadBudget.maximumRenderCost,
+			highDetailProximityThreshold: e.cadBudget.highDetailProximityThreshold
+		},
+		pointCloudBudget: { numberOfPoints: t.pointCloudBudget ?? e.pointCloudBudget.numberOfPoints },
+		resolutionOptions: {
+			maxRenderResolution: t.maxRenderResolution ?? e.resolutionOptions.maxRenderResolution,
+			movingCameraResolutionFactor: t.movingCameraResolutionFactor ?? e.resolutionOptions.movingCameraResolutionFactor
+		}
+	};
+}
+function u(t) {
+	let n = t.revealSettingsController;
+	n.qualitySettings(e), n.pointSize(2), n.pointShape(r), n.pointColorType(i);
+}
+//#endregion
+export { i as DEFAULT_POINT_COLOR_TYPE, r as DEFAULT_POINT_SHAPE, c as applyQualitySettingsToRenderTarget, a as applyResourceSettings, s as mapPointColorType, o as mapPointShape, l as mergeQualitySettings, u as resetRevealQualitySettings };

package/dist/utilities/restrictToDmsId.d.ts

@@ -0,0 +1,2 @@
+import { DmsUniqueIdentifier } from '../data-providers/FdmSDK';
+export declare function restrictToDmsId<T extends DmsUniqueIdentifier>(identifier: T): DmsUniqueIdentifier;

package/dist/utilities/restrictToDmsId.js

@@ -0,0 +1,9 @@
+//#region libs/shared/reveal-components/src/utilities/restrictToDmsId.ts
+function e(e) {
+	return {
+		externalId: e.externalId,
+		space: e.space
+	};
+}
+//#endregion
+export { e as restrictToDmsId };

package/dist/utilities/restrictToViewReference.d.ts

@@ -0,0 +1,3 @@
+import { ViewDefinition } from '@cognite/sdk';
+import { Source } from '../data-providers/FdmSDK';
+export declare function restrictToViewReference(view: ViewDefinition): Source;

package/dist/utilities/restrictToViewReference.js

@@ -0,0 +1,11 @@
+//#region libs/shared/reveal-components/src/utilities/restrictToViewReference.ts
+function e(e) {
+	return {
+		externalId: e.externalId,
+		space: e.space,
+		version: e.version,
+		type: "view"
+	};
+}
+//#endregion
+export { e as restrictToViewReference };

package/dist/utilities/signal/DisposableSignal.d.ts

@@ -0,0 +1,5 @@
+import { ReadonlySignal } from '@cognite/signal-utils';
+export type DisposableSignal<T> = {
+    signal: ReadonlySignal<() => T>;
+    dispose: () => void;
+};

package/dist/utilities/signal/useDisposableSignal.d.ts

@@ -0,0 +1,2 @@
+import { DisposableSignal } from './DisposableSignal';
+export declare function useDisposableSignal<T>(disposableSignal: DisposableSignal<T>): T;

package/dist/utilities/signal/useDisposableSignal.js

@@ -0,0 +1,10 @@
+import { useEffect as e, useMemo as t } from "react";
+import { useSignalValue as n } from "@cognite/signal-utils/react";
+//#region libs/shared/reveal-components/src/utilities/signal/useDisposableSignal.ts
+function r(r) {
+	e(() => r.dispose, [r]);
+	let i = n(r.signal);
+	return t(() => i(), [i]);
+}
+//#endregion
+export { r as useDisposableSignal };

package/dist/utilities/styling/index.d.ts

@@ -0,0 +1 @@
+export type { TreeIndexStylingGroup, PointCloudModelStyling, CadStylingGroup, NodeStylingGroup, PointCloudVolumeStylingGroup, } from './stylingGroups';

package/dist/utilities/styling/stylingGroups.d.ts

@@ -0,0 +1,20 @@
+import { NodeAppearance, IndexSet, PointCloudAppearance, DMInstanceRef } from '@cognite/reveal';
+export type PointCloudVolumeStylingGroup = {
+    pointCloudVolumes: Array<number | DMInstanceRef>;
+    style: PointCloudAppearance;
+};
+export type PointCloudModelStyling = {
+    defaultStyle?: PointCloudAppearance;
+    groups?: PointCloudVolumeStylingGroup[];
+};
+export type NodeStylingGroup = {
+    nodeIds: number[];
+    style: NodeAppearance;
+};
+export type TreeIndexStylingGroup = {
+    treeIndexSet: IndexSet;
+    style: NodeAppearance;
+};
+export type CadStylingGroup = NodeStylingGroup | TreeIndexStylingGroup;
+export declare function isNodeStylingGroup(stylingGroup: CadStylingGroup): stylingGroup is NodeStylingGroup;
+export declare function isTreeIndexStylingGroup(stylingGroup: CadStylingGroup): stylingGroup is TreeIndexStylingGroup;

package/dist/utilities/styling/stylingGroups.js

@@ -0,0 +1,9 @@
+//#region libs/shared/reveal-components/src/utilities/styling/stylingGroups.ts
+function e(e) {
+	return "nodeIds" in e;
+}
+function t(e) {
+	return "treeIndexSet" in e;
+}
+//#endregion
+export { e as isNodeStylingGroup, t as isTreeIndexStylingGroup };

package/dist/utilities/tryGetModelIdFromExternalId.d.ts

@@ -0,0 +1,2 @@
+export declare function isCog3dModelExternalId(externalId: string): boolean;
+export declare function tryGetModelIdFromExternalId(externalId: string): number | undefined;

package/dist/utilities/tryGetModelIdFromExternalId.js

@@ -0,0 +1,14 @@
+import { getModelIdFromExternalId as e } from "../data-providers/core-dm-provider/getCdfIdFromExternalId.js";
+//#region libs/shared/reveal-components/src/utilities/tryGetModelIdFromExternalId.ts
+var t = "cog_3d_model_";
+function n(n) {
+	return n.startsWith(t) ? !isNaN(e(n)) : !1;
+}
+function r(t) {
+	let n = Number(t);
+	if (!isNaN(n)) return n;
+	let r = e(t);
+	if (!isNaN(r)) return r;
+}
+//#endregion
+export { n as isCog3dModelExternalId, r as tryGetModelIdFromExternalId };

package/package.json

@@ -0,0 +1,117 @@
+{
+  "name": "@cognite/reveal-components",
+  "version": "1.0.0",
+  "description": "React components, hooks, and data providers for building 3D applications on top of Cognite Reveal.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "imports": {
+    "#test-utils/*": "./src/__mocks__/*.ts",
+    "#test-components/*": "./src/__mocks__/*.tsx"
+  },
+  "exports": {
+    "./ui/components": {
+      "import": "./dist/ui/components/index.js",
+      "types": "./dist/ui/components/index.d.ts"
+    },
+    "./ui/hooks": {
+      "import": "./dist/ui/hooks/index.js",
+      "types": "./dist/ui/hooks/index.d.ts"
+    },
+    "./ui/query": {
+      "import": "./dist/ui/query/index.js",
+      "types": "./dist/ui/query/index.d.ts"
+    },
+    "./ui/higher-order-components": {
+      "import": "./dist/ui/higher-order-components/index.js",
+      "types": "./dist/ui/higher-order-components/index.d.ts"
+    },
+    "./data-providers": {
+      "import": "./dist/data-providers/index.js",
+      "types": "./dist/data-providers/index.d.ts"
+    },
+    "./data-providers/types": {
+      "import": "./dist/data-providers/types/index.js",
+      "types": "./dist/data-providers/types/index.d.ts"
+    },
+    "./data-providers/cache": {
+      "import": "./dist/data-providers/cache/index.js",
+      "types": "./dist/data-providers/cache/index.d.ts"
+    },
+    "./data-providers/utils": {
+      "import": "./dist/data-providers/utils/index.js",
+      "types": "./dist/data-providers/utils/index.d.ts"
+    },
+    "./utilities": {
+      "import": "./dist/utilities/index.js",
+      "types": "./dist/utilities/index.d.ts"
+    },
+    "./utilities/styling": {
+      "import": "./dist/utilities/styling/index.js",
+      "types": "./dist/utilities/styling/index.d.ts"
+    },
+    "./utilities/modelIds": {
+      "import": "./dist/utilities/modelIds/index.js",
+      "types": "./dist/utilities/modelIds/index.d.ts"
+    },
+    "./foundation/treeNodes": {
+      "import": "./dist/foundation/treeNodes/index.js",
+      "types": "./dist/foundation/treeNodes/index.d.ts"
+    },
+    "./foundation/utilities": {
+      "import": "./dist/foundation/utilities/index.js",
+      "types": "./dist/foundation/utilities/index.d.ts"
+    },
+    "./domains": {
+      "import": "./dist/domains/index.js",
+      "types": "./dist/domains/index.d.ts"
+    },
+    "./src/index.css": "./src/index.css"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@base-ui/react": "^1.6.0",
+    "@cognite/reveal": "4.36.0",
+    "@cognite/sdk": "^10.14.0",
+    "@floating-ui/react": "^0.24.8",
+    "@tabler/icons-react": "^3.35.0",
+    "@tanstack/react-query": "^4.43.0",
+    "dayjs": "^1.11.13",
+    "lodash-es": "^4.18.1",
+    "ml-matrix": "^6.12.1",
+    "random-seed": "^0.3.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "three": "0.184.0",
+    "@cognite/underscore": "1.0.0",
+    "@cognite/signal-utils": "1.0.0",
+    "@cognite/aura": "0.3.5"
+  },
+  "devDependencies": {
+    "@azure/msal-browser": "^2.31.0",
+    "@chromatic-com/storybook": "^5.1.2",
+    "@nx/eslint-plugin": "22.7.8",
+    "@storybook/addon-vitest": "10.3.5",
+    "@storybook/react-vite": "10.3.5",
+    "@tailwindcss/vite": "^4.3.1",
+    "@tanstack/react-query-devtools": "^4.43.0",
+    "@testing-library/jest-dom": "^6.4.6",
+    "@testing-library/react": "16.0.1",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/lodash-es": "^4.17.12",
+    "@types/react": "18.3.14",
+    "@types/react-dom": "18.3.2",
+    "@types/three": "0.184.1",
+    "@vitejs/plugin-react": "^5.2.0",
+    "@vitest/browser": "^4.1.10",
+    "@vitest/browser-playwright": "^4.1.10",
+    "eslint-plugin-i18next": "^6.1.3",
+    "moq.ts": "10.0.8",
+    "vite": "8.2.2",
+    "vitest": "^4.1.10"
+  }
+}