Skip to content

Commit

Permalink
fix(composer)!: remove deprecated and internal interfaces from public
Browse files Browse the repository at this point in the history
  • Loading branch information
sheilaXu committed Feb 7, 2024
1 parent a2e140a commit 07e82b4
Show file tree
Hide file tree
Showing 17 changed files with 27 additions and 234 deletions.
2 changes: 1 addition & 1 deletion packages/scene-composer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"convert-svg": "npx @svgr/cli --out-dir src/assets/auto-gen/icons/ --typescript --index-template tools/index-template.js -- src/assets/icons/",
"release": "run-s compile copy-assets",
"copy-assets": "copyfiles -e \"**/*.tsx\" -e \"**/*.ts\" -e \"**/*.snap\" -e \"**/*.js\" -e \"**/*.jsx\" -e \"**/*.json\" \"src/**/*\" dist/",
"lint": "eslint . --max-warnings=484",
"lint": "eslint . --max-warnings=476",
"fix": "eslint --fix .",
"test": "jest --config jest.config.ts --coverage --silent",
"test:dev": "jest --config jest.config.ts --coverage",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ import str2ab from 'string-to-arraybuffer';
import flushPromises from 'flush-promises';
import { Object3D, Event, Mesh, MeshBasicMaterial, Color } from 'three';

import { SceneComposerInternal, useSceneComposerApi, SceneComposerApi } from '..';
import { useSceneComposerApi, SceneComposerApi } from '..';
import { testScenes } from '../../tests/testData';
import { useStore } from '../store';

import { SceneComposerInternal } from './SceneComposerInternal';

jest.mock('../layouts/StaticLayout', () => ({
StaticLayout: 'StaticLayout',
}));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,15 @@ import { sceneComposerIdContext } from '../common/sceneComposerIdContext';
import LogProvider from '../logger/react-logger/log-provider';
import { GlobalStyles } from '../GlobalStyles';
import useAwsLightDarkModes from '../hooks/useAwsLightDarkModes';
import { KnownComponentType, SceneComposerInternalProps, StyleTarget } from '../interfaces';
import { KnownComponentType, StyleTarget } from '../interfaces';
import { materialReducer, initialMaterialMaps, addMaterial, removeMaterial, backUpOriginalMaterial } from '../reducers';
import { useStore } from '../store';
import { IDataBoundSceneComponentInternal, ISceneComponentInternal } from '../store/internalInterfaces';
import { darkTheme, lightTheme } from '../theme';
import { containsMatchingEntityComponent } from '../utils/dataBindingUtils';
import { generateUUID } from '../utils/mathUtils';
import { createMaterialFromStyle } from '../utils/objectThreeStyleUtils';
import { SceneComposerInternalProps } from '../interfaces/sceneComposerInternal';

import StateManager from './StateManager';
import DefaultErrorFallback from './DefaultErrorFallback';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@ import { create, act } from 'react-test-renderer';
import str2ab from 'string-to-arraybuffer';
import flushPromises from 'flush-promises';

import { SceneComposerInternal } from '..';
import * as SceneLayoutComponents from '../layouts/SceneLayout';
import { invalidTestScenes, testScenes } from '../../tests/testData';

import { SceneComposerInternal } from './SceneComposerInternal';

jest.mock('../layouts/StaticLayout', () => ({
StaticLayout: 'StaticLayout',
}));
Expand Down
4 changes: 3 additions & 1 deletion packages/scene-composer/src/components/StateManager.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@ import DefaultErrorFallback from './DefaultErrorFallback';
import { numberStream, stringStream, viewport } from '../../tests/data/mockDataStreams';
import { DataStream } from '@iot-app-kit/core';
import useActiveCamera from '../hooks/useActiveCamera';
import { KnownComponentType, SceneComposerInternalConfig, setMatterportSdk } from '..';
import { KnownComponentType } from '..';
import * as THREE from 'three';
import { SCENE_CAPABILITY_MATTERPORT } from '../common/constants';
import { TwinMakerSceneMetadataModule } from '@iot-app-kit/source-iottwinmaker';
import { MpSdk } from '@matterport/webcomponent';
import { SceneComposerInternalConfig } from '../interfaces/sceneComposerInternal';
import { setMatterportSdk } from '../common/GlobalSettings';

jest.mock('../hooks/useActiveCamera', () => {
return jest.fn().mockReturnValue({
Expand Down
10 changes: 2 additions & 8 deletions packages/scene-composer/src/components/StateManager.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,7 @@ import { DisplayMessageCategory } from '../store/internalInterfaces';
import { useSceneComposerId } from '../common/sceneComposerIdContext';
import useActiveCamera from '../hooks/useActiveCamera';
import useMatterportViewer from '../hooks/useMatterportViewer';
import {
AdditionalComponentData,
COMPOSER_FEATURES,
ExternalLibraryConfig,
KnownComponentType,
KnownSceneProperty,
SceneComposerInternalProps,
} from '../interfaces';
import { AdditionalComponentData, ExternalLibraryConfig, KnownComponentType, KnownSceneProperty } from '../interfaces';
import { SceneLayout } from '../layouts/SceneLayout';
import useLifecycleLogging from '../logger/react-logger/hooks/useLifecycleLogging';
import { ICameraComponentInternal, RootState, useStore, useViewOptionState } from '../store';
Expand All @@ -48,6 +41,7 @@ import { combineTimeSeriesData, convertDataStreamsToDataInput } from '../utils/d
import { findComponentByType } from '../utils/nodeUtils';
import sceneDocumentSnapshotCreator from '../utils/sceneDocumentSnapshotCreator';
import { createStandardUriModifier } from '../utils/uriModifiers';
import { SceneComposerInternalProps } from '../interfaces/sceneComposerInternal';

import IntlProvider from './IntlProvider';
import { LoadingProgress } from './three-fiber/LoadingProgress';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,13 @@ import {
IModelRefComponent,
IMotionIndicatorComponent,
KnownComponentType,
setFeatureConfig,
setMetricRecorder,
} from '../../../..';
import { CameraType, Component, LightType } from '../../../../models/SceneModels';
import { createNodeWithTransform } from '../../../../utils/nodeUtils';
import { ToolbarOrientation } from '../../common/types';
import { isDynamicScene } from '../../../../utils/entityModelUtils/sceneUtils';
import { TILESET_JSON } from '../../../../utils/sceneAssetUtils';
import { setFeatureConfig, setMetricRecorder } from '../../../../common/GlobalSettings';
/* eslint-enable */

jest.mock('../../../../utils/entityModelUtils/sceneUtils', () => ({
Expand Down
10 changes: 2 additions & 8 deletions packages/scene-composer/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ export * from './interfaces';

export * from './common/errors';

export * from './components/SceneComposerInternal';
export { useSceneComposerApi } from './components/SceneComposerInternal';
export type { SceneComposerApi } from './components/SceneComposerInternal';

export * from './SceneViewer';

Expand All @@ -11,13 +12,6 @@ export type { Scene } from './models/SceneModels';
// Augmentation related interfaces
export * from './augmentations/three';

export * from './common/GlobalSettings';

/**
* @deprecated To be removed in new version
*/
export * from './utils/dataFrameLabelUtils';

export * from './utils/dataBindingTemplateUtils';

export * from './common/constants';
1 change: 0 additions & 1 deletion packages/scene-composer/src/interfaces/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,5 @@ export * from './dataTypes';
export * from './dataBinding';
export * from './metricRecorder';
export * from './feature';
export * from './sceneComposerInternal';
export * from './sceneViewer';
export * from './componentSettings';
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ export type ShowAssetBrowserCallback = (callback: AssetBrowserResultCallback, ty

export interface SceneComposerInternalProps extends SceneViewerPropsShared {
onSceneUpdated?: OnSceneUpdateCallback;
onSceneLoaded?: () => void;

showAssetBrowserCallback?: ShowAssetBrowserCallback;

Expand Down
1 change: 1 addition & 0 deletions packages/scene-composer/src/interfaces/sceneViewer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export interface SceneViewerPropsShared {

onSelectionChanged?: SelectionChangedEventCallback;
onWidgetClick?: WidgetClickEventCallback;
onSceneLoaded?: () => void;

/**
* The data to be visualized by the composer.
Expand Down
3 changes: 1 addition & 2 deletions packages/scene-composer/src/store/internalInterfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,6 @@ import {
ITransformConstraint,
IValueDataBinding,
IValueDataBindingProvider,
OperationMode,
ShowAssetBrowserCallback,
URIModifier,
KnownComponentType,
WidgetClickEventCallback,
Expand All @@ -27,6 +25,7 @@ import {
IEntityBindingComponent,
IPlaneGeometryComponent,
} from '../interfaces';
import { OperationMode, ShowAssetBrowserCallback } from '../interfaces/sceneComposerInternal';
import { MapControls as MapControlsImpl, OrbitControls as OrbitControlsImpl } from '../three/OrbitControls';
import { PointerLockControls as PointerLockControlsImpl } from '../three/PointerLockControls';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import flushPromises from 'flush-promises';
import { Object3D, Vector3 } from 'three';

import { IAnchorComponentInternal, IDataOverlayComponentInternal, ISceneNodeInternal } from '..';
import { COMPOSER_FEATURES, IErrorDetails, KnownComponentType, KnownSceneProperty, setFeatureConfig } from '../..';
import { COMPOSER_FEATURES, IErrorDetails, KnownComponentType, KnownSceneProperty } from '../..';
import { Component } from '../../models/SceneModels';
import { containsMatchingEntityComponent } from '../../utils/dataBindingUtils';
import { deleteNodeEntity } from '../../utils/entityModelUtils/deleteNodeEntity';
Expand All @@ -16,6 +16,7 @@ import { DisplayMessageCategory, SceneNodeRuntimeProperty } from '../internalInt
import { appendSceneNode } from '../helpers/sceneDocumentHelpers';
import { createNodeEntity } from '../../utils/entityModelUtils/createNodeEntity';
import { updateSceneRootEntity } from '../../utils/entityModelUtils/sceneUtils';
import { setFeatureConfig } from '../../common/GlobalSettings';

import { createSceneDocumentSlice } from './SceneDocumentSlice';

Expand Down
108 changes: 0 additions & 108 deletions packages/scene-composer/src/utils/dataFrameLabelUtils.ts

This file was deleted.

8 changes: 7 additions & 1 deletion packages/scene-composer/tests/GlobalSettings.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
import { getGlobalSettings, setDebugMode, setDracoDecoder, setMetricRecorder, setFeatureConfig } from '../src';
import {
getGlobalSettings,
setDebugMode,
setDracoDecoder,
setMetricRecorder,
setFeatureConfig,
} from '../src/common/GlobalSettings';

describe('GlobalSettings', () => {
it('should be able to setDebugMode', () => {
Expand Down
7 changes: 0 additions & 7 deletions packages/scene-composer/tests/index.spec.tsx

This file was deleted.

0 comments on commit 07e82b4

Please sign in to comment.