@rockrms/obsidian-framework 18.2.4 → 19.1.8

package/types/ViewModels/Blocks/Connection/ConnectionTypeNavigation/connectionFavoriteOpportunityGroupBag.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 { ConnectionFavoriteOpportunityBag } from "@Obsidian/ViewModels/Blocks/Connection/ConnectionTypeNavigation/connectionFavoriteOpportunityBag";
+
+/**
+ * A bag that contains a group of favorited connection opportunities under a single
+ * connection type for the Connection Type Navigation block.
+ */
+export type ConnectionFavoriteOpportunityGroupBag = {
+    /** Gets or sets the IdKey of the connection type that groups these favorited opportunities. */
+    connectionTypeIdKey?: string | null;
+
+    /** Gets or sets the name of the connection type. */
+    connectionTypeName?: string | null;
+
+    /**
+     * Gets or sets the favorited connection opportunities within this connection type,
+     * ordered alphabetically by name.
+     */
+    opportunities?: ConnectionFavoriteOpportunityBag[] | null;
+};

package/types/ViewModels/Blocks/Connection/ConnectionTypeNavigation/connectionTypeNavigationInitializationBox.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 { ConnectionFavoriteOpportunityGroupBag } from "@Obsidian/ViewModels/Blocks/Connection/ConnectionTypeNavigation/connectionFavoriteOpportunityGroupBag";
+import { ConnectionTypeSummaryBag } from "@Obsidian/ViewModels/Blocks/Connection/ConnectionTypeNavigation/connectionTypeSummaryBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The box that contains all the initialization information for the connection type navigation block. */
+export type ConnectionTypeNavigationInitializationBox = {
+    /** Gets or sets the list of connection type summaries to display. */
+    connectionTypeSummaries?: ConnectionTypeSummaryBag[] | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /**
+     * Gets or sets the favorited connection opportunities for the current person,
+     * grouped by connection type and ordered by type order then opportunity name.
+     */
+    favoriteOpportunityGroups?: ConnectionFavoriteOpportunityGroupBag[] | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets whether to show the configure connection types button. */
+    showConfigureConnectionTypesButton: boolean;
+
+    /** Gets or sets the list of connection type visibility items the individual may select. */
+    typeVisibilityItems?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Connection/ConnectionTypeNavigation/connectionTypeSummaryBag.d.ts

@@ -0,0 +1,73 @@
+//------------------------------------------------------------------------------
+// <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 { EnabledViewFlags } from "@Obsidian/Enums/Connection/enabledViewFlags";
+
+/** A bag that contains information about a connection type summary for the Connection Type Navigation block. */
+export type ConnectionTypeSummaryBag = {
+    /** Gets or sets the count of active connection requests for all connection opportunities of this type. */
+    activeRequestCount: number;
+
+    /** Gets or sets the count of connection requests assigned to the current person for all connection opportunities of this type. */
+    assignedToYouRequestCount: number;
+
+    /** Gets or sets the description for this connection type. */
+    description?: string | null;
+
+    /** Gets or sets the count of "due soon" connection requests for all connection opportunities of this type. */
+    dueSoonRequestCount: number;
+
+    /** Gets or sets the enabled views for this connection type. */
+    enabledViews: EnabledViewFlags;
+
+    /** Gets or sets the icon CSS class for this connection type. */
+    iconCssClass?: string | null;
+
+    id?: number | null;
+
+    idKey?: string | null;
+
+    /** Gets whether board view is enabled for this connection type. */
+    isBoardViewEnabled: boolean;
+
+    /** Gets whether board view is enabled for this connection type. */
+    isGridViewEnabled: boolean;
+
+    /** Gets whether list view is enabled for this connection type. */
+    isListViewEnabled: boolean;
+
+    /** Gets whether snapshot view is enabled for this connection type. */
+    isSnapshotViewEnabled: boolean;
+
+    /** Gets or sets the name for this connection type. */
+    name?: string | null;
+
+    /** Gets or sets the order for this connection type. */
+    order: number;
+
+    /** Gets or sets the count of overdue connection requests for all connection opportunities of this type. */
+    overdueRequestCount: number;
+
+    /** Gets or sets the count of unassigned connection requests for all connection opportunities of this type. */
+    unassignedRequestCount: number;
+};

package/types/ViewModels/Blocks/Core/AttributeCategoryList/attributeCategoryBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The bag that contains the editable fields for an attribute category. */
+export type AttributeCategoryBag = {
+    /** Gets or sets the description of the category. */
+    description?: string | null;
+
+    /**
+     * Gets or sets the entity type associated with this category.
+     * A null value indicates this is a Global Attributes category.
+     */
+    entityType?: ListItemBag | null;
+
+    /** Gets or sets the highlight color for the category. */
+    highlightColor?: string | null;
+
+    /** Gets or sets the CSS class for the category's icon. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the encrypted identifier key for the category. */
+    idKey?: string | null;
+
+    /** Gets or sets the name of the category. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Core/AttributeCategoryList/attributeCategoryListOptionsBag.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 Attribute Category List block. */
+export type AttributeCategoryListOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/BinaryFileTypeDetail/binaryFileTypeBag.d.ts

@@ -57,6 +57,9 @@ export type BinaryFileTypeBag = {
     /** Gets or sets the identifier key of this entity. */
     idKey?: string | null;
 
+    /** Gets or sets a value indicating whether the type is publicly viewable. */
+    isPublicViewable: boolean;
+
     /** Gets or sets a flag indicating if this BinaryFileType is part of the Rock core system/framework. This property is required. */
     isSystem: boolean;
 

package/types/ViewModels/Blocks/Core/CampusContextSetter/campusContextSetterOptionsBag.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 initialization options for the Campus Context Setter block. */
+export type CampusContextSetterOptionsBag = {
+    /** The alignment of the dropdown. 1 = Left, 2 = Right. */
+    alignment: number;
+
+    /** The list of campuses to display in the dropdown. */
+    campuses?: ListItemBag[] | null;
+
+    /** The text to display as the current selection. */
+    currentSelectionText?: string | null;
+};

package/types/ViewModels/Blocks/Core/CampusDetail/campusBag.d.ts

@@ -55,6 +55,12 @@ export type CampusBag = {
     /** Gets or sets the closed date. */
     closedDate?: string | null;
 
+    /** Gets or sets the specially handled core attributes. */
+    coreAttributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the specially handled core attribute values. */
+    coreAttributeValues?: Record<string, string> | null;
+
     /** Gets or sets the description. */
     description?: string | null;
 

package/types/ViewModels/Blocks/Core/ComponentList/componentListEditBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/**
+ * The data bag returned when editing a component's attributes in the
+ * Component List block.
+ */
+export type ComponentListEditBag = {
+    /**
+     * Gets or sets the public attribute definitions for the component,
+     * keyed by attribute key.
+     */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /**
+     * Gets or sets the public attribute values for the component,
+     * keyed by attribute key.
+     */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets a value indicating whether to show the SMTP warning. */
+    isSmtpTransport: boolean;
+
+    /** Gets or sets the friendly name of the component being edited. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Core/ComponentList/componentListOptionsBag.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>
+//
+
+/** The options bag for the Component List block. */
+export type ComponentListOptionsBag = {
+    /**
+     * Gets or sets a value indicating whether ordering is supported.
+     * When true and the individual has Administrate access, a
+     * reorder column is displayed in the grid.
+     */
+    isSupportOrdering: boolean;
+
+    /**
+     * Gets or sets a value indicating whether per-component security is supported.
+     * When true and the individual has Administrate access, a
+     * security button is displayed for each row.
+     */
+    isSupportSecurity: boolean;
+};

package/types/ViewModels/Blocks/Core/ComponentList/componentListRowBag.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 { Guid } from "@Obsidian/Types";
+
+/** A single row in the Component List grid representing a MEF component. */
+export type ComponentListRowBag = {
+    /** Gets or sets the description of the component. */
+    description?: string | null;
+
+    /**
+     * Gets or sets the EntityType identifier for this component,
+     * used to display per-component security.
+     */
+    entityTypeId: number;
+
+    /**
+     * Gets or sets the EntityType GUID for this component. Used as
+     * the row identifier for the grid.
+     */
+    guid: Guid;
+
+    /** Gets or sets a value indicating whether the component is active. */
+    isActive: boolean;
+
+    /** Gets or sets the friendly name of the component. */
+    name?: string | null;
+};

package/types/ViewModels/Blocks/Core/DocumentTypeDetail/documentTypeBag.d.ts

@@ -61,6 +61,9 @@ export type DocumentTypeBag = {
     /** Gets or sets the IsImage flag for the Rock.Model.DocumentType. */
     isImage: boolean;
 
+    /** Gets or sets a value indicating whether the type is publicly viewable. */
+    isPublicViewable: boolean;
+
     /** Gets or sets a flag indicating if this DocumentType is part of the Rock core system/framework. This property is required. */
     isSystem: boolean;
 

package/types/ViewModels/Blocks/Core/ExceptionDetail/exceptionDetailBag.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 { ExceptionLogItemBag } from "@Obsidian/ViewModels/Blocks/Core/ExceptionDetail/exceptionLogItemBag";
+
+/** The bag containing the data for the Exception Detail block. */
+export type ExceptionDetailBag = {
+    /** Gets or sets the raw HTML content of the cookies at the time of the exception. */
+    cookies?: string | null;
+
+    /** Gets or sets the ordered list of inner (non-root) exception log items. */
+    innerExceptions?: ExceptionLogItemBag[] | null;
+
+    /** Gets or sets the root (outermost) exception's display data. */
+    rootException?: ExceptionLogItemBag | null;
+
+    /** Gets or sets the raw HTML content of the server variables at the time of the exception. */
+    serverVariables?: string | null;
+};

package/types/ViewModels/Blocks/Core/ExceptionDetail/exceptionDetailOptionsBag.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 Exception Detail block. */
+export type ExceptionDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Core/ExceptionDetail/exceptionLogItemBag.d.ts

@@ -0,0 +1,66 @@
+//------------------------------------------------------------------------------
+// <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 an individual exception log entry in the exception hierarchy. */
+export type ExceptionLogItemBag = {
+    /** Gets or sets the exception message. */
+    description?: string | null;
+
+    /** Gets or sets the formatted date/time when this exception occurred. */
+    exceptionDate?: string | null;
+
+    /** Gets or sets the exception class name (e.g., "System.Web.HttpException"). */
+    exceptionType?: string | null;
+
+    /** Gets or sets the identifier of this exception log entry. */
+    id: number;
+
+    /** Gets or sets the internal name of the page where this exception occurred. */
+    pageName?: string | null;
+
+    /** Gets or sets the URL of the page where this exception occurred. */
+    pageUrl?: string | null;
+
+    /** Gets or sets the full name of the person who triggered this exception. */
+    personFullName?: string | null;
+
+    /**
+     * Gets or sets the IdKey of the person who triggered this exception,
+     * used for linking to the person's profile page.
+     */
+    personIdKey?: string | null;
+
+    /** Gets or sets the parsed query string items as key-value pairs. */
+    queryStringItems?: ListItemBag[] | null;
+
+    /** Gets or sets the name of the site where this exception occurred. */
+    siteName?: string | null;
+
+    /** Gets or sets the source application or object that threw the exception. */
+    source?: string | null;
+
+    /** Gets or sets the call stack trace for this exception. */
+    stackTrace?: string | null;
+};

package/types/ViewModels/Blocks/Core/ExceptionOccurrenceList/exceptionOccurrenceListOptionsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The additional configuration options for the Exception Occurrence List block. */
+export type ExceptionOccurrenceListOptionsBag = {
+    /** Gets or sets the full description from the template exception. */
+    description?: string | null;
+
+    /**
+     * Gets or sets the exception type name from the template exception
+     * (e.g., "System.Web.HttpException").
+     */
+    exceptionType?: string | null;
+
+    /** Gets or sets the list of available sites for the filter dropdown. */
+    siteItems?: ListItemBag[] | null;
+};