@rockrms/obsidian-framework 17.3.1 → 17.5.2

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@rockrms/obsidian-framework",
     "description": "Type definitions to allow building a plugin against the Obsidian framework.",
-    "version": "17.3.1",
+    "version": "17.5.2",
     "license": "SEE LICENSE IN LICENSE.md",
     "scripts": {},
     "exports": "./types/*.d.ts",

package/types/Controls/Grid/Columns/dateTimeColumn.partial.d.ts

@@ -88,6 +88,14 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
+    /**
+     * Normally the column will does not display the seconds (ss).
+     * If this is set to `true` then it will show the seconds as well.
+     */
+    showSeconds: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     name: {
         type: PropType<string>;
         default: "";
@@ -221,6 +229,14 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
+    /**
+     * Normally the column will does not display the seconds (ss).
+     * If this is set to `true` then it will show the seconds as well.
+     */
+    showSeconds: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     name: {
         type: PropType<string>;
         default: "";
@@ -299,5 +315,6 @@ declare const _default: import("vue").DefineComponent<{
     visiblePriority: "xs" | "sm" | "lg" | "md" | "xl";
     wrapped: boolean;
     disableSort: boolean;
+    showSeconds: boolean;
 }, {}>;
 export default _default;

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

@@ -47,6 +47,28 @@ export declare function getPaddingWrapperCellSelector(componentTypeName: Compone
 type ContentWrapperSupportedComponentType = Extract<ComponentTypeName, "text" | "code">;
 export declare function getContentWrapperCssClass(componentTypeName: ContentWrapperSupportedComponentType, wrapperSuffix?: string): string;
 export declare function getContentWrapperSelector(componentTypeName: ContentWrapperSupportedComponentType, wrapperSuffix?: string): string;
+/**
+ * These classes that can be added to globally style elements.
+ */
+export declare const GlobalCssClasses: {
+    readonly borderHeading1: "border-heading-1";
+    readonly borderHeading2: "border-heading-2";
+    readonly borderHeading3: "border-heading-3";
+    readonly borderParagraph: "border-paragraph";
+    readonly fontGlobal: "font-global";
+    readonly fontHeading1: "font-heading-1";
+    readonly fontHeading2: "font-heading-2";
+    readonly fontHeading3: "font-heading-3";
+    readonly fontParagraph: "font-paragraph";
+    readonly marginHeading1: "margin-heading-1";
+    readonly marginHeading2: "margin-heading-2";
+    readonly marginHeading3: "margin-heading-3";
+    readonly marginParagraph: "margin-paragraph";
+    readonly paddingHeading1: "padding-heading-1";
+    readonly paddingHeading2: "padding-heading-2";
+    readonly paddingHeading3: "padding-heading-3";
+    readonly paddingParagraph: "padding-paragraph";
+};
 export declare const GlobalStylesCssSelectors: {
     readonly backgroundColor: ".email-wrapper";
     readonly bodyWidth: string;
@@ -55,21 +77,6 @@ export declare const GlobalStylesCssSelectors: {
     readonly bodyAlignment: string;
     readonly bodyBorderStyling: string;
     readonly bodyMargin: string;
-    readonly globalTextStyling: "body, .email-wrapper > tbody > tr > td";
-    readonly heading1TextStyling: ".component-title h1";
-    readonly heading1Margin: string;
-    readonly heading1Padding: string;
-    readonly heading1BorderStyling: string;
-    readonly heading2TextStyling: ".component-title h2";
-    readonly heading2Margin: string;
-    readonly heading2Padding: string;
-    readonly heading2BorderStyling: string;
-    readonly heading3TextStyling: ".component-title h3";
-    readonly heading3Margin: string;
-    readonly heading3Padding: string;
-    readonly heading3BorderStyling: string;
-    readonly paragraphTextStyling: string;
-    readonly paragraphMargin: string;
     readonly buttonBackgroundColor: ".component-button .button-link";
     readonly buttonTextStyling: ".component-button .button-link";
     readonly buttonCornerRadius: string;
@@ -272,16 +279,27 @@ export declare function getVideoComponentHelper(): ComponentMigrationHelper & {
     getElements(componentElement: Element): ComponentStructure | null;
     createComponentElement(): HTMLElement;
 };
+type TitleComponentStructure = ComponentStructure & {
+    readonly headingEl: HTMLHeadElement | null;
+    readonly borderEl: HTMLElement;
+    readonly marginEl: HTMLElement;
+    readonly paddingEl: HTMLElement;
+};
+export type SupportedHeadingLevel = "h1" | "h2" | "h3";
+export declare const SupportedHeadingLevels: SupportedHeadingLevel[];
 export declare function getTitleComponentHelper(): ComponentMigrationHelper & {
-    getElements(componentElement: Element): ComponentStructure & {
-        readonly headingEl: HTMLHeadElement | null;
-    } | null;
+    getElements(componentElement: Element): TitleComponentStructure | null;
     createComponentElement(): HTMLElement;
+    setCssClasses(componentElements: TitleComponentStructure): void;
+};
+type TextComponentStructure = ComponentStructure & {
+    readonly contentWrapper: HTMLHeadElement | null;
+    readonly borderEl: HTMLElement;
+    readonly marginEl: HTMLElement;
+    readonly paddingEl: HTMLElement;
 };
 export declare function getTextComponentHelper(): ComponentMigrationHelper & {
-    getElements(componentElement: Element): ComponentStructure & {
-        readonly contentWrapper: HTMLElement | null;
-    } | null;
+    getElements(componentElement: Element): TextComponentStructure | null;
     createComponentElement(): HTMLElement;
 };
 export declare function getButtonComponentHelper(): ComponentMigrationHelper & {
@@ -328,4 +346,33 @@ export declare function getComponentHelper(componentTypeName: ComponentTypeName)
     }) | null;
     createComponentElement(componentTypeName: SectionComponentTypeName): HTMLElement;
 }) | null;
+export declare const FontFamilies: {
+    readonly Arial: "Arial, Helvetica, sans-serif";
+    readonly "Courier New": "\"Courier New\", Courier, monospace";
+    readonly Georgia: "Georgia, serif";
+    readonly Tahoma: "Tahoma, Geneva, sans-serif";
+    readonly "Times New Roman": "\"Times New Roman\", Times, serif";
+    readonly "Trebuchet MS": "\"Trebuchet MS\", Helvetica, sans-serif";
+    readonly Verdana: "Verdana, Geneva, sans-serif";
+    readonly Lucida: "\"Lucida Sans Unicode\", \"Lucida Grande\", sans-serif";
+    readonly "Helvetica Neue": "\"Helvetica Neue\", Helvetica, Arial, sans-serif";
+};
+export declare const LineHeights: {
+    readonly tight: {
+        readonly value: "1.2";
+        readonly title: "Tight";
+    };
+    readonly normal: {
+        readonly value: "1.5";
+        readonly title: "Normal";
+    };
+    readonly loose: {
+        readonly value: "1.8";
+        readonly title: "Loose";
+    };
+    readonly veryLoose: {
+        readonly value: "2";
+        readonly title: "Very Loose";
+    };
+};
 export {};

package/types/Controls/firstNameTextBox.obs.d.ts

@@ -38,6 +38,7 @@ declare const _default: import("vue").DefineComponent<{
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: ListItemBag) => void;
+    "update:baseModelValue": (value: string) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     label: {
         type: PropType<string>;
@@ -76,6 +77,7 @@ declare const _default: import("vue").DefineComponent<{
     };
 }>> & {
     "onUpdate:modelValue"?: ((value: ListItemBag) => any) | undefined;
+    "onUpdate:baseModelValue"?: ((value: string) => any) | undefined;
 }, {
     label: string;
     help: string;

package/types/Controls/phoneNumberBoxWithSms.obs.d.ts

@@ -35,7 +35,7 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
-    /** When this is enabled, the SMS option will be hidden regardless of server settings. */
+    /** When this is enabled, the SMS option will be hidden. */
     hideSms: {
         type: PropType<boolean>;
         default: boolean;
@@ -77,7 +77,7 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         default: string;
     };
-    /** When this is enabled, the SMS option will be hidden regardless of server settings. */
+    /** When this is enabled, the SMS option will be hidden. */
     hideSms: {
         type: PropType<boolean>;
         default: boolean;

package/types/Enums/Blocks/Connection/ConnectionOpportunitySignup/connectionOpportunitySignupResultType.d.ts

@@ -0,0 +1,19 @@
+/** Represents the result type for a connection opportunity signup attempt. */
+export declare const ConnectionOpportunitySignupResultType: {
+    /** The signup was successful. */
+    readonly Success: 0;
+    /** The request was invalid. */
+    readonly CaptchaInvalid: 1;
+    /** The captcha validation failed. */
+    readonly InvalidRequest: 2;
+    /** The specified opportunity was not found. */
+    readonly OpportunityNotFound: 3;
+    /** The connection request was invalid. */
+    readonly InvalidConnectionRequest: 4;
+    /** An unknown error occurred. */
+    readonly UnknownError: 99;
+};
+/** Represents the result type for a connection opportunity signup attempt. */
+export declare const ConnectionOpportunitySignupResultTypeDescription: Record<number, string>;
+/** Represents the result type for a connection opportunity signup attempt. */
+export type ConnectionOpportunitySignupResultType = typeof ConnectionOpportunitySignupResultType[keyof typeof ConnectionOpportunitySignupResultType];

package/types/SystemGuids/groupRole.d.ts

@@ -2,8 +2,6 @@
 export declare const GroupRole: {
     /** The Member group member role for Application Group */
     GroupRoleApplicationGroupMember: string;
-    /** The Member group member role for Hidden Application Group */
-    GroupRoleHiddenApplicationGroupMember: string;
     /** The Administrator group member role for a Campus Team */
     GrouproleCampusTeamAdministrator: string;
     /** The Pastor group member role for a Campus Team */

package/types/SystemGuids/groupType.d.ts

@@ -18,8 +18,6 @@ export declare const GroupType: {
     GrouptypeFundraisingopportunity: string;
     /** General group type guid */
     GrouptypeGeneral: string;
-    /** Hidden Application Group group type guid */
-    GrouptypeHiddenApplicationGroup: string;
     /** Know relationship group type guid */
     GrouptypeKnownRelationships: string;
     /** Learning Management System (LMS) Class group type guid */

package/types/Utility/http.d.ts

@@ -82,6 +82,8 @@ export type UploadOptions = {
     parentEntityTypeId?: number;
     /** The parent entity identifier */
     parentEntityId?: number;
+    /** The security grant token */
+    securityGrantToken?: string | null;
 };
 /**
  * Uploads a file to the Rock file system, usually inside the ~/Content directory.

package/types/ViewModels/Blocks/Cms/PersistedDatasetList/persistedDatasetListBag.d.ts

@@ -0,0 +1,108 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+
+/** Class PersistedDatasetListBag. */
+export type PersistedDatasetListBag = {
+    /** Gets or sets the unique key to use to access this persisted dataset */
+    accessKey?: string | null;
+
+    /** Gets or sets a value indicating whether [allow manual refresh]. */
+    allowManualRefresh: boolean;
+
+    /** Gets or sets the build script. See Rock.Model.PersistedDataset.BuildScriptType */
+    buildScript?: string | null;
+
+    /** Gets or sets a user defined description of the PersistedDataset. */
+    description?: string | null;
+
+    /** Gets or sets a comma-delimited list of enabled LavaCommands */
+    enabledLavaCommands?: ListItemBag[] | null;
+
+    /** Gets or sets the type of the entity. */
+    entityType?: ListItemBag | null;
+
+    /** The DateTime when to stop updating the Rock.Model.PersistedDataset.ResultData */
+    expireDateTime?: string | null;
+
+    /**  Gets or sets the readable iCalendar content  */
+    friendlyScheduleText?: string | null;
+
+    /**
+     * The PersistedDataset's Id.  It is included for the Excel/CSV Export and
+     * to generate the IdKey from after ToList(). 
+     */
+    id: number;
+
+    /**
+     * Gets or sets the identifier key of this entity.
+     * NOTE: This is used to identify the PersistedDataset in the client operations.
+     */
+    idKey?: string | null;
+
+    /** Gets or sets a value indicating whether this instance is active. */
+    isActive: boolean;
+
+    /** Gets or sets a value indicating whether this instance is used by the system. */
+    isSystem: boolean;
+
+    /** Gets or sets the persisted last refresh date time. */
+    lastRefreshDateTime?: string | null;
+
+    /** Gets or sets the memory cache duration ms. */
+    memoryCacheDurationHours?: number | null;
+
+    /** Gets or sets the Name of the PersistedDataset. */
+    name?: string | null;
+
+    /** Gets or sets the named schedules. */
+    namedSchedules?: ListItemBag[] | null;
+
+    /** Gets or sets the schedule data. */
+    persistedSchedule?: string | null;
+
+    /** Gets or sets the Schedule ID. */
+    persistedScheduleId?: number | null;
+
+    /** Gets or sets the persisted schedule interval type. */
+    persistedScheduleIntervalType?: string | null;
+
+    /** Gets or sets the persisted schedule type. */
+    persistedScheduleType?: string | null;
+
+    /** Gets or sets the persistence type. */
+    persistenceType?: string | null;
+
+    /** Gets or sets the refresh interval */
+    refreshInterval?: number | null;
+
+    /** Gets or sets the refresh interval Hours */
+    refreshIntervalHours?: number | null;
+
+    /** Gets or sets the size of the result data in bytes. */
+    resultSize?: number | null;
+
+    /**  Gets or sets the time to build in milliseconds */
+    timeToBuildMS?: number | null;
+};

package/types/ViewModels/Blocks/Communication/CommunicationEntry/communicationEntryEmailMediumOptionsBag.d.ts

@@ -37,7 +37,10 @@ export type CommunicationEntryEmailMediumOptionsBag = {
     bulkEmailThreshold?: number | null;
 
     /** Gets or sets the document folder root. */
-    documentFolderRoot?: string | null;
+    encryptedDocumentFolderRoot?: string | null;
+
+    /** Gets or sets the image folder root. */
+    encryptedImageFolderRoot?: string | null;
 
     /** Gets or sets the address of the sender. */
     fromAddress?: string | null;
@@ -48,9 +51,6 @@ export type CommunicationEntryEmailMediumOptionsBag = {
     /** Gets or sets a value indicating whether this medium has an active transport. */
     hasActiveTransport: boolean;
 
-    /** Gets or sets the image folder root. */
-    imageFolderRoot?: string | null;
-
     /** Gets or sets a value indicating whether the attachment uploader is shown. */
     isAttachmentUploaderShown: boolean;
 

package/types/ViewModels/Blocks/Communication/SmsConversations/smsConversationsInitializationBox.d.ts

@@ -47,6 +47,9 @@ export type SmsConversationsInitializationBox = {
     /** Gets or sets the list of available note types. */
     noteTypes?: NoteTypeBag[] | null;
 
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
     /** Gets or sets the list of available snippets. */
     snippets?: SnippetBag[] | null;
 

package/types/ViewModels/Blocks/Connection/ConnectionOpportunitySignup/connectionOpportunitySignupInitializationBox.d.ts

@@ -0,0 +1,77 @@
+//------------------------------------------------------------------------------
+// <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 { PhoneNumberBoxWithSmsControlBag } from "@Obsidian/ViewModels/Controls/phoneNumberBoxWithSmsControlBag";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { PublicAttributeBag } from "@Obsidian/ViewModels/Utility/publicAttributeBag";
+
+/** A bag containing the required information to render a Connection Opportunity Signup block. */
+export type ConnectionOpportunitySignupInitializationBox = {
+    /** Gets or sets the public editable attributes for the connection request. */
+    attributes?: Record<string, PublicAttributeBag> | null;
+
+    /** Gets or sets the available campuses for the opportunity. */
+    campuses?: ListItemBag[] | null;
+
+    /** Gets or sets the label to display for the comment field on the signup form. */
+    commentFieldLabel?: string | null;
+
+    /** Gets or sets whether to disable captcha support for the block. */
+    disableCaptchaSupport: boolean;
+
+    /** Gets or sets whether to display the home phone field. */
+    displayHomePhone: boolean;
+
+    /** Gets or sets whether to display the mobile phone field. */
+    displayMobilePhone: boolean;
+
+    /** Gets or sets the pre-filled email. */
+    email?: string | null;
+
+    /**
+     * Gets or sets the error message. A non-empty value indicates that
+     * an error is preventing the block from being displayed.
+     */
+    errorMessage?: string | null;
+
+    /** Gets or sets the pre-filled first name. */
+    firstName?: string | null;
+
+    /** Gets or sets the pre-filled home phone. */
+    homePhone?: PhoneNumberBoxWithSmsControlBag | null;
+
+    /** Gets or sets the pre-filled last name. */
+    lastName?: string | null;
+
+    /** Gets or sets the pre-filled mobile phone. */
+    mobilePhone?: PhoneNumberBoxWithSmsControlBag | null;
+
+    /** Gets or sets the navigation urls. */
+    navigationUrls?: Record<string, string> | null;
+
+    /** Gets or sets the security grant token. */
+    securityGrantToken?: string | null;
+
+    /** Gets or sets the pre-selected campus ID. */
+    selectedCampusId?: number | null;
+};

package/types/ViewModels/Blocks/Connection/ConnectionOpportunitySignup/connectionOpportunitySignupRequestBag.d.ts

@@ -0,0 +1,51 @@
+//------------------------------------------------------------------------------
+// <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 { PhoneNumberBoxWithSmsControlBag } from "@Obsidian/ViewModels/Controls/phoneNumberBoxWithSmsControlBag";
+
+/** A bag containing the signup request details. */
+export type ConnectionOpportunitySignupRequestBag = {
+    /** Gets or sets the attribute values. */
+    attributeValues?: Record<string, string> | null;
+
+    /** Gets or sets the campus identifier. */
+    campusId?: number | null;
+
+    /** Gets or sets the comments. */
+    comments?: string | null;
+
+    /** Gets or sets the email. */
+    email?: string | null;
+
+    /** Gets or sets the first name. */
+    firstName?: string | null;
+
+    /** Gets or sets the pre-filled home phone. */
+    homePhone?: PhoneNumberBoxWithSmsControlBag | null;
+
+    /** Gets or sets the last name. */
+    lastName?: string | null;
+
+    /** Gets or sets the pre-filled mobile phone. */
+    mobilePhone?: PhoneNumberBoxWithSmsControlBag | null;
+};

package/types/ViewModels/Blocks/Connection/ConnectionOpportunitySignup/connectionOpportunitySignupResultBag.d.ts

@@ -0,0 +1,33 @@
+//------------------------------------------------------------------------------
+// <auto-generated>
+//     This code was generated by the Rock.CodeGeneration project
+//     Changes to this file will be lost when the code is regenerated.
+// </auto-generated>
+//------------------------------------------------------------------------------
+// <copyright>
+// Copyright by the Spark Development Network
+//
+// Licensed under the Rock Community License (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.rockrms.com/license
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+// </copyright>
+//
+
+import { ConnectionOpportunitySignupResultType } from "@Obsidian/Enums/Blocks/Connection/ConnectionOpportunitySignup/connectionOpportunitySignupResultType";
+
+/** A bag containing the response information after signing up. */
+export type ConnectionOpportunitySignupResultBag = {
+    /** Gets or sets the response message (success or error details). */
+    responseMessage?: string | null;
+
+    /** Gets or sets the result type of the signup attempt. */
+    resultType: ConnectionOpportunitySignupResultType;
+};

package/types/ViewModels/Blocks/Finance/FinancialPledgeList/financialPledgeListOptionsBag.d.ts

@@ -21,7 +21,12 @@
 // </copyright>
 //
 
+import { CurrencyInfoBag } from "@Obsidian/ViewModels/Utility/currencyInfoBag";
+
 export type FinancialPledgeListOptionsBag = {
+    /** Gets or sets the currency information. */
+    currencyInfo?: CurrencyInfoBag | null;
+
     /** Determines if the amount column should be displayed. */
     hideAmount: boolean;