@rockrms/obsidian-framework 17.6.1 → 18.1.0

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

@@ -0,0 +1,66 @@
+import { PropType } from "vue";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    /** The title to display in the slicer bar. */
+    title: {
+        type: PropType<string>;
+        required: true;
+    };
+    /** Whether to show the campus context picker. */
+    showCampus: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Campus type defined value guids that limit which campuses are
+     * included in the list of campus options.
+     */
+    campusTypeFilter: {
+        type: PropType<string | string[] | undefined>;
+        required: false;
+    };
+    /**
+     * Campus status defined value guids that limit which campuses are
+     * included in the list of campus options.
+     */
+    campusStatusFilter: {
+        type: PropType<string | string[] | undefined>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The title to display in the slicer bar. */
+    title: {
+        type: PropType<string>;
+        required: true;
+    };
+    /** Whether to show the campus context picker. */
+    showCampus: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * Campus type defined value guids that limit which campuses are
+     * included in the list of campus options.
+     */
+    campusTypeFilter: {
+        type: PropType<string | string[] | undefined>;
+        required: false;
+    };
+    /**
+     * Campus status defined value guids that limit which campuses are
+     * included in the list of campus options.
+     */
+    campusStatusFilter: {
+        type: PropType<string | string[] | undefined>;
+        required: false;
+    };
+}>>, {
+    showCampus: boolean;
+}, {}>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -1,5 +1,6 @@
 import { PropType } from "vue";
-declare const _default: import("vue").DefineComponent<{
+import { BtnSize } from "@Obsidian/Enums/Controls/btnSize";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     value: {
         type: PropType<string>;
         required: true;
@@ -17,6 +18,12 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<"auto" | "left" | "top" | "right" | "bottom">;
         default: string;
     };
+    isSquare: {
+        type: PropType<boolean | null | undefined>;
+    };
+    btnSize: {
+        type: PropType<BtnSize | undefined>;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     value: {
         type: PropType<string>;
@@ -35,8 +42,21 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<"auto" | "left" | "top" | "right" | "bottom">;
         default: string;
     };
+    isSquare: {
+        type: PropType<boolean | null | undefined>;
+    };
+    btnSize: {
+        type: PropType<BtnSize | undefined>;
+    };
 }>>, {
     tooltip: string;
     tooltipPlacement: "auto" | "left" | "top" | "right" | "bottom";
-}, {}>;
+}, {}>, {
+    default?(_: {}): any;
+}>;
 export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -10,6 +10,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     help: {
         type: PropType<string>;
+        /** Whether to parse the entered value and reformat it to match the set format. NOT Reactive */
         default: "";
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;
@@ -97,6 +98,7 @@ declare const _default: import("vue").DefineComponent<{
     };
     help: {
         type: PropType<string>;
+        /** Whether to parse the entered value and reformat it to match the set format. NOT Reactive */
         default: "";
     };
     rules: import("@Obsidian/ValidationRules").RulesPropType;

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

@@ -0,0 +1,127 @@
+import { PropType } from "vue";
+import { MenuAction } from "@Obsidian/Types/Controls/dropDownMenu";
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+    aside: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    asideIconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    badgeText: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    iconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    iconLabelType: {
+        type: PropType<string | Omit<"default" | "type" | "primary" | "danger" | "warning" | "success" | "info" | "campus" | "custom", "custom">>;
+        default: "info";
+    };
+    iconTitleAndDescMinWidth: {
+        type: PropType<string>;
+        required: false;
+        default: "150px";
+    };
+    description: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    minWidth: {
+        type: PropType<string>;
+        required: false;
+        default: "440px";
+    };
+    primaryActions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    secondaryActions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    title: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /**
+     * Optional click handler that will be called when the main item
+     * is clicked.
+     */
+    onClick: {
+        type: PropType<() => void>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    aside: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    asideIconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    badgeText: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    iconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    iconLabelType: {
+        type: PropType<string | Omit<"default" | "type" | "primary" | "danger" | "warning" | "success" | "info" | "campus" | "custom", "custom">>;
+        default: "info";
+    };
+    iconTitleAndDescMinWidth: {
+        type: PropType<string>;
+        required: false;
+        default: "150px";
+    };
+    description: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    minWidth: {
+        type: PropType<string>;
+        required: false;
+        default: "440px";
+    };
+    primaryActions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    secondaryActions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    title: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /**
+     * Optional click handler that will be called when the main item
+     * is clicked.
+     */
+    onClick: {
+        type: PropType<() => void>;
+        required: false;
+    };
+}>>, {
+    iconLabelType: string | Omit<"default" | "type" | "primary" | "danger" | "warning" | "success" | "info" | "campus" | "custom", "custom">;
+    iconTitleAndDescMinWidth: string;
+    minWidth: string;
+}, {}>, {
+    prepend?(_: {}): any;
+    description?(_: {}): any;
+    actions?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -0,0 +1,24 @@
+import { PropType } from "vue";
+import { MenuAction } from "@Obsidian/Types/Controls/dropDownMenu";
+declare const _default: import("vue").DefineComponent<{
+    actions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    addText: {
+        type: PropType<string>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    actions: {
+        type: PropType<MenuAction[] | null | undefined>;
+        required: false;
+    };
+    addText: {
+        type: PropType<string>;
+        default: string;
+    };
+}>>, {
+    addText: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,23 @@
+import { PropType, VNodeTypes } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    tippableConnectorTargets: {
+        type: PropType<VNodeTypes[] | null | undefined>;
+        required: false;
+    };
+    hasConnectors: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    tippableConnectorTargets: {
+        type: PropType<VNodeTypes[] | null | undefined>;
+        required: false;
+    };
+    hasConnectors: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}>>, {
+    hasConnectors: boolean;
+}, {}>;
+export default _default;

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

@@ -14,6 +14,10 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string[]>;
         default: string[];
     };
+    preventOverflowClipping: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (v: boolean) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -31,12 +35,17 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         type: PropType<string[]>;
         default: string[];
     };
+    preventOverflowClipping: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((v: boolean) => any) | undefined;
 }, {
     modelValue: boolean;
     showArrow: boolean;
     preventCloseOnClickSelectors: string[];
+    preventOverflowClipping: boolean;
 }, {}>, {
     anchor?(_: {}): any;
     default?(_: {}): any;

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

@@ -0,0 +1,70 @@
+import { PropType } from "vue";
+import { DynamicComponentDefinitionBag } from "@Obsidian/ViewModels/Controls/dynamicComponentDefinitionBag";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The value that will be edited by the dynamic component.
+     */
+    modelValue: {
+        type: PropType<Record<string, string>>;
+        required: false;
+    };
+    /**
+     * The dynamic component definition that will be used to load the
+     * component and pass the custom options to it.
+     */
+    definition: {
+        type: PropType<DynamicComponentDefinitionBag>;
+        required: true;
+    };
+    /**
+     * Additional properties that will be passed to the component.
+     */
+    properties: {
+        type: PropType<Record<string, unknown>>;
+        required: false;
+    };
+    /**
+     * The function that will be used to send any requests from the
+     * component to the server.
+     */
+    executeRequest: {
+        type: PropType<(request: Record<string, string>, securityGrantToken: string | null) => Promise<Record<string, string> | null>>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: unknown) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The value that will be edited by the dynamic component.
+     */
+    modelValue: {
+        type: PropType<Record<string, string>>;
+        required: false;
+    };
+    /**
+     * The dynamic component definition that will be used to load the
+     * component and pass the custom options to it.
+     */
+    definition: {
+        type: PropType<DynamicComponentDefinitionBag>;
+        required: true;
+    };
+    /**
+     * Additional properties that will be passed to the component.
+     */
+    properties: {
+        type: PropType<Record<string, unknown>>;
+        required: false;
+    };
+    /**
+     * The function that will be used to send any requests from the
+     * component to the server.
+     */
+    executeRequest: {
+        type: PropType<(request: Record<string, string>, securityGrantToken: string | null) => Promise<Record<string, string> | null>>;
+        required: false;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: unknown) => any) | undefined;
+}, {}, {}>;
+export default _default;

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

@@ -0,0 +1,117 @@
+import { PropType } from "vue";
+type ProgressBar = {
+    /**
+     * The percentage value of the progress bar.
+     *
+     * This should be a number between 0 and 100.
+     */
+    value: number;
+    /**
+     * The opacity of the progress bar (defaults to 100% opacity when nullish).
+     *
+     * This should be a string representing a CSS opacity value (e.g., "0.5", "1").
+     */
+    opacity?: string | null | undefined;
+    /**
+     * The text to display inside the progress bar.
+     */
+    text?: string | null | undefined;
+    /**
+     * The progress bar type, which determines the color and style of the bar (defaults to `props.progressType`).
+     */
+    type?: ProgressBarType;
+};
+type Indicator = {
+    /**
+     * The percentage value of the progress bar where the indicator should appear.
+     *
+     * This should be a number between 0 and 100.
+     */
+    value: number;
+    /**
+     * The indicator type, which determines the color and style of the indicator (defaults to `props.indicatorType`).
+     */
+    type?: ProgressBarType | null | undefined;
+};
+type ProgressBarType = "danger" | "success" | "critical" | "warning" | "info" | "default";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The progress to display in the progress bar.
+     *
+     * These should be percentages (0-100) that indicate the progress of the task.
+     */
+    modelValue: {
+        type: PropType<number | ProgressBar | ProgressBar[] | null | undefined>;
+        required: true;
+    };
+    /**
+     * Optional indicator marks to display along the progress bar.
+     *
+     * These should be percentages (0-100) that represent where the indicators should be placed.
+     */
+    indicators: {
+        type: PropType<(number | Indicator)[] | null | undefined>;
+    };
+    /**
+     * The type of indicator marks to display along the progress bar.
+     */
+    indicatorType: {
+        type: PropType<ProgressBarType>;
+        default: string;
+    };
+    /**
+     * The color for the progress bar.
+     */
+    progressType: {
+        type: PropType<ProgressBarType>;
+        default: string;
+    };
+    /**
+     *  The tooltip for the progress bar (supports HTML)
+     */
+    tooltip: {
+        type: PropType<string | null | undefined>;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The progress to display in the progress bar.
+     *
+     * These should be percentages (0-100) that indicate the progress of the task.
+     */
+    modelValue: {
+        type: PropType<number | ProgressBar | ProgressBar[] | null | undefined>;
+        required: true;
+    };
+    /**
+     * Optional indicator marks to display along the progress bar.
+     *
+     * These should be percentages (0-100) that represent where the indicators should be placed.
+     */
+    indicators: {
+        type: PropType<(number | Indicator)[] | null | undefined>;
+    };
+    /**
+     * The type of indicator marks to display along the progress bar.
+     */
+    indicatorType: {
+        type: PropType<ProgressBarType>;
+        default: string;
+    };
+    /**
+     * The color for the progress bar.
+     */
+    progressType: {
+        type: PropType<ProgressBarType>;
+        default: string;
+    };
+    /**
+     *  The tooltip for the progress bar (supports HTML)
+     */
+    tooltip: {
+        type: PropType<string | null | undefined>;
+    };
+}>>, {
+    indicatorType: ProgressBarType;
+    progressType: ProgressBarType;
+}, {}>;
+export default _default;

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

@@ -28,23 +28,8 @@ declare const _default: import("vue").DefineComponent<{
     };
     enhanceForLongLists: {
         type: PropType<boolean>;
-        /**
-         * Perform additional processing on the items based on our property
-         * settings.
-         *
-         * @param items The items to be processed.
-         *
-         * @returns A new array of items that have been processed.
-         */
         default: false;
-    }; /**
-     * Perform additional processing on the items based on our property
-     * settings.
-     *
-     * @param items The items to be processed.
-     *
-     * @returns A new array of items that have been processed.
-     */
+    };
     lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
@@ -60,9 +45,7 @@ declare const _default: import("vue").DefineComponent<{
     blankValue: {
         type: PropType<string>;
         default: "";
-    }; /**
-     * Loads the items from the server.
-     */
+    };
     displayStyle: {
         type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
         default: "auto";
@@ -113,23 +96,8 @@ declare const _default: import("vue").DefineComponent<{
     };
     enhanceForLongLists: {
         type: PropType<boolean>;
-        /**
-         * Perform additional processing on the items based on our property
-         * settings.
-         *
-         * @param items The items to be processed.
-         *
-         * @returns A new array of items that have been processed.
-         */
         default: false;
-    }; /**
-     * Perform additional processing on the items based on our property
-     * settings.
-     *
-     * @param items The items to be processed.
-     *
-     * @returns A new array of items that have been processed.
-     */
+    };
     lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
@@ -145,9 +113,7 @@ declare const _default: import("vue").DefineComponent<{
     blankValue: {
         type: PropType<string>;
         default: "";
-    }; /**
-     * Loads the items from the server.
-     */
+    };
     displayStyle: {
         type: PropType<import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle>;
         default: "auto";

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

@@ -28,12 +28,11 @@ declare const _default: import("vue").DefineComponent<{
     };
     enhanceForLongLists: {
         type: PropType<boolean>;
-        default: false;
-    };
-    lazyMode: {
-        /**
+        default: false; /**
          * Loads the items from the server.
          */
+    };
+    lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };
@@ -100,12 +99,11 @@ declare const _default: import("vue").DefineComponent<{
     };
     enhanceForLongLists: {
         type: PropType<boolean>;
-        default: false;
-    };
-    lazyMode: {
-        /**
+        default: false; /**
          * Loads the items from the server.
          */
+    };
+    lazyMode: {
         type: PropType<import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode>;
         default: "onDemand";
     };

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

@@ -23,6 +23,10 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     isRequiredIndicatorHidden: {
+        /**
+         * 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.
+         */
         type: PropType<boolean>;
         default: false;
     };
@@ -84,6 +88,10 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
     isRequiredIndicatorHidden: {
+        /**
+         * 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.
+         */
         type: PropType<boolean>;
         default: false;
     };

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

@@ -63,8 +63,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: string;
     };
 }>>, {
-    wrapperClass: string;
     isCollapsed: boolean;
+    wrapperClass: string;
 }, {}>, {
     default?(_: {}): any;
     footer?(_: {}): any;

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

@@ -1,12 +1,19 @@
+import { FilterMode } from "@Obsidian/Enums/Reporting/filterMode";
 import { PropType } from "vue";
 declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     compareLabel: {
         type: PropType<string>;
     };
+    filterMode: {
+        type: PropType<FilterMode>;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     compareLabel: {
         type: PropType<string>;
     };
+    filterMode: {
+        type: PropType<FilterMode>;
+    };
 }>>, {}, {}>, {
     compare?(_: {}): any;
     default?(_: {}): any;