@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

package/types/Utility/dialogs.d.ts

@@ -1,80 +1,86 @@
-import { Guid } from "@Obsidian/Types";
-import { ICancellationToken } from "./cancellation";
-/** The options that describe the dialog. */
-export declare type DialogOptions = {
-    /** The text to display inside the dialog. */
-    message: string;
-    /** A list of buttons to display, rendered left to right. */
-    buttons: ButtonOptions[];
-    /**
-     * An optional container element for the dialog. If not specified then one
-     * will be chosen automatically.
-     */
-    container?: string | Element;
-    /**
-     * An optional cancellation token that will dismiss the dialog automatically
-     * and return `cancel` as the button clicked.
-     */
-    cancellationToken?: ICancellationToken;
-};
-/** The options that describe a single button in the dialog. */
-export declare type ButtonOptions = {
-    /** The key that uniquely identifies this button. */
-    key: string;
-    /** The text to display in the button. */
-    label: string;
-    /** The CSS classes to assign to the button, such as `btn btn-primary`. */
-    className: string;
-};
-/**
- * Shows a dialog modal. This is meant to look and behave like the standard
- * Rock.dialog.* functions, but this handles fullscreen mode whereas the old
- * methods do not.
- *
- * @param options The options that describe the dialog to be shown.
- *
- * @returns The key of the button that was clicked, or "cancel" if the cancel button was clicked.
- */
-export declare function showDialog(options: DialogOptions): Promise<string>;
-/**
- * Shows an alert message that requires the user to acknowledge.
- *
- * @param message The message text to be displayed.
- *
- * @returns A promise that indicates when the dialog has been dismissed.
- */
-export declare function alert(message: string): Promise<void>;
-/**
- * Shows a confirmation dialog that consists of OK and Cancel buttons. The
- * user will be required to click one of these two buttons.
- *
- * @param message The message to be displayed inside the dialog.
- *
- * @returns A promise that indicates when the dialog has been dismissed. The
- * value will be true if the OK button was clicked or false otherwise.
- */
-export declare function confirm(message: string): Promise<boolean>;
-/**
- * Shows a delete confirmation dialog that consists of OK and Cancel buttons.
- * The user will be required to click one of these two buttons. The message
- * is standardized.
- *
- * @param nameText The name of type that will be deleted.
- *
- * @returns A promise that indicates when the dialog has been dismissed. The
- * value will be true if the OK button was clicked or false otherwise.
- */
-export declare function confirmDelete(typeName: string, additionalMessage?: string): Promise<boolean>;
-/**
- * Shows the security dialog for the given entity.
- *
- * @param entityTypeIdKey The identifier of the entity's type.
- * @param entityIdKey The identifier of the entity to secure.
- * @param entityTitle The title of the entity. This is used to construct the modal title.
- */
-export declare function showSecurity(entityTypeIdKey: Guid | string | number, entityIdKey: Guid | string | number, entityTitle?: string): void;
-/**
- * Shows the child pages for the given page.
- * @param pageId The page identifier
- */
-export declare function showChildPages(pageId: Guid | string | number): void;
+import { Guid } from "@Obsidian/Types";
+import { ICancellationToken } from "./cancellation";
+/** The options that describe the dialog. */
+export type DialogOptions = {
+    /** The text to display inside the dialog. */
+    message: string | HTMLElement;
+    /** A list of buttons to display, rendered left to right. */
+    buttons: ButtonOptions[];
+    /**
+     * An optional container element for the dialog. If not specified then one
+     * will be chosen automatically.
+     */
+    container?: string | Element;
+    /**
+     * Determines if the standard close button in the corner of the dialog
+     * should be hidden.
+     */
+    hideCloseButton?: boolean;
+    /**
+     * An optional cancellation token that will dismiss the dialog automatically
+     * and return `cancel` as the button clicked.
+     */
+    cancellationToken?: ICancellationToken;
+};
+/** The options that describe a single button in the dialog. */
+export type ButtonOptions = {
+    /** The key that uniquely identifies this button. */
+    key: string;
+    /** The text to display in the button. */
+    label: string;
+    /** The CSS classes to assign to the button, such as `btn btn-primary`. */
+    className: string;
+    autoFocus?: boolean;
+};
+/**
+ * Shows a dialog modal. This is meant to look and behave like the standard
+ * Rock.dialog.* functions, but this handles fullscreen mode whereas the old
+ * methods do not.
+ *
+ * @param options The options that describe the dialog to be shown.
+ *
+ * @returns The key of the button that was clicked, or "cancel" if the cancel button was clicked.
+ */
+export declare function showDialog(options: DialogOptions): Promise<string>;
+/**
+ * Shows an alert message that requires the user to acknowledge.
+ *
+ * @param message The message text to be displayed.
+ *
+ * @returns A promise that indicates when the dialog has been dismissed.
+ */
+export declare function alert(message: string): Promise<void>;
+/**
+ * Shows a confirmation dialog that consists of OK and Cancel buttons. The
+ * user will be required to click one of these two buttons.
+ *
+ * @param message The message to be displayed inside the dialog.
+ *
+ * @returns A promise that indicates when the dialog has been dismissed. The
+ * value will be true if the OK button was clicked or false otherwise.
+ */
+export declare function confirm(message: string): Promise<boolean>;
+/**
+ * Shows a delete confirmation dialog that consists of OK and Cancel buttons.
+ * The user will be required to click one of these two buttons. The message
+ * is standardized.
+ *
+ * @param nameText The name of type that will be deleted.
+ *
+ * @returns A promise that indicates when the dialog has been dismissed. The
+ * value will be true if the OK button was clicked or false otherwise.
+ */
+export declare function confirmDelete(typeName: string, additionalMessage?: string): Promise<boolean>;
+/**
+ * Shows the security dialog for the given entity.
+ *
+ * @param entityTypeIdKey The identifier of the entity's type.
+ * @param entityIdKey The identifier of the entity to secure.
+ * @param entityTitle The title of the entity. This is used to construct the modal title.
+ */
+export declare function showSecurity(entityTypeIdKey: Guid | string | number, entityIdKey: Guid | string | number, entityTitle?: string): void;
+/**
+ * Shows the child pages for the given page.
+ * @param pageId The page identifier
+ */
+export declare function showChildPages(pageId: Guid | string | number): void;

package/types/Utility/dom.d.ts

@@ -0,0 +1,88 @@
+/**
+ * Get a unique CSS selector for any DOM element.
+ */
+export declare function getUniqueCssSelector(el: Element): string;
+export declare function getAncestors(element: Element): IterableIterator<Element>;
+/**
+ * Scrolls the start of an element to the top of the window.
+ *
+ * This accounts for fixed elements.
+ */
+export declare function scrollElementStartToTop(element: Element): void;
+/**
+ * Finds the direct child of `element` containing the `descendantElement`.
+ * @param element The element to be searched.
+ * @param descendantElement The descendant element to search for.
+ */
+export declare function findDirectChildContaining(element: HTMLElement, descendantElement: HTMLElement): HTMLElement | null;
+/**
+ * Finds the nearest element to a specific coordinate in the y-direction.
+ * @param iframe
+ * @param x The X position (in pixels) to search.
+ * @param y The Y position (in pixels) to search.
+ * @param selector The CSS selector used to find the matching element.
+ * @param xRange The horizontal distance (in pixels) left and right of the `xPosition` to search for an element.
+ * @param yRange The vertical distance (in pixels) above and below the `yPosition` to search for an element.
+ * @returns
+ */
+export declare function findNearestIFrameElementFromPoint(iframe: HTMLIFrameElement, x: number, y: number, selector: string, xRange?: number, yRange?: number): {
+    element: HTMLElement | null;
+    isAbove: boolean;
+    isBelow: boolean;
+    isLeft: boolean;
+    isRight: boolean;
+};
+/**
+ * Gets the window associated with an element.
+ */
+export declare function getWindow(el: Element): (Window & typeof globalThis) | null;
+/**
+ * Determines whether the argument is an Element.
+ */
+export declare function isElement(el: unknown): el is Element;
+/**
+ * Determines whether the argument is an HTMLElement.
+ */
+export declare function isHTMLElement(el: unknown): el is HTMLElement;
+/**
+ * Determines whether the argument is an HTMLTableElement.
+ */
+export declare function isHTMLTableElement(el: unknown): el is HTMLTableElement;
+/**
+ * Determines whether the argument is an HTMLAnchorElement.
+ */
+export declare function isHTMLAnchorElement(el: unknown): el is HTMLAnchorElement;
+/**
+ * Determines whether the argument is a Document.
+ */
+export declare function isDocument(doc: unknown): doc is Document;
+/**
+ * Determines whether the argument is a MouseEvent.
+ * @param event
+ * @returns
+ */
+export declare function isMouseEvent(event: unknown): event is MouseEvent;
+/**
+ * Determines whether the argument is a TouchEvent.
+ * @param event
+ * @returns
+ */
+export declare function isTouchEvent(event: unknown): event is TouchEvent;
+/**
+ * Removes white space content from an element.
+ *
+ * This is important for applying :empty styles.
+ */
+export declare function removeWhiteSpaceFromElement(element: Element, selector?: string): void;
+/**
+ * Removes white space content from an element and its children.
+ *
+ * This is important for applying :empty styles.
+ */
+export declare function removeWhiteSpaceFromElementAndChildElements(element: Element, selector?: string): void;
+/**
+ * Removes white space content from an element's children.
+ *
+ * This is important for applying :empty styles.
+ */
+export declare function removeWhiteSpaceFromChildElements(element: Document | Element, selector?: string): void;

package/types/Utility/email.d.ts

@@ -1,5 +1,5 @@
-/**
- * Is the value a valid email address?
- * @param val
- */
-export declare function isEmail(val: unknown): boolean;
+/**
+ * Is the value a valid email address?
+ * @param val
+ */
+export declare function isEmail(val: unknown): boolean;

package/types/Utility/enumUtils.d.ts

@@ -1,9 +1,9 @@
-import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
-/**
- * A function to convert the enums to array of ListItemBag in the frontend.
- *
- * @param description The enum to be converted to an array of listItemBag as a dictionary of value to enum description
- *
- * @returns An array of ListItemBag.
- */
-export declare function enumToListItemBag(description: Record<number, string>): ListItemBag[];
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+/**
+ * A function to convert the enums to array of ListItemBag in the frontend.
+ *
+ * @param description The enum to be converted to an array of listItemBag as a dictionary of value to enum description
+ *
+ * @returns An array of ListItemBag.
+ */
+export declare function enumToListItemBag(description: Record<number, string>): ListItemBag[];

package/types/Utility/fieldTypes.d.ts

@@ -1,20 +1,34 @@
-import { Guid } from "@Obsidian/Types";
-import { IFieldType } from "@Obsidian/Types/fieldType";
-/** Determines how the field type component is being used so it can adapt to different */
-export declare type DataEntryMode = "defaultValue" | undefined;
-/**
- * Register a new field type in the system. This must be called for all field
- * types a plugin registers.
- *
- * @param fieldTypeGuid The unique identifier of the field type.
- * @param fieldType The class instance that will handle the field type.
- */
-export declare function registerFieldType(fieldTypeGuid: Guid, fieldType: IFieldType): void;
-/**
- * Get the field type handler for a given unique identifier.
- *
- * @param fieldTypeGuid The unique identifier of the field type.
- *
- * @returns The field type instance or null if not found.
- */
-export declare function getFieldType(fieldTypeGuid: Guid): IFieldType | null;
+import { Guid } from "@Obsidian/Types";
+import { IFieldType } from "@Obsidian/Types/fieldType";
+import { Ref } from "vue";
+/** Determines how the field type component is being used so it can adapt to different */
+export type DataEntryMode = "defaultValue" | undefined;
+/**
+ * Register a new field type in the system. This must be called for all field
+ * types a plugin registers.
+ *
+ * @param fieldTypeGuid The unique identifier of the field type.
+ * @param fieldType The class instance that will handle the field type.
+ */
+export declare function registerFieldType(fieldTypeGuid: Guid, fieldType: IFieldType): void;
+/**
+ * Get the field type handler for a given unique identifier.
+ *
+ * @param fieldTypeGuid The unique identifier of the field type.
+ *
+ * @returns The field type instance or null if not found.
+ */
+export declare function getFieldType(fieldTypeGuid: Guid): IFieldType | null;
+/**
+ * Provides the attribute guid for a field type component to use.
+ *
+ * @param guid A reference to the attribute guid value.
+ */
+export declare function provideFieldTypeAttributeGuid(guid: Ref<Guid | undefined | null>): void;
+/**
+ * Gets a reference to the attribute guid value for this field. The value may be
+ * undefined or null.
+ *
+ * @returns A function that will cause the block component to be reloaded.
+ */
+export declare function useFieldTypeAttributeGuid(): Ref<Guid | undefined | null>;

package/types/Utility/file.d.ts

@@ -1,8 +1,40 @@
-/**
- * Triggers an automatic download of the data so it can be saved to the
- * filesystem.
- *
- * @param data The data to be downloaded by the browser.
- * @param filename The name of the filename to suggest to the browser.
- */
-export declare function downloadFile(data: Blob, filename: string): Promise<void>;
+/**
+ * Triggers an automatic download of the data so it can be saved to the
+ * filesystem.
+ *
+ * @param data The data to be downloaded by the browser.
+ * @param filename The name of the filename to suggest to the browser.
+ */
+export declare function downloadFile(data: Blob, filename: string): Promise<void>;
+/**
+ * Fetch the global attribute configuration for image file extensions from the server as an array of
+ * file extension strings.
+ *
+ * Cacheable version of fetchImageFileExtensions
+ */
+export declare const getImageFileExtensions: () => Promise<string[] | null>;
+/**
+ * Determine, based on the file's extension and the list of image file extensions (from the
+ * server's configuration), whether the file is an image.
+ */
+export declare function isImage(filename: string): Promise<boolean>;
+/**
+ * Creates a file processor function that resizes images to fit within a specified maximum width and/or height,
+ * while maintaining the original aspect ratio.
+ *
+ * If the input file is not an image, it is returned unchanged. If `maxWidth` or `maxHeight` is provided,
+ * the image will be resized accordingly.
+ *
+ * @param {object} [options] - The resizing options (optional).
+ * @param {number} [options.maxWidth] - The maximum allowed width for the image (optional).
+ * @param {number} [options.maxHeight] - The maximum allowed height for the image (optional).
+ * @returns {(file: File) => File | Promise<File>} A function that processes the given file and returns either the original file or a resized version.
+ *
+ * @example
+ * const processor = resizeImageFileProcessor({ maxWidth: 800 }); // Resize only by width
+ * const resizedFile = await processor(imageFile);
+ */
+export declare function resizeImageFileProcessor({ maxWidth, maxHeight }?: {
+    maxWidth?: number;
+    maxHeight?: number;
+}): (file: File) => File | Promise<File>;

package/types/Utility/form.d.ts

@@ -1,33 +1,33 @@
-/**
- * Holds the state of a single form on the page along with any callback methods
- * that can be used to interact with the form.
- */
-export declare type FormState = {
-    /** The number of submissions the form has had. */
-    submitCount: number;
-    /** Sets the current error for the given field name. A blank error means no error. */
-    setError: (id: string, name: string, error: string) => void;
-};
-/**
- * Contains the internal form error passed between RockForm and RockValidation.
- *
- * This is an internal type and subject to change at any time.
- */
-export declare type FormError = {
-    /** The name of the field. */
-    name: string;
-    /** The current error text. */
-    text: string;
-};
-/**
- * Provides the form state for any child components that need access to it.
- *
- * @param state The state that will be provided to child components.
- */
-export declare function provideFormState(state: FormState): void;
-/**
- * Makes use of the FormState that was previously provided by a parent component.
- *
- * @returns The form state or undefined if it was not available.
- */
-export declare function useFormState(): FormState | undefined;
+/**
+ * Holds the state of a single form on the page along with any callback methods
+ * that can be used to interact with the form.
+ */
+export type FormState = {
+    /** The number of submissions the form has had. */
+    submitCount: number;
+    /** Sets the current error for the given field name. A blank error means no error. */
+    setError: (id: string, name: string, error: string) => void;
+};
+/**
+ * Contains the internal form error passed between RockForm and RockValidation.
+ *
+ * This is an internal type and subject to change at any time.
+ */
+export type FormError = {
+    /** The name of the field. */
+    name: string;
+    /** The current error text. */
+    text: string;
+};
+/**
+ * Provides the form state for any child components that need access to it.
+ *
+ * @param state The state that will be provided to child components.
+ */
+export declare function provideFormState(state: FormState): void;
+/**
+ * Makes use of the FormState that was previously provided by a parent component.
+ *
+ * @returns The form state or undefined if it was not available.
+ */
+export declare function useFormState(): FormState | undefined;

package/types/Utility/fullscreen.d.ts

@@ -1,33 +1,37 @@
-declare global {
-    interface Document {
-        mozCancelFullScreen?: () => Promise<void>;
-        webkitExitFullscreen?: () => Promise<void>;
-        mozFullScreenElement?: Element;
-        webkitFullscreenElement?: Element;
-    }
-    interface HTMLElement {
-        mozRequestFullscreen?: () => Promise<void>;
-        webkitRequestFullscreen?: () => Promise<void>;
-    }
-}
-/**
- * Request that the window enter true fullscreen mode for the given element.
- *
- * @param element The element that will be the root of the fullscreen view.
- * @param exitCallback The function to call when leaving fullscreen mode.
- *
- * @returns A promise that indicates when the operation has completed.
- */
-export declare function enterFullscreen(element: HTMLElement, exitCallback?: (() => void)): Promise<boolean>;
-/**
- * Checks if any element is currently in fullscreen mode.
- *
- * @returns True if an element is currently in fullscreen mode in the window; otherwise false.
- */
-export declare function isFullscreen(): boolean;
-/**
- * Manually exits fullscreen mode.
- *
- * @returns True if fullscreen mode was exited; otherwise false.
- */
-export declare function exitFullscreen(): Promise<boolean>;
+declare global {
+    interface Document {
+        mozCancelFullScreen?: () => Promise<void>;
+        webkitExitFullscreen?: () => Promise<void>;
+        mozFullScreenElement?: Element;
+        webkitFullscreenElement?: Element;
+    }
+    interface HTMLElement {
+        mozRequestFullscreen?: () => Promise<void>;
+        webkitRequestFullscreen?: () => Promise<void>;
+    }
+}
+/**
+ * Request that the window enter true fullscreen mode for the given element.
+ *
+ * @param element The element that will be the root of the fullscreen view.
+ * @param exitCallback The function to call when leaving fullscreen mode.
+ *
+ * @returns A promise that indicates when the operation has completed.
+ */
+export declare function enterFullscreen(element: HTMLElement, exitCallback?: (() => void)): Promise<boolean>;
+/**
+ * Checks if any element is currently in fullscreen mode.
+ *
+ * @returns True if an element is currently in fullscreen mode in the window; otherwise false.
+ */
+export declare function isFullscreen(): boolean;
+/**
+ * Gets the element that is currently the root of fullscreen mode.
+ */
+export declare function getFullscreenElement(): Element | undefined;
+/**
+ * Manually exits fullscreen mode.
+ *
+ * @returns True if fullscreen mode was exited; otherwise false.
+ */
+export declare function exitFullscreen(): Promise<boolean>;

package/types/Utility/geo.d.ts

@@ -1,45 +1,45 @@
-import { DrawingMode, Coordinate, ILatLng, ILatLngLiteral } from "@Obsidian/Types/Controls/geo";
-import { GeoPickerSettingsBag } from "@Obsidian/ViewModels/Rest/Controls/geoPickerSettingsBag";
-import { GeoPickerGetSettingsOptionsBag } from "@Obsidian/ViewModels/Rest/Controls/geoPickerGetSettingsOptionsBag";
-/**
- * Converts a LatLng object, "lat,lng" coordinate string, or WellKnown "lng lat" coordinate string to a Coordinate array
- * @param coord Either a string in "lat,lng" format or a LatLng object from Google Maps
- * @param isWellKnown True if is "lng lat" format, false if it is "lat, lng"
- *
- * @returns Coordinate: Tuple with a Latitude number and Longitude number as the elements
- */
-export declare function toCoordinate(coord: string | ILatLng, isWellKnown?: boolean): Coordinate;
-/**
- * Takes a Well Known Text value and converts it into a Coordinate array
- */
-export declare function wellKnownToCoordinates(wellKnownText: string, type: DrawingMode): Coordinate[];
-/**
- * Takes a Well Known Text value and converts it into a Coordinate array
- */
-export declare function coordinatesToWellKnown(coordinates: Coordinate[], type: DrawingMode): string;
-/**
- * Takes a Coordinate and uses Geocoding to get nearest address
- */
-export declare function nearAddressForCoordinate(coordinate: Coordinate): Promise<string>;
-/**
- * Takes a Coordinate array and uses Geocoding to get nearest address for the first point
- */
-export declare function nearAddressForCoordinates(coordinates: Coordinate[]): Promise<string>;
-/**
- * Determine whether the polygon's coordinates are drawn in clockwise order
- * Thank you dominoc!
- * http://dominoc925.blogspot.com/2012/03/c-code-to-determine-if-polygon-vertices.html
- */
-export declare function isClockwisePolygon(polygon: number[][]): boolean;
-/**
- * Download the necessary resources to run the maps and return the map settings from the API
- *
- * @param options Options for which data to get from the API
- *
- * @return Promise with the map settings retrieved from the API
- */
-export declare function loadMapResources(options?: GeoPickerGetSettingsOptionsBag): Promise<GeoPickerSettingsBag>;
-/**
- * Creates a ILatLng object
- */
-export declare function createLatLng(latOrLatLngOrLatLngLiteral: number | ILatLngLiteral | ILatLng, lngOrNoClampNoWrap?: number | boolean | null, noClampNoWrap?: boolean): ILatLng;
+import { DrawingMode, Coordinate, ILatLng, ILatLngLiteral } from "@Obsidian/Types/Controls/geo";
+import { GeoPickerSettingsBag } from "@Obsidian/ViewModels/Rest/Controls/geoPickerSettingsBag";
+import { GeoPickerGetSettingsOptionsBag } from "@Obsidian/ViewModels/Rest/Controls/geoPickerGetSettingsOptionsBag";
+/**
+ * Converts a LatLng object, "lat,lng" coordinate string, or WellKnown "lng lat" coordinate string to a Coordinate array
+ * @param coord Either a string in "lat,lng" format or a LatLng object from Google Maps
+ * @param isWellKnown True if is "lng lat" format, false if it is "lat, lng"
+ *
+ * @returns Coordinate: Tuple with a Latitude number and Longitude number as the elements
+ */
+export declare function toCoordinate(coord: string | ILatLng, isWellKnown?: boolean): Coordinate;
+/**
+ * Takes a Well Known Text value and converts it into a Coordinate array
+ */
+export declare function wellKnownToCoordinates(wellKnownText: string, type: DrawingMode): Coordinate[];
+/**
+ * Takes a Well Known Text value and converts it into a Coordinate array
+ */
+export declare function coordinatesToWellKnown(coordinates: Coordinate[], type: DrawingMode): string;
+/**
+ * Takes a Coordinate and uses Geocoding to get nearest address
+ */
+export declare function nearAddressForCoordinate(coordinate: Coordinate): Promise<string>;
+/**
+ * Takes a Coordinate array and uses Geocoding to get nearest address for the first point
+ */
+export declare function nearAddressForCoordinates(coordinates: Coordinate[]): Promise<string>;
+/**
+ * Determine whether the polygon's coordinates are drawn in clockwise order
+ * Thank you dominoc!
+ * http://dominoc925.blogspot.com/2012/03/c-code-to-determine-if-polygon-vertices.html
+ */
+export declare function isClockwisePolygon(polygon: number[][]): boolean;
+/**
+ * Download the necessary resources to run the maps and return the map settings from the API
+ *
+ * @param options Options for which data to get from the API
+ *
+ * @return Promise with the map settings retrieved from the API
+ */
+export declare function loadMapResources(options?: GeoPickerGetSettingsOptionsBag): Promise<GeoPickerSettingsBag>;
+/**
+ * Creates a ILatLng object
+ */
+export declare function createLatLng(latOrLatLngOrLatLngLiteral: number | ILatLngLiteral | ILatLng, lngOrNoClampNoWrap?: number | boolean | null, noClampNoWrap?: boolean): ILatLng;