@rockrms/obsidian-framework 17.0.43 → 17.1.5

package/types/Controls/Grid/grid.partial.obs.d.ts

@@ -711,12 +711,12 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: boolean;
     };
 }>> & {
+    onGridSettingsClick?: (() => any) | undefined;
     onFilteredRowsChanged?: ((grid: IGridState) => any) | undefined;
     onSelectedKeysChanged?: ((grid: IGridState) => any) | undefined;
-    onGridSettingsClick?: (() => any) | undefined;
 }, {
-    light: boolean;
     isFooterHidden: boolean;
+    light: boolean;
     markInactiveRows: boolean;
     rowClass: string | ((row: Record<string, unknown>) => string);
     emptyDataText: string;

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

@@ -9,6 +9,7 @@ import { EmailEditorGetFutureAttendanceOccurrencesOptionsBag } from "@Obsidian/V
 import { EmailEditorCreateAttendanceOccurrenceOptionsBag } from "@Obsidian/ViewModels/Rest/Controls/emailEditorCreateAttendanceOccurrenceOptionsBag";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
 import { Guid } from "@Obsidian/Types";
+import { Ref } from "vue";
 type ElementBinaryFileInfo = {
     binaryFile: ListItemBag | null | undefined;
 };
@@ -24,20 +25,30 @@ type CreateBinaryFileFromElementOptions = {
     /** The binary filetype guid. */
     binaryFileTypeGuid: Guid;
 };
-/**
- * Creates a binary file image from an HTML element.
- *
- * @param options `options.element` must exist in the DOM.
- */
-export declare function createBinaryFileImageFromElement(options: CreateBinaryFileFromElementOptions): Promise<ElementBinaryFileInfo>;
-export declare function createEmailSection(bag: EmailEditorEmailSectionBag): Promise<HttpResult<EmailEditorEmailSectionBag>>;
-export declare function getEmailSection(bag: EmailEditorGetEmailSectionOptionsBag): Promise<HttpResult<EmailEditorEmailSectionBag>>;
-export declare function getAllEmailSections(): Promise<HttpResult<EmailEditorEmailSectionBag[]>>;
-export declare function updateEmailSection(bag: EmailEditorEmailSectionBag): Promise<HttpResult<EmailEditorEmailSectionBag>>;
-export declare function deleteEmailSection(options: EmailEditorDeleteEmailSectionOptionsBag): Promise<HttpResult<void>>;
-export declare function createStarterSections(document: Document): Promise<HttpResult<EmailEditorEmailSectionBag[]>>;
-export declare function registerRsvpRecipients(bag: EmailEditorRegisterRsvpRecipientsOptionsBag): Promise<HttpResult<void>>;
-export declare function getAttendanceOccurrence(bag: EmailEditorGetAttendanceOccurrenceOptionsBag): Promise<HttpResult<EmailEditorAttendanceOccurrenceBag>>;
-export declare function getFutureAttendanceOccurrences(bag: EmailEditorGetFutureAttendanceOccurrencesOptionsBag): Promise<HttpResult<ListItemBag[]>>;
-export declare function createAttendanceOccurrence(bag: EmailEditorCreateAttendanceOccurrenceOptionsBag): Promise<HttpResult<EmailEditorAttendanceOccurrenceBag>>;
+export declare function provideApi(api: EmailEditorApi): void;
+export declare function useApi(): EmailEditorApi;
+export declare class EmailEditorApi {
+    private securityGrantToken;
+    constructor(options: {
+        securityGrantToken: Ref<string | null>;
+    });
+    /**
+     * Creates a binary file image from an HTML element.
+     *
+     * @param options `options.element` must exist in the DOM.
+     */
+    createBinaryFileImageFromElement(options: CreateBinaryFileFromElementOptions): Promise<ElementBinaryFileInfo>;
+    createEmailSection(bag: EmailEditorEmailSectionBag): Promise<HttpResult<EmailEditorEmailSectionBag>>;
+    getEmailSection(bag: EmailEditorGetEmailSectionOptionsBag): Promise<HttpResult<EmailEditorEmailSectionBag>>;
+    getAllEmailSections(): Promise<HttpResult<EmailEditorEmailSectionBag[]>>;
+    updateEmailSection(bag: EmailEditorEmailSectionBag): Promise<HttpResult<EmailEditorEmailSectionBag>>;
+    deleteEmailSection(bag: EmailEditorDeleteEmailSectionOptionsBag): Promise<HttpResult<void>>;
+    private useTemporaryElement;
+    private createEmailSectionAndThumbnail;
+    createStarterSections(document: Document): Promise<HttpResult<EmailEditorEmailSectionBag[]>>;
+    registerRsvpRecipients(bag: EmailEditorRegisterRsvpRecipientsOptionsBag): Promise<HttpResult<void>>;
+    getAttendanceOccurrence(bag: EmailEditorGetAttendanceOccurrenceOptionsBag): Promise<HttpResult<EmailEditorAttendanceOccurrenceBag>>;
+    getFutureAttendanceOccurrences(bag: EmailEditorGetFutureAttendanceOccurrencesOptionsBag): Promise<HttpResult<ListItemBag[]>>;
+    createAttendanceOccurrence(bag: EmailEditorCreateAttendanceOccurrenceOptionsBag): Promise<HttpResult<EmailEditorAttendanceOccurrenceBag>>;
+}
 export {};

package/types/Controls/Internal/EmailEditor/emailEditor.partial.obs.d.ts

@@ -1,6 +1,13 @@
 import { PropType } from "vue";
 import { GetHtmlRequest } from "./types";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { EmailEditorApi } from "./api";
+/**
+ * Gets the API for the email editor.
+ *
+ * @returns The API for the email editor. This is used to communicate with server on behalf of the email editor.
+ */
+declare function getApi(): EmailEditorApi;
 declare const _default: import("vue").DefineComponent<{
     html: {
         type: PropType<string>;
@@ -29,6 +36,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    ltr: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     /** Paragraph & Lava components - the merge fields available for selection. */
     mergeFields: {
         type: PropType<string[] | undefined>;
@@ -56,7 +67,9 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string[] | null | undefined>;
         required: true;
     };
-}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+}, {
+    getApi: typeof getApi;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:communicationTemplateGuid": (value: string | null | undefined) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     html: {
@@ -86,6 +99,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<boolean>;
         default: boolean;
     };
+    ltr: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     /** Paragraph & Lava components - the merge fields available for selection. */
     mergeFields: {
         type: PropType<string[] | undefined>;
@@ -117,6 +134,7 @@ declare const _default: import("vue").DefineComponent<{
     "onUpdate:communicationTemplateGuid"?: ((value: string | null | undefined) => any) | undefined;
 }, {
     disabled: boolean;
+    ltr: boolean;
     imageComponentBinaryFileTypeGuid: string;
 }, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/multiSelectButtonGroup.partial.obs.d.ts

@@ -102,14 +102,14 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((value: string[]) => any) | undefined;
 }, {
     label: string;
-    help: string;
     disabled: boolean;
+    btnSize: BtnSize;
+    help: string;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    btnSize: BtnSize;
     unselectedBtnType: LiteralUnion<BtnType>;
     selectedBtnType: LiteralUnion<BtnType>;
 }, {}>, {

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

@@ -14,7 +14,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: number;
     };
     zIndex: {
-        type: PropType<number | "inherit" | "auto">;
+        type: PropType<number | "auto" | "inherit">;
         default: "auto";
     };
     isAbsolute: {
@@ -40,7 +40,7 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: number;
     };
     zIndex: {
-        type: PropType<number | "inherit" | "auto">;
+        type: PropType<number | "auto" | "inherit">;
         default: "auto";
     };
     isAbsolute: {
@@ -52,9 +52,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         default: string;
     };
 }>>, {
-    backgroundColor: string;
-    zIndex: number | "inherit" | "auto";
     isVisible: boolean;
+    backgroundColor: string;
+    zIndex: number | "auto" | "inherit";
     displayDelayMs: number;
     isAbsolute: boolean;
 }, {}>, {

package/types/Controls/Internal/EmailEditor/properties/inlineSwitchProperty.partial.obs.d.ts

@@ -23,8 +23,8 @@ declare const _default: import("vue").DefineComponent<{
         required: true;
     };
 }>> & {
-    onToggle?: ((value: boolean) => any) | undefined;
     onOn?: (() => any) | undefined;
     onOff?: (() => any) | undefined;
+    onToggle?: ((value: boolean) => any) | undefined;
 }, {}, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/properties/togglablePropertyGroup.partial.obs.d.ts

@@ -23,9 +23,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         required: true;
     };
 }>> & {
-    onToggle?: ((value: boolean) => any) | undefined;
     onOn?: (() => any) | undefined;
     onOff?: (() => any) | undefined;
+    onToggle?: ((value: boolean) => any) | undefined;
 }, {}, {}>, {
     default?(_: {}): any;
 }>;

package/types/Controls/Internal/EmailEditor/propertyPanels/buttonComponentPropertyPanel.partial.obs.d.ts

@@ -8,6 +8,7 @@ declare const _default: import("vue").DefineComponent<{
     clone: () => void;
     complete: () => void;
     delete: () => void;
+    migrate: (value: Element) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     componentElement: {
         type: PropType<HTMLElement>;
@@ -17,5 +18,6 @@ declare const _default: import("vue").DefineComponent<{
     onComplete?: (() => any) | undefined;
     onDelete?: (() => any) | undefined;
     onClone?: (() => any) | undefined;
+    onMigrate?: ((value: Element) => any) | undefined;
 }, {}, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/propertyPanels/codeComponentPropertyPanel.partial.obs.d.ts

@@ -12,6 +12,7 @@ declare const _default: import("vue").DefineComponent<{
     clone: () => void;
     complete: () => void;
     delete: () => void;
+    migrate: (value: Element) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     componentElement: {
         type: PropType<HTMLElement>;
@@ -25,5 +26,6 @@ declare const _default: import("vue").DefineComponent<{
     onComplete?: (() => any) | undefined;
     onDelete?: (() => any) | undefined;
     onClone?: (() => any) | undefined;
+    onMigrate?: ((value: Element) => any) | undefined;
 }, {}, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/propertyPanels/imageComponentPropertyPanel.partial.obs.d.ts

@@ -12,6 +12,7 @@ declare const _default: import("vue").DefineComponent<{
     clone: () => void;
     complete: () => void;
     delete: () => void;
+    migrate: (value: Element) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     componentElement: {
         type: PropType<HTMLElement>;
@@ -25,5 +26,6 @@ declare const _default: import("vue").DefineComponent<{
     onComplete?: (() => any) | undefined;
     onDelete?: (() => any) | undefined;
     onClone?: (() => any) | undefined;
+    onMigrate?: ((value: Element) => any) | undefined;
 }, {}, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/propertyPanels/rowComponentPropertyPanel.partial.obs.d.ts

@@ -8,6 +8,7 @@ declare const _default: import("vue").DefineComponent<{
     clone: () => void;
     complete: () => void;
     delete: () => void;
+    migrate: (value: Element) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     componentElement: {
         type: PropType<HTMLElement>;
@@ -17,5 +18,6 @@ declare const _default: import("vue").DefineComponent<{
     onComplete?: (() => any) | undefined;
     onDelete?: (() => any) | undefined;
     onClone?: (() => any) | undefined;
+    onMigrate?: ((value: Element) => any) | undefined;
 }, {}, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/propertyPanels/rsvpComponentPropertyPanel.partial.obs.d.ts

@@ -12,6 +12,7 @@ declare const _default: import("vue").DefineComponent<{
     clone: () => void;
     complete: () => void;
     delete: () => void;
+    migrate: (value: Element) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     componentElement: {
         type: PropType<HTMLElement>;
@@ -25,5 +26,6 @@ declare const _default: import("vue").DefineComponent<{
     onComplete?: (() => any) | undefined;
     onDelete?: (() => any) | undefined;
     onClone?: (() => any) | undefined;
+    onMigrate?: ((value: Element) => any) | undefined;
 }, {}, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/propertyPanels/videoComponentPropertyPanel.partial.obs.d.ts

@@ -12,6 +12,7 @@ declare const _default: import("vue").DefineComponent<{
     clone: () => void;
     complete: () => void;
     delete: () => void;
+    migrate: (value: Element) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     componentElement: {
         type: PropType<HTMLElement>;
@@ -25,5 +26,6 @@ declare const _default: import("vue").DefineComponent<{
     onComplete?: (() => any) | undefined;
     onDelete?: (() => any) | undefined;
     onClone?: (() => any) | undefined;
+    onMigrate?: ((value: Element) => any) | undefined;
 }, {}, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/sidePanel.partial.obs.d.ts

@@ -18,6 +18,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         required: true;
     };
+    ltr: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     mergeFields: {
         type: PropType<string[] | undefined>;
         required: true;
@@ -72,6 +76,10 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string>;
         required: true;
     };
+    ltr: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
     mergeFields: {
         type: PropType<string[] | undefined>;
         required: true;
@@ -109,5 +117,7 @@ declare const _default: import("vue").DefineComponent<{
     onComponentTypeDragEnd?: ((value: ComponentTypeDragEndRequest) => any) | undefined;
     onDeleteComponent?: ((value: DeleteComponentRequest) => any) | undefined;
     onReplaceComponent?: ((value: ReplaceComponentRequest) => any) | undefined;
-}, {}, {}>;
+}, {
+    ltr: boolean;
+}, {}>;
 export default _default;

package/types/Controls/Internal/EmailEditor/singleSelectButtonGroup.partial.obs.d.ts

@@ -110,15 +110,15 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
     "onUpdate:modelValue"?: ((value: string) => any) | undefined;
 }, {
     label: string;
-    help: string;
-    multiple: boolean;
     disabled: boolean;
+    btnSize: BtnSize;
+    help: string;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    btnSize: BtnSize;
+    multiple: boolean;
     unselectedBtnType: LiteralUnion<BtnType>;
     selectedBtnType: LiteralUnion<BtnType>;
 }, {}>, {

package/types/Controls/Internal/EmailEditor/textFormatPicker.partial.obs.d.ts

@@ -86,8 +86,8 @@ declare const _default: import("vue").DefineComponent<{
     };
 }>>, {
     label: string;
-    help: string;
     disabled: boolean;
+    help: string;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;

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

@@ -268,37 +268,64 @@ export declare function isComponentVersionNumber(str: string): boolean;
  * - `0` if they are equal
  */
 export declare function compareComponentVersions(v1: string, v2: string): number;
+export declare function getVideoComponentHelper(): ComponentMigrationHelper & {
+    getElements(componentElement: Element): ComponentStructure | null;
+    createComponentElement(): HTMLElement;
+};
 export declare function getTitleComponentHelper(): ComponentMigrationHelper & {
     getElements(componentElement: Element): ComponentStructure & {
         readonly headingEl: HTMLHeadElement | null;
     } | null;
+    createComponentElement(): HTMLElement;
 };
 export declare function getTextComponentHelper(): ComponentMigrationHelper & {
     getElements(componentElement: Element): ComponentStructure & {
         readonly contentWrapper: HTMLElement | null;
     } | null;
+    createComponentElement(): HTMLElement;
 };
-export declare function getButtonComponentHelper(): {
+export declare function getButtonComponentHelper(): ComponentMigrationHelper & {
     getElements(componentElement: Element): ComponentStructure & {
         readonly linkButton: HTMLAnchorElement | null;
     } | null;
+    createComponentElement(): HTMLElement;
 };
-export declare function getCodeComponentHelper(): {
+export declare function getCodeComponentHelper(): ComponentMigrationHelper & {
     getElements(componentElement: Element): ComponentStructure & {
         readonly contentWrapper: HTMLElement | null;
     } | null;
+    createComponentElement(): HTMLElement;
 };
 export declare function getDividerComponentHelper(): ComponentMigrationHelper & {
     getElements(componentElement: Element): ComponentStructure | null;
+    createComponentElement(): HTMLElement;
+};
+export declare function getRsvpComponentHelper(): ComponentMigrationHelper & {
+    getElements(componentElement: Element): ComponentStructure | null;
+    createComponentElement(): HTMLElement;
 };
-export declare function getRowComponentHelper(): {
+export declare function getRowComponentHelper(): ComponentMigrationHelper & {
     getElements(componentElement: Element): ComponentStructure | null;
+    createComponentElement(): HTMLElement;
 };
+type SectionComponentTypeName = Extract<EditorComponentTypeName, "section" | "one-column-section" | "two-column-section" | "three-column-section" | "four-column-section" | "right-sidebar-section" | "left-sidebar-section">;
 export declare function getSectionComponentHelper(): ComponentMigrationHelper & {
     getElements(componentElement: Element): ComponentStructure & {
         readonly rowWrapper: HTMLTableElement | null;
     } | null;
+    createComponentElement(componentTypeName: SectionComponentTypeName): HTMLElement;
 };
-export declare function getImageComponentHelper(componentElement: Element): ComponentStructure | null;
-export declare function getVideoComponentHelper(componentElement: Element): ComponentStructure | null;
+export declare function getImageComponentHelper(): ComponentMigrationHelper & {
+    getElements(componentElement: Element): ComponentStructure | null;
+    createComponentElement(): HTMLElement;
+};
+export declare function getComponentHelper(componentTypeName: ComponentTypeName): (ComponentMigrationHelper & {
+    getElements(componentElement: Element): ComponentStructure | null;
+    createComponentElement(): HTMLElement;
+}) | (ComponentMigrationHelper & {
+    getElements(componentElement: Element): (ComponentStructure & {
+        readonly rowWrapper: HTMLTableElement | null;
+    }) | null;
+    createComponentElement(componentTypeName: SectionComponentTypeName): HTMLElement;
+}) | null;
 export {};

package/types/Controls/Internal/Notes/note.partial.obs.d.ts

@@ -0,0 +1,34 @@
+import { PropType } from "vue";
+import { ExpandedNoteBag } from "./types.partial";
+declare const _default: import("vue").DefineComponent<{
+    note: {
+        type: PropType<ExpandedNoteBag>;
+        required: true;
+    };
+    depth: {
+        type: PropType<number>;
+        default: number;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    delete: (value: ExpandedNoteBag) => void;
+    edited: (value: ExpandedNoteBag) => void;
+    beginEditNote: () => void;
+    endEditNote: () => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    note: {
+        type: PropType<ExpandedNoteBag>;
+        required: true;
+    };
+    depth: {
+        type: PropType<number>;
+        default: number;
+    };
+}>> & {
+    onDelete?: ((value: ExpandedNoteBag) => any) | undefined;
+    onEdited?: ((value: ExpandedNoteBag) => any) | undefined;
+    onBeginEditNote?: (() => any) | undefined;
+    onEndEditNote?: (() => any) | undefined;
+}, {
+    depth: number;
+}, {}>;
+export default _default;

package/types/Controls/Internal/Notes/noteEditor.partial.obs.d.ts

@@ -0,0 +1,103 @@
+import { PropType } from "vue";
+import { NoteEditBag } from "@Obsidian/ViewModels/Controls/noteEditBag";
+import { NoteTypeBag } from "@Obsidian/ViewModels/Controls/noteTypeBag";
+declare const _default: import("vue").DefineComponent<{
+    modelValue: {
+        type: PropType<NoteEditBag>;
+        required: false;
+    };
+    hideCancel: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    noteTypes: {
+        type: PropType<NoteTypeBag[]>;
+        required: true;
+    };
+    avatarUrl: {
+        type: PropType<string | null>;
+        required: false;
+    };
+    showAlert: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    showDate: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    showPrivate: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    showSecurity: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    autoSize: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    autoFocus: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: NoteEditBag) => void;
+    save: () => void;
+    cancel: () => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: PropType<NoteEditBag>;
+        required: false;
+    };
+    hideCancel: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    noteTypes: {
+        type: PropType<NoteTypeBag[]>;
+        required: true;
+    };
+    avatarUrl: {
+        type: PropType<string | null>;
+        required: false;
+    };
+    showAlert: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    showDate: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    showPrivate: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    showSecurity: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    autoSize: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    autoFocus: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: NoteEditBag) => any) | undefined;
+    onCancel?: (() => any) | undefined;
+    onSave?: (() => any) | undefined;
+}, {
+    hideCancel: boolean;
+    showAlert: boolean;
+    showDate: boolean;
+    showPrivate: boolean;
+    showSecurity: boolean;
+    autoSize: boolean;
+    autoFocus: boolean;
+}, {}>;
+export default _default;

package/types/Controls/Internal/Notes/noteList.partial.obs.d.ts

@@ -0,0 +1,24 @@
+import { PropType } from "vue";
+import { ExpandedNoteBag } from "./types.partial";
+declare const _default: import("vue").DefineComponent<{
+    notes: {
+        type: PropType<ExpandedNoteBag[]>;
+        required: true;
+    };
+    depth: {
+        type: PropType<number>;
+        default: number;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    notes: {
+        type: PropType<ExpandedNoteBag[]>;
+        required: true;
+    };
+    depth: {
+        type: PropType<number>;
+        default: number;
+    };
+}>>, {
+    depth: number;
+}, {}>;
+export default _default;

package/types/Controls/Internal/Notes/types.partial.d.ts

@@ -0,0 +1,63 @@
+import { Component } from "vue";
+import { NoteBag } from "@Obsidian/ViewModels/Controls/noteBag";
+import { NoteTypeBag } from "@Obsidian/ViewModels/Controls/noteTypeBag";
+import { NoteEditBag } from "@Obsidian/ViewModels/Controls/noteEditBag";
+import { SaveNoteRequestBag } from "@Obsidian/ViewModels/Controls/saveNoteRequestBag";
+/**
+ * Expanded note bag that contains some additional details that will be
+ * dynamically added to the object at run-time.
+ */
+export type ExpandedNoteBag = NoteBag & {
+    /** The note type of this note. */
+    noteType: NoteTypeBag;
+    /** The ordered child notes of this note. */
+    childNotes: ExpandedNoteBag[];
+};
+/**
+ * Options that describe the current configuration of the block. This will be
+ * provided to all child UI components.
+ */
+export type NoteOptions = {
+    /**
+     * We need to provide/inject the note component so that the container can
+     * access it without causing a recursive reference when bundling.
+     */
+    noteComponent: Component;
+    /** The note types that are configured on the block settings. */
+    noteTypes: NoteTypeBag[];
+    /** The user-selectable note types configured on the block settings. */
+    selectableNoteTypes: NoteTypeBag[];
+    /** `true` if notes should be displayed in descending order. */
+    isDescending: boolean;
+    /** `true` if the is alert option should be displayed when editing notes. */
+    showAlert: boolean;
+    /**
+     * `true` if the created date time override should be displayed when
+     * editing notes.
+     */
+    showCreateDate: boolean;
+    /** `true` if the note type panel header should be displayed. */
+    showNoteTypeHeading: boolean;
+    /** `true` if the private option should be displayed when editing notes. */
+    showPrivate: boolean;
+    /** `true` if the security button should be displayed when editing notes. */
+    showSecurity: boolean;
+    /** `true` if adding new notes is available. */
+    showAdd: boolean;
+    /** `true` if the person avatar should be shown when viewing notes. */
+    showAvatar: boolean;
+    /** Contains the URL of the current person's avatar. */
+    avatarUrl: string | undefined | null;
+    /** `true` if the notes block is in light mode. */
+    isLightMode: boolean;
+    /** `true` if replies should be auto expanded. */
+    autoExpandReplies: boolean;
+    /** The function to call to begin editing an existing note. */
+    editNote?: (idKey: string) => Promise<NoteEditBag> | NoteEditBag;
+    /** The function to call to watch or unwatch a note. */
+    watchNote?: (idKey: string, watching: boolean) => Promise<void> | void;
+    /** The function to call to save a new or edited note. */
+    saveNote?: (note: SaveNoteRequestBag) => Promise<NoteBag> | NoteBag;
+    /** The function to call to delete a note. */
+    deleteNote?: (idKey: string) => Promise<void> | void;
+};