@rockrms/obsidian-framework 1.16.3-rc.1

package/types/ViewModels/Blocks/Workflow/WorkflowTriggerDetail/workflowTriggerDetailBox.d.ts

@@ -0,0 +1,50 @@
+//------------------------------------------------------------------------------
+// <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 { WorkflowTriggerBag } from "@Obsidian/ViewModels/Blocks/Workflow/WorkflowTriggerDetail/workflowTriggerBag";
+
+export type WorkflowTriggerDetailBox = {
+    /** Gets or sets the entity. */
+    entity?: WorkflowTriggerBag | 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 a value indicating whether this instance is editable. */
+    isEditable: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the readonly notification message. */
+    readonlyNotificationMessage?: string | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the valid properties. */
+    validProperties?: string[] | null;
+};

package/types/ViewModels/Blocks/blockActionContextBag.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>
+//
+
+/**
+ * The data structure of the __context parameter included with block
+ * action requests.
+ */
+export type BlockActionContextBag = {
+    /** Gets or sets the captcha that should be validated by the server. */
+    captcha?: string | null;
+
+    /**
+     * Gets or sets the page parameters that the page was originally
+     * loaded with.
+     */
+    pageParameters?: Record<string, string> | null;
+};

package/types/ViewModels/Blocks/blockBox.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>
+//
+
+/** The information required to render a generic block. */
+export type BlockBox = {
+    /**
+     * 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 navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/customSettingsBox.d.ts

@@ -0,0 +1,40 @@
+//------------------------------------------------------------------------------
+// <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 box that contains the required information to render a custom
+ * settings component.
+ */
+export type CustomSettingsBox<TSettings, TOptions> = {
+    /** Gets or sets the options. */
+    options?: TOptions | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the data. */
+    settings?: TSettings | null;
+
+    /** Gets or sets the valid properties. */
+    validProperties?: string[] | null;
+};

package/types/ViewModels/Blocks/detailBlockBox.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>
+//
+
+/** The information required to render a standard detail block. */
+export type DetailBlockBox<TEntityBag, TOptions> = {
+    /** Gets or sets the entity. */
+    entity?: TEntityBag | 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 a value indicating whether this instance is editable. */
+    isEditable: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the options. */
+    options?: TOptions | null;
+
+    /**
+     * Gets or sets the property names that are referenced by any attribute
+     * qualifiers which might require that attributes be refreshed when they
+     * are modified.
+     */
+    qualifiedAttributeProperties?: string[] | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the valid properties. */
+    validProperties?: string[] | null;
+};

package/types/ViewModels/Blocks/listBlockBox.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 { GridDefinitionBag } from "@Obsidian/ViewModels/Core/Grid/gridDefinitionBag";
+
+/** The information required to render a standard list block. */
+export type ListBlockBox<TOptions> = {
+    /**
+     * 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 expected row count. This is used to determine
+     * optimization settings and also the number of skeleton rows to show.
+     * A value of null implies no fast way to estimate the number
+     * of expected rows.
+     */
+    expectedRowCount?: number | null;
+
+    /** Gets or sets the grid definition. */
+    gridDefinition?: GridDefinitionBag | null;
+
+    /** Gets or sets a value indicating whether add item is enabled. */
+    isAddEnabled: boolean;
+
+    /** Gets or sets a value indicating whether delete is enabled. */
+    isDeleteEnabled: boolean;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the options. */
+    options?: TOptions | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Cms/blockCustomActionBag.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>
+//
+
+/**
+ * Identifies a single custom configuration action/button that will be
+ * made available in a block's configuration bar.
+ */
+export type BlockCustomActionBag = {
+    /**
+     * Gets or sets the URL of the component that will be loaded when
+     * the button is clicked. The component will be added to a hidden
+     * div container. It is expected that the component will display a
+     * modal to handle its user interface.
+     */
+    componentFileUrl?: string | null;
+
+    /** Gets or sets the icon CSS class used to display the button. */
+    iconCssClass?: string | null;
+
+    /** Gets or sets the tooltip text of the button. */
+    tooltip?: string | null;
+};

package/types/ViewModels/Cms/contentCollectionAttributeFilterSettingsBag.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 { ContentCollectionFilterControl } from "@Obsidian/Enums/Cms/contentCollectionFilterControl";
+
+/** The settings for a single attribute filter configured on a content collection. */
+export type ContentCollectionAttributeFilterSettingsBag = {
+    /** Gets or sets the search filter control. */
+    filterControl: ContentCollectionFilterControl;
+
+    /** Gets or sets a value indicating if this search filter is enabled. */
+    isEnabled: boolean;
+
+    /** Gets or sets a value indicating if multiple selection is allowed. */
+    isMultipleSelection: boolean;
+
+    /** Gets or sets the label to use for the filter. */
+    label?: string | null;
+};

package/types/ViewModels/Cms/contentCollectionCustomFieldBag.d.ts

@@ -0,0 +1,44 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/**
+ * Defines a custom field that will be used to store custom data in the
+ * index for an item.
+ */
+export type ContentCollectionCustomFieldBag = {
+    /**
+     * Gets or sets a value indicating whether the value will be treated
+     * as a multi-value field. When enabled the final value will be split
+     * by comma and turned into multiple values.
+     */
+    isMultiple: boolean;
+
+    /** Gets or sets the key used in the item index. */
+    key?: string | null;
+
+    /** Gets or sets the lava template to use when generating custom content. */
+    template?: string | null;
+
+    /** Gets or sets the friendly display title. */
+    title?: string | null;
+};

package/types/ViewModels/Cms/contentCollectionCustomFieldFilterSettingsBag.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 { ContentCollectionFilterControl } from "@Obsidian/Enums/Cms/contentCollectionFilterControl";
+
+/** The settings for a single custom field filter configured on a content collection. */
+export type ContentCollectionCustomFieldFilterSettingsBag = {
+    /** Gets or sets the search filter control. */
+    filterControl: ContentCollectionFilterControl;
+
+    /** Gets or sets a value indicating if this search filter is enabled. */
+    isEnabled: boolean;
+
+    /** Gets or sets a value indicating if multiple selection is allowed. */
+    isMultipleSelection: boolean;
+
+    /** Gets or sets the label to use for the filter. */
+    label?: string | null;
+};

package/types/ViewModels/Cms/contentCollectionFilterSettingsBag.d.ts

@@ -0,0 +1,78 @@
+//------------------------------------------------------------------------------
+// <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 { ContentCollectionAttributeFilterSettingsBag } from "@Obsidian/ViewModels/Cms/contentCollectionAttributeFilterSettingsBag";
+import { ContentCollectionCustomFieldFilterSettingsBag } from "@Obsidian/ViewModels/Cms/contentCollectionCustomFieldFilterSettingsBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/**
+ * Defines the settings used by the Content Collection filters as stored
+ * in the database.
+ */
+export type ContentCollectionFilterSettingsBag = {
+    /**
+     * Gets or sets the attributes that are enabled for filtering
+     * and indexing on the content collection.
+     */
+    attributeFilters?: Record<string, ContentCollectionAttributeFilterSettingsBag> | null;
+
+    /**
+     * Gets or sets the attribute values that have been learned. These
+     * are used to display the known values in the filter panel.
+     */
+    attributeValues?: Record<string, ListItemBag[]> | null;
+
+    /** Gets or sets the custom field filters that are enabled for filtering. */
+    customFieldFilters?: Record<string, ContentCollectionCustomFieldFilterSettingsBag> | null;
+
+    /**
+     * Gets or sets the field values that have been learned. These
+     * are used to display the known values in the filter panel.
+     */
+    fieldValues?: Record<string, ListItemBag[]> | 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/Cms/contentCollectionSourceAdditionalSettingsBag.d.ts

@@ -0,0 +1,43 @@
+//------------------------------------------------------------------------------
+// <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 { ContentCollectionCustomFieldBag } from "@Obsidian/ViewModels/Cms/contentCollectionCustomFieldBag";
+
+/**
+ * The settings that describe additional details about a content collection
+ * source that will be used during indexing.
+ */
+export type ContentCollectionSourceAdditionalSettingsBag = {
+    /**
+     * Gets or sets the attribute unique identifiers that are included
+     * for indexing from this source.
+     */
+    attributeGuids?: Guid[] | null;
+
+    /**
+     * Gets or sets the custom fields that when indexing content for
+     * this source.
+     */
+    customFields?: ContentCollectionCustomFieldBag[] | null;
+};

package/types/ViewModels/Cms/obsidianBlockConfigBag.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 { Guid } from "@Obsidian/Types";
+import { BlockCustomActionBag } from "@Obsidian/ViewModels/Cms/blockCustomActionBag";
+import { ObsidianBlockPreferencesBag } from "@Obsidian/ViewModels/Cms/obsidianBlockPreferencesBag";
+
+/**
+ * Contains the configuration required to initialize an Obsidian block in
+ * the web browser.
+ */
+export type ObsidianBlockConfigBag = {
+    /** Gets or sets the URL used to load the Obsidian block JavaScript file. */
+    blockFileUrl?: string | null;
+
+    /**
+     * Gets or sets the unique identifier of the block that is being
+     * represented by this configuration.
+     */
+    blockGuid?: Guid | null;
+
+    /**
+     * Gets or sets the custom configuration values for the block. This
+     * object is made available to the block component.
+     */
+    configurationValues?: unknown;
+
+    /**
+     * Gets or sets the custom configuration actions that should be added
+     * to the block's configuration bar.
+     */
+    customConfigurationActions?: BlockCustomActionBag[] | null;
+
+    /** Gets or sets the person preferences associated with this block. */
+    preferences?: ObsidianBlockPreferencesBag | null;
+
+    /**
+     * Gets or sets the HTML element identifier that the block will be
+     * mounted on as its root.
+     */
+    rootElementId?: string | null;
+};