@threekit-tools/treble 0.0.80 → 0.0.83

package/dist/store/treble.js

@@ -50,7 +50,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.reloadPlayer = exports.unloadPlayer = exports.launch = exports.initPlayer = exports.getPlayerElementId = exports.isPlayerLoading = exports.isThreekitInitialized = exports.getThreekitEnv = exports.reloadTreble = exports.setPlayerElement = exports.setPlayerLoading = exports.setThreekitInitialized = exports.setThreekitEnv = void 0;
+exports.reloadPlayer = exports.unloadPlayer = exports.launch = exports.initPlayer = exports.getLoadingProgress = exports.getPlayerElementId = exports.isPlayerLoading = exports.isThreekitInitialized = exports.getThreekitEnv = exports.updateLoadingProgress = exports.reloadTreble = exports.setPlayerElement = exports.setPlayerLoading = exports.setThreekitInitialized = exports.setThreekitEnv = void 0;
 var connection_1 = __importDefault(require("../connection"));
 var toolkit_1 = require("@reduxjs/toolkit");
 var api_1 = __importDefault(require("../api"));
@@ -63,17 +63,7 @@ var wishlist_1 = require("./wishlist");
 var translations_1 = require("./translations");
 var product_1 = require("./product");
 var message_1 = __importDefault(require("../components/message"));
-/*****************************************************
- * Helper Functions
- ****************************************************/
 var createPlayerLoaderEl = function (elementId) {
-    /**
-     * By default the player is loaded into a player-loader div that
-     * is placed outside the user's view. This is done because in
-     * React the Threekit Initialization may happen before the
-     * component with the player HTML element has loaded which would
-     * otherwise throw an error.
-     */
     var playerElement = document.getElementById(elementId);
     if (playerElement)
         return playerElement;
@@ -90,31 +80,21 @@ var createPlayerLoaderEl = function (elementId) {
     document.body.appendChild(playerLoader);
     return playerElement;
 };
-/*****************************************************
- * Constants and Event Handlers
- ****************************************************/
 var EVENTS = {};
-/*****************************************************
- * State
- ****************************************************/
 var initialState = {
     threekitEnv: 'preview',
     isThreekitInitialized: false,
     isPlayerLoading: false,
     playerElId: undefined,
     notifications: true,
+    loadingProgress: 0,
 };
-/*****************************************************
- * Actions
- ****************************************************/
 exports.setThreekitEnv = (0, toolkit_1.createAction)('treble/set-threekit-env');
 exports.setThreekitInitialized = (0, toolkit_1.createAction)('treble/set-threekit-initialized');
 exports.setPlayerLoading = (0, toolkit_1.createAction)('treble/set-player-loading');
 exports.setPlayerElement = (0, toolkit_1.createAction)('treble/set-player-element');
 exports.reloadTreble = (0, toolkit_1.createAction)('treble/reload');
-/*****************************************************
- * Slice
- ****************************************************/
+exports.updateLoadingProgress = (0, toolkit_1.createAction)('treble/update-loading-progress');
 var reducer = (0, toolkit_1.createSlice)({
     name: 'treble',
     initialState: initialState,
@@ -139,17 +119,16 @@ var reducer = (0, toolkit_1.createSlice)({
         builder.addCase(exports.reloadTreble, function (state, action) {
             return __assign(__assign({}, state), action.payload);
         });
+        builder.addCase(exports.updateLoadingProgress, function (state, action) {
+            state.loadingProgress = Math.round(action.payload * 100);
+            return state;
+        });
     },
 }).reducer;
-/*****************************************************
- * Standard Selectors
- ****************************************************/
-//  Loading Trackers
 var getThreekitEnv = function (state) {
     return state.treble.threekitEnv;
 };
 exports.getThreekitEnv = getThreekitEnv;
-//  Loading Trackers
 var isThreekitInitialized = function (state) {
     return state.treble.isThreekitInitialized;
 };
@@ -158,14 +137,14 @@ var isPlayerLoading = function (state) {
     return state.treble.isPlayerLoading;
 };
 exports.isPlayerLoading = isPlayerLoading;
-//  Player's HTML element
 var getPlayerElementId = function (state) {
     return state.treble.playerElId;
 };
 exports.getPlayerElementId = getPlayerElementId;
-/*****************************************************
- * Complex Actions
- ****************************************************/
+var getLoadingProgress = function (state) {
+    return state.treble.loadingProgress;
+};
+exports.getLoadingProgress = getLoadingProgress;
 var initPlayer = function (config) {
     return function (dispatch, getState) { return __awaiter(void 0, void 0, void 0, function () {
         var el, authToken, assetId, stageId, orgId, playerConfig, initialConfiguration, player, configurator;
@@ -173,12 +152,14 @@ var initPlayer = function (config) {
             switch (_a.label) {
                 case 0:
                     el = config.el, authToken = config.authToken, assetId = config.assetId, stageId = config.stageId, orgId = config.orgId, playerConfig = config.playerConfig, initialConfiguration = config.initialConfiguration;
-                    return [4 /*yield*/, window.threekitPlayer(__assign(__assign({ el: el, 
-                            // Variables to sort out
-                            authToken: authToken, stageId: stageId, assetId: assetId }, playerConfig), { initialConfiguration: initialConfiguration }))];
+                    return [4, window.threekitPlayer(__assign(__assign({ el: el, authToken: authToken, stageId: stageId, assetId: assetId }, playerConfig), { initialConfiguration: initialConfiguration, onLoadingProgress: function (progress) {
+                                var _a;
+                                dispatch((0, exports.updateLoadingProgress)(progress));
+                                (_a = playerConfig === null || playerConfig === void 0 ? void 0 : playerConfig.onLoadingProgress) === null || _a === void 0 ? void 0 : _a.call(playerConfig, progress);
+                            } }))];
                 case 1:
                     player = _a.sent();
-                    return [4 /*yield*/, player.getConfigurator()];
+                    return [4, player.getConfigurator()];
                 case 2:
                     configurator = _a.sent();
                     if (window.threekit) {
@@ -200,6 +181,7 @@ var initPlayer = function (config) {
                         };
                     dispatch((0, exports.setThreekitInitialized)(true));
                     dispatch((0, exports.setPlayerLoading)(false));
+                    dispatch((0, exports.updateLoadingProgress)(1));
                     if (window.threekit.treble._debugMode)
                         (0, utils_1.runDebugger)();
                     window.threekit.player.on('setConfiguration', function () { return __awaiter(void 0, void 0, void 0, function () {
@@ -212,14 +194,14 @@ var initPlayer = function (config) {
                                     previousAttributes = Object.values(attributes);
                                     updatedAttributes = window.threekit.configurator.getDisplayAttributes();
                                     dispatch((0, attributes_1.setAttributes)(updatedAttributes));
-                                    return [4 /*yield*/, ((_a = EVENTS.postConfigurationChange) === null || _a === void 0 ? void 0 : _a.call(EVENTS, updatedAttributes, {}, previousAttributes))];
+                                    return [4, ((_a = EVENTS.postConfigurationChange) === null || _a === void 0 ? void 0 : _a.call(EVENTS, updatedAttributes, {}, previousAttributes))];
                                 case 1:
                                     _b.sent();
-                                    return [2 /*return*/];
+                                    return [2];
                             }
                         });
                     }); });
-                    return [2 /*return*/];
+                    return [2];
             }
         });
     }); };
@@ -233,7 +215,7 @@ var launch = function (launchConfig) {
             switch (_j.label) {
                 case 0:
                     if (window.threekit)
-                        return [2 /*return*/];
+                        return [2];
                     config = (0, utils_1.loadTrebleConfig)();
                     credentials = ((_b = launchConfig === null || launchConfig === void 0 ? void 0 : launchConfig.project) === null || _b === void 0 ? void 0 : _b.credentials) || ((_c = config.project) === null || _c === void 0 ? void 0 : _c.credentials) || {};
                     productsRaw = ((_d = launchConfig === null || launchConfig === void 0 ? void 0 : launchConfig.project) === null || _d === void 0 ? void 0 : _d.products) || ((_e = config.project) === null || _e === void 0 ? void 0 : _e.products) || {};
@@ -280,12 +262,14 @@ var launch = function (launchConfig) {
                         return Object.assign(output, (_b = {}, _b[prodId] = updatedEnvs, _b));
                     }, {});
                     if (!Object.keys(credentials).length || !Object.keys(products).length)
-                        return [2 /*return*/, console.error('Missing credentials')];
+                        return [2, console.error('Missing credentials')];
+                    dispatch((0, product_1.initProduct)(products));
+                    dispatch((0, product_1.setProductId)(productId));
                     threekitEnv = (launchConfig === null || launchConfig === void 0 ? void 0 : launchConfig.threekitEnv) || process.env.THREEKIT_ENV || 'preview';
                     serverUrl = (launchConfig === null || launchConfig === void 0 ? void 0 : launchConfig.serverUrl) || ((_g = config === null || config === void 0 ? void 0 : config.project) === null || _g === void 0 ? void 0 : _g.serverUrl);
                     playerConfig = Object.assign({}, constants_1.DEFAULT_PLAYER_CONFIG, config.player, launchConfig === null || launchConfig === void 0 ? void 0 : launchConfig.playerConfig);
                     envCredentials = credentials[threekitEnv];
-                    _a = products[productId][threekitEnv], assetIdRaw = _a.assetId, stageId = _a.stageId, configurationId = _a.configurationId, initialConfigurationRaw = _a.initialConfiguration;
+                    _a = products[productId][threekitEnv] || {}, assetIdRaw = _a.assetId, stageId = _a.stageId, configurationId = _a.configurationId, initialConfigurationRaw = _a.initialConfiguration;
                     assetId = (launchConfig === null || launchConfig === void 0 ? void 0 : launchConfig.assetId) || assetIdRaw;
                     threekitDomainRaw = envCredentials.threekitDomain || "".concat(threekitEnv, ".threekit.com");
                     orgId = envCredentials.orgId, authToken = envCredentials.publicToken;
@@ -298,7 +282,6 @@ var launch = function (launchConfig) {
                         el = createPlayerLoaderEl(constants_1.TK_PLAYER_ROOT_DIV);
                         dispatch((0, exports.setPlayerElement)(constants_1.TK_PLAYER_ROOT_DIV));
                     }
-                    //  Connection
                     connection_1.default.connect({
                         authToken: authToken,
                         orgId: orgId,
@@ -313,8 +296,8 @@ var launch = function (launchConfig) {
                     configId = ((_h = params[constants_1.TK_SAVED_CONFIG_PARAM_KEY]) === null || _h === void 0 ? void 0 : _h.length)
                         ? params[constants_1.TK_SAVED_CONFIG_PARAM_KEY]
                         : configurationId;
-                    if (!configId) return [3 /*break*/, 2];
-                    return [4 /*yield*/, api_1.default.configurations.fetch(configId)];
+                    if (!configId) return [3, 2];
+                    return [4, api_1.default.configurations.fetch(configId)];
                 case 1:
                     configuration = _j.sent();
                     if (configuration) {
@@ -325,9 +308,8 @@ var launch = function (launchConfig) {
                     _j.label = 2;
                 case 2:
                     if (!updatedAssetId)
-                        return [2 /*return*/, console.error('missing assetId')];
-                    //  We create the threekit script
-                    return [4 /*yield*/, new Promise(function (resolve) {
+                        return [2, console.error('missing assetId')];
+                    return [4, new Promise(function (resolve) {
                             var script = document.createElement('script');
                             script.src = "".concat(threekitDomain, "/app/js/threekit-player-bundle.js");
                             script.id = 'threekit-player-bundle';
@@ -335,9 +317,8 @@ var launch = function (launchConfig) {
                             document.head.appendChild(script);
                         })];
                 case 3:
-                    //  We create the threekit script
                     _j.sent();
-                    return [4 /*yield*/, dispatch((0, exports.initPlayer)({
+                    return [4, dispatch((0, exports.initPlayer)({
                             el: el,
                             orgId: orgId,
                             authToken: authToken,
@@ -352,14 +333,15 @@ var launch = function (launchConfig) {
                         message_1.default.info(e.detail.message);
                     });
                     EVENTS = Object.assign(EVENTS, launchConfig === null || launchConfig === void 0 ? void 0 : launchConfig.eventHandlers);
+                    dispatch((0, product_1.setName)());
+                    dispatch((0, product_1.setMetadata)());
+                    dispatch((0, product_1.initProduct)());
                     dispatch((0, exports.setThreekitEnv)(threekitEnv));
                     dispatch((0, translations_1.initTranslations)(launchConfig === null || launchConfig === void 0 ? void 0 : launchConfig.locale));
                     dispatch((0, price_1.initPrice)());
                     dispatch((0, price_1.updatePrice)());
-                    dispatch((0, product_1.initProduct)(products));
-                    dispatch((0, product_1.setProductId)(productId));
                     dispatch((0, wishlist_1.refreshWishlist)());
-                    return [2 /*return*/];
+                    return [2];
             }
         });
     }); };
@@ -374,10 +356,10 @@ var unloadPlayer = function () { return function (dispatch) { return __awaiter(v
                 dispatch((0, attributes_1.setAttributes)([]));
                 dispatch((0, product_1.setName)(''));
                 dispatch((0, product_1.setMetadata)({}));
-                return [4 /*yield*/, window.threekit.player.unload()];
+                return [4, window.threekit.player.unload()];
             case 1:
                 _a.sent();
-                return [2 /*return*/];
+                return [2];
         }
     });
 }); }; };
@@ -389,19 +371,19 @@ var reloadPlayer = function (config) {
             switch (_a.label) {
                 case 0:
                     connectionObj = connection_1.default.getConnection();
-                    if (!(config === undefined)) return [3 /*break*/, 1];
+                    if (!(config === undefined)) return [3, 1];
                     assetId = connectionObj.assetId;
-                    return [3 /*break*/, 4];
+                    return [3, 4];
                 case 1:
-                    if (!(typeof config === 'string')) return [3 /*break*/, 2];
+                    if (!(typeof config === 'string')) return [3, 2];
                     assetId = config;
-                    return [3 /*break*/, 4];
+                    return [3, 4];
                 case 2:
                     assetId = (config === null || config === void 0 ? void 0 : config.assetId) || connectionObj.assetId;
                     stageId = config === null || config === void 0 ? void 0 : config.stageId;
                     initialConfiguration = (config === null || config === void 0 ? void 0 : config.configuration) || {};
-                    if (!(config === null || config === void 0 ? void 0 : config.configurationId)) return [3 /*break*/, 4];
-                    return [4 /*yield*/, api_1.default.configurations.fetch(config === null || config === void 0 ? void 0 : config.configurationId)];
+                    if (!(config === null || config === void 0 ? void 0 : config.configurationId)) return [3, 4];
+                    return [4, api_1.default.configurations.fetch(config === null || config === void 0 ? void 0 : config.configurationId)];
                 case 3:
                     configuration = _a.sent();
                     if (configuration) {
@@ -410,19 +392,18 @@ var reloadPlayer = function (config) {
                     }
                     _a.label = 4;
                 case 4:
-                    //  Update connection
                     if (assetId !== connectionObj.assetId)
                         connection_1.default.connect({ assetId: assetId });
                     state = getState();
                     trebleConfig = (0, utils_1.loadTrebleConfig)();
                     playerConfig = Object.assign({}, constants_1.DEFAULT_PLAYER_CONFIG, trebleConfig.player);
                     el = document.getElementById(state.treble.playerElId);
-                    if (!state.treble.isThreekitInitialized) return [3 /*break*/, 6];
-                    return [4 /*yield*/, dispatch((0, exports.unloadPlayer)())];
+                    if (!state.treble.isThreekitInitialized) return [3, 6];
+                    return [4, dispatch((0, exports.unloadPlayer)())];
                 case 5:
                     _a.sent();
                     _a.label = 6;
-                case 6: return [4 /*yield*/, dispatch((0, exports.initPlayer)({
+                case 6: return [4, dispatch((0, exports.initPlayer)({
                         el: el,
                         orgId: connectionObj.orgId,
                         authToken: connectionObj.authToken,
@@ -435,7 +416,7 @@ var reloadPlayer = function (config) {
                     _a.sent();
                     dispatch((0, price_1.updatePrice)());
                     dispatch((0, product_1.initProduct)());
-                    return [2 /*return*/];
+                    return [2];
             }
         });
     }); };

package/dist/store/wishlist.d.ts

@@ -1,24 +1,12 @@
 import { RootState, ThreekitDispatch } from './index';
 import { WishlistArray } from '../Treble';
 import { ISaveConfiguration } from '../api/configurations';
-/*****************************************************
- * Types and Interfaces
- ****************************************************/
 export declare type WishlistState = WishlistArray;
-/*****************************************************
- * Standard Selectors
- ****************************************************/
 export declare const refreshWishlist: import("@reduxjs/toolkit").AsyncThunk<import("../http/configurations").IConfigurationResponse[], void, {}>;
-export declare const addToWishlist: import("@reduxjs/toolkit").AsyncThunk<import("../http/configurations").IConfigurationResponse[], Omit<ISaveConfiguration, "configurator">, {}>;
+export declare const addToWishlist: import("@reduxjs/toolkit").AsyncThunk<import("../http/configurations").IConfigurationResponse[], Omit<ISaveConfiguration, "configuration">, {}>;
 export declare const clearWishlist: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[], import("../http/configurations").IConfigurationResponse[], "treble/wishlist/clear", never, never>;
 export declare const removeFromWishlist: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[idx: number], import("../http/configurations").IConfigurationResponse[], "treble/wishlist/remove-item", never, never>;
-/*****************************************************
- * Slice
- ****************************************************/
 declare const reducer: import("redux").Reducer<WishlistArray, import("redux").AnyAction>;
-/*****************************************************
- * Standard Selectors
- ****************************************************/
 export declare const getWishlist: (state: RootState) => WishlistArray;
 export declare const resumeFromWishlist: (idx: number) => (_: ThreekitDispatch, getState: () => RootState) => void;
 export default reducer;

package/dist/store/wishlist.js

@@ -38,21 +38,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resumeFromWishlist = exports.getWishlist = exports.removeFromWishlist = exports.clearWishlist = exports.addToWishlist = exports.refreshWishlist = void 0;
 var toolkit_1 = require("@reduxjs/toolkit");
-/*****************************************************
- * State
- ****************************************************/
 var initialState = [];
-/*****************************************************
- * Standard Selectors
- ****************************************************/
 exports.refreshWishlist = (0, toolkit_1.createAsyncThunk)('treble/wishlist/refresh-data', function () { return __awaiter(void 0, void 0, void 0, function () {
     var wishlistData;
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, window.threekit.treble.wishlist.getWishlist()];
+            case 0: return [4, window.threekit.treble.wishlist.getWishlist()];
             case 1:
                 wishlistData = _a.sent();
-                return [2 /*return*/, wishlistData];
+                return [2, wishlistData];
         }
     });
 }); });
@@ -60,10 +54,10 @@ exports.addToWishlist = (0, toolkit_1.createAsyncThunk)('treble/wishlist/add-ite
     var wishlistData;
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, window.threekit.treble.wishlist.addItem(config)];
+            case 0: return [4, window.threekit.treble.wishlist.addItem(config)];
             case 1:
                 wishlistData = _a.sent();
-                return [2 /*return*/, wishlistData];
+                return [2, wishlistData];
         }
     });
 }); });
@@ -75,9 +69,6 @@ exports.removeFromWishlist = (0, toolkit_1.createAction)('treble/wishlist/remove
     var wishlistData = window.threekit.treble.wishlist.removeItemByIdx(idx);
     return { payload: wishlistData };
 });
-/*****************************************************
- * Slice
- ****************************************************/
 var reducer = (0, toolkit_1.createSlice)({
     name: 'wishlist',
     initialState: initialState,
@@ -97,10 +88,6 @@ var reducer = (0, toolkit_1.createSlice)({
         });
     },
 }).reducer;
-/*****************************************************
- * Standard Selectors
- ****************************************************/
-//  Wishlist
 var getWishlist = function (state) { return state.wishlist; };
 exports.getWishlist = getWishlist;
 var resumeFromWishlist = function (idx) { return function (_, getState) {

package/dist/types.d.ts

@@ -7,9 +7,6 @@ export declare type DISPLAY_OPTIONS = 'webgl' | 'image';
 export declare type IAttributeTypes = 'String' | 'Asset' | 'Color' | 'Number' | 'Boolean';
 export declare type AssetType = 'upload' | 'item';
 export declare type IMetadata = Record<string, string | number | null>;
-/***************************************************
- *  Scene
- **************************************************/
 export interface ISceneQuery {
     all?: boolean;
     id?: string;
@@ -41,9 +38,6 @@ export interface ISceneResult {
     name: string;
     configurator: IThreekitPrivateConfigurator;
 }
-/***************************************************
- *  Configuration
- **************************************************/
 export interface IConfigurationAsset {
     assetId: string;
     configuration?: string;
@@ -57,11 +51,6 @@ export interface IConfigurationColor {
 export declare type IConfigurationAttribute = IConfigurationAsset | IConfigurationColor | string | number | boolean | undefined;
 export declare type IConfiguration = Record<string, IConfigurationAttribute>;
 export declare type ISetConfiguration = Record<string, IConfigurationAttribute>;
-/***************************************************
- *  ATTRIBUTES
- *
- *  This section covers both getAttributes() and getDisplayAttributes()
- **************************************************/
 interface IDisplayAttributeConfig {
     includeHidden?: boolean;
 }
@@ -72,7 +61,6 @@ interface IAttributeBase<T extends IAttributeTypes, V extends IConfigurationAttr
     value: V;
     label: string;
 }
-/****** ASSET TYPE ATTRIBUTE *******/
 export interface IConfigurationAssetValue {
     assetId: string;
     name: string;
@@ -101,7 +89,6 @@ export interface IAttributeAssetBase<V> extends IAttributeBase<'Asset', IConfigu
 export declare type IDisplayAttributeAsset = IAttributeAssetBase<IDisplayAttributeAssetValue>;
 export declare type IHydratedAttributeAsset = IAttributeAssetBase<IHydratedAttributeAssetValue>;
 export declare type IAttributeAsset = IAttributeAssetBase<IConfigurationAssetValue>;
-/****** String TYPE ATTRIBUTE *******/
 export interface IDisplayAttributeStringValue {
     label: string;
     value: string;
@@ -120,11 +107,9 @@ export interface IAttributeStringBase<V> extends IAttributeBase<'String', string
 export declare type IDisplayAttributeString = IAttributeStringBase<IDisplayAttributeStringValue>;
 export declare type IHydratedAttributeString = IAttributeStringBase<IHydratedAttributeStringValue>;
 export declare type IAttributeString = IAttributeStringBase<string>;
-/****** STRING TYPE ATTRIBUTE *******/
 export interface IAttributeColor extends IAttributeBase<'Color', IConfigurationColor> {
     defaultValue: IConfigurationColor;
 }
-/****** NUMBER TYPE ATTRIBUTE *******/
 export interface IAttributeNumber extends IAttributeBase<'Number', number> {
     defaultValue: number;
     lockToStep: boolean;
@@ -132,19 +117,12 @@ export interface IAttributeNumber extends IAttributeBase<'Number', number> {
     min?: number;
     step: number;
 }
-/****** NUMBER TYPE ATTRIBUTE *******/
 export interface IAttributeBoolean extends IAttributeBase<'Boolean', boolean> {
     defaultValue: boolean;
 }
-/****** getAttributes() *******/
 export declare type IThreekitAttribute = IAttributeAsset | IAttributeColor | IAttributeString | IAttributeNumber | IAttributeBoolean;
-/****** getDisplayAttributes() *******/
 export declare type IThreekitDisplayAttribute = IDisplayAttributeAsset | IDisplayAttributeString | IAttributeColor | IAttributeNumber | IAttributeBoolean;
-/****** Treble Hydrated Values *******/
 export declare type IHydratedAttribute = IHydratedAttributeAsset | IHydratedAttributeString | IAttributeColor | IAttributeNumber | IAttributeBoolean;
-/***************************************************
- *  Camera
- **************************************************/
 export interface ICoordinates {
     x: number;
     y: number;
@@ -161,9 +139,53 @@ export interface ISnapshotConfig {
     };
 }
 export declare type SNAPSHOT_FORMAT_TYPES = 'jpg' | 'png';
-/***************************************************
- *  Threekit Api
- **************************************************/
+export interface Node {
+    name: string;
+    nodeId: string;
+    type: string;
+}
+export interface HitNode {
+    distance: number;
+    intersection: ICoordinates;
+    nodeId: string;
+    hierarchy: Array<Node>;
+}
+export interface PlayerToolEvent {
+    altKey: boolean;
+    clientX: number;
+    clientY: number;
+    deltaX: number;
+    deltaY: number;
+    ctrlKey: boolean;
+    isTouch: boolean;
+    metaKey: boolean;
+    shiftKey: boolean;
+    which: number;
+    originalEvent: MouseEvent;
+    rect: DOMRect;
+    hitNodes: Array<HitNode>;
+}
+export interface CustomPlayerTool {
+    key: string;
+    label: string;
+    active: boolean;
+    enabled: boolean;
+    handlers: {
+        click?: (event: PlayerToolEvent) => void | Promise<void>;
+        mousedown?: (event: PlayerToolEvent) => void | Promise<void>;
+        mouseup?: (event: PlayerToolEvent) => void | Promise<void>;
+    };
+}
+export interface IThreekitTools {
+    addTool: (tool: string | CustomPlayerTool) => void;
+    addTools: (tools: Array<string | CustomPlayerTool>) => void;
+    removeTool: (tool: string) => void;
+    removeTools: (tools: Array<string>) => void;
+    setPrimary: (tool: string) => void;
+    getPrimaryTool: () => string;
+    setTool: () => void;
+    setTools: () => void;
+}
 export interface IConfigurationChangeEvent {
     name: string;
     appliedConfiguration: Record<string, string>;
@@ -189,16 +211,6 @@ export interface IThreekitScene {
     find: (query: ISceneQuery | string) => ISceneResult;
     set: (query: ISceneQuery | string, transform: ICoordinates) => void;
 }
-export interface IThreekitTools {
-    addTool: (tool: string) => void;
-    addTools: (tools: string[]) => void;
-    removeTool: (tool: string) => void;
-    removeTools: (tools: string[]) => void;
-    setPrimary: (tool: string) => void;
-    getPrimaryTool: () => string;
-    setTool: () => void;
-    setTools: () => void;
-}
 export interface IThreekitCamera {
     frameBoundingSphere: () => void;
     getPosition: () => ICoordinates;
@@ -265,9 +277,6 @@ export interface ThreekitInitConfig {
         help?: string;
     };
 }
-/***************************************************
- *  Treble Declarations
- **************************************************/
 export interface IFrameworkConfig {
     productsCtx: __WebpackModuleApi.RequireContext;
 }
@@ -297,9 +306,6 @@ export interface ITrebleConfig {
     treble: IFrameworkConfig;
     player: IPlayerConfig;
 }
-/***************************************************
- *  Global Declaration
- **************************************************/
 declare global {
     interface Window {
         threekitPlayer: (arg0: ThreekitInitConfig) => Promise<IThreekitPlayer>;

package/dist/utils.d.ts

@@ -15,13 +15,13 @@ interface IAttributeComponentProps {
 interface IAttributesComponentProps {
     [attributeName: string]: undefined | false | IAttributeComponentProps;
 }
-export declare const generateClassName: (baseClass: string) => (component: string, customClassName?: string | undefined, title?: string | undefined) => string;
-export declare const generateInputClassName: (component: string, customClassName?: string | undefined, title?: string | undefined) => string;
-export declare const generateWidgetClassName: (component: string, customClassName?: string | undefined, title?: string | undefined) => string;
-export declare const generateLayoutClassName: (component: string, customClassName?: string | undefined, title?: string | undefined) => string;
-export declare const generateToolClassName: (component: string, customClassName?: string | undefined, title?: string | undefined) => string;
-export declare const generateDisplayClassName: (component: string, customClassName?: string | undefined, title?: string | undefined) => string;
-export declare const generateFormClassName: (component: string, customClassName?: string | undefined, title?: string | undefined) => string;
+export declare const generateClassName: (baseClass: string) => (component: string, customClassName?: string, title?: string) => string;
+export declare const generateInputClassName: (component: string, customClassName?: string, title?: string) => string;
+export declare const generateWidgetClassName: (component: string, customClassName?: string, title?: string) => string;
+export declare const generateLayoutClassName: (component: string, customClassName?: string, title?: string) => string;
+export declare const generateToolClassName: (component: string, customClassName?: string, title?: string) => string;
+export declare const generateDisplayClassName: (component: string, customClassName?: string, title?: string) => string;
+export declare const generateFormClassName: (component: string, customClassName?: string, title?: string) => string;
 export declare const isIOS: () => RegExpMatchArray | null;
 export declare const isJsonString: (str: string) => boolean;
 export declare const objectToQueryStr: (obj: Record<string, any>) => string;
@@ -57,7 +57,7 @@ export declare const selectionToConfiguration: (value: RawAttributeValue, attrib
     assetId: RawAttributeValue;
 } | undefined;
 export declare const filterFormAttributes: (attributes: Record<string, IThreekitDisplayAttribute>, attributeComponentProps: IAttributesComponentProps, includeReservedAttributes: boolean) => IThreekitDisplayAttribute[];
-export declare const isUuid: (str?: string | undefined) => boolean;
+export declare const isUuid: (str?: string) => boolean;
 export declare const runDebugger: () => Promise<void>;
 export declare const loadTrebleConfig: () => Partial<ITrebleConfig>;
 export {};

package/dist/utils.js

@@ -143,35 +143,26 @@ var shallowCompare = function (value1, value2) {
 };
 exports.shallowCompare = shallowCompare;
 var deepCompare = function (item1, item2) {
-    //  Are the items the same type
     if (typeof item1 !== typeof item2)
         return false;
-    //  If that type is Array we deepCompare each item
-    //  against its counter part
-    //  The same arrays in different orders will fail this check
     else if (Array.isArray(item1)) {
         if (item1.length !== item2.length)
             return false;
         for (var i = 0; i < item1.length; i++)
             if (!(0, exports.deepCompare)(item1[i], item2[i]))
                 return false;
-        //  If they're objects...
     }
     else if (isObject(item1)) {
         var keys1 = Object.keys(item1);
         var keys2 = Object.keys(item2);
-        //  We makre sure they have the same keys...
         if (keys1.length !== keys2.length) {
             return false;
         }
-        //  and then deep compare each value
         for (var _i = 0, keys1_2 = keys1; _i < keys1_2.length; _i++) {
             var key = keys1_2[_i];
             if (!(0, exports.deepCompare)(item1[key], item2[key]))
                 return false;
         }
-        //  This leaves us with literals that can be
-        //  compared directly
     }
     else if (item1 !== item2)
         return false;
@@ -280,7 +271,7 @@ var downloadSnapshot = function (snapshot, filename) { return __awaiter(void 0,
         link.addEventListener('click', clickHandler);
         document.body.appendChild(link);
         link.click();
-        return [2 /*return*/];
+        return [2];
     });
 }); };
 exports.downloadSnapshot = downloadSnapshot;
@@ -409,12 +400,12 @@ var runDebugger = function () { return __awaiter(void 0, void 0, void 0, functio
     var logs;
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, window.threekit.treble._player.calculateLogs()];
+            case 0: return [4, window.threekit.treble._player.calculateLogs()];
             case 1:
                 logs = _a.sent();
                 if (logs.length)
                     console.log("Threekit Debugger: \n", logs);
-                return [2 /*return*/];
+                return [2];
         }
     });
 }); };