@rockrms/obsidian-framework 17.5.2 → 18.1.0

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

@@ -0,0 +1,364 @@
+import { PropType } from "vue";
+import { LabelDateFormat, LegendAlign, LegendPosition, LineStyle, PieSeries, TooltipCallback } from "@Obsidian/Core/Controls/chart";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The category axis label.
+     */
+    categoryLabel: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The maximum number of ticks to show on the category axis.
+     */
+    categoryMaxTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * Whether to show the category axis grid lines. Hidden by default.
+     */
+    categoryShowGridLines: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The CSS style string to set the height of the pie 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 format to use for the date labels.
+     *
+     * When set, `labels` is treated as an array of ISO date strings.
+     */
+    labelDateFormat: {
+        type: PropType<LabelDateFormat | undefined>;
+    };
+    /**
+     * When supplying date strings, they MUST be in ISO format and you MUST set `labelDateFormat`.
+     */
+    labels: {
+        type: PropType<string[]>;
+        required: true;
+    };
+    /**
+     * 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>;
+    };
+    /**
+     * Whether the chart has linear connections between data points.
+     *
+     * The per series property, `props.data[n].isLinear`, overrides this setting.
+     */
+    linear: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The line style to use for the chart.
+     *
+     * The per series property, `props.data[n].lineStyle`, overrides this setting.
+     */
+    lineStyle: {
+        type: PropType<LineStyle | undefined>;
+    };
+    /**
+     * The series data to display in the chart.
+     */
+    series: {
+        type: PropType<PieSeries[]>;
+        required: true;
+    };
+    /**
+     * Whether the chart has stacked lines.
+     */
+    stack: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The title of the chart.
+     */
+    title: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The tooltip formatter function.
+     */
+    tooltip: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The tooltip title formatter function.
+     */
+    tooltipTitle: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The type of data represented in the chart.
+     *
+     * For "percent", the data MUST be in decimal form (e.g., 0.1 for 10%).
+     */
+    type: {
+        type: PropType<"number" | "percent">;
+        default: string;
+    };
+    /**
+     * Whether the chart has unfilled areas.
+     *
+     * The per series property, `props.data[n].isUnfilled`, overrides this setting.
+     */
+    unfilled: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * Whether to hide the value axis grid lines. Shown by default.
+     */
+    valueHideGridLines: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The value axis label.
+     */
+    valueLabel: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The maximum number of ticks to show on the value axis.
+     */
+    valueMaxTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The minimum value to display in the value axis if there is nothing lower.
+     *
+     * This is useful for controlling the starting point of the value axis.
+     * The actual minimum value will be used if there is a lower value present.
+     */
+    valueSuggestedMin: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The maximum value to display in the value axis if there is nothing higher.
+     *
+     * This is useful for controlling the ending point of the value axis.
+     * The actual maximum value will be used if there is a higher value present.
+     */
+    valueSuggestedMax: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The number of ticks to show on the value axis.
+     *
+     * This overrides `valueMaxTickCount`.
+     */
+    valueTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The CSS style string to set the width of the pie 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 category axis label.
+     */
+    categoryLabel: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The maximum number of ticks to show on the category axis.
+     */
+    categoryMaxTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * Whether to show the category axis grid lines. Hidden by default.
+     */
+    categoryShowGridLines: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The CSS style string to set the height of the pie 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 format to use for the date labels.
+     *
+     * When set, `labels` is treated as an array of ISO date strings.
+     */
+    labelDateFormat: {
+        type: PropType<LabelDateFormat | undefined>;
+    };
+    /**
+     * When supplying date strings, they MUST be in ISO format and you MUST set `labelDateFormat`.
+     */
+    labels: {
+        type: PropType<string[]>;
+        required: true;
+    };
+    /**
+     * 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>;
+    };
+    /**
+     * Whether the chart has linear connections between data points.
+     *
+     * The per series property, `props.data[n].isLinear`, overrides this setting.
+     */
+    linear: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The line style to use for the chart.
+     *
+     * The per series property, `props.data[n].lineStyle`, overrides this setting.
+     */
+    lineStyle: {
+        type: PropType<LineStyle | undefined>;
+    };
+    /**
+     * The series data to display in the chart.
+     */
+    series: {
+        type: PropType<PieSeries[]>;
+        required: true;
+    };
+    /**
+     * Whether the chart has stacked lines.
+     */
+    stack: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The title of the chart.
+     */
+    title: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The tooltip formatter function.
+     */
+    tooltip: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The tooltip title formatter function.
+     */
+    tooltipTitle: {
+        type: PropType<TooltipCallback | undefined>;
+    };
+    /**
+     * The type of data represented in the chart.
+     *
+     * For "percent", the data MUST be in decimal form (e.g., 0.1 for 10%).
+     */
+    type: {
+        type: PropType<"number" | "percent">;
+        default: string;
+    };
+    /**
+     * Whether the chart has unfilled areas.
+     *
+     * The per series property, `props.data[n].isUnfilled`, overrides this setting.
+     */
+    unfilled: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * Whether to hide the value axis grid lines. Shown by default.
+     */
+    valueHideGridLines: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The value axis label.
+     */
+    valueLabel: {
+        type: PropType<string | undefined>;
+    };
+    /**
+     * The maximum number of ticks to show on the value axis.
+     */
+    valueMaxTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The minimum value to display in the value axis if there is nothing lower.
+     *
+     * This is useful for controlling the starting point of the value axis.
+     * The actual minimum value will be used if there is a lower value present.
+     */
+    valueSuggestedMin: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The maximum value to display in the value axis if there is nothing higher.
+     *
+     * This is useful for controlling the ending point of the value axis.
+     * The actual maximum value will be used if there is a higher value present.
+     */
+    valueSuggestedMax: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The number of ticks to show on the value axis.
+     *
+     * This overrides `valueMaxTickCount`.
+     */
+    valueTickCount: {
+        type: PropType<number | undefined>;
+    };
+    /**
+     * The CSS style string to set the width of the pie 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;
+    };
+}>>, {
+    type: "number" | "percent";
+    width: string | undefined;
+    height: string | undefined;
+}, {}>;
+export default _default;

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

@@ -8,6 +8,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    progressBarType: {
+        type: PropType<"default" | "danger" | "warning" | "success" | "info">;
+        default: string;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     percent: {
         type: PropType<number>;
@@ -17,7 +21,12 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    progressBarType: {
+        type: PropType<"default" | "danger" | "warning" | "success" | "info">;
+        default: string;
+    };
 }>>, {
     showCompletionText: boolean;
+    progressBarType: "default" | "danger" | "warning" | "success" | "info";
 }, {}>;
 export default _default;

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

@@ -27,13 +27,13 @@ declare const _default: import("vue").DefineComponent<{
         default: false;
     };
     enhanceForLongLists: {
+        /**
+         * Loads the items from the server.
+         */
         type: PropType<boolean>;
         default: false;
     };
     lazyMode: {
-        /**
-         * Loads the items from the server.
-         */
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };
@@ -51,7 +51,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     displayStyle: {
         type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
-        default: "auto";
+        default: "auto"; /** The currently selected campus value(s). */
     };
     columnCount: {
         type: PropType<number>;
@@ -99,13 +99,13 @@ declare const _default: import("vue").DefineComponent<{
         default: false;
     };
     enhanceForLongLists: {
+        /**
+         * Loads the items from the server.
+         */
         type: PropType<boolean>;
         default: false;
     };
     lazyMode: {
-        /**
-         * Loads the items from the server.
-         */
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };
@@ -123,7 +123,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     displayStyle: {
         type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
-        default: "auto";
+        default: "auto"; /** The currently selected campus value(s). */
     };
     columnCount: {
         type: PropType<number>;

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

@@ -16,11 +16,11 @@ declare const _default: import("vue").DefineComponent<{
     rules: import("@Obsidian/ValidationRules").RulesPropType;
     formGroupClasses: {
         type: PropType<string>;
-        default: ""; /** The currently selected campus value(s). */
+        default: "";
     };
     validationTitle: {
         type: PropType<string>;
-        default: "";
+        default: ""; /** GUID for the Registration Template that you want to pull instances from */
     };
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
@@ -34,9 +34,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };
-    /**
-     * Loads the items from the server.
-     */
     multiple: {
         type: PropType<boolean>;
         default: false;
@@ -85,11 +82,11 @@ declare const _default: import("vue").DefineComponent<{
     rules: import("@Obsidian/ValidationRules").RulesPropType;
     formGroupClasses: {
         type: PropType<string>;
-        default: ""; /** The currently selected campus value(s). */
+        default: "";
     };
     validationTitle: {
         type: PropType<string>;
-        default: "";
+        default: ""; /** GUID for the Registration Template that you want to pull instances from */
     };
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
@@ -103,9 +100,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };
-    /**
-     * Loads the items from the server.
-     */
     multiple: {
         type: PropType<boolean>;
         default: false;

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

@@ -1,5 +1,6 @@
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { PropType } from "vue";
+import { ValidationRule } from "@Obsidian/ValidationRules";
 declare const _default: import("vue").DefineComponent<{
     modelValue: {
         type: PropType<ListItemBag | null>;
@@ -14,6 +15,15 @@ declare const _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
+    rules: {
+        type: PropType<ValidationRule | ValidationRule[]>;
+        default: string;
+    };
+    /** Enhance the picker for dealing with long lists by providing a search mechanism. */
+    enhanceForLongLists: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: ListItemBag | null) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -30,10 +40,21 @@ declare const _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
+    rules: {
+        type: PropType<ValidationRule | ValidationRule[]>;
+        default: string;
+    };
+    /** Enhance the picker for dealing with long lists by providing a search mechanism. */
+    enhanceForLongLists: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: ListItemBag | null) => any) | undefined;
 }, {
     disabled: boolean;
+    rules: ValidationRule | ValidationRule[];
+    enhanceForLongLists: boolean;
     registrationTemplateGuid: string | null;
 }, {}>;
 export default _default;

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

@@ -20,6 +20,7 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     validationTitle: {
+        /** Filter the resulting reminder types to only be of the given entity type */
         type: PropType<string>;
         default: "";
     };
@@ -37,12 +38,12 @@ declare const _default: import("vue").DefineComponent<{
     };
     multiple: {
         type: PropType<boolean>;
-        default: false;
-    };
-    showBlankItem: {
         /**
          * Loads the items from the server.
          */
+        default: false;
+    };
+    showBlankItem: {
         type: PropType<boolean>;
         default: false;
     };
@@ -89,6 +90,7 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     validationTitle: {
+        /** Filter the resulting reminder types to only be of the given entity type */
         type: PropType<string>;
         default: "";
     };
@@ -106,12 +108,12 @@ declare const _default: import("vue").DefineComponent<{
     };
     multiple: {
         type: PropType<boolean>;
-        default: false;
-    };
-    showBlankItem: {
         /**
          * Loads the items from the server.
          */
+        default: false;
+    };
+    showBlankItem: {
         type: PropType<boolean>;
         default: false;
     };

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

@@ -20,8 +20,16 @@ declare const _default: import("vue").DefineComponent<{
     };
     validationTitle: {
         type: PropType<string>;
+        /**
+         * The actual items to make available to the picker. This allows us to do any
+         * post-processing, such as adding additional items, and still be lazy loaded as well.
+         */
         default: "";
     };
+    /**
+     * The actual items to make available to the picker. This allows us to do any
+     * post-processing, such as adding additional items, and still be lazy loaded as well.
+     */
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
         default: false;
@@ -80,8 +88,16 @@ declare const _default: import("vue").DefineComponent<{
     };
     validationTitle: {
         type: PropType<string>;
+        /**
+         * The actual items to make available to the picker. This allows us to do any
+         * post-processing, such as adding additional items, and still be lazy loaded as well.
+         */
         default: "";
     };
+    /**
+     * The actual items to make available to the picker. This allows us to do any
+     * post-processing, such as adding additional items, and still be lazy loaded as well.
+     */
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
         default: false;

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

@@ -1,6 +1,6 @@
 import { PropType } from "vue";
 import { ComparisonValue } from "@Obsidian/Types/Reporting/comparisonValue";
-import { FilterMode } from "@Obsidian/Core/Reporting/filterMode";
+import { FilterMode } from "@Obsidian/Enums/Reporting/filterMode";
 import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
 declare const _default: import("vue").DefineComponent<{
     modelValue: {
@@ -19,7 +19,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     filterMode: {
         type: PropType<FilterMode>;
-        default: FilterMode;
+        default: 0;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: ComparisonValue) => void;
@@ -40,7 +40,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     filterMode: {
         type: PropType<FilterMode>;
-        default: FilterMode;
+        default: 0;
     };
 }>> & {
     "onUpdate:modelValue"?: ((value: ComparisonValue) => any) | undefined;

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

@@ -8,11 +8,6 @@ declare const _default: import("vue").DefineComponent<{
         default: false;
     };
     help: {
-        type: import("vue").PropType<string>;
-        default: "";
-    };
-    rules: import("@Obsidian/ValidationRules").RulesPropType;
-    formGroupClasses: {
         type: import("vue").PropType<string>; /**
          * If the modelValue is an object or array and its properties get changed, normally
          * that doesn't trigger a re-validation. If you enable this, it'll watch more deeply for
@@ -22,6 +17,11 @@ declare const _default: import("vue").DefineComponent<{
          */
         default: "";
     };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
     validationTitle: {
         type: import("vue").PropType<string>;
         default: "";
@@ -64,11 +64,6 @@ declare const _default: import("vue").DefineComponent<{
         default: false;
     };
     help: {
-        type: import("vue").PropType<string>;
-        default: "";
-    };
-    rules: import("@Obsidian/ValidationRules").RulesPropType;
-    formGroupClasses: {
         type: import("vue").PropType<string>; /**
          * If the modelValue is an object or array and its properties get changed, normally
          * that doesn't trigger a re-validation. If you enable this, it'll watch more deeply for
@@ -78,6 +73,11 @@ declare const _default: import("vue").DefineComponent<{
          */
         default: "";
     };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
     validationTitle: {
         type: import("vue").PropType<string>;
         default: "";