@rockrms/obsidian-framework 17.0.43 → 17.1.5

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

@@ -141,18 +141,18 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
     registrationTemplateGuid: string | null;
 }, {}>;
 export default _default;

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

@@ -142,17 +142,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: PickerDisplayStyle;
+    columnCount: number;
 }, {}>;
 export default _default;

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

@@ -123,17 +123,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
 }, {}>;
 export default _default;

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

@@ -12,7 +12,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: string;
     };
     type: {
-        type: PropType<"button" | "reset" | "submit">;
+        type: PropType<"button" | "submit" | "reset">;
         default: string;
     };
     disabled: {
@@ -56,6 +56,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
+    disableLoadingIndicator: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }, {}, 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>;
@@ -66,7 +70,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: string;
     };
     type: {
-        type: PropType<"button" | "reset" | "submit">;
+        type: PropType<"button" | "submit" | "reset">;
         default: string;
     };
     disabled: {
@@ -110,17 +114,22 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
+    disableLoadingIndicator: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
 }>>, {
-    type: "button" | "reset" | "submit";
-    disabled: boolean;
+    type: "button" | "submit" | "reset";
     isLoading: boolean;
     loadingText: string;
+    disabled: boolean;
     btnType: LiteralUnion<BtnType>;
     btnSize: BtnSize;
     autoLoading: boolean;
     autoDisable: boolean;
     isSquare: boolean;
     shortcutKey: string;
+    disableLoadingIndicator: boolean;
 }, {}>, {
     loading?(_: {}): any;
     default?(_: {}): any;

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

@@ -34,6 +34,17 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    /**
+     * If `true` then the field will be marked as required even if the
+     * attribute is not. If `false` then the field will not be required
+     * even if the attribute wants to be. If the default of `undefined` then
+     * the value from the attribute will be used.
+     */
+    requiredOverride: {
+        type: PropType<boolean>;
+        default: undefined;
+        required: false;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: string) => void;
     updateConfigurationValue: (key: string, value: string) => void;
@@ -70,6 +81,17 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    /**
+     * If `true` then the field will be marked as required even if the
+     * attribute is not. If `false` then the field will not be required
+     * even if the attribute wants to be. If the default of `undefined` then
+     * the value from the attribute will be used.
+     */
+    requiredOverride: {
+        type: PropType<boolean>;
+        default: undefined;
+        required: false;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
     onUpdateConfigurationValue?: ((key: string, value: string) => any) | undefined;
@@ -80,5 +102,6 @@ declare const _default: import("vue").DefineComponent<{
     isCondensed: boolean;
     dataEntryMode: DataEntryMode;
     isEscaped: boolean;
+    requiredOverride: boolean;
 }, {}>;
 export default _default;

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

@@ -1,5 +1,10 @@
 import { PropType } from "vue";
 import { FormError } from "@Obsidian/Utility/form";
+/**
+ * Submits the form and waits until both validation and the onSubmit
+ * callback have completed before returning.
+ */
+declare function submitForm(): Promise<void>;
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     /** True if the form should attempt to submit. */
     submit: {
@@ -24,7 +29,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<() => void | PromiseLike<void>>;
         required: false;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}, {
+    submitForm: typeof submitForm;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     validationChanged: (errors: FormError[]) => void;
     visibleValidationChanged: (errors: FormError[]) => void;
     "update:submit": (value: boolean) => void;

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

@@ -107,11 +107,11 @@ declare const _default: import("vue").DefineComponent<{
 }>>, {
     label: string;
     help: string;
+    watchDeep: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    watchDeep: boolean;
 }, {}>;
 export default _default;

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

@@ -22,8 +22,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: number;
     };
 }>> & {
-    onLoaded?: (() => any) | undefined;
     onTimeout?: (() => any) | undefined;
+    onLoaded?: (() => any) | undefined;
     onReady?: (() => any) | undefined;
 }, {
     delay: number;

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

@@ -38,9 +38,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }>> & {
     "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
 }, {
-    description: string;
     title: string;
     modelValue: boolean;
+    description: string;
     toggleText: string;
 }, {}>, {
     actions?(_: {}): any;

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

@@ -26,8 +26,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: boolean;
     };
 }>>, {
-    description: string;
     title: string;
+    description: string;
     isSeparatorHidden: boolean;
 }, {}>, {
     actions?(_: {}): any;

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

@@ -209,9 +209,8 @@ declare const _default: import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }, {
     label: string;
-    help: string;
-    toolbar: ToolbarConfig;
     disabled: boolean;
+    help: string;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
@@ -219,6 +218,7 @@ declare const _default: import("vue").DefineComponent<{
     isRequiredIndicatorHidden: boolean;
     editorHeight: number;
     startInCodeEditorMode: boolean;
+    toolbar: ToolbarConfig;
     countDownMaxChars: number;
     isCharacterCountShown: boolean;
     isCountDownShown: boolean;

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

@@ -17,7 +17,7 @@ declare const _default: import("vue").DefineComponent<{
 }>> & {
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }, {
-    rules: ValidationRule | ValidationRule[];
     modelValue: string;
+    rules: ValidationRule | ValidationRule[];
 }, {}>;
 export default _default;

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

@@ -123,17 +123,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
 }, {}>;
 export default _default;

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

@@ -137,18 +137,18 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
     stepProgramGuid: string | null;
 }, {}>;
 export default _default;

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

@@ -131,18 +131,18 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
     stepProgramGuid: string | null;
 }, {}>;
 export default _default;

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

@@ -123,17 +123,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
 }, {}>;
 export default _default;

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

@@ -90,14 +90,14 @@ declare const _default: import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }, {
     label: string;
-    help: string;
     disabled: boolean;
+    help: string;
+    modelValue: string;
     disableLabel: boolean;
     rules: ValidationRule | ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    modelValue: string;
     toolsGuid: string | null;
 }, {}>;
 export default _default;

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

@@ -193,9 +193,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }, {
     type: string;
     label: string;
-    size: "small" | "medium" | "large";
-    help: string;
     placeholder: string;
+    help: string;
     disableLabel: boolean;
     rules: ValidationRule | ValidationRule[];
     formGroupClasses: string;
@@ -209,6 +208,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     inputGroupClasses: string;
     rows: number;
     textMode: string;
+    size: "small" | "medium" | "large";
     allowHtml: boolean;
     isClearable: boolean;
     canExceedMaxLength: boolean;

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

@@ -75,13 +75,13 @@ declare const _default: import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((_value: TimePickerValue) => any) | undefined;
 }, {
     label: string;
-    help: string;
     disabled: boolean;
+    help: string;
+    modelValue: TimePickerValue;
     disableLabel: boolean;
     rules: ValidationRule | ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    modelValue: TimePickerValue;
 }, {}>;
 export default _default;

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

@@ -123,14 +123,14 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     "onUpdate:showPopup"?: ((_value: boolean) => any) | undefined;
     onValueSelected?: (() => any) | undefined;
 }, {
-    multiple: boolean;
-    blankValue: string;
     showPopup: boolean;
     iconCssClass: string;
     fullWidth: boolean;
+    multiple: boolean;
     disableFolderSelection: boolean;
     autoExpand: boolean;
     showChildCount: boolean;
+    blankValue: string;
 }, {}>, {
     pickerContentSuperHeader?(_: {}): any;
     pickerContentHeader?(_: {}): any;

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

@@ -126,8 +126,8 @@ declare const _default: import("vue").DefineComponent<{
     "onTreeitem-collapsed"?: ((value: TreeItemBag) => any) | undefined;
     "onUpdate:items"?: ((value: TreeItemBag[]) => any) | undefined;
 }, {
-    multiple: boolean;
     modelValue: string[];
+    multiple: boolean;
     disableFolderSelection: boolean;
     initiallyExpanded: string[];
     autoExpand: boolean;

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

@@ -95,12 +95,12 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
+    modelValue: Partial<CompoundFilterExpression>;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    modelValue: Partial<CompoundFilterExpression>;
     comparisonTypes: ComparisonItem[];
     hideFilterMode: boolean;
 }, {}>;

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

@@ -214,19 +214,19 @@ declare const _default: import("vue").DefineComponent<{
     onBeginDraw?: (() => any) | undefined;
     onEndDraw?: (() => any) | undefined;
 }, {
-    animationDuration: number;
-    height: string | number;
     width: string | number;
+    height: string | number;
     words: string[];
-    colors: string[];
     angleCount: number;
     minimumAngle: number;
     maximumAngle: number;
     fontName: string;
     minimumFontSize: number;
     maximumFontSize: number;
+    colors: string[];
     wordPadding: number;
     autoClear: boolean;
+    animationDuration: number;
     minimumUpdateInterval: number;
 }, {}>;
 export default _default;

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

@@ -137,18 +137,18 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
     workflowTypeGuid: string | null;
 }, {}>;
 export default _default;

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

@@ -90,14 +90,14 @@ declare const _default: import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((_value: ListItemBag | ListItemBag[] | null) => any) | undefined;
 }, {
     label: string;
-    help: string;
-    multiple: boolean;
     disabled: boolean;
+    help: string;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     includeInactiveItems: boolean;
 }, {}>;
 export default _default;

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

@@ -73,13 +73,13 @@ declare const _default: import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((val: string) => any) | undefined;
 }, {
     label: string;
-    help: string;
     disabled: boolean;
+    help: string;
+    modelValue: string | null;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    modelValue: string | null;
 }, {}>;
 export default _default;

package/types/Core/Reporting/fieldFilter.d.ts

@@ -1,3 +1,4 @@
+import { FieldFilterAttributeData } from "@Obsidian/Types/Reporting/fieldFilterAttributeData";
 import { FieldFilterGroupBag } from "@Obsidian/ViewModels/Reporting/fieldFilterGroupBag";
 import { FieldFilterRuleBag } from "@Obsidian/ViewModels/Reporting/fieldFilterRuleBag";
 import { FieldFilterSourceBag } from "@Obsidian/ViewModels/Reporting/fieldFilterSourceBag";
@@ -20,3 +21,86 @@ export declare function getFilterGroupTitleHtml(group: FieldFilterGroupBag): str
  * @returns A plain text string that represents the rule in a human friendly format.
  */
 export declare function getFilterRuleDescription(rule: FieldFilterRuleBag, sources: FieldFilterSourceBag[]): string;
+/**
+ * Provides filtering logic for {@link FieldFilterGroupBag} objects. This can
+ * either perform a one-time check against a single instance or build a
+ * function that can be used repeatedly against different objects.
+ */
+export declare class FieldFilterFunctionBuilder<T = unknown> {
+    /**
+     * Checks if the object matches the rule(s) provided by the filter.
+     *
+     * @param instance The object to be checked to determine if it matches the filter.
+     * @param filter The rule(s) that describe the filter conditions.
+     *
+     * @returns `true` if the object matched the rules; otherwise `false`.
+     */
+    isMatch(instance: T, filter: FieldFilterGroupBag): boolean;
+    /**
+     * Gets a reusable function that can be called on various objects to determine
+     * if they match the provided filter.
+     *
+     * @param filter The rule(s) that describe the filter conditions.
+     *
+     * @returns A function that can be called to determine if an object matches the filter.
+     */
+    getIsMatchFunction(filter: FieldFilterGroupBag): (instance: T) => boolean;
+    /**
+     * Determines if the object matches the filter rule group.
+     *
+     * @param instance The object to be checked to determine if it matches the filter.
+     * @param filter The rule(s) that describe the filter conditions.
+     *
+     * @returns `true` if the object matched the rules; otherwise `false`.
+     */
+    protected isGroupMatch(instance: T, filter: FieldFilterGroupBag): boolean;
+    /**
+     * Determines if the object matches a single filter rule.
+     *
+     * @param instance The object to be checked to determine if it matches the filter.
+     * @param rule The single rule that describes the filter condition.
+     *
+     * @returns `true` if the object matched the rule; otherwise `false`.
+     */
+    protected isRuleMatch(instance: T, rule: FieldFilterRuleBag): boolean;
+    /**
+     * Determines if the object matches a single property rule.
+     *
+     * @param instance The object to be checked to determine if it matches the filter.
+     * @param rule The single rule that describes the filter condition.
+     *
+     * @returns `true` if the object matched the rule; otherwise `false`.
+     */
+    protected isRulePropertyMatch(instance: T, rule: FieldFilterRuleBag): boolean;
+    /**
+     * Determines if the object matches a single attribute rule.
+     *
+     * @param instance The object to be checked to determine if it matches the filter.
+     * @param rule The single rule that describes the filter condition.
+     *
+     * @returns `true` if the object matched the rule; otherwise `false`.
+     */
+    protected isRuleAttributeMatch(instance: T, rule: FieldFilterRuleBag): boolean;
+    /**
+     * Gets the required data which describes the attribute. This is used to
+     * load the field type and provide the configuration values when calling
+     * the compare function on the field.
+     *
+     * @param instance The object to be checked to determine if it matches the filter.
+     * @param rule The single rule that describes the filter condition.
+     *
+     * @returns An object that describes the attribute details or `undefined` if
+     * the attribute could not be found.
+     */
+    protected getInstanceAttributeData(instance: T, rule: FieldFilterRuleBag): FieldFilterAttributeData | undefined;
+    /**
+     * Gets the current value of the attribute on the object. The value must
+     * be in public edit format in order for the filter to work correctly.
+     *
+     * @param instance The object to be checked to determine if it matches the filter.
+     * @param rule The single rule that describes the filter condition.
+     *
+     * @returns A string that represents the current edit value.
+     */
+    protected getInstanceAttributeValue(instance: T, rule: FieldFilterRuleBag): string | undefined;
+}

package/types/Enums/Blocks/Communication/CommunicationEntryWizard/pushOpenAction.d.ts

@@ -1,4 +1,4 @@
-/** The Push Open Action used by the Communication Entry block. */
+/** The Push Open Action used by the Communication Entry Wizard block. */
 export declare const PushOpenAction: {
     /** No action */
     readonly NoAction: 0;
@@ -9,7 +9,7 @@ export declare const PushOpenAction: {
     /** Link to URL */
     readonly LinkToUrl: 3;
 };
-/** The Push Open Action used by the Communication Entry block. */
+/** The Push Open Action used by the Communication Entry Wizard block. */
 export declare const PushOpenActionDescription: Record<number, string>;
-/** The Push Open Action used by the Communication Entry block. */
+/** The Push Open Action used by the Communication Entry Wizard block. */
 export type PushOpenAction = typeof PushOpenAction[keyof typeof PushOpenAction];

package/types/Enums/Blocks/Communication/CommunicationTemplateDetail/pushOpenAction.d.ts

@@ -0,0 +1,15 @@
+/** The Push Open Action used by the Template Detail block. */
+export declare const PushOpenAction: {
+    /** No action */
+    readonly NoAction: 0;
+    /** Show details */
+    readonly ShowDetails: 1;
+    /** Link to mobile page */
+    readonly LinkToMobilePage: 2;
+    /** Link to URL */
+    readonly LinkToUrl: 3;
+};
+/** The Push Open Action used by the Template Detail block. */
+export declare const PushOpenActionDescription: Record<number, string>;
+/** The Push Open Action used by the Template Detail block. */
+export type PushOpenAction = typeof PushOpenAction[keyof typeof PushOpenAction];