@rockrms/obsidian-framework 17.5.2 → 18.1.0

package/types/ViewModels/Blocks/Lms/LearningClassDetail/learningClassFacilitatorBag.d.ts

@@ -41,6 +41,9 @@ export type LearningClassFacilitatorBag = {
     /** Gets or sets the facilitator name. */
     facilitatorName?: string | null;
 
+    /** Gets or sets the facilitator Person Id. */
+    facilitatorPersonId: number;
+
     /** Gets or sets the facilitator role. */
     facilitatorRole?: string | null;
 

package/types/ViewModels/Blocks/Lms/LearningProgramDetail/learningProgramBag.d.ts

@@ -74,6 +74,9 @@ export type LearningProgramBag = {
     /** Gets or sets the Description of the LearningProgram. */
     description?: string | null;
 
+    /** Gets or sets a value indicating whether public security should be enforced for this program. */
+    enforcePublicSecurity: boolean;
+
     /** Gets or sets the color of the highlight. */
     highlightColor?: string | null;
 

package/types/ViewModels/Blocks/Lms/PublicLearningClassWorkspace/publicLearningClassWorkspaceBox.d.ts

@@ -21,6 +21,7 @@
 // </copyright>
 //
 
+import { CommunicationType } from "@Obsidian/Enums/Communication/communicationType";
 import { ConfigurationMode } from "@Obsidian/Enums/Lms/configurationMode";
 import { LearningCompletionStatus } from "@Obsidian/Enums/Lms/learningCompletionStatus";
 import { Guid } from "@Obsidian/Types";
@@ -49,6 +50,9 @@ export type PublicLearningClassWorkspaceBox = {
     /** Gets or sets the id for the class. */
     classIdKey?: string | null;
 
+    /** Gets or sets the communication preference */
+    communicationPreference: CommunicationType;
+
     /** Gets or sets the custom content pages for the class. */
     contentPages?: LearningClassContentPageBag[] | null;
 
@@ -103,6 +107,9 @@ export type PublicLearningClassWorkspaceBox = {
     /** Gets or sets the security grant token. */
     securityGrantToken?: string | null;
 
+    /** Gets or sets whethere the Communication Preference toggle should be shown. */
+    showCommunicationPreference: boolean;
+
     /** Whether to show grades on the class overview page. */
     showGrades: boolean;
 };

package/types/ViewModels/Blocks/Prayer/PrayerRequestEntry/prayerRequestEntryInitializationBox.d.ts

@@ -87,6 +87,9 @@ export type PrayerRequestEntryInitializationBox = {
      */
     defaultRequest?: string | null;
 
+    /** Gets or sets whether to disable captcha support for the block. */
+    disableCaptchaSupport: boolean;
+
     /**
      * Gets or sets the error message. A non-empty value indicates that
      * an error is preventing the block from being displayed.

package/types/ViewModels/Blocks/Reporting/Insights/insightsChartDataBag.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 { ChartBag } from "@Obsidian/ViewModels/Reporting/chartBag";
+
+/** Data Bag for the Insights block charts. */
+export type InsightsChartDataBag = {
+    /** Gets or sets the chart bag containing the chart's data and configuration. */
+    chartBag?: ChartBag | null;
+
+    /** Gets or sets the category of the insight. */
+    insightCategory?: string | null;
+
+    /** Gets or sets the subcategory of the insight. */
+    insightSubcategory?: string | null;
+};

package/types/ViewModels/Blocks/Reporting/Insights/insightsInitializationBox.d.ts

@@ -0,0 +1,46 @@
+//------------------------------------------------------------------------------
+// <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 { InsightsChartDataBag } from "@Obsidian/ViewModels/Blocks/Reporting/Insights/insightsChartDataBag";
+import { InsightsOptionsBag } from "@Obsidian/ViewModels/Blocks/Reporting/Insights/insightsOptionsBag";
+
+/** Contains all the initialization information for the Insights block. */
+export type InsightsInitializationBox = {
+    /** Passes all attached Insights Chart Data Bags to the front end. */
+    chartDataBags?: InsightsChartDataBag[] | 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 navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Passes all attached Insights Options Bags to the front end. */
+    optionsBags?: Record<string, InsightsOptionsBag> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+};

package/types/ViewModels/Blocks/Reporting/Insights/insightsOptionsBag.d.ts

@@ -0,0 +1,58 @@
+//------------------------------------------------------------------------------
+// <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>
+//
+
+/** Options bag for the Insights block. */
+export type InsightsOptionsBag = {
+    /** Passes the IsAgeShown block attribute to the front end. */
+    isAgeShown: boolean;
+
+    /** Passes the IsConnectionStatusShown block attribute to the front end. */
+    isConnectionStatusShown: boolean;
+
+    /** Passes the IsDemographicsShown block attribute to the front end. */
+    isDemographicsShown: boolean;
+
+    /** Passes the IsEthnicityShown block attribute to the front end. */
+    isEthnicityShown: boolean;
+
+    /** Passes the IsGenderShown block attribute to the front end. */
+    isGenderShown: boolean;
+
+    /** Passes the IsInformationCompletenessShown block attribute to the front end. */
+    isInformationCompletenessShown: boolean;
+
+    /** Passes the IsInformationStatisticsShown block attribute to the front end. */
+    isInformationStatisticsShown: boolean;
+
+    /** Passes the IsMaritalStatusShown block attribute to the front end. */
+    isMaritalStatusShown: boolean;
+
+    /** Passes the IsPercentageOfIndividualsWithAssessmentsShown block attribute to the front end. */
+    isPercentageOfIndividualsWithAssessmentsShown: boolean;
+
+    /** Passes the IsRaceShown block attribute to the front end. */
+    isRaceShown: boolean;
+
+    /** Passes the IsRecordStatusesShown block attribute to the front end. */
+    isRecordStatusesShown: boolean;
+};

package/types/ViewModels/Blocks/Reporting/PowerBiAccount/powerBiAccountRegisterBox.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 { PowerBiAccountRegisterOptionsBag } from "@Obsidian/ViewModels/Blocks/Reporting/PowerBiAccount/powerBiAccountRegisterOptionsBag";
+
+/** The initialization data for the Power BI Account Register block. */
+export type PowerBiAccountRegisterBox = {
+    /** Gets or sets the options for the block. */
+    options?: PowerBiAccountRegisterOptionsBag | null;
+};

package/types/ViewModels/Blocks/Reporting/PowerBiAccount/powerBiAccountRegisterOptionsBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <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 configuration options for the Power BI Account Register block. */
+export type PowerBiAccountRegisterOptionsBag = {
+    /** Gets or sets the homepage URL. */
+    homepageUrl?: string | null;
+
+    /** Gets or sets the redirect URL. */
+    redirectUrl?: string | null;
+};

package/types/ViewModels/Blocks/Reporting/powerBiAccountRegisterBox.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 { PowerBiAccountRegisterOptionsBag } from "@Obsidian/ViewModels/Blocks/Reporting/powerBiAccountRegisterOptionsBag";
+
+/** The initialization data for the Power BI Account Register block. */
+export type PowerBiAccountRegisterBox = {
+    /** Gets or sets the options for the block. */
+    options?: PowerBiAccountRegisterOptionsBag | null;
+};

package/types/ViewModels/Blocks/Reporting/powerBiAccountRegisterOptionsBag.d.ts

@@ -0,0 +1,31 @@
+//------------------------------------------------------------------------------
+// <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 configuration options for the Power BI Account Register block. */
+export type PowerBiAccountRegisterOptionsBag = {
+    /** Gets or sets the homepage URL. */
+    homepageUrl?: string | null;
+
+    /** Gets or sets the redirect URL. */
+    redirectUrl?: string | null;
+};

package/types/ViewModels/Blocks/Security/Oidc/AuthScopeDetail/authScopeBag.d.ts

@@ -0,0 +1,48 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** The item details for the Auth Scope Detail block. */
+export type AuthScopeBag = {
+    /** 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 identifier key of this entity. */
+    idKey?: string | null;
+
+    /** Gets or sets a flag indicating if this item is active or not. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this instance is system. */
+    isSystem: boolean;
+
+    /** Gets or sets the name. */
+    name?: string | null;
+
+    /** Gets or sets the name of the public. */
+    publicName?: string | null;
+};

package/types/ViewModels/Blocks/Security/Oidc/AuthScopeDetail/authScopeDetailOptionsBag.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 Auth Scope Detail block. */
+export type AuthScopeDetailOptionsBag = {
+};

package/types/ViewModels/Blocks/Workflow/FormBuilder/formBuilderDetailLinkToFormBag.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";
+
+/** The bag containing information to link to a form in the Obsidian Form Builder Detail block. */
+export type FormBuilderDetailLinkToFormBag = {
+    /** Gets or sets the unique identifier of the page containing the form. */
+    formPageGuid: Guid;
+
+    /** Gets or sets the name of the page containing the form. */
+    formPageName?: string | null;
+
+    /** Gets or sets the URL to the page. */
+    formPageUrl?: string | null;
+};

package/types/ViewModels/CheckIn/attendanceSessionRequestBag.d.ts

@@ -66,4 +66,10 @@ export type AttendanceSessionRequestBag = {
 
     /** Gets or sets the term used when searching for families. */
     searchTerm?: string | null;
+
+    /**
+     * The identifier of the check-in source that will be used when creating
+     * the attendance records for this session.
+     */
+    sourceValueId?: string | null;
 };

package/types/ViewModels/CheckIn/attendeeBag.d.ts

@@ -23,6 +23,7 @@
 
 import { OpportunitySelectionBag } from "@Obsidian/ViewModels/CheckIn/opportunitySelectionBag";
 import { PersonBag } from "@Obsidian/ViewModels/CheckIn/personBag";
+import { ScheduleOpportunityBag } from "@Obsidian/ViewModels/CheckIn/scheduleOpportunityBag";
 
 /** Details about a single attendee being considered for check-in. */
 export type AttendeeBag = {
@@ -44,6 +45,9 @@ export type AttendeeBag = {
     /** Gets or sets the person represented by this item. */
     person?: PersonBag | null;
 
+    /** Gets all possible schedules that are available to this attendee. */
+    possibleSchedules?: ScheduleOpportunityBag[] | null;
+
     /** Gets or sets the selected opportunities for this attendee. */
     selectedOpportunities?: OpportunitySelectionBag[] | null;
 

package/types/ViewModels/CheckIn/kioskBag.d.ts

@@ -21,11 +21,18 @@
 // </copyright>
 //
 
+import { AdultsOrChildrenSelectionMode } from "@Obsidian/Enums/CheckIn/adultsOrChildrenSelectionMode";
 import { CameraBarcodeConfiguration } from "@Obsidian/Enums/Core/cameraBarcodeConfiguration";
 import { KioskType } from "@Obsidian/Enums/Core/kioskType";
 
 /** Details about a single kiosk device. */
 export type KioskBag = {
+    /**
+     * Controls who can be added to an existing family during check-in,
+     * regardless of the IsAddingFamiliesEnabled value.
+     */
+    allowAddingIndividualsToExistingFamilies: AdultsOrChildrenSelectionMode;
+
     /** Determines how the camera should operate on this kiosk device. */
     cameraMode: CameraBarcodeConfiguration;
 

package/types/ViewModels/CheckIn/proximityAttendanceNotificationBag.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>
+//
+
+/**
+ * Represents the notification details sent to the client when a proximity-based
+ * attendance event occurs.
+ */
+export type ProximityAttendanceNotificationBag = {
+    /** Gets or sets the body/message content of the notification displayed to the user. */
+    message?: string | null;
+
+    /** Gets or sets the title of the notification (e.g. the heading presented to the user). */
+    title?: string | null;
+};

package/types/ViewModels/Cms/contextEntityItemBag.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 { Guid } from "@Obsidian/Types";
+
+/** Represents a entity that has been added to the page or site context. */
+export type ContextEntityItemBag = {
+    /** The unique identifier of the entity. */
+    entityGuid: Guid;
+
+    /** The name of the entity, used for display purposes. */
+    entityName?: string | null;
+
+    /** The full class name of the entity type. */
+    entityType?: string | null;
+
+    /** The unique identifier of the entity type. */
+    entityTypeGuid: Guid;
+};

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

@@ -22,6 +22,7 @@
 //
 
 import { BlockReloadMode } from "@Obsidian/Enums/Cms/blockReloadMode";
+import { BlockRole } from "@Obsidian/Enums/Cms/blockRole";
 import { Guid } from "@Obsidian/Types";
 import { BlockCustomActionBag } from "@Obsidian/ViewModels/Cms/blockCustomActionBag";
 import { ObsidianBlockPreferencesBag } from "@Obsidian/ViewModels/Cms/obsidianBlockPreferencesBag";
@@ -71,6 +72,12 @@ export type ObsidianBlockConfigBag = {
     /** Gets or sets the reload mode when the block configuration changes. */
     reloadMode: BlockReloadMode;
 
+    /**
+     * The role this block plays on the page. This is used to show and
+     * hide certain blocks in response to user actions.
+     */
+    role: BlockRole;
+
     /**
      * Gets or sets the HTML element identifier that the block will be
      * mounted on as its root.

package/types/ViewModels/Controls/dynamicComponentDefinitionBag.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>
+//
+
+/**
+ * Describes the settings that will be used to initialize an Obsidian
+ * UI component. This is used by various parts of Rock to allow an
+ * Obsidian UI component to handle some aspect of a C# component when
+ * it needs to render a custom UI.
+ */
+export type DynamicComponentDefinitionBag = {
+    /**
+     * The static options that will be sent to the component to help it render
+     * correctly. These will not be sent back to the server.
+     */
+    options?: Record<string, string> | null;
+
+    /**
+     * The security grant that will be provided to the component. This
+     * will allow any UI controls to make API requests that require
+     * additional permissions. These are not automatically renewed so it
+     * is suggested that you create the token with an expiration of atleast
+     * a few hours to cover then walking away while editing something.
+     */
+    securityGrantToken?: string | null;
+
+    /** The URL of an obsidian component to display. */
+    url?: string | null;
+};