@rockrms/obsidian-framework 17.5.2 → 18.1.0

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

@@ -1,6 +1,7 @@
 import { PropType } from "vue";
 import { FieldFilterRuleBag } from "@Obsidian/ViewModels/Reporting/fieldFilterRuleBag";
 import { FieldFilterSourceBag } from "@Obsidian/ViewModels/Reporting/fieldFilterSourceBag";
+import { FilterMode } from "@Obsidian/Enums/Reporting/filterMode";
 declare const _default: import("vue").DefineComponent<{
     modelValue: {
         type: PropType<FieldFilterRuleBag>;
@@ -20,6 +21,28 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    /** The filter mode to use for the field filter. */
+    filterMode: {
+        type: PropType<FilterMode>;
+        default: 1;
+    };
+    /**
+     * If this row is being used by itself, rather than in a list, it probably doesn't make sense to remove it,
+     * so we can disable the removal button.
+     */
+    disableRemoval: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * In some cases, we don't want to automatically select the first field in the list when we don't have a
+     * current selection. This is useful when we want to allow the rule to be empty and prevents Obsidian from
+     * changing a filter rule inadvertently when it wasn't set in the Webforms version of the filter.
+     */
+    allowBlankFieldSelection: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: FieldFilterRuleBag) => void;
     removeRule: (value: FieldFilterRuleBag) => void;
@@ -42,11 +65,36 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    /** The filter mode to use for the field filter. */
+    filterMode: {
+        type: PropType<FilterMode>;
+        default: 1;
+    };
+    /**
+     * If this row is being used by itself, rather than in a list, it probably doesn't make sense to remove it,
+     * so we can disable the removal button.
+     */
+    disableRemoval: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * In some cases, we don't want to automatically select the first field in the list when we don't have a
+     * current selection. This is useful when we want to allow the rule to be empty and prevents Obsidian from
+     * changing a filter rule inadvertently when it wasn't set in the Webforms version of the filter.
+     */
+    allowBlankFieldSelection: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: FieldFilterRuleBag) => any) | undefined;
     onRemoveRule?: ((value: FieldFilterRuleBag) => any) | undefined;
 }, {
+    filterMode: FilterMode;
     groupSources: boolean;
     enhanceForLongSourceLists: boolean;
+    disableRemoval: boolean;
+    allowBlankFieldSelection: boolean;
 }, {}>;
 export default _default;

package/types/Controls/fieldTypePicker.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/fileUploader.obs.d.ts

@@ -49,6 +49,18 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    isBinaryFile: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    rootFolder: {
+        type: PropType<string>;
+        default: string;
+    };
+    uploadPath: {
+        type: PropType<string>;
+        default: string;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: ListItemBag | undefined) => void;
     error: (value: string) => void;
@@ -101,6 +113,18 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    isBinaryFile: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    rootFolder: {
+        type: PropType<string>;
+        default: string;
+    };
+    uploadPath: {
+        type: PropType<string>;
+        default: string;
+    };
 }>> & {
     onError?: ((value: string) => any) | undefined;
     "onUpdate:modelValue"?: ((value: ListItemBag | undefined) => any) | undefined;
@@ -110,5 +134,8 @@ declare const _default: import("vue").DefineComponent<{
     uploadAsTemporary: boolean;
     uploadButtonText: string;
     showDeleteButton: boolean;
+    isBinaryFile: boolean;
+    rootFolder: string;
+    uploadPath: string;
 }, {}>;
 export default _default;

package/types/Controls/financialStatementTemplatePicker.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/firstNameTextBox.obs.d.ts

@@ -3,7 +3,6 @@ import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 declare const _default: import("vue").DefineComponent<{
     label: {
         type: PropType<string>;
-        /** List of strings that are not allowed to appear in the value. */
         default: "";
     };
     disableLabel: {
@@ -42,7 +41,6 @@ declare const _default: import("vue").DefineComponent<{
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     label: {
         type: PropType<string>;
-        /** List of strings that are not allowed to appear in the value. */
         default: "";
     };
     disableLabel: {

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

@@ -48,7 +48,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     disableLabel: {
         type: PropType<boolean>;
-        default: false;
+        default: false; /**
+         * Geographical Point or Polygon coordinates in Well Known Text format
+         */
     };
     help: {
         type: PropType<string>;
@@ -118,7 +120,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     };
     disableLabel: {
         type: PropType<boolean>;
-        default: false;
+        default: false; /**
+         * Geographical Point or Polygon coordinates in Well Known Text format
+         */
     };
     help: {
         type: PropType<string>;

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

@@ -26,9 +26,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
-    /**
-     * Loads the items from the server.
-     */
     enhanceForLongLists: {
         type: PropType<boolean>;
         default: false;
@@ -97,9 +94,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: false;
     };
-    /**
-     * Loads the items from the server.
-     */
     enhanceForLongLists: {
         type: PropType<boolean>;
         default: false;

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

@@ -26,7 +26,7 @@ declare const _default: import("vue").DefineComponent<{
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
         default: false;
-    };
+    }; /** V-model for the group type so you can get/set it */
     enhanceForLongLists: {
         type: PropType<boolean>;
         default: false;
@@ -49,10 +49,6 @@ declare const _default: import("vue").DefineComponent<{
     };
     displayStyle: {
         type: PropType<PickerDisplayStyle>;
-        /**
-         * 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: "auto";
     };
     columnCount: {
@@ -112,7 +108,7 @@ declare const _default: import("vue").DefineComponent<{
     isRequiredIndicatorHidden: {
         type: PropType<boolean>;
         default: false;
-    };
+    }; /** V-model for the group type so you can get/set it */
     enhanceForLongLists: {
         type: PropType<boolean>;
         default: false;
@@ -135,10 +131,6 @@ declare const _default: import("vue").DefineComponent<{
     };
     displayStyle: {
         type: PropType<PickerDisplayStyle>;
-        /**
-         * 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: "auto";
     };
     columnCount: {

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

@@ -55,7 +55,7 @@ declare const _default: import("vue").DefineComponent<{
         default: 0;
     };
     modelValue: {
-        type: PropType<ListItemBag | null>;
+        type: PropType<ListItemBag | ListItemBag[] | null>;
         required: true;
     };
     excludeGroupRoles: {
@@ -123,7 +123,7 @@ declare const _default: import("vue").DefineComponent<{
         default: 0;
     };
     modelValue: {
-        type: PropType<ListItemBag | null>;
+        type: PropType<ListItemBag | ListItemBag[] | null>;
         required: true;
     };
     excludeGroupRoles: {

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

@@ -51,9 +51,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<PickerDisplayStyle>;
         default: "auto";
     };
-    /**
-     * Loads the group items from the server.
-     */
     columnCount: {
         type: PropType<number>;
         default: 0;
@@ -133,9 +130,6 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<PickerDisplayStyle>;
         default: "auto";
     };
-    /**
-     * Loads the group items from the server.
-     */
     columnCount: {
         type: PropType<number>;
         default: 0;

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

@@ -2,6 +2,7 @@ import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { PropType } from "vue";
 declare const _default: import("vue").DefineComponent<{
     label: {
+        /** The currently selected group type value(s). */
         type: PropType<string>;
         default: "";
     };
@@ -11,12 +12,12 @@ declare const _default: import("vue").DefineComponent<{
     };
     help: {
         type: PropType<string>;
-        default: "";
+        default: ""; /** List of Group Type GUIDs of the Group Types to include in the picker. If null, include all Group Types */
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;
     formGroupClasses: {
         type: PropType<string>;
-        default: ""; /** List of Group Type GUIDs of the Group Types to include in the picker. If null, include all Group Types */
+        default: "";
     };
     validationTitle: {
         type: PropType<string>;
@@ -78,6 +79,7 @@ declare const _default: import("vue").DefineComponent<{
     "update:modelValue": (value: ListItemBag | ListItemBag[] | null) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     label: {
+        /** The currently selected group type value(s). */
         type: PropType<string>;
         default: "";
     };
@@ -87,12 +89,12 @@ declare const _default: import("vue").DefineComponent<{
     };
     help: {
         type: PropType<string>;
-        default: "";
+        default: ""; /** List of Group Type GUIDs of the Group Types to include in the picker. If null, include all Group Types */
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;
     formGroupClasses: {
         type: PropType<string>;
-        default: ""; /** List of Group Type GUIDs of the Group Types to include in the picker. If null, include all Group Types */
+        default: "";
     };
     validationTitle: {
         type: PropType<string>;

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

@@ -0,0 +1,16 @@
+import { PropType } from "vue";
+import { LiteralUnion } from "@Obsidian/Types/Utility/support";
+declare const _default: import("vue").DefineComponent<{
+    hintType: {
+        type: PropType<LiteralUnion<"ai">>;
+        default: "ai";
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    hintType: {
+        type: PropType<LiteralUnion<"ai">>;
+        default: "ai";
+    };
+}>>, {
+    hintType: LiteralUnion<"ai">;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,91 @@
+import { type PropType } from "vue";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    modelValue: {
+        type: PropType<string>;
+        default: string;
+    };
+    label: {
+        type: PropType<string>;
+        default: "";
+    };
+    disableLabel: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    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;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: string | null) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: PropType<string>;
+        default: string;
+    };
+    label: {
+        type: PropType<string>;
+        default: "";
+    };
+    disableLabel: {
+        type: PropType<boolean>;
+        default: false;
+    };
+    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;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: string | null) => any) | undefined;
+}, {
+    label: string;
+    help: string;
+    modelValue: string;
+    disableLabel: boolean;
+    rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
+    formGroupClasses: string;
+    validationTitle: string;
+    isRequiredIndicatorHidden: boolean;
+}, {}>, {
+    prepend?(_: {
+        isInputGroupSupported: boolean;
+    }): any;
+    inputGroupPrepend?(_: {
+        isInputGroupSupported: boolean;
+    }): any;
+    append?(_: {
+        isInputGroupSupported: boolean;
+    }): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -163,8 +163,8 @@ declare const _default: import("vue").DefineComponent<{
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    binaryFileTypeGuid: string;
     aspectRatio: number;
+    binaryFileTypeGuid: string;
     maxImageHeight: number;
     maxImageWidth: number;
     noPictureUrl: string;

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

@@ -8,6 +8,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         required: true;
     };
+    help: {
+        type: PropType<string>;
+        default: string;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: boolean) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -19,7 +23,13 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         required: true;
     };
+    help: {
+        type: PropType<string>;
+        default: string;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
-}, {}, {}>;
+}, {
+    help: string;
+}, {}>;
 export default _default;

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

@@ -20,6 +20,10 @@ 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: "";
     };
     isRequiredIndicatorHidden: {
@@ -80,6 +84,10 @@ 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: "";
     };
     isRequiredIndicatorHidden: {

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

@@ -1,5 +1,5 @@
 import { PropType } from "vue";
-declare const _default: import("vue").DefineComponent<{
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     /**
      * The value to display. If this is a number type then it will be
      * formatted with group separators, such as "," in the US.
@@ -25,7 +25,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     /** The base color to use for the text and border. */
     color: {
-        type: PropType<"blue" | "gray" | "green" | "indigo" | "orange" | "pink" | "purple" | "red" | "teal" | "yellow">;
+        type: PropType<"red" | "green" | "blue" | "gray" | "indigo" | "orange" | "pink" | "purple" | "teal" | "yellow">;
         default: string;
     };
     /** The shade of the color to use for the text and border. */
@@ -64,7 +64,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     /** The base color to use for the text and border. */
     color: {
-        type: PropType<"blue" | "gray" | "green" | "indigo" | "orange" | "pink" | "purple" | "red" | "teal" | "yellow">;
+        type: PropType<"red" | "green" | "blue" | "gray" | "indigo" | "orange" | "pink" | "purple" | "teal" | "yellow">;
         default: string;
     };
     /** The shade of the color to use for the text and border. */
@@ -78,8 +78,15 @@ declare const _default: import("vue").DefineComponent<{
         default: boolean;
     };
 }>>, {
-    color: "blue" | "gray" | "green" | "indigo" | "orange" | "pink" | "purple" | "red" | "teal" | "yellow";
+    color: "red" | "green" | "blue" | "gray" | "indigo" | "orange" | "pink" | "purple" | "teal" | "yellow";
     colorShade: 100 | 200 | 400 | 500 | 300 | 600 | 700 | 800 | 900;
     isCard: boolean;
-}, {}>;
+}, {}>, {
+    secondaryLabel?(_: {}): any;
+}>;
 export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -23,6 +23,10 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     disableLabel: {
+        /**
+         * The following come with the standardAsyncPickerProps, but their
+         * defaults need to be changed to match how this picker is typically used.
+         **/
         type: PropType<boolean>;
         default: false;
     };
@@ -44,7 +48,12 @@ declare const _default: import("vue").DefineComponent<{
         default: false;
     };
     enhanceForLongLists: {
-        type: PropType<boolean>;
+        /**
+         * Loads the items from the server.
+         */
+        type: PropType<boolean>; /**
+         * Loads the items from the server.
+         */
         default: false;
     };
     lazyMode: {
@@ -87,6 +96,10 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     disableLabel: {
+        /**
+         * The following come with the standardAsyncPickerProps, but their
+         * defaults need to be changed to match how this picker is typically used.
+         **/
         type: PropType<boolean>;
         default: false;
     };
@@ -108,7 +121,12 @@ declare const _default: import("vue").DefineComponent<{
         default: false;
     };
     enhanceForLongLists: {
-        type: PropType<boolean>;
+        /**
+         * Loads the items from the server.
+         */
+        type: PropType<boolean>; /**
+         * Loads the items from the server.
+         */
         default: false;
     };
     lazyMode: {