@rockrms/obsidian-framework 17.6.1 → 18.2.4

package/types/ViewModels/Blocks/Group/GroupPlacement/groupMemberBag.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>
+//
+
+import { PersonBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** Represents a group member with associated role, attributes, person details, and metadata for placement and UI purposes. */
+export type GroupMemberBag = {
+    /** The collection of public attribute metadata for this group member. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** The collection of attribute values associated with this group member. */
+    attributeValues?: Record<string, string> | null;
+
+    /** The date and time when the group member record was added, if available. */
+    dateTimeAdded?: string | null;
+
+    /**
+     * Gets or sets the group member unique identifier.
+     * (TODO: Remove this when Group Member Detail is converted to Obsidian.)
+     */
+    groupMemberId: number;
+
+    /** The encrypted identifier key for the group member. */
+    groupMemberIdKey?: string | null;
+
+    /** The encrypted identifier key for the group role assigned to the member. */
+    groupRoleIdKey?: string | null;
+
+    /** The person associated with this group member. */
+    person?: PersonBag | null;
+};

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

@@ -0,0 +1,75 @@
+//------------------------------------------------------------------------------
+// <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 { PlacementMode } from "@Obsidian/Enums/Group/placementMode";
+import { DestinationGroupTypeRoleBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/destinationGroupTypeRoleBag";
+import { GroupPlacementKeysBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/groupPlacementKeysBag";
+import { PersonBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personBag";
+import { PlacementConfigurationSettingOptionsBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/placementConfigurationSettingOptionsBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * Contains all the initialization data needed to configure and display the group placement block,
+ * including placement settings, roles, attributes, context, and navigation.
+ */
+export type GroupPlacementInitializationBox = {
+    /** Attributes that can be applied to new groups added during placement. */
+    attributesForGroupAdd?: Record<string, PublicAttributeBag> | null;
+
+    /** The URL of the page to return to when navigating "back" from the placement UI. */
+    backPageUrl?: string | null;
+
+    /** A list of group type roles that are available for destination groups during placement. */
+    destinationGroupTypeRoles?: DestinationGroupTypeRoleBag[] | null;
+
+    /** Gets or sets the error message, if any, to be displayed to the user. */
+    errorMessage?: string | null;
+
+    /** Contextual keys that define the placement scope. */
+    groupPlacementKeys?: GroupPlacementKeysBag | null;
+
+    /** Indicates whether the logged in person has edit permissions for the Destination Group Type. */
+    isPersonPermittedToEditGroupType: boolean;
+
+    /** Indicates whether multiple group placements are allowed per person. */
+    isPlacementAllowingMultiple: boolean;
+
+    /** Gets or sets the navigation URLs for common actions like saving, canceling, or navigating to other blocks. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** A set of configuration options that influence how placement is performed and displayed. */
+    placementConfigurationSettingOptions?: PlacementConfigurationSettingOptionsBag | null;
+
+    /** Indicates the mode of placement. */
+    placementMode: PlacementMode;
+
+    /** A list of placement options configured for the current registration template. */
+    registrationTemplatePlacements?: ListItemBag[] | null;
+
+    /** The source person passed in by page parameters, typically the registrant or individual being placed. */
+    sourcePerson?: PersonBag | null;
+
+    /** The title to be displayed on the placement interface. */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Group/GroupPlacement/groupPlacementKeysBag.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>
+//
+
+import { Guid } from "@Obsidian/Types";
+
+/** Represents a collection of contextual keys and identifiers used to scope a group placement session. */
+export type GroupPlacementKeysBag = {
+    /** The encrypted key of the destination group type that defines what kind of group people will be placed into. */
+    destinationGroupTypeIdKey?: string | null;
+
+    /** The encrypted key for the entity set that may define the scope of people or groups involved in the placement. */
+    entitySetIdKey?: string | null;
+
+    /** The GUID of the registration instance, if available. */
+    registrationInstanceGuid?: Guid | null;
+
+    /** The encrypted key for the registration instance associated with the placement. */
+    registrationInstanceIdKey?: string | null;
+
+    /** The GUID of the registration template, if available. */
+    registrationTemplateGuid?: Guid | null;
+
+    /** The encrypted key for the registration template associated with the placement. */
+    registrationTemplateIdKey?: string | null;
+
+    /** The encrypted key representing the specific registration template placement being used. */
+    registrationTemplatePlacementIdKey?: string | null;
+
+    /** The GUID of the source group, if available. */
+    sourceGroupGuid?: Guid | null;
+
+    /** The encrypted key of the source group where individuals are initially associated. */
+    sourceGroupIdKey?: string | null;
+
+    /** The encrypted key of the source group type used to categorize or filter source groups. */
+    sourceGroupTypeIdKey?: string | null;
+};

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

@@ -0,0 +1,62 @@
+//------------------------------------------------------------------------------
+// <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 { Gender } from "@Obsidian/Enums/Crm/gender";
+import { GroupMemberBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/groupMemberBag";
+import { RegistrantBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/registrantBag";
+
+/**
+ * Represents a person involved in a placement process, including basic identity details,
+ * photo, and associated registrants or source group memberships.
+ */
+export type PersonBag = {
+    /**
+     * The Date time the person was added to a specific Destination Group.
+     * (This is only used for date sorting in Obsidian and should not be populated/used in any other way.)
+     */
+    dateTimeAddedToDestinationGroup?: string | null;
+
+    /** The person’s first name. */
+    firstName?: string | null;
+
+    /** The gender of the person. */
+    gender: Gender;
+
+    /** The person’s last name. */
+    lastName?: string | null;
+
+    /** The person’s preferred name or nickname. */
+    nickName?: string | null;
+
+    /** The encrypted key for the person’s unique identifier. */
+    personIdKey?: string | null;
+
+    /** The URL of the person’s profile photo. */
+    photoUrl?: string | null;
+
+    /** A list of registrant records associated with the person, typically used in registration-based placement. */
+    registrants?: RegistrantBag[] | null;
+
+    /** A list of group membership records representing the person’s involvement in source groups. */
+    sourceGroupMembers?: GroupMemberBag[] | 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/placementBag.d.ts

@@ -0,0 +1,29 @@
+//------------------------------------------------------------------------------
+// <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 SMS Conversations Initialization Box */
+export type PlacementBag = {
+    iconCSSClass?: string | null;
+
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Group/GroupPlacement/placementConfigurationSettingOptionsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Represents configurable options available for group placement settings,
+ * including attribute filters and registration instance selections.
+ */
+export type PlacementConfigurationSettingOptionsBag = {
+    /** A list of selectable attributes available on destination groups that can be used for filtering or configuration. */
+    destinationGroupAttributes?: ListItemBag[] | null;
+
+    /** A list of selectable attributes available on destination group members for filtering or display purposes. */
+    destinationGroupMemberAttributes?: ListItemBag[] | null;
+
+    /** A list of registration instances available for selection in placement scenarios using template-based modes. */
+    registrationInstances?: ListItemBag[] | null;
+
+    /** A list of selectable source-side attributes that can be used for filtering or display. */
+    sourceAttributes?: ListItemBag[] | null;
+};

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

@@ -0,0 +1,70 @@
+//------------------------------------------------------------------------------
+// <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 { PersonFiltersBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personFiltersBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Represents the configuration settings used to control various display and filtering behaviors 
+ * in the group placement block.
+ */
+export type PlacementConfigurationSettingsBag = {
+    /** Gets or sets a value indicating whether [show fees]. */
+    areFeesDisplayed: boolean;
+
+    /** Gets or sets a value indicating whether [hide full groups]. */
+    areFullGroupsHidden: boolean;
+
+    /**
+     * Gets or sets a value indicating whether source attributes should also be displayed 
+     * on destination group members for comparison or reference.
+     */
+    areSourceAttributesDisplayedOnDestinationGroupMembers: boolean;
+
+    /** Gets or sets the displayed group attribute ids. */
+    destinationGroupAttributesToDisplay?: string[] | null;
+
+    /** Gets or sets the displayed group member attribute ids. */
+    destinationGroupMemberAttributesToDisplay?: string[] | null;
+
+    /** Gets or sets the displayed campus identifier. */
+    displayedCampus?: ListItemBag | null;
+
+    /**
+     * Gets or sets the included registration instance ids.
+     * Note this setting only applies when in Template Mode
+     */
+    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
+     */
+    showRegistrationInstanceName: boolean;
+
+    /** Gets or sets the displayed registrant attribute ids. */
+    sourceAttributesToDisplay?: string[] | null;
+};

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

@@ -0,0 +1,65 @@
+//------------------------------------------------------------------------------
+// <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 { GroupMemberBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/groupMemberBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** A bag of data representing a group in the placement process. */
+export type PlacementGroupBag = {
+    /** The group attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** The group attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** The group capacity. */
+    groupCapacity?: number | null;
+
+    /** The group GUID. */
+    groupGuid: Guid;
+
+    /** The group ID. */
+    groupId: number;
+
+    /** The group ID key. */
+    groupIdKey?: string | null;
+
+    /** The group members. */
+    groupMembers?: GroupMemberBag[] | null;
+
+    /** The group name. */
+    groupName?: string | null;
+
+    /** The group order. */
+    groupOrder: number;
+
+    /** The group type ID key. */
+    groupTypeIdKey?: string | null;
+
+    /** Whether the group is shared. */
+    isShared: boolean;
+
+    /** The registration instance ID key. */
+    registrationInstanceIdKey?: string | null;
+};

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

@@ -0,0 +1,35 @@
+//------------------------------------------------------------------------------
+// <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 { PlacementGroupTypeRoleBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/placementGroupTypeRoleBag";
+
+/** The SMS Conversations Initialization Box */
+export type PlacementGroupTypeBag = {
+    iconCSSClass?: string | null;
+
+    idKey?: string | null;
+
+    name?: string | null;
+
+    roles?: PlacementGroupTypeRoleBag[] | null;
+};

package/types/ViewModels/Blocks/Group/GroupPlacement/placementPeopleBag.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>
+//
+
+import { PersonBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/personBag";
+import { PlacementGroupBag } from "@Obsidian/ViewModels/Blocks/Group/GroupPlacement/placementGroupBag";
+
+/** A bag containing temporary groups and people available for placement. */
+export type PlacementPeopleBag = {
+    /** The people to place. */
+    peopleToPlace?: PersonBag[] | null;
+
+    /** The temporary groups. */
+    tempGroups?: PlacementGroupBag[] | null;
+};

package/types/ViewModels/Blocks/Group/GroupPlacement/realTimeConnectionKeysBag.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 { Guid } from "@Obsidian/Types";
+
+/** A bag of keys used to subscribe a client to real-time group placement updates. */
+export type RealTimeConnectionKeysBag = {
+    /** The connection ID. */
+    connectionId?: string | null;
+
+    /** The group GUIDs. */
+    groupGuids?: Guid[] | null;
+
+    /** The registration instance GUID. */
+    registrationInstanceGuid?: Guid | null;
+
+    /** The registration template GUID. */
+    registrationTemplateGuid?: Guid | null;
+};