@rockrms/obsidian-framework 18.1.0 → 19.1.8

package/types/ViewModels/Rest/Controls/captchaVerifyResultBag.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 results of the CaptchaRedeemChallenge API action of the Captcha control. */
+export type CaptchaVerifyResultBag = {
+    /** Gets or sets the failure message. */
+    error?: string | null;
+
+    /** Gets or sets the token expiration time. */
+    expires?: number | null;
+
+    /** Gets or sets whether the challenge is successful or not. */
+    isVerified: boolean;
+
+    /** Gets or sets the token generated after the challenge is successfully completed. */
+    token?: string | null;
+};

package/types/ViewModels/Rest/Controls/colorPickerGetColorPickerSwatchesOptionsBag.d.ts

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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 that can be passed to the ColorPickerGetColorPickerSwatches API action of
+ * the ColorPicker control.
+ */
+export type ColorPickerGetColorPickerSwatchesOptionsBag = {
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/colorPickerSwatchBag.d.ts

@@ -0,0 +1,34 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Bag containing the swatch information needed for the Color Picker control. */
+export type ColorPickerSwatchBag = {
+    /** Gets or sets the color description. */
+    description?: string | null;
+
+    /** Gets or sets the display location in the color picker. */
+    displayLocation?: string | null;
+
+    /** Gets or sets the color value. */
+    value?: string | null;
+};

package/types/ViewModels/Rest/Controls/connectionRequestPickerGetChildrenOptionsBag.d.ts

@@ -28,6 +28,15 @@ import { Guid } from "@Obsidian/Types";
  * the ConnectionRequestPicker control.
  */
 export type ConnectionRequestPickerGetChildrenOptionsBag = {
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /**
      * Gets or sets the parent unique identifier whose children are to
      * be retrieved. If null then the root items are being requested.

package/types/ViewModels/Rest/Controls/emailEditorEmailSectionBag.d.ts

@@ -26,6 +26,12 @@ import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 
 /** Bag containing the email section information needed for the Email Editor control. */
 export type EmailEditorEmailSectionBag = {
+    /** Gets or sets a value indicating whether the current person can delete this email section. */
+    canDelete: boolean;
+
+    /** Gets or sets a value indicating whether the current person can edit this email section. */
+    canEdit: boolean;
+
     /** Gets or sets the email section category. */
     category?: ListItemBag | null;
 

package/types/ViewModels/Rest/Controls/emailEditorGetGroupOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/** Bag containing the information needed to get a group from the Email Editor control. */
+export type EmailEditorGetGroupOptionsBag = {
+    /** Gets or sets the group unique identifier used for retrieving the group. */
+    groupGuid: Guid;
+
+    /**
+     * Gets or sets the security grant token to use when performing
+     * authorization checks.
+     */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Rest/Controls/entityTypePickerGetEntityTypesOptionsBag.d.ts

@@ -30,4 +30,7 @@ import { Guid } from "@Obsidian/Types";
 export type EntityTypePickerGetEntityTypesOptionsBag = {
     /** List of GUIDs of Entity Types that you wish to include in the list. If blank, it will load all. */
     entityTypeGuids?: Guid[] | null;
+
+    /** List of GUIDs of Entity Types that you wish to exclude from the list. */
+    excludedEntityTypeGuids?: Guid[] | null;
 };

package/types/ViewModels/Rest/Controls/eventItemOccurrencePickerGetEventItemOccurrencesOptionsBag.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 { Guid } from "@Obsidian/Types";
+
+/**
+ * The options that can be passed to the GetEventItems API action of
+ * the EventItemPicker control.
+ */
+export type EventItemOccurrencePickerGetEventItemOccurrencesOptionsBag = {
+    /** The end of the date range to limit occurrences to. */
+    dateRangeEnd?: string | null;
+
+    /** The start of the date range to limit occurrences to. */
+    dateRangeStart?: string | null;
+
+    /** The root calendar to limit the event items to. */
+    eventItem: Guid;
+
+    /** Whether or not to include inactive event items */
+    includeInactive: boolean;
+};

package/types/ViewModels/Rest/Controls/eventItemPickerGetEventItemsOptionsBag.d.ts

@@ -21,11 +21,22 @@
 // </copyright>
 //
 
+import { Guid } from "@Obsidian/Types";
+
 /**
  * The options that can be passed to the GetEventItems API action of
  * the EventItemPicker control.
  */
 export type EventItemPickerGetEventItemsOptionsBag = {
+    /** The end of the date range to limit event items to. */
+    dateRangeEnd?: string | null;
+
+    /** The start of the date range to limit event items to. */
+    dateRangeStart?: string | null;
+
     /** Whether or not to include inactive event items */
     includeInactive: boolean;
+
+    /** The root calendar to limit the event items to. */
+    rootCalendar: Guid;
 };

package/types/ViewModels/Rest/Controls/groupPickerGetChildrenOptionsBag.d.ts

@@ -28,6 +28,18 @@ import { Guid } from "@Obsidian/Types";
  * the GroupMemberPicker control.
  */
 export type GroupPickerGetChildrenOptionsBag = {
+    /** When true, show no groups unless IncludedGroupTypeGuids has values. */
+    excludeAllByDefault: boolean;
+
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /** GUID of the group the member is part of. */
     guid?: Guid | null;
 

package/types/ViewModels/Rest/Controls/groupTypePickerGetGroupTypesOptionsBag.d.ts

@@ -28,6 +28,9 @@ import { Guid } from "@Obsidian/Types";
  * the GroupTypePicker control.
  */
 export type GroupTypePickerGetGroupTypesOptionsBag = {
+    /** List of GUIDs for the group types we want to exclude */
+    excludeGroupTypes?: Guid[] | null;
+
     /** List of GUIDs for the group types we want to retrieve */
     groupTypes?: Guid[] | null;
 

package/types/ViewModels/Rest/Controls/locationItemPickerGetActiveChildrenOptionsBag.d.ts

@@ -43,6 +43,9 @@ export type LocationItemPickerGetActiveChildrenOptionsBag = {
      */
     guid: Guid;
 
+    /** Determines if inactive locations should be included in the results. */
+    includeInactive: boolean;
+
     /**
      * Gets or sets the root location unique identifier. This is used if Rock.ViewModels.Rest.Controls.LocationItemPickerGetActiveChildrenOptionsBag.Guid
      * is empty to specify the root location to limit the tree to.

package/types/ViewModels/Rest/Controls/mergeTemplatePickerGetMergeTemplatesOptionsBag.d.ts

@@ -35,6 +35,15 @@ export type MergeTemplatePickerGetMergeTemplatesOptionsBag = {
      */
     defaultIconCssClass?: string | null;
 
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /** Gets or sets a filter for which merge templates to include in results: Global, Public, or Both */
     mergeTemplateOwnership: MergeTemplateOwnership;
 

package/types/ViewModels/Rest/Controls/metricCategoryPickerGetChildrenOptionsBag.d.ts

@@ -34,6 +34,15 @@ export type MetricCategoryPickerGetChildrenOptionsBag = {
      */
     defaultIconCssClass?: string | null;
 
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /**
      * Gets or sets the parent unique identifier whose children are to
      * be retrieved. If null then the root items are being requested.

package/types/ViewModels/Rest/Controls/pagePickerGetChildrenOptionsBag.d.ts

@@ -28,6 +28,15 @@ import { Guid } from "@Obsidian/Types";
  * the PagePicker control.
  */
 export type PagePickerGetChildrenOptionsBag = {
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /**
      * Gets or sets the unique identifier of the parent page whose
      * children are to be enumerated.

package/types/ViewModels/Rest/Controls/registrationTemplatePickerGetChildrenOptionsBag.d.ts

@@ -28,6 +28,15 @@ import { Guid } from "@Obsidian/Types";
  * the RegistrationTemplatePicker control.
  */
 export type RegistrationTemplatePickerGetChildrenOptionsBag = {
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /**
      * Gets or sets the parent unique identifier whose children are to
      * be retrieved. If null then the root items are being requested.

package/types/ViewModels/Rest/Controls/reportPickerGetChildrenOptionsBag.d.ts

@@ -31,6 +31,15 @@ export type ReportPickerGetChildrenOptionsBag = {
     /** Guid of an Entity Type to filter results by the reports that relate to this entity type. */
     entityTypeGuid?: Guid | null;
 
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /** A list of category GUIDs to filter the results. */
     includeCategoryGuids?: Guid[] | null;
 

package/types/ViewModels/Rest/Controls/schedulePickerGetChildrenOptionsBag.d.ts

@@ -28,6 +28,21 @@ import { Guid } from "@Obsidian/Types";
  * the RegistrationTemplatePicker control.
  */
 export type SchedulePickerGetChildrenOptionsBag = {
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
+    /**
+     * The category unique identifier to filter schedules by.
+     * If null then schedules from all categories are included.
+     */
+    includeCategoryGuids?: Guid[] | null;
+
     /** Whether to include schedules marked as inactive in the results. */
     includeInactiveItems: boolean;
 

package/types/ViewModels/Rest/Controls/workflowActionTypePickerGetChildrenOptionsBag.d.ts

@@ -26,6 +26,15 @@
  * the RegistrationTemplatePicker control.
  */
 export type WorkflowActionTypePickerGetChildrenOptionsBag = {
+    /**
+     * Gets or sets the values that need to be expanded to. This is used
+     * when opening the tree view with an already selected value. Each
+     * selected value is included in this property. When getting the list
+     * of root items, you should automatically expand your results until
+     * each of these values is reached.
+     */
+    expandToValues?: string[] | null;
+
     /**
      * The identifier of the parent folder/category.
      * If null then the folders are being requested.

package/types/ViewModels/Utility/csvImportActivityProgressStatusBag.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>
+//
+
+/** Contains information about the starting or stopping of a task. */
+export type CsvImportActivityProgressStatusBag = {
+    /** The percentage of completion for the task, from 0 to 100. */
+    completionPercentage: number;
+
+    /** An error the task encountered while running. */
+    error?: string | null;
+
+    /** A message indicating the current state of this task. */
+    message?: string | null;
+
+    /** The name of the task. */
+    taskName?: string | null;
+};

package/types/ViewModels/Utility/publicAttributeBag.d.ts

@@ -61,4 +61,10 @@ export type PublicAttributeBag = {
 
     /** Gets or sets the pre HTML. */
     preHtml?: string | null;
+
+    /**
+     * The token that will be used to grant access to API calls that the UI
+     * will need to make when editing the attribute value.
+     */
+    securityGrantToken?: string | null;
 };

package/types/ViewModels/Utility/publicAttributeCategoryBag.d.ts

@@ -25,6 +25,9 @@ import { Guid } from "@Obsidian/Types";
 
 /** Provides the details about a category that an attribute belongs to. */
 export type PublicAttributeCategoryBag = {
+    /** Gets or sets the description of the category. */
+    description?: string | null;
+
     /** Gets or sets the unique identifier of the category. */
     guid: Guid;
 

package/types/ViewModels/Workflow/entryFormFieldBag.d.ts

@@ -53,6 +53,13 @@ export type EntryFormFieldBag = {
     /** The identifier of the section to display this field in. */
     sectionId?: string | null;
 
+    /**
+     * A string that contains the security grant required for this form
+     * field to function. If null or empty then the default security grant
+     * from the block will be used.
+     */
+    securityGrantToken?: string | null;
+
     /**
      * The main rule that describes if this field should be visible or not
      * depending on the values of other fields.

package/types/Controls/Internal/EmailEditor/types.d.ts

@@ -1,9 +0,0 @@
-export type GetHtmlRequest = {
-    onSuccess: (response: GetHtmlResponse) => void;
-    onError?: ((error: string) => void) | null | undefined;
-};
-export type GetHtmlResponse = {
-    html: string;
-    bodyWidth?: number | null | undefined;
-};
-export type UsageType = "template" | "email";

package/types/Controls/Internal/pageDebugTimingRow.obs.d.ts

@@ -1,22 +0,0 @@
-import { PropType } from "vue";
-import { DebugTiming } from "@Obsidian/ViewModels/Utility/debugTiming";
-declare const _default: import("vue").DefineComponent<{
-    viewModel: {
-        type: PropType<DebugTiming>;
-        required: true;
-    };
-    totalMs: {
-        type: PropType<number>;
-        required: true;
-    };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
-    viewModel: {
-        type: PropType<DebugTiming>;
-        required: true;
-    };
-    totalMs: {
-        type: PropType<number>;
-        required: true;
-    };
-}>>, {}, {}>;
-export default _default;