@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Controls/rockCacheability.d.ts

@@ -0,0 +1,33 @@
+// <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 { RockCacheabilityType } from "@Obsidian/Enums/Controls/rockCacheabilityType";
+import { TimeInterval } from "@Obsidian/ViewModels/Utility/timeInterval";
+
+/**
+ * Represents a setting for how to cache a resource. Based on Rock.Utility.RockCacheability
+ */
+export type RockCacheability = {
+    /** Cache header type */
+    rockCacheabilityType: RockCacheabilityType;
+
+    /** Max amount of time to cache */
+    maxAge: TimeInterval;
+
+    /** Max amount of time to cache in a shared cache */
+    sharedMaxAge: TimeInterval;
+};

package/types/ViewModels/Controls/rockCacheabilityBag.d.ts

@@ -0,0 +1,36 @@
+//------------------------------------------------------------------------------
+// <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 { TimeIntervalBag } from "@Obsidian/ViewModels/Utility/timeIntervalBag";
+
+/** Represents the Cache-Control settings used inside Rock. */
+export type RockCacheabilityBag = {
+    /** Gets or sets the maximum age. */
+    maxAge?: TimeIntervalBag | null;
+
+    /** Gets or sets the type of the rock cacheability type. */
+    rockCacheabilityType: number;
+
+    /** Gets or sets the shared maximum age. */
+    sharedMaxAge?: TimeIntervalBag | null;
+};

package/types/ViewModels/Controls/slidingDateRangeBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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 { SlidingDateRangeType } from "@Obsidian/Enums/Controls/slidingDateRangeType";
+import { TimeUnitType } from "@Obsidian/Enums/Controls/timeUnitType";
+
+/** Class SlidingDateRangeBag. */
+export type SlidingDateRangeBag = {
+    /** Gets or sets the id */
+    lowerDate?: string | null;
+
+    /** Gets or sets the range type */
+    rangeType: SlidingDateRangeType;
+
+    /** Gets or sets the id */
+    timeUnit?: TimeUnitType | null;
+
+    /** Gets or sets the id */
+    timeValue?: number | null;
+
+    /** Gets or sets the id */
+    upperDate?: string | null;
+};

package/types/ViewModels/Controls/timePickerValue.d.ts

@@ -0,0 +1,25 @@
+// <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>
+//
+
+/** The value expected by the TimePicker. */
+export type TimePickerValue = {
+    /** Hour of the time, 0-23. */
+    hour?: number;
+
+    /** Minute of the time, 0-59. */
+    minute?: number;
+};

package/types/ViewModels/Core/Grid/attributeFieldDefinitionBag.d.ts

@@ -0,0 +1,47 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * Information about a single attribute field that has been defined on
+ * the grid. Attributes are handled slightly differently than normal
+ * fields so these are handled differently than regular
+ * Rock.ViewModels.Core.Grid.FieldDefinitionBag objects.
+ */
+export type AttributeFieldDefinitionBag = {
+    /**
+     * Gets or sets the field type unique identifier. This is the field type
+     * that provides logic for the attribute.
+     */
+    fieldTypeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the name of the field. This corresponds to the key name
+     * in the row data object.
+     */
+    name?: string | null;
+
+    /** Gets or sets the title to use for the column. */
+    title?: string | null;
+};

package/types/ViewModels/Core/Grid/customActionBag.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>
+//
+
+/** Defines a custom action configured by the administrator. */
+export type CustomActionBag = {
+    /**
+     * Gets or sets the description. This is the help text that describes
+     * the action in more detail.
+     */
+    description?: string | null;
+
+    /** Gets or sets the icon CSS class. */
+    iconCssClass?: string | null;
+
+    /**
+     * Gets or sets the name of the action. This should be one or two words
+     * that quickly describe the action.
+     */
+    name?: string | null;
+
+    /**
+     * Gets or sets the route. If the route includes {0} then it
+     * will be replaced with the entity set identifier. Otherwise the a
+     * query string parameter of EntitySetId will be appended to
+     * the route.
+     */
+    route?: string | null;
+};

package/types/ViewModels/Core/Grid/customColumnDefinitionBag.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>
+//
+
+import { ColumnPositionAnchor } from "@Obsidian/Enums/Core/Grid/columnPositionAnchor";
+
+/**
+ * Defines the structure of a custom column that will be incorporated
+ * into a Grid.
+ */
+export type CustomColumnDefinitionBag = {
+    /** Gets or sets a value indicating where this column is anchored. */
+    anchor: ColumnPositionAnchor;
+
+    /** Gets or sets the name of the field that contains the text data. */
+    fieldName?: string | null;
+
+    /** Gets or sets the header class. This will be applied to the th element. */
+    headerClass?: string | null;
+
+    /** Gets or sets the text to display in the column header. */
+    headerText?: string | null;
+
+    /** Gets or sets the item class. This will be applied to all td elements. */
+    itemClass?: string | null;
+
+    /** Gets or sets the position offset. This should be a positive number. */
+    positionOffset: number;
+};

package/types/ViewModels/Core/Grid/fieldDefinitionBag.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>
+//
+
+/** Information about a single field that has been defined on the grid. */
+export type FieldDefinitionBag = {
+    /**
+     * Gets or sets the name of the field. This corresponds to the key name
+     * in the row data object.
+     */
+    name?: string | null;
+};

package/types/ViewModels/Core/Grid/gridCommunicationBag.d.ts

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <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 { GridEntitySetItemBag } from "@Obsidian/ViewModels/Core/Grid/gridEntitySetItemBag";
+
+/**
+ * Identifies the information about a communication that should be created
+ * for use by a Grid.
+ */
+export type GridCommunicationBag = {
+    /** Gets or sets the URL of the page this request came from. */
+    fromUrl?: string | null;
+
+    /** Gets or sets the merge field keys that are available for use. */
+    mergeFields?: string[] | null;
+
+    /** Gets or sets the recipients. */
+    recipients?: GridEntitySetItemBag[] | null;
+};

package/types/ViewModels/Core/Grid/gridDataBag.d.ts

@@ -0,0 +1,28 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** The data that describes the contents of a grid. */
+export type GridDataBag = {
+    /** Gets or sets the row data to display in the grid. */
+    rows?: Record<string, unknown>[] | null;
+};

package/types/ViewModels/Core/Grid/gridDefinitionBag.d.ts

@@ -0,0 +1,76 @@
+//------------------------------------------------------------------------------
+// <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 { AttributeFieldDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/attributeFieldDefinitionBag";
+import { CustomActionBag } from "@Obsidian/ViewModels/Core/Grid/customActionBag";
+import { CustomColumnDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/customColumnDefinitionBag";
+import { FieldDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/fieldDefinitionBag";
+
+/**
+ * Describes the structure of a grid. This should be passed to
+ * the grid.
+ */
+export type GridDefinitionBag = {
+    /**
+     * Gets or sets the action urls. These are used as a lookup table for
+     * when a standard action is executed on a set of items. The key is
+     * something known by the Grid internally.
+     */
+    actionUrls?: Record<string, string> | null;
+
+    /**
+     * Gets or sets the attribute fields that hav ebeen defined on the
+     * grid. Each attribute field has a corresponding entry in the row
+     * data object.
+     */
+    attributeFields?: AttributeFieldDefinitionBag[] | null;
+
+    /** Gets or sets the custom actions that should be added to the grid. */
+    customActions?: CustomActionBag[] | null;
+
+    /**
+     * Gets or sets the definitions of any custom columns that should be
+     * added to the grid. These are defined by the administrator.
+     */
+    customColumns?: CustomColumnDefinitionBag[] | null;
+
+    /**
+     * Gets or sets a value indicating whether the launch workflow action
+     * should be included. This is additive, if the developer has explicitely
+     * turned off launch workflows then they will not be enabled by this.
+     */
+    enableLaunchWorkflow: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the sticky header should
+     * be enabled. This is additive, if the developer has explicitely turned
+     * off sticky headers then they will not be enabled by this.
+     */
+    enableStickyHeader: boolean;
+
+    /**
+     * Gets or sets the fields that have been defined on the grid. Each
+     * field has a corresponding entry in the row data object.
+     */
+    fields?: FieldDefinitionBag[] | null;
+};

package/types/ViewModels/Core/Grid/gridEntitySetBag.d.ts

@@ -0,0 +1,39 @@
+//------------------------------------------------------------------------------
+// <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 { GridEntitySetItemBag } from "@Obsidian/ViewModels/Core/Grid/gridEntitySetItemBag";
+
+/**
+ * Identifies the data used by a Grid to request a new entity set be
+ * created. 
+ */
+export type GridEntitySetBag = {
+    /**
+     * Gets or sets the entity type key. Currently this must be a Guid
+     * value.
+     */
+    entityTypeKey?: string | null;
+
+    /** Gets or sets the items that will be stored in the set. */
+    items?: GridEntitySetItemBag[] | null;
+};

package/types/ViewModels/Core/Grid/gridEntitySetItemBag.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>
+//
+
+/**
+ * Identifies a single entity set item that should be created when a Grid
+ * needs to create an entity set.
+ */
+export type GridEntitySetItemBag = {
+    /** Gets or sets the additional merge values. */
+    additionalMergeValues?: Record<string, unknown> | null;
+
+    /**
+     * Gets or sets the entity key. This should either be a Guid, IdKey
+     * or Id property value.
+     */
+    entityKey?: string | null;
+
+    /** Gets or sets the order of the item in the set. */
+    order: number;
+};

package/types/ViewModels/Core/Grid/personFieldBag.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>
+//
+
+/**
+ * The data bag that contains all the information required to display
+ * a PersonColumn in a Grid.
+ */
+export type PersonFieldBag = {
+    /** Gets or sets the last name. */
+    lastName?: string | null;
+
+    /** Gets or sets the nick name. */
+    nickName?: string | null;
+
+    /** Gets or sets the photo URL. */
+    photoUrl?: string | null;
+};

package/types/ViewModels/Core/notificationMessageActionBag.d.ts

@@ -0,0 +1,42 @@
+//------------------------------------------------------------------------------
+// <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 { NotificationMessageActionType } from "@Obsidian/Enums/Core/notificationMessageActionType";
+
+/** Type of audit done to an entity */
+export type NotificationMessageActionBag = {
+    /**
+     * Gets or sets the message to be displayed. Only valid if Rock.ViewModels.Core.NotificationMessageActionBag.Type
+     * is the value Rock.Enums.Core.NotificationMessageActionType.ShowMessage.
+     */
+    message?: string | null;
+
+    /** Gets or sets the type of action to be performed. */
+    type: NotificationMessageActionType;
+
+    /**
+     * Gets or sets the URL of the page to link to. Only valid if
+     * Rock.ViewModels.Core.NotificationMessageActionBag.Type is the value Rock.Enums.Core.NotificationMessageActionType.LinkToPage.
+     */
+    url?: string | null;
+};