@rockrms/obsidian-framework 17.6.1 → 18.1.0

package/types/Controls/Internal/smsMobilePreview.obs.d.ts

@@ -0,0 +1,40 @@
+import { PropType } from "vue";
+import { BinaryFileAttachment } from "./MobilePreview/types.partial";
+declare const _default: import("vue").DefineComponent<{
+    isLoading: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    smsMessage: {
+        type: PropType<string>;
+        required: true;
+    };
+    smsFromNumberName: {
+        type: PropType<string>;
+        required: true;
+    };
+    smsAttachmentLinks: {
+        type: PropType<BinaryFileAttachment[]>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    isLoading: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    smsMessage: {
+        type: PropType<string>;
+        required: true;
+    };
+    smsFromNumberName: {
+        type: PropType<string>;
+        required: true;
+    };
+    smsAttachmentLinks: {
+        type: PropType<BinaryFileAttachment[]>;
+        required: true;
+    };
+}>>, {
+    isLoading: boolean;
+}, {}>;
+export default _default;

package/types/Controls/Internal/universalItemSearchPicker.obs.d.ts

@@ -21,6 +21,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         required: false;
     };
+    context: {
+        type: PropType<string>;
+        required: false;
+    };
 }, {}, 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<{
@@ -44,6 +48,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         required: false;
     };
+    context: {
+        type: PropType<string>;
+        required: false;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: ListItemBag | null) => any) | undefined;
 }, {

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

@@ -30,7 +30,7 @@ declare const _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
-    /** If false, set automatically fill state and country fields with default values if not provided in model value */
+    /** If false, automatically fill state and country fields with default values if not provided in model value */
     omitDefaultValues: {
         type: BooleanConstructor;
         default: boolean;
@@ -77,7 +77,7 @@ declare const _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
-    /** If false, set automatically fill state and country fields with default values if not provided in model value */
+    /** If false, automatically fill state and country fields with default values if not provided in model value */
     omitDefaultValues: {
         type: BooleanConstructor;
         default: boolean;

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

@@ -0,0 +1,464 @@
+import { PropType } from "vue";
+import { BarChartClickEvent, BarLabelPosition, BarLabelSpec, BarSeries, LabelDateFormat, LegendAlign, LegendPosition, TooltipCallback } from "@Obsidian/Core/Controls/chart";
+declare const _default: import("vue").DefineComponent<{
+    /** The configuration for the bar labels for all series. */
+    barLabels: {
+        type: PropType<Partial<Record<BarLabelPosition, BarLabelSpec>> | undefined>;
+    };
+    /**
+     * 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>;
+    };
+    /**
+     * Whether to show all ticks on the category axis.
+     */
+    categoryShowAllTicks: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The CSS style string to set the height of the bar 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>;
+    };
+    /**
+     * Whether to display horizontal bars instead of vertical bars.
+     */
+    horizontal: {
+        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>;
+    };
+    /**
+     * When `true`, bars from multiple datasets are drawn in the same position
+     * and overlap each other rather than being shown side-by-side (grouped)
+     * or stacked.
+     *
+     * Note: If the dataset values should accumulate into a single bar,
+     * use the `stack` prop instead.
+     *
+     * For example:
+     * - Default (grouped): each dataset has its own bar next to the others
+     *   for the same category.
+     * - stack: dataset values accumulate vertically (or horizontally) into
+     *   a single bar for each category.
+     * - overlap: all datasets share the same bar slot and are drawn on top of
+     *   each other. This is often combined with transparency to allow visual
+     *   comparison without stacking values.
+     *
+     * Charting pros: Equivalent to Chart.js’s `grouped: false` setting for
+     * bar charts. Unlike stacking, values do not accumulate — bars simply
+     * share the same baseline and x-position.
+     */
+    overlap: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The series data to display in the chart.
+     */
+    series: {
+        type: PropType<BarSeries[]>;
+        required: true;
+    };
+    /**
+     * When `true`, bars from multiple data series are stacked on top of each other
+     * instead of being drawn side-by-side.
+     *
+     * Note: If the bars should share the same position without accumulating
+     * their values, use the `overlap` prop instead.
+     *
+     * For example:
+     * - Without stacking (default), each series is shown with its own separate bar
+     *   for the same category (grouped layout).
+     * - With stacking enabled, series values for the same category accumulate
+     *   vertically (or horizontally, if using horizontal bars) into a single bar.
+     *
+     * This makes it easy to compare both the total value across series and the
+     * contribution of each series to that total.
+     *
+     * Charting pros: This prop switches the bar layout mode from "grouped" to
+     * "stack" (cumulative). Stacking preserves relative series proportions
+     * within a category but alters absolute comparisons across categories.
+     */
+    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 number of decimal places to display for values.
+     * Applies to both axis tick labels and tooltips.
+     */
+    valuePrecision: {
+        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 bar 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, {
+    click: (value: BarChartClickEvent) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The configuration for the bar labels for all series. */
+    barLabels: {
+        type: PropType<Partial<Record<BarLabelPosition, BarLabelSpec>> | undefined>;
+    };
+    /**
+     * 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>;
+    };
+    /**
+     * Whether to show all ticks on the category axis.
+     */
+    categoryShowAllTicks: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The CSS style string to set the height of the bar 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>;
+    };
+    /**
+     * Whether to display horizontal bars instead of vertical bars.
+     */
+    horizontal: {
+        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>;
+    };
+    /**
+     * When `true`, bars from multiple datasets are drawn in the same position
+     * and overlap each other rather than being shown side-by-side (grouped)
+     * or stacked.
+     *
+     * Note: If the dataset values should accumulate into a single bar,
+     * use the `stack` prop instead.
+     *
+     * For example:
+     * - Default (grouped): each dataset has its own bar next to the others
+     *   for the same category.
+     * - stack: dataset values accumulate vertically (or horizontally) into
+     *   a single bar for each category.
+     * - overlap: all datasets share the same bar slot and are drawn on top of
+     *   each other. This is often combined with transparency to allow visual
+     *   comparison without stacking values.
+     *
+     * Charting pros: Equivalent to Chart.js’s `grouped: false` setting for
+     * bar charts. Unlike stacking, values do not accumulate — bars simply
+     * share the same baseline and x-position.
+     */
+    overlap: {
+        type: PropType<boolean | undefined>;
+    };
+    /**
+     * The series data to display in the chart.
+     */
+    series: {
+        type: PropType<BarSeries[]>;
+        required: true;
+    };
+    /**
+     * When `true`, bars from multiple data series are stacked on top of each other
+     * instead of being drawn side-by-side.
+     *
+     * Note: If the bars should share the same position without accumulating
+     * their values, use the `overlap` prop instead.
+     *
+     * For example:
+     * - Without stacking (default), each series is shown with its own separate bar
+     *   for the same category (grouped layout).
+     * - With stacking enabled, series values for the same category accumulate
+     *   vertically (or horizontally, if using horizontal bars) into a single bar.
+     *
+     * This makes it easy to compare both the total value across series and the
+     * contribution of each series to that total.
+     *
+     * Charting pros: This prop switches the bar layout mode from "grouped" to
+     * "stack" (cumulative). Stacking preserves relative series proportions
+     * within a category but alters absolute comparisons across categories.
+     */
+    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 number of decimal places to display for values.
+     * Applies to both axis tick labels and tooltips.
+     */
+    valuePrecision: {
+        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 bar 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;
+    };
+}>> & {
+    onClick?: ((value: BarChartClickEvent) => any) | undefined;
+}, {
+    type: "number" | "percent";
+    width: string | undefined;
+    height: string | undefined;
+}, {}>;
+export default _default;

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

@@ -30,9 +30,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
-    /**
-     * Loads the items from the server.
-     */
     lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
@@ -97,9 +94,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
-    /**
-     * Loads the items from the server.
-     */
     lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";

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

@@ -29,13 +29,13 @@ declare const _default: import("vue").DefineComponent<{
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;
     formGroupClasses: {
-        type: PropType<string>;
+        type: PropType<string>; /** V-Model of the template string */
         default: "";
     };
     validationTitle: {
         type: PropType<string>;
         default: "";
-    }; /** V-Model of the template string */
+    };
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
         default: false;
@@ -73,13 +73,13 @@ declare const _default: import("vue").DefineComponent<{
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;
     formGroupClasses: {
-        type: PropType<string>;
+        type: PropType<string>; /** V-Model of the template string */
         default: "";
     };
     validationTitle: {
         type: PropType<string>;
         default: "";
-    }; /** V-Model of the template string */
+    };
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
         default: false;

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

@@ -1,5 +1,6 @@
 import { PropType } from "vue";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { BtnType } from "@Obsidian/Enums/Controls/btnType";
 declare const _default: import("vue").DefineComponent<{
     label: {
         type: PropType<string>;
@@ -14,7 +15,6 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;
-    /** Used as a label on the button when using checkmark selection style */
     formGroupClasses: {
         type: PropType<string>;
         default: "";
@@ -23,10 +23,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         default: "";
     };
-    /**
-     * When set to 'title', when an item is selected, the selected item is displayed as the button text, or if set to 'checkmark'
-     * it will place a check next to the selected item and display a given `title` as the button text
-     */
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
         default: false;
@@ -54,6 +50,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<"title" | "checkmark">;
         default: string;
     };
+    btnType: {
+        type: PropType<BtnType>;
+        default: "default";
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (v: string) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -70,7 +70,6 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;
-    /** Used as a label on the button when using checkmark selection style */
     formGroupClasses: {
         type: PropType<string>;
         default: "";
@@ -79,10 +78,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         default: "";
     };
-    /**
-     * When set to 'title', when an item is selected, the selected item is displayed as the button text, or if set to 'checkmark'
-     * it will place a check next to the selected item and display a given `title` as the button text
-     */
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
         default: false;
@@ -110,11 +105,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<"title" | "checkmark">;
         default: string;
     };
+    btnType: {
+        type: PropType<BtnType>;
+        default: "default";
+    };
 }>> & {
     "onUpdate:modelValue"?: ((v: string) => any) | undefined;
 }, {
     label: string;
     title: string;
+    btnType: BtnType;
     help: string;
     modelValue: string;
     disableLabel: boolean;