@threekit-tools/treble 0.0.10-alpha.17 → 0.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/README.md +163 -156
  2. package/dist/Treble/Snapshots.d.ts +28 -0
  3. package/dist/Treble/Snapshots.js +280 -0
  4. package/dist/Treble/Treble.d.ts +9 -27
  5. package/dist/Treble/Treble.js +34 -350
  6. package/dist/Treble/Wishlist.d.ts +18 -0
  7. package/dist/Treble/Wishlist.js +137 -0
  8. package/dist/Treble/index.d.ts +2 -0
  9. package/dist/Treble/index.js +2 -0
  10. package/dist/components/Accordion/accordion.styles.d.ts +5 -0
  11. package/dist/components/Accordion/accordion.styles.js +13 -0
  12. package/dist/components/Accordion/index.d.ts +14 -0
  13. package/dist/components/Accordion/index.js +63 -0
  14. package/dist/components/Cards/index.d.ts +2 -2
  15. package/dist/components/Drawer/index.js +0 -1
  16. package/dist/components/Dropdown/dropdown.styles.js +1 -3
  17. package/dist/components/Dropdown/index.d.ts +2 -2
  18. package/dist/components/FlatForm/index.d.ts +2 -1
  19. package/dist/components/FlatForm/index.js +5 -3
  20. package/dist/components/FormComponentDescription/index.js +1 -1
  21. package/dist/components/FormComponentTitle/formComponentTitle.styles.js +1 -1
  22. package/dist/components/Modal/index.js +3 -1
  23. package/dist/components/PortalToElement/index.d.ts +1 -1
  24. package/dist/components/PortalToElement/index.js +4 -4
  25. package/dist/components/ProductDescription/description.styles.js +1 -1
  26. package/dist/components/ProductName/productName.styles.js +1 -1
  27. package/dist/components/Share/index.d.ts +37 -0
  28. package/dist/components/Share/index.js +51 -0
  29. package/dist/components/Strips/index.d.ts +2 -2
  30. package/dist/components/Strips/index.js +1 -1
  31. package/dist/components/Swatch/index.d.ts +2 -2
  32. package/dist/components/Tabs/index.d.ts +14 -0
  33. package/dist/components/Tabs/index.js +53 -0
  34. package/dist/components/Tabs/tabs.styles.d.ts +8 -0
  35. package/dist/components/Tabs/tabs.styles.js +20 -0
  36. package/dist/components/ThreekitProvider/index.d.ts +11 -2
  37. package/dist/components/ThreekitProvider/index.js +3 -3
  38. package/dist/components/Tiles/index.d.ts +2 -2
  39. package/dist/components/TilesGroup/index.d.ts +2 -2
  40. package/dist/components/containers/formInputContainer.d.ts +2 -2
  41. package/dist/hooks/useShare/index.d.ts +3 -0
  42. package/dist/hooks/useShare/index.js +71 -0
  43. package/dist/hooks/useWishlist/index.d.ts +2 -3
  44. package/dist/index.d.ts +5 -1
  45. package/dist/index.js +9 -1
  46. package/dist/store/index.d.ts +2 -2
  47. package/dist/store/threekit.d.ts +6 -19
  48. package/dist/store/threekit.js +12 -13
  49. package/dist/threekit.d.ts +2 -0
  50. package/package.json +8 -5
package/dist/index.d.ts CHANGED
@@ -8,6 +8,7 @@ import useThreekitInitStatus from './hooks/useThreekitInitStatus';
8
8
  import useZoom from './hooks/useZoom';
9
9
  import useSnapshot from './hooks/useSnapshot';
10
10
  import useWishlist from './hooks/useWishlist';
11
+ import useShare from './hooks/useShare';
11
12
  import ThreekitProvider from './components/ThreekitProvider';
12
13
  import Player from './components/Player';
13
14
  import Button from './components/Button';
@@ -25,10 +26,13 @@ import TotalPrice from './components/TotalPrice';
25
26
  import message from './components/message';
26
27
  import Modal from './components/TotalPrice';
27
28
  import Drawer from './components/Drawer';
29
+ import Accordion from './components/Accordion';
30
+ import Tabs from './components/Tabs';
28
31
  import PortalToElement from './components/PortalToElement';
29
32
  import AwaitThreekitLoad from './components/AwaitThreekitLoad';
30
33
  import FlatForm from './components/FlatForm';
31
34
  import Zoom from './components/Zoom';
32
35
  import Snapshots from './components/Snapshots';
33
36
  import Wishlist from './components/Wishlist';
34
- export { useAttribute, useConfigurator, useMetadata, useName, usePlayerLoadingStatus, usePrice, useThreekitInitStatus, useZoom, useSnapshot, useWishlist, ThreekitProvider, Player, Button, Cards, Dropdown, Strips, Swatch, Tiles, TilesGroup, ProductName, ProductDescription, AttributeTitle, AttributeValue, TotalPrice, message, Modal, Drawer, PortalToElement, AwaitThreekitLoad, FlatForm, Zoom, Snapshots, Wishlist, };
37
+ import Share from './components/Share';
38
+ export { useAttribute, useConfigurator, useMetadata, useName, usePlayerLoadingStatus, usePrice, useThreekitInitStatus, useZoom, useSnapshot, useWishlist, useShare, ThreekitProvider, Player, Button, Cards, Dropdown, Strips, Swatch, Tiles, TilesGroup, ProductName, ProductDescription, AttributeTitle, AttributeValue, TotalPrice, message, Modal, Drawer, Accordion, Tabs, PortalToElement, AwaitThreekitLoad, FlatForm, Zoom, Snapshots, Wishlist, Share, };
package/dist/index.js CHANGED
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.Wishlist = exports.Snapshots = exports.Zoom = exports.FlatForm = exports.AwaitThreekitLoad = exports.PortalToElement = exports.Drawer = exports.Modal = exports.message = exports.TotalPrice = exports.AttributeValue = exports.AttributeTitle = exports.ProductDescription = exports.ProductName = exports.TilesGroup = exports.Tiles = exports.Swatch = exports.Strips = exports.Dropdown = exports.Cards = exports.Button = exports.Player = exports.ThreekitProvider = exports.useWishlist = exports.useSnapshot = exports.useZoom = exports.useThreekitInitStatus = exports.usePrice = exports.usePlayerLoadingStatus = exports.useName = exports.useMetadata = exports.useConfigurator = exports.useAttribute = void 0;
6
+ exports.Share = exports.Wishlist = exports.Snapshots = exports.Zoom = exports.FlatForm = exports.AwaitThreekitLoad = exports.PortalToElement = exports.Tabs = exports.Accordion = exports.Drawer = exports.Modal = exports.message = exports.TotalPrice = exports.AttributeValue = exports.AttributeTitle = exports.ProductDescription = exports.ProductName = exports.TilesGroup = exports.Tiles = exports.Swatch = exports.Strips = exports.Dropdown = exports.Cards = exports.Button = exports.Player = exports.ThreekitProvider = exports.useShare = exports.useWishlist = exports.useSnapshot = exports.useZoom = exports.useThreekitInitStatus = exports.usePrice = exports.usePlayerLoadingStatus = exports.useName = exports.useMetadata = exports.useConfigurator = exports.useAttribute = void 0;
7
7
  // Hooks
8
8
  var useAttribute_1 = __importDefault(require("./hooks/useAttribute"));
9
9
  exports.useAttribute = useAttribute_1.default;
@@ -25,6 +25,8 @@ var useSnapshot_1 = __importDefault(require("./hooks/useSnapshot"));
25
25
  exports.useSnapshot = useSnapshot_1.default;
26
26
  var useWishlist_1 = __importDefault(require("./hooks/useWishlist"));
27
27
  exports.useWishlist = useWishlist_1.default;
28
+ var useShare_1 = __importDefault(require("./hooks/useShare"));
29
+ exports.useShare = useShare_1.default;
28
30
  // Components
29
31
  var ThreekitProvider_1 = __importDefault(require("./components/ThreekitProvider"));
30
32
  exports.ThreekitProvider = ThreekitProvider_1.default;
@@ -64,6 +66,10 @@ var TotalPrice_2 = __importDefault(require("./components/TotalPrice"));
64
66
  exports.Modal = TotalPrice_2.default;
65
67
  var Drawer_1 = __importDefault(require("./components/Drawer"));
66
68
  exports.Drawer = Drawer_1.default;
69
+ var Accordion_1 = __importDefault(require("./components/Accordion"));
70
+ exports.Accordion = Accordion_1.default;
71
+ var Tabs_1 = __importDefault(require("./components/Tabs"));
72
+ exports.Tabs = Tabs_1.default;
67
73
  // Wrappers
68
74
  var PortalToElement_1 = __importDefault(require("./components/PortalToElement"));
69
75
  exports.PortalToElement = PortalToElement_1.default;
@@ -79,3 +85,5 @@ var Snapshots_1 = __importDefault(require("./components/Snapshots"));
79
85
  exports.Snapshots = Snapshots_1.default;
80
86
  var Wishlist_1 = __importDefault(require("./components/Wishlist"));
81
87
  exports.Wishlist = Wishlist_1.default;
88
+ var Share_1 = __importDefault(require("./components/Share"));
89
+ exports.Share = Share_1.default;
@@ -1,13 +1,13 @@
1
1
  import { TypedUseSelectorHook } from 'react-redux';
2
2
  declare const store: import("@reduxjs/toolkit").EnhancedStore<{
3
3
  threekit: import("./threekit").ThreekitState;
4
- }, import("redux").AnyAction, import("@reduxjs/toolkit").MiddlewareArray<import("redux").Middleware<{}, any, import("redux").Dispatch<import("redux").AnyAction>> | import("redux-thunk").ThunkMiddleware<{
4
+ }, import("redux").AnyAction, import("@reduxjs/toolkit").MiddlewareArray<import("redux-thunk").ThunkMiddleware<{
5
5
  threekit: import("./threekit").ThreekitState;
6
6
  }, import("redux").AnyAction, null> | import("redux-thunk").ThunkMiddleware<{
7
7
  threekit: import("./threekit").ThreekitState;
8
8
  }, import("redux").AnyAction, undefined> | import("redux").Middleware<{}, {
9
9
  threekit: import("./threekit").ThreekitState;
10
- }, import("redux").Dispatch<import("redux").AnyAction>>>>;
10
+ }, import("redux").Dispatch<import("redux").AnyAction>> | import("redux").Middleware<{}, any, import("redux").Dispatch<import("redux").AnyAction>>>>;
11
11
  export declare type RootState = ReturnType<typeof store.getState>;
12
12
  export declare type ThreekitDispatch = typeof store.dispatch;
13
13
  export declare const useThreekitDispatch: () => import("@reduxjs/toolkit").ThunkDispatch<{
@@ -1,37 +1,24 @@
1
1
  import { RootState, ThreekitDispatch } from './index';
2
- import { IConfiguration, ISetConfiguration, IThreekitDisplayAttribute, IMetadata } from '../threekit';
2
+ import { ISetConfiguration, IThreekitDisplayAttribute, IMetadata, ThreekitInitConfig } from '../threekit';
3
3
  import { ITranslationMap } from '../api/products';
4
- import { ISaveConfigurationConfig } from '../Treble';
5
- import { IConfigurationResponse } from '../http/configurations';
4
+ import { ISaveConfigurationConfig, WishlistArray } from '../Treble';
6
5
  /*****************************************************
7
6
  * Types and Interfaces
8
7
  ****************************************************/
9
8
  export interface IThreekitCredentials {
10
9
  publicToken: string;
11
10
  assetId: string;
11
+ configurationId?: string;
12
12
  orgId: string;
13
13
  stageId?: string;
14
14
  publishStage?: string;
15
15
  threekitDomain?: string;
16
16
  }
17
- export interface ILaunchConfig {
17
+ export interface ILaunchConfig extends Omit<ThreekitInitConfig, 'el' | 'authToken' | 'orgId' | 'assetId' | 'stageId'> {
18
18
  threekitEnv?: string;
19
19
  preview: IThreekitCredentials;
20
20
  'admin-fts': IThreekitCredentials;
21
- configurationId?: string;
22
21
  elementId?: string;
23
- public: string;
24
- cache?: string;
25
- showConfigurator?: boolean;
26
- initialConfiguration?: IConfiguration;
27
- showLoadingThumbnail?: boolean;
28
- showLoadingProgress?: boolean;
29
- onLoadingProgress?: boolean;
30
- showAR?: boolean;
31
- showShare?: boolean;
32
- locale?: string;
33
- allowMobileVerticalOrbit?: boolean;
34
- publishStage?: string;
35
22
  language?: string | undefined;
36
23
  }
37
24
  interface IPriceConfig {
@@ -55,7 +42,7 @@ export interface ThreekitState {
55
42
  isPlayerLoading: boolean;
56
43
  isThreekitLoaded: boolean;
57
44
  attributes: undefined | Array<IThreekitDisplayAttribute>;
58
- wishlist: Array<IConfigurationResponse>;
45
+ wishlist: WishlistArray;
59
46
  }
60
47
  declare const reducer: import("redux").Reducer<ThreekitState, import("redux").AnyAction>;
61
48
  export declare const setThreekitLoaded: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>;
@@ -71,7 +58,7 @@ export declare const getMetadata: (state: RootState) => undefined | IMetadata;
71
58
  export declare const getLanguage: (state: RootState) => undefined | string;
72
59
  export declare const getLanguageOptions: (state: RootState) => Array<string>;
73
60
  export declare const getAttributes: (state: RootState) => undefined | Record<string, IThreekitDisplayAttribute>;
74
- export declare const getWishlist: (state: RootState) => IConfigurationResponse[];
61
+ export declare const getWishlist: (state: RootState) => WishlistArray;
75
62
  /*****************************************************
76
63
  * Complex Selectors
77
64
  ****************************************************/
@@ -87,7 +87,7 @@ var createPlayerLoaderEl = function (elementId) {
87
87
  var initialState = {
88
88
  // Player HTML element
89
89
  playerElId: undefined,
90
- // Name of the Intialized Item
90
+ // Name of the Initialized Item
91
91
  name: undefined,
92
92
  // Initialized item's metadata
93
93
  metadata: undefined,
@@ -115,15 +115,15 @@ var _a = (0, toolkit_1.createSlice)({
115
115
  setPlayerLoading: function (state, action) {
116
116
  state.isPlayerLoading = action.payload;
117
117
  },
118
- // Intialized Item's Name
118
+ // Initialized Item's Name
119
119
  setPlayerElement: function (state, action) {
120
120
  state.playerElId = action.payload;
121
121
  },
122
- // Intialized Item's Name
122
+ // Initialized Item's Name
123
123
  setName: function (state, action) {
124
124
  state.name = action.payload;
125
125
  },
126
- // Intialized Item's Metadata
126
+ // Initialized Item's Metadata
127
127
  setMetadata: function (state, action) {
128
128
  state.metadata = action.payload;
129
129
  },
@@ -264,12 +264,10 @@ var launch = function (launchConfig) { return function (dispatch) { return __awa
264
264
  var _a,
265
265
  // Threekit Env specific credentials,
266
266
  threekitEnv,
267
- // User saved configuration
268
- configurationId,
269
267
  // Threekit Player Init
270
268
  elementId,
271
269
  // cache,
272
- showConfigurator, initialConfigurationRaw, showLoadingThumbnail, showLoadingProgress, onLoadingProgress, showAR, showShare, locale, allowMobileVerticalOrbit, publishStage, threekitCredentials, threekitDomainRaw, assetId, authToken, orgId, stageId, threekitDomain, initialConfiguration, updatedAssetId, params, configId, configuration, el, _b, player, translations, pricebook, _c, priceConfig, productName, wishlistData;
270
+ showConfigurator, initialConfigurationRaw, showLoadingThumbnail, showLoadingProgress, onLoadingProgress, showAR, showShare, locale, allowMobileVerticalOrbit, publishStage, display, threekitCredentials, threekitDomainRaw, assetId, authToken, orgId, stageId, configurationId, threekitDomain, initialConfiguration, updatedAssetId, params, configId, configuration, el, _b, player, translations, pricebook, _c, priceConfig, productName, wishlistData;
273
271
  var _d;
274
272
  var _e;
275
273
  return __generator(this, function (_f) {
@@ -277,10 +275,10 @@ var launch = function (launchConfig) { return function (dispatch) { return __awa
277
275
  case 0:
278
276
  if (window.threekit)
279
277
  return [2 /*return*/];
280
- _a = Object.assign(constants_1.DEFAULT_PLAYER_CONFIG, launchConfig), threekitEnv = _a.threekitEnv, configurationId = _a.configurationId, elementId = _a.elementId, showConfigurator = _a.showConfigurator, initialConfigurationRaw = _a.initialConfiguration, showLoadingThumbnail = _a.showLoadingThumbnail, showLoadingProgress = _a.showLoadingProgress, onLoadingProgress = _a.onLoadingProgress, showAR = _a.showAR, showShare = _a.showShare, locale = _a.locale, allowMobileVerticalOrbit = _a.allowMobileVerticalOrbit, publishStage = _a.publishStage;
278
+ _a = Object.assign(constants_1.DEFAULT_PLAYER_CONFIG, launchConfig), threekitEnv = _a.threekitEnv, elementId = _a.elementId, showConfigurator = _a.showConfigurator, initialConfigurationRaw = _a.initialConfiguration, showLoadingThumbnail = _a.showLoadingThumbnail, showLoadingProgress = _a.showLoadingProgress, onLoadingProgress = _a.onLoadingProgress, showAR = _a.showAR, showShare = _a.showShare, locale = _a.locale, allowMobileVerticalOrbit = _a.allowMobileVerticalOrbit, publishStage = _a.publishStage, display = _a.display;
281
279
  threekitCredentials = launchConfig[threekitEnv || 'preview'];
282
280
  threekitDomainRaw = threekitCredentials.threekitDomain || "".concat(threekitEnv, ".threekit.com");
283
- assetId = threekitCredentials.assetId, authToken = threekitCredentials.publicToken, orgId = threekitCredentials.orgId, stageId = threekitCredentials.stageId;
281
+ assetId = threekitCredentials.assetId, authToken = threekitCredentials.publicToken, orgId = threekitCredentials.orgId, stageId = threekitCredentials.stageId, configurationId = threekitCredentials.configurationId;
284
282
  // Connection
285
283
  connection_1.default.connect({
286
284
  authToken: authToken,
@@ -337,6 +335,7 @@ var launch = function (launchConfig) { return function (dispatch) { return __awa
337
335
  locale: locale,
338
336
  allowMobileVerticalOrbit: allowMobileVerticalOrbit,
339
337
  publishStage: publishStage,
338
+ display: display,
340
339
  }),
341
340
  api_1.default.products.fetchTranslations(),
342
341
  api_1.default.price.getPricebooksList(),
@@ -371,7 +370,7 @@ var launch = function (launchConfig) { return function (dispatch) { return __awa
371
370
  dispatch(setAttributes(window.threekit.configurator.getDisplayAttributes()));
372
371
  dispatch((0, exports.setThreekitLoaded)(true));
373
372
  dispatch(setPlayerLoading(false));
374
- return [4 /*yield*/, window.threekit.treble.getWishlist()];
373
+ return [4 /*yield*/, window.threekit.treble.wishlist.getWishlist()];
375
374
  case 6:
376
375
  wishlistData = _f.sent();
377
376
  dispatch(setWishlist(wishlistData));
@@ -403,7 +402,7 @@ var addToWishlist = function (config) { return function (dispatch) { return __aw
403
402
  var wishlistData;
404
403
  return __generator(this, function (_a) {
405
404
  switch (_a.label) {
406
- case 0: return [4 /*yield*/, window.threekit.treble.addToWishlist(config)];
405
+ case 0: return [4 /*yield*/, window.threekit.treble.wishlist.addItem(config)];
407
406
  case 1:
408
407
  wishlistData = _a.sent();
409
408
  dispatch(setWishlist(wishlistData));
@@ -413,7 +412,7 @@ var addToWishlist = function (config) { return function (dispatch) { return __aw
413
412
  }); }; };
414
413
  exports.addToWishlist = addToWishlist;
415
414
  var removeFromWishlist = function (idx) { return function (dispatch) {
416
- var wishlistData = window.threekit.treble.removeFromWishlist(idx);
415
+ var wishlistData = window.threekit.treble.wishlist.removeItemByIdx(idx);
417
416
  dispatch(setWishlist(wishlistData));
418
417
  }; };
419
418
  exports.removeFromWishlist = removeFromWishlist;
@@ -426,7 +425,7 @@ var resumeFromWishlist = function (idx) { return function (dispatch, getState) {
426
425
  }; };
427
426
  exports.resumeFromWishlist = resumeFromWishlist;
428
427
  var clearWishlist = function () { return function (dispatch) {
429
- var wishlistData = window.threekit.treble.clearWishlist();
428
+ var wishlistData = window.threekit.treble.wishlist.clearWishlist();
430
429
  dispatch(setWishlist(wishlistData));
431
430
  }; };
432
431
  exports.clearWishlist = clearWishlist;
@@ -1,6 +1,7 @@
1
1
  import Treble from './Treble';
2
2
  declare type SCENE_PHASES = 'LOADED' | 'PRELOADED' | 'RENDERED';
3
3
  declare type PRIVATE_APIS = 'scene' | 'player';
4
+ export declare type DISPLAY_OPTIONS = 'webgl' | 'image';
4
5
  declare type IAttributeTypes = 'String' | 'Asset' | 'Color' | 'Number';
5
6
  export declare type IMetadata = Record<string, string | number | null>;
6
7
  /***************************************************
@@ -215,6 +216,7 @@ export interface ThreekitInitConfig {
215
216
  locale?: string;
216
217
  allowMobileVerticalOrbit?: boolean;
217
218
  publishStage?: string;
219
+ display?: DISPLAY_OPTIONS;
218
220
  }
219
221
  /***************************************************
220
222
  * Global Declaration
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@threekit-tools/treble",
3
- "version": "0.0.10-alpha.17+f763859",
3
+ "version": "0.0.15",
4
4
  "author": "Amaan Saeed",
5
5
  "license": "MIT",
6
6
  "files": [
@@ -9,13 +9,17 @@
9
9
  "main": "dist/index.js",
10
10
  "module": "dist/index.js",
11
11
  "types": "dist/index.d.js",
12
+ "publishConfig": {
13
+ "directory": "dist"
14
+ },
12
15
  "scripts": {
13
16
  "start": "tsc --watch",
14
17
  "build": "tsc",
15
18
  "clean": "rimraf dist",
16
- "format": "prettier --write ./src",
17
19
  "storybook": "start-storybook -p 6006",
18
- "build-storybook": "build-storybook -o build"
20
+ "build-storybook": "build-storybook -o build",
21
+ "lint": "eslint ./src",
22
+ "format": "prettier --write ./src"
19
23
  },
20
24
  "dependencies": {
21
25
  "@reduxjs/toolkit": "^1.6.2",
@@ -40,7 +44,6 @@
40
44
  "@types/redux-logger": "^3.0.9",
41
45
  "@types/styled-components": "^5.1.15",
42
46
  "babel-loader": "^8.2.2",
43
- "prettier": "^2.4.1",
44
47
  "react": ">=17.0.2",
45
48
  "react-dom": ">=17.0.2",
46
49
  "rimraf": "^3.0.2",
@@ -48,5 +51,5 @@
48
51
  "storybook-addon-styled-component-theme": "^2.0.0",
49
52
  "typescript": ">=4.4.4"
50
53
  },
51
- "gitHead": "f763859aaef26b38e765bc143447b09104e90001"
54
+ "gitHead": "2e16bcf98f81e16bb1768072fdb3968122e7966f"
52
55
  }