@rockrms/obsidian-framework 18.2.4 → 19.1.8

package/types/Templates/detailBlock.d.ts

@@ -1,4 +1,5 @@
 import { PropType } from "vue";
+import { Guid } from "@Obsidian/Types";
 import { PanelAction } from "@Obsidian/Types/Controls/panelAction";
 import { DetailPanelMode } from "@Obsidian/Enums/Controls/detailPanelMode";
 /** Provides a pattern for entity detail blocks. */
@@ -23,7 +24,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     /** The unique identifier of the entity type that this detail block represents. */
     entityTypeGuid: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         required: false;
     };
     /** The friendly name of the entity type that this block represents. */
@@ -107,6 +108,15 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<PanelAction[]>;
         required: false;
     };
+    /**
+     * When true, the `labels` render inside the panel header (next to the
+     * title) rather than in the default sub-header row. Opt-in so existing
+     * blocks keep their current placement.
+     */
+    showLabelsInHeader: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     /**
      * Additional actions to display in the footer of the panel. These are
      * currently displayed as full buttons on the left of the footer.
@@ -184,6 +194,13 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    /**
+     * Shows the experience mode picker for this block.
+     */
+    showExperienceMode: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }, {
     editForm: any;
     entityTypeName: import("vue").ComputedRef<string>;
@@ -213,6 +230,7 @@ declare const _default: import("vue").DefineComponent<{
     showTags: import("vue").ComputedRef<boolean>;
 }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:mode": (_value: DetailPanelMode) => true;
+    "update:isFullscreen": (_value: boolean) => true;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     /** If true then labels for the entity will be visible regardless of the panel mode. */
     alwaysShowLabels: {
@@ -234,7 +252,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     /** The unique identifier of the entity type that this detail block represents. */
     entityTypeGuid: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         required: false;
     };
     /** The friendly name of the entity type that this block represents. */
@@ -318,6 +336,15 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<PanelAction[]>;
         required: false;
     };
+    /**
+     * When true, the `labels` render inside the panel header (next to the
+     * title) rather than in the default sub-header row. Opt-in so existing
+     * blocks keep their current placement.
+     */
+    showLabelsInHeader: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     /**
      * Additional actions to display in the footer of the panel. These are
      * currently displayed as full buttons on the left of the footer.
@@ -395,8 +422,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    /**
+     * Shows the experience mode picker for this block.
+     */
+    showExperienceMode: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:mode"?: ((_value: DetailPanelMode) => any) | undefined;
+    "onUpdate:isFullscreen"?: ((_value: boolean) => any) | undefined;
 }, {
     alwaysShowLabels: boolean;
     isTagsVisible: boolean;
@@ -408,6 +443,8 @@ declare const _default: import("vue").DefineComponent<{
     isDeleteVisible: boolean;
     isFullScreenVisible: boolean;
     mode: DetailPanelMode;
+    showLabelsInHeader: boolean;
     worksurfaceMode: boolean;
+    showExperienceMode: boolean;
 }, {}>;
 export default _default;

package/types/Templates/rockBlock.partial.d.ts

@@ -23,9 +23,9 @@ declare const _default: import("vue").DefineComponent<{
     blockGuid: string;
     currentBlockComponent: import("vue").Ref<{
         new (...args: any[]): any;
-        __isFragment?: undefined;
-        __isTeleport?: undefined;
-        __isSuspense?: undefined;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
     } | import("vue").FunctionalComponent<any, any, any> | {
         [x: string]: any;
         setup?: ((this: void, props: import("@vue/shared").LooseRequired<any>, ctx: {
@@ -36,13 +36,13 @@ declare const _default: import("vue").DefineComponent<{
                 [name: string]: import("vue").Slot<any> | undefined;
             }>;
             emit: ((event: unknown, ...args: any[]) => void) | ((event: string, ...args: any[]) => void);
-            expose: (exposed?: Record<string, any> | undefined) => void;
+            expose: (exposed?: Record<string, any>) => void;
         }) => any) | undefined;
         name?: string | undefined;
         template?: string | object | undefined;
         render?: Function | undefined;
-        components?: Record<string, Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>> | undefined;
-        directives?: Record<string, import("vue").Directive<any, any>> | undefined;
+        components?: Record<string, Component> | undefined;
+        directives?: Record<string, import("vue").Directive> | undefined;
         inheritAttrs?: boolean | undefined;
         emits?: any;
         slots?: {} | undefined;
@@ -55,9 +55,9 @@ declare const _default: import("vue").DefineComponent<{
             delimiters?: [string, string] | undefined;
         } | undefined;
         call?: ((this: unknown, ...args: unknown[]) => never) | undefined;
-        __isFragment?: undefined;
-        __isTeleport?: undefined;
-        __isSuspense?: undefined;
+        __isFragment?: never | undefined;
+        __isTeleport?: never | undefined;
+        __isSuspense?: never | undefined;
         __defaults?: any;
         compatConfig?: {
             GLOBAL_MOUNT?: boolean | "suppress-warning" | undefined;
@@ -102,16 +102,16 @@ declare const _default: import("vue").DefineComponent<{
             RENDER_FUNCTION?: boolean | "suppress-warning" | undefined;
             FILTERS?: boolean | "suppress-warning" | undefined;
             PRIVATE_APIS?: boolean | "suppress-warning" | undefined;
-            MODE?: 2 | 3 | ((comp: Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions> | null) => 2 | 3) | undefined;
+            MODE?: 2 | 3 | ((comp: Component | null) => 2 | 3) | undefined;
         } | undefined;
         data?: ((this: any, vm: any) => any) | undefined;
         computed?: import("vue").ComputedOptions | undefined;
         methods?: import("vue").MethodOptions | undefined;
         watch?: {
             [x: string]: (string | import("vue").WatchCallback<any, any> | ({
-                handler: string | import("vue").WatchCallback<any, any>;
+                handler: import("vue").WatchCallback | string;
             } & import("vue").WatchOptions<boolean>)) | (string | import("vue").WatchCallback<any, any> | ({
-                handler: string | import("vue").WatchCallback<any, any>;
+                handler: import("vue").WatchCallback | string;
             } & import("vue").WatchOptions<boolean>))[];
         } | undefined;
         provide?: import("vue").ComponentProvideOptions | undefined;
@@ -133,7 +133,7 @@ declare const _default: import("vue").DefineComponent<{
         unmounted?: (() => void) | undefined;
         renderTracked?: ((e: import("vue").DebuggerEvent) => void) | undefined;
         renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | undefined;
-        errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | undefined;
+        errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance | null, info: string) => boolean | void) | undefined;
         delimiters?: [string, string] | undefined;
         __differentiator?: string | number | symbol | undefined;
         __isBuiltIn?: boolean | undefined;
@@ -142,9 +142,9 @@ declare const _default: import("vue").DefineComponent<{
     } | null>;
     customActionComponent: import("vue").Ref<{
         new (...args: any[]): any;
-        __isFragment?: undefined;
-        __isTeleport?: undefined;
-        __isSuspense?: undefined;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
     } | import("vue").FunctionalComponent<any, any, any> | {
         [x: string]: any;
         setup?: ((this: void, props: import("@vue/shared").LooseRequired<any>, ctx: {
@@ -155,13 +155,13 @@ declare const _default: import("vue").DefineComponent<{
                 [name: string]: import("vue").Slot<any> | undefined;
             }>;
             emit: ((event: unknown, ...args: any[]) => void) | ((event: string, ...args: any[]) => void);
-            expose: (exposed?: Record<string, any> | undefined) => void;
+            expose: (exposed?: Record<string, any>) => void;
         }) => any) | undefined;
         name?: string | undefined;
         template?: string | object | undefined;
         render?: Function | undefined;
-        components?: Record<string, Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions>> | undefined;
-        directives?: Record<string, import("vue").Directive<any, any>> | undefined;
+        components?: Record<string, Component> | undefined;
+        directives?: Record<string, import("vue").Directive> | undefined;
         inheritAttrs?: boolean | undefined;
         emits?: any;
         slots?: {} | undefined;
@@ -174,9 +174,9 @@ declare const _default: import("vue").DefineComponent<{
             delimiters?: [string, string] | undefined;
         } | undefined;
         call?: ((this: unknown, ...args: unknown[]) => never) | undefined;
-        __isFragment?: undefined;
-        __isTeleport?: undefined;
-        __isSuspense?: undefined;
+        __isFragment?: never | undefined;
+        __isTeleport?: never | undefined;
+        __isSuspense?: never | undefined;
         __defaults?: any;
         compatConfig?: {
             GLOBAL_MOUNT?: boolean | "suppress-warning" | undefined;
@@ -221,16 +221,16 @@ declare const _default: import("vue").DefineComponent<{
             RENDER_FUNCTION?: boolean | "suppress-warning" | undefined;
             FILTERS?: boolean | "suppress-warning" | undefined;
             PRIVATE_APIS?: boolean | "suppress-warning" | undefined;
-            MODE?: 2 | 3 | ((comp: Component<any, any, any, import("vue").ComputedOptions, import("vue").MethodOptions> | null) => 2 | 3) | undefined;
+            MODE?: 2 | 3 | ((comp: Component | null) => 2 | 3) | undefined;
         } | undefined;
         data?: ((this: any, vm: any) => any) | undefined;
         computed?: import("vue").ComputedOptions | undefined;
         methods?: import("vue").MethodOptions | undefined;
         watch?: {
             [x: string]: (string | import("vue").WatchCallback<any, any> | ({
-                handler: string | import("vue").WatchCallback<any, any>;
+                handler: import("vue").WatchCallback | string;
             } & import("vue").WatchOptions<boolean>)) | (string | import("vue").WatchCallback<any, any> | ({
-                handler: string | import("vue").WatchCallback<any, any>;
+                handler: import("vue").WatchCallback | string;
             } & import("vue").WatchOptions<boolean>))[];
         } | undefined;
         provide?: import("vue").ComponentProvideOptions | undefined;
@@ -252,7 +252,7 @@ declare const _default: import("vue").DefineComponent<{
         unmounted?: (() => void) | undefined;
         renderTracked?: ((e: import("vue").DebuggerEvent) => void) | undefined;
         renderTriggered?: ((e: import("vue").DebuggerEvent) => void) | undefined;
-        errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance<{}, {}, {}, {}, {}, {}, {}, {}, false, import("vue").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, {}, {}, string, {}>, {}, {}> | null, info: string) => boolean | void) | undefined;
+        errorCaptured?: ((err: unknown, instance: import("vue").ComponentPublicInstance | null, info: string) => boolean | void) | undefined;
         delimiters?: [string, string] | undefined;
         __differentiator?: string | number | symbol | undefined;
         __isBuiltIn?: boolean | undefined;

package/types/Templates/rockPage.d.ts

@@ -52,7 +52,7 @@ export declare function showCustomBlockAction(actionFileUrl: string, pageGuid: s
  *
  * @param {object} pageConfig
  */
-export declare function initializePage(pageConfig: PageConfig): Promise<void>;
+export declare function initializePage(pageConfig: PageConfig): void;
 /**
  * Shows the Obsidian debug timings
  * @param debugTimingConfig

package/types/Types/Controls/grid.d.ts

@@ -1019,6 +1019,17 @@ export interface IGridState {
      */
     getSortedRows(): Record<string, unknown>[];
 
+    /**
+     * Sorts the given set of rows. This does not update the internal state of
+     * the grid, it simply returns a new array of rows that is sorted.
+     *
+     * @param rows The rows that should be sorted according to the current sorting definition.
+     * @param columnSort The column sort definition that describes how to sort the rows.
+     *
+     * @returns A new array of rows that is properly sorted.
+     */
+    sortRows(rows: ReadonlyArray<Record<string, unknown>>, columnSort: ColumnSort): Record<string, unknown>[];
+
     /**
      * Registers a function that will be called whenever the value of the
      * property changes.

package/types/Types/Controls/valueDetailListItem.d.ts

@@ -29,4 +29,7 @@ export type ValueDetailListItem = {
 
     /** The HTML value to be displayed. No escaping is performed. */
     htmlValue?: string;
+
+    /** The HTMLElement to be displayed as the value. */
+    elementValue?: HTMLElement;
 };

package/types/Types/Utility/http.d.ts

@@ -29,9 +29,9 @@ export type HttpResult<T> = {
     errorMessage: string | null;
 };
 
-export type HttpDoApiCallFunc = <T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, cancellationToken?: ICancellationToken) => Promise<HttpResult<T>>;
+export type HttpDoApiCallFunc = <T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, options?: { headers?: Record<string, string> }, cancellationToken?: ICancellationToken) => Promise<HttpResult<T>>;
 
-export type HttpDoStreamingApiCallFunc = <T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, cancellationToken?: ICancellationToken) => Promise<HttpResult<ReadableStream<T>>>;
+export type HttpDoStreamingApiCallFunc = <T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, options?: { headers?: Record<string, string> }, cancellationToken?: ICancellationToken) => Promise<HttpResult<ReadableStream<T>>>;
 
 export type HttpGetFunc = <T>(url: string, params?: HttpUrlParams) => Promise<HttpResult<T>>;
 

package/types/Utility/component.d.ts

@@ -79,6 +79,15 @@ type StandardRockFormFieldProps = {
         type: PropType<boolean>;
         default: false;
     };
+    /**
+     * True if the field is only available when the page is in trailblazer
+     * mode. The field will automatically be hidden and not participate in any
+     * form validation.
+     */
+    trailblazerField: {
+        type: PropType<boolean>;
+        default: false;
+    };
 };
 /** The standard component props that should be included when using RockFormField. */
 export declare const standardRockFormFieldProps: StandardRockFormFieldProps;

package/types/Utility/dom.d.ts

@@ -3,6 +3,7 @@
  */
 export declare function getUniqueCssSelector(el: Element): string;
 export declare function getAncestors(element: Element): IterableIterator<Element>;
+export declare function isElementFullyVisible(element: Element): boolean;
 /**
  * Scrolls the start of an element to the top of the window.
  *

package/types/Utility/file.d.ts

@@ -26,6 +26,8 @@ export declare function isImage(filename: string): Promise<boolean>;
  * the image will be resized accordingly.
  *
  * @param {object} [options] - The resizing options (optional).
+ * @param {number} [options.minWidth] - The minimum allowed width for the image (optional).
+ * @param {number} [options.minHeight] - The minimum allowed height for the image (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.
@@ -34,7 +36,9 @@ export declare function isImage(filename: string): Promise<boolean>;
  * const processor = resizeImageFileProcessor({ maxWidth: 800 }); // Resize only by width
  * const resizedFile = await processor(imageFile);
  */
-export declare function resizeImageFileProcessor({ maxWidth, maxHeight }?: {
+export declare function resizeImageFileProcessor({ minWidth, minHeight, maxWidth, maxHeight }?: {
+    minWidth?: number;
+    minHeight?: number;
     maxWidth?: number;
     maxHeight?: number;
 }): (file: File) => File | Promise<File>;

package/types/Utility/http.d.ts

@@ -8,10 +8,12 @@ import { ICancellationToken } from "./cancellation";
  * normally be used. Instead call useHttp() to get the HTTP functions that
  * can be used.
  *
- * @param {string} method The HTTP method, such as GET
- * @param {string} url The endpoint to access, such as /api/campuses/
- * @param {object} params Query parameter object.  Will be converted to ?key1=value1&key2=value2 as part of the URL.
- * @param {any} data This will be the body of the request
+ * @obsolete RockObsolete( "19.0" ) - Use the overload that accepts an options object.
+ *
+ * @param method The HTTP method, such as GET
+ * @param url The endpoint to access, such as /api/campuses/
+ * @param params Query parameter object.  Will be converted to ?key1=value1&key2=value2 as part of the URL.
+ * @param data This will be the body of the request
  */
 export declare function doApiCall<T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, cancellationToken?: ICancellationToken): Promise<HttpResult<T>>;
 /**
@@ -19,12 +21,42 @@ export declare function doApiCall<T>(method: HttpMethod, url: string, params?: H
  * normally be used. Instead call useHttp() to get the HTTP functions that
  * can be used.
  *
- * @param {string} method The HTTP method, such as GET
- * @param {string} url The endpoint to access, such as /api/campuses/
- * @param {object} params Query parameter object.  Will be converted to ?key1=value1&key2=value2 as part of the URL.
- * @param {any} data This will be the body of the request
+ * @param method The HTTP method, such as GET
+ * @param url The endpoint to access, such as /api/campuses/
+ * @param params Query parameter object.  Will be converted to ?key1=value1&key2=value2 as part of the URL.
+ * @param data This will be the body of the request
+ * @param options Additional options to use when construction the API call.
+ */
+export declare function doApiCall<T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, options?: {
+    headers?: Record<string, string>;
+}, cancellationToken?: ICancellationToken): Promise<HttpResult<T>>;
+/**
+ * Make an API call.  This is a special use function that should not
+ * normally be used. Instead call useHttp() to get the HTTP functions that
+ * can be used.
+ *
+ * @obsolete RockObsolete( "19.0" ) - Use the overload that accepts an options object.
+ *
+ * @param method The HTTP method, such as GET
+ * @param url The endpoint to access, such as /api/campuses/
+ * @param params Query parameter object.  Will be converted to ?key1=value1&key2=value2 as part of the URL.
+ * @param data This will be the body of the request
+ */
+export declare function doStreamingApiCall<T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, cancellationToken?: ICancellationToken): Promise<HttpResult<T>>;
+/**
+ * Make an API call.  This is a special use function that should not
+ * normally be used. Instead call useHttp() to get the HTTP functions that
+ * can be used.
+ *
+ * @param method The HTTP method, such as GET
+ * @param url The endpoint to access, such as /api/campuses/
+ * @param params Query parameter object.  Will be converted to ?key1=value1&key2=value2 as part of the URL.
+ * @param data This will be the body of the request
+ * @param options Additional options to use when construction the API call.
  */
-export declare function doStreamingApiCall<T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, cancellationToken?: ICancellationToken): Promise<HttpResult<ReadableStream<T>>>;
+export declare function doStreamingApiCall<T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, options?: {
+    headers?: Record<string, string>;
+}, cancellationToken?: ICancellationToken): Promise<HttpResult<T>>;
 /**
  * Make a GET HTTP request. This is a special use function that should not
  * normally be used. Instead call useHttp() to get the HTTP functions that

package/types/Utility/linq.d.ts

@@ -274,6 +274,23 @@ export declare class Enumerable<T> {
      * // Throws: Invalid cast: Value 'hello' cannot be cast to the specified type.
      */
     cast<U extends T>(typeCheck: (item: T) => item is U): Enumerable<U>;
+    /**
+     * Splits the sequence into chunks of the specified size.
+     * - Deferred execution
+     * - Each chunk is an array of size `size`
+     * - The final chunk may contain fewer elements
+     * - Throws if size < 1
+     *
+     * @param size The maximum size of each chunk. Must be greater than 0.
+     * @returns An Enumerable of arrays, each containing up to `size` elements.
+     *
+     * @example
+     * Enumerable.from([1, 2, 3, 4, 5])
+     *   .chunk(2)
+     *   .toArray();
+     * // [[1, 2], [3, 4], [5]]
+     */
+    chunk(size: number): Enumerable<T[]>;
     /**
      * Concatenates the current sequence with another sequence.
      * @param second - The second sequence to concatenate.

package/types/Utility/page.d.ts

@@ -10,6 +10,7 @@ export type PageConfig = {
     currentPerson: CurrentPersonBag | null;
     isAnonymousVisitor: boolean;
     loginUrlWithReturnUrl: string;
+    trailblazerMode: boolean;
 };
 export declare function smoothScrollToTop(): void;
 declare const _default: {

package/types/Utility/rockDateTime.d.ts

@@ -292,6 +292,19 @@ export declare class RockDateTime {
      * @returns A string that represents the amount of time that has elapsed.
      */
     toElapsedString(currentDateTime?: RockDateTime): string;
+    /**
+     * Converts this date into a compact elapsed time string such as "5m", "3h",
+     * "9d", "2w", or "1y".
+     *
+     * This format is intended for UI displays where space is limited (e.g. grid
+     * columns, badges, activity lists). Months are intentionally skipped to avoid
+     * ambiguity (28–31 days), using weeks instead.
+     *
+     * @param currentDateTime Optional reference time. Defaults to now.
+     *
+     * @returns A compact elapsed time string.
+     */
+    toElapsedShortString(currentDateTime?: RockDateTime): string;
     /**
      * Formats this instance as a string that can be used in HTTP headers and
      * cookies.