@neurodyn/room-viewer 0.0.32 → 0.1.0

package/dist/room-viewer.js

@@ -42,38 +42,198 @@ class RoomViewerDialogRenderer {
         }));
     }
 }
-function readTriggerProps(trigger, props = {}) {
+function contract_attribute(name, parser, details) {
     return {
-        disableClose: void 0 !== props.disableClose ? props.disableClose : 'true' === trigger.getAttribute('data-neurodyn-room-viewer-disable-close'),
-        type: void 0 !== props.type ? props.type : trigger.getAttribute('data-neurodyn-room-viewer-type'),
-        src: void 0 !== props.src ? props.src : trigger.getAttribute('data-neurodyn-room-viewer-src'),
-        tinuuid: void 0 !== props.tinuuid ? props.tinuuid : trigger.getAttribute('data-neurodyn-room-viewer-tinuuid'),
-        roomId: void 0 !== props.roomId ? props.roomId : trigger.getAttribute('data-neurodyn-room-viewer-room-id') ?? void 0,
-        name: void 0 !== props.name ? props.name : trigger.getAttribute('data-neurodyn-room-viewer-name'),
-        language: void 0 !== props.language ? props.language : trigger.getAttribute('data-neurodyn-room-viewer-language'),
-        width: void 0 !== props.width ? props.width : readNumberAttribute(trigger, 'data-neurodyn-room-viewer-width'),
-        height: void 0 !== props.height ? props.height : readNumberAttribute(trigger, 'data-neurodyn-room-viewer-height'),
-        dimensionUnit: void 0 !== props.dimensionUnit ? props.dimensionUnit : readDimensionUnitAttribute(trigger, 'data-neurodyn-room-viewer-dimension-unit'),
-        displayUnit: void 0 !== props.displayUnit ? props.displayUnit : readDisplayUnitAttribute(trigger, 'data-neurodyn-room-viewer-display-unit'),
-        apiKey: void 0 !== props.apiKey ? props.apiKey : trigger.getAttribute('data-neurodyn-room-viewer-api-key'),
-        source: void 0 !== props.source ? props.source : readSourceAttribute(trigger, 'data-neurodyn-room-viewer-source')
+        kind: 'attribute',
+        name,
+        parse: parser.parse,
+        values: parser.values,
+        ...details
     };
 }
-function readNumberAttribute(trigger, name) {
-    const value = trigger.getAttribute(name);
-    return value ? Number(value) : void 0;
+function optionOnly(reason) {
+    return {
+        kind: 'option',
+        reason
+    };
 }
-function readDimensionUnitAttribute(trigger, name) {
-    const value = trigger.getAttribute(name);
-    return 'm' === value || 'cm' === value || 'in' === value ? value : void 0;
+function defineTriggerContract() {
+    return (contract)=>contract;
 }
-function readDisplayUnitAttribute(trigger, name) {
-    const value = trigger.getAttribute(name);
-    return 'cm' === value || 'in' === value ? value : void 0;
+function contract_attributeEntries(contract) {
+    return Object.entries(contract.fields).filter((entry)=>'attribute' === entry[1].kind);
 }
-function readSourceAttribute(trigger, name) {
+function readRawAttribute(trigger, name, legacyNames = []) {
     const value = trigger.getAttribute(name);
-    return 'default' === value || 'shopify' === value ? value : void 0;
+    if (0 === legacyNames.length || value?.trim()) return value;
+    for (const legacyName of legacyNames){
+        const legacyValue = trigger.getAttribute(legacyName);
+        if (legacyValue?.trim()) return legacyValue;
+    }
+    return value;
+}
+function readTriggerAttributes(trigger, contract, options = {}) {
+    const values = {};
+    for (const [key, field] of contract_attributeEntries(contract)){
+        const name = `${contract.prefix}${field.name}`;
+        const option = options[key];
+        if (void 0 !== option) {
+            values[key] = field.normalizesOptions ? field.parse(option, {
+                attribute: name
+            }) : option;
+            continue;
+        }
+        values[key] = field.parse(readRawAttribute(trigger, name, field.legacyNames), {
+            attribute: name
+        });
+    }
+    return values;
+}
+function parsers_text() {
+    return {
+        parse: (raw)=>raw ?? void 0
+    };
+}
+function number() {
+    return {
+        parse: (raw)=>raw ? Number(raw) : void 0
+    };
+}
+function flag() {
+    return {
+        parse: (raw)=>'true' === raw
+    };
+}
+function oneOf(values) {
+    return {
+        parse: (raw)=>values.includes(raw ?? '') ? raw : void 0,
+        values
+    };
+}
+function unchecked(values) {
+    return {
+        parse: (raw)=>raw ?? void 0,
+        values
+    };
+}
+function listOf() {
+    return (values)=>values;
+}
+const ROOM_VIEWER_TRIGGER_ATTRIBUTE = 'data-neurodyn-room-viewer-dialog';
+const ROOM_VIEWER_RESOURCE_TYPES = listOf()([
+    'wallart',
+    'rugs',
+    'flooring',
+    'wall-panel'
+]);
+const ROOM_VIEWER_DIMENSION_UNITS = listOf()([
+    'm',
+    'cm',
+    'in'
+]);
+const ROOM_VIEWER_DISPLAY_UNITS = listOf()([
+    'cm',
+    'in'
+]);
+const ROOM_VIEWER_LANGUAGES = listOf()([
+    'en',
+    'ru'
+]);
+const ROOM_VIEWER_SOURCES = listOf()([
+    'default',
+    'shopify'
+]);
+const roomViewerContract = defineTriggerContract()({
+    prefix: 'data-neurodyn-room-viewer-',
+    markers: [
+        {
+            name: ROOM_VIEWER_TRIGGER_ATTRIBUTE,
+            description: 'Marks an element for the embed build.'
+        }
+    ],
+    fields: {
+        type: contract_attribute('type', unchecked(ROOM_VIEWER_RESOURCE_TYPES), {
+            required: true,
+            description: 'Resource type.'
+        }),
+        src: contract_attribute('src', parsers_text(), {
+            required: {
+                when: 'type',
+                is: [
+                    'wallart'
+                ]
+            },
+            description: 'Wall-art image URL.'
+        }),
+        tinuuid: contract_attribute('tinuuid', parsers_text(), {
+            required: {
+                when: 'type',
+                is: [
+                    'rugs',
+                    'flooring',
+                    'wall-panel'
+                ]
+            },
+            description: 'The object\'s tinuuid.'
+        }),
+        roomId: contract_attribute('room-id', parsers_text(), {
+            required: false,
+            description: 'Initial Room ID from the available catalog. Skips the initial interior chooser; unavailable Rooms open the chooser. Empty values do nothing.'
+        }),
+        name: contract_attribute('name', parsers_text(), {
+            required: true,
+            description: 'Title shown in the dialog header.'
+        }),
+        width: contract_attribute('width', number(), {
+            required: false,
+            description: 'Wall-art width. Used when `type` is `wallart`.'
+        }),
+        height: contract_attribute('height', number(), {
+            required: false,
+            description: 'Wall-art height. Used when `type` is `wallart`.'
+        }),
+        dimensionUnit: contract_attribute('dimension-unit', oneOf(ROOM_VIEWER_DIMENSION_UNITS), {
+            required: false,
+            defaultValue: '`m`',
+            description: 'Unit used by wall-art width and height.'
+        }),
+        displayUnit: contract_attribute('display-unit', oneOf(ROOM_VIEWER_DISPLAY_UNITS), {
+            required: false,
+            defaultValue: '`cm`',
+            description: 'Unit used to display UI measurements.'
+        }),
+        language: contract_attribute('language', oneOf(ROOM_VIEWER_LANGUAGES), {
+            required: false,
+            defaultValue: 'User locale',
+            description: 'UI language override.'
+        }),
+        apiKey: contract_attribute('api-key', parsers_text(), {
+            required: true,
+            description: 'Public API key sent as `x-api-key`. Not needed when `source` is `shopify`.'
+        }),
+        source: contract_attribute('source', oneOf(ROOM_VIEWER_SOURCES), {
+            required: false,
+            defaultValue: '`default`',
+            description: 'Backend source mode.'
+        }),
+        disableClose: contract_attribute('disable-close', flag(), {
+            required: false,
+            defaultValue: '`false`',
+            description: 'Set to `true` to hide close controls and prevent dismissal.'
+        }),
+        widgetSession: optionOnly('An existing Widget Session handed over by an embedding surface such as Shopify.'),
+        open: optionOnly('The embed build owns the open state.'),
+        defaultOpen: optionOnly('The embed build owns the open state.'),
+        onOpenChange: optionOnly('The embed build owns the open state.')
+    }
+});
+function readTriggerProps(trigger, props = {}) {
+    const values = readTriggerAttributes(trigger, roomViewerContract, props);
+    return {
+        ...values,
+        type: values.type,
+        name: values.name
+    };
 }
 class src_RoomViewerDialog {
     renderer = new RoomViewerDialogRenderer();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@neurodyn/room-viewer",
   "type": "module",
-  "version": "0.0.32",
+  "version": "0.1.0",
   "publishConfig": {
     "access": "public"
   },
@@ -10,6 +10,11 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/room-viewer.js",
       "default": "./dist/room-viewer.js"
+    },
+    "./contract": {
+      "types": "./dist/contract.d.ts",
+      "import": "./dist/contract.js",
+      "default": "./dist/contract.js"
     }
   },
   "main": "./dist/room-viewer.js",
@@ -21,7 +26,7 @@
   "dependencies": {
     "react": "^19.2.0",
     "react-dom": "^19.2.0",
-    "@neurodyn/react-room-viewer": "0.0.32"
+    "@neurodyn/react-room-viewer": "0.0.34"
   },
   "devDependencies": {
     "@google/model-viewer": "4.2.0",
@@ -56,7 +61,6 @@
     "react-i18next": "^16.3.5",
     "react-intersection-observer": "^10.0.0",
     "react-zoom-pan-pinch": "3.7.0",
-    "swiper": "^12.1.0",
     "tailwind-merge": "3.4.0",
     "three": "^0.185.1",
     "typescript": "^5.9.3",
@@ -67,6 +71,9 @@
     "dev": "rslib build --watch",
     "build": "rslib build",
     "test": "vitest run",
+    "test:contract": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "docs:generate": "vitest run --update src/contract.docs.test.ts",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "rsdoctor": "RSDOCTOR=true rslib build"