hart-estate-widget 4.0.0 → 4.0.1

package/README.md

@@ -166,79 +166,88 @@ html, body
 ## Parameters:
 Here you can see a list of accessible options and examples of usage. There are accessible values for each option below in the block "Types of Elements".
 
-```ts
-type TWidgetTab =
-  'rotation' | // circular view images (order is mandatory)
-  'plan'     | // original plan image
-  'panorama' ; // 360° images
-
-type TPanoramaControlType =
-  'ruler'      | // Ruler button
-  'scale'      | // Scale 1x, 2x, 0.5x button
-  'autoRotate' ; // Auto rotation button
-
-type TAppColor =
-  'main'     | // Widget fill color
-  'mainText' ; // Widget text color
-
-type TWidgetLocale =
-  'en' | // English language
-  'ru' | // Russian language
-  'de' | // German language
-  'es' | // Spanish language
-  'ja' ; // Japanese language
-
-export type TConfig = {
-  /** Widget API base URL */
-  baseUrl: string;
-
-  /** Widget locale */
-  locale: TWidgetLocale;
-  /** Overrides locale keys with custom text or translation */
-  localeOverrides: Record<string, string>;
-
-  /** Path/link to the logo */
-  logoUrl: string;
-  /** Link opened when logo is clicked */
-  logoLinkUrl: string;
-  /**
-   * Widget color settings
-   * - `main`: main color of buttons, elements
-   * - `mainText`: text color for buttons, elements contrasting with the main color
-   * */
-  colors: Record<TAppColor, string>;
-
-  /** First opened tab */
-  primaryTab: TWidgetTab;
-  /** Available widget tabs, defaults ['plan', 'rotation', 'panorama'] */
-  tabs: TWidgetTab[];
-  /** Path/link to the logo */
-  /** Controls can be: ruler, autoRotate or scale */
-  controls: TPanoramaControlType[];
-
-  /** Enable/disable modal of instruction in 3D tour */
-  isInstructionsVisible: boolean;
-  /** Enable/disable auto rotation in 3D tour */
-  isAutoRotate: boolean;
-  /** Enable/disable device gyroscope for AR */
-  isGyroscopeEnabled: boolean;
-  /** Show/hide fullscreen button */
-  isFullscreenButtonVisible: boolean;
-  /** Show/hide current room type top label */
-  isRoomLabelVisible?: boolean;
-
-  /** Camera persective FOV */
-  cameraFov: number;
-
-  /** Time for fade in (seconds) */
-  panoramaFadeTime: number;
-
-  /** Widget external integrations */
-  integrations: {
-    /** Configuration options for the Sentry Browser SDK. */
-    sentry?: BrowserOptions; // See https://docs.sentry.io/platforms/javascript/configuration/options/
-  };
-};
+```json
+{
+  // Widget API base URL
+  "baseUrl": "https://backend.estate.hart-digital.com",
+
+  // Widget locale can be one of
+  // "en" - English language
+  // "ru" - Russian language
+  // "de" - German language
+  // "es" - Spanish language
+  // "ja" - Japanese language
+  "locale": "en",
+  // Overrides locale keys with custom text or translation
+  "localeOverrides": {
+    "create-points": "Create a point",
+    "delete-points": "Remove point",
+    "research-plan": "Research plan",
+    "rotate-plan": "Rotate plan",
+    "ok": "Ok",
+    "ruler-ok": "Ok",
+    "made-by-link": "https://getfloorplan.com/",
+    "made-by-text": "getfloorplan.com",
+    "floor": "$0 floor",
+    "floorNumberEndings": {
+      "1": "$0st",
+      "2": "$0nd",
+      "3": "$0d",
+      "rest": "$0th"
+    }
+  },
+
+  // Path/link to the logo
+  "logoUrl": "https://getfloorplan.com/img/logo.58f6cd11.svg",
+  // Link opened when logo is clicked
+  "logoLinkUrl": "https://getfloorplan.com",
+  // Widget color settings in CSS color formal like: "rgba(255, 255, 255, 0)", "#ABCDEF", etc...
+  // "main" - main color of buttons, elements
+  // "mainText" - text color for buttons, elements contrasting with the main color
+  "colors": {
+    "main": "#FFA900",
+    "mainText": "#413E3E"
+  },
+
+  // First opened tab
+  "primaryTab": "panorama",
+  // Available widget tabs array with order:
+  // "panorama" - Panorama 360 tab
+  // "rotation" - Isometric plan rotation tab
+  // "plan" - Original plan tab
+  "tabs": ["plan", "rotation", "panorama"],
+
+  // Controls in bottom bar, can be:
+  // "ruler" - Ruler enable/disable button
+  // "scale" - Scale x1, x2, x0.5 button
+  // "autoRotate" - Auto rotate enable/disable button
+  "controls": ["ruler", "scale", "autoRotate"],
+
+  // Enable/disable modal of instruction in 3D tour
+  "isInstructionsVisible": true,
+  // Enable/disable auto rotation in 3D tour
+  "isAutoRotate": false,
+  // Enable/disable device gyroscope for AR
+  "isGyroscopeEnabled": true,
+  // Show/hide fullscreen button
+  "isFullscreenButtonVisible": true,
+  // Show/hide current room type top label
+  "isRoomLabelVisible": false,
+
+  // Camera persective FOV
+  "cameraFov": 75,
+
+  // Panorama fade time in seconds
+  "panoramaFadeTime": 0.5,
+
+  // Widget external integrations
+  "integrations": {
+    // https://docs.sentry.io/platforms/javascript/configuration/options/
+    "sentry": {
+      "dsn": "https://1234567890abcdef@sentry.com/12345"
+    }
+  }
+}
 ```
 
 ## Widget object from the REST API

package/build/api.js

@@ -1 +1 @@
-var r={d:(e,t)=>{for(var a in t)r.o(t,a)&&!r.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:t[a]})},o:(r,e)=>Object.prototype.hasOwnProperty.call(r,e)},e={};r.d(e,{j:()=>t});class t{baseUrl;constructor(r){this.baseUrl=r}get headers(){return{Accept:"application/json;widget-version=4.0.0"}}loadCrmWidgetData=async r=>{if(!r)return this.makeError(404,"No crmPlanId!");try{const e=await this.fetch(`/api/crm/plans/${r}/v4/widget`);return e.ok?e.json():this.makeErrorFromResponse(e,"Failed to get CRM Plan widget data!")}catch(r){return this.makeError(520,r.message)}};loadWidgetData=async r=>{if(!r)return this.makeError(404,"No planId!");try{const e=await this.fetch(`/api/plans/${r}/v4/widget`);return e.ok?e.json():this.makeErrorFromResponse(e,"Failed to get Plan widget data!")}catch(r){return this.makeError(520,r.message)}};loadJson=async r=>{try{return(await fetch(r)).json()}catch(r){return this.makeError(500,r.message)}};makeError(r,e="Unknown error"){return{error:{status:r,message:e}}}async makeErrorFromResponse(r,e){if("application/json"===r.headers.get("Content-Type")){const e=await r.json();if("message"in e&&"string"==typeof e.message)return this.makeError(r.status,e.message)}return this.makeError(r.status,e)}fetch(r,e={headers:this.headers}){return fetch(`${this.baseUrl}${r}`,e)}}var a=e.j;export{a as Api};
+var r={d:(e,t)=>{for(var a in t)r.o(t,a)&&!r.o(e,a)&&Object.defineProperty(e,a,{enumerable:!0,get:t[a]})},o:(r,e)=>Object.prototype.hasOwnProperty.call(r,e)},e={};r.d(e,{j:()=>t});class t{baseUrl;constructor(r){this.baseUrl=r}get headers(){return{Accept:"application/json;widget-version=4.0.1"}}loadCrmWidgetData=async r=>{if(!r)return this.makeError(404,"No crmPlanId!");try{const e=await this.fetch(`/api/crm/plans/${r}/v4/widget`);return e.ok?e.json():this.makeErrorFromResponse(e,"Failed to get CRM Plan widget data!")}catch(r){return this.makeError(520,r.message)}};loadWidgetData=async r=>{if(!r)return this.makeError(404,"No planId!");try{const e=await this.fetch(`/api/plans/${r}/v4/widget`);return e.ok?e.json():this.makeErrorFromResponse(e,"Failed to get Plan widget data!")}catch(r){return this.makeError(520,r.message)}};loadJson=async r=>{try{return(await fetch(r)).json()}catch(r){return this.makeError(500,r.message)}};makeError(r,e="Unknown error"){return{error:{status:r,message:e}}}async makeErrorFromResponse(r,e){if("application/json"===r.headers.get("Content-Type")){const e=await r.json();if("message"in e&&"string"==typeof e.message)return this.makeError(r.status,e.message)}return this.makeError(r.status,e)}fetch(r,e={headers:this.headers}){return fetch(`${this.baseUrl}${r}`,e)}}var a=e.j;export{a as Api};