@openremote/or-components 1.9.0-snapshot.20250919113633 → 1.9.0-snapshot.20250922141329

package/custom-elements.json

@@ -543,6 +543,231 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/or-iframe.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Model for the IFRAME-EVENT that OrIframe can dispatch.\nFired when the iframe loading state changes.",
+          "name": "OrIFrameEvent",
+          "members": [
+            {
+              "kind": "field",
+              "name": "NAME",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "static": true,
+              "readonly": true,
+              "default": "\"or-iframe-event\""
+            }
+          ],
+          "superclass": {
+            "name": "CustomEvent",
+            "module": "src/or-iframe.ts"
+          }
+        },
+        {
+          "kind": "class",
+          "description": "",
+          "name": "OrIframe",
+          "members": [
+            {
+              "kind": "field",
+              "name": "src",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "public",
+              "attribute": "src"
+            },
+            {
+              "kind": "field",
+              "name": "timeout",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "10000",
+              "attribute": "timeout"
+            },
+            {
+              "kind": "field",
+              "name": "loading",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "protected",
+              "default": "true"
+            },
+            {
+              "kind": "field",
+              "name": "error",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "protected",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "preventCache",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "true",
+              "attribute": "preventCache"
+            },
+            {
+              "kind": "field",
+              "name": "timeoutId",
+              "type": {
+                "text": "number | undefined"
+              },
+              "privacy": "protected"
+            },
+            {
+              "kind": "method",
+              "name": "_clearTimeout",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_startTimeout",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_resetState",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "_handleLoadEvent",
+              "privacy": "protected",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "_handleErrorEvent",
+              "privacy": "protected",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "_handleIframeEvent",
+              "privacy": "protected",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "getSrc",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "reload",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Reload the iframe content by clearing and resetting the src"
+            }
+          ],
+          "events": [
+            {
+              "type": {
+                "text": "OrIFrameEvent"
+              },
+              "description": "Fired when the iframe loading state changes, and dispatches the event detail containing type, src, and optional error.",
+              "name": "or-iframe-event"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "src",
+              "type": {
+                "text": "string | undefined"
+              },
+              "fieldName": "src"
+            },
+            {
+              "name": "timeout",
+              "type": {
+                "text": "number"
+              },
+              "default": "10000",
+              "fieldName": "timeout"
+            },
+            {
+              "name": "preventCache",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "true",
+              "fieldName": "preventCache"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "or-iframe",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "OrIFrameEvent",
+          "declaration": {
+            "name": "OrIFrameEvent",
+            "module": "src/or-iframe.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "OrIframe",
+          "declaration": {
+            "name": "OrIframe",
+            "module": "src/or-iframe.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "or-iframe",
+          "declaration": {
+            "name": "OrIframe",
+            "module": "src/or-iframe.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/or-loading-indicator.ts",

package/lib/or-iframe.d.ts

@@ -0,0 +1,51 @@
+import { LitElement, PropertyValues } from "lit";
+import "./or-loading-indicator";
+import "@openremote/or-icon";
+export declare enum OrIFrameEventType {
+    LOADED = "or-iframe-loaded",
+    ERROR = "or-iframe-error",
+    TIMEOUT = "or-iframe-timeout"
+}
+/**
+ * Event detail for or-iframe-event
+ */
+export interface OrIFrameEventDetail {
+    type: OrIFrameEventType;
+    src?: string;
+    error?: string;
+}
+/**
+ * Model for the IFRAME-EVENT that {@link OrIframe} can dispatch.
+ * Fired when the iframe loading state changes.
+ */
+export declare class OrIFrameEvent extends CustomEvent<OrIFrameEventDetail> {
+    static readonly NAME = "or-iframe-event";
+    constructor(detail: OrIFrameEventDetail);
+}
+/**
+ * @event {OrIFrameEvent} or-iframe-event - Fired when the iframe loading state changes, and dispatches the event detail containing type, src, and optional error.
+ */
+export declare class OrIframe extends LitElement {
+    static get styles(): import("lit").CSSResult[];
+    src?: string;
+    timeout: number;
+    protected loading: boolean;
+    protected error: boolean;
+    preventCache: boolean;
+    protected timeoutId?: number;
+    protected _clearTimeout(): void;
+    protected _startTimeout(): void;
+    protected _resetState(): void;
+    connectedCallback(): void;
+    willUpdate(changedProperties: PropertyValues): void;
+    protected readonly _handleLoadEvent: (event: Event) => void;
+    protected readonly _handleErrorEvent: (event: Event) => void;
+    protected readonly _handleIframeEvent: (type: OrIFrameEventType, event: Event) => void;
+    disconnectedCallback(): void;
+    getSrc(): string;
+    /**
+     * Reload the iframe content by clearing and resetting the src
+     */
+    reload(): void;
+    render(): import("lit").TemplateResult<1>;
+}

package/lib/or-iframe.js

@@ -0,0 +1,52 @@
+var __decorate=this&&this.__decorate||function(e,r,t,o){var i,a=arguments.length,s=a<3?r:null===o?o=Object.getOwnPropertyDescriptor(r,t):o;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)s=Reflect.decorate(e,r,t,o);else for(var n=e.length-1;n>=0;n--)(i=e[n])&&(s=(a<3?i(s):a>3?i(r,t,s):i(r,t))||s);return a>3&&s&&Object.defineProperty(r,t,s),s};import{css as e,html as r,LitElement as t}from"lit";import{customElement as o,property as i,state as a}from"lit/decorators.js";import"./or-loading-indicator";import"@openremote/or-icon";export var OrIFrameEventType;!function(e){e.LOADED="or-iframe-loaded",e.ERROR="or-iframe-error",e.TIMEOUT="or-iframe-timeout"}(OrIFrameEventType||(OrIFrameEventType={}));export class OrIFrameEvent extends CustomEvent{constructor(e){super(OrIFrameEvent.NAME,{bubbles:!0,composed:!0,detail:e})}}OrIFrameEvent.NAME="or-iframe-event";let style=e`
+    :host {
+        display: block;
+        width: 100%;
+        height: 100%;
+    }
+
+    .wrapper {
+        position: relative;
+        width: 100%;
+        height: 100%;
+    }
+
+    iframe {
+        width: 100%;
+        height: 100%;
+        border: none;
+        display: block;
+        opacity: 0;
+        transition: opacity 0.3s ease;
+        overflow-y: auto;
+        overflow-x: hidden;
+    }
+
+    iframe.loaded {
+        opacity: 1;
+    }
+
+    .error {
+        display: flex;
+        justify-content: center;
+        align-items: center;
+        height: 100%;
+        font-weight: 500;
+        gap: 0.5rem;
+    }
+`,OrIframe=class extends t{constructor(){super(...arguments),this.timeout=1e4,this.loading=!0,this.error=!1,this.preventCache=!0,this._handleLoadEvent=e=>{this._handleIframeEvent(OrIFrameEventType.LOADED,e)},this._handleErrorEvent=e=>{this._handleIframeEvent(OrIFrameEventType.ERROR,e)},this._handleIframeEvent=(e,r)=>{this._clearTimeout();let t={type:e,src:this.src,error:e===OrIFrameEventType.ERROR||e===OrIFrameEventType.TIMEOUT?e===OrIFrameEventType.TIMEOUT?"Timeout loading iframe":"Error loading iframe":void 0};switch(this.dispatchEvent(new OrIFrameEvent(t)),e){case OrIFrameEventType.LOADED:this.error=!1,this.loading=!1;break;case OrIFrameEventType.ERROR:this.error=!0,this.loading=!1,console.error(`Error event loading iframe for src: ${this.src}`,r);break;case OrIFrameEventType.TIMEOUT:this.error=!0,this.loading=!1,console.error(`Timeout event loading iframe for src: ${this.src}`,r)}}}static get styles(){return[style]}_clearTimeout(){this.timeoutId&&(window.clearTimeout(this.timeoutId),this.timeoutId=void 0)}_startTimeout(){this._clearTimeout(),this.timeoutId=window.setTimeout(()=>{console.warn(`Iframe load timeout after ${this.timeout}ms for src: ${this.src}`),this._handleIframeEvent(OrIFrameEventType.TIMEOUT,new Event("timeout"))},this.timeout)}_resetState(){this.loading=!0,this.error=!1,this._startTimeout()}connectedCallback(){super.connectedCallback(),this._resetState()}willUpdate(e){e.has("src")&&this._resetState()}disconnectedCallback(){this._clearTimeout()}getSrc(){if(this.preventCache&&this.src){let e=new URL(this.src);return e.searchParams.set("t",Date.now().toString()),e.toString()}return this.src||""}reload(){var e;if(!this.src)return void console.warn("Cannot reload iframe: no src specified");this._resetState();let r=null==(e=this.shadowRoot)?void 0:e.querySelector("iframe");if(r){let e=this.getSrc();r.src="",requestAnimationFrame(()=>{r.src=e})}}render(){return r`
+            <div class="wrapper">
+                ${this.loading?r`<or-loading-indicator></or-loading-indicator>`:r``}
+                ${this.error?r`<div class="error">
+                          <or-icon icon="alert-octagon"></or-icon>
+                          <slot name="onerror">Failed to load iframe</slot>
+                      </div>`:r``}
+                <iframe
+                    @load=${this._handleLoadEvent}
+                    @error=${this._handleErrorEvent}
+                    id="or-iframe"
+                    src="${this.getSrc()}"
+                    class="${!this.loading?"loaded":""}"
+                ></iframe>
+            </div>
+        `}};__decorate([i({type:String})],OrIframe.prototype,"src",void 0),__decorate([i({type:Number})],OrIframe.prototype,"timeout",void 0),__decorate([a()],OrIframe.prototype,"loading",void 0),__decorate([a()],OrIframe.prototype,"error",void 0),__decorate([i({type:Boolean})],OrIframe.prototype,"preventCache",void 0),OrIframe=__decorate([o("or-iframe")],OrIframe);export{OrIframe};

package/lib/or-iframe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"or-iframe.js","sourceRoot":"","sources":["../src/or-iframe.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAkB,MAAM,KAAK,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,wBAAwB,CAAC;AAChC,OAAO,qBAAqB,CAAC;AAE7B,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,gDAA2B,CAAA;IAC3B,8CAAyB,CAAA;IACzB,kDAA6B,CAAA;AACjC,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAWD;;;GAGG;AACH,MAAM,OAAO,aAAc,SAAQ,WAAgC;IAG/D,YAAY,MAA2B;QACnC,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE;YACtB,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,MAAM;SACjB,CAAC,CAAC;IACP,CAAC;;AARsB,kBAAI,GAAG,iBAAiB,CAAC;AAWpD,MAAM,KAAK,GAAG,GAAG,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoChB,CAAC;AAEF;;GAEG;AAEI,IAAM,QAAQ,GAAd,MAAM,QAAS,SAAQ,UAAU;IAAjC;;QASI,YAAO,GAAG,KAAK,CAAC,CAAC,6BAA6B;QAG3C,YAAO,GAAG,IAAI,CAAC;QAGf,UAAK,GAAG,KAAK,CAAC;QAGjB,iBAAY,GAAG,IAAI,CAAC;QAqCR,qBAAgB,GAAG,CAAC,KAAY,EAAQ,EAAE;YACzD,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC7D,CAAC,CAAC;QAEiB,sBAAiB,GAAG,CAAC,KAAY,EAAQ,EAAE;YAC1D,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5D,CAAC,CAAC;QAEiB,uBAAkB,GAAG,CAAC,IAAuB,EAAE,KAAY,EAAQ,EAAE;YACpF,IAAI,CAAC,aAAa,EAAE,CAAC;YAErB,MAAM,MAAM,GAAwB;gBAChC,IAAI;gBACJ,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,KAAK,EACD,IAAI,KAAK,iBAAiB,CAAC,KAAK,IAAI,IAAI,KAAK,iBAAiB,CAAC,OAAO;oBAClE,CAAC,CAAC,IAAI,KAAK,iBAAiB,CAAC,OAAO;wBAChC,CAAC,CAAC,wBAAwB;wBAC1B,CAAC,CAAC,sBAAsB;oBAC5B,CAAC,CAAC,SAAS;aACtB,CAAC;YAEF,IAAI,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;YAE9C,QAAQ,IAAI,EAAE,CAAC;gBACX,KAAK,iBAAiB,CAAC,MAAM;oBACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;oBACnB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;oBACrB,MAAM;gBACV,KAAK,iBAAiB,CAAC,KAAK;oBACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;oBACrB,OAAO,CAAC,KAAK,CAAC,uCAAuC,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;oBACxE,MAAM;gBACV,KAAK,iBAAiB,CAAC,OAAO;oBAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClB,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;oBACrB,OAAO,CAAC,KAAK,CAAC,yCAAyC,IAAI,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,CAAC;oBAC1E,MAAM;YACd,CAAC;QACL,CAAC,CAAC;IAyDN,CAAC;IAvJG,MAAM,KAAK,MAAM;QACb,OAAO,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAmBS,aAAa;QACnB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACpC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC/B,CAAC;IACL,CAAC;IAES,aAAa;QACnB,IAAI,CAAC,aAAa,EAAE,CAAC;QAErB,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;YACpC,OAAO,CAAC,IAAI,CAAC,6BAA6B,IAAI,CAAC,OAAO,eAAe,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;YACjF,IAAI,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,OAAO,EAAE,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;QAC7E,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAES,WAAW;QACjB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC;IAED,iBAAiB;QACb,KAAK,CAAC,iBAAiB,EAAE,CAAC;QAC1B,IAAI,CAAC,WAAW,EAAE,CAAC;IACvB,CAAC;IAED,UAAU,CAAC,iBAAiC;QACxC,IAAI,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,WAAW,EAAE,CAAC;QACvB,CAAC;IACL,CAAC;IA4CD,oBAAoB;QAChB,IAAI,CAAC,aAAa,EAAE,CAAC;IACzB,CAAC;IAEM,MAAM;QACT,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC9B,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjD,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACI,MAAM;;QACT,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;YACvD,OAAO;QACX,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,gEAAgE;QAChE,MAAM,MAAM,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,MAAM,EAAE,CAAC;YACT,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,GAAG,EAAE,CAAC;YAChB,gIAAgI;YAChI,qBAAqB,CAAC,GAAG,EAAE;gBACvB,MAAM,CAAC,GAAG,GAAG,UAAU,CAAC;YAC5B,CAAC,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAA;;kBAED,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAA,+CAA+C,CAAC,CAAC,CAAC,IAAI,CAAA,EAAE;kBAC3E,IAAI,CAAC,KAAK;YACR,CAAC,CAAC,IAAI,CAAA;;;6BAGG;YACT,CAAC,CAAC,IAAI,CAAA,EAAE;;4BAEA,IAAI,CAAC,gBAAgB;6BACpB,IAAI,CAAC,iBAAiB;;2BAExB,IAAI,CAAC,MAAM,EAAE;6BACX,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE;;;SAGjD,CAAC;IACN,CAAC;CACJ,CAAA;AAlJU;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;qCACP;AAGb;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;yCACJ;AAGb;IADT,KAAK,EAAE;yCACiB;AAGf;IADT,KAAK,EAAE;uCACgB;AAGjB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;8CACD;AAlBlB,QAAQ;IADpB,aAAa,CAAC,WAAW,CAAC;GACd,QAAQ,CAwJpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openremote/or-components",
-  "version": "1.9.0-snapshot.20250919113633",
+  "version": "1.9.0-snapshot.20250922141329",
   "description": "OpenRemote basic UI components",
   "customElements": "custom-elements.json",
   "main": "dist/umd/index.bundle.js",
@@ -26,14 +26,14 @@
   "license": "AGPL-3.0-or-later",
   "dependencies": {
     "@material/elevation": "^9.0.0",
-    "@openremote/core": "1.9.0-snapshot.20250919113633",
-    "@openremote/or-mwc-components": "1.9.0-snapshot.20250919113633",
+    "@openremote/core": "1.9.0-snapshot.20250922141329",
+    "@openremote/or-mwc-components": "1.9.0-snapshot.20250922141329",
     "ace-builds": "^1.41.0",
     "lit": "^3.3.1",
     "simplebar": "^5.3.6"
   },
   "devDependencies": {
-    "@openremote/util": "1.9.0-snapshot.20250919113633"
+    "@openremote/util": "1.9.0-snapshot.20250922141329"
   },
   "publishConfig": {
     "access": "public"