@threekit-tools/treble 0.0.82 → 0.0.85-next-1

package/dist/components/Share/index.js

@@ -1,45 +1,166 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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 __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Share = void 0;
-var react_1 = __importDefault(require("react"));
+var react_1 = __importStar(require("react"));
 var prop_types_1 = __importDefault(require("prop-types"));
 var Button_1 = __importDefault(require("../Button"));
+var message_1 = __importDefault(require("../message"));
 var Share_1 = __importDefault(require("../../icons/Share"));
 var useThreekitInitStatus_1 = __importDefault(require("../../hooks/useThreekitInitStatus"));
-var useShare_1 = __importDefault(require("../../hooks/useShare"));
 var utils_1 = require("../../utils");
+var share_styles_1 = require("./share.styles");
 var Share = function (props) {
-    var _a = Object.assign({ type: 'threekit', shape: 'round', message: 'Link copied!' }, props), shape = _a.shape, type = _a.type, className = _a.className, message = _a.message;
+    var _a = Object.assign({
+        type: 'threekit',
+        shape: 'round',
+        message: 'Link copied!',
+        position: 'bottom-right',
+        saveSceneGraphState: false,
+    }, props), shape = _a.shape, type = _a.type, className = _a.className, msg = _a.message, position = _a.position, saveSceneGraphState = _a.saveSceneGraphState;
     var hasLoaded = (0, useThreekitInitStatus_1.default)();
-    var handleShare = (0, useShare_1.default)();
-    if (!hasLoaded || !handleShare)
+    var _b = (0, react_1.useState)(false), show = _b[0], setShow = _b[1];
+    var _c = (0, react_1.useState)(null), resumeUrl = _c[0], setResumeUrl = _c[1];
+    var resumeUrlElRef = (0, react_1.useRef)(null);
+    var shareButtonRef = (0, react_1.useRef)(null);
+    var shareContentRef = (0, react_1.useRef)(null);
+    (0, react_1.useEffect)(function () {
+        var handleClickOutside = function (e) {
+            var _a, _b;
+            if (!e)
+                return;
+            if (!((_a = shareButtonRef.current) === null || _a === void 0 ? void 0 : _a.contains(e.target)) &&
+                !((_b = shareContentRef.current) === null || _b === void 0 ? void 0 : _b.contains(e.target))) {
+                setShow(false);
+                e.stopPropagation();
+            }
+        };
+        document.addEventListener('mousedown', handleClickOutside);
+        return function () {
+            document.removeEventListener('mousedown', handleClickOutside);
+        };
+    }, [show, shareButtonRef, shareContentRef]);
+    if (!hasLoaded)
         return null;
     var cls = (0, utils_1.generateWidgetClassName)('share', className);
-    var handleClick = function () {
-        handleShare(message);
-    };
-    return (react_1.default.createElement(Button_1.default, { className: cls, shape: shape, type: type, icon: Share_1.default.iconName, onClick: handleClick }));
+    var handleClick = function () { return __awaiter(void 0, void 0, void 0, function () {
+        var configuration, e_1;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    if (show) {
+                        setResumeUrl(null);
+                        setShow(!show);
+                        return [2];
+                    }
+                    return [4, window.threekit.treble.saveConfiguration({
+                            saveSceneGraphState: saveSceneGraphState,
+                        })];
+                case 1:
+                    configuration = _a.sent();
+                    _a.label = 2;
+                case 2:
+                    _a.trys.push([2, 4, , 5]);
+                    return [4, navigator.clipboard.writeText(configuration.resumableUrl)];
+                case 3:
+                    _a.sent();
+                    if (msg === null || msg === void 0 ? void 0 : msg.length)
+                        message_1.default.info(msg);
+                    return [3, 5];
+                case 4:
+                    e_1 = _a.sent();
+                    setResumeUrl(configuration.resumableUrl);
+                    setShow(!show);
+                    return [3, 5];
+                case 5: return [2];
+            }
+        });
+    }); };
+    var handleClickCopy = function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            if (!((_a = resumeUrlElRef.current) === null || _a === void 0 ? void 0 : _a.value))
+                return [2];
+            navigator.clipboard.writeText(resumeUrlElRef.current.value);
+            if (msg === null || msg === void 0 ? void 0 : msg.length)
+                message_1.default.info(msg);
+            return [2];
+        });
+    }); };
+    return (react_1.default.createElement(share_styles_1.Wrapper, { ref: shareButtonRef },
+        react_1.default.createElement(Button_1.default, { className: cls, shape: shape, type: type, icon: Share_1.default.iconName, onClick: handleClick }),
+        show ? (react_1.default.createElement(share_styles_1.ShareWrapper, { position: position },
+            react_1.default.createElement(share_styles_1.Content, { ref: shareContentRef },
+                react_1.default.createElement("input", { type: "text", ref: resumeUrlElRef, value: resumeUrl || '', onChange: function () { } }),
+                react_1.default.createElement("button", { type: "button", onClick: handleClickCopy }, "copy link")),
+            react_1.default.createElement(share_styles_1.Caret, null))) : null));
 };
 exports.Share = Share;
 exports.Share.propTypes = {
     className: prop_types_1.default.string,
-    /**
-     * The presentational type of the input component. Options
-     * include: `hollow`, `standard`, `accent`, `primary`
-     */
     type: prop_types_1.default.string,
-    /**
-     * Used to set the shape of the Widget button. Options
-     * include: `square`, `round`
-     */
     shape: prop_types_1.default.string,
-    /**
-     * Used to set an overwrite of the message presented to the user
-     * when the share URL has been successfully copied.
-     */
     message: prop_types_1.default.string,
 };
 exports.Share.defaultProps = {
@@ -47,5 +168,6 @@ exports.Share.defaultProps = {
     shape: 'round',
     type: 'threekit',
     message: 'Link copied!',
+    saveSceneGraphState: false,
 };
 exports.default = exports.Share;

package/dist/components/Share/share.styles.d.ts

@@ -0,0 +1,9 @@
+export declare type Positions = 'top-right' | 'bottom-right' | 'bottom-left' | 'top-left';
+interface PositionProps {
+    position: Positions;
+}
+export declare const Wrapper: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
+export declare const Content: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
+export declare const Caret: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, {}, never>;
+export declare const ShareWrapper: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, PositionProps, never>;
+export {};

package/dist/components/Share/share.styles.js

@@ -0,0 +1,23 @@
+"use strict";
+var __makeTemplateObject = (this && this.__makeTemplateObject) || function (cooked, raw) {
+    if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
+    return cooked;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShareWrapper = exports.Caret = exports.Content = exports.Wrapper = void 0;
+var styled_components_1 = __importDefault(require("styled-components"));
+exports.Wrapper = styled_components_1.default.div(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n  height: 40px;\n  width: 40px;\n  position: relative;\n"], ["\n  height: 40px;\n  width: 40px;\n  position: relative;\n"])));
+var ShareWrapperStyles = styled_components_1.default.div(templateObject_2 || (templateObject_2 = __makeTemplateObject(["\n  position: relative;\n"], ["\n  position: relative;\n"])));
+exports.Content = styled_components_1.default.div(templateObject_3 || (templateObject_3 = __makeTemplateObject(["\n  padding: 24px 18px;\n  border-radius: 4px;\n  background: rgba(0, 0, 0, 0.9);\n  color: white;\n  font-size: 16px;\n  width: 290px;\n\n  display: flex;\n  flex-direction: row;\n  justify-content: center;\n\n  input {\n    background: #555555;\n    color: #ffffff;\n    border: none;\n    outline: none;\n    padding: 9px;\n    border-radius: 4px;\n    font-size: 13px;\n    text-overflow: ellipsis;\n    width: 180px;\n  }\n\n  button {\n    color: #2a94f5;\n    font-size: 13px;\n    background: none;\n    outline: none;\n    border: none;\n    cursor: pointer;\n  }\n"], ["\n  padding: 24px 18px;\n  border-radius: 4px;\n  background: rgba(0, 0, 0, 0.9);\n  color: white;\n  font-size: 16px;\n  width: 290px;\n\n  display: flex;\n  flex-direction: row;\n  justify-content: center;\n\n  input {\n    background: #555555;\n    color: #ffffff;\n    border: none;\n    outline: none;\n    padding: 9px;\n    border-radius: 4px;\n    font-size: 13px;\n    text-overflow: ellipsis;\n    width: 180px;\n  }\n\n  button {\n    color: #2a94f5;\n    font-size: 13px;\n    background: none;\n    outline: none;\n    border: none;\n    cursor: pointer;\n  }\n"])));
+exports.Caret = styled_components_1.default.div(templateObject_4 || (templateObject_4 = __makeTemplateObject(["\n  width: 0;\n  height: 0;\n  border-left: 10px solid transparent;\n  border-right: 10px solid transparent;\n  border-top: 8px solid rgba(0, 0, 0, 0.9);\n\n  position: absolute;\n"], ["\n  width: 0;\n  height: 0;\n  border-left: 10px solid transparent;\n  border-right: 10px solid transparent;\n  border-top: 8px solid rgba(0, 0, 0, 0.9);\n\n  position: absolute;\n"])));
+exports.ShareWrapper = (0, styled_components_1.default)(ShareWrapperStyles)(templateObject_5 || (templateObject_5 = __makeTemplateObject(["\n  top: ", ";\n  left: ", ";\n  transform: ", ";\n\n  ", " {\n    left: ", ";\n    top: ", ";\n\n    transform: ", ";\n  }\n"], ["\n  top: ", ";\n  left: ", ";\n  transform: ", ";\n\n  ", " {\n    left: ", ";\n    top: ", ";\n\n    transform: ", ";\n  }\n"])), function (props) { return (props.position.includes('top') ? '14px' : '-100%'); }, function (props) { return (props.position.includes('right') ? '-250px' : 'auto'); }, function (props) {
+    return props.position.includes('top')
+        ? ''
+        : 'translateY(calc(0px - 14px - 100%))';
+}, exports.Caret, function (props) { return (props.position.includes('right') ? '260px' : '10px'); }, function (props) { return (props.position.includes('top') ? '0' : 'auto'); }, function (props) {
+    return props.position.includes('top') ? 'translateY(-100%) scaleY(-1)' : '';
+});
+var templateObject_1, templateObject_2, templateObject_3, templateObject_4, templateObject_5;

package/dist/components/Snapshots/index.d.ts

@@ -13,15 +13,7 @@ export declare const Snapshots: {
     (props: SnapshotProps): JSX.Element | null;
     propTypes: {
         className: PropTypes.Requireable<string>;
-        /**
-         * The presentational type of the input component. Options
-         * include: `hollow`, `standard`, `accent`, `primary`
-         */
         type: PropTypes.Requireable<string>;
-        /**
-         * Used to set the shape of the Widget button. Options
-         * include: `square`, `round`
-         */
         shape: PropTypes.Requireable<string>;
     };
     defaultProps: {

package/dist/components/Snapshots/index.js

@@ -24,15 +24,7 @@ var Snapshots = function (props) {
 exports.Snapshots = Snapshots;
 exports.Snapshots.propTypes = {
     className: prop_types_1.default.string,
-    /**
-     * The presentational type of the input component. Options
-     * include: `hollow`, `standard`, `accent`, `primary`
-     */
     type: prop_types_1.default.string,
-    /**
-     * Used to set the shape of the Widget button. Options
-     * include: `square`, `round`
-     */
     shape: prop_types_1.default.string,
 };
 exports.Snapshots.defaultProps = {

package/dist/components/Strips/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import PropTypes from 'prop-types';
+import { ATTRIBUTE_TYPES } from '../../types';
 import { IFormComponentProps, IOption } from '../containers/formInputContainer';
 export interface IStrips extends IFormComponentProps<IOption> {
     showThumbnail?: boolean;
@@ -9,33 +10,11 @@ export interface IStrips extends IFormComponentProps<IOption> {
 export declare const Strips: {
     (props: IStrips): JSX.Element;
     propTypes: {
-        /**
-         * Is the attribute name on the initialized asset that we are
-         * using this component for. If the attribute prop is used,
-         * the component will ignore the props for: `value`, `options`, `onClick`.
-         */
         attribute: PropTypes.Requireable<string>;
-        /**
-         * Used to add a title to the input
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Used to provide a custom description for the input component
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * Selected value from the option set. Should match the 'value' property
-         * of one of the items in the options array.
-         */
         value: PropTypes.Requireable<string>;
-        /**
-         * Handles the user seletion by passing the value of the selected
-         * option as the argument into the onClick callback.
-         */
         onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * The options set to be displayed for the user
-         */
         options: PropTypes.Requireable<(PropTypes.InferProps<{
             name: PropTypes.Requireable<string>;
             description: PropTypes.Requireable<string>;
@@ -44,44 +23,12 @@ export declare const Strips: {
             color: PropTypes.Requireable<string>;
             disabled: PropTypes.Requireable<boolean>;
         }> | null | undefined)[]>;
-        /**
-         * Used to add a custom class name to each of the components html elements
-         */
         className: PropTypes.Requireable<string>;
-        /**
-         * By default the thumbnail (image/color value) is soruced from the `_thumbnail`
-         * metadata key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **thumbnailFromMetadata** prop.
-         */
         metadataKeyThumbnail: PropTypes.Requireable<string>;
-        /**
-         * By default the description is soruced from the `_description` metadata
-         * key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **metadataKeyDescription**
-         * prop.
-         */
         metadataKeyDescription: PropTypes.Requireable<string>;
-        /**
-         * By default the price of an item is soruced from the pricebook entry for
-         * the option's Catalog Item. The price can alternatively be soruced from
-         * the option's Catalog Item metadata, by specifying the key under which the
-         * price can be found as the **metadataKeyPrice** prop.
-         */
         metadataKeyPrice: PropTypes.Requireable<string>;
-        /**
-         * A boolean to set whether or all the Cards should display thumbnails
-         * for the options.
-         */
         showThumbnail: PropTypes.Requireable<boolean>;
-        /**
-         * A boolean to set whether or all the Cards should display the description
-         * for the options.
-         */
         showDescription: PropTypes.Requireable<boolean>;
-        /**
-         * A boolean to set whether or all the Cards should display the price
-         * for the options/
-         */
         showPrice: PropTypes.Requireable<boolean>;
     };
     defaultProps: {
@@ -100,7 +47,7 @@ export declare const Strips: {
         onClick: undefined;
     };
     componentName: string;
-    compatibleAttributes: Set<string>;
+    compatibleAttributes: Set<ATTRIBUTE_TYPES>;
 };
 declare const _default: (props: IStrips) => JSX.Element | null;
 export default _default;

package/dist/components/Strips/index.js

@@ -11,7 +11,7 @@ var FormComponentDescription_1 = __importDefault(require("../FormComponentDescri
 var strips_styles_1 = require("./strips.styles");
 var shared_styles_1 = require("../shared.styles");
 var utils_1 = require("../../utils");
-var constants_1 = require("../../constants");
+var types_1 = require("../../types");
 var formInputContainer_1 = __importDefault(require("../containers/formInputContainer"));
 var Thumbnail = function (props) {
     var imageUrl = props.imageUrl, color = props.color, name = props.name, className = props.className;
@@ -62,33 +62,11 @@ var Strips = function (props) {
 };
 exports.Strips = Strips;
 exports.Strips.propTypes = {
-    /**
-     * Is the attribute name on the initialized asset that we are
-     * using this component for. If the attribute prop is used,
-     * the component will ignore the props for: `value`, `options`, `onClick`.
-     */
     attribute: prop_types_1.default.string,
-    /**
-     * Used to add a title to the input
-     */
     title: prop_types_1.default.string,
-    /**
-     * Used to provide a custom description for the input component
-     */
     description: prop_types_1.default.string,
-    /**
-     * Selected value from the option set. Should match the 'value' property
-     * of one of the items in the options array.
-     */
     value: prop_types_1.default.string,
-    /**
-     * Handles the user seletion by passing the value of the selected
-     * option as the argument into the onClick callback.
-     */
     onClick: prop_types_1.default.func,
-    /**
-     * The options set to be displayed for the user
-     */
     options: prop_types_1.default.arrayOf(prop_types_1.default.shape({
         name: prop_types_1.default.string,
         description: prop_types_1.default.string,
@@ -97,59 +75,24 @@ exports.Strips.propTypes = {
         color: prop_types_1.default.string,
         disabled: prop_types_1.default.bool,
     })),
-    /**
-     * Used to add a custom class name to each of the components html elements
-     */
     className: prop_types_1.default.string,
-    /**
-     * By default the thumbnail (image/color value) is soruced from the `_thumbnail`
-     * metadata key in the option's Catalog Item. This metadata key can be overwritten
-     * by passing in the prefered key value to the **thumbnailFromMetadata** prop.
-     */
     metadataKeyThumbnail: prop_types_1.default.string,
-    /**
-     * By default the description is soruced from the `_description` metadata
-     * key in the option's Catalog Item. This metadata key can be overwritten
-     * by passing in the prefered key value to the **metadataKeyDescription**
-     * prop.
-     */
     metadataKeyDescription: prop_types_1.default.string,
-    /**
-     * By default the price of an item is soruced from the pricebook entry for
-     * the option's Catalog Item. The price can alternatively be soruced from
-     * the option's Catalog Item metadata, by specifying the key under which the
-     * price can be found as the **metadataKeyPrice** prop.
-     */
     metadataKeyPrice: prop_types_1.default.string,
-    /**
-     * A boolean to set whether or all the Cards should display thumbnails
-     * for the options.
-     */
     showThumbnail: prop_types_1.default.bool,
-    /**
-     * A boolean to set whether or all the Cards should display the description
-     * for the options.
-     */
     showDescription: prop_types_1.default.bool,
-    /**
-     * A boolean to set whether or all the Cards should display the price
-     * for the options/
-     */
     showPrice: prop_types_1.default.bool,
 };
 exports.Strips.defaultProps = {
     description: undefined,
     className: undefined,
-    //  Default use
     attribute: undefined,
-    //  Default user overrides
     metadataKeyThumbnail: undefined,
     metadataKeyDescription: undefined,
     metadataKeyPrice: undefined,
     showThumbnail: true,
     showPrice: true,
     showDescription: true,
-    //  Custom use
     title: undefined,
     value: undefined,
     options: undefined,
@@ -157,7 +100,7 @@ exports.Strips.defaultProps = {
 };
 exports.Strips.componentName = 'strips';
 exports.Strips.compatibleAttributes = new Set([
-    constants_1.ATTRIBUTE_TYPES.asset,
-    constants_1.ATTRIBUTE_TYPES.string,
+    types_1.ATTRIBUTE_TYPES.ASSET,
+    types_1.ATTRIBUTE_TYPES.STRING,
 ]);
 exports.default = (0, formInputContainer_1.default)(exports.Strips);

package/dist/components/Swatch/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import PropTypes from 'prop-types';
+import { ATTRIBUTE_TYPES } from '../../types';
 import { IFormComponentProps, IOption } from '../containers/formInputContainer';
 export interface ISwatch extends IFormComponentProps<IOption> {
     showThumbnail?: boolean;
@@ -10,44 +11,13 @@ export interface ISwatch extends IFormComponentProps<IOption> {
 export declare const Swatch: {
     (props: ISwatch): JSX.Element;
     propTypes: {
-        /**
-         * Is the attribute name on the initialized asset that we are
-         * using this component for. If the attribute prop is used,
-         * the component will ignore the props for: `value`, `options`, `onClick`.
-         */
         attribute: PropTypes.Requireable<string>;
-        /**
-         * Used to set the shape of the Swatch Option component. Options
-         * include: `square`, `round`
-         */
         shape: PropTypes.Requireable<string>;
-        /**
-         * Used to add a title to the input
-         */
         title: PropTypes.Requireable<string>;
-        /**
-         * Used to provide a custom description for the input component
-         */
         description: PropTypes.Requireable<string>;
-        /**
-         * Selected value from the option set. Should match the 'value' property
-         * of one of the items in the options array.
-         */
         value: PropTypes.Requireable<string>;
-        /**
-         * Handles the user seletion by passing the value of the selected
-         * option as the argument into the onClick callback.
-         */
         size: PropTypes.Requireable<string>;
-        /**
-         * The size of the for a swatch option. The size should be a valid CSS
-         * height/width property.
-         *
-         */
         onClick: PropTypes.Requireable<(...args: any[]) => any>;
-        /**
-         * The options set to be displayed for the user
-         */
         options: PropTypes.Requireable<(PropTypes.InferProps<{
             name: PropTypes.Requireable<string>;
             description: PropTypes.Requireable<string>;
@@ -57,44 +27,12 @@ export declare const Swatch: {
             color: PropTypes.Requireable<string>;
             disabled: PropTypes.Requireable<boolean>;
         }> | null | undefined)[]>;
-        /**
-         * Used to add a custom class name to each of the components html elements
-         */
         className: PropTypes.Requireable<string>;
-        /**
-         * By default the thumbnail (image/color value) is soruced from the `_thumbnail`
-         * metadata key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **thumbnailFromMetadata** prop.
-         */
         metadataKeyThumbnail: PropTypes.Requireable<string>;
-        /**
-         * By default the description is soruced from the `_description` metadata
-         * key in the option's Catalog Item. This metadata key can be overwritten
-         * by passing in the prefered key value to the **metadataKeyDescription**
-         * prop.
-         */
         metadataKeyDescription: PropTypes.Requireable<string>;
-        /**
-         * By default the price of an item is soruced from the pricebook entry for
-         * the option's Catalog Item. The price can alternatively be soruced from
-         * the option's Catalog Item metadata, by specifying the key under which the
-         * price can be found as the **metadataKeyPrice** prop.
-         */
         metadataKeyPrice: PropTypes.Requireable<string>;
-        /**
-         * A boolean to set whether or all the Cards should display thumbnails
-         * for the options.
-         */
         showThumbnail: PropTypes.Requireable<boolean>;
-        /**
-         * A boolean to set whether or all the Cards should display the description
-         * for the options.
-         */
         showDescription: PropTypes.Requireable<boolean>;
-        /**
-         * A boolean to set whether or all the Cards should display the price
-         * for the options/
-         */
         showPrice: PropTypes.Requireable<boolean>;
     };
     defaultProps: {
@@ -114,7 +52,7 @@ export declare const Swatch: {
         onClick: undefined;
     };
     componentName: string;
-    compatibleAttributes: Set<string>;
+    compatibleAttributes: Set<ATTRIBUTE_TYPES>;
 };
 declare const _default: (props: ISwatch) => JSX.Element | null;
 export default _default;