@rockrms/obsidian-framework 1.16.3-rc.1

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

@@ -0,0 +1,34 @@
+import { GridAction, IGridState } from "@Obsidian/Types/Controls/grid";
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    /** The state object for the entire grid. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+    /** The array of grid actions that will be displayed. */
+    gridActions: {
+        type: PropType<(GridAction & {
+            isPrimary?: boolean | undefined;
+        })[]>;
+        default: never[];
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The state object for the entire grid. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+    /** The array of grid actions that will be displayed. */
+    gridActions: {
+        type: PropType<(GridAction & {
+            isPrimary?: boolean | undefined;
+        })[]>;
+        default: never[];
+    };
+}>>, {
+    gridActions: (GridAction & {
+        isPrimary?: boolean | undefined;
+    })[];
+}>;
+export default _default;

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

@@ -0,0 +1,31 @@
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    /** The currently selected/visible page number. */
+    modelValue: {
+        type: PropType<number>;
+        required: true;
+    };
+    /** The total number of pages that are available to pick from. */
+    pageCount: {
+        type: PropType<number>;
+        default: number;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: number) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The currently selected/visible page number. */
+    modelValue: {
+        type: PropType<number>;
+        required: true;
+    };
+    /** The total number of pages that are available to pick from. */
+    pageCount: {
+        type: PropType<number>;
+        default: number;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: number) => any) | undefined;
+}, {
+    pageCount: number;
+}>;
+export default _default;

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

@@ -0,0 +1,41 @@
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The currently selected page size value. This is the number of
+     * rows to display per page.
+     */
+    modelValue: {
+        type: PropType<number>;
+        required: true;
+    };
+    /**
+     * The list of available page sizes that the individual can pick from.
+     */
+    pageSizes: {
+        type: PropType<number[]>;
+        default: never[];
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: number) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The currently selected page size value. This is the number of
+     * rows to display per page.
+     */
+    modelValue: {
+        type: PropType<number>;
+        required: true;
+    };
+    /**
+     * The list of available page sizes that the individual can pick from.
+     */
+    pageSizes: {
+        type: PropType<number[]>;
+        default: never[];
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: number) => any) | undefined;
+}, {
+    pageSizes: number[];
+}>;
+export default _default;

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

@@ -0,0 +1,73 @@
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    /** The number of items to display per page. */
+    pageSize: {
+        type: PropType<number>;
+        required: true;
+    };
+    /** The available page sizes that can be selected by the individual. */
+    pageSizes: {
+        type: PropType<number[]>;
+        default: never[];
+    };
+    /** The currently selected page number to display in the grid. */
+    currentPage: {
+        type: PropType<number>;
+        default: number;
+    };
+    /** The total number of pages available to be viewed. */
+    pageCount: {
+        type: PropType<number>;
+        default: number;
+    };
+    /**
+     * The number of visible columns. This is used as the colspan attribute
+     * so that the footer looks like a single column across the entire
+     * width of the grid. */
+    visibleColumnCount: {
+        type: PropType<number>;
+        default: number;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:pageSize": (value: number) => void;
+} & {
+    "update:currentPage": (value: number) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The number of items to display per page. */
+    pageSize: {
+        type: PropType<number>;
+        required: true;
+    };
+    /** The available page sizes that can be selected by the individual. */
+    pageSizes: {
+        type: PropType<number[]>;
+        default: never[];
+    };
+    /** The currently selected page number to display in the grid. */
+    currentPage: {
+        type: PropType<number>;
+        default: number;
+    };
+    /** The total number of pages available to be viewed. */
+    pageCount: {
+        type: PropType<number>;
+        default: number;
+    };
+    /**
+     * The number of visible columns. This is used as the colspan attribute
+     * so that the footer looks like a single column across the entire
+     * width of the grid. */
+    visibleColumnCount: {
+        type: PropType<number>;
+        default: number;
+    };
+}>> & {
+    "onUpdate:pageSize"?: ((value: number) => any) | undefined;
+    "onUpdate:currentPage"?: ((value: number) => any) | undefined;
+}, {
+    visibleColumnCount: number;
+    pageCount: number;
+    pageSizes: number[];
+    currentPage: number;
+}>;
+export default _default;

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

@@ -0,0 +1,34 @@
+import { GridAction, IGridState } from "@Obsidian/Types/Controls/grid";
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    /** The grid action to be represented by this button. */
+    action: {
+        type: PropType<GridAction>;
+        required: true;
+    };
+    /**
+     * The grid state that this action belongs to.
+     */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: () => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The grid action to be represented by this button. */
+    action: {
+        type: PropType<GridAction>;
+        required: true;
+    };
+    /**
+     * The grid state that this action belongs to.
+     */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+}>> & {
+    onClick?: (() => any) | undefined;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,28 @@
+import { GridAction, IGridState } from "@Obsidian/Types/Controls/grid";
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    gridActions: {
+        type: PropType<GridAction[]>;
+        required: true;
+    };
+    /**
+     * The grid state that this action belongs to.
+     */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    gridActions: {
+        type: PropType<GridAction[]>;
+        required: true;
+    };
+    /**
+     * The grid state that this action belongs to.
+     */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+}>>, {}>;
+export default _default;

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

@@ -0,0 +1,26 @@
+import { PropType } from "vue";
+import { ColumnDefinition, IGridState } from "@Obsidian/Types/Controls/grid";
+declare const _default: import("vue").DefineComponent<{
+    /** The column definition of this cell. */
+    column: {
+        type: PropType<ColumnDefinition>;
+        required: true;
+    };
+    /** This grid this cell belongs to. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The column definition of this cell. */
+    column: {
+        type: PropType<ColumnDefinition>;
+        required: true;
+    };
+    /** This grid this cell belongs to. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+}>>, {}>;
+export default _default;

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

@@ -0,0 +1,46 @@
+import { ColumnDefinition, IGridState } from "@Obsidian/Types/Controls/grid";
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The array of columns that should be displayed in the data row.
+     * This may be different than the columns defined in the grid but
+     * must be a subset of them.
+     */
+    columns: {
+        type: PropType<readonly ColumnDefinition[]>;
+        required: true;
+    };
+    /** The grid this row is being displayed for. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+    /** True if this row is an even numbered row. */
+    isEven: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The array of columns that should be displayed in the data row.
+     * This may be different than the columns defined in the grid but
+     * must be a subset of them.
+     */
+    columns: {
+        type: PropType<readonly ColumnDefinition[]>;
+        required: true;
+    };
+    /** The grid this row is being displayed for. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+    /** True if this row is an even numbered row. */
+    isEven: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}>>, {
+    isEven: boolean;
+}>;
+export default _default;

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

@@ -0,0 +1,44 @@
+import { PropType } from "vue";
+import { ColumnDefinition, IGridState } from "@Obsidian/Types/Controls/grid";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The array of columns that should be displayed in the data rows.
+     * This may be different than the columns defined in the grid but
+     * must be a subset of them.
+     */
+    columns: {
+        type: PropType<readonly ColumnDefinition[]>;
+        required: true;
+    };
+    /** The grid that contains all the state information. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+    /** The number of skeleton rows to render. */
+    count: {
+        type: PropType<number>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The array of columns that should be displayed in the data rows.
+     * This may be different than the columns defined in the grid but
+     * must be a subset of them.
+     */
+    columns: {
+        type: PropType<readonly ColumnDefinition[]>;
+        required: true;
+    };
+    /** The grid that contains all the state information. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+    /** The number of skeleton rows to render. */
+    count: {
+        type: PropType<number>;
+        required: true;
+    };
+}>>, {}>;
+export default _default;

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

@@ -0,0 +1,70 @@
+import { ColumnDefinition, IGridState } from "@Obsidian/Types/Controls/grid";
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The array of columns that should be displayed in the data rows.
+     * This may be different than the columns defined in the grid but
+     * must be a subset of them.
+     */
+    columns: {
+        type: PropType<readonly ColumnDefinition[]>;
+        required: true;
+    };
+    /** The rows that contain the data to be displayed. */
+    rows: {
+        type: PropType<Record<string, unknown>[]>;
+        required: true;
+    };
+    /** The grid that contains all the state information. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+    /** The field that will be used to display per-row tooltips. */
+    tooltipField: {
+        type: PropType<string>;
+        required: false;
+    };
+    /** True if any data row is selectable. */
+    isSelectable: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    click: (key: string) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The array of columns that should be displayed in the data rows.
+     * This may be different than the columns defined in the grid but
+     * must be a subset of them.
+     */
+    columns: {
+        type: PropType<readonly ColumnDefinition[]>;
+        required: true;
+    };
+    /** The rows that contain the data to be displayed. */
+    rows: {
+        type: PropType<Record<string, unknown>[]>;
+        required: true;
+    };
+    /** The grid that contains all the state information. */
+    grid: {
+        type: PropType<IGridState>;
+        required: true;
+    };
+    /** The field that will be used to display per-row tooltips. */
+    tooltipField: {
+        type: PropType<string>;
+        required: false;
+    };
+    /** True if any data row is selectable. */
+    isSelectable: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}>> & {
+    onClick?: ((key: string) => any) | undefined;
+}, {
+    isSelectable: boolean;
+}>;
+export default _default;

package/types/Controls/Grid/virtualScroller.partial.d.ts

@@ -0,0 +1,172 @@
+/**
+ * A range of items that should be displayed, including the padding that should
+ * be applied before and after the items so everything fits properly.
+ */
+export declare type Range = {
+    /** The first item index to be displayed. */
+    startIndex: number;
+    /** The last item index to be displayed, this is inclusive. */
+    endIndex: number;
+    /** The padding, in pixels, that should preceed the first item. */
+    padBefore: number;
+    /** The padding, in pixels, that should follow the last item. */
+    padAfter: number;
+};
+/**
+ * The options to use when creating a new instance of {@link VirtualScroller}.
+ */
+export declare type VirtualOptions = {
+    /**
+     * The number of visible items expected to fit on screen.
+     */
+    visibleCount: number;
+    /**
+     * The number of "off-screen" items before and after the edge of the sceen
+     * to keep rendered.
+     */
+    bufferCount: number;
+    /**
+     * The estimated height of each item.
+     */
+    estimatedHeight: number;
+    /**
+     * The list of all unique identifiers representing all items in the list.
+     */
+    uniqueIds: string[];
+};
+/**
+ * Helper class to handle virtual scrolling. There is no DOM interaction here.
+ * This simply handles the logic of which items to scroll and how much buffer
+ * space to prepend and append to the real list.
+ */
+export default class VirtualScroller {
+    /** The options we were initialized with. */
+    private readonly options;
+    /** The callback function to call when the range has changed. */
+    private readonly rangeUpdated;
+    /** The hash table to map item identifiers to the known height. */
+    private readonly heights;
+    /**
+     * When not `undefined` this contains the total height of all known items.
+     * It indicates that we need to keep woring to figure out an average height
+     * until it becomes `undefined.
+     */
+    private firstRangeTotalHeight?;
+    /** Contains the calculated average height of each row. */
+    private firstRangeAverageHeight;
+    /** Tracks the highest most index whose position has been calculated. */
+    private highestCalculatedIndex;
+    /** The type of item height calculation we are using. */
+    private calcType;
+    /**
+     * Contains the currently known fixed height if {@link calcType} is
+     * {@link CalcType.Fixed}. Will be set to `undefined` if we are in
+     * dynamic mode.
+     */
+    private fixedHeightValue?;
+    /** Contains the last known scroll offset for this scroller. */
+    private offset;
+    /** The current range of items to be displayed. */
+    private range;
+    /**
+     * Creates a new instance of {@link VirtualScroller}.
+     *
+     * @param options The options to initialize the virtual scroller with.
+     * @param rangeUpdated The callback for when the range value changes.
+     */
+    constructor(options: VirtualOptions, rangeUpdated: (range: Range) => void);
+    /**
+     * Performs any cleanup on the virtual scroller that is needed. This should
+     * be called when the scroller will no longer be used.
+     */
+    destroy(): void;
+    /**
+     * Gets the current calculated range for the scroller.
+     *
+     * @returns The current calculated range for the scroller.
+     */
+    getRange(): Range;
+    /**
+     * Informs the virtual scroller that the list of items to be displayed
+     * has changed. This should be called anytime anything about the list or
+     * order gets modified.
+     *
+     * @param uniqueIds The new list of unique identifiers in the list.
+     */
+    dataSourceChanged(uniqueIds: string[]): void;
+    /**
+     * Informs the virtual scroller that the height of a single item has
+     * changed.
+     *
+     * @param id The identifier of the item whose height changed.
+     * @param height The new height of the item.
+     */
+    updateHeight(id: string, height: number): void;
+    /**
+     * Informs the scroller that a scroll action has taken place. This is the
+     * meat of the scroller and kicks off all logic to handle which items
+     * need to be displayed.
+     *
+     * @param offset The offset from start in the virtual scroller it is positioned at.
+     */
+    handleScroll(offset: number): void;
+    /**
+     * Determines the index of the first item that is at least partially visible.
+     *
+     * @returns The first item that is at least partially visible.
+     */
+    private getFirstVisibleIndex;
+    /**
+     * Calculates and returns the offset position of the given item.
+     *
+     * @param givenIndex The index of the item whose offset we need to calcualate.
+     *
+     * @returns The offset of the start of the item at this index.
+     */
+    private getIndexOffset;
+    /**
+     * Checks if the current calculation type is a known fixed height.
+     *
+     * @returns `true` if the calculation type is currently a fixed height.
+     */
+    private isFixedType;
+    /**
+     * Gets the index number of the last item.
+     *
+     * @returns The index of the last item.
+     */
+    private getLastIndex;
+    /**
+     * Checks if the range is valid and then updates the range if it has
+     * changed from the current values.
+     *
+     * @param start The requested starting index.
+     * @param end The requested ending index (inclusive).
+     */
+    private checkRange;
+    /**
+     * Updates the item range to match the supplied values.
+     *
+     * @param start The index of the first item to render.
+     * @param end The index of the last item to render (inclusive).
+     */
+    private updateRange;
+    /**
+     * Gets the padding to be applied before the first visible item in the list.
+     *
+     * @returns The number of pixels to use as padding before the first item.
+     */
+    private getPadBefore;
+    /**
+     * Gets the padding to be applied after the last visible item in the list.
+     *
+     * @returns The number of pixels to use as padding after the last item.
+     */
+    private getPadAfter;
+    /**
+     * Gets the estimated height of a single item.
+     *
+     * @returns The estimated height of a single item.
+     */
+    private getEstimatedItemHeight;
+}

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

@@ -0,0 +1,38 @@
+import { PropType } from "vue";
+import { FormError } from "@Obsidian/Utility/form";
+declare enum NMIPaymentType {
+    Card = 0,
+    BankAccount = 1
+}
+declare const _default: import("vue").DefineComponent<{
+    settings: {
+        type: PropType<{
+            /** The payment types that are enabled for use. */
+            enabledPaymentTypes?: NMIPaymentType[] | undefined;
+            /** The configured key used to initialize the tokenzier. */
+            tokenizationKey?: string | undefined;
+        }>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    success: (value: string) => void;
+} & {
+    validation: (value: FormError[]) => void;
+} & {
+    error: (value: string) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    settings: {
+        type: PropType<{
+            /** The payment types that are enabled for use. */
+            enabledPaymentTypes?: NMIPaymentType[] | undefined;
+            /** The configured key used to initialize the tokenzier. */
+            tokenizationKey?: string | undefined;
+        }>;
+        required: true;
+    };
+}>> & {
+    onError?: ((value: string) => any) | undefined;
+    onSuccess?: ((value: string) => any) | undefined;
+    onValidation?: ((value: FormError[]) => any) | undefined;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,30 @@
+import { PropType } from "vue";
+import { DebugTiming } from "@Obsidian/ViewModels/Utility/debugTiming";
+declare const _default: import("vue").DefineComponent<{
+    viewModel: {
+        type: PropType<DebugTiming>;
+        required: true;
+    };
+    startTimeMs: {
+        type: PropType<number>;
+        required: true;
+    };
+    totalMs: {
+        type: PropType<number>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    viewModel: {
+        type: PropType<DebugTiming>;
+        required: true;
+    };
+    startTimeMs: {
+        type: PropType<number>;
+        required: true;
+    };
+    totalMs: {
+        type: PropType<number>;
+        required: true;
+    };
+}>>, {}>;
+export default _default;