@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Cms/ContentCollectionDetail/customFieldFilterBag.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 { ContentCollectionFilterControl } from "@Obsidian/Enums/Cms/contentCollectionFilterControl";
+
+/** Represents a single custom field filter for a content collection. */
+export type CustomFieldFilterBag = {
+    /** Gets or sets the type of control to use when displaying this filter. */
+    filterControl: ContentCollectionFilterControl;
+
+    /** Gets or sets the friendly label to use when displaying this filter. */
+    filterLabel?: string | null;
+
+    /** Gets or sets the enabled state of this filter. */
+    isEnabled: boolean;
+
+    /** Gets or sets if multiple selections are allowed. */
+    isMultipleSelection: boolean;
+
+    /** Gets or sets the internal identification key of the field. */
+    key?: string | null;
+
+    /** Gets or sets the names of the sources that make up this filter. */
+    sourceNames?: string[] | null;
+
+    /** Gets or sets the friendly name of the field. */
+    title?: string | null;
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionDetail/filterSettingsBag.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 { ContentCollectionFilterControl } from "@Obsidian/Enums/Cms/contentCollectionFilterControl";
+import { AttributeFilterBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionDetail/attributeFilterBag";
+import { CustomFieldFilterBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionDetail/customFieldFilterBag";
+
+/** Class FilterSettingsBag. */
+export type FilterSettingsBag = {
+    /**
+     * Gets or sets the attributes that are enabled for filtering
+     * and indexing on the content collection.
+     */
+    attributeFilters?: AttributeFilterBag[] | null;
+
+    /** Gets or sets the custom field filters. */
+    customFieldFilters?: CustomFieldFilterBag[] | null;
+
+    /** Gets or sets a value indicating whether full text search should be enabled. */
+    fullTextSearchEnabled: boolean;
+
+    /**
+     * Gets or sets a value indicating whether searching content by year
+     * should be enabled.
+     */
+    yearSearchEnabled: boolean;
+
+    /** Gets or sets the year search filter control. */
+    yearSearchFilterControl: ContentCollectionFilterControl;
+
+    /**
+     * Gets or sets a value that indicates if multiple selection is
+     * used by the year search filter.
+     */
+    yearSearchFilterIsMultipleSelection: boolean;
+
+    /**
+     * Gets or sets the label to use for the filter that allows an
+     * individual to search for content by a specific year.
+     */
+    yearSearchLabel?: string | null;
+};

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

@@ -0,0 +1,79 @@
+//------------------------------------------------------------------------------
+// <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 { SearchFilterBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionView/searchFilterBag";
+import { SearchResultBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionView/searchResultBag";
+
+/**
+ * The box that contains all the initialization information for the
+ * Content Collection View block.
+ */
+export type ContentCollectionInitializationBox = {
+    /** Gets or sets the enabled sort orders options. */
+    enabledSortOrders?: string[] | 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 filters that should be displayed in the filters panel. */
+    filters?: SearchFilterBag[] | null;
+
+    /** Gets or sets the initial results to be displayed when the block loads. */
+    initialResults?: SearchResultBag | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the content to be displayed before the first search. */
+    preSearchContent?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether to show search results
+     * on initial load.
+     */
+    searchOnLoad: boolean;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether the filters panel
+     * should be visible.
+     */
+    showFiltersPanel: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the full text search panel
+     * should be visible.
+     */
+    showFullTextSearch: boolean;
+
+    /** Gets or sets a value indicating whether the sort option should be shown. */
+    showSort: boolean;
+
+    /** Gets or sets the trending term to use when sorting. */
+    trendingTerm?: string | null;
+};

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

@@ -0,0 +1,47 @@
+//------------------------------------------------------------------------------
+// <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";
+
+/**
+ * Contains the details about a single content collection item that can
+ * be picked by the individual in the custom settings for the Content
+ * Collection View block. This extends the standard ListItemBag to include
+ * the filters that are available to be used with this content collection.
+ */
+export type ContentCollectionListItemBag = {
+    /** Gets or sets the category for this item. */
+    category?: string | null;
+
+    /** Gets or sets disabled for this item. */
+    disabled?: boolean | null;
+
+    /** Gets or sets the filters that are available to this content collection. */
+    filters?: ListItemBag[] | null;
+
+    /** Gets or sets the text. */
+    text?: string | null;
+
+    /** Gets or sets the value. */
+    value?: string | null;
+};

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

@@ -0,0 +1,121 @@
+//------------------------------------------------------------------------------
+// <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 { FilterOptionsBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionView/filterOptionsBag";
+
+/**
+ * The settings that will be edited in the custom settings panel for the
+ * Content Collection View block.
+ */
+export type CustomSettingsBag = {
+    /**
+     * Gets or sets a value indicating whether results with matching
+     * request segments should be boosted.
+     */
+    boostMatchingRequestFilters: boolean;
+
+    /**
+     * Gets or sets a value indicating whether results with matching
+     * personalization segments should be boosted.
+     */
+    boostMatchingSegments: boolean;
+
+    /** Gets or sets the content collection that is currently selected. */
+    contentCollection?: Guid | null;
+
+    /**
+     * Gets or sets a value indicating which sort orders are available to
+     * be used by the individual
+     */
+    enabledSortOrders?: string[] | null;
+
+    /** Gets or sets the filters that are configured. */
+    filters?: FilterOptionsBag[] | null;
+
+    /**
+     * Gets or sets a value indicating whether results should be grouped
+     * by source.
+     */
+    groupResultsBySource: boolean;
+
+    /**
+     * Gets or sets the template that will be used to render each individual
+     * search result item.
+     */
+    itemTemplate?: string | null;
+
+    /**
+     * Gets or sets the number of results to return per source. If grouping
+     * is not enabled then this controls the total number of results.
+     */
+    numberOfResults?: number | null;
+
+    /**
+     * Gets or sets the template that will be used to render the content
+     * to display in the search results area before a search happens.
+     */
+    preSearchTemplate?: string | null;
+
+    /** Gets or sets the request filter boost amount. */
+    requestFilterBoostAmount?: number | null;
+
+    /**
+     * Gets or sets the template that will be used to render the search
+     * results container. It must have a div with result-items class
+     * and an optional element with show-more class to act as a show more
+     * button.
+     */
+    resultsTemplate?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether to perform an initial
+     * search if no query string parameters are provided. If query string
+     * parameters are provided then search will always be performed on load.
+     */
+    searchOnLoad: boolean;
+
+    /** Gets or sets the segment boost amount. */
+    segmentBoostAmount?: number | null;
+
+    /**
+     * Gets or sets a value indicating whether the filters panel
+     * should be visible.
+     */
+    showFiltersPanel: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the full text search
+     * panel should be visible.
+     */
+    showFullTextSearch: boolean;
+
+    /**
+     * Gets or sets a value indicating whether the sorting control
+     * should be shown.
+     */
+    showSort: boolean;
+
+    /** Gets or sets the trending term to use when displaying the sort option. */
+    trendingTerm?: string | null;
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionView/customSettingsOptionsBag.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 { ContentCollectionListItemBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionView/contentCollectionListItemBag";
+
+/**
+ * The additional information required to build the custom settings UI
+ * for the Content Collection View block.
+ */
+export type CustomSettingsOptionsBag = {
+    /** Gets or sets the content collection items that can be picked by the individual. */
+    contentCollectionItems?: ContentCollectionListItemBag[] | null;
+};

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

@@ -0,0 +1,41 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Information about a single filter that may be shown in the filter panel. */
+export type FilterOptionsBag = {
+    /** Gets or sets the markup that will be displayed before the filter. */
+    headerMarkup?: string | null;
+
+    /** Gets or sets the display name of the filter. */
+    name?: string | null;
+
+    /** Gets or sets a value indicating whether this filter is shown. */
+    show: boolean;
+
+    /**
+     * The unique key that identifies the filter source. If backed by
+     * an attribute then it will be the value "attr_" followed by the
+     * attribute key.
+     */
+    sourceKey?: string | null;
+};

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

@@ -0,0 +1,49 @@
+//------------------------------------------------------------------------------
+// <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 { ContentCollectionFilterControl } from "@Obsidian/Enums/Cms/contentCollectionFilterControl";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Identifies a single search filter that should be displayed to the
+ * individual for them to limit the results that will be returned.
+ */
+export type SearchFilterBag = {
+    /** Gets or sets the control type to use when rendering the filter. */
+    control: ContentCollectionFilterControl;
+
+    /** Gets or sets the markup to display above the filter control. */
+    headerMarkup?: string | null;
+
+    /**
+     * Gets or sets a value indicating whether this filter supports
+     * multiple selection.
+     */
+    isMultipleSelection: boolean;
+
+    /** Gets or sets the items to allow the individual to pick from. */
+    items?: ListItemBag[] | null;
+
+    /** Gets or sets the label to identify the search filter. */
+    label?: string | null;
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionView/searchQueryBag.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 { SearchOrder } from "@Obsidian/Enums/Blocks/Cms/ContentCollectionView/searchOrder";
+import { Guid } from "@Obsidian/Types";
+
+/**
+ * Defines a query against the content collection for the Content Collection
+ * View block.
+ */
+export type SearchQueryBag = {
+    /** Gets or sets the filter values to use when searching for results. */
+    filters?: Record<string, string> | null;
+
+    /**
+     * Gets or sets the offset to start loading results for. This is used
+     * by the show more feature.
+     */
+    offset?: number | null;
+
+    /** Gets or sets the order to sort results into. */
+    order?: SearchOrder | null;
+
+    /**
+     * Gets or sets the source unique identifier to load results for. This
+     * is used by the show more feature.
+     */
+    sourceGuid?: Guid | null;
+
+    /** Gets or sets the text to use when searching for content. */
+    text?: string | null;
+};

package/types/ViewModels/Blocks/Cms/ContentCollectionView/searchResultBag.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 { SearchResultSourceBag } from "@Obsidian/ViewModels/Blocks/Cms/ContentCollectionView/searchResultSourceBag";
+
+/**
+ * Contains the results of a Search request for the Content Collection
+ * View block.
+ */
+export type SearchResultBag = {
+    /** Gets or sets the sources that results have been generated for. */
+    resultSources?: SearchResultSourceBag[] | null;
+
+    /** Gets or sets the total number of matching results found in the index. */
+    totalResultCount: number;
+};

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

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// <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 source that contains a number of results in response
+ * to a search query.
+ */
+export type SearchResultSourceBag = {
+    /**
+     * Gets or sets a value indicating whether this source has more results
+     * available to load.
+     */
+    hasMore: boolean;
+
+    /** Gets or sets the rendered HTML that describes each of the results. */
+    results?: string[] | null;
+
+    /**
+     * Gets or sets the source unique identifier. This will be an empty
+     * Guid if grouping has not been enabled in the block settings.
+     */
+    sourceGuid?: Guid | null;
+
+    /**
+     * Gets or sets the template to use when rendering the search
+     * results container.
+     */
+    template?: string | null;
+
+    /** Gets or sets the total number of matching results found in the index. */
+    totalResultCount: number;
+};