Chore: Rename viewers (#29)

* chore: renaming viewers. consistent 3D naming

* chore: renamed Box3DUiUtils -> Box3DUIUtils

src/lib/Preview.js

@@ -10,7 +10,7 @@ import Logger from './Logger';
 import loaderList from './loaders';
 import cache from './Cache';
 import ProgressBar from './ProgressBar';
-import PreviewError from './viewers/error/PreviewError';
+import PreviewErrorViewer from './viewers/error/PreviewErrorViewer';
 import getTokens from './tokens';
 import {
     get,
@@ -1057,7 +1057,7 @@ class Preview extends EventEmitter {
      * @return {PreviewError} PreviewError instance
      */
     getErrorViewer() {
-        return new PreviewError(this.createViewerOptions({
+        return new PreviewErrorViewer(this.createViewerOptions({
             viewer: { NAME: 'Error' },
             container: this.container,
             file: this.file

src/lib/loaders.js

@@ -5,7 +5,7 @@ import TextLoader from './viewers/text/TextLoader';
 import MediaLoader from './viewers/media/MediaLoader';
 import Video360Loader from './viewers/box3d/video360/Video360Loader';
 import DocLoader from './viewers/doc/DocLoader';
-import Model3dLoader from './viewers/box3d/model3d/Model3dLoader';
+import Model3DLoader from './viewers/box3d/model3d/Model3DLoader';
 import IFrameLoader from './viewers/iframe/IFrameLoader';
 import OfficeLoader from './viewers/office/OfficeLoader';
 
@@ -19,6 +19,6 @@ export default [
     MediaLoader,
     Image360Loader,
     ImageLoader,
-    Model3dLoader,
+    Model3DLoader,
     IFrameLoader
 ];

src/lib/viewers/Base.js → src/lib/viewers/BaseViewer.js

@@ -25,13 +25,13 @@ const LOAD_TIMEOUT_MS = 180000; // 3m
 const RESIZE_WAIT_TIME_IN_MILLIS = 300;
 
 @autobind
-class Base extends EventEmitter {
+class BaseViewer extends EventEmitter {
     /**
      * [constructor]
      *
      * @param {HTMLElement} containerEl - The container
      * @param {Object} options - some options
-     * @return {Base} Instance of base
+     * @return {BaseViewer} Instance of base viewer
      */
     constructor(options) {
         super();
@@ -480,4 +480,4 @@ class Base extends EventEmitter {
     }
 }
 
-export default Base;
+export default BaseViewer;

src/lib/viewers/__tests__/Base-test.js → src/lib/viewers/__tests__/BaseViewer-test.js

@@ -1,6 +1,6 @@
 /* eslint-disable no-unused-expressions */
 import EventEmitter from 'events';
-import Base from '../Base';
+import BaseViewer from '../BaseViewer';
 import Browser from '../../Browser';
 import RepStatus from '../../RepStatus';
 import fullscreen from '../../Fullscreen';
@@ -10,7 +10,7 @@ let base;
 let containerEl;
 const sandbox = sinon.sandbox.create();
 
-describe('lib/viewers/Base', () => {
+describe('lib/viewers/BaseViewer', () => {
     before(() => {
         fixture.setBase('src/lib');
     });
@@ -19,7 +19,7 @@ describe('lib/viewers/Base', () => {
         fixture.load('viewers/__tests__/Base-test.html');
 
         containerEl = document.querySelector('.bp-container');
-        base = new Base({
+        base = new BaseViewer({
             container: containerEl,
             file: {
                 id: '0'
@@ -132,7 +132,7 @@ describe('lib/viewers/Base', () => {
             const sharedLinkPassword = 'pass';
             const url = 'url';
 
-            base = new Base({
+            base = new BaseViewer({
                 token,
                 sharedLink,
                 sharedLinkPassword,
@@ -162,7 +162,7 @@ describe('lib/viewers/Base', () => {
         it('should return content url with asset path from args', () => {
             const url = 'url{asset_path}';
 
-            base = new Base({
+            base = new BaseViewer({
                 viewer: { ASSET: 'foo' },
                 container: containerEl,
                 file: {
@@ -195,7 +195,7 @@ describe('lib/viewers/Base', () => {
             const sharedLinkPassword = 'pass';
             const headers = {};
 
-            base = new Base({
+            base = new BaseViewer({
                 token,
                 sharedLink,
                 sharedLinkPassword,
@@ -291,7 +291,7 @@ describe('lib/viewers/Base', () => {
             const data = {};
             const viewerName = 'name';
 
-            base = new Base({
+            base = new BaseViewer({
                 viewer: { NAME: viewerName },
                 file: {
                     id: fileId
@@ -319,7 +319,7 @@ describe('lib/viewers/Base', () => {
         let event = {};
 
         beforeEach(() => {
-            base = new Base({
+            base = new BaseViewer({
                 container: containerEl,
                 file: {
                     id: '123'

src/lib/viewers/box3d/Box3dControls.js → src/lib/viewers/box3d/Box3DControls.js

@@ -6,15 +6,15 @@ import {
     EVENT_SCENE_LOADED,
     EVENT_TOGGLE_FULLSCREEN,
     EVENT_TOGGLE_VR
-} from './Box3dConstants';
+} from './box3DConstants';
 import {
     ICON_FULLSCREEN_IN,
     ICON_FULLSCREEN_OUT,
     ICON_3D_VR
 } from '../../icons/icons';
 
 import { CLASS_HIDDEN } from '../../constants';
-import { UIRegistry } from './Box3dUiUtils';
+import { UIRegistry } from './Box3DUIUtils';
 
 @autobind
 class Box3DControls extends EventEmitter {

src/lib/viewers/box3d/Box3dRenderer.js → src/lib/viewers/box3d/Box3DRenderer.js

@@ -5,7 +5,7 @@ import {
     EVENT_SHOW_VR_BUTTON,
     EVENT_SCENE_LOADED,
     EVENT_TRIGGER_RENDER
-} from './Box3dConstants';
+} from './box3DConstants';
 import { MODEL3D_STATIC_ASSETS_VERSION } from '../../constants';
 
 const PREVIEW_CAMERA_CONTROLLER_ID = 'orbit_camera';

src/lib/viewers/box3d/Box3dUiUtils.js → src/lib/viewers/box3d/Box3DUIUtils.js

@@ -4,7 +4,7 @@ import {
     CSS_CLASS_SETTINGS_PANEL_LABEL,
     CSS_CLASS_SETTINGS_PANEL_ROW,
     CSS_CLASS_HIDDEN
-} from './model3d/Model3dConstants';
+} from './model3d/model3DConstants';
 
 import {
     CLASS_BOX_PREVIEW_BUTTON,

src/lib/viewers/box3d/Box3d.js → src/lib/viewers/box3d/Box3DViewer.js

@@ -1,8 +1,8 @@
 import autobind from 'autobind-decorator';
-import Base from '../Base';
+import BaseViewer from '../BaseViewer';
 import fullscreen from '../../Fullscreen';
-import Box3DControls from './Box3dControls';
-import Box3DRenderer from './Box3dRenderer';
+import Box3DControls from './Box3DControls';
+import Box3DRenderer from './Box3DRenderer';
 import Browser from '../../Browser';
 import { get } from '../../util';
 import {
@@ -14,22 +14,22 @@ import {
     EVENT_SHOW_VR_BUTTON,
     EVENT_TOGGLE_FULLSCREEN,
     EVENT_TOGGLE_VR
-} from './Box3dConstants';
-import JS from './box3dAssets';
-import './Box3d.scss';
+} from './box3DConstants';
+import JS from './box3DAssets';
+import './Box3D.scss';
 
 // Milliseconds to wait for model to load before cancelling Preview
 const LOAD_TIMEOUT = 50000;
 
 const CLASS_VR_ENABLED = 'vr-enabled';
 
 /**
- * Box3D
+ * Box3DViewer
  * This is the entry point for Box3D Preview Base
  * @class
  */
 @autobind
-class Box3D extends Base {
+class Box3DViewer extends BaseViewer {
     /**
      * @inheritdoc
      */
@@ -290,4 +290,4 @@ class Box3D extends Base {
     }
 }
 
-export default Box3D;
+export default Box3DViewer;

src/lib/viewers/box3d/__tests__/Box3dControls-test.js → src/lib/viewers/box3d/__tests__/Box3DControls-test.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-unused-expressions */
-import Box3DControls from '../Box3dControls';
+import Box3DControls from '../Box3DControls';
 import Controls from '../../../Controls';
-import { UIRegistry } from '../Box3dUiUtils';
+import { UIRegistry } from '../Box3DUIUtils';
 import { CLASS_HIDDEN } from '../../../constants';
 import {
     ICON_FULLSCREEN_IN,
@@ -13,20 +13,20 @@ import {
     EVENT_SCENE_LOADED,
     EVENT_TOGGLE_FULLSCREEN,
     EVENT_TOGGLE_VR
-} from '../Box3dConstants';
+} from '../box3DConstants';
 
 const sandbox = sinon.sandbox.create();
 
 let containerEl;
 let controls;
 
-describe('lib/viewers/box3d/Box3dControls', () => {
+describe('lib/viewers/box3d/Box3DControls', () => {
     before(() => {
         fixture.setBase('src/lib');
     });
 
     beforeEach(() => {
-        fixture.load('viewers/box3d/__tests__/Box3dControls-test.html');
+        fixture.load('viewers/box3d/__tests__/Box3DControls-test.html');
         containerEl = document.querySelector('.container');
         controls = new Box3DControls(containerEl);
     });

src/lib/viewers/box3d/__tests__/Box3dRenderer-test.js → src/lib/viewers/box3d/__tests__/Box3DRenderer-test.js

@@ -1,7 +1,7 @@
 /* global Box3D */
 /* eslint-disable no-unused-expressions */
-import Box3DRenderer from '../Box3dRenderer';
-import { EVENT_SHOW_VR_BUTTON } from '../Box3dConstants';
+import Box3DRenderer from '../Box3DRenderer';
+import { EVENT_SHOW_VR_BUTTON } from '../box3DConstants';
 
 const sandbox = sinon.sandbox.create();
 const PREVIEW_CAMERA_CONTROLLER_ID = 'orbit_camera';
@@ -10,13 +10,13 @@ let containerEl;
 let renderer;
 let stubs = {};
 
-describe('lib/viewers/box3d/Box3dRenderer', () => {
+describe('lib/viewers/box3d/Box3DRenderer', () => {
     before(() => {
         fixture.setBase('src/lib');
     });
 
     beforeEach(() => {
-        fixture.load('viewers/box3d/__tests__/Box3dRenderer-test.html');
+        fixture.load('viewers/box3d/__tests__/Box3DRenderer-test.html');
         stubs.THREE = sandbox.stub(window, 'THREE');
         containerEl = document.querySelector('.container');
         renderer = new Box3DRenderer(containerEl, {});

src/lib/viewers/box3d/__tests__/Box3dUiUtils-test.js → src/lib/viewers/box3d/__tests__/Box3DUIUtils-test.js

@@ -7,15 +7,15 @@ import {
     createPullup,
     createRow,
     UIRegistry
-} from '../Box3dUiUtils';
+} from '../Box3DUIUtils';
 
 import {
     CSS_CLASS_OVERLAY,
     CSS_CLASS_PULLUP,
     CSS_CLASS_SETTINGS_PANEL_LABEL,
     CSS_CLASS_SETTINGS_PANEL_ROW,
     CSS_CLASS_HIDDEN
-} from '../model3d/Model3dConstants';
+} from '../model3d/model3DConstants';
 
 
 import {
@@ -31,13 +31,13 @@ const sandbox = sinon.sandbox.create();
 
 let containerEl;
 
-describe('lib/viewers/box3d/Box3dUiUtils', () => {
+describe('lib/viewers/box3d/Box3DUIUtils', () => {
     before(() => {
         fixture.setBase('src/lib');
     });
 
     beforeEach(() => {
-        fixture.load('viewers/box3d/__tests__/Box3dUiUtils-test.html');
+        fixture.load('viewers/box3d/__tests__/Box3DUIUtils-test.html');
         containerEl = document.querySelector('.container');
     });