@rockrms/obsidian-framework 18.2.4 → 19.1.8

package/types/Controls/learningClassPicker.obs.d.ts

@@ -1,5 +1,6 @@
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { PropType } from "vue";
+import { Guid } from "@Obsidian/Types";
 declare const _default: import("vue").DefineComponent<{
     label: {
         type: PropType<string>;
@@ -26,12 +27,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
+    trailblazerField: {
+        type: PropType<boolean>;
+        default: false;
+    };
     enhanceForLongLists: {
         type: PropType<boolean>;
         default: false;
     };
     lazyMode: {
-        type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
+        type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode.js").ControlLazyMode>;
         default: "onDemand";
     };
     multiple: {
@@ -47,7 +52,7 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     displayStyle: {
-        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
+        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle.js").PickerDisplayStyle>;
         default: "auto";
     };
     columnCount: {
@@ -59,7 +64,7 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     learningCourseGuid: {
-        type: PropType<string | null>;
+        type: PropType<Guid | null>;
         required: true;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
@@ -90,12 +95,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
+    trailblazerField: {
+        type: PropType<boolean>;
+        default: false;
+    };
     enhanceForLongLists: {
         type: PropType<boolean>;
         default: false;
     };
     lazyMode: {
-        type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
+        type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode.js").ControlLazyMode>;
         default: "onDemand";
     };
     multiple: {
@@ -111,7 +120,7 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     displayStyle: {
-        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
+        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle.js").PickerDisplayStyle>;
         default: "auto";
     };
     columnCount: {
@@ -123,25 +132,26 @@ declare const _default: import("vue").DefineComponent<{
         required: false;
     };
     learningCourseGuid: {
-        type: PropType<string | null>;
+        type: PropType<Guid | null>;
         required: true;
     };
 }>> & {
     "onUpdate:modelValue"?: ((value: ListItemBag | ListItemBag[] | null) => any) | undefined;
 }, {
+    columnCount: number;
     label: string;
+    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     help: string;
     disableLabel: boolean;
-    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    multiple: boolean;
-    enhanceForLongLists: boolean;
+    trailblazerField: boolean;
     showBlankItem: boolean;
     blankValue: string;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
-    displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
-    columnCount: number;
+    multiple: boolean;
+    enhanceForLongLists: boolean;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode.js").ControlLazyMode;
+    displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle.js").PickerDisplayStyle;
 }, {}>;
 export default _default;

package/types/Controls/lineChart.obs.d.ts

@@ -1,5 +1,5 @@
 import { PropType } from "vue";
-import { LabelDateFormat, LegendAlign, LegendPosition, LineSeries, LineStyle, TooltipCallback } from "@Obsidian/Core/Controls/chart";
+import { LabelDateFormat, LegendAlign, LegendPosition, LineSeries, LineStyle, TitleAlign, TooltipCallback } from "@Obsidian/Core/Controls/chart";
 declare const _default: import("vue").DefineComponent<{
     /**
      * The category axis label.
@@ -96,6 +96,12 @@ declare const _default: import("vue").DefineComponent<{
     title: {
         type: PropType<string | undefined>;
     };
+    /**
+     * The alignment of the chart title.
+     */
+    titleAlign: {
+        type: PropType<TitleAlign | undefined>;
+    };
     /**
      * The tooltip formatter function.
      */
@@ -281,6 +287,12 @@ declare const _default: import("vue").DefineComponent<{
     title: {
         type: PropType<string | undefined>;
     };
+    /**
+     * The alignment of the chart title.
+     */
+    titleAlign: {
+        type: PropType<TitleAlign | undefined>;
+    };
     /**
      * The tooltip formatter function.
      */
@@ -371,8 +383,8 @@ declare const _default: import("vue").DefineComponent<{
         default: string;
     };
 }>>, {
-    type: "number" | "percent";
-    width: string | undefined;
     height: string | undefined;
+    width: string | undefined;
+    type: "number" | "percent";
 }, {}>;
 export default _default;

package/types/Controls/linearGaugeChart.obs.d.ts

@@ -0,0 +1,247 @@
+import { PropType } from "vue";
+import { LegendAlign, LegendPosition, LinearGaugeSectionStyle, LinearGaugeSeries, TitleAlign, TooltipCallback } from "@Obsidian/Core/Controls/chart";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The CSS style string to set the height of the doughnut chart component.
+     * - Accepts any valid CSS height value (e.g., "400px", "50vh") or undefined.
+     * - Value defaults to "100%" if undefined.
+     */
+    height: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+    /**
+     * Whether the legend is hidden.
+     */
+    hideLegend: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The labels to display to the left of each linear gauge.
+     *
+     * Each label corresponds by index to a rendered gauge. For example,
+     * `labels[i]` describes the i-th linear gauge formed from the series data.
+     */
+    labels: {
+        type: PropType<string[] | undefined>;
+        required: false;
+    };
+    /**
+     * The alignment of the legend in the chart.
+     */
+    legendAlign: {
+        type: PropType<LegendAlign | null | undefined>;
+    };
+    /**
+     * The position of the legend in the chart.
+     */
+    legendPosition: {
+        type: PropType<LegendPosition | undefined>;
+    };
+    /**
+     * The line style used to render each section of the linear gauge.
+     *
+     * A segmented style renders sections as a series of discrete visual pieces,
+     * while a continuous style renders each section as a single uninterrupted shape.
+     */
+    sectionStyle: {
+        type: PropType<LinearGaugeSectionStyle>;
+        default: string;
+    };
+    /**
+     * The series used to render the linear gauge.
+     *
+     * Each entry represents a section that may appear in one or more linear gauges.
+     * Sections at the same index across all series are combined to form a single gauge.
+     *
+     * @example
+     * ```ts
+     * // Example for a single linear gauge composed of three sections
+     * // representing request health (On Track, Due Soon, Overdue)
+     * const series: LinearGaugeSeries[] = [
+     *   { label: "On Track", data: [55], color: "var(--color-success-strong)" },
+     *   { label: "Due Soon", data: [18], color: "#F59E0B" },
+     *   { label: "Overdue", data: [8], color: "#EF4444" }
+     * ];
+     * ```
+     *
+     * @example
+     * ```ts
+     * // Example for multiple linear gauges using the same sections.
+     * // Each index across the data arrays forms a complete gauge.
+     * // In this example, two gauges are rendered.
+     * const series: LinearGaugeSeries[] = [
+     *   { label: "On Track", data: [55, 42], color: "var(--color-success-strong)" },
+     *   { label: "Due Soon", data: [18, 25], color: "#F59E0B" },
+     *   { label: "Overdue", data: [8, 13], color: "#EF4444" }
+     * ];
+     * ```
+     */
+    series: {
+        type: PropType<LinearGaugeSeries[]>;
+        required: true;
+    };
+    /**
+     * The title of the chart.
+     */
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The alignment of the chart title.
+     */
+    titleAlign: {
+        type: PropType<TitleAlign | undefined>;
+    };
+    /**
+     * The tooltip formatter function.
+     *
+     * This formats the value portion of the tooltip body. The title of the tooltip will use the `tooltipTitle` formatter if provided, otherwise it will use the default formatter.
+     */
+    tooltip: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The tooltip title.
+     *
+     * Either a string or a formatter function can be used. If a formatter function is provided, it will be used to format the title of the tooltip. If a string is provided, it will be used as the title for all tooltips. If neither is provided, the default formatter will use the series label as the title.
+     */
+    tooltipTitle: {
+        type: PropType<TooltipCallback | string | undefined>;
+    };
+    /**
+     * The CSS style string to set the width of the doughnut chart component.
+     * - Accepts any valid CSS width value (e.g., "600px", "100%") or undefined.
+     * - Value defaults to "100%" if undefined.
+     */
+    width: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The CSS style string to set the height of the doughnut chart component.
+     * - Accepts any valid CSS height value (e.g., "400px", "50vh") or undefined.
+     * - Value defaults to "100%" if undefined.
+     */
+    height: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+    /**
+     * Whether the legend is hidden.
+     */
+    hideLegend: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The labels to display to the left of each linear gauge.
+     *
+     * Each label corresponds by index to a rendered gauge. For example,
+     * `labels[i]` describes the i-th linear gauge formed from the series data.
+     */
+    labels: {
+        type: PropType<string[] | undefined>;
+        required: false;
+    };
+    /**
+     * The alignment of the legend in the chart.
+     */
+    legendAlign: {
+        type: PropType<LegendAlign | null | undefined>;
+    };
+    /**
+     * The position of the legend in the chart.
+     */
+    legendPosition: {
+        type: PropType<LegendPosition | undefined>;
+    };
+    /**
+     * The line style used to render each section of the linear gauge.
+     *
+     * A segmented style renders sections as a series of discrete visual pieces,
+     * while a continuous style renders each section as a single uninterrupted shape.
+     */
+    sectionStyle: {
+        type: PropType<LinearGaugeSectionStyle>;
+        default: string;
+    };
+    /**
+     * The series used to render the linear gauge.
+     *
+     * Each entry represents a section that may appear in one or more linear gauges.
+     * Sections at the same index across all series are combined to form a single gauge.
+     *
+     * @example
+     * ```ts
+     * // Example for a single linear gauge composed of three sections
+     * // representing request health (On Track, Due Soon, Overdue)
+     * const series: LinearGaugeSeries[] = [
+     *   { label: "On Track", data: [55], color: "var(--color-success-strong)" },
+     *   { label: "Due Soon", data: [18], color: "#F59E0B" },
+     *   { label: "Overdue", data: [8], color: "#EF4444" }
+     * ];
+     * ```
+     *
+     * @example
+     * ```ts
+     * // Example for multiple linear gauges using the same sections.
+     * // Each index across the data arrays forms a complete gauge.
+     * // In this example, two gauges are rendered.
+     * const series: LinearGaugeSeries[] = [
+     *   { label: "On Track", data: [55, 42], color: "var(--color-success-strong)" },
+     *   { label: "Due Soon", data: [18, 25], color: "#F59E0B" },
+     *   { label: "Overdue", data: [8, 13], color: "#EF4444" }
+     * ];
+     * ```
+     */
+    series: {
+        type: PropType<LinearGaugeSeries[]>;
+        required: true;
+    };
+    /**
+     * The title of the chart.
+     */
+    title: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The alignment of the chart title.
+     */
+    titleAlign: {
+        type: PropType<TitleAlign | undefined>;
+    };
+    /**
+     * The tooltip formatter function.
+     *
+     * This formats the value portion of the tooltip body. The title of the tooltip will use the `tooltipTitle` formatter if provided, otherwise it will use the default formatter.
+     */
+    tooltip: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The tooltip title.
+     *
+     * Either a string or a formatter function can be used. If a formatter function is provided, it will be used to format the title of the tooltip. If a string is provided, it will be used as the title for all tooltips. If neither is provided, the default formatter will use the series label as the title.
+     */
+    tooltipTitle: {
+        type: PropType<TooltipCallback | string | undefined>;
+    };
+    /**
+     * The CSS style string to set the width of the doughnut chart component.
+     * - Accepts any valid CSS width value (e.g., "600px", "100%") or undefined.
+     * - Value defaults to "100%" if undefined.
+     */
+    width: {
+        type: PropType<string | undefined>;
+        default: string;
+    };
+}>>, {
+    title: string;
+    height: string | undefined;
+    width: string | undefined;
+    sectionStyle: LinearGaugeSectionStyle;
+}, {}>;
+export default _default;

package/types/Controls/listBox.obs.d.ts

@@ -2,7 +2,7 @@ import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { PropType } from "vue";
 declare const _default: import("vue").DefineComponent<{
     modelValue: {
-        type: PropType<string[]>;
+        type: PropType<Array<string>>;
         default: never[];
     };
     items: {
@@ -29,7 +29,7 @@ declare const _default: import("vue").DefineComponent<{
     "update:modelValue": (value: string[]) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     modelValue: {
-        type: PropType<string[]>;
+        type: PropType<Array<string>>;
         default: never[];
     };
     items: {
@@ -55,11 +55,11 @@ declare const _default: import("vue").DefineComponent<{
 }>> & {
     "onUpdate:modelValue"?: ((value: string[]) => any) | undefined;
 }, {
-    modelValue: string[];
     items: ListItemBag[];
-    enhanceForLongLists: boolean;
+    modelValue: string[];
     showBlankItem: boolean;
     blankValue: string;
     formControlClasses: string;
+    enhanceForLongLists: boolean;
 }, {}>;
 export default _default;

package/types/Controls/listItems.obs.d.ts

@@ -25,6 +25,10 @@ declare const _default: import("vue").DefineComponent<{
         type: import("vue").PropType<boolean>;
         default: false;
     };
+    trailblazerField: {
+        type: import("vue").PropType<boolean>;
+        default: false;
+    };
     modelValue: {
         type: StringConstructor;
         default: string;
@@ -65,6 +69,10 @@ declare const _default: import("vue").DefineComponent<{
         type: import("vue").PropType<boolean>;
         default: false;
     };
+    trailblazerField: {
+        type: import("vue").PropType<boolean>;
+        default: false;
+    };
     modelValue: {
         type: StringConstructor;
         default: string;
@@ -81,13 +89,14 @@ declare const _default: import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }, {
     label: string;
-    help: string;
+    rules: ValidationRule | ValidationRule[];
     modelValue: string;
+    help: string;
     disableLabel: boolean;
-    rules: ValidationRule | ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    trailblazerField: boolean;
     allowHtml: boolean;
     valuePrompt: string;
 }, {}>;

package/types/Controls/loading.obs.d.ts

@@ -1,5 +1,9 @@
 import { PropType } from "vue";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<{
     isLoading: {
         type: PropType<boolean>;
         required: true;
@@ -21,11 +25,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
 }>>, {
     isSmall: boolean;
-}, {}>, {
-    default?(_: {}): any;
-}>;
+}, {}>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };

package/types/Controls/locationAddressPicker.obs.d.ts

@@ -1,6 +1,22 @@
 import { PropType } from "vue";
 import { AddressControlBag } from "@Obsidian/ViewModels/Controls/addressControlBag";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+declare var __VLS_20: {}, __VLS_22: {
+    isInputGroupSupported: boolean;
+}, __VLS_24: {
+    isInputGroupSupported: boolean;
+}, __VLS_26: {
+    isInputGroupSupported: boolean;
+};
+type __VLS_Slots = {} & {
+    pickerContentSuperHeader?: (props: typeof __VLS_20) => any;
+} & {
+    prepend?: (props: typeof __VLS_22) => any;
+} & {
+    inputGroupPrepend?: (props: typeof __VLS_24) => any;
+} & {
+    append?: (props: typeof __VLS_26) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<{
     modelValue: {
         type: PropType<AddressControlBag>;
         required: true;
@@ -36,6 +52,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
+    trailblazerField: {
+        type: PropType<boolean>;
+        default: false;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: AddressControlBag) => void;
     "update:showPopup": (value: boolean) => void;
@@ -75,32 +95,27 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
+    trailblazerField: {
+        type: PropType<boolean>;
+        default: false;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: AddressControlBag) => any) | undefined;
     "onUpdate:showPopup"?: ((value: boolean) => any) | undefined;
 }, {
     label: string;
+    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     help: string;
     disableLabel: boolean;
-    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    trailblazerField: boolean;
     showPopup: boolean;
-}, {}>, {
-    pickerContentSuperHeader?(_: {}): any;
-    prepend?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-    inputGroupPrepend?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-    append?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-}>;
+}, {}>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };

package/types/Controls/locationItemPicker.obs.d.ts

@@ -1,6 +1,22 @@
 import { PropType } from "vue";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+declare var __VLS_5: {}, __VLS_7: {
+    isInputGroupSupported: boolean;
+}, __VLS_9: {
+    isInputGroupSupported: boolean;
+}, __VLS_11: {
+    isInputGroupSupported: boolean;
+};
+type __VLS_Slots = {} & {
+    pickerContentSuperHeader?: (props: typeof __VLS_5) => any;
+} & {
+    prepend?: (props: typeof __VLS_7) => any;
+} & {
+    inputGroupPrepend?: (props: typeof __VLS_9) => any;
+} & {
+    append?: (props: typeof __VLS_11) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<{
     modelValue: {
         type: PropType<ListItemBag | ListItemBag[] | null>;
         default: null;
@@ -46,22 +62,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     "onUpdate:showPopup"?: ((value: boolean) => any) | undefined;
 }, {
     modelValue: ListItemBag | ListItemBag[] | null;
-    showPopup: boolean;
     multiple: boolean;
-}, {}>, {
-    pickerContentSuperHeader?(_: {}): any;
-    prepend?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-    inputGroupPrepend?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-    append?(_: {
-        isInputGroupSupported: boolean;
-    }): any;
-}>;
+    showPopup: boolean;
+}, {}>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };