npm - @roomle/web-sdk - Versions diffs - 2.44.0-alpha.1 → 2.44.0-alpha.3 - Mend

@roomle/web-sdk 2.44.0-alpha.1 → 2.44.0-alpha.3

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 (225) hide show

package/lib/configurator-dummy.html CHANGED Viewed

@@ -1,94 +1,182 @@
 <!DOCTYPE html>
 <html>
-<head>
-    <meta charset="utf-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
     <title>HSC Dummy</title>
-    <meta name="description" content="">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-</head>
-<body>
-<style>
-    .loadConfiguration {
+    <meta name="description" content="" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+  </head>
+  <body>
+    <style>
+      .loadConfiguration {
         background-color: lightblue;
-    }
+      }
-    .loadConfigurableItem {
+      .loadConfigurableItem {
         background-color: lightsalmon;
-    }
-</style>
-<div>
-    <textarea type="text" id="input-configuration"></textarea>
-    <button id="load-configuration" disabled="disabled">Load configuration</button>
-    <button id="load-rapi-configuration" disabled="disabled">Load rapi configuration</button>
-    <button id="load-item" disabled="disabled">Load rapi item</button>
-</div>
-<div class="dummy-buttons">
-    <button disabled="disabled" class="loadConfigurableItem" data-rml-id="sitzfeldt:Panama_L_version_rechts">Sitzfeldt
-        Sofa
-    </button>
-    <button disabled="disabled" class="loadConfigurableItem" data-rml-id="koinor:Formia_11710052">Formia Sofa</button>
-    <button disabled="disabled" class="loadConfigurableItem" data-rml-id="joka:Arte_Bed">Joka Bed</button>
-    <button disabled="disabled" class="loadConfigurableItem" data-rml-id="moormann:FNP2">Moormann Shelf</button>
-    <button disabled="disabled" class="loadConfigurableItem" data-rml-id="team7:RilettoBed">Team7 Bed</button>
-    <button disabled="disabled" class="loadConfigurableItem" data-rml-id="strasser:ST-ONEUnitL244">Strasser Kitchen
-    </button>
+      }
+    </style>
+    <div>
+      <textarea type="text" id="input-configuration"></textarea>
+      <button id="load-configuration" disabled="disabled">
+        Load configuration
+      </button>
+      <button id="load-rapi-configuration" disabled="disabled">
+        Load rapi configuration
+      </button>
+      <button id="load-item" disabled="disabled">Load rapi item</button>
+    </div>
+    <div class="dummy-buttons">
+      <button
+        disabled="disabled"
+        class="loadConfigurableItem"
+        data-rml-id="sitzfeldt:Panama_L_version_rechts"
+      >
+        Sitzfeldt Sofa
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfigurableItem"
+        data-rml-id="koinor:Formia_11710052"
+      >
+        Formia Sofa
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfigurableItem"
+        data-rml-id="joka:Arte_Bed"
+      >
+        Joka Bed
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfigurableItem"
+        data-rml-id="moormann:FNP2"
+      >
+        Moormann Shelf
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfigurableItem"
+        data-rml-id="team7:RilettoBed"
+      >
+        Team7 Bed
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfigurableItem"
+        data-rml-id="strasser:ST-ONEUnitL244"
+      >
+        Strasser Kitchen
+      </button>
-    <button disabled="disabled" class="loadConfiguration"
-            data-rml-id="venjakob:Turn:3941E6FE3112C540CB94152649A6F6512BDABA6322BBC7372B8D89EA5A44F5D5">Venkajob Chair
-    </button>
-    <button disabled="disabled" class="loadConfiguration"
-            data-rml-id="biohort:Highline_Master:E4A40F90869CFB913BF9BC68A4CE6407C2602FEC1C386F1CAECA2A142766F871">
+      <button
+        disabled="disabled"
+        class="loadConfiguration"
+        data-rml-id="venjakob:Turn:3941E6FE3112C540CB94152649A6F6512BDABA6322BBC7372B8D89EA5A44F5D5"
+      >
+        Venkajob Chair
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfiguration"
+        data-rml-id="biohort:Highline_Master:E4A40F90869CFB913BF9BC68A4CE6407C2602FEC1C386F1CAECA2A142766F871"
+      >
         Biohort
-    </button>
-    <button disabled="disabled" class="loadConfiguration"
-            data-rml-id="usm:frame:FA92430853C0E886C163F12A7DEAEB4609CD3EAC30AA9AC2B6601E6273EB3130">USM conf from RAPI
-    </button>
-    <button disabled="disabled" class="loadConfiguration"
-            data-rml-id="KIKA:Consul:01D1C44477E66A4F12A98E6834A496C8A95FA99492FEC6380087F479F5B709EB">Kika conf from
-        RAPI
-    </button>
-    <button disabled="disabled" class="loadConfiguration"
-            data-rml-id="ikea:PAX_Wardrobe:61B46FE6B3C405B706F67FAA093092C2DFB9C691052AFC72F9B941BA81BB0C44">Ikea conf
-        from RAPI
-    </button>
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfiguration"
+        data-rml-id="usm:frame:FA92430853C0E886C163F12A7DEAEB4609CD3EAC30AA9AC2B6601E6273EB3130"
+      >
+        USM conf from RAPI
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfiguration"
+        data-rml-id="KIKA:Consul:01D1C44477E66A4F12A98E6834A496C8A95FA99492FEC6380087F479F5B709EB"
+      >
+        Kika conf from RAPI
+      </button>
+      <button
+        disabled="disabled"
+        class="loadConfiguration"
+        data-rml-id="ikea:PAX_Wardrobe:61B46FE6B3C405B706F67FAA093092C2DFB9C691052AFC72F9B941BA81BB0C44"
+      >
+        Ikea conf from RAPI
+      </button>
-    <button disabled="disabled" id="load-configuration-sofa">KIKA Sofa</button>
-    <button disabled="disabled" id="load-configuration-string-big">USM from String (big)</button>
-    <button disabled="disabled" id="load-configuration-string-small">USM from String (small)</button>
-    <button disabled="disabled" id="load-configuration-fantoni">Fantoni from String</button>
-    <button disabled="disabled" id="load-configuration-muuto">Muuto from String</button>
-    <button disabled="disabled" id="debug-scene-graph">Scene Graph</button>
-    <button disabled="disabled" id="component-change-width">Change Width to 350.00</button>
-    <button disabled="disabled" id="preview-dockings">Show Ghosts</button>
-    <button disabled="disabled" id="preview-dockings-fantoni">Show Fantoni Ghosts</button>
-    <button disabled="disabled" id="preview-dockings-muuto">Show Muuto Ghosts</button>
-    <button disabled="disabled" id="preview-dockings-umdasch">Show Umdasch Ghosts</button>
-    <button disabled="disabled" id="image">Perspective Image</button>
-    <button disabled="disabled" id="top-image">Top Image</button>
-    <button disabled="disabled" id="part-image">Part Image</button>
-    <button disabled="disabled" id="render-image">Render Image</button>
-    <button disabled="disabled" id="component-delete">Delete Component</button>
-    <button disabled="disabled" id="camera-reset">Reset Camera</button>
-    <button disabled="disabled" id="pause">Pause</button>
-    <button disabled="disabled" id="resume">Resume</button>
-    <button disabled="disabled" id="component-info">Component Info</button>
-</div>
-<script>
-    window.performance.mark('load_app_js_start');
-    var appjsLoaded = function load(event) {
+      <button disabled="disabled" id="load-configuration-sofa">
+        KIKA Sofa
+      </button>
+      <button disabled="disabled" id="load-configuration-string-big">
+        USM from String (big)
+      </button>
+      <button disabled="disabled" id="load-configuration-string-small">
+        USM from String (small)
+      </button>
+      <button disabled="disabled" id="load-configuration-fantoni">
+        Fantoni from String
+      </button>
+      <button disabled="disabled" id="load-configuration-muuto">
+        Muuto from String
+      </button>
+      <button disabled="disabled" id="debug-scene-graph">Scene Graph</button>
+      <button disabled="disabled" id="component-change-width">
+        Change Width to 350.00
+      </button>
+      <button disabled="disabled" id="preview-dockings">Show Ghosts</button>
+      <button disabled="disabled" id="preview-dockings-fantoni">
+        Show Fantoni Ghosts
+      </button>
+      <button disabled="disabled" id="preview-dockings-muuto">
+        Show Muuto Ghosts
+      </button>
+      <button disabled="disabled" id="preview-dockings-umdasch">
+        Show Umdasch Ghosts
+      </button>
+      <button disabled="disabled" id="image">Perspective Image</button>
+      <button disabled="disabled" id="top-image">Top Image</button>
+      <button disabled="disabled" id="part-image">Part Image</button>
+      <button disabled="disabled" id="render-image">Render Image</button>
+      <button disabled="disabled" id="component-delete">
+        Delete Component
+      </button>
+      <button disabled="disabled" id="camera-reset">Reset Camera</button>
+      <button disabled="disabled" id="pause">Pause</button>
+      <button disabled="disabled" id="resume">Resume</button>
+      <button disabled="disabled" id="component-info">Component Info</button>
+    </div>
+    <script>
+      window.performance.mark('load_app_js_start');
+      var appjsLoaded = function load(event) {
         console.log('ON LOAD DONE');
         window.performance.mark('load_app_js_end');
-        window.performance.measure('load_app_js', 'load_app_js_start', 'load_app_js_end');
+        window.performance.measure(
+          'load_app_js',
+          'load_app_js_start',
+          'load_app_js_end'
+        );
         const script = document.createElement('script');
         script.src = 'configurator-dummy-app.js';
         document.body.appendChild(script);
-    };
-</script>
-<div id="roomle-configurator"
-     style="height: 100vh; width: 100%; background-color: deeppink; border: solid 1px gray"></div>
-<script src="configurator-main.js" id="appjs" type="module" onload="appjsLoaded();"></script>
-</body>
+      };
+    </script>
+    <div
+      id="roomle-configurator"
+      style="
+        height: 100vh;
+        width: 100%;
+        background-color: deeppink;
+        border: solid 1px gray;
+      "
+    ></div>
+    <script
+      src="configurator-main.js"
+      id="appjs"
+      type="module"
+      onload="appjsLoaded();"
+    ></script>
+  </body>
 </html>

package/lib/configurator-main-10fa7f9b.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import"./query-params-helper-a271f9dc.js";import"./roomle-dependency-injection-0464676f.js";import"./main-thread-to-worker-88f74244.js";import"./roomle-configurator-43aab7fd.js";import"./pixotron-5905d47b.js";import"./script-loader-394f7657.js";import"./component-raycast-helper-23393bb6.js";import"./default-light-setting-408ac1bd.js";import{Configurator}from"./configurator-a0113de7.js";(new Configurator).boot(),window.requestIdleCallback\|\|(window.requestIdleCallback=o=>setTimeout(()=>{let e=Date.now();o({didTimeout:!1,timeRemaining:()=>Math.max(0,50-(Date.now()-e))})},1)),window.cancelIdleCallback\|\|(window.cancelIdleCallback=window.cancelIdleCallback\|\|function(o){clearTimeout(o)});
2	+ //# sourceMappingURL=configurator-main-10fa7f9b.js.map

package/lib/configurator-main-10fa7f9b.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"configurator-main-10fa7f9b.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/lib/configurator-main.nomodule.js CHANGED Viewed

@@ -1,2 +1,2 @@
-System.register(["./query-params-helper-c231e1b8.nomodule.js","./roomle-dependency-injection-4c51790a.nomodule.js","./main-thread-to-worker-31ec8d3a.nomodule.js","./roomle-configurator-e2cafe97.nomodule.js","./pixotron-11d8ecf1.nomodule.js","./script-loader-ff5cfb68.nomodule.js","./component-raycast-helper-917c5fce.nomodule.js","./default-light-setting-e2fe40ee.nomodule.js","./configurator-74c366d0.nomodule.js"],(function(){var e;return{setters:[function(){},function(){},function(){},function(){},function(){},function(){},function(){},function(){},function(o){e=o.Configurator}],execute:function(){(new e).boot(),window.requestIdleCallback||(window.requestIdleCallback=e=>setTimeout(()=>{let o=Date.now();e({didTimeout:!1,timeRemaining:()=>Math.max(0,50-(Date.now()-o))})},1)),window.cancelIdleCallback||(window.cancelIdleCallback=window.cancelIdleCallback||function(e){clearTimeout(e)})}}}));
+System.register(["./query-params-helper-c231e1b8.nomodule.js","./roomle-dependency-injection-07615f35.nomodule.js","./main-thread-to-worker-6a4eb1ee.nomodule.js","./roomle-configurator-e72d373d.nomodule.js","./pixotron-9fe87cf0.nomodule.js","./script-loader-8efb6055.nomodule.js","./component-raycast-helper-3ec360cf.nomodule.js","./default-light-setting-f72c0eb6.nomodule.js","./configurator-6e17bbb4.nomodule.js"],(function(){var e;return{setters:[function(){},function(){},function(){},function(){},function(){},function(){},function(){},function(){},function(o){e=o.Configurator}],execute:function(){(new e).boot(),window.requestIdleCallback||(window.requestIdleCallback=e=>setTimeout(()=>{let o=Date.now();e({didTimeout:!1,timeRemaining:()=>Math.max(0,50-(Date.now()-o))})},1)),window.cancelIdleCallback||(window.cancelIdleCallback=window.cancelIdleCallback||function(e){clearTimeout(e)})}}}));
 //# sourceMappingURL=configurator-main.nomodule.js.map

package/lib/{default-light-setting-43be6138.js → default-light-setting-408ac1bd.js} RENAMED Viewed

@@ -1,2 +1,2 @@
-import{h as getGUI}from"./roomle-dependency-injection-244ed68c.js";import{L as LightSetting}from"./pixotron-e1f44e21.js";class DefaultLightSetting extends LightSetting{constructor(i,t){super(i,t),this._params={ambientLight:{color:"#ffffff"},mainDirLight:{position:{x:-3,y:4,z:4},color:"#ffffff"},secondDirLight:{position:{x:3,y:4,z:3},color:"#ffffff"}},this._mainDirectionalLight=new THREE.DirectionalLight(new THREE.Color(this._params.mainDirLight.color),.8),this._mainDirectionalLight.position.set(this._params.mainDirLight.position.x,this._params.mainDirLight.position.y,this._params.mainDirLight.position.z),this._mainDirectionalLight.layers.set(1),this._mainDirectionalLight.castShadow=!0,this._mainDirectionalLight.shadow.camera.near=.1,this._mainDirectionalLight.shadow.camera.far=100,this._mainDirectionalLight.shadow.mapSize=new THREE.Vector2(1024,1024),this._mainDirectionalLight.visible=!0,this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)),this._secondDirectionalLight=new THREE.DirectionalLight(new THREE.Color(this._params.secondDirLight.color),.2),this._secondDirectionalLight.position.set(this._params.secondDirLight.position.x,this._params.secondDirLight.position.y,this._params.secondDirLight.position.z),this._secondDirectionalLight.layers.set(1),this._secondDirectionalLight.castShadow=!1,this._secondDirectionalLight.shadow.camera.near=.1,this._secondDirectionalLight.shadow.camera.far=100,this._secondDirectionalLight.shadow.mapSize=new THREE.Vector2(1024,1024),this._secondDirectionalLight.visible=!0,this._secondDirectionalLight.lookAt(new THREE.Vector3(0,0,0)),this._ambientLight=new THREE.AmbientLight(new THREE.Color(this._params.ambientLight.color),.5),this._ambientLight.layers.set(1),this.addToScene()}needsBounds(){return!0}updateBounds(i){const t=i.getSize(new THREE.Vector3),a=Math.max(Math.max(t.x,t.y),t.z)+1,e=a/2;this._mainDirectionalLight.shadow.camera.top=e,this._mainDirectionalLight.shadow.camera.bottom=-e,this._mainDirectionalLight.shadow.camera.left=-e,this._mainDirectionalLight.shadow.camera.right=e,this._mainDirectionalLight.shadow.camera.near=.01,this._mainDirectionalLight.shadow.camera.far=4*a,this._mainDirectionalLight.shadow.camera.updateProjectionMatrix(),this._secondDirectionalLight.shadow.camera.top=e,this._secondDirectionalLight.shadow.camera.bottom=-e,this._secondDirectionalLight.shadow.camera.left=-e,this._secondDirectionalLight.shadow.camera.right=e,this._secondDirectionalLight.shadow.camera.near=.01,this._secondDirectionalLight.shadow.camera.far=4*a,this._secondDirectionalLight.shadow.camera.updateProjectionMatrix()}addToScene(){this._scene.add(this._mainDirectionalLight),this._scene.add(this._secondDirectionalLight),this._scene.add(this._ambientLight)}removeFromScene(){this._scene.remove(this._mainDirectionalLight),this._scene.remove(this._secondDirectionalLight),this._scene.remove(this._ambientLight)}reload(){this.removeFromScene(),this.addToScene()}showGUI(){let i=getGUI();if(i){if(this._ambientLight){let t=i.addFolder("Ambient Light");t.add(this._ambientLight,"visible"),t.add(this._ambientLight,"intensity").min(0).max(5).step(.1),t.addColor(this._params.ambientLight,"color").onChange(i=>this._ambientLight.color=new THREE.Color(i))}if(this._mainDirectionalLight){let t=i.addFolder("Main Directional Light");t.add(this._mainDirectionalLight,"visible"),t.add(this._mainDirectionalLight,"intensity").min(0).max(10).step(.1),t.add(this._mainDirectionalLight,"castShadow"),t.addColor(this._params.mainDirLight,"color").onChange(i=>this._mainDirectionalLight.color=new THREE.Color(i)),t.add(this._mainDirectionalLight.position,"x").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._mainDirectionalLight.position,"y").min(-10).max(50).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._mainDirectionalLight.position,"z").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)))}if(this._secondDirectionalLight){let t=i.addFolder("Second Directional Light");t.add(this._secondDirectionalLight,"visible"),t.add(this._secondDirectionalLight,"intensity").min(0).max(10).step(.1),t.add(this._secondDirectionalLight,"castShadow"),t.addColor(this._params.mainDirLight,"color").onChange(i=>this._mainDirectionalLight.color=new THREE.Color(i)),t.add(this._secondDirectionalLight.position,"x").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._secondDirectionalLight.position,"y").min(-10).max(50).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._secondDirectionalLight.position,"z").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)))}}}}export{DefaultLightSetting as D};
-//# sourceMappingURL=default-light-setting-43be6138.js.map
+import{h as getGUI}from"./roomle-dependency-injection-0464676f.js";import{L as LightSetting}from"./pixotron-5905d47b.js";class DefaultLightSetting extends LightSetting{constructor(i,t){super(i,t),this._params={ambientLight:{color:"#ffffff"},mainDirLight:{position:{x:-3,y:4,z:4},color:"#ffffff"},secondDirLight:{position:{x:3,y:4,z:3},color:"#ffffff"}},this._mainDirectionalLight=new THREE.DirectionalLight(new THREE.Color(this._params.mainDirLight.color),.8),this._mainDirectionalLight.position.set(this._params.mainDirLight.position.x,this._params.mainDirLight.position.y,this._params.mainDirLight.position.z),this._mainDirectionalLight.layers.set(1),this._mainDirectionalLight.castShadow=!0,this._mainDirectionalLight.shadow.camera.near=.1,this._mainDirectionalLight.shadow.camera.far=100,this._mainDirectionalLight.shadow.mapSize=new THREE.Vector2(1024,1024),this._mainDirectionalLight.visible=!0,this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)),this._secondDirectionalLight=new THREE.DirectionalLight(new THREE.Color(this._params.secondDirLight.color),.2),this._secondDirectionalLight.position.set(this._params.secondDirLight.position.x,this._params.secondDirLight.position.y,this._params.secondDirLight.position.z),this._secondDirectionalLight.layers.set(1),this._secondDirectionalLight.castShadow=!1,this._secondDirectionalLight.shadow.camera.near=.1,this._secondDirectionalLight.shadow.camera.far=100,this._secondDirectionalLight.shadow.mapSize=new THREE.Vector2(1024,1024),this._secondDirectionalLight.visible=!0,this._secondDirectionalLight.lookAt(new THREE.Vector3(0,0,0)),this._ambientLight=new THREE.AmbientLight(new THREE.Color(this._params.ambientLight.color),.5),this._ambientLight.layers.set(1),this.addToScene()}needsBounds(){return!0}updateBounds(i){const t=i.getSize(new THREE.Vector3),a=Math.max(Math.max(t.x,t.y),t.z)+1,o=a/2;this._mainDirectionalLight.shadow.camera.top=o,this._mainDirectionalLight.shadow.camera.bottom=-o,this._mainDirectionalLight.shadow.camera.left=-o,this._mainDirectionalLight.shadow.camera.right=o,this._mainDirectionalLight.shadow.camera.near=.01,this._mainDirectionalLight.shadow.camera.far=4*a,this._mainDirectionalLight.shadow.camera.updateProjectionMatrix(),this._secondDirectionalLight.shadow.camera.top=o,this._secondDirectionalLight.shadow.camera.bottom=-o,this._secondDirectionalLight.shadow.camera.left=-o,this._secondDirectionalLight.shadow.camera.right=o,this._secondDirectionalLight.shadow.camera.near=.01,this._secondDirectionalLight.shadow.camera.far=4*a,this._secondDirectionalLight.shadow.camera.updateProjectionMatrix()}addToScene(){this._scene.add(this._mainDirectionalLight),this._scene.add(this._secondDirectionalLight),this._scene.add(this._ambientLight)}removeFromScene(){this._scene.remove(this._mainDirectionalLight),this._scene.remove(this._secondDirectionalLight),this._scene.remove(this._ambientLight)}reload(){this.removeFromScene(),this.addToScene()}showGUI(){let i=getGUI();if(i){if(this._ambientLight){let t=i.addFolder("Ambient Light");t.add(this._ambientLight,"visible"),t.add(this._ambientLight,"intensity").min(0).max(5).step(.1),t.addColor(this._params.ambientLight,"color").onChange(i=>this._ambientLight.color=new THREE.Color(i))}if(this._mainDirectionalLight){let t=i.addFolder("Main Directional Light");t.add(this._mainDirectionalLight,"visible"),t.add(this._mainDirectionalLight,"intensity").min(0).max(10).step(.1),t.add(this._mainDirectionalLight,"castShadow"),t.addColor(this._params.mainDirLight,"color").onChange(i=>this._mainDirectionalLight.color=new THREE.Color(i)),t.add(this._mainDirectionalLight.position,"x").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._mainDirectionalLight.position,"y").min(-10).max(50).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._mainDirectionalLight.position,"z").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)))}if(this._secondDirectionalLight){let t=i.addFolder("Second Directional Light");t.add(this._secondDirectionalLight,"visible"),t.add(this._secondDirectionalLight,"intensity").min(0).max(10).step(.1),t.add(this._secondDirectionalLight,"castShadow"),t.addColor(this._params.mainDirLight,"color").onChange(i=>this._mainDirectionalLight.color=new THREE.Color(i)),t.add(this._secondDirectionalLight.position,"x").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._secondDirectionalLight.position,"y").min(-10).max(50).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._secondDirectionalLight.position,"z").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)))}}}}export{DefaultLightSetting as D};
+//# sourceMappingURL=default-light-setting-408ac1bd.js.map

package/lib/default-light-setting-408ac1bd.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"default-light-setting-408ac1bd.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/lib/{default-light-setting-e2fe40ee.nomodule.js → default-light-setting-f72c0eb6.nomodule.js} RENAMED Viewed

@@ -1,2 +1,2 @@
-System.register(["./roomle-dependency-injection-4c51790a.nomodule.js","./pixotron-11d8ecf1.nomodule.js"],(function(i){var t,a;return{setters:[function(i){t=i.h},function(i){a=i.L}],execute:function(){i("D",class extends a{constructor(i,t){super(i,t),this._params={ambientLight:{color:"#ffffff"},mainDirLight:{position:{x:-3,y:4,z:4},color:"#ffffff"},secondDirLight:{position:{x:3,y:4,z:3},color:"#ffffff"}},this._mainDirectionalLight=new THREE.DirectionalLight(new THREE.Color(this._params.mainDirLight.color),.8),this._mainDirectionalLight.position.set(this._params.mainDirLight.position.x,this._params.mainDirLight.position.y,this._params.mainDirLight.position.z),this._mainDirectionalLight.layers.set(1),this._mainDirectionalLight.castShadow=!0,this._mainDirectionalLight.shadow.camera.near=.1,this._mainDirectionalLight.shadow.camera.far=100,this._mainDirectionalLight.shadow.mapSize=new THREE.Vector2(1024,1024),this._mainDirectionalLight.visible=!0,this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)),this._secondDirectionalLight=new THREE.DirectionalLight(new THREE.Color(this._params.secondDirLight.color),.2),this._secondDirectionalLight.position.set(this._params.secondDirLight.position.x,this._params.secondDirLight.position.y,this._params.secondDirLight.position.z),this._secondDirectionalLight.layers.set(1),this._secondDirectionalLight.castShadow=!1,this._secondDirectionalLight.shadow.camera.near=.1,this._secondDirectionalLight.shadow.camera.far=100,this._secondDirectionalLight.shadow.mapSize=new THREE.Vector2(1024,1024),this._secondDirectionalLight.visible=!0,this._secondDirectionalLight.lookAt(new THREE.Vector3(0,0,0)),this._ambientLight=new THREE.AmbientLight(new THREE.Color(this._params.ambientLight.color),.5),this._ambientLight.layers.set(1),this.addToScene()}needsBounds(){return!0}updateBounds(i){const t=i.getSize(new THREE.Vector3),a=Math.max(Math.max(t.x,t.y),t.z)+1,o=a/2;this._mainDirectionalLight.shadow.camera.top=o,this._mainDirectionalLight.shadow.camera.bottom=-o,this._mainDirectionalLight.shadow.camera.left=-o,this._mainDirectionalLight.shadow.camera.right=o,this._mainDirectionalLight.shadow.camera.near=.01,this._mainDirectionalLight.shadow.camera.far=4*a,this._mainDirectionalLight.shadow.camera.updateProjectionMatrix(),this._secondDirectionalLight.shadow.camera.top=o,this._secondDirectionalLight.shadow.camera.bottom=-o,this._secondDirectionalLight.shadow.camera.left=-o,this._secondDirectionalLight.shadow.camera.right=o,this._secondDirectionalLight.shadow.camera.near=.01,this._secondDirectionalLight.shadow.camera.far=4*a,this._secondDirectionalLight.shadow.camera.updateProjectionMatrix()}addToScene(){this._scene.add(this._mainDirectionalLight),this._scene.add(this._secondDirectionalLight),this._scene.add(this._ambientLight)}removeFromScene(){this._scene.remove(this._mainDirectionalLight),this._scene.remove(this._secondDirectionalLight),this._scene.remove(this._ambientLight)}reload(){this.removeFromScene(),this.addToScene()}showGUI(){let i=t();if(i){if(this._ambientLight){let t=i.addFolder("Ambient Light");t.add(this._ambientLight,"visible"),t.add(this._ambientLight,"intensity").min(0).max(5).step(.1),t.addColor(this._params.ambientLight,"color").onChange(i=>this._ambientLight.color=new THREE.Color(i))}if(this._mainDirectionalLight){let t=i.addFolder("Main Directional Light");t.add(this._mainDirectionalLight,"visible"),t.add(this._mainDirectionalLight,"intensity").min(0).max(10).step(.1),t.add(this._mainDirectionalLight,"castShadow"),t.addColor(this._params.mainDirLight,"color").onChange(i=>this._mainDirectionalLight.color=new THREE.Color(i)),t.add(this._mainDirectionalLight.position,"x").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._mainDirectionalLight.position,"y").min(-10).max(50).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._mainDirectionalLight.position,"z").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)))}if(this._secondDirectionalLight){let t=i.addFolder("Second Directional Light");t.add(this._secondDirectionalLight,"visible"),t.add(this._secondDirectionalLight,"intensity").min(0).max(10).step(.1),t.add(this._secondDirectionalLight,"castShadow"),t.addColor(this._params.mainDirLight,"color").onChange(i=>this._mainDirectionalLight.color=new THREE.Color(i)),t.add(this._secondDirectionalLight.position,"x").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._secondDirectionalLight.position,"y").min(-10).max(50).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._secondDirectionalLight.position,"z").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)))}}}})}}}));
-//# sourceMappingURL=default-light-setting-e2fe40ee.nomodule.js.map
+System.register(["./roomle-dependency-injection-07615f35.nomodule.js","./pixotron-9fe87cf0.nomodule.js"],(function(i){var t,a;return{setters:[function(i){t=i.h},function(i){a=i.L}],execute:function(){i("D",class extends a{constructor(i,t){super(i,t),this._params={ambientLight:{color:"#ffffff"},mainDirLight:{position:{x:-3,y:4,z:4},color:"#ffffff"},secondDirLight:{position:{x:3,y:4,z:3},color:"#ffffff"}},this._mainDirectionalLight=new THREE.DirectionalLight(new THREE.Color(this._params.mainDirLight.color),.8),this._mainDirectionalLight.position.set(this._params.mainDirLight.position.x,this._params.mainDirLight.position.y,this._params.mainDirLight.position.z),this._mainDirectionalLight.layers.set(1),this._mainDirectionalLight.castShadow=!0,this._mainDirectionalLight.shadow.camera.near=.1,this._mainDirectionalLight.shadow.camera.far=100,this._mainDirectionalLight.shadow.mapSize=new THREE.Vector2(1024,1024),this._mainDirectionalLight.visible=!0,this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)),this._secondDirectionalLight=new THREE.DirectionalLight(new THREE.Color(this._params.secondDirLight.color),.2),this._secondDirectionalLight.position.set(this._params.secondDirLight.position.x,this._params.secondDirLight.position.y,this._params.secondDirLight.position.z),this._secondDirectionalLight.layers.set(1),this._secondDirectionalLight.castShadow=!1,this._secondDirectionalLight.shadow.camera.near=.1,this._secondDirectionalLight.shadow.camera.far=100,this._secondDirectionalLight.shadow.mapSize=new THREE.Vector2(1024,1024),this._secondDirectionalLight.visible=!0,this._secondDirectionalLight.lookAt(new THREE.Vector3(0,0,0)),this._ambientLight=new THREE.AmbientLight(new THREE.Color(this._params.ambientLight.color),.5),this._ambientLight.layers.set(1),this.addToScene()}needsBounds(){return!0}updateBounds(i){const t=i.getSize(new THREE.Vector3),a=Math.max(Math.max(t.x,t.y),t.z)+1,o=a/2;this._mainDirectionalLight.shadow.camera.top=o,this._mainDirectionalLight.shadow.camera.bottom=-o,this._mainDirectionalLight.shadow.camera.left=-o,this._mainDirectionalLight.shadow.camera.right=o,this._mainDirectionalLight.shadow.camera.near=.01,this._mainDirectionalLight.shadow.camera.far=4*a,this._mainDirectionalLight.shadow.camera.updateProjectionMatrix(),this._secondDirectionalLight.shadow.camera.top=o,this._secondDirectionalLight.shadow.camera.bottom=-o,this._secondDirectionalLight.shadow.camera.left=-o,this._secondDirectionalLight.shadow.camera.right=o,this._secondDirectionalLight.shadow.camera.near=.01,this._secondDirectionalLight.shadow.camera.far=4*a,this._secondDirectionalLight.shadow.camera.updateProjectionMatrix()}addToScene(){this._scene.add(this._mainDirectionalLight),this._scene.add(this._secondDirectionalLight),this._scene.add(this._ambientLight)}removeFromScene(){this._scene.remove(this._mainDirectionalLight),this._scene.remove(this._secondDirectionalLight),this._scene.remove(this._ambientLight)}reload(){this.removeFromScene(),this.addToScene()}showGUI(){let i=t();if(i){if(this._ambientLight){let t=i.addFolder("Ambient Light");t.add(this._ambientLight,"visible"),t.add(this._ambientLight,"intensity").min(0).max(5).step(.1),t.addColor(this._params.ambientLight,"color").onChange(i=>this._ambientLight.color=new THREE.Color(i))}if(this._mainDirectionalLight){let t=i.addFolder("Main Directional Light");t.add(this._mainDirectionalLight,"visible"),t.add(this._mainDirectionalLight,"intensity").min(0).max(10).step(.1),t.add(this._mainDirectionalLight,"castShadow"),t.addColor(this._params.mainDirLight,"color").onChange(i=>this._mainDirectionalLight.color=new THREE.Color(i)),t.add(this._mainDirectionalLight.position,"x").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._mainDirectionalLight.position,"y").min(-10).max(50).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._mainDirectionalLight.position,"z").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)))}if(this._secondDirectionalLight){let t=i.addFolder("Second Directional Light");t.add(this._secondDirectionalLight,"visible"),t.add(this._secondDirectionalLight,"intensity").min(0).max(10).step(.1),t.add(this._secondDirectionalLight,"castShadow"),t.addColor(this._params.mainDirLight,"color").onChange(i=>this._mainDirectionalLight.color=new THREE.Color(i)),t.add(this._secondDirectionalLight.position,"x").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._secondDirectionalLight.position,"y").min(-10).max(50).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0))),t.add(this._secondDirectionalLight.position,"z").min(-10).max(10).step(.1).onChange(()=>this._mainDirectionalLight.lookAt(new THREE.Vector3(0,0,0)))}}}})}}}));
+//# sourceMappingURL=default-light-setting-f72c0eb6.nomodule.js.map

package/lib/default-light-setting-f72c0eb6.nomodule.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"default-light-setting-f72c0eb6.nomodule.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/lib/definitions/common-core/src/lightsetting/dynamic-light-setting-loader.d.ts CHANGED Viewed

@@ -36,7 +36,7 @@ export interface DynamicLight {
     height?: number;
     movesWithCamera?: boolean;
 }
-type PreDefinedLightSettings = typeof PREDEFINED_LIGHTSETTING[(keyof typeof PREDEFINED_LIGHTSETTING)];
+type PreDefinedLightSettings = (typeof PREDEFINED_LIGHTSETTING)[keyof typeof PREDEFINED_LIGHTSETTING];
 export interface DynamicLightSettingSource {
     url?: string;
     json?: string;

package/lib/definitions/common-core/src/main.d.ts CHANGED Viewed

@@ -19,14 +19,13 @@ export interface GlobalAPI {
      * Sets the available screen space for our item
      * Example 1: right 0.9 means 10% padding on the right side
      * Example 2: bottom 0.2 means 20% padding on the bottom side
-     * default: {left: 0, top: 1, right: 1, bottom: 0}
-     * @param offset {@link CanvasOffset}
+     * default: 'left: 0, top: 1, right: 1, bottom: 0'
+     * @param offset
      */
     setCameraOffset(offset: CanvasOffset): void;
     /**
      * Gets the available screen space for our item
-     * default: {left: 0, top: 1, right: 1, bottom: 0}
-     * Returns {@link CanvasOffset}
+     * default: 'left: 0, top: 1, right: 1, bottom: 0'
      */
     getCameraOffset(): CanvasOffset;
     getUnitFormatter(): UnitFormatter;

package/lib/definitions/common-core/src/utils/shims.d.ts CHANGED Viewed

@@ -188,13 +188,13 @@ export interface ConfiguratorInitData {
     offlineSync?: string;
     /**
      * Set the floor material which is used when loading the configurator
-     * For different options see {@link EnvironmentSetting}
+     * For different options see {@link @roomle/web-sdk/common-core/src/environment/dynamic-environment-setting-loader#EnvironmentSetting}
      */
     initialFloorMaterial?: string;
     /**
      * @internal
      * Load a light setting using an URL.
-     * Check lights in {@link SceneSettings} for an example.
+     * Check lights in {@link @roomle/web-sdk/common-core/src/scene-settings-loader#SceneSettings} for an example.
      */
     dls?: string;
     ls?: string;

package/lib/definitions/configurator-core/src/roomle-configurator.d.ts CHANGED Viewed

@@ -113,7 +113,7 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
      */
     disableHDGeometry(): Promise<void | ConfigurationLoadedResponse>;
     /**
-     * Change the camera offset, see {@link CanvasOffset} for more details
+     * Change the camera offset
      * @param offset
      */
     changeOffset(offset: CanvasOffset): void;
@@ -219,7 +219,7 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
     /**
      * Sets the parameter of the selected component. If nothing is selected the parameters of the
      * parameters of the plan object are set
-     * @param parameter an instance of the kernel parameter we want to set, use {key: "your-key"} if
+     * @param parameter an instance of the kernel parameter we want to set, use 'key: "your-key"' if
      *                  you do not have a kernel instance and do not need validation of the input
      * @param value the value we want to set on the parameter as string
      * @param isRaw turn this to true if you dont want the kernel to parse the value string, e.g. convert 100cm to 1000
@@ -227,7 +227,7 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
     setParameter(parameter: KernelParameter, value: string, isRaw?: boolean): Promise<void>;
     /**
      * Method to set a parameter on the plan object. This is used by embedding as well
-     * @param parameter an instance of the kernel parameter we want to set, use {key: "your-key"} if
+     * @param parameter an instance of the kernel parameter we want to set, use 'key: "your-key"' if
      *                  you do not have a kernel instance and do not need validation of the input
      * @param value the value we want to set on the parameter as string
      */
@@ -238,7 +238,7 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
     getParametersOfPlanObject(): Promise<KernelParameter[]>;
     /**
      * Method to set a parameter on the root component. This is used by embedding as well
-     * @param parameter an instance of the kernel parameter we want to set, use {key: "your-key"} if
+     * @param parameter an instance of the kernel parameter we want to set, use 'key: "your-key"' if
      *                  you do not have a kernel instance and do not need validation of the input
      * @param value the value we want to set on the parameter as string
      */
@@ -294,7 +294,7 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
      */
     requestAsset(url: string): AssetUrl;
     /**
-     * Sets the material of the floor to the given {@link RapiMaterial}.
+     * Sets the material of the floor to the given RapiMaterial.
      * If the current environment is not floor environment it will be changed
      *
      * @param material
@@ -347,7 +347,7 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
      */
     changeTypeChangeTag(rapiId: RapiId): void;
     /**
-     * Just calls {@link onRemoveTypeChangeTag} on {@link ConfiguratorUiCallbacks}
+     * After calling this method the UiCallback removeTypeChangeTag is triggered (see: {@link @roomle/web-sdk/configurator-core/src/services/configurator-ui-callback#ConfiguratorUiCallbacks.onRemoveTypeChangeTag})
      * @param rapiId
      */
     removeTypeChangeTag(rapiId: RapiId): void;
@@ -365,14 +365,14 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
     /**
      * Show dimensions (width, height, depth) of object
      *
-     * See {@link onDimensionsVisibilityChange} to get notified when dimension visibility changes
+     * See {@link @roomle/web-sdk/configurator-core/src/services/configurator-ui-callback#ConfiguratorUiCallbacks.onDimensionsVisibilityChange} to get notified when dimension visibility changes
      */
     showDimensions(): void;
     /**
      * Hides dimensions when they are shown (see {@link showDimensions}).
      * Calling hideDimensions does not force dimensions to be always hidden.
      *
-     * See {@link onDimensionsVisibilityChange} to get notified when dimension visibility changes
+     * See {@link @roomle/web-sdk/configurator-core/src/services/configurator-ui-callback#ConfiguratorUiCallbacks.onDimensionsVisibilityChange} to get notified when dimension visibility changes
      */
     hideDimensions(): void;
     /**
@@ -391,67 +391,67 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
      */
     syncTypeChangeTag(tagId: RapiId): Promise<void>;
     /**
-     * Loads a dynamic light settings into the scene. The dynamic light setting source can be an
-     * object (js), json, or an url (url to json). See {@link SceneSettings} how to define it.
-     *
-     * Exampe:
-     * ```
-     {
-      "lights": [
-        {
-          "type": "rectarea",
-          "name": "main",
-          "intensity": 240,
-          "color": "#ffffff",
-          "position": {
-            "x": -0.5,
-            "y": 6,
-            "z": 3
-          },
-          "target": {
-            "x": 0,
-            "y": 0,
-            "z": 0
+       * Loads a dynamic light settings into the scene. The dynamic light setting source can be an
+       * object (js), json, or an url (url to json). See {@link @roomle/web-sdk/common-core/src/scene-settings-loader#SceneSettings} how to define it.
+       *
+       * Exampe:
+       * ```
+       {
+        "lights": [
+          {
+            "type": "rectarea",
+            "name": "main",
+            "intensity": 240,
+            "color": "#ffffff",
+            "position": {
+              "x": -0.5,
+              "y": 6,
+              "z": 3
+            },
+            "target": {
+              "x": 0,
+              "y": 0,
+              "z": 0
+            },
+            "castShadow": true,
+            "width": 0.8,
+            "height": 0.8
           },
-          "castShadow": true,
-          "width": 0.8,
-          "height": 0.8
-        },
-        {
-          "type": "spot",
-          "name": "side",
-          "intensity": 0.3,
-          "color": "#ffffff",
-          "position": {
-            "x": 2,
-            "y": 3,
-            "z": 1.5
+          {
+            "type": "spot",
+            "name": "side",
+            "intensity": 0.3,
+            "color": "#ffffff",
+            "position": {
+              "x": 2,
+              "y": 3,
+              "z": 1.5
+            },
+            "target": {
+              "x": 0,
+              "y": 0.1,
+              "z": 0
+            },
+            "castShadow": false,
+            "angle": 50,
+            "penumbra": 0.5
           },
-          "target": {
-            "x": 0,
-            "y": 0.1,
-            "z": 0
-          },
-          "castShadow": false,
-          "angle": 50,
-          "penumbra": 0.5
-        },
-        {
-          "type": "ambient",
-          "name": "ambient",
-          "intensity": 0.3,
-          "color": "#ffffff",
-          "position": {
-            "x": 0,
-            "y": 0,
-            "z": 0
+          {
+            "type": "ambient",
+            "name": "ambient",
+            "intensity": 0.3,
+            "color": "#ffffff",
+            "position": {
+              "x": 0,
+              "y": 0,
+              "z": 0
+            }
           }
-        }
-      ]
-    }
-     ```
-     * @param source
-     */
+        ]
+      }
+       ```
+       * @param source
+       */
     loadDynamicLightSetting(source: DynamicLightSettingSource): Promise<void>;
     /**
      * Used for test puprose only
@@ -474,7 +474,7 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
     setBakedShadow(hex: string, url: string): void;
     /**
      * Loads a SceneSettings object, currently it can can contain a light setting definition
-     * (see {@link loadDynamicLightSetting}) and an environment definition (see {@link EnvironmentSetting}).
+     * (see {@link @roomle/web-sdk/configurator-core/src/roomle-configurator#RoomleConfigurator.loadDynamicLightSetting}) and an environment definition (see {@link @roomle/web-sdk/common-core/src/environment/dynamic-environment-setting-loader#EnvironmentSetting}).
      * @param sceneSettings
      */
     loadSceneSetting(sceneSettings: SceneSettings): Promise<void>;
@@ -530,12 +530,12 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
      */
     zoomOut(value?: number): void;
     /**
-     * Return {@link ConfiguratorUiCallbacks} to override
+     * Use this callbacks to hook in your functionality
      */
     get callbacks(): ConfiguratorUiCallbacks;
     /**
      * @internal
-     * Return {@link GlobalCallback} to override
+     * Use this callbacks to hook in your functionality
      */
     get globalCallbacks(): GlobalCallback;
     /**
@@ -580,7 +580,7 @@ export default class RoomleConfigurator implements GlobalAPI, Context, KernelUti
      * Sets the parameter of the component by it's runtime id
      * parameters of the plan object are set
      * @param runtimeId number, the runtime id of the component. You can retrieve this ID from partlist etc
-     * @param parameter an instance of the kernel parameter we want to set, use {key: "your-key"} if
+     * @param parameter an instance of the kernel parameter we want to set, use 'key: "your-key"' if
      *                  you do not have a kernel instance and do not need validation of the input
      * @param value the value we want to set on the parameter as string
      */