@rockrms/obsidian-framework 18.2.4 → 19.1.8

package/types/Controls/Internal/pageDebugTraceRow.partial.obs.d.ts

@@ -0,0 +1,67 @@
+import { PropType } from "vue";
+import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+type TraceRecordBag = {
+    traceId?: string | null;
+    spanId?: string | null;
+    parentSpanId?: string | null;
+    status?: string | null;
+    name?: string | null;
+    startTime: number;
+    duration: number;
+    tags?: ListItemBag[] | null;
+};
+type TraceRecordTreeBag = TraceRecordBag & {
+    children: TraceRecordTreeBag[];
+    queries: number;
+    parent: TraceRecordTreeBag | null;
+};
+declare const _default: import("vue").DefineComponent<{
+    trace: {
+        type: PropType<TraceRecordTreeBag>;
+        required: true;
+    };
+    indentLevel: {
+        type: PropType<number>;
+        required: true;
+    };
+    isExpanded: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    startMs: {
+        type: PropType<number>;
+        required: true;
+    };
+    totalMs: {
+        type: PropType<number>;
+        required: true;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    select: (trace: TraceRecordTreeBag) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    trace: {
+        type: PropType<TraceRecordTreeBag>;
+        required: true;
+    };
+    indentLevel: {
+        type: PropType<number>;
+        required: true;
+    };
+    isExpanded: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    startMs: {
+        type: PropType<number>;
+        required: true;
+    };
+    totalMs: {
+        type: PropType<number>;
+        required: true;
+    };
+}>> & {
+    onSelect?: ((trace: TraceRecordTreeBag) => any) | undefined;
+}, {
+    isExpanded: boolean;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,49 @@
+import { PropType } from "vue";
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The current text being used for the quick filter search box.
+     * The quick filter will only be shown if this value is not undefined.
+     */
+    modelValue: {
+        type: PropType<string | undefined>;
+        default: undefined;
+    };
+    /** Additional CSS classes to apply to the quick filter container element. */
+    quickFilterClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    /** Additional CSS classes to apply to the quick filter button element. */
+    quickFilterButtonClass: {
+        type: PropType<string>;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: string) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The current text being used for the quick filter search box.
+     * The quick filter will only be shown if this value is not undefined.
+     */
+    modelValue: {
+        type: PropType<string | undefined>;
+        default: undefined;
+    };
+    /** Additional CSS classes to apply to the quick filter container element. */
+    quickFilterClass: {
+        type: PropType<string>;
+        default: string;
+    };
+    /** Additional CSS classes to apply to the quick filter button element. */
+    quickFilterButtonClass: {
+        type: PropType<string>;
+        default: string;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
+}, {
+    modelValue: string | undefined;
+    quickFilterClass: string;
+    quickFilterButtonClass: string;
+}, {}>;
+export default _default;

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

@@ -1,20 +1,21 @@
 import { PropType } from "vue";
+import { Guid } from "@Obsidian/Types";
 import { BtnSize } from "@Obsidian/Enums/Controls/btnSize";
 declare const _default: import("vue").DefineComponent<{
     contextEntityGuid: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         required: true;
     };
     contextEntityTypeGuid: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         required: true;
     };
     viewRemindersPage: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         default: string;
     };
     editReminderPage: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         default: string;
     };
     btnSize: {
@@ -22,22 +23,22 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
-    addSuccess: () => void;
+    addSuccess: (value: string) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
     contextEntityGuid: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         required: true;
     };
     contextEntityTypeGuid: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         required: true;
     };
     viewRemindersPage: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         default: string;
     };
     editReminderPage: {
-        type: PropType<string>;
+        type: PropType<Guid>;
         default: string;
     };
     btnSize: {
@@ -45,7 +46,7 @@ declare const _default: import("vue").DefineComponent<{
         default: "";
     };
 }>> & {
-    onAddSuccess?: (() => any) | undefined;
+    onAddSuccess?: ((value: string) => any) | undefined;
 }, {
     btnSize: BtnSize;
     viewRemindersPage: string;

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

@@ -0,0 +1,85 @@
+import { PropType } from "vue";
+import { Guid } from "@Obsidian/Types";
+declare var __VLS_63: {};
+type __VLS_Slots = {} & {
+    postBody?: (props: typeof __VLS_63) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<{
+    modelValue: {
+        type: PropType<boolean>;
+        required: true;
+    };
+    contextEntityGuid: {
+        type: PropType<Guid>;
+        required: true;
+    };
+    contextEntityTypeGuid: {
+        type: PropType<Guid>;
+        required: true;
+    };
+    viewRemindersPage: {
+        type: PropType<Guid>;
+        default: string;
+    };
+    editReminderPage: {
+        type: PropType<Guid>;
+        default: string;
+    };
+    areDetailsRequired: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    isAdditionalOptionsLinkVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "update:modelValue": (value: boolean) => void;
+    addSuccess: (value: string) => void;
+    reminderClosed: (value: string) => void;
+}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: PropType<boolean>;
+        required: true;
+    };
+    contextEntityGuid: {
+        type: PropType<Guid>;
+        required: true;
+    };
+    contextEntityTypeGuid: {
+        type: PropType<Guid>;
+        required: true;
+    };
+    viewRemindersPage: {
+        type: PropType<Guid>;
+        default: string;
+    };
+    editReminderPage: {
+        type: PropType<Guid>;
+        default: string;
+    };
+    areDetailsRequired: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+    isAdditionalOptionsLinkVisible: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((value: boolean) => any) | undefined;
+    onAddSuccess?: ((value: string) => any) | undefined;
+    onReminderClosed?: ((value: string) => any) | undefined;
+}, {
+    viewRemindersPage: string;
+    editReminderPage: string;
+    areDetailsRequired: boolean;
+    isAdditionalOptionsLinkVisible: boolean;
+}, {}>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

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

@@ -1,6 +1,6 @@
 import { PropType } from "vue";
 import { FormError } from "@Obsidian/Utility/form";
-type Settings = {};
+type Settings = Record<string, never>;
 declare const _default: import("vue").DefineComponent<{
     settings: {
         type: PropType<Settings>;

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

@@ -51,8 +51,17 @@ declare const _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * If enabled then an icon will be shown next to folder items to allow
+     * selecting all children and descendant items of that folder.
+     */
+    showSelectChildren: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     "update:modelValue": (value: string[]) => void;
+    "update:items": (value: TreeItemBag[]) => void;
     "treeitem-expanded": (value: TreeItemBag) => void;
     "treeitem-collapsed": (value: TreeItemBag) => void;
 }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
@@ -105,18 +114,28 @@ declare const _default: import("vue").DefineComponent<{
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * If enabled then an icon will be shown next to folder items to allow
+     * selecting all children and descendant items of that folder.
+     */
+    showSelectChildren: {
+        type: PropType<boolean>;
+        default: boolean;
+    };
 }>> & {
     "onUpdate:modelValue"?: ((value: string[]) => any) | undefined;
+    "onUpdate:items"?: ((value: TreeItemBag[]) => any) | undefined;
     "onTreeitem-expanded"?: ((value: TreeItemBag) => any) | undefined;
     "onTreeitem-collapsed"?: ((value: TreeItemBag) => any) | undefined;
 }, {
+    item: TreeItemBag;
     modelValue: string[];
     multiple: boolean;
-    item: TreeItemBag;
     disableFolderSelection: boolean;
     initiallyExpanded: string[];
     autoExpand: boolean;
     showChildCount: boolean;
     enableDeselect: boolean;
+    showSelectChildren: boolean;
 }, {}>;
 export default _default;

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

@@ -32,8 +32,8 @@ declare const _default: import("vue").DefineComponent<{
         }[];
     };
 }>> & {
-    "onUpdate:modelValue"?: ((v: string) => any) | undefined;
     onDelete?: (() => any) | undefined;
+    "onUpdate:modelValue"?: ((v: string) => any) | undefined;
 }, {
     comparisonTypes: ComparisonItem[];
 }, {}>;

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

@@ -1,25 +1,3 @@
-/**
- * CountDownPlugin - Adds a count-down badge component wherever this plugin is placed.
- * The badge displays the character count remaining that can be entered.
- *
- * Note: This plugin does NOT validate or limit the number of characters that can be entered.
- * Note: This plugin can display negative values.
- *
- * @example
- * <!--
- *      someEditorHost.obs - This example shows just enough code to wire up the plugin.
- *      FYI, the Vue - Official extension complains if template and script tags are used in comments,
- *      so using (template) and (script) for now.
- * -->
- * (template)
- *   <CountDownPlugin :modelValue="internalValue"
- *                    :countDownMaxChars="countDownMaxChars" />
- * (/template)
- *
- * (script setup lang="ts")
- *   import CountDownPlugin from "./NoteEditor/countDownPlugin.partial.obs";
- * (/script)
- */
 import { PropType } from "vue";
 declare const _default: import("vue").DefineComponent<{
     modelValue: {

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

@@ -1,58 +1,11 @@
-/**
- * EditSourceCodePlugin - Adds a toolbar button for editing the source code of the editor.
- *
- * @example
- * <!--
- *      someEditorHost.obs - This example shows just enough code to wire up the plugin.
- *      FYI, the Vue - Official extension complains if template and script tags are used in comments,
- *      so using (template) and (script) for now.
- * -->
- * (template)
-*    <EditSourceCodePlugin v-model="internalValue"
-*                          :disabled="disabled"
-*                          :editorHeight="editorHeight"
-*                          :mergeFields="mergeFields"
-*                          ref="editSourceCodePlugin"
-*                          :startInCodeEditorMode="startInCodeEditorMode">
-*      <template #default="{ isEditorShown }">
-*        <div v-show="!isEditorShown" id="uniqueEditorId"></div>
-*      </template>
-*    </EditSourceCodePlugin>
- * (/template)
- *
- * (script setup lang="ts")
- *   import EditSourceCodePlugin from "./NoteEditor/editSourceCodePlugin.partial.obs";
- *   ...
- *
- *   const editSourceCodePlugin = ref<InstanceType<typeof EditSourceCodePlugin> | undefined>();
- *   ...
- *
- *   // The host must provide the plugins feature.
- *   const pluginManager = providePluginsFeature({
- *       editorInstance: computed(() => tinyMceInstance.value),
- *       toolbarElement: computed(() => toolbarElement.value)
- *   });
- *   ...
- *
- *   // Initialize the editor.
- *   onMounted(() => {
- *     ...
- *
- *     tinymce.init({
- *       // The edit source code button can be placed anywhere in this configuration string.
- *       // Here, the toolbar will display
- *       // the edit source code button, followed by a separator character,
- *       // then the undo and redo buttons.
- *       // Reference: https://www.tiny.cloud/docs/tinymce/6/toolbar-configuration-options/#example-grouped-toolbar
- *       toolbar: `${editSourceCodePlugin.value?.id} | undo redo`
- *     });
- *
- *     ...
- *   });
- * (/script)
- */
 import { PropType } from "vue";
-declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
+declare var __VLS_1: {
+    isEditorShown: boolean;
+};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<{
     modelValue: {
         type: PropType<string>;
         required: true;
@@ -133,19 +86,16 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<{
         isPrevented: boolean;
     }) => any) | undefined;
 }, {
-    isShown: boolean;
     disabled: boolean;
+    isShown: boolean;
     editorHeight: number;
     mergeFields: string[] | undefined;
     startInCodeEditorMode: boolean;
     isTogglableCodeEditorForced: boolean;
-}, {}>, {
-    default?(_: {
-        isEditorShown: boolean;
-    }): any;
-}>;
+}, {}>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };

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

@@ -1,50 +1,3 @@
-/**
- * MergeFieldPlugin - Adds a toolbar button for adding a merge field at the current
- * cursor position in the editor.
- *
- * @example
- * <!--
- *      someEditorHost.obs - This example shows just enough code to wire up the plugin.
- *      FYI, the Vue - Official extension complains if template and script tags are used in comments,
- *      so using (template) and (script) for now.
- * -->
- * (template)
- *   <div id="uniqueEditorId">
- *     <MergeFieldPlugin ref="mergeFieldPlugin" />
- *   </div>
- * (/template)
- *
- * (script setup lang="ts")
- *   import MergeFieldPlugin from "./NoteEditor/mergeFieldPlugin.partial.obs";
- *   ...
- *
- *   const mergeFieldPlugin = ref<InstanceType<typeof MergeFieldPlugin> | undefined>();
- *   ...
- *
- *   // The host must provide the plugins feature.
- *   const pluginManager = providePluginsFeature({
- *       editorInstance: computed(() => tinyMceInstance.value),
- *       toolbarElement: computed(() => toolbarElement.value)
- *   });
- *   ...
- *
- *   // Initialize the editor.
- *   onMounted(() => {
- *     ...
- *
- *     tinymce.init({
- *       // The merge field button can be placed anywhere in this configuration string.
- *       // Here, the toolbar will display
- *       // the merge field button, followed by a separator character,
- *       // then the undo and redo buttons.
- *       // Reference: https://www.tiny.cloud/docs/tinymce/6/toolbar-configuration-options/#example-grouped-toolbar
- *       toolbar: `${mergeFieldPlugin.value?.id} | undo redo`
- *     });
- *
- *     ...
- *   });
- * (/script)
- */
 import { PropType } from "vue";
 declare const _default: import("vue").DefineComponent<{
     mergeFields: {

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

@@ -1,52 +1,6 @@
-/**
- * ShortLinkPlugin - Adds a toolbar button for adding a short link at the current
- * cursor position in the editor.
- *
- * @example
- * <!--
- *      someEditorHost.obs - This example shows just enough code to wire up the plugin.
- *      FYI, the Vue - Official extension complains if template and script tags are used in comments,
- *      so using (template) and (script) for now.
- * -->
- * (template)
- *   <div id="uniqueEditorId">
- *     <ShortLinkPlugin ref="shortLinkPlugin" />
- *   </div>
- * (/template)
- *
- * (script setup lang="ts")
- *   import ShortLinkPlugin from "./NoteEditor/shortLinkPlugin.partial.obs";
- *   ...
- *
- *   const shortLinkPlugin = ref<InstanceType<typeof ShortLinkPlugin> | undefined>();
- *   ...
- *
- *   // The host must provide the plugins feature.
- *   const pluginManager = providePluginsFeature({
- *       editorInstance: computed(() => tinyMceInstance.value),
- *       toolbarElement: computed(() => toolbarElement.value)
- *   });
- *   ...
- *
- *   // Initialize the editor.
- *   onMounted(() => {
- *     ...
- *
- *     tinymce.init({
- *       // The short link button can be placed anywhere in this configuration string.
- *       // Here, the toolbar will display
- *       // the short link button, followed by a separator character,
- *       // then the undo and redo buttons.
- *       // Reference: https://www.tiny.cloud/docs/tinymce/6/toolbar-configuration-options/#example-grouped-toolbar
- *       toolbar: `${shortLinkPlugin.value?.id} | undo redo`
- *     });
- *
- *     ...
- *   });
- * (/script)
- */
 import { PropType } from "vue";
 import { ListItemBag } from "@Obsidian/ViewModels/Utility/listItemBag";
+import { Guid } from "@Obsidian/Types";
 declare const _default: import("vue").DefineComponent<{
     checkToken: {
         type: PropType<((token: string, siteId: number) => Promise<string>) | null | undefined>;
@@ -71,7 +25,7 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<number | null | undefined>;
     };
     getPageId: {
-        type: PropType<((pageGuid: string) => Promise<number | null | undefined>) | null | undefined>;
+        type: PropType<((pageGuid: Guid) => Promise<number | null | undefined>) | null | undefined>;
         required: true;
     };
 }, {
@@ -100,7 +54,7 @@ declare const _default: import("vue").DefineComponent<{
         type: PropType<number | null | undefined>;
     };
     getPageId: {
-        type: PropType<((pageGuid: string) => Promise<number | null | undefined>) | null | undefined>;
+        type: PropType<((pageGuid: Guid) => Promise<number | null | undefined>) | null | undefined>;
         required: true;
     };
 }>>, {

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

@@ -1,38 +1,3 @@
-/**
- * StylesheetsPlugin - Adds stylesheets (<style> tag) support to a note editor.
- *
- * <style> tags added to the note editor are internally scoped by this plugin so
- * they do not bleed out to other parts of the page. To accomplish this, the
- * plugin requires two input properties that tell it which elements to treat as
- * the "html" and "body" CSS selectors within the <style> tags.
- *
- * Note: This plugin does not add a toolbar button.
- *
- * @example
- * <!--
- *      someEditorHost.obs - This example shows just enough code to wire up the plugin.
- *      FYI, the Vue - Official extension complains if template and script tags are used in comments,
- *      so using (template) and (script) for now.
- * -->
- * (template)
- *   <div id="uniqueWrapperId">
- *     <div id="uniqueEditorId">
- *       <StylesheetsPlugin htmlCssReplacementSelector="uniqueWrapperId"
- *                          bodyCssReplacementSelector="uniqueEditorId" />
- *     </div>
- *   </div>
- * (/template)
- *
- * (script setup lang="ts")
- *   import StylesheetsPlugin from "./NoteEditor/stylesheetsPlugin.partial.obs";
- *
- *   // The host must provide the plugins feature.
- *   const pluginManager = providePluginsFeature({
- *       editorInstance: computed(() => tinyMceInstance.value),
- *       toolbarElement: computed(() => toolbarElement.value)
- *   });
- * (/script)
- */
 import { PropType } from "vue";
 declare const _default: import("vue").DefineComponent<{
     /**

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

@@ -1,48 +1,3 @@
-/**
- * ToolbarCharCountPlugin - Adds a character count badge to a note editor toolbar.
- *
- * @example
- * <!--
- *      someEditorHost.obs - This example shows just enough code to wire up the plugin.
- *      FYI, the Vue - Official extension complains if template and script tags are used in comments,
- *      so using (template) and (script) for now.
- * -->
- * (template)
- *   <ToolbarCharCountPlugin :modelValue="internalValue" />
- * (/template)
- *
- * (script setup lang="ts")
- *   import ToolbarCharCountPlugin from "./NoteEditor/toolbarCharCountPlugin.partial.obs";
- *   ...
- *
- *   const toolbarCharCountPlugin = ref<InstanceType<typeof ToolbarCharCountPlugin> | undefined>();
- *   ...
- *
- *   // The host must provide the plugins feature.
- *   const pluginManager = providePluginsFeature({
- *       editorInstance: computed(() => tinyMceInstance.value),
- *       toolbarElement: computed(() => toolbarElement.value)
- *   });
- *   ...
- *
- *   // Initialize the editor.
- *   onMounted(() => {
- *     ...
- *
- *     tinymce.init({
- *       // The toolbar label can be placed anywhere in this configuration string.
- *       // Here, the toolbar will display
- *       // the character count on the left, followed by a separator character,
- *       // then the undo and redo buttons.
- *       // Reference: https://www.tiny.cloud/docs/tinymce/6/toolbar-configuration-options/#example-grouped-toolbar
- *       toolbar: `${toolbarCharCountPlugin.value?.id} | undo redo`
- *     });
- *
- *     ...
- *   });
- *   ...
- * (/script)
- */
 import { PropType } from "vue";
 declare const _default: import("vue").DefineComponent<{
     modelValue: {