@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Utility/debugTiming.d.ts

@@ -0,0 +1,32 @@
+// <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>
+//
+
+/**
+ * Contains information about debug timings.
+ *
+ * Internal use only.
+ *
+ * @package
+ * */
+export type DebugTiming = {
+    timestampMs: number;
+    title: string;
+    subTitle: string;
+    indentLevel: number;
+    durationMs: number;
+    isTitleBold: boolean;
+};

package/types/ViewModels/Utility/entityAuditBag.d.ts

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/** Contains the information required to show the audit panel details for a model. */
+export type EntityAuditBag = {
+    /** Gets or sets the name of the person that created the model. */
+    createdByName?: string | null;
+
+    /** Gets or sets the identifier of the person that created the model. */
+    createdByPersonId?: number | null;
+
+    /** Gets or sets the time the model was created relative to now. */
+    createdRelativeTime?: string | null;
+
+    /** Gets or sets the unique identifier of the model. */
+    guid?: Guid | null;
+
+    /** Gets or sets the identifier of the model. */
+    id?: number | null;
+
+    /** Gets or sets the identifier key of the model. */
+    idKey?: string | null;
+
+    /** Gets or sets the name of the person that modified the model. */
+    modifiedByName?: string | null;
+
+    /** Gets or sets the identifier of the person that modified the model. */
+    modifiedByPersonId?: number | null;
+
+    /** Gets or sets the time the model was modified relative to now. */
+    modifiedRelativeTime?: string | null;
+};

package/types/ViewModels/Utility/listItemBag.d.ts

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Identifies a single item that will be displayed through some UI control. */
+export type ListItemBag = {
+    /** Gets or sets the category for this item. */
+    category?: string | null;
+
+    /** Gets or sets disabled for this item. */
+    disabled?: boolean | null;
+
+    /** Gets or sets the text. */
+    text?: string | null;
+
+    /** Gets or sets the value. */
+    value?: string | null;
+};

package/types/ViewModels/Utility/publicAttributeBag.d.ts

@@ -0,0 +1,64 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { PublicAttributeCategoryBag } from "@Obsidian/ViewModels/Utility/publicAttributeCategoryBag";
+
+/**
+ * A slimmed down version of an attribute that includes enough detail to
+ * view and edit a value, but not enough to edit the attribute itself.
+ */
+export type PublicAttributeBag = {
+    /** Gets or sets the attribute unique identifier. */
+    attributeGuid?: Guid | null;
+
+    /** Gets or sets the categories. */
+    categories?: PublicAttributeCategoryBag[] | null;
+
+    /** Gets or sets the configuration values. */
+    configurationValues?: Record<string, string> | null;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets the field type unique identifier. */
+    fieldTypeGuid?: Guid | null;
+
+    /** Gets or sets a value indicating whether this attribute value is required. */
+    isRequired: boolean;
+
+    /** Gets or sets the key that identifies the attribute on the entity. */
+    key?: string | null;
+
+    /** Gets or sets the name of the attribute. */
+    name?: string | null;
+
+    /** Gets or sets the order. */
+    order: number;
+
+    /** Gets or sets the pre HTML. */
+    postHtml?: string | null;
+
+    /** Gets or sets the pre HTML. */
+    preHtml?: string | null;
+};

package/types/ViewModels/Utility/publicAttributeCategoryBag.d.ts

@@ -0,0 +1,40 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/** Provides the details about a category that an attribute belongs to. */
+export type PublicAttributeCategoryBag = {
+    /** Gets or sets the unique identifier of the category. */
+    guid?: Guid | null;
+
+    /** Gets or sets the name of the category. */
+    name?: string | null;
+
+    /**
+     * Gets or sets the order of the category. This provides ordering
+     * information when multiple attributes need to be grouped by
+     * category and then order the categories for display.
+     */
+    order: number;
+};

package/types/ViewModels/Utility/publicComparisonValueBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Describes a field type comparison value send to and from remote systems. */
+export type PublicComparisonValueBag = {
+    /** Gets or sets the comparison type that will be performed with the value. */
+    comparisonType?: number | null;
+
+    /** Gets or sets the current raw filter value. */
+    value?: string | null;
+};

package/types/ViewModels/Utility/publicEditableAttributeBag.d.ts

@@ -0,0 +1,123 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+import { Guid } from "@Obsidian/Types";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Describes the data sent to and from remote systems to allow editing
+ * of attributes (not values, the attributes themselves).
+ */
+export type PublicEditableAttributeBag = {
+    /** Gets or sets the abbreviated name of the attribute. */
+    abbreviatedName?: string | null;
+
+    /** Gets or sets the categories the attribute is associated with. */
+    categories?: ListItemBag[] | null;
+
+    /** Gets or sets the configuration values for the attribute. */
+    configurationValues?: Record<string, string> | null;
+
+    /** Gets or sets the default value of the attribute. */
+    defaultValue?: string | null;
+
+    /**
+     * Gets or sets the description of the attribute. This is usually used
+     * in the help bubble when the edit control is rendered.
+     */
+    description?: string | null;
+
+    /**
+     * Gets or sets the field type unique identifier that defines the behavior
+     * of the attribute. A value of null is only valid when transmitted
+     * from the server to remote systems so that it can provide default values
+     * in other properties.
+     */
+    fieldTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the unique identifier of the existing attribute. If
+     * this is a new attribute the value should be null.
+     */
+    guid?: Guid | null;
+
+    /** Gets or sets a value indicating whether the attribute is active. */
+    isActive: boolean;
+
+    /**
+     * Gets or sets a value indicating whether this attribute should be made available
+     * when performing searches.
+     */
+    isAllowSearch: boolean;
+
+    /** Gets or sets a value indicating whether this attribute is used for analytics. */
+    isAnalytic: boolean;
+
+    /** Gets or sets a value indicating whether this attribute records analytic history. */
+    isAnalyticHistory: boolean;
+
+    /**
+     * Gets or sets a value indicating whether changes to this attribute's values should
+     * be saved for historical purposes.
+     */
+    isEnableHistory: boolean;
+
+    /** Gets or sets a value indicating whether this attribute is indexed by universal search. */
+    isIndexEnabled: boolean;
+
+    /** Gets or sets a value indicating whether the attribute is publically visible. */
+    isPublic: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the attribute is required
+     * to be filled in when the edit control is rendered on a page.
+     */
+    isRequired: boolean;
+
+    /** Gets or sets a value indicating whether the attribute is shown on grids. */
+    isShowInGrid: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the attribute is shown on
+     * bulk update screens.
+     */
+    isShowOnBulk: boolean;
+
+    /**
+     * Gets or sets a value indicating whether this attribute is a system
+     * attribute, which implies limited editing ability.
+     */
+    isSystem: boolean;
+
+    /** Gets or sets the key that identifies the attribute. */
+    key?: string | null;
+
+    /** Gets or sets the name of the attribute. */
+    name?: string | null;
+
+    /** Gets or sets any HTML to be rendered after the attribute's edit control. */
+    postHtml?: string | null;
+
+    /** Gets or sets any HTML to be rendered before the attribute's edit control. */
+    preHtml?: string | null;
+};

package/types/ViewModels/Utility/taskActivityProgressLogBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Contains a details about a new log message that should be recorded. */
+export type TaskActivityProgressLogBag = {
+    /** The message associated with this log message. */
+    message?: string | null;
+
+    /** A unique identifier for the task to which this log message applies. */
+    taskId?: string | null;
+};

package/types/ViewModels/Utility/taskActivityProgressStatusBag.d.ts

@@ -0,0 +1,52 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Contains information about the starting or stopping of a task. */
+export type TaskActivityProgressStatusBag = {
+    /** Additional custom data related to the status of this task. */
+    data?: unknown;
+
+    /** The total time elapsed for this task, measured in milliseconds. */
+    elapsedMilliseconds: number;
+
+    /** A collection of errors the task encountered while running. */
+    errors?: string[] | null;
+
+    /** A flag indicating if this task is finished. */
+    isFinished: boolean;
+
+    /** A flag indicating if this task has started. */
+    isStarted: boolean;
+
+    /** A message indicating the current state of this task. */
+    message?: string | null;
+
+    /** A unique identifier for the task to which this status applies. */
+    taskId?: string | null;
+
+    /** The name of the task. */
+    taskName?: string | null;
+
+    /** A collection of warnings the task encountered while running. */
+    warnings?: string[] | null;
+};

package/types/ViewModels/Utility/taskActivityProgressUpdateBag.d.ts

@@ -0,0 +1,37 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Contains updated progress about an ongoing task activity. */
+export type TaskActivityProgressUpdateBag = {
+    /** The measure of completion for this task, as a percentage */
+    completionPercentage: number;
+
+    /** The total time elapsed for this task, measured in milliseconds. */
+    elapsedMilliseconds: number;
+
+    /** The message associated with this progress report. */
+    message?: string | null;
+
+    /** A unique identifier for the task to which this update applies. */
+    taskId?: string | null;
+};

package/types/ViewModels/Utility/timeInterval.d.ts

@@ -0,0 +1,27 @@
+// <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>
+
+import { TimeIntervalUnit } from "../../Enums/Core/timeIntervalUnit";
+
+/**
+ * Represents an amount of time, denoted by a number of a unit of time
+ *
+ * Based on Rock.Utility.TimeInterval
+ */
+export type TimeInterval = {
+    value: number | null;
+    unit: TimeIntervalUnit | null;
+};

package/types/ViewModels/Utility/timeIntervalBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Represents the unit and value of time. */
+export type TimeIntervalBag = {
+    /** Gets or sets the unit. */
+    unit: number;
+
+    /** Gets or sets the value. */
+    value?: number | null;
+};

package/types/ViewModels/Utility/treeItemBag.d.ts

@@ -0,0 +1,57 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Describes a single item that can be displayed in a tree view. */
+export type TreeItemBag = {
+    /** Gets or sets the child count. Optional. */
+    childCount?: number | null;
+
+    /**
+     * Gets or sets the children. A value of null indicates that the
+     * children should be lazy loaded by the caller.
+     */
+    children?: TreeItemBag[] | null;
+
+    /** Gets or sets a value indicating whether this instance has children. */
+    hasChildren: boolean;
+
+    /** Gets or sets the icon CSS class. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /**
+     * Gets or sets a value indicating whether this instance is a folder.
+     * A folder is an item that is intended to hold child items. This is
+     * a distinction from the Rock.ViewModels.Utility.TreeItemBag.HasChildren property which
+     * specifies if this item _currently_ has children or not.
+     */
+    isFolder: boolean;
+
+    /** Gets or sets the text that should be displayed to identify this item. */
+    text?: string | null;
+
+    /** Gets or sets the generic identifier of this item. */
+    value?: string | null;
+};

package/types/ViewModels/Utility/validPropertiesBox.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** A generic valid properties bag that uses "Bag" as the main property name. */
+export type ValidPropertiesBox<TPropertyBag> = {
+    /** Gets or sets the bag that contains the properties. */
+    bag?: TPropertyBag | null;
+
+    /** Gets or sets the valid properties. */
+    validProperties?: string[] | null;
+};