@rockrms/obsidian-framework 1.16.3-rc.1

package/types/Utility/treeItemProviders.d.ts

@@ -0,0 +1,512 @@
+import { Guid } from "@Obsidian/Types";
+import { TreeItemBag } from "@Obsidian/ViewModels/Utility/treeItemBag";
+import { MergeTemplateOwnership } from "@Obsidian/Enums/Controls/mergeTemplateOwnership";
+/**
+ * The methods that must be implemented by tree item providers. These methods
+ * provide the TreeItem objects to be displayed when lazy loading is being used.
+ */
+export interface ITreeItemProvider {
+    /**
+     * Get the root items to be displayed in the tree list.
+     *
+     * @returns A collection of TreeItem objects, optionally wrapped in a Promise
+     * if the loading is being performed asynchronously.
+     */
+    getRootItems(): Promise<TreeItemBag[]> | TreeItemBag[];
+    /**
+     * Get the child items of the given tree item.
+     *
+     * @param item The parent item whose children should be loaded.
+     *
+     * @returns A collection of TreeItem objects, optionally wrapped in a Promise
+     * if the loading is being performed asynchronously.
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]> | TreeItemBag[];
+}
+/**
+ * Tree Item Provider for retrieving categories from the server and displaying
+ * them inside a tree list.
+ */
+export declare class CategoryTreeItemProvider implements ITreeItemProvider {
+    /**
+     * The root category to start pulling categories from. Set to undefined to
+     * begin with any category that does not have a parent.
+     */
+    rootCategoryGuid?: Guid;
+    /**
+     * The entity type unique identifier to restrict results to. Set to undefined
+     * to include all categories, regardless of entity type.
+     */
+    entityTypeGuid?: Guid;
+    /**
+     * The value that must match in the category EntityTypeQualifierColumn
+     * property. Set to undefined or an empty string to ignore.
+     */
+    entityTypeQualifierColumn?: string;
+    /**
+     * The value that must match in the category EntityTypeQualifierValue
+     * property.
+     */
+    entityTypeQualifierValue?: string;
+    /**
+     * The security grant token that will be used to request additional access
+     * to the category list.
+     */
+    securityGrantToken?: string | null;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving locations from the server and displaying
+ * them inside a tree list.
+ */
+export declare class LocationTreeItemProvider implements ITreeItemProvider {
+    /**
+     * The security grant token that will be used to request additional access
+     * to the category list.
+     */
+    securityGrantToken?: string | null;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving data views from the server and displaying
+ * them inside a tree list.
+ */
+export declare class DataViewTreeItemProvider implements ITreeItemProvider {
+    /**
+     * The entity type unique identifier to restrict results to. Set to undefined
+     * to include all categories, regardless of entity type.
+     */
+    entityTypeGuid?: Guid;
+    /**
+     * The security grant token that will be used to request additional access
+     * to the category list.
+     */
+    securityGrantToken?: string | null;
+    /**
+     * The flag sets whether only persisted data view should be shown by the picker
+     */
+    displayPersistedOnly: boolean;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving categories from the server and displaying
+ * them inside a tree list.
+ */
+export declare class WorkflowTypeTreeItemProvider implements ITreeItemProvider {
+    /**
+     * The entity type unique identifier to restrict results to. Set to undefined
+     * to include all categories, regardless of entity type.
+     */
+    includeInactiveItems?: boolean;
+    /**
+     * The security grant token that will be used to request additional access
+     * to the category list.
+     */
+    securityGrantToken?: string | null;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving pages from the server and displaying
+ * them inside a tree list.
+ */
+export declare class PageTreeItemProvider implements ITreeItemProvider {
+    /**
+     * The security grant token that will be used to request additional access
+     * to the category list.
+     */
+    securityGrantToken?: string | null;
+    /**
+     * List of GUIDs or pages to exclude from the list.
+     */
+    hidePageGuids?: Guid[] | null;
+    /**
+     * Currently selected page
+     */
+    selectedPageGuids?: Guid[] | null;
+    /**
+     * Gets the child items of the given parent (or root if no parent given) from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * Get the hierarchical list of parent pages of the selectedPageGuid
+     *
+     * @returns A list of GUIDs of the parent pages
+     */
+    private getParentList;
+    /**
+     * Fill in pages to the depth of the selected page
+     *
+     * @param rootLayer The bottom layer of pages that we'll build depth upon
+     *
+     * @return The augmented `rootLayer` with the child pages
+     */
+    private getHierarchyToSelectedPage;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving connection requests from the server and displaying
+ * them inside a tree list.
+ */
+export declare class ConnectionRequestTreeItemProvider implements ITreeItemProvider {
+    /**
+     * The security grant token that will be used to request additional access
+     * to the category list.
+     */
+    securityGrantToken?: string | null;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving groups from the server and displaying
+ * them inside a tree list.
+ */
+export declare class GroupTreeItemProvider implements ITreeItemProvider {
+    /** The security grant token that will be used to request additional access to the group list. */
+    securityGrantToken: string | null;
+    /** GUID of the group you want to use as the root. */
+    rootGroupGuid: Guid | null;
+    /** List of group types GUIDs to limit to groups of those types. */
+    includedGroupTypeGuids: Guid[];
+    /** Whether to include inactive groups or not. */
+    includeInactiveGroups: boolean;
+    /** Whether to limit to only groups that have scheduling enabled. */
+    limitToSchedulingEnabled: boolean;
+    /** Whether to limit to only groups that have RSVPs enabled. */
+    limitToRSVPEnabled: boolean;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving merge templates from the server and displaying
+ * them inside a tree list.
+ */
+export declare class MergeTemplateTreeItemProvider implements ITreeItemProvider {
+    /** The security grant token that will be used to request additional access to the group list. */
+    securityGrantToken: string | null;
+    /** Filter for which merge templates to include in results: Global, Public, or Both */
+    mergeTemplateOwnership: MergeTemplateOwnership;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving merge templates from the server and displaying
+ * them inside a tree list.
+ */
+export declare class MetricCategoryTreeItemProvider implements ITreeItemProvider {
+    /** The security grant token that will be used to request additional access to the group list. */
+    securityGrantToken: string | null;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving merge templates from the server and displaying
+ * them inside a tree list.
+ */
+export declare class MetricItemTreeItemProvider implements ITreeItemProvider {
+    /** The security grant token that will be used to request additional access to the group list. */
+    securityGrantToken: string | null;
+    /** A list of category GUIDs to filter the results */
+    includeCategoryGuids: Guid[] | null;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving registration templates from the server and displaying
+ * them inside a tree list.
+ */
+export declare class RegistrationTemplateTreeItemProvider implements ITreeItemProvider {
+    /** The security grant token that will be used to request additional access to the group list. */
+    securityGrantToken: string | null;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving reports from the server and displaying
+ * them inside a tree list.
+ */
+export declare class ReportTreeItemProvider implements ITreeItemProvider {
+    /** The security grant token that will be used to request additional access to the group list. */
+    securityGrantToken: string | null;
+    /** A list of category GUIDs to filter the results. */
+    includeCategoryGuids: Guid[] | null;
+    /** Guid of an Entity Type to filter results by the reports that relate to this entity type. */
+    entityTypeGuid: Guid | null;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving reports from the server and displaying
+ * them inside a tree list.
+ */
+export declare class ScheduleTreeItemProvider implements ITreeItemProvider {
+    /** The security grant token that will be used to request additional access to the group list. */
+    securityGrantToken: string | null;
+    /** Whether to include inactive schedules in the results. */
+    includeInactive: boolean;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+ * Tree Item Provider for retrieving reports from the server and displaying
+ * them inside a tree list.
+ */
+export declare class WorkflowActionTypeTreeItemProvider implements ITreeItemProvider {
+    /** The security grant token that will be used to request additional access to the group list. */
+    securityGrantToken: string | null;
+    /** Whether to include inactive schedules in the results. */
+    includeInactive: boolean;
+    /**
+     * Gets the child items from the server.
+     *
+     * @param parentGuid The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}
+/**
+     * Tree Item Provider for retrieving merge fields from the server and displaying
+     * them inside a tree list.
+     */
+export declare class MergeFieldTreeItemProvider implements ITreeItemProvider {
+    /**
+     * The security grant token that will be used to request additional access
+     * to the category list.
+     */
+    securityGrantToken?: string | null;
+    /**
+     * Currently selected page
+     */
+    selectedIds?: string[] | string | null;
+    /**
+     * Root Level Merge Fields
+     */
+    additionalFields: string;
+    /**
+     * Gets the child items of the given parent (or root if no parent given) from the server.
+     *
+     * @param parentId The parent item whose children are retrieved.
+     *
+     * @returns A collection of TreeItem objects as an asynchronous operation.
+     */
+    private getItems;
+    /**
+     * Fill in pages to the depth of the selected page
+     *
+     * @param rootLayer The bottom layer of pages that we'll build depth upon
+     *
+     * @return The augmented `rootLayer` with the child pages
+     */
+    private getHierarchyToSelectedMergeField;
+    /**
+     * Get the hierarchical list of parent merge fields of the selected merge fields
+     *
+     * @returns A list of IDs of the parent merge fields
+     */
+    private getParentList;
+    /**
+     * Split the given selected ID up and get a list of the parent IDs
+     *
+     * @param selection a string denoted one of the selected values
+     */
+    private splitSelectionIntoParents;
+    /**
+     * @inheritdoc
+     */
+    getRootItems(): Promise<TreeItemBag[]>;
+    /**
+     * @inheritdoc
+     */
+    getChildItems(item: TreeItemBag): Promise<TreeItemBag[]>;
+}

package/types/Utility/url.d.ts

@@ -0,0 +1,39 @@
+import { Ref } from "vue";
+/**
+ * Is the value a valid URL?
+ * @param val
+ */
+export declare function isUrl(val: unknown): boolean;
+/**
+ * Make the URL safe to use for redirects. Basically, this strips off any
+ * protocol and hostname from the URL and ensures it's not a javascript:
+ * url or anything like that.
+ *
+ * @param url The URL to be made safe to use with a redirect.
+ *
+ * @returns A string that is safe to assign to window.location.href.
+ */
+export declare function makeUrlRedirectSafe(url: string): string;
+/**
+ * Keep a list of named Refs synchronized with URL query parameters in the address of the same names.
+ * If there are already query parameters in the URL with those names, the Refs will be assigned those
+ * values. This will also watch those Refs for changes and update the query parameters to reflect
+ * those changes.
+ *
+ * @param refs An object where the keys represent the query parameters keys to keep synchronized with
+ * and the values are the Refs those query parameters are synched with.
+ */
+export declare function syncRefsWithQueryParams(refs: Record<string, Ref>): void;
+/**
+ * Removes query parameters from the current URL and replaces the state in history.
+ *
+ * @param queryParamKeys The string array of query parameter keys to remove from the current URL.
+ */
+export declare function removeCurrentUrlQueryParams(...queryParamKeys: string[]): (string | null)[];
+/**
+ * Removes query parameters from the current URL and replaces the state in history.
+ *
+ * @param url The URL from which to remove the query parameters.
+ * @param queryParamKeys The string array of query parameter keys to remove from the current URL.
+ */
+export declare function removeUrlQueryParams(url: string | URL, ...queryParamKeys: string[]): (string | null)[];

package/types/Utility/util.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Compares two values for equality by performing deep nested comparisons
+ * if the values are objects or arrays.
+ *
+ * @param a The first value to compare.
+ * @param b The second value to compare.
+ * @param strict True if strict comparision is required (meaning 1 would not equal "1").
+ *
+ * @returns True if the two values are equal to each other.
+ */
+export declare function deepEqual(a: unknown, b: unknown, strict: boolean): boolean;
+/**
+ * Debounces the function so it will only be called once during the specified
+ * delay period. The returned function should be called to trigger the original
+ * function that is to be debounced.
+ *
+ * @param fn The function to be called once per delay period.
+ * @param delay The period in milliseconds. If the returned function is called
+ * more than once during this period then fn will only be executed once for
+ * the period. If not specified then it defaults to 250ms.
+ * @param eager If true then the fn function will be called immediately and
+ * then any subsequent calls will be debounced.
+ *
+ * @returns A function to be called when fn should be executed.
+ */
+export declare function debounce(fn: (() => void), delay?: number, eager?: boolean): (() => void);

package/types/Utility/validationRules.d.ts

@@ -0,0 +1,49 @@
+import type { RulesPropType, ValidationRule, ValidationRuleFunction, ValidationRuleReference } from "@Obsidian/Types/validationRules";
+/** Defines the property type for a component's rules. */
+export declare const rulesPropType: RulesPropType;
+/**
+ * Parse a string into a valid rule reference. Basically this does the heavy
+ * lifting to take a string and spit out the rule name and parameters. This
+ * assumes the rule has already been normalized and does not contain multiple
+ * rules separated by a | character.
+ *
+ * @param rule The rule to be parsed.
+ *
+ * @returns The rule reference that contains the name and parameters.
+ */
+export declare function parseRule(rule: string): ValidationRuleReference;
+/**
+ * Normalize a single rule or array of rules into a flat array of rules. This
+ * handles strings that contain multiple rules and splits them out into individual
+ * rule strings.
+ *
+ * @param rules The rules to be normalized.
+ *
+ * @returns A flattened array that contains all the individual rules.
+ */
+export declare function normalizeRules(rules: ValidationRule | ValidationRule[]): ValidationRule[];
+/**
+ * Checks if any of the specified rules indicates a rule that requires the value
+ * to be filled in.
+ *
+ * @param rules The rules to be checked.
+ *
+ * @returns True if any of the rules is considered a required rule; otherwise false.
+ */
+export declare function containsRequiredRule(rules: ValidationRule | ValidationRule[]): boolean;
+/**
+ * Runs validation on the value for all the rules provided.
+ *
+ * @param value The value to be checked.
+ * @param rule The array of rules that will be used during validation.
+ *
+ * @returns An array of error messages, or empty if value passed.
+ */
+export declare function validateValue(value: unknown, rule: ValidationRule | ValidationRule[]): string[];
+/**
+ * Define a new rule by name and provide the validation function.
+ *
+ * @param ruleName The name of the rule to be registered.
+ * @param validator The validation function.
+ */
+export declare function defineRule(ruleName: string, validator: ValidationRuleFunction): void;

package/types/ValidationRules/index.d.ts

@@ -0,0 +1,3 @@
+import type { RulesPropType, ValidationResult, ValidationRule, ValidationRuleFunction, ValidationRuleReference } from "@Obsidian/Types/validationRules";
+import { containsRequiredRule, defineRule, normalizeRules, parseRule, rulesPropType, validateValue } from "@Obsidian/Utility/validationRules";
+export { RulesPropType, ValidationResult, ValidationRule, ValidationRuleFunction, ValidationRuleReference, containsRequiredRule, defineRule, normalizeRules, parseRule, rulesPropType, validateValue, };

package/types/ViewModels/Blocks/Bus/QueueDetail/queueBag.d.ts

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+export type QueueBag = {
+    /**
+     * Gets the messages consumed last day.
+     * Specific to one Rock instance.
+     */
+    messagesConsumedLastDay?: number | null;
+
+    /**
+     * Gets the messages consumed last hour.
+     * Specific to one Rock instance.
+     */
+    messagesConsumedLastHour?: number | null;
+
+    /**
+     * Gets the messages consumed last minute.
+     * Specific to one Rock instance.
+     */
+    messagesConsumedLastMinute?: number | null;
+
+    /** Gets the name. Each instance of Rock shares this name for this queue. */
+    name?: string | null;
+
+    /** Gets or sets the time to live in seconds. */
+    timeToLiveSeconds?: number | null;
+};