@rockrms/obsidian-framework 18.1.0 → 18.2.4

package/types/Enums/Group/appliesToPlacementConfiguration.d.ts

@@ -0,0 +1,13 @@
+/** Represents the different modes Person Filters can apply to when configuring Group Placements. */
+export declare const AppliesToPlacementConfiguration: {
+    /** Person Filters should only be applied in the "People To Place" Panel. */
+    readonly PeopleToPlace: 0;
+    /** Person Filters should only be applied in the "Destination Groups" Panel. */
+    readonly DestinationGroupMembers: 1;
+    /** Person Filters should be applied to all people. */
+    readonly AllPeople: 2;
+};
+/** Represents the different modes Person Filters can apply to when configuring Group Placements. */
+export declare const AppliesToPlacementConfigurationDescription: Record<number, string>;
+/** Represents the different modes Person Filters can apply to when configuring Group Placements. */
+export type AppliesToPlacementConfiguration = typeof AppliesToPlacementConfiguration[keyof typeof AppliesToPlacementConfiguration];

package/types/PageState/index.d.ts

@@ -9,6 +9,7 @@ export type PageDebugTiming = {
 export declare class Store {
     state: Readonly<State>;
     constructor();
+    /** @deprecated since v18.0 - This function will be removed in the future. */
     setAreSecondaryBlocksShown(areSecondaryBlocksShown: boolean): void;
     initialize(pageConfig: PageConfig): void;
     addPageDebugTiming(timing: PageDebugTiming): void;

package/types/PageState/state.d.ts

@@ -2,7 +2,6 @@ import { Guid } from "@Obsidian/Types";
 import { DebugTiming } from "@Obsidian/ViewModels/Utility/debugTiming";
 import { CurrentPersonBag } from "@Obsidian/ViewModels/Crm/currentPersonBag";
 export type State = {
-    areSecondaryBlocksShown: boolean;
     currentPerson: CurrentPersonBag | null;
     isAnonymousVisitor: boolean;
     pageParameters: Record<string, string>;

package/types/SystemGuids/serviceJob.d.ts

@@ -164,12 +164,14 @@ export declare const ServiceJob: {
     DataMigrations180PopulateCommunicationrecipientDelivereddatetime: string;
     /** The Job to run Post v18.0 Data Migrations to swap Block. */
     DataMigrations180SwapObsidianBlocks: string;
-    /** The job to run Post v18.0 Data Migrations to update an existing index on the CommunicationRecipient table. */
-    DataMigrations180UpdateCommunicationrecipientIndex: string;
     /** The job to run Post v18.0 Data Migrations to update the Manage My Account Page block setting for the recently-chopped Email Preference Entry block. */
     DataMigrations180UpdateEmailPreferenceEntryBlockManageMyAccountPage: string;
     /** The job to run Post v18.0 Data Migrations to update the Nameless Locations. */
     DataMigrations180UpdateNamelessLocations: string;
+    /** The job to run Post v18.1 Data Migrations to add a new index to the FinancialBatch table. */
+    DataMigrations181AddFinancialbatchIndex: string;
+    /** The job to run Post v18.1 Data Migrations to add indexes to improve communication prep performance. */
+    DataMigrations181AddIndexesForCommunicationPrep: string;
     /**
      * The Post Update Data Migration Job to chop the Schedule Detail, Asset Storage Provider Detail, Page Short Link Detail, Streak Type Detail,
      * Following Event Type Detail, Financial Batch Detail

package/types/Utility/dom.d.ts

@@ -86,3 +86,13 @@ export declare function removeWhiteSpaceFromElementAndChildElements(element: Ele
  * This is important for applying :empty styles.
  */
 export declare function removeWhiteSpaceFromChildElements(element: Document | Element, selector?: string): void;
+/**
+ * Replaces an element's tag name with a new tag name, preserving attributes and children.
+ *
+ * Does not copy event listeners.
+ *
+ * @param oldElement The element to be replaced.
+ * @param newTagName The new tag name to use.
+ * @returns The newly created element with the new tag name.
+ */
+export declare function replaceTagName<K extends keyof HTMLElementTagNameMap>(oldElement: HTMLElement, newTagName: K): HTMLElement;

package/types/Utility/lava.d.ts

@@ -1,4 +1,6 @@
 export declare function resolveMergeFields(template: string, mergeFields: Record<string, unknown>): string;
+/** Determines whether the string potentially has lava variable {{ }} fields in it. */
+export declare function hasLavaVariableFields(template: string): boolean;
 /** Determines whether the string potentially has lava command {% %} fields in it. */
 export declare function hasLavaCommandFields(template: string): boolean;
 /** Determines whether the string potentially has lava shortcode {[ ]} fields in it. */

package/types/Utility/linq.d.ts

@@ -199,6 +199,11 @@ export declare class Enumerable<T> {
      * @param iterableFactory - A factory function that produces an iterable.
      */
     constructor(iterableFactory: () => Iterable<T>);
+    /**
+     * Creates an empty Enumerable.
+     * @returns A new empty Enumerable instance.
+     */
+    static empty<T>(): Enumerable<T>;
     /**
      * Creates an Enumerable from a regular iterable (e.g., Array, Set).
      * @param iterable - An iterable to create the Enumerable from.
@@ -433,26 +438,6 @@ export declare class Enumerable<T> {
      * Enumerable.from([{x: 1}, {x: 5}]).min(e => e.x); // 1
      */
     min(selector: (item: T) => number): number | undefined;
-    /**
-     * Returns the maximum element of the sequence.
-     *
-     * @template T The type of the elements in the sequence.
-     * @param selector A function to project each element to a numeric, comparable value.
-     * @returns The maximum element or `undefined` if the sequence is empty.
-     *
-
-        let maxItem = selector(first.value);
-
-        for (let next = self.next(); !next.done; next = self.next()) {
-            const value = selector(next.value);
-            if (value > maxItem) {
-                maxItem = value;
-            }
-        }
-
-        return maxItem;
-    }
-
     /**
      * Filters the sequence and returns only elements of the specified type.
      * @template U The target type to filter by.

package/types/ViewModels/Blocks/Communication/Chat/ChatConfiguration/chatConfigurationBag.d.ts

@@ -37,6 +37,9 @@ export type ChatConfigurationBag = {
     /** Gets or sets the list of data views that will be used to populate badges in the external chat application. */
     chatBadgeDataViews?: ListItemBag[] | null;
 
+    /** Gets or sets the data view that will be used to determine who has direct message access. */
+    directMessageAccessDataView?: ListItemBag | null;
+
     /** Gets or sets the system default for whether individuals can receive direct messages from anybody in the system. */
     isOpenDirectMessagingAllowed: boolean;
 };

package/types/ViewModels/Blocks/Communication/Chat/ChatView/chatPersonDataBag.d.ts

@@ -35,6 +35,9 @@ export type ChatPersonDataBag = {
     /** Gets or sets a value indicating whether the individual is required to complete age verification before using chat features. */
     isAgeVerificationRequired: boolean;
 
+    /** Gets or sets a value indicating whether direct messaging is allowed for the individual. */
+    isDirectMessagingAllowed: boolean;
+
     /** Gets or sets the unique token used for authentication or session tracking in chat. */
     token?: string | null;
 

package/types/ViewModels/Blocks/Core/DefinedTypeList/definedTypeListOptionsBag.d.ts

@@ -23,6 +23,4 @@
 
 /** The additional configuration options for the Defined Type List block. */
 export type DefinedTypeListOptionsBag = {
-    /** Determines if the category column should be displayed. */
-    showCategoryColumn: boolean;
 };

package/types/ViewModels/Blocks/Engagement/StepProgramDetail/stepStatusBag.d.ts

@@ -26,10 +26,7 @@ import { Guid } from "@Obsidian/Types";
 /** The step status details for the Step Program Detail workflow trigger grid. */
 export type StepStatusBag = {
     /** Gets or sets the unique identifier. */
-    guid?: Guid | null;
-
-    /** Gets or sets the Step Status identifier. */
-    id: number;
+    guid: Guid;
 
     /** Gets or sets a value indicating whether this status is active. */
     isActive: boolean;

package/types/ViewModels/Blocks/Event/RegistrationEntry/persistSessionResponseBag.d.ts

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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 a response containing session persistence details for the Registration Entry block. */
+export type PersistSessionResponseBag = {
+    /** Gets or sets the expiration date and time for the registration session. */
+    expirationDateTime?: string | null;
+
+    /** Gets or sets a value indicating whether the timeout is disabled for the registration instance. */
+    isTimeoutDisabled: boolean;
+
+    /** Gets or sets the number of spots remaining for the registration instance. */
+    spotsRemaining?: number | null;
+};

package/types/ViewModels/Blocks/Group/GroupPlacement/personFiltersBag.d.ts

@@ -0,0 +1,56 @@
+//------------------------------------------------------------------------------
+// <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 { AppliesToPlacementConfiguration } from "@Obsidian/Enums/Group/appliesToPlacementConfiguration";
+import { ComparisonType } from "@Obsidian/Enums/Reporting/comparisonType";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Represents the Person Filters defined from the Placement Configuration Modal. */
+export type PersonFiltersBag = {
+    /** Gets or sets the age value used for filtering. */
+    age?: number | null;
+
+    /** Gets or sets the comparison type used when filtering by age. */
+    ageComparisonType?: ComparisonType | null;
+
+    /** Gets or sets the delimited age range used when the comparison type is Between. */
+    ageRangeDelimited?: string | null;
+
+    /** Gets or sets the placement subset to which the person filters apply. */
+    appliesToPlacementConfiguration?: AppliesToPlacementConfiguration | null;
+
+    /** Gets or sets the campuses selected for filtering. */
+    campuses?: ListItemBag[] | null;
+
+    /** Gets or sets the selected gender filter. */
+    gender?: number | null;
+
+    /** Gets or sets the selected grade used for filtering. */
+    grade?: ListItemBag | null;
+
+    /** Gets or sets the comparison type used when filtering by grade. */
+    gradeComparisonType?: ComparisonType | null;
+
+    /** Gets or sets the data views used to filter people. */
+    persistedDataViews?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Group/GroupPlacement/placementConfigurationSettingsBag.d.ts

@@ -21,6 +21,7 @@
 // </copyright>
 //
 
+import { PersonFiltersBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personFiltersBag";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 
 /**
@@ -55,6 +56,9 @@ export type PlacementConfigurationSettingsBag = {
      */
     includedRegistrationInstanceIds?: string[] | null;
 
+    /** Gets or sets the person-level filters used to limit which people are included in placement. */
+    personFilters?: PersonFiltersBag | null;
+
     /**
      * Gets or sets a value indicating whether [show registration instance name].
      * Note this setting only applies when in Template Mode

package/types/ViewModels/Blocks/Reporting/DynamicData/gridResultsBag.d.ts

@@ -77,14 +77,6 @@ export type GridResultsBag = {
     /** Gets or sets whether the query returns a list of people. */
     isPersonReport: boolean;
 
-    /**
-     * Gets or sets the field that will be used to uniquely identify each row.
-     * 
-     * This may be a simple field name (i.e. "id") or a dot-separated path to the
-     * key value within a particular field's object (i.e. "person.idKey").
-     */
-    keyField?: string | null;
-
     /**
      * Gets or sets the field that will contain the person key.
      * 

package/types/ViewModels/Rest/Controls/emailEditorGetGroupOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/** Bag containing the information needed to get a group from the Email Editor control. */
+export type EmailEditorGetGroupOptionsBag = {
+    /** Gets or sets the group unique identifier used for retrieving the group. */
+    groupGuid: Guid;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};