@rockrms/obsidian-framework 17.0.43 → 17.2.4

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;
+};

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

@@ -0,0 +1,93 @@
+import { ComputedRef } from "vue";
+import { ExpandedNoteBag, NoteOptions } from "./types.partial";
+/**
+ * Converts an input string to a CSS class name.
+ *
+ * @param input The text to be converted.
+ *
+ * @returns A string safe for use as a CSS class.
+ */
+export declare function toCssClass(input: string): string;
+/**
+ * Sorts a collection of notes in place. This should only be called if it is
+ * likely that the order will change.
+ *
+ * @param notes The array of notes to be sorted.
+ * @param descending `true` if the notes should be sorted in descending order.
+ */
+export declare function sortNotes(notes: ExpandedNoteBag[], descending: boolean): void;
+/**
+ * Inserts a new note into the collection in the proper sorted position.
+ *
+ * @param expandedNote The note to be inserted.
+ * @param notes The collection of existing notes.
+ * @param descending Whether to treat the list of notes as descending or not.
+ */
+export declare function insertSortedPosition(expandedNote: ExpandedNoteBag, notes: ExpandedNoteBag[], descending: boolean): void;
+/**
+ * Makes the note options object available to child components.
+ *
+ * @param options The options to be provided to child note components.
+ */
+export declare function provideNoteOptions(options: ComputedRef<NoteOptions>): void;
+/**
+ * Gets the note options object for this tree of notes or throws an error if
+ * it is not available.
+ *
+ * @returns An instance of {@link NoteOptions}.
+ */
+export declare function useNoteOptions(): ComputedRef<NoteOptions>;
+type NoteEventNames = "beginEdit" | "endEdit";
+/**
+ * Creats a new {@link NoteEventEmitter} and provides it to child components.
+ *
+ * @returns The emitter that was created.
+ */
+export declare function provideEmitter(): NoteEventEmitter;
+/**
+ * Uses a previously provided {@link NoteEventEmitter} from the notes component.
+ *
+ * @returns The emitter.
+ */
+export declare function useEmitter(): NoteEventEmitter;
+/**
+ * A special class that handles emitting events related to the notes block.
+ */
+export declare class NoteEventEmitter {
+    private readonly events;
+    /**
+     * Creates a new subscriber that can then subscribe to events.
+     *
+     * @returns A new subscriber key.
+     */
+    subscribe(): string;
+    /**
+     * Unsubscribes a subscriber from all events.
+     *
+     * @param subscriberKey The subscriber to be unsubscribed.
+     */
+    unsubscribe(subscriberKey: string): void;
+    /**
+     * Registers a callback for a specific event.
+     *
+     * @param event The event to be registered to.
+     * @param subscriberKey The identifier of the subscriber.
+     * @param handler The function to call when the event is fired.
+     */
+    on(event: NoteEventNames, subscriberKey: string, handler: () => void): void;
+    /**
+     * Unregisters a callback for a specific event.
+     *
+     * @param event The event to be unregistered from.
+     * @param subscriberKey The identifier of the subscriber.
+     */
+    off(event: NoteEventNames, subscriberKey: string): void;
+    /**
+     * Emits a single event to all subscribers except the one specified.
+     *
+     * @param event The event name to be emitted.
+     * @param exceptSubscriberKey The identifier of the subscriber that will not receive the event.
+     */
+    emit(event: NoteEventNames, exceptSubscriberKey: string): void;
+}
+export {};

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

@@ -138,12 +138,12 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
+    modelValue: AttributeMatrixEditorPublicItemBag[];
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    modelValue: AttributeMatrixEditorPublicItemBag[];
     defaultAttributeValues: Record<string, string>;
     minRows: number;
     maxRows: number;

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

@@ -0,0 +1,247 @@
+import { PropType } from "vue";
+import { NoteEditBag } from "@Obsidian/ViewModels/Controls/noteEditBag";
+import { SaveNoteRequestBag } from "@Obsidian/ViewModels/Controls/saveNoteRequestBag";
+import { NoteBag } from "@Obsidian/ViewModels/Controls/noteBag";
+import { NoteTypeBag } from "@Obsidian/ViewModels/Controls/noteTypeBag";
+declare const _default: import("vue").DefineComponent<{
+    /** The notes to be displayed in the container. */
+    notes: {
+        type: PropType<NoteBag[]>;
+        required: true;
+    };
+    /** The note types that are valid to display. */
+    noteTypes: {
+        type: PropType<NoteTypeBag[]>;
+        required: true;
+    };
+    /** The title of the panel header surrounding the notes. */
+    title: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /** The icon CSS class that will be displayed in the header. */
+    titleIconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /** `true` if notes should be displayed in descending order. */
+    descending: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the is alert option should be displayed when editing
+     * notes.
+     */
+    showAlert: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the created date time override should be displayed when
+     * editing notes.
+     */
+    showCreateDateOverride: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** `true` if the note type panel header should be displayed. */
+    showNoteTypeHeading: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the private option should be displayed when editing notes.
+     */
+    showPrivate: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the security button should be displayed when editing notes.
+     */
+    showSecurity: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** `true` if adding new notes is available. */
+    showAdd: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the add note editor should always be visible. Otherwise
+     * the person will have to click the add button to begin adding a note.
+     */
+    alwaysShowAdd: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** `true` if the person avatar should be shown when viewing notes. */
+    showAvatar: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** Contains the URL of the current person's avatar. */
+    personAvatarUrl: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /** `true` if the notes container is rendered in lightweight mode. */
+    lightMode: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** `true` if replies should be auto expanded. */
+    autoExpandReplies: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** The function to call to begin editing an existing note. */
+    onEditNote: {
+        type: PropType<(idKey: string) => NoteEditBag | Promise<NoteEditBag>>;
+        required: false;
+    };
+    /** The function to call to watch or unwatch a note. */
+    onWatchNote: {
+        type: PropType<(idKey: string, watching: boolean) => void | Promise<void>>;
+        required: false;
+    };
+    /** The function to call to save a new or edited note. */
+    onSaveNote: {
+        type: PropType<(note: SaveNoteRequestBag) => NoteBag | Promise<NoteBag>>;
+        required: false;
+    };
+    /** The function to call to delete an existing note. */
+    onDeleteNote: {
+        type: PropType<(idKey: string) => void | Promise<void>>;
+        required: false;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /** The notes to be displayed in the container. */
+    notes: {
+        type: PropType<NoteBag[]>;
+        required: true;
+    };
+    /** The note types that are valid to display. */
+    noteTypes: {
+        type: PropType<NoteTypeBag[]>;
+        required: true;
+    };
+    /** The title of the panel header surrounding the notes. */
+    title: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /** The icon CSS class that will be displayed in the header. */
+    titleIconCssClass: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /** `true` if notes should be displayed in descending order. */
+    descending: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the is alert option should be displayed when editing
+     * notes.
+     */
+    showAlert: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the created date time override should be displayed when
+     * editing notes.
+     */
+    showCreateDateOverride: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** `true` if the note type panel header should be displayed. */
+    showNoteTypeHeading: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the private option should be displayed when editing notes.
+     */
+    showPrivate: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the security button should be displayed when editing notes.
+     */
+    showSecurity: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** `true` if adding new notes is available. */
+    showAdd: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /**
+     * `true` if the add note editor should always be visible. Otherwise
+     * the person will have to click the add button to begin adding a note.
+     */
+    alwaysShowAdd: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** `true` if the person avatar should be shown when viewing notes. */
+    showAvatar: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** Contains the URL of the current person's avatar. */
+    personAvatarUrl: {
+        type: PropType<string | null | undefined>;
+        required: false;
+    };
+    /** `true` if the notes container is rendered in lightweight mode. */
+    lightMode: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** `true` if replies should be auto expanded. */
+    autoExpandReplies: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    /** The function to call to begin editing an existing note. */
+    onEditNote: {
+        type: PropType<(idKey: string) => NoteEditBag | Promise<NoteEditBag>>;
+        required: false;
+    };
+    /** The function to call to watch or unwatch a note. */
+    onWatchNote: {
+        type: PropType<(idKey: string, watching: boolean) => void | Promise<void>>;
+        required: false;
+    };
+    /** The function to call to save a new or edited note. */
+    onSaveNote: {
+        type: PropType<(note: SaveNoteRequestBag) => NoteBag | Promise<NoteBag>>;
+        required: false;
+    };
+    /** The function to call to delete an existing note. */
+    onDeleteNote: {
+        type: PropType<(idKey: string) => void | Promise<void>>;
+        required: false;
+    };
+}>>, {
+    showAlert: boolean;
+    showPrivate: boolean;
+    showSecurity: boolean;
+    descending: boolean;
+    showCreateDateOverride: boolean;
+    showNoteTypeHeading: boolean;
+    showAdd: boolean;
+    alwaysShowAdd: boolean;
+    showAvatar: boolean;
+    lightMode: boolean;
+    autoExpandReplies: boolean;
+}, {}>;
+export default _default;

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

@@ -110,8 +110,8 @@ declare const _default: import("vue").DefineComponent<{
     "onTreeitem-expanded"?: ((value: TreeItemBag) => any) | undefined;
     "onTreeitem-collapsed"?: ((value: TreeItemBag) => any) | undefined;
 }, {
-    multiple: boolean;
     modelValue: string[];
+    multiple: boolean;
     item: TreeItemBag;
     disableFolderSelection: boolean;
     initiallyExpanded: string[];

package/types/Controls/NoteEditor/editSourceCodePlugin.partial.obs.d.ts

@@ -133,8 +133,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         isPrevented: boolean;
     }) => any) | undefined;
 }, {
-    disabled: boolean;
     isShown: boolean;
+    disabled: boolean;
     editorHeight: number;
     mergeFields: string[] | undefined;
     startInCodeEditorMode: boolean;

package/types/Controls/NoteEditor/mergeFieldPlugin.partial.obs.d.ts

@@ -51,6 +51,15 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string[] | undefined>;
         required: false;
     };
+    /**
+     * A list of common merge field to show below the picker for easy access. Should be an array of strings
+     * and the strings should be in the following format: "FieldName^Label|Icon", where the FieldName is the
+     * name of the merge field, Label is the text to display on the button, and Icon is the CSS class for icon.
+     */
+    commonMergeFields: {
+        type: PropType<string[] | undefined>;
+        required: false;
+    };
     isIconHidden: {
         type: PropType<boolean>;
         default: boolean;
@@ -70,6 +79,15 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<string[] | undefined>;
         required: false;
     };
+    /**
+     * A list of common merge field to show below the picker for easy access. Should be an array of strings
+     * and the strings should be in the following format: "FieldName^Label|Icon", where the FieldName is the
+     * name of the merge field, Label is the text to display on the button, and Icon is the CSS class for icon.
+     */
+    commonMergeFields: {
+        type: PropType<string[] | undefined>;
+        required: false;
+    };
     isIconHidden: {
         type: PropType<boolean>;
         default: boolean;

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

@@ -107,16 +107,16 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
-    enhanceForLongLists: boolean;
+    multiple: boolean;
     displayPublicName: boolean;
     activeOnly: boolean;
     displayChildItemCountLabel: boolean;
+    enhanceForLongLists: boolean;
 }, {}>, {
     pickerContentSuperHeader?(_: {}): any;
     prepend?(_: {

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

@@ -123,17 +123,17 @@ declare const _default: import("vue").DefineComponent<{
 }, {
     label: string;
     help: string;
-    columnCount: number;
-    multiple: boolean;
     disableLabel: boolean;
     rules: import("@Obsidian/ValidationRules").ValidationRule | import("@Obsidian/ValidationRules").ValidationRule[];
     formGroupClasses: string;
     validationTitle: string;
     isRequiredIndicatorHidden: boolean;
+    multiple: boolean;
     enhanceForLongLists: boolean;
-    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     showBlankItem: boolean;
     blankValue: string;
+    lazyMode: import("@Obsidian/Enums/Controls/controlLazyMode").ControlLazyMode;
     displayStyle: import("@Obsidian/Enums/Controls/pickerDisplayStyle").PickerDisplayStyle;
+    columnCount: number;
 }, {}>;
 export default _default;