@rockrms/obsidian-framework 1.16.9-rc.1 → 17.0.43

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

@@ -0,0 +1,126 @@
+//------------------------------------------------------------------------------
+// <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";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+import { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+/** The item details for the Content Channel Detail block. */
+export type ContentChannelBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the author attribute unique identifier. */
+    authorAttributeGuid?: Guid | null;
+
+    /**
+     * Gets or sets the collection of Categories that this Content Channel is associated with.
+     * NOTE: Since changes to Categories aren't tracked by ChangeTracker, set the ModifiedDateTime if Categories are modified.
+     */
+    categories?: ListItemBag[] | null;
+
+    /** Gets or sets the channel URL. */
+    channelUrl?: string | null;
+
+    /** Gets or sets the collection of ContentChannels that this ContentChannel allows as children. */
+    childContentChannels?: ListItemBag[] | null;
+
+    /** Gets or sets a value indicating whether child items are manually ordered or not */
+    childItemsManuallyOrdered: boolean;
+
+    /** Gets or sets the type of the content channel. */
+    contentChannelType?: ListItemBag | null;
+
+    /** Gets or sets the type of the control to render when editing content for items of this type. */
+    contentControlType: number;
+
+    /** Gets or sets the description. */
+    description?: string | null;
+
+    /** Gets or sets a value indicating whether [enable personalization]. */
+    enablePersonalization: boolean;
+
+    /** Gets or sets a value indicating whether [enable RSS]. */
+    enableRss: boolean;
+
+    /** Gets or sets the icon CSS class. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets the image attribute unique identifier. */
+    imageAttributeGuid?: Guid | null;
+
+    /** Gets or sets a value indicating whether this instance is content library enabled. */
+    isContentLibraryEnabled: boolean;
+
+    /** Gets or sets a value indicating whether this instance is index enabled. */
+    isIndexEnabled: boolean;
+
+    /** Gets or sets a value indicating whether this content is structured. */
+    isStructuredContent: boolean;
+
+    /** Gets or sets a value indicating whether this instance is tagging enabled. */
+    isTaggingEnabled: boolean;
+
+    /** Gets or sets the item attributes. */
+    itemAttributes?: PublicEditableAttributeBag[] | null;
+
+    /** Gets or sets a value indicating whether items are manually ordered or not */
+    itemsManuallyOrdered: boolean;
+
+    /** Gets or sets the item tag Rock.Model.Category. */
+    itemTagCategory?: ListItemBag | null;
+
+    /** Gets or sets the item URL. */
+    itemUrl?: string | null;
+
+    /** Gets or sets the license type unique identifier. */
+    licenseTypeGuid?: Guid | null;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets a value indicating whether [requires approval]. */
+    requiresApproval: boolean;
+
+    /** Gets or sets the root image directory to use when the HTML control type is used */
+    rootImageDirectory?: string | null;
+
+    /** Gets or sets the settings. */
+    settings?: string[] | null;
+
+    /** Gets or sets the Rock.Model.DefinedValue representing the content channel's structure content tool. */
+    structuredContentToolValue?: ListItemBag | null;
+
+    /** Gets or sets the summary attribute unique identifier. */
+    summaryAttributeGuid?: Guid | null;
+
+    /** Gets or sets the number of minutes a feed can stay cached before refreshing it from the source. */
+    timeToLive?: number | null;
+};

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

@@ -0,0 +1,60 @@
+//------------------------------------------------------------------------------
+// <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 Content Channel Detail block. */
+export type ContentChannelDetailOptionsBag = {
+    /** Gets or sets the available licenses. */
+    availableLicenses?: ListItemBag[] | null;
+
+    /** Gets or sets the content channel list. */
+    contentChannelList?: ListItemBag[] | null;
+
+    /** Gets or sets the content channel types. */
+    contentChannelTypes?: ListItemBag[] | null;
+
+    /** Gets or sets the content control types. */
+    contentControlTypes?: ListItemBag[] | null;
+
+    /** Gets or sets the content library attributes. */
+    contentLibraryAttributes?: ListItemBag[] | null;
+
+    /** Gets or sets the current page URL. */
+    currentPageUrl?: string | null;
+
+    /** Gets or sets a value indicating whether [disable content field]. */
+    disableContentField: boolean;
+
+    /** Gets or sets a value indicating whether there is any approver configured. */
+    isApproverConfigured: boolean;
+
+    /** Gets or sets a value indicating whether the server has index enabled. */
+    isIndexEnabled: boolean;
+
+    /** Gets or sets a value indicating whether the organization's store is configured */
+    isOrganizationConfigured: boolean;
+
+    /** Gets or sets the settings options. */
+    settingsOptions?: ListItemBag[] | null;
+};

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

@@ -0,0 +1,60 @@
+//------------------------------------------------------------------------------
+// <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 { ContentChannelDateType } from "@Obsidian/Enums/Cms/contentChannelDateType";
+import { Guid } from "@Obsidian/Types";
+
+/** The additional configuration options for the Content Channel Item List block. */
+export type ContentChannelItemListOptionsBag = {
+    contentChannelId: number;
+
+    contentItemName?: string | null;
+
+    dateType: ContentChannelDateType;
+
+    includeTime: boolean;
+
+    isContentLibraryEnabled: boolean;
+
+    isManuallyOrdered: boolean;
+
+    libraryLicenseGuid: Guid;
+
+    libraryLicenseName?: string | null;
+
+    showExpireDateTimeColumn: boolean;
+
+    showFilters: boolean;
+
+    showOccurrencesColumn: boolean;
+
+    showPriorityColumn: boolean;
+
+    showReorderColumn: boolean;
+
+    showSecurityColumn: boolean;
+
+    showStartDateTimeColumn: boolean;
+
+    showStatusColumn: boolean;
+};

package/types/ViewModels/Blocks/Cms/ContentChannelList/contentChannelListOptionsBag.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 { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The additional configuration options for the Content Channel List block. */
+export type ContentChannelListOptionsBag = {
+    /** Gets or sets the available content channel types for the Content Channel Type filter. */
+    contentChannelTypeItems?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Cms/ContentChannelTypeDetail/contentChannelTypeBag.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 { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+import { PublicEditableAttributeBag } from "@Obsidian/ViewModels/Utility/publicEditableAttributeBag";
+
+/** The item details for the Content Channel Type Detail block. */
+export type ContentChannelTypeBag = {
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the channel attributes. */
+    channelAttributes?: PublicEditableAttributeBag[] | null;
+
+    /** Gets or sets an Rock.Model.ContentChannelDateType enumeration that represents the type of date range that this DateRangeTypeEnum supports. */
+    dateRangeType: number;
+
+    /** Gets or sets a value indicating whether [disable content field]. */
+    disableContentField: boolean;
+
+    /** Gets or sets a value indicating whether [disable priority]. */
+    disablePriority: boolean;
+
+    /**
+     * Gets or sets a value indicating whether [disable status].
+     * If this is set to True, all of the ContentChannelItems are "Approved"
+     */
+    disableStatus: boolean;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether time should be included with the single or date range values */
+    includeTime: boolean;
+
+    /** Gets or sets a flag indicating if this ContentType is part of the Rock core system/framework.  */
+    isSystem: boolean;
+
+    /** Gets or sets the item attributes. */
+    itemAttributes?: PublicEditableAttributeBag[] | null;
+
+    /** Gets or sets the name of the ContentType. This property is required. */
+    name?: string | null;
+
+    /**
+     * A flag indicating if a Rock.Model.ContentChannel of this ContentChannelType will be shown in the content channel list.
+     * When false, it means any 'Channel Types Include' settings MUST specifically include in order to show it.
+     */
+    showInChannelList: boolean;
+};

package/types/ViewModels/Blocks/Cms/ContentChannelTypeDetail/contentChannelTypeDetailOptionsBag.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>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** The additional configuration options for the Content Channel Type Detail block. */
+export type ContentChannelTypeDetailOptionsBag = {
+    dateRangeTypes?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Cms/ContentChannelTypeList/contentChannelTypeListOptionsBag.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 Channel Type List block. */
+export type ContentChannelTypeListOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionView/customSettingsBag.d.ts

@@ -29,6 +29,9 @@ import { FilterOptionsBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollect
  * Content Collection View block.
  */
 export type CustomSettingsBag = {
+    /** Gets or sets a value indicating whether to auto focus on the searchbar. */
+    autoFocus: boolean;
+
     /**
      * Gets or sets a value indicating whether results with matching
      * request segments should be boosted.

package/types/ViewModels/Blocks/Cms/LogSettings/logSettingsBag.d.ts

@@ -0,0 +1,80 @@
+//------------------------------------------------------------------------------
+// <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 item details for the Rock Settings block. */
+export type LogSettingsBag = {
+    /**
+     * Gets or sets the advanced settings as a JSON object that conforms
+     * to the standard Microsoft logging syntax. The root object should be
+     * the "Logging" node - meaning "LogLevel" should be one of the keys
+     * defined at the root of this object.
+     */
+    advancedSettings?: string | null;
+
+    /** Gets or sets the attributes. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /**
+     * Gets or sets the standard categories to log. These will be logged
+     * at the level specified by Rock.ViewModels.Blocks.Cms.LogSettings.LogSettingsBag.StandardLogLevel.
+     */
+    categories?: string[] | null;
+
+    /** Gets or sets the custom categories. */
+    customCategories?: string[] | null;
+
+    /** Gets or sets the identifier key of this entity. */
+    idKey?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether Rock will write logs to the
+     * local file system.
+     */
+    isLocalLoggingEnabled: boolean;
+
+    /**
+     * Gets or sets a value indicating whether Rock will write logs to the
+     * Observability framework.
+     */
+    isObservabilityLoggingEnabled: boolean;
+
+    /** Gets or sets the maximum size of the file. */
+    maxFileSize?: string | null;
+
+    /** Gets or sets the number of log files. */
+    numberOfLogFiles?: string | null;
+
+    /** Gets or sets the selected categories. */
+    selectedCategories?: string[] | null;
+
+    /**
+     * Gets or sets the log level to use for all categories that are
+     * enabled for standard logging.
+     */
+    standardLogLevel?: string | null;
+};

package/types/ViewModels/Blocks/Cms/LogSettings/logSettingsDetailOptionsBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <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 Rock Settings block. */
+export type LogSettingsDetailOptionsBag = {
+    /** Gets or sets the standard categories. */
+    standardCategories?: ListItemBag[] | null;
+
+    /** Gets or sets the verbosity levels. */
+    verbosityLevels?: ListItemBag[] | null;
+};

package/types/ViewModels/Blocks/Cms/MediaAccountList/mediaAccountListOptionsBag.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 Media Account List block. */
+export type MediaAccountListOptionsBag = {
+};

package/types/ViewModels/Blocks/Cms/MediaFolderList/mediaFolderListOptionsBag.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>
+//
+
+/** The additional configuration options for the Media Folder List block. */
+export type MediaFolderListOptionsBag = {
+    /** Gets or sets a value indicating whether the block should be visible to the media account. */
+    isBlockVisible: boolean;
+
+    mediaAccountName?: string | null;
+};

package/types/ViewModels/Blocks/Cms/PageList/pageListOptionsBag.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 additional configuration options for the Page List block. */
+export type PageListOptionsBag = {
+    /** Determines if the page's ID should be displayed. */
+    showPageId: boolean;
+};

package/types/ViewModels/Blocks/Cms/PageSearch/pageSearchBag.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>
+//
+
+import { PageSearchPageBag } from "@Obsidian/ViewModels/Blocks/Cms/PageSearch/pageSearchPageBag";
+
+/** The additional configuration options for the Page List block. */
+export type PageSearchBag = {
+    pages?: PageSearchPageBag[] | null;
+};