@openremote/or-asset-tree 1.11.0-snapshot.20251103144513 → 1.11.0

package/custom-elements-jsx.d.ts

@@ -0,0 +1,279 @@
+
+import type { style, OrAssetTreeRequestSelectionEvent, OrAssetTreeSelectionEvent, OrAssetTreeChangeParentEvent, OrAssetTreeToggleExpandEvent, OrAssetTreeRequestAddEvent, OrAssetTreeAddEvent, OrAssetTreeRequestDeleteEvent, OrAssetTreeAssetEvent, OrAssetTreeFilter, OrAssetTree } from "./lib/index.d.ts";
+import type { OrAddChangedEvent, OrAddAssetDialog } from "./lib/or-add-asset-dialog.d.ts";
+
+/**
+ * This type can be used to create scoped tags for your components.
+ *
+ * Usage:
+ *
+ * ```ts
+ * import type { ScopedElements } from "path/to/library/jsx-integration";
+ *
+ * declare module "my-library" {
+ *   namespace JSX {
+ *     interface IntrinsicElements
+ *       extends ScopedElements<'test-', ''> {}
+ *   }
+ * }
+ * ```
+ *
+ * @deprecated Runtime scoped elements result in duplicate types and can confusing for developers. It is recommended to use the `prefix` and `suffix` options to generate new types instead.
+ */
+export type ScopedElements<
+  Prefix extends string = "",
+  Suffix extends string = ""
+> = {
+  [Key in keyof CustomElements as `${Prefix}${Key}${Suffix}`]: CustomElements[Key];
+};
+
+type BaseProps<T extends HTMLElement> = {
+
+  /** Content added between the opening and closing tags of the element */
+  children?: any;
+  /** Used for declaratively styling one or more elements using CSS (Cascading Stylesheets) */
+  class?: string;
+  /** Used for declaratively styling one or more elements using CSS (Cascading Stylesheets) */
+  className?: string;
+  /** Takes an object where the key is the class name(s) and the value is a boolean expression. When true, the class is applied, and when false, it is removed. */
+  classList?: Record<string, boolean | undefined>;
+  /** Specifies the text direction of the element. */
+  dir?: "ltr" | "rtl";
+  /** Contains a space-separated list of the part names of the element that should be exposed on the host element. */
+  exportparts?: string;
+  /** For <label> and <output>, lets you associate the label with some control. */
+  htmlFor?: string;
+  /** Specifies whether the element should be hidden. */
+  hidden?: boolean | string;
+  /** A unique identifier for the element. */
+  id?: string;
+  /** Keys tell React which array item each component corresponds to */
+  key?: string | number;
+  /** Specifies the language of the element. */
+  lang?: string;
+  /** Contains a space-separated list of the part names of the element. Part names allows CSS to select and style specific elements in a shadow tree via the ::part pseudo-element. */
+  part?: string;
+  /** Use the ref attribute with a variable to assign a DOM element to the variable once the element is rendered. */
+  ref?: T | ((e: T) => void);
+  /** Adds a reference for a custom element slot */
+  slot?: string;
+  /** Prop for setting inline styles */
+  style?: Record<string, string | number>;
+  /** Overrides the default Tab button behavior. Avoid using values other than -1 and 0. */
+  tabIndex?: number;
+  /** Specifies the tooltip text for the element. */
+  title?: string;
+  /** Passing 'no' excludes the element content from being translated. */
+  translate?: "yes" | "no";
+  /** The popover global attribute is used to designate an element as a popover element. */
+  popover?: "auto" | "hint" | "manual";
+  /** Turns an element element into a popover control button; takes the ID of the popover element to control as its value. */
+  popovertarget?: "top" | "bottom" | "left" | "right" | "auto";
+  /** Specifies the action to be performed on a popover element being controlled by a control element. */
+  popovertargetaction?: "show" | "hide" | "toggle";
+
+} ;
+
+type BaseEvents = {
+
+
+};
+
+
+
+export type OrAssetTreeProps = {
+  /** Allows arbitrary assets to be displayed using a tree */
+  "assets"?: OrAssetTree['assets'];
+  /**  */
+  "rootAssets"?: OrAssetTree['rootAssets'];
+  /**  */
+  "rootAssetIds"?: OrAssetTree['rootAssetIds'];
+  /**  */
+  "dataProvider"?: OrAssetTree['dataProvider'];
+  /**  */
+  "readonly"?: OrAssetTree['readonly'];
+  /**  */
+  "disabled"?: OrAssetTree['disabled'];
+  /**  */
+  "disableSubscribe"?: OrAssetTree['disableSubscribe'];
+  /**  */
+  "selectedIds"?: OrAssetTree['selectedIds'];
+  /**  */
+  "showDeselectBtn"?: OrAssetTree['showDeselectBtn'];
+  /**  */
+  "showSortBtn"?: OrAssetTree['showSortBtn'];
+  /**  */
+  "showFilter"?: OrAssetTree['showFilter'];
+  /**  */
+  "sortBy"?: OrAssetTree['sortBy'];
+  /**  */
+  "expandAllNodes"?: OrAssetTree['expandAllNodes'];
+  /**  */
+  "checkboxes"?: OrAssetTree['checkboxes'];
+  /**  */
+  "queryLimit"?: OrAssetTree['queryLimit'];
+  /**  */
+  "selectedNodes"?: OrAssetTree['selectedNodes'];
+
+  /**  */
+  "onundefined"?: (e: CustomEvent<OrAssetTreeSelectionEvent>) => void;
+  /**  */
+  "onassetEvent"?: (e: CustomEvent<OrAssetTreeAssetEvent>) => void;
+}
+
+
+export type OrAddAssetDialogProps = {
+  /**  */
+  "config"?: OrAddAssetDialog['config'];
+  /**  */
+  "agentTypes"?: OrAddAssetDialog['agentTypes'];
+  /**  */
+  "assetTypes"?: OrAddAssetDialog['assetTypes'];
+  /**  */
+  "parent"?: OrAddAssetDialog['parent'];
+  /**  */
+  "selectedType"?: OrAddAssetDialog['selectedType'];
+  /**  */
+  "selectedAttributes"?: OrAddAssetDialog['selectedAttributes'];
+  /**  */
+  "selectedChildAssetType"?: OrAddAssetDialog['selectedChildAssetType'];
+  /**  */
+  "name"?: OrAddAssetDialog['name'];
+
+  /**  */
+  "onundefined"?: (e: CustomEvent<OrAddChangedEvent>) => void;
+}
+
+  export type CustomElements = {
+
+
+  /**
+     * 
+ * 
+ * ## Attributes & Properties
+ * 
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ * 
+ * - `assets`: Allows arbitrary assets to be displayed using a tree 
+ * - `rootAssets`: undefined 
+ * - `rootAssetIds`: undefined 
+ * - `dataProvider`: undefined 
+ * - `readonly`: undefined 
+ * - `disabled`: undefined 
+ * - `disableSubscribe`: undefined 
+ * - `selectedIds`: undefined 
+ * - `showDeselectBtn`: undefined 
+ * - `showSortBtn`: undefined 
+ * - `showFilter`: undefined 
+ * - `sortBy`: undefined 
+ * - `expandAllNodes`: undefined 
+ * - `checkboxes`: undefined 
+ * - `queryLimit`: undefined 
+ * - `selectedNodes`: undefined (property only)
+ * 
+ * ## Events
+ * 
+ * Events that will be emitted by the component.
+ * 
+ * - `undefined`: undefined
+ * - `assetEvent`: undefined
+ * 
+ * ## Methods
+ * 
+ * Methods that can be called to access component functionality.
+ * 
+ * - `refresh() => void`: undefined
+ * - `isAncestorSelected(node: UiAssetTreeNode) => void`: undefined
+ * - `applyFilter(filter?: OrAssetTreeFilter | string, reflect = false) => void`: A setter function for updating the list of nodes (assets) shown in the UI.
+ * - `_addEventSubscriptions() => Promise<void>`: undefined
+ * - `onEventsConnect() => void`: undefined
+ * - `onEventsDisconnect() => void`: undefined
+ * - `getNodes() => UiAssetTreeNode[]`: undefined
+ * - `_onEvent(event: SharedEvent) => void`: undefined
+ * - `_onDragStart(ev: any) => void`: undefined
+ * - `_onDragEnd(ev: any) => void`: undefined
+ * - `_onDragOver(ev: any) => void`: undefined
+ * - `_onDragEnter(ev: any) => void`: undefined
+ * - `_onDragLeave(ev: any) => void`: undefined
+  */
+    "or-asset-tree": Partial<OrAssetTreeProps & BaseProps<OrAssetTree> & BaseEvents>;
+
+
+  /**
+     * 
+ * 
+ * ## Attributes & Properties
+ * 
+ * Component attributes and properties that can be applied to the element or by using JavaScript.
+ * 
+ * - `config`: undefined (property only)
+ * - `agentTypes`: undefined (property only)
+ * - `assetTypes`: undefined (property only)
+ * - `parent`: undefined (property only)
+ * - `selectedType`: undefined (property only)
+ * - `selectedAttributes`: undefined (property only)
+ * - `selectedChildAssetType`: undefined (property only)
+ * - `name`: undefined (property only)
+ * 
+ * ## Events
+ * 
+ * Events that will be emitted by the component.
+ * 
+ * - `undefined`: undefined
+  */
+    "or-add-asset-dialog": Partial<OrAddAssetDialogProps & BaseProps<OrAddAssetDialog> & BaseEvents>;
+  }
+
+export type CustomCssProperties = {
+
+}
+
+
+declare module 'react' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module 'preact' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module '@builder.io/qwik' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module '@stencil/core' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module 'hono/jsx' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare module 'react-native' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}
+
+declare global {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElements {}
+  }
+  export interface CSSProperties extends CustomCssProperties {}
+}

package/custom-elements.json

@@ -580,7 +580,10 @@
             {
               "kind": "method",
               "name": "refresh",
-              "privacy": "public"
+              "privacy": "public",
+              "type": {
+                "text": "refresh() => void"
+              }
             },
             {
               "kind": "method",
@@ -593,7 +596,10 @@
                     "text": "UiAssetTreeNode"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "isAncestorSelected(node: UiAssetTreeNode) => void"
+              }
             },
             {
               "kind": "method",
@@ -614,7 +620,10 @@
                   "description": "If the changes should be reflected in the filtering UI. (default: false)"
                 }
               ],
-              "description": "A setter function for updating the list of nodes (assets) shown in the UI."
+              "description": "A setter function for updating the list of nodes (assets) shown in the UI.",
+              "type": {
+                "text": "applyFilter(filter?: OrAssetTreeFilter | string, reflect = false) => void"
+              }
             },
             {
               "kind": "method",
@@ -1170,17 +1179,26 @@
                 "type": {
                   "text": "Promise<void>"
                 }
+              },
+              "type": {
+                "text": "_addEventSubscriptions() => Promise<void>"
               }
             },
             {
               "kind": "method",
               "name": "onEventsConnect",
-              "privacy": "public"
+              "privacy": "public",
+              "type": {
+                "text": "onEventsConnect() => void"
+              }
             },
             {
               "kind": "method",
               "name": "onEventsDisconnect",
-              "privacy": "public"
+              "privacy": "public",
+              "type": {
+                "text": "onEventsDisconnect() => void"
+              }
             },
             {
               "kind": "method",
@@ -1190,6 +1208,9 @@
                 "type": {
                   "text": "UiAssetTreeNode[]"
                 }
+              },
+              "type": {
+                "text": "getNodes() => UiAssetTreeNode[]"
               }
             },
             {
@@ -1203,7 +1224,10 @@
                     "text": "SharedEvent"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "_onEvent(event: SharedEvent) => void"
+              }
             },
             {
               "kind": "method",
@@ -1266,7 +1290,10 @@
                     "text": "any"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "_onDragStart(ev: any) => void"
+              }
             },
             {
               "kind": "method",
@@ -1284,7 +1311,10 @@
                     "text": "any"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "_onDragEnd(ev: any) => void"
+              }
             },
             {
               "kind": "method",
@@ -1320,7 +1350,10 @@
                     "text": "any"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "_onDragOver(ev: any) => void"
+              }
             },
             {
               "kind": "method",
@@ -1356,7 +1389,10 @@
                     "text": "any"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "_onDragEnter(ev: any) => void"
+              }
             },
             {
               "kind": "method",
@@ -1374,7 +1410,10 @@
                     "text": "any"
                   }
                 }
-              ]
+              ],
+              "type": {
+                "text": "_onDragLeave(ev: any) => void"
+              }
             },
             {
               "kind": "method",
@@ -1573,7 +1612,9 @@
             "package": "lit"
           },
           "tagName": "or-asset-tree",
-          "customElement": true
+          "customElement": true,
+          "modulePath": "src/index.ts",
+          "definitionPath": "src/index.ts"
         }
       ],
       "exports": [
@@ -1897,7 +1938,9 @@
             "package": "lit"
           },
           "tagName": "or-add-asset-dialog",
-          "customElement": true
+          "customElement": true,
+          "modulePath": "src/or-add-asset-dialog.ts",
+          "definitionPath": "src/or-add-asset-dialog.ts"
         }
       ],
       "exports": [