@rockrms/obsidian-framework 17.5.2 → 18.1.0

package/types/SystemGuids/blockType.d.ts

@@ -84,6 +84,10 @@ export declare const BlockType: {
     MobileCrmGroupMembers: string;
     /** The GUID for the entity Rock.Blocks.Types.Mobile.Crm.PersonProfile. */
     MobileCrmPersonProfile: string;
+    /** The mobile financial batch detail > Financial Batch Detail block type. */
+    MobileFinanceFinancialBatchDetail: string;
+    /** The mobile financial batch list > Financial Batch List block type. */
+    MobileFinanceFinancialBatchList: string;
     /** The mobile scheduled transaction list > Scheduled Transaction block type. */
     MobileFinanceScheduledTransactionList: string;
     /** The mobile transaction detail > Transaction Detail block type. */
@@ -122,6 +126,8 @@ export declare const BlockType: {
     ObsidianExampleControlGallery: string;
     /** The obsidian event field type gallery */
     ObsidianExampleFieldTypeGallery: string;
+    /** Workflow Entry */
+    ObsidianWorkflowEntry: string;
     /** The oidc authorize */
     OidcAuthorize: string;
     /** The oidc claims */

package/types/SystemGuids/category.d.ts

@@ -94,8 +94,12 @@ export declare const Category: {
     SchedulePersistedDatasets: string;
     /** Gets the DataView Persisted Schedule category guid */
     SchedulePersistedDataviews: string;
+    /** Gets the Personalization Segment Schedules category guid */
+    SchedulePersonalizationSegments: string;
     /** Gets the Service Times schedule category guid */
     ScheduleServiceTimes: string;
+    /** The system communication Form Builder Category guid. */
+    SystemCommunicationFormBuilder: string;
     /** The System Communication RSVP Confirmation Category guid */
     SystemCommunicationRsvpConfirmation: string;
     /** The system communication Sign-Up Group confirmation Category guid */

package/types/SystemGuids/definedType.d.ts

@@ -24,6 +24,8 @@ export declare const DefinedType: {
     CampusType: string;
     /** Guid for the types of chart styles */
     ChartStyles: string;
+    /** GUID for the Chat Reaction defined type. */
+    ChatReaction: string;
     /** The check in attendance types */
     CheckInAttendanceTypes: string;
     /** Guid for check-in search type */
@@ -97,6 +99,8 @@ export declare const DefinedType: {
     GrouptypeInactiveReasons: string;
     /** Guid for GroupType Purpose */
     GrouptypePurpose: string;
+    /** Guid for the icon libraries */
+    IconLibraries: string;
     /** Guid for the types of interaction service. */
     InteractionChannelMedium: string;
     /** Guid for the types of interaction intent. */
@@ -137,6 +141,8 @@ export declare const DefinedType: {
     MotivatorThemeType: string;
     /** Motivator Type */
     MotivatorType: string;
+    /** Guid for the types of Organizational Objectives (such as Outreach, Discipleship, Activation) */
+    OrganizationalObjectiveType: string;
     /** List of different types of relationships and individual could have in their Peer Network. */
     PeerNetworkRelationshipType: string;
     /** Guid for the types of possible check-in system ability levels (such as Infant, Crawler, etc.) */
@@ -175,6 +181,8 @@ export declare const DefinedType: {
     ProjectType: string;
     /** Protect My Ministry MVR jurisdiction codes */
     ProtectMyMinistryMvrJurisdictionCodes: string;
+    /** Guid for the types of Record Sources (such as external website, event registration, etc.) */
+    RecordSourceType: string;
     /** The REST allowed domains */
     RestApiAllowedDomains: string;
     /**

package/types/SystemGuids/definedValue.d.ts

@@ -6,6 +6,10 @@ export declare const DefinedValue: {
     AttendanceSourceLegacyKiosk: string;
     /** The attendance record came from a mobile check-in. */
     AttendanceSourceMobile: string;
+    /** The attendance record from from a proximity (bluetooth low energy) check-in. */
+    AttendanceSourceProximity: string;
+    /** The attendance record came from a physical token, such as NFC or QR Code scan. */
+    AttendanceSourceToken: string;
     /** Benevolence Approved */
     BenevolenceApproved: string;
     /** Benevolence Denied */
@@ -102,6 +106,16 @@ export declare const DefinedValue: {
     ChartStyleFlot: string;
     /** Rock Chart Style */
     ChartStyleRock: string;
+    /** The default 'Haha' reaction for chat messages. */
+    ChatReactionHaha: string;
+    /** The default 'Like' reaction for chat messages. */
+    ChatReactionLike: string;
+    /** The default 'Love' reaction for chat messages. */
+    ChatReactionLove: string;
+    /** The default 'Sad' reaction for chat messages. */
+    ChatReactionSad: string;
+    /** The default 'Wow' reaction for chat messages. */
+    ChatReactionWow: string;
     /** The check in attendance type physical */
     CheckInAttendanceTypePhysical: string;
     /** The check in attendance type virtual */
@@ -305,6 +319,16 @@ export declare const DefinedValue: {
     MapStyleGoogle: string;
     /** The standard Rock map style */
     MapStyleRock: string;
+    /** The measurement classification for metrics that measure adult attendance. */
+    MeasurementTotalAdultAttendance: string;
+    /** The measurement classification for metrics that measure children attendance. */
+    MeasurementTotalChildrensAttendance: string;
+    /** The measurement classification for metrics that measure student attendance. */
+    MeasurementTotalStudentsAttendance: string;
+    /** The measurement classification for metrics that measure volunteer attendance. */
+    MeasurementTotalVolunteerAttendance: string;
+    /** The measurement classification for metrics that measure weekend attendance. */
+    MeasurementTotalWeekendAttendance: string;
     /** Metric values come from a DataView */
     MetricSourceValueTypeDataview: string;
     /** Metric values are populated from custom Lava */
@@ -375,6 +399,12 @@ export declare const DefinedValue: {
     NoncashAssetStocksandbonds: string;
     /** Non-Cash Asset Type: Vehicles. */
     NoncashAssetVehicles: string;
+    /** The activation organizational objective. */
+    OrganizationalObjectiveTypeActivation: string;
+    /** The discipleship organizational objective. */
+    OrganizationalObjectiveTypeDiscipleship: string;
+    /** The outreach organizational objective. */
+    OrganizationalObjectiveTypeOutreach: string;
     /** The PBX CDR medium value */
     PbxCdrMediumValue: string;
     /** Person Connection Status - Attendee */
@@ -459,6 +489,34 @@ export declare const DefinedValue: {
     ProjectTypeInPerson: string;
     /** Project Type = Project Due */
     ProjectTypeProjectDue: string;
+    /** The Apple TV app record source. */
+    RecordSourceTypeAppleTvApp: string;
+    /** The check-in record source. */
+    RecordSourceTypeCheckIn: string;
+    /** The event registration record source. */
+    RecordSourceTypeEventRegistration: string;
+    /** The external website record source. */
+    RecordSourceTypeExternalWebsite: string;
+    /** The family registration record source. */
+    RecordSourceTypeFamilyRegistration: string;
+    /** The giving record source. */
+    RecordSourceTypeGiving: string;
+    /** The group registration record source. */
+    RecordSourceTypeGroupRegistration: string;
+    /** The mobile app record source. */
+    RecordSourceTypeMobileApp: string;
+    /** The pledge record source. */
+    RecordSourceTypePledge: string;
+    /** The prayer record source. */
+    RecordSourceTypePrayer: string;
+    /** The Roku TV app record source. */
+    RecordSourceTypeRokuTvApp: string;
+    /** The Serving Connection record source. */
+    RecordSourceTypeServingConnection: string;
+    /** The sign-up record source. */
+    RecordSourceTypeSignUp: string;
+    /** The workflow record source. */
+    RecordSourceTypeWorkflow: string;
     /** Schedule Type:  Weekend Service */
     ScheduleTypeWeekendService: string;
     /** Spiritual Gifts: Administration */

package/types/SystemGuids/entityType.d.ts

@@ -16,8 +16,22 @@ export declare const EntityType: {
     AdaptiveMessageAdaptationSegment: string;
     /** The EntityType Guid for Rock.Model.AdaptiveMessageCategory  */
     AdaptiveMessageCategory: string;
+    /** The EntityType Guid for Rock.Model.AIAgent  */
+    AiAgent: string;
+    /** The EntityType Guid for Rock.Model.AIAgentSession  */
+    AiAgentSession: string;
+    /** The EntityType Guid for Rock.Model.AIAgentSessionAnchor  */
+    AiAgentSessionAnchor: string;
+    /** The EntityType Guid for Rock.Model.AIAgentSessionHistory  */
+    AiAgentSessionHistory: string;
+    /** The EntityType Guid for Rock.Model.AIAgentSkill  */
+    AiAgentSkill: string;
     /** The EntityType Guid for Rock.Model.AIProvider  */
     AiProvider: string;
+    /** The EntityType Guid for Rock.Model.AISkill  */
+    AiSkill: string;
+    /** The EntityType Guid for Rock.Model.AISkillTool  */
+    AiSkillTool: string;
     /** The EntityType Guid for Rock.Model.AnalyticsDimCampus  */
     AnalyticsDimCampus: string;
     /** The EntityType Guid for Rock.Model.AnalyticsDimFamilyCurrent  */
@@ -98,6 +112,10 @@ export declare const EntityType: {
     AuthenticationPasswordless: string;
     /** The pin authentication provider */
     AuthenticationPin: string;
+    /** The EntityType Guid for Rock.Model.AutomationEvent  */
+    AutomationEvent: string;
+    /** The EntityType Guid for Rock.Model.AutomationTrigger  */
+    AutomationTrigger: string;
     /** The EntityType Guid for Rock.Model.BackgroundCheck  */
     BackgroundCheck: string;
     /** The guid for the Rock.Model.Badge entity */
@@ -138,6 +156,18 @@ export declare const EntityType: {
     Communication: string;
     /** The EntityType Guid for Rock.Model.CommunicationAttachment  */
     CommunicationAttachment: string;
+    /** The guid for the communication flow */
+    CommunicationFlow: string;
+    /** The guid for the communication flow communication */
+    CommunicationFlowCommunication: string;
+    /** The guid for the communication flow instance */
+    CommunicationFlowInstance: string;
+    /** The guid for the communication flow instance communication */
+    CommunicationFlowInstanceCommunication: string;
+    /** The guid for the communication flow instance communication conversion */
+    CommunicationFlowInstanceCommunicationConversion: string;
+    /** The guid for the communication flow instance recipient */
+    CommunicationFlowInstanceRecipient: string;
     /** The guid for the email communication medium */
     CommunicationMediumEmail: string;
     /** The guid for the push notification communication medium */
@@ -306,8 +336,6 @@ export declare const EntityType: {
     GroupLocation: string;
     /** The EntityType Guid for Rock.Model.GroupLocationHistorical  */
     GroupLocationHistorical: string;
-    /** The EntityType Guid for Rock.Model.GroupLocationHistoricalSchedule  */
-    GroupLocationHistoricalSchedule: string;
     /** The guid for the Rock.Model.GroupMember entity. */
     GroupMember: string;
     /** The EntityType Guid for Rock.Model.GroupMemberAssignment  */
@@ -376,6 +404,10 @@ export declare const EntityType: {
     InteractiveExperienceSchedule: string;
     /** The EntityType Guid for Rock.Model.InteractiveExperienceScheduleCampus */
     InteractiveExperienceScheduleCampus: string;
+    /** The EntityType Guid for Rock.Model.LavaApplication  */
+    LavaApplication: string;
+    /** The EntityType Guid for Rock.Model.LavaEndpoint  */
+    LavaEndpoint: string;
     /** The EntityType Guid for Rock.Model.LavaShortcode (well known as of v14) */
     LavaShortcode: string;
     /** The EntityType Guid for LavaShortcodeCategory 'joiner' table Rock.Model.LavaShortcodeConfiguration */
@@ -498,6 +530,10 @@ export declare const EntityType: {
     MobileEventsPrayerSessionBlockType: string;
     /** The GUID for the entity Rock.Blocks.Types.Mobile.Events.PrayerSessionSetup */
     MobileEventsPrayerSessionSetupBlockType: string;
+    /** The GUID for the entity Rock.Blocks.Types.Mobile.Finance.FinancialBatchDetail. */
+    MobileFinanceFinancialBatchDetailBlockType: string;
+    /** The GUID for the entity Rock.Blocks.Types.Mobile.Finance.FinancialBatchList. */
+    MobileFinanceFinancialBatchListBlockType: string;
     /** The GUID for the entity Rock.Blocks.Types.Mobile.Finance.ScheduledTransactionList. */
     MobileFinanceScheduledTransactionListBlockType: string;
     /** The GUID for the entity Rock.Blocks.Types.Mobile.Finance.TransactionDetail. */

package/types/SystemGuids/fieldType.d.ts

@@ -62,6 +62,8 @@ export declare const FieldType: {
     Color: string;
     /** Color selector field type */
     ColorSelector: string;
+    /** Communication Flow field type */
+    CommunicationFlow: string;
     /** Communication Preference field type */
     CommunicationPreferenceType: string;
     /** Communication Template field type */
@@ -130,6 +132,8 @@ export declare const FieldType: {
     DefinedValueCategorized: string;
     /** Defined Value Range field type */
     DefinedValueRange: string;
+    /** Device field type */
+    Device: string;
     /** Document Type field type */
     DocumentType: string;
     /** Email field type */

package/types/SystemGuids/group.d.ts

@@ -28,6 +28,8 @@ export declare const Group: {
     GroupFinanceAdministrators: string;
     /** The Finance Users Group guid */
     GroupFinanceUsers: string;
+    /** Role for individuals allowed to develop Lava Applications. */
+    GroupLavaApplicationDevelopers: string;
     /** The security group used by mobile app */
     GroupMobileApp: string;
     /** RSR - Mobile Application Users */

package/types/SystemGuids/page.d.ts

@@ -375,6 +375,13 @@ export declare const Page: {
      * ParentPage: Communications
      */
     CommunicationMediums: string;
+    /** Gets the Communication Reports page guid */
+    CommunicationReports: string;
+    /**
+     * Gets the Communication Saturation page guid
+     * ParentPage: Communications
+     */
+    CommunicationSaturation: string;
     /**
      * Gets the Communication Templates page guid
      * ParentPage: Communications
@@ -681,6 +688,8 @@ export declare const Page: {
      * ParentPage: Internal Homepage
      */
     Finance: string;
+    /** Gets the Finance Reports page guid */
+    FinanceReports: string;
     /**
      * The financial account search guid
      * ParentPage: Internal Homepage > Finance > Administration
@@ -789,6 +798,8 @@ export declare const Page: {
     GroupMemberDetailSecurityRolesDetail: string;
     /** The group member history page guid */
     GroupMemberHistory: string;
+    /** The Group Placement page. */
+    GroupPlacement: string;
     /**
      * Gets the Group Registration page guid
      * ParentPage: Small Groups
@@ -1025,6 +1036,8 @@ export declare const Page: {
      * ParentPage: Communications
      */
     NewCommunication: string;
+    /** Gets the New Communication (Obsidian) page guid */
+    NewCommunicationObsidian: string;
     /**
      * Gets the New Family page guid
      * ParentPage: Manage

package/types/SystemGuids/pageRoute.d.ts

@@ -17,6 +17,8 @@ export declare const PageRoute: {
     FinancialAccountSearch: string;
     /** Gets the Campus Detail > Group Member Detail page route guid */
     GroupMemberDetailCampusDetail: string;
+    /** The Group Placement route 'GroupPlacement' */
+    GroupPlacement: string;
     /** The library viewer route 'admin/cms/content-library'. */
     LibraryViewer: string;
     /** The oidc authorize route. */

package/types/SystemGuids/serviceJob.d.ts

@@ -148,6 +148,28 @@ export declare const ServiceJob: {
     DataMigrations171PopulateAttendanceRootGroupType: string;
     /** The job to run Post v17.1 Data Migrations to update an existing index on the CommunicationRecipient table. */
     DataMigrations171UpdateCommunicationrecipientIndex: string;
+    /** The job to run Post v17.3 Data Migrations to remove a redundant index on the AttendanceOccurrence table. */
+    DataMigrations173UpdateAttendanceoccurrenceIndex: string;
+    /** The job to run Post v17.3 Data Migrations to update the Nameless Schedules. */
+    DataMigrations173UpdateNamelessSchedules: string;
+    /** The Job to run Post v18.0 Data Migrations to chop Block. */
+    DataMigrations180ChopObsidianBlocks: string;
+    /** The job to run Post v18.0 Data Migrations to delete the deprecated GroupLocationHistoricalSchedule table from the database. */
+    DataMigrations180DeleteGrouplocationhistoricalschedule: string;
+    /** The job to run Post v18.0 Data Migrations to Delete Self-Service Kiosk Site, Blocks, BlockTypes and KioskStark theme. */
+    DataMigrations180DeleteSelfserviceKioskSiteAndRelated: string;
+    /** The job to run Post v18.0 Data Migrations to migrate existing eRA records from the History table to the Steps table. */
+    DataMigrations180MigrateEraDataToSteps: string;
+    /** The job to run Post v18.0 Data Migrations to populate the newly-added [CommunicationRecipient].[DeliveredDateTime] field. */
+    DataMigrations180PopulateCommunicationrecipientDelivereddatetime: string;
+    /** The Job to run Post v18.0 Data Migrations to swap Block. */
+    DataMigrations180SwapObsidianBlocks: string;
+    /** The job to run Post v18.0 Data Migrations to update an existing index on the CommunicationRecipient table. */
+    DataMigrations180UpdateCommunicationrecipientIndex: string;
+    /** The job to run Post v18.0 Data Migrations to update the Manage My Account Page block setting for the recently-chopped Email Preference Entry block. */
+    DataMigrations180UpdateEmailPreferenceEntryBlockManageMyAccountPage: string;
+    /** The job to run Post v18.0 Data Migrations to update the Nameless Locations. */
+    DataMigrations180UpdateNamelessLocations: string;
     /**
      * The Post Update Data Migration Job to chop the Schedule Detail, Asset Storage Provider Detail, Page Short Link Detail, Streak Type Detail,
      * Following Event Type Detail, Financial Batch Detail
@@ -169,6 +191,8 @@ export declare const ServiceJob: {
     Post170UpdateHistoryEntitytypeidIndex: string;
     /** A run once job after a new installation. The purpose of this job is to populate generated datasets after an initial installation using RockInstaller that are too large to include in the installer. */
     PostInstallDataMigrations: string;
+    /** The job for processing communication flows. Rock.Jobs.ProcessCommunicationFlows */
+    ProcessCommunicationFlows: string;
     /** The Process Elevated Security Job. Rock.Jobs.ProcessElevatedSecurity */
     ProcessElevatedSecurity: string;
     /** The Rock.Jobs.ProcessReminders job. */
@@ -190,12 +214,16 @@ export declare const ServiceJob: {
     SyncMedia: string;
     /** The Rock.Jobs.UpdateAnalyticsSourcePostalCode job. */
     UpdateAnalyticsSourcePostalCode: string;
+    /** The Rock.Jobs.UpdateEntityUsage job configured to update Media Element usage. */
+    UpdateMediaElementUsage: string;
     /** The Update Persisted Attribute Values job. */
     UpdatePersistedAttributeValue: string;
     /** The Rock.Jobs.UpdatePersistedDatasets job. */
     UpdatePersistedDatasets: string;
     /** The Rock.Jobs.UpdatePersonalizationData job. */
     UpdatePersonalizationData: string;
-    /** The job for updating learning program completions. Rock.Jobs.UpdateProgramCompletions. */
+    /** The job for updating learning program completions. Rock.Jobs.UpdateLearningProgramCompletions. */
     UpdateProgramCompletions: string;
+    /** The job for updating step program completions. Rock.Jobs.UpdateStepProgramCompletions. */
+    UpdateStepProgramCompletions: string;
 };

package/types/SystemGuids/stepProgram.d.ts

@@ -0,0 +1,5 @@
+/** Guids for Step Programs. */
+export declare const StepProgram: {
+    /** Core Steps Step Program */
+    CoreSteps: string;
+};

package/types/SystemGuids/stepStatus.d.ts

@@ -0,0 +1,7 @@
+/** Guids for Step Statuses. */
+export declare const StepStatus: {
+    /** Complete Step Status */
+    Complete: string;
+    /** In Progress Step Status */
+    InProgress: string;
+};

package/types/SystemGuids/stepType.d.ts

@@ -0,0 +1,11 @@
+/** Guids for Step Types. */
+export declare const StepType: {
+    /** Baptism Step Type */
+    Baptism: string;
+    /** eRA Step Type */
+    Era: string;
+    /** Serve Step Type */
+    Serve: string;
+    /** Small Group Step Type */
+    SmallGroup: string;
+};

package/types/Templates/detailBlock.d.ts

@@ -174,6 +174,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string | null>;
         required: false;
     };
+    /**
+     * Enables the worksurface mode which allows the panel to be used on
+     * a full worksurface layout. This will cause the body content to
+     * automatically scroll if it is too large to fit in the panel. All
+     * other panel elements will remain in static positions.
+     */
+    worksurfaceMode: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }, {
     editForm: any;
     entityTypeName: import("vue").ComputedRef<string>;
@@ -375,6 +385,16 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string | null>;
         required: false;
     };
+    /**
+     * Enables the worksurface mode which allows the panel to be used on
+     * a full worksurface layout. This will cause the body content to
+     * automatically scroll if it is too large to fit in the panel. All
+     * other panel elements will remain in static positions.
+     */
+    worksurfaceMode: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:mode"?: ((_value: DetailPanelMode) => any) | undefined;
 }, {
@@ -388,5 +408,6 @@ declare const _default: import("vue").DefineComponent<{
     isDeleteVisible: boolean;
     isFullScreenVisible: boolean;
     mode: DetailPanelMode;
+    worksurfaceMode: boolean;
 }, {}>;
 export default _default;

package/types/Templates/rockPage.d.ts

@@ -4,6 +4,7 @@ import "@Obsidian/FieldTypes/index";
 import { DebugTiming } from "@Obsidian/ViewModels/Utility/debugTiming";
 import { ObsidianBlockConfigBag } from "@Obsidian/ViewModels/Cms/obsidianBlockConfigBag";
 import { PageConfig } from "@Obsidian/Utility/page";
+import { Guid } from "@Obsidian/Types";
 type DebugTimingConfig = {
     elementId: string;
     debugTimingViewModels: DebugTiming[];
@@ -22,15 +23,18 @@ export declare function initializeBlock(config: ObsidianBlockConfigBag): Promise
 export declare function showShortLink(url: string): void;
 /**
  * This is an internal method that will be removed in the future. It serves the
- * ObsidianDataComponentWrapper WebForms control to initialize an Obsidian
+ * ObsidianDynamicComponentWrapper WebForms control to initialize an Obsidian
  * component inside a WebForms component.
  *
- * @param url The URL of the Obsidian component to load.
  * @param rootElementId The identifier of the DOM node to mount the component on.
+ * @param componentGuid The unique identifier of the component.
+ * @param componentDefinitionId The identifier of the DOM node that contains the component definition bag.
  * @param componentDataId The identifier of the DOM node that contains the component data.
  * @param componentPropertiesId The identifier of the DOM node that contains the additional component properties.
+ * @param pageGuid The unique identifier of the page.
+ * @param blockGuid The unique identifier of the block.
  */
-export declare function initializeDataComponentWrapper(url: string, rootElementId: string, componentDataId: string, componentPropertiesId: string | undefined): Promise<void>;
+export declare function initializeDynamicComponentWrapper(rootElementId: string, componentGuid: Guid, componentDefinitionId: string, componentDataId: string, componentPropertiesId: string | undefined, pageGuid: string | null, blockGuid: string | null): Promise<void>;
 /**
  * Loads and shows a custom block action. This is a special purpose function
  * designed to be used only by the WebForms PageZoneBlocksEditor.ascx.cs control.

package/types/Types/Controls/dropDownMenu.d.ts

@@ -1,5 +1,5 @@
 /** The type to use for coloring and styling of the action. */
-export type MenuActionType = "default" | "danger";
+export type MenuActionType = "default" | "danger" | "info";
 
 /** A function that will be called in response to an action. */
 export type MenuActionCallback = (event: Event) => void | Promise<void>;

package/types/Types/Controls/grid.d.ts

@@ -285,6 +285,19 @@ export type ExportValueFunction = (row: Record<string, unknown>, column: ColumnD
  */
 export type ColumnFilterMatchesFunction = (needle: unknown, haystack: unknown, column: ColumnDefinition, grid: IGridState) => boolean;
 
+/**
+ * A function that will be called to get the tooltip text to display for a cell.
+ * This function will be called when the cell is initialized so any changes to
+ * the value while the cell is visible will not be reflected in the tooltip.
+ *
+ * @param row The data object that represents the row.
+ * @param column The column definition for this operation.
+ * @param grid The grid that owns this operation.
+ *
+ * @returns The string of text to display in the tooltip. An empty string, `null`, or `undefined` will not display a tooltip.
+ */
+export type TooltipFunction = (row: Record<string, unknown>, column: ColumnDefinition, grid: IGridState) => string | undefined | null;
+
 // #endregion
 
 // #region Component Props
@@ -514,6 +527,25 @@ type StandardColumnProps = {
         type: PropType<boolean>,
         default: false
     },
+
+    /**
+     * Either a string that represents the field to use when displaying the
+     * tooltip or a function that will be called to get the tooltip text.
+     */
+    tooltip: {
+        type: PropType<string | TooltipFunction>,
+        required: false
+    },
+
+    /**
+     * If `true` then the tooltip will be rendered as HTML. This is useful if
+     * you need to provide custom formatting inside the tooltip. Any plain text
+     * must be properly escaped.
+     */
+    tooltipHtml: {
+        type: PropType<boolean>,
+        default: false
+    },
 };
 
 /** The standard properties available on header cells. */
@@ -847,6 +879,19 @@ export type ColumnDefinition = {
      * If 'true', disables sorting for this column.
      */
     disableSort: boolean;
+
+    /**
+     * Either a string that represents the field to use when displaying the
+     * tooltip or a function that will be called to get the tooltip text.
+     */
+    tooltip?: string | TooltipFunction;
+
+    /**
+     * If `true` then the tooltip will be rendered as HTML. This is useful if
+     * you need to provide custom formatting inside the tooltip. Any plain text
+     * must be properly escaped.
+     */
+    tooltipHtml: boolean;
 };
 
 /**

package/types/Types/Utility/block.d.ts

@@ -41,3 +41,6 @@ export type BlockEvent<T = Record<string, unknown> | undefined> = {
 
 /** A function that will invoke a block action. */
 export type InvokeBlockActionFunc = <T>(actionName: string, data?: HttpBodyData, actionContext?: BlockActionContextBag, cancellationToken?: ICancellationToken) => Promise<HttpResult<T>>;
+
+/** A function that will invoke a block action returning streaming events. */
+export type InvokeStreamingBlockActionFunc = <T>(actionName: string, data?: HttpBodyData, actionContext?: BlockActionContextBag, cancellationToken?: ICancellationToken) => Promise<HttpResult<ReadableStream<T>>>;

package/types/Types/Utility/browserBus.d.ts

@@ -60,4 +60,15 @@ export type BlockEndEditData = void;
  */
 export type QueryStringChangedData = URLSearchParams;
 
+/**
+ * The data that is available in a page contextEntityChanged message.
+ */
+export type ContextEntityChangedData = {
+    /** The full class name of the entity type. */
+    entityType?: string | null;
+
+    /** The unique identifier of the entity type. */
+    entityTypeGuid?: Guid | null;
+};
+
 // #endregion

package/types/Types/Utility/http.d.ts

@@ -31,12 +31,15 @@ export type HttpResult<T> = {
 
 export type HttpDoApiCallFunc = <T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, cancellationToken?: ICancellationToken) => Promise<HttpResult<T>>;
 
+export type HttpDoStreamingApiCallFunc = <T>(method: HttpMethod, url: string, params?: HttpUrlParams, data?: HttpBodyData, cancellationToken?: ICancellationToken) => Promise<HttpResult<ReadableStream<T>>>;
+
 export type HttpGetFunc = <T>(url: string, params?: HttpUrlParams) => Promise<HttpResult<T>>;
 
 export type HttpPostFunc = <T>(url: string, params?: HttpUrlParams, data?: HttpBodyData, cancellationToken?: ICancellationToken) => Promise<HttpResult<T>>;
 
 export type HttpFunctions = {
     doApiCall: HttpDoApiCallFunc;
+    doStreamingApiCall: HttpDoStreamingApiCallFunc;
     get: HttpGetFunc;
     post: HttpPostFunc;
 };