@threekit-tools/treble 0.0.57-animation → 0.0.59

package/dist/threekit.d.ts

@@ -84,6 +84,11 @@ export interface IDisplayAttributeAssetValue extends IConfigurationAssetValue {
     tags: Array<string>;
     label: string;
 }
+export interface IHydratedAttributeAssetValue extends IDisplayAttributeAssetValue {
+    label: string;
+    handleSelect: () => Promise<void>;
+    selected: boolean;
+}
 export interface IAttributeAssetBase<V> extends IAttributeBase<'Asset', IConfigurationAsset> {
     assetType: AssetType;
     blacklist: [];
@@ -93,12 +98,17 @@ export interface IAttributeAssetBase<V> extends IAttributeBase<'Asset', IConfigu
     values: Array<V>;
 }
 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;
 }
+export interface IHydratedAttributeStringValue extends IDisplayAttributeStringValue {
+    handleSelect: () => Promise<void>;
+    selected: boolean;
+}
 export interface IAttributeStringBase<V> extends IAttributeBase<'String', string> {
     blacklist: [];
     defaultValue: string;
@@ -107,6 +117,7 @@ export interface IAttributeStringBase<V> extends IAttributeBase<'String', string
     values: Array<V>;
 }
 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> {
@@ -123,7 +134,9 @@ export interface IAttributeNumber extends IAttributeBase<'Number', number> {
 /****** getAttributes() *******/
 export declare type IThreekitAttribute = IAttributeAsset | IAttributeColor | IAttributeString | IAttributeNumber;
 /****** getDisplayAttributes() *******/
-export declare type IThreekitDisplayAttribute = IDisplayAttributeAsset | IAttributeColor | IDisplayAttributeString | IAttributeNumber;
+export declare type IThreekitDisplayAttribute = IDisplayAttributeAsset | IDisplayAttributeString | IAttributeColor | IAttributeNumber;
+/****** Treble Hydrated Values *******/
+export declare type IHydratedAttribute = IHydratedAttributeAsset | IHydratedAttributeString | IAttributeColor | IAttributeNumber;
 /***************************************************
  *  Camera
  **************************************************/
@@ -195,6 +208,7 @@ export interface IThreekitPlayer {
     getConfigurator: () => Promise<IThreekitConfigurator>;
     enableApi: (api: PRIVATE_APIS) => any;
     snapshotAsync: (snapshotConfig: ISnapshotConfig) => Promise<string>;
+    unload: () => Promise<string>;
 }
 export interface IThreekitPrivateConfigurator extends IThreekitConfigurator {
     getAppliedConfiguration: (attributeName: string) => string;
@@ -262,6 +276,7 @@ export interface IProducts extends Record<string, string | Partial<IProduct>> {
 export interface IProject {
     credentials: ICredentials;
     products: IProducts;
+    serverUrl?: string;
 }
 export interface ITrebleConfig {
     project: IProject;

package/dist/utils.d.ts

@@ -1,4 +1,3 @@
-import { ITranslationMap } from './api/products';
 import { IThreekitCamera, IConfigurationColor, ICoordinates, IQuaternion, IThreekitDisplayAttribute } from './threekit';
 import { ITrebleConfig, IAttributeTypes } from './threekit';
 import { RawAttributeValue } from './hooks/useAttribute';
@@ -43,17 +42,10 @@ export declare const getCameraPosition: (cameraApi: IThreekitCamera) => {
 export declare const setCameraPosition: (cameraApi: IThreekitCamera, cameraPosition: ICameraPosition) => void;
 export declare const dataURItoBlob: (dataURI: string) => Blob;
 export declare const dataURItoFile: (dataURI: string, filename: string) => File;
+export declare const downloadSnapshot: (snapshot: string, filename: string) => Promise<void>;
 export declare const copyToClipboard: (data: string | Record<string, string | number | boolean>) => void;
 export declare const easeInOutCubic: (val: number) => number;
 export declare const metadataValueToObject: (data: string) => Record<string, string | number>;
-/**
- * A function to load the Threekit JS Player API script
- *
- * @param threekitDomain The threekit environement to use. i.e. preview.threekit.com
- * @returns
- */
-export declare const createThreekitScriptEl: (threekitDomain: string) => Promise<void>;
-export declare const translateAttribute: (attributes: Array<IThreekitDisplayAttribute>, translations?: ITranslationMap | undefined, language?: string | undefined) => IThreekitDisplayAttribute;
 export declare const selectionToConfiguration: (value: RawAttributeValue, attributeType: IAttributeTypes) => string | number | boolean | File | IConfigurationColor | {
     assetId: RawAttributeValue;
 } | undefined;

package/dist/utils.js

@@ -1,4 +1,40 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
         if (ar || !(i in from)) {
@@ -9,7 +45,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadTrebleConfig = exports.isUuid = exports.filterFormAttributes = exports.selectionToConfiguration = exports.translateAttribute = exports.createThreekitScriptEl = exports.metadataValueToObject = exports.easeInOutCubic = exports.copyToClipboard = exports.dataURItoFile = exports.dataURItoBlob = exports.setCameraPosition = exports.getCameraPosition = exports.findHitNode = exports.deflateRgb = exports.inflateRgb = exports.rgbToHex = exports.hexToRgb = exports.regularToKebabCase = exports.deepCompare = exports.shallowCompare = exports.getResumableUrl = exports.getParams = exports.objectToQueryStr = exports.isJsonString = exports.generateFormClassName = exports.generateDisplayClassName = exports.generateToolClassName = exports.generateLayoutClassName = exports.generateWidgetClassName = exports.generateInputClassName = exports.generateClassName = void 0;
+exports.loadTrebleConfig = exports.isUuid = exports.filterFormAttributes = exports.selectionToConfiguration = exports.metadataValueToObject = exports.easeInOutCubic = exports.copyToClipboard = exports.downloadSnapshot = exports.dataURItoFile = exports.dataURItoBlob = exports.setCameraPosition = exports.getCameraPosition = exports.findHitNode = exports.deflateRgb = exports.inflateRgb = exports.rgbToHex = exports.hexToRgb = exports.regularToKebabCase = exports.deepCompare = exports.shallowCompare = exports.getResumableUrl = exports.getParams = exports.objectToQueryStr = exports.isJsonString = exports.generateFormClassName = exports.generateDisplayClassName = exports.generateToolClassName = exports.generateLayoutClassName = exports.generateWidgetClassName = exports.generateInputClassName = exports.generateClassName = void 0;
 var constants_1 = require("./constants");
 var generateClassName = function (baseClass) {
     return function (component, customClassName, title) {
@@ -225,6 +261,27 @@ var dataURItoFile = function (dataURI, filename) {
     return new File([u8arr], filename, { type: mime });
 };
 exports.dataURItoFile = dataURItoFile;
+var downloadSnapshot = function (snapshot, filename) { return __awaiter(void 0, void 0, void 0, function () {
+    var blob, blobUrl, link, clickHandler;
+    return __generator(this, function (_a) {
+        blob = (0, exports.dataURItoBlob)(snapshot);
+        blobUrl = URL.createObjectURL(blob);
+        link = document.createElement('a');
+        link.href = blobUrl;
+        link.download = filename;
+        clickHandler = function () {
+            setTimeout(function () {
+                URL.revokeObjectURL(blobUrl);
+                link.removeEventListener('click', clickHandler);
+            }, 150);
+        };
+        link.addEventListener('click', clickHandler);
+        document.body.appendChild(link);
+        link.click();
+        return [2 /*return*/];
+    });
+}); };
+exports.downloadSnapshot = downloadSnapshot;
 var copyToClipboard = function (data) {
     if (!data)
         return;
@@ -252,59 +309,6 @@ var metadataValueToObject = function (data) {
     }, {});
 };
 exports.metadataValueToObject = metadataValueToObject;
-/**
- * A function to load the Threekit JS Player API script
- *
- * @param threekitDomain The threekit environement to use. i.e. preview.threekit.com
- * @returns
- */
-var createThreekitScriptEl = function (threekitDomain) {
-    return new Promise(function (resolve) {
-        var script = document.createElement('script');
-        script.src = "".concat(threekitDomain, "/app/js/threekit-player-bundle.js");
-        script.id = 'threekit-player-bundle';
-        script.onload = function () { return resolve(); };
-        document.head.appendChild(script);
-    });
-};
-exports.createThreekitScriptEl = createThreekitScriptEl;
-var translateAttribute = function (attributes, translations, language) {
-    var hasTranslation = !!language && !!translations;
-    return attributes.reduce(function (output, attribute) {
-        var _a;
-        var _b;
-        return Object.assign(output, (_a = {},
-            _a[attribute.name] = Object.assign({}, attribute, {
-                label: hasTranslation
-                    ? ((_b = translations === null || translations === void 0 ? void 0 : translations[attribute.name]) === null || _b === void 0 ? void 0 : _b[language]) || attribute.name
-                    : attribute.name,
-            }, attribute.type === 'String'
-                ? {
-                    values: attribute.values.map(function (el) {
-                        var _a;
-                        return Object.assign({}, el, {
-                            label: hasTranslation
-                                ? ((_a = translations === null || translations === void 0 ? void 0 : translations[el.label]) === null || _a === void 0 ? void 0 : _a[language]) || el.label
-                                : attribute.name,
-                        });
-                    }),
-                }
-                : attribute.type === 'Asset'
-                    ? {
-                        values: attribute.values.map(function (el) {
-                            var _a;
-                            return Object.assign({}, el, {
-                                label: hasTranslation
-                                    ? ((_a = translations === null || translations === void 0 ? void 0 : translations[el.name]) === null || _a === void 0 ? void 0 : _a[language]) || el.name
-                                    : attribute.name,
-                            });
-                        }),
-                    }
-                    : undefined),
-            _a));
-    });
-};
-exports.translateAttribute = translateAttribute;
 var selectionToConfiguration = function (value, attributeType) {
     switch (attributeType) {
         case constants_1.ATTRIBUTE_TYPES.number:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@threekit-tools/treble",
-  "version": "0.0.57-animation",
+  "version": "0.0.59",
   "author": "Amaan Saeed",
   "license": "MIT",
   "files": [

package/dist/hooks/useArrayAttribute/index.d.ts

@@ -1,2 +0,0 @@
-export declare type AttributeIdentifier = string | RegExp;
-export declare const useArrayAttribute: (attributeIdentifier: AttributeIdentifier) => string | RegExp | never[];

package/dist/hooks/useArrayAttribute/index.js

@@ -1,184 +0,0 @@
-"use strict";
-// import { useThreekitSelector, useThreekitDispatch } from '../../store';
-// import { getAttributes, setConfiguration } from '../../store/attributes';
-// import { selectionToConfiguration } from '../../utils';
-// import {
-//   IConfigurationColor,
-//   ISetConfiguration,
-//   IThreekitDisplayAttribute,
-// } from '../../threekit';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useArrayAttribute = void 0;
-// export type AttributeValue = string | number | boolean | IConfigurationColor;
-// type UseAttributeError = [undefined, undefined];
-// type UseAttributeSuccess = [
-//   IThreekitDisplayAttribute,
-//   (val: AttributeValue) => void
-// ];
-var useArrayAttribute = function (attributeIdentifier) {
-    if (!attributeIdentifier)
-        return [];
-    return attributeIdentifier;
-};
-exports.useArrayAttribute = useArrayAttribute;
-//  Ordinal Configurator (Psuedo-Array type attribute)
-// export const addItemToArray = (arrayLabel) => (
-//     assetId,
-//     addToIdx = undefined
-//   ) => async (dispatch, getState) => {
-//     if (!assetId?.length) return;
-//     const { threekit } = getState();
-//     const attributesRegExp = new RegExp(`${arrayLabel} [0-9]`);
-//     const arrayAttributes = filterAttributesArray(
-//       attributesRegExp,
-//       threekit.attributes
-//     );
-//     let updateAttrIdx = addToIdx;
-//     let attributeToUpdate;
-//     if (isNaN(updateAttrIdx))
-//       attributeToUpdate = Object.values(arrayAttributes).find((el, idx) => {
-//         if (!el.value.assetId?.length) {
-//           updateAttrIdx = idx;
-//           return true;
-//         }
-//       });
-//     else attributeToUpdate = arrayAttributes[updateAttrIdx];
-//     if (!attributeToUpdate) return message.info('Max items reached');
-//     let error;
-//     const options = Object.values(arrayAttributes)[0].values.reduce(
-//       (output, item) => Object.assign(output, { [item.assetId]: item }),
-//       {}
-//     );
-//     const updatedArray = Object.values(arrayAttributes).reduce(
-//       (output, attr, i) => {
-//         if (i !== updateAttrIdx) output.push(attr);
-//         else output.push({ ...attr, value: { assetId } });
-//         return output;
-//       },
-//       []
-//     );
-//     //  Default Validator
-//     error = arrayValidator(options, updatedArray);
-//     if (error) return message.info(error);
-//     //  Custom Validator
-//     if (MIDDLEWARE.arrayValidation?.[arrayLabel])
-//       error = MIDDLEWARE.arrayValidation?.[arrayLabel](options, updatedArray);
-//     if (error) return message.info(error);
-//     dispatch(setConfiguration({ [attributeToUpdate.name]: { assetId } }));
-//   };
-//   export const deleteItemFromArray = (arrayLabel) => (idx) => async (
-//     dispatch,
-//     getState
-//   ) => {
-//     if (isNaN(idx)) return;
-//     const { threekit } = getState();
-//     const attributesRegExp = new RegExp(`${arrayLabel} [0-9]`);
-//     const arrayAttributes = filterAttributesArray(
-//       attributesRegExp,
-//       threekit.attributes
-//     );
-//     let error;
-//     const options = Object.values(arrayAttributes)[0].values.reduce(
-//       (output, item) => Object.assign(output, { [item.assetId]: item }),
-//       {}
-//     );
-//     const updatedArray = Object.values(arrayAttributes).filter(
-//       (_, i) => i !== idx
-//     );
-//     //  Default Validator
-//     error = arrayValidator(options, updatedArray);
-//     if (error) return message.info(error);
-//     //  Custom Validator
-//     if (MIDDLEWARE.arrayValidation?.[arrayLabel])
-//       error = MIDDLEWARE.arrayValidation?.[arrayLabel](options, updatedArray);
-//     if (error) return message.info(error);
-//     const arrayConfigurationObj = filterAttributesArray(
-//       attributesRegExp,
-//       window.threekit.configurator.getConfiguration()
-//     );
-//     const arrayConfiguration = Object.entries(arrayConfigurationObj);
-//     const updatedConfiguration = arrayConfiguration.reduce(
-//       (output, [attributeName], i) => {
-//         if (i < idx) return output;
-//         if (!arrayConfiguration[i + 1])
-//           return Object.assign(output, { [attributeName]: { assetId: '' } });
-//         return Object.assign(output, {
-//           [attributeName]: arrayConfiguration[i + 1][1],
-//         });
-//       },
-//       {}
-//     );
-//     dispatch(setConfiguration(updatedConfiguration));
-//   };
-//   export const moveItemWithinArray = (arrayLabel) => (
-//   fromIdx,
-//   toIdx,
-//   config
-// ) => async (dispatch, getState) => {
-//   if (isNaN(fromIdx) || isNaN(fromIdx)) return;
-//   const { threekit } = getState();
-//   const { method } = Object.assign({ method: 'move' }, config);
-//   const attributesRegExp =
-//     typeof arrayLabel === 'string'
-//       ? new RegExp(`${arrayLabel} [0-9]`)
-//       : arrayLabel;
-//   const arrayAttributes = filterAttributesArray(
-//     attributesRegExp,
-//     threekit.attributes
-//   );
-//   let error;
-//   const options = Object.values(arrayAttributes)[0].values.reduce(
-//     (output, item) => Object.assign(output, { [item.assetId]: item }),
-//     {}
-//   );
-//   let updatedArray;
-//   switch (method) {
-//     case 'move':
-//       updatedArray = Object.values(arrayAttributes).reduce(
-//         (output, attr, idx, srcArray) => {
-//           if (idx === fromIdx) return output;
-//           output.push(attr);
-//           if (idx === toIdx) output.push(srcArray[fromIdx]);
-//           return output;
-//         },
-//         []
-//       );
-//       break;
-//     default:
-//       break;
-//   }
-//   //  Default Validator
-//   error = arrayValidator(options, updatedArray);
-//   if (error) return message.info(error);
-//   //  Custom Validator
-//   if (MIDDLEWARE.arrayValidation?.[arrayLabel])
-//     error = MIDDLEWARE.arrayValidation?.[arrayLabel](options, updatedArray);
-//   if (error) return message.info(error);
-//   const arrayConfigurationObj = filterAttributesArray(
-//     attributesRegExp,
-//     window.threekit.configurator.getConfiguration()
-//   );
-//   const attributeKeys = Object.keys(arrayConfigurationObj);
-//   const arrayConfiguration = Object.values(arrayConfigurationObj);
-//   let updatedConfiguration;
-//   switch (method) {
-//     case 'move':
-//       updatedConfiguration = arrayConfiguration.reduce(
-//         (output, configuration, idx, srcArray) => {
-//           if (idx === fromIdx) return output;
-//           output = Object.assign(output, {
-//             [attributeKeys.shift()]: configuration,
-//           });
-//           if (idx === toIdx)
-//             output = Object.assign(output, {
-//               [attributeKeys.shift()]: srcArray[fromIdx],
-//             });
-//           return output;
-//         },
-//         {}
-//       );
-//       break;
-//     default:
-//       break;
-//   }
-//   dispatch(setConfiguration(updatedConfiguration));