@rockrms/obsidian-framework 1.16.3-rc.2 → 1.16.4-rc.1

package/package.json

@@ -7,7 +7,7 @@
         "type": "git",
         "url": "git+https://github.com/SparkDevNetwork/Rock.git"
     },
-    "version": "1.16.3-rc.2",
+    "version": "1.16.4-rc.1",
     "peerDependencies": {
         "vue": "3.2.35"
     }

package/types/Controls/Grid/filterHeaderRow.partial.obs.d.ts

@@ -31,6 +31,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         required: false;
     };
+    /** Determines if the count message is visible. */
+    isCountMessageVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** Determines if the search box is visible. */
+    isSearchVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:quickFilterValue": (value: string) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -64,6 +74,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         required: false;
     };
+    /** Determines if the count message is visible. */
+    isCountMessageVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** Determines if the search box is visible. */
+    isSearchVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:quickFilterValue"?: ((value: string) => any) | undefined;
 }, {
@@ -72,5 +92,7 @@ declare const _default: import("vue").DefineComponent<{
     })[];
     quickFilterValue: string;
     visibleColumnCount: number;
+    isCountMessageVisible: boolean;
+    isSearchVisible: boolean;
 }>;
 export default _default;

package/types/Controls/Grid/grid.partial.obs.d.ts

@@ -253,6 +253,22 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<(key: string) => void | Promise<void>>;
         required: false;
     };
+    /**
+     * When `true`, the row count message will be displayed. When `false`,
+     * the row count message will be hidden.
+     */
+    isCountMessageVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * When `true`, the search box will be displayed. When `false`, the
+     * search box will be hidden.
+     */
+    isSearchVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }, {
     deleteRow: (keyOrIndex: string | number) => void;
     rowUpdated: (keyOrIndex: string | number) => void;
@@ -514,12 +530,30 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<(key: string) => void | Promise<void>>;
         required: false;
     };
+    /**
+     * When `true`, the row count message will be displayed. When `false`,
+     * the row count message will be hidden.
+     */
+    isCountMessageVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * When `true`, the search box will be displayed. When `false`, the
+     * search box will be hidden.
+     */
+    isSearchVisible: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }>> & {
     onFilteredRowsChanged?: ((grid: IGridState) => any) | undefined;
     onSelectedKeysChanged?: ((grid: IGridState) => any) | undefined;
     onGridSettingsClick?: (() => any) | undefined;
 }, {
     light: boolean;
+    isCountMessageVisible: boolean;
+    isSearchVisible: boolean;
     stickyHeader: boolean;
     personAsBusiness: boolean;
     mergeTemplateAsPerson: boolean;

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

@@ -1,5 +1,6 @@
 import { PropType } from "vue";
 import { TreeItemBag } from "@Obsidian/ViewModels/Utility/treeItemBag";
+import { ITreeItemProvider } from "@Obsidian/Utility/treeItemProviders";
 declare const _default: import("vue").DefineComponent<{
     modelValue: {
         type: PropType<string[]>;
@@ -17,6 +18,9 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    provider: {
+        type: PropType<ITreeItemProvider>;
+    };
     /**
      * Automatically open to show children if a selected value is a child of this item
      */
@@ -52,6 +56,9 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    provider: {
+        type: PropType<ITreeItemProvider>;
+    };
     /**
      * Automatically open to show children if a selected value is a child of this item
      */

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

@@ -0,0 +1,53 @@
+import { PropType } from "vue";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+declare const _default: import("vue").DefineComponent<{
+    modelValue: {
+        type: PropType<ListItemBag | null>;
+        required: false;
+    };
+    iconCssClass: {
+        type: PropType<string>;
+        required: false;
+    };
+    areDetailsAlwaysVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    isIncludeInactiveVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    searchUrl: {
+        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<{
+    modelValue: {
+        type: PropType<ListItemBag | null>;
+        required: false;
+    };
+    iconCssClass: {
+        type: PropType<string>;
+        required: false;
+    };
+    areDetailsAlwaysVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    isIncludeInactiveVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    searchUrl: {
+        type: PropType<string>;
+        required: false;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: ListItemBag | null) => any) | undefined;
+}, {
+    areDetailsAlwaysVisible: boolean;
+    isIncludeInactiveVisible: boolean;
+}>;
+export default _default;

package/types/Controls/Internal/universalItemSearchPickerResult.partial.obs.d.ts

@@ -0,0 +1,28 @@
+import { PropType } from "vue";
+import { UniversalItemSearchPickerItemBag } from "@Obsidian/ViewModels/Controls/universalItemSearchPickerItemBag";
+declare const _default: import("vue").DefineComponent<{
+    result: {
+        type: PropType<UniversalItemSearchPickerItemBag>;
+        required: true;
+    };
+    areDetailsAlwaysVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    select: (value: UniversalItemSearchPickerItemBag) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    result: {
+        type: PropType<UniversalItemSearchPickerItemBag>;
+        required: true;
+    };
+    areDetailsAlwaysVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}>> & {
+    onSelect?: ((value: UniversalItemSearchPickerItemBag) => any) | undefined;
+}, {
+    areDetailsAlwaysVisible: boolean;
+}>;
+export default _default;

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

@@ -47,6 +47,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<BtnSize>;
         default: "";
     };
+    disabled: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (_value: string) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -94,11 +98,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<BtnSize>;
         default: "";
     };
+    disabled: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((_value: string) => any) | undefined;
 }, {
     label: string;
     help: string;
+    disabled: boolean;
     rules: import("@Obsidian/Types/validationRules.js").ValidationRule | import("@Obsidian/Types/validationRules.js").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;

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

@@ -1,18 +1,18 @@
 import { PropType } from "vue";
-import { RockCacheability } from "@Obsidian/ViewModels/Controls/rockCacheability";
+import { RockCacheabilityBag } from "@Obsidian/ViewModels/Controls/rockCacheabilityBag";
 declare const _default: import("vue").DefineComponent<{
     modelValue: {
-        type: PropType<RockCacheability | null>;
+        type: PropType<RockCacheabilityBag | null>;
         required: true;
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (_value: RockCacheability | null) => void;
+    "update:modelValue": (_value: RockCacheabilityBag | null) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     modelValue: {
-        type: PropType<RockCacheability | null>;
+        type: PropType<RockCacheabilityBag | null>;
         required: true;
     };
 }>> & {
-    "onUpdate:modelValue"?: ((_value: RockCacheability | null) => any) | undefined;
+    "onUpdate:modelValue"?: ((_value: RockCacheabilityBag | null) => any) | undefined;
 }, {}>;
 export default _default;

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

@@ -242,10 +242,10 @@ declare const _default: import("vue").DefineComponent<{
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    currencyCodeDefinedValueGuid: string;
     campusTypeFilter: string | string[];
     campusStatusFilter: string | string[];
     campusGuid: string | null;
-    currencyCodeDefinedValueGuid: string;
     accountAmountEntryMode: "singleAccount" | "multipleAccounts";
     disableAccountCampusMappingLogic: boolean;
     accountHeaderTemplate: string;

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

@@ -8,9 +8,14 @@ declare const _default: import("vue").DefineComponent<{
     minimumValue: {
         type: PropType<number | null>;
     };
+    /** The maximum allowed value to be entered. */
     maximumValue: {
         type: PropType<number | null>;
     };
+    currencyCodeDefinedValueGuid: {
+        type: PropType<string>;
+        default: string;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: number | null) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -22,12 +27,18 @@ declare const _default: import("vue").DefineComponent<{
     minimumValue: {
         type: PropType<number | null>;
     };
+    /** The maximum allowed value to be entered. */
     maximumValue: {
         type: PropType<number | null>;
     };
+    currencyCodeDefinedValueGuid: {
+        type: PropType<string>;
+        default: string;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: number | null) => any) | undefined;
 }, {
     modelValue: number | null;
+    currencyCodeDefinedValueGuid: string;
 }>;
 export default _default;

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

@@ -1,5 +1,5 @@
 import { PropType } from "vue";
-import { TimeInterval } from "@Obsidian/ViewModels/Utility/timeInterval";
+import { TimeIntervalBag } from "@Obsidian/ViewModels/Utility/timeIntervalBag";
 import { BtnType } from "@Obsidian/Enums/Controls/btnType";
 import { LiteralUnion } from "@Obsidian/Types/Utility/support";
 declare const _default: import("vue").DefineComponent<{
@@ -25,7 +25,7 @@ declare const _default: import("vue").DefineComponent<{
         default: false;
     };
     modelValue: {
-        type: PropType<TimeInterval | null>;
+        type: PropType<TimeIntervalBag | null>;
         required: true;
     };
     unselectedBtnType: {
@@ -37,7 +37,7 @@ declare const _default: import("vue").DefineComponent<{
         default: "primary";
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    "update:modelValue": (_value: TimeInterval) => void;
+    "update:modelValue": (_value: TimeIntervalBag) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     label: {
         type: PropType<string>;
@@ -61,7 +61,7 @@ declare const _default: import("vue").DefineComponent<{
         default: false;
     };
     modelValue: {
-        type: PropType<TimeInterval | null>;
+        type: PropType<TimeIntervalBag | null>;
         required: true;
     };
     unselectedBtnType: {
@@ -73,7 +73,7 @@ declare const _default: import("vue").DefineComponent<{
         default: "primary";
     };
 }>> & {
-    "onUpdate:modelValue"?: ((_value: TimeInterval) => any) | undefined;
+    "onUpdate:modelValue"?: ((_value: TimeIntervalBag) => any) | undefined;
 }, {
     label: string;
     help: string;

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

@@ -1,7 +1,29 @@
 import { PropType } from "vue";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { KeyValueItem } from "@Obsidian/Types/Controls/keyValueItem";
+import type { ValidationRule } from "@Obsidian/Types/validationRules";
 declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: PropType<string>;
+        default: "";
+    };
+    help: {
+        type: PropType<string>;
+        default: "";
+    };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: PropType<string>;
+        default: "";
+    };
+    validationTitle: {
+        type: PropType<string>;
+        default: "";
+    };
+    isRequiredIndicatorHidden: {
+        type: PropType<boolean>;
+        default: false;
+    };
     modelValue: {
         type: PropType<KeyValueItem[]>;
         required: false;
@@ -26,9 +48,34 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    allowHtml: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: KeyValueItem[]) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: PropType<string>;
+        default: "";
+    };
+    help: {
+        type: PropType<string>;
+        default: "";
+    };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: PropType<string>;
+        default: "";
+    };
+    validationTitle: {
+        type: PropType<string>;
+        default: "";
+    };
+    isRequiredIndicatorHidden: {
+        type: PropType<boolean>;
+        default: false;
+    };
     modelValue: {
         type: PropType<KeyValueItem[]>;
         required: false;
@@ -53,10 +100,21 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    allowHtml: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: KeyValueItem[]) => any) | undefined;
 }, {
+    label: string;
+    help: string;
+    rules: ValidationRule | ValidationRule[];
+    formGroupClasses: string;
+    validationTitle: string;
+    isRequiredIndicatorHidden: boolean;
     fullWidth: boolean;
+    allowHtml: boolean;
     displayValueFirst: boolean;
 }>;
 export default _default;

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

@@ -1,6 +1,23 @@
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { PropType } from "vue";
+import { PickerDisplayStyle } from "@Obsidian/Enums/Controls/pickerDisplayStyle";
 declare const _default: import("vue").DefineComponent<{
+    /**
+     * The following come with the standardAsyncPickerProps, but their
+     * defaults need to be changed to match how this picker is typically used.
+     **/
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    displayStyle: {
+        type: PropType<PickerDisplayStyle>;
+        default: "list";
+    };
+    columnCount: {
+        type: NumberConstructor;
+        default: number;
+    };
     label: {
         type: PropType<string>;
         default: "";
@@ -30,10 +47,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };
-    multiple: {
-        type: PropType<boolean>;
-        default: false;
-    };
     showBlankItem: {
         type: PropType<boolean>;
         default: false;
@@ -42,14 +55,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         default: "";
     };
-    displayStyle: {
-        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
-        default: "auto";
-    };
-    columnCount: {
-        type: PropType<number>;
-        default: 0;
-    };
     modelValue: {
         type: PropType<ListItemBag | ListItemBag[] | null>;
         required: false;
@@ -57,6 +62,22 @@ declare const _default: import("vue").DefineComponent<{
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: ListItemBag | ListItemBag[] | null) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The following come with the standardAsyncPickerProps, but their
+     * defaults need to be changed to match how this picker is typically used.
+     **/
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    displayStyle: {
+        type: PropType<PickerDisplayStyle>;
+        default: "list";
+    };
+    columnCount: {
+        type: NumberConstructor;
+        default: number;
+    };
     label: {
         type: PropType<string>;
         default: "";
@@ -86,10 +107,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };
-    multiple: {
-        type: PropType<boolean>;
-        default: false;
-    };
     showBlankItem: {
         type: PropType<boolean>;
         default: false;
@@ -98,14 +115,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         default: "";
     };
-    displayStyle: {
-        type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
-        default: "auto";
-    };
-    columnCount: {
-        type: PropType<number>;
-        default: 0;
-    };
     modelValue: {
         type: PropType<ListItemBag | ListItemBag[] | null>;
         required: false;
@@ -125,6 +134,6 @@ declare const _default: import("vue").DefineComponent<{
     lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
-    displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    displayStyle: PickerDisplayStyle;
 }>;
 export default _default;

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

@@ -1,29 +1,85 @@
+import type { ValidationRule } from "@Obsidian/Types/validationRules";
 declare const _default: import("vue").DefineComponent<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
+    help: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
+    validationTitle: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
+    isRequiredIndicatorHidden: {
+        type: import("vue").PropType<boolean>;
+        default: false;
+    };
     modelValue: {
         type: StringConstructor;
-        required: false;
         default: string;
     };
     valuePrompt: {
         type: StringConstructor;
         default: string;
     };
+    allowHtml: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: string) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
+    help: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
+    rules: import("@Obsidian/ValidationRules").RulesPropType;
+    formGroupClasses: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
+    validationTitle: {
+        type: import("vue").PropType<string>;
+        default: "";
+    };
+    isRequiredIndicatorHidden: {
+        type: import("vue").PropType<boolean>;
+        default: false;
+    };
     modelValue: {
         type: StringConstructor;
-        required: false;
         default: string;
     };
     valuePrompt: {
         type: StringConstructor;
         default: string;
     };
+    allowHtml: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }, {
+    label: string;
+    help: string;
+    rules: ValidationRule | ValidationRule[];
+    formGroupClasses: string;
+    validationTitle: string;
+    isRequiredIndicatorHidden: boolean;
     modelValue: string;
+    allowHtml: boolean;
     valuePrompt: string;
 }>;
 export default _default;