@rockrms/obsidian-framework 18.2.4 → 19.1.8

package/types/ViewModels/Blocks/BulkImport/csvImportGetCsvFieldsResultsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The request parameters for starting a bulk import. */
+export type CsvImportGetCsvFieldsResultsBag = {
+    /** Gets or sets the encrypted root folder path where the file to be deleted resides. */
+    csvColumns?: string[] | null;
+
+    /** Gets or sets the name of the file to be deleted. */
+    personFields?: ListItemBag[] | null;
+
+    /** Number of rows of data in the CSV file. */
+    recordCount: number;
+};

package/types/ViewModels/Blocks/BulkImport/csvImportStartImportOptionsBag.d.ts

@@ -0,0 +1,46 @@
+//------------------------------------------------------------------------------
+// <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 request parameters for importing the CSV data */
+export type CsvImportStartImportOptionsBag = {
+    /** Gets or sets a value indicating whether existing records should be updated if a match is found. */
+    allowUpdatingExisting: boolean;
+
+    /** Gets or sets a map of Person fields (the key) to the name of the CSV column namee (the value) that the column should be mapped to. */
+    columnMappings?: Record<string, string> | null;
+
+    /** Gets or sets the name of the CSV file with the import data. */
+    fileName?: string | null;
+
+    /**
+     * Gets or sets the number of records that will be imported.
+     * This is used to provide feedback to the user about how many records are being processed.
+     */
+    recordCount: number;
+
+    /** Gets or sets the identifier of the realtime session so messages can be sent to a specific block. */
+    sessionId?: string | null;
+
+    /** Gets or sets the description of the source of the data being imported. */
+    sourceDescription?: string | null;
+};

package/types/ViewModels/Blocks/BulkImport/csvImportValidateMappingsOptionsBag.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 request parameters for validating whether the mappings between */
+export type CsvImportValidateMappingsOptionsBag = {
+    /** Gets or sets a map of Person fields (the key) to the name of the CSV column namee (the value) that the column should be mapped to. */
+    columnMappings?: Record<string, string> | null;
+};

package/types/ViewModels/Blocks/CheckIn/CheckInKiosk/editFamilyResponseBag.d.ts

@@ -43,6 +43,12 @@ export type EditFamilyResponseBag = {
      */
     childRelationship?: ListItemBag | null;
 
+    /**
+     * Controls how the family address field displayed when adding or
+     * editing a family during registration.
+     */
+    displayAddressOnFamilies: RequirementLevel;
+
     /** Determines how the birthdate field will be displayed for adults. */
     displayBirthdateForAdults: RequirementLevel;
 

package/types/ViewModels/Blocks/CheckIn/Manager/CheckInContextSetter/checkInContextSetterOptionsBag.d.ts

@@ -0,0 +1,59 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/** The initialization options for the Check-in Context Setter block. */
+export type CheckInContextSetterOptionsBag = {
+    /** The list of campuses to display in the dropdown. */
+    campuses?: ListItemBag[] | null;
+
+    /**
+     * When a context item changes, this will cause the page to redirect
+     * back to itself so that the new context can be applied to legacy
+     * WebForms blocks.
+     */
+    isRedirectRequired: boolean;
+
+    /** The root locations to use for the location picker. */
+    rootLocations?: Record<Guid, Guid> | null;
+
+    /**
+     * The list of schedules that are valid for the currently selected
+     * location.
+     */
+    schedules?: ListItemBag[] | null;
+
+    /** The security grant token to use when loading additional data. */
+    securityGrantToken?: string | null;
+
+    /** The selected campus when the block loaded. */
+    selectedCampus?: ListItemBag | null;
+
+    /** The selected location when the block loaded. */
+    selectedLocation?: ListItemBag | null;
+
+    /** The selected schedule when the block loaded. */
+    selectedSchedule?: ListItemBag | null;
+};

package/types/ViewModels/Blocks/CheckIn/Manager/Roster/rosterAttendanceBag.d.ts

@@ -0,0 +1,74 @@
+//------------------------------------------------------------------------------
+// <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 { CheckInStatus } from "@Obsidian/Enums/Event/checkInStatus";
+import { RosterAttendeeBag } from "@Obsidian/ViewModels/Blocks/CheckIn/Manager/Roster/rosterAttendeeBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Represents a single attendance record on the roster. */
+export type RosterAttendanceBag = {
+    /** The name and identifier of the area the individual checked in to. */
+    area?: ListItemBag | null;
+
+    /** The attendee associated with this attendance record. */
+    attendee?: RosterAttendeeBag | null;
+
+    /** The date and time the individual checked in. */
+    checkInTime?: string | null;
+
+    /** The date and time the individual was checked out. */
+    checkoutTime?: string | null;
+
+    /** The security code included on the individual's nametag. */
+    code?: string | null;
+
+    /** The name and identifier of the group the individual checked in to. */
+    group?: ListItemBag | null;
+
+    /** The encoded identifier for the attendance record. */
+    idKey?: string | null;
+
+    /** Determines if checkout is supported for this attendance record. */
+    isCheckoutSupported: boolean;
+
+    /**
+     * Determines if this attendance record represents the individual's first
+     * ever check-in record.
+     */
+    isFirstTime: boolean;
+
+    /**
+     * Determines if presence tracking is supported for this attendance
+     * record.
+     */
+    isPresenceSupported: boolean;
+
+    /** The date and time the individual was marked as present in the room. */
+    presentTime?: string | null;
+
+    /** The name and identifier of the schedule the individual checked in to. */
+    schedule?: ListItemBag | null;
+
+    /** The current status of the attendance record. */
+    status: CheckInStatus;
+};

package/types/ViewModels/Blocks/CheckIn/Manager/Roster/rosterAttendeeBadgeBag.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>
+//
+
+/**
+ * A custom badge for a roster attendee. This is typically used to show
+ * special statuses based on attributes or data view membership.
+ */
+export type RosterAttendeeBadgeBag = {
+    /** The CSS color for the badge. */
+    color?: string | null;
+
+    /** The CSS class for the icon to display in the badge. */
+    iconCssClass?: string | null;
+
+    /** The tooltip text that will describe the details of the badge. */
+    text?: string | null;
+};

package/types/ViewModels/Blocks/CheckIn/Manager/Roster/rosterAttendeeBag.d.ts

@@ -0,0 +1,46 @@
+//------------------------------------------------------------------------------
+// <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 { RosterAttendeeBadgeBag } from "@Obsidian/ViewModels/Blocks/CheckIn/Manager/Roster/rosterAttendeeBadgeBag";
+
+/** Represents an attendee on the attendance record. */
+export type RosterAttendeeBag = {
+    /** The collection of badges that should be displayed for the attendee. */
+    badges?: RosterAttendeeBadgeBag[] | null;
+
+    /** The person's full name. */
+    fullName?: string | null;
+
+    /** The unique identifier for the person. */
+    guid: Guid;
+
+    /** The encoded identifier for the person. */
+    idKey?: string | null;
+
+    /** The name of the person's parents. */
+    parents?: string | null;
+
+    /** The URL that points to the person's photo. */
+    photoUrl?: string | null;
+};

package/types/ViewModels/Blocks/CheckIn/Manager/Roster/rosterOptionsBag.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>
+//
+
+/** The initialization options for the Roster block. */
+export type RosterOptionsBag = {
+    /**
+     * The error message to display. If this is set, then the block should
+     * not attempt to load any other data.
+     */
+    errorMessage?: string | null;
+
+    /** Determines if the checkout all button should be displayed. */
+    isCheckoutAllEnabled: boolean;
+
+    /**
+     * Determines if the "delete" button should be displayed to allow
+     * deleting an attendance record entirely.
+     */
+    isDeleteButtonEnabled: boolean;
+
+    /** Determines if the "mark all present" button should be displayed. */
+    isMarkAllPresentEnabled: boolean;
+
+    /**
+     * Determines if the "not present" button should be displayed to mark
+     * attendees that are present as no longer present.
+     */
+    isNotPresentButtonEnabled: boolean;
+
+    /**
+     * Determines if the "present" button should be displayed on the
+     * checked-out roster view. The button will always be displayed on the
+     * checked-in roster view.
+     */
+    isPresentButtonEnabled: boolean;
+
+    /** Determines if the "staying for service" button should be displayed. */
+    isStayingButtonEnabled: boolean;
+
+    /** The URL template to use for person profile links. */
+    personPageUrl?: string | null;
+};

package/types/ViewModels/Blocks/Cms/ContentChannelDetail/contentChannelDetailOptionsBag.d.ts

@@ -37,8 +37,12 @@ export type ContentChannelDetailOptionsBag = {
     /** Gets or sets the content control types. */
     contentControlTypes?: ListItemBag[] | null;
 
-    /** Gets or sets the content library attributes. */
-    contentLibraryAttributes?: ListItemBag[] | null;
+    /**
+     * Gets or sets the content library inherited item attributes
+     * from the Content Channel Type. These are provided on initial
+     * load so dropdown selections persist before the async fetch completes.
+     */
+    contentLibraryInheritedItemAttributes?: ListItemBag[] | null;
 
     /** Gets or sets the current page URL. */
     currentPageUrl?: string | null;

package/types/ViewModels/Blocks/Cms/ContentChannelItemList/contentChannelItemListOptionsBag.d.ts

@@ -26,35 +26,60 @@ import { Guid } from "@Obsidian/Types";
 
 /** The additional configuration options for the Content Channel Item List block. */
 export type ContentChannelItemListOptionsBag = {
+    /** Gets or sets the identifier for the content channel. */
     contentChannelId: number;
 
+    /** Gets or sets the name of the content item. */
     contentItemName?: string | null;
 
+    /** Gets or sets the date type for the content channel. */
     dateType: ContentChannelDateType;
 
+    /** Gets or sets whether to include the time in the date/time fields. */
     includeTime: boolean;
 
+    /** Gets or sets whether the content library is enabled. */
     isContentLibraryEnabled: boolean;
 
+    /** Gets or sets whether the items are manually ordered. */
     isManuallyOrdered: boolean;
 
+    /** Gets or sets the unique identifier for the library license. */
     libraryLicenseGuid: Guid;
 
+    /** Gets or sets the name of the library license. */
     libraryLicenseName?: string | null;
 
+    /** Gets or sets whether to show the expiration date/time column. */
     showExpireDateTimeColumn: boolean;
 
+    /** Gets or sets whether to show the filter options. */
     showFilters: boolean;
 
+    /** Gets or sets whether to show the Item URL column. */
+    showItemUrlColumn: boolean;
+
+    /** Gets or sets whether to show the linked media column. */
+    showLinkedMediaColumn: boolean;
+
+    /** Gets or sets whether to show the occurrences column. */
     showOccurrencesColumn: boolean;
 
+    /** Gets or sets whether to show the priority column. */
     showPriorityColumn: boolean;
 
+    /** Gets or sets whether to show the reorder column. */
     showReorderColumn: boolean;
 
+    /** Gets or sets whether to show the security column. */
     showSecurityColumn: boolean;
 
+    /** Gets or sets whether to show the start date/time column. */
     showStartDateTimeColumn: boolean;
 
+    /** Gets or sets whether to show the status column. */
     showStatusColumn: boolean;
+
+    /** Gets or sets whether to show the total views columns. */
+    showTotalViewsColumns: boolean;
 };

package/types/ViewModels/Blocks/Cms/ContentChannelItemList/getLinkedMediaElementsRequestBag.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>
+//
+
+/** A bag that contains information about a request to get linked media elements for the Content Channel Item List block. */
+export type GetLinkedMediaElementsRequestBag = {
+    /** Gets or sets the identifier key of the content channel item. */
+    contentChannelItemIdKey?: string | null;
+};

package/types/ViewModels/Blocks/Cms/ContentChannelItemList/getLinkedMediaElementsResponseBag.d.ts

@@ -0,0 +1,30 @@
+//------------------------------------------------------------------------------
+// <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 { LinkedMediaElementBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentChannelItemList/linkedMediaElementBag";
+
+/** A bag that contains information about linked media elements for the Content Channel Item List block. */
+export type GetLinkedMediaElementsResponseBag = {
+    /** Gets or sets the list of linked media elements. */
+    linkedMediaElements?: LinkedMediaElementBag[] | null;
+};

package/types/ViewModels/Blocks/Cms/ContentChannelItemList/linkedMediaElementBag.d.ts

@@ -0,0 +1,32 @@
+//------------------------------------------------------------------------------
+// <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 bag that contains information about a linked media element for the Content Channel Item List block. */
+export type LinkedMediaElementBag = {
+    id?: number | null;
+
+    idKey?: string | null;
+
+    /** Gets or sets the name of this linked media element. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionList/contentCollectionListOptionsBag.d.ts

@@ -0,0 +1,26 @@
+//------------------------------------------------------------------------------
+// <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 additional configuration options for the Content Collection List block. */
+export type ContentCollectionListOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/FileEditor/fileEditorBag.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 a container for file-related information, including the file's path, name, and contents. */
+export type FileEditorBag = {
+    /** Gets or sets the contents of the file as a string. */
+    fileContents?: string | null;
+
+    /** Gets or sets the file path associated with the operation. */
+    filePath?: string | null;
+};