obsidian-dev-utils 16.2.0 → 16.4.0

package/dist/lib/obsidian/@types/Dataview/data-model/markdown.d.ts

@@ -1,109 +1,115 @@
-import type { DateTime } from "luxon";
-import type { FullIndex } from "../data-index/index.d.ts";
-import type { Literal, Link } from "../data-model/value.d.ts";
-import type { DataObject } from "../index.d.ts";
-import type { SListItem, SMarkdownPage } from "../data-model/serialized/markdown.d.ts";
-import type { Pos } from "obsidian";
+import type { DateTime } from 'luxon';
+import type { Pos } from 'obsidian';
+import type { FullIndex } from '../data-index/index.d.ts';
+import type {
+  SListItem,
+  SMarkdownPage
+} from '../data-model/serialized/markdown.d.ts';
+import type {
+  Link,
+  Literal
+} from '../data-model/value.d.ts';
+import type { DataObject } from '../index.d.ts';
 /** All extracted markdown file metadata obtained from a file. */
 export declare class PageMetadata {
-    /** The path this file exists at. */
-    path: string;
-    /** Obsidian-provided date this page was created. */
-    ctime: DateTime;
-    /** Obsidian-provided date this page was modified. */
-    mtime: DateTime;
-    /** Obsidian-provided size of this page in bytes. */
-    size: number;
-    /** The day associated with this page, if relevant. */
-    day?: DateTime;
-    /** The first H1/H2 header in the file. May not exist. */
-    title?: string;
-    /** All of the fields contained in this markdown file - both frontmatter AND in-file links. */
-    fields: Map<string, Literal>;
-    /** All of the exact tags (prefixed with '#') in this file overall. */
-    tags: Set<string>;
-    /** All of the aliases defined for this file. */
-    aliases: Set<string>;
-    /** All OUTGOING links (including embeds, header + block links) in this file. */
-    links: Link[];
-    /** All list items contained within this page. Filter for tasks to get just tasks. */
-    lists: ListItem[];
-    /** The raw frontmatter for this document. */
-    frontmatter: Record<string, Literal>;
-    constructor(path: string, init?: Partial<PageMetadata>);
-    /** Canonicalize raw links and other data in partial data with normalizers, returning a completed object. */
-    static canonicalize(data: Partial<PageMetadata>, linkNormalizer: (link: Link) => Link): PageMetadata;
-    /** The name (based on path) of this file. */
-    name(): string;
-    /** The containing folder (based on path) of this file. */
-    folder(): string;
-    /** The extension of this file (likely 'md'). */
-    extension(): string;
-    /** Return a set of tags AND all of their parent tags (so #hello/yes would become #hello, #hello/yes). */
-    fullTags(): Set<string>;
-    /** Convert all links in this file to file links. */
-    fileLinks(): Link[];
-    /** Map this metadata to a full object; uses the index for additional data lookups.  */
-    serialize(index: FullIndex, cache?: ListSerializationCache): SMarkdownPage;
+  /** The path this file exists at. */
+  path: string;
+  /** Obsidian-provided date this page was created. */
+  ctime: DateTime;
+  /** Obsidian-provided date this page was modified. */
+  mtime: DateTime;
+  /** Obsidian-provided size of this page in bytes. */
+  size: number;
+  /** The day associated with this page, if relevant. */
+  day?: DateTime;
+  /** The first H1/H2 header in the file. May not exist. */
+  title?: string;
+  /** All of the fields contained in this markdown file - both frontmatter AND in-file links. */
+  fields: Map<string, Literal>;
+  /** All of the exact tags (prefixed with '#') in this file overall. */
+  tags: Set<string>;
+  /** All of the aliases defined for this file. */
+  aliases: Set<string>;
+  /** All OUTGOING links (including embeds, header + block links) in this file. */
+  links: Link[];
+  /** All list items contained within this page. Filter for tasks to get just tasks. */
+  lists: ListItem[];
+  /** The raw frontmatter for this document. */
+  frontmatter: Record<string, Literal>;
+  constructor(path: string, init?: Partial<PageMetadata>);
+  /** Canonicalize raw links and other data in partial data with normalizers, returning a completed object. */
+  static canonicalize(data: Partial<PageMetadata>, linkNormalizer: (link: Link) => Link): PageMetadata;
+  /** The name (based on path) of this file. */
+  name(): string;
+  /** The containing folder (based on path) of this file. */
+  folder(): string;
+  /** The extension of this file (likely 'md'). */
+  extension(): string;
+  /** Return a set of tags AND all of their parent tags (so #hello/yes would become #hello, #hello/yes). */
+  fullTags(): Set<string>;
+  /** Convert all links in this file to file links. */
+  fileLinks(): Link[];
+  /** Map this metadata to a full object; uses the index for additional data lookups.  */
+  serialize(index: FullIndex, cache?: ListSerializationCache): SMarkdownPage;
 }
 /** A list item inside of a list. */
 export declare class ListItem {
-    /** The symbol ('*', '-', '1.') used to define this list item. */
-    symbol: string;
-    /** A link which points to this task, or to the closest block that this task is contained in. */
-    link: Link;
-    /** A link to the section that contains this list element; could be a file if this is not in a section. */
-    section: Link;
-    /** The text of this list item. This may be multiple lines of markdown. */
-    text: string;
-    /** The line that this list item starts on in the file. */
-    line: number;
-    /** The number of lines that define this list item. */
-    lineCount: number;
-    /** The line number for the first list item in the list this item belongs to. */
-    list: number;
-    /** Any links contained within this list item. */
-    links: Link[];
-    /** The tags contained within this list item. */
-    tags: Set<string>;
-    /** The raw Obsidian-provided position for where this task is. */
-    position: Pos;
-    /** The line number of the parent list item, if present; if this is undefined, this is a root item. */
-    parent?: number;
-    /** The line numbers of children of this list item. */
-    children: number[];
-    /** The block ID for this item, if one is present. */
-    blockId?: string;
-    /** Any fields defined in this list item. For tasks, this includes fields underneath the task. */
-    fields: Map<string, Literal[]>;
-    task?: {
-        /** The text in between the brackets of the '[ ]' task indicator ('[X]' would yield 'X', for example.) */
-        status: string;
-        /** Whether or not this task has been checked in any way (it's status is not empty/space). */
-        checked: boolean;
-        /** Whether or not this task was completed; derived from 'status' by checking if the field 'X' or 'x'. */
-        completed: boolean;
-        /** Whether or not this task and all of it's subtasks are completed. */
-        fullyCompleted: boolean;
-    };
-    constructor(init?: Partial<ListItem>);
-    id(): string;
-    file(): Link;
-    markdown(): string;
-    created(): Literal | undefined;
-    due(): Literal | undefined;
-    completed(): Literal | undefined;
-    start(): Literal | undefined;
-    scheduled(): Literal | undefined;
-    /** Create an API-friendly copy of this list item. De-duplication is done via the provided cache. */
-    serialize(cache: ListSerializationCache): SListItem;
+  /** The symbol ('*', '-', '1.') used to define this list item. */
+  symbol: string;
+  /** A link which points to this task, or to the closest block that this task is contained in. */
+  link: Link;
+  /** A link to the section that contains this list element; could be a file if this is not in a section. */
+  section: Link;
+  /** The text of this list item. This may be multiple lines of markdown. */
+  text: string;
+  /** The line that this list item starts on in the file. */
+  line: number;
+  /** The number of lines that define this list item. */
+  lineCount: number;
+  /** The line number for the first list item in the list this item belongs to. */
+  list: number;
+  /** Any links contained within this list item. */
+  links: Link[];
+  /** The tags contained within this list item. */
+  tags: Set<string>;
+  /** The raw Obsidian-provided position for where this task is. */
+  position: Pos;
+  /** The line number of the parent list item, if present; if this is undefined, this is a root item. */
+  parent?: number;
+  /** The line numbers of children of this list item. */
+  children: number[];
+  /** The block ID for this item, if one is present. */
+  blockId?: string;
+  /** Any fields defined in this list item. For tasks, this includes fields underneath the task. */
+  fields: Map<string, Literal[]>;
+  task?: {
+    /** The text in between the brackets of the '[ ]' task indicator ('[X]' would yield 'X', for example.) */
+    status: string;
+    /** Whether or not this task has been checked in any way (it's status is not empty/space). */
+    checked: boolean;
+    /** Whether or not this task was completed; derived from 'status' by checking if the field 'X' or 'x'. */
+    completed: boolean;
+    /** Whether or not this task and all of it's subtasks are completed. */
+    fullyCompleted: boolean;
+  };
+  constructor(init?: Partial<ListItem>);
+  id(): string;
+  file(): Link;
+  markdown(): string;
+  created(): Literal | undefined;
+  due(): Literal | undefined;
+  completed(): Literal | undefined;
+  start(): Literal | undefined;
+  scheduled(): Literal | undefined;
+  /** Create an API-friendly copy of this list item. De-duplication is done via the provided cache. */
+  serialize(cache: ListSerializationCache): SListItem;
 }
 /** De-duplicates list items across section metadata and page metadata. */
 export declare class ListSerializationCache {
-    listItems: Record<number, ListItem>;
-    cache: Record<number, SListItem>;
-    seen: Set<number>;
-    constructor(listItems: ListItem[]);
-    get(lineno: number): SListItem | undefined;
+  listItems: Record<number, ListItem>;
+  cache: Record<number, SListItem>;
+  seen: Set<number>;
+  constructor(listItems: ListItem[]);
+  get(lineno: number): SListItem | undefined;
 }
 export declare function addFields(fields: Map<string, Literal[]>, target: DataObject): DataObject;

package/dist/lib/obsidian/@types/Dataview/data-model/serialized/markdown.d.ts

@@ -1,103 +1,106 @@
 /** Serialized / API facing data types for Dataview objects. */
-import type { Link, Literal } from "../../data-model/value.d.ts";
-import type { DateTime } from "luxon";
-import type { Pos } from "obsidian";
+import type { DateTime } from 'luxon';
+import type { Pos } from 'obsidian';
+import type {
+  Link,
+  Literal
+} from '../../data-model/value.d.ts';
 export interface SMarkdownPage {
-    file: {
-        path: string;
-        folder: string;
-        name: string;
-        link: Link;
-        outlinks: Link[];
-        inlinks: Link[];
-        etags: string[];
-        tags: string[];
-        aliases: string[];
-        lists: SListItem[];
-        tasks: STask[];
-        ctime: DateTime;
-        cday: DateTime;
-        mtime: DateTime;
-        mday: DateTime;
-        size: number;
-        ext: string;
-        starred: boolean;
-        day?: DateTime;
-    };
-    /** Additional fields added by field data. */
-    [key: string]: any;
+  file: {
+    path: string;
+    folder: string;
+    name: string;
+    link: Link;
+    outlinks: Link[];
+    inlinks: Link[];
+    etags: string[];
+    tags: string[];
+    aliases: string[];
+    lists: SListItem[];
+    tasks: STask[];
+    ctime: DateTime;
+    cday: DateTime;
+    mtime: DateTime;
+    mday: DateTime;
+    size: number;
+    ext: string;
+    starred: boolean;
+    day?: DateTime;
+  };
+  /** Additional fields added by field data. */
+  [key: string]: any;
 }
 /** A serialized list item. */
 export type SListItem = SListEntry | STask;
 /** Shared data between list items. */
 export interface SListItemBase {
-    /** The symbol used to start this list item, like '1.' or '1)' or '*'. */
-    symbol: string;
-    /** A link to the closest thing to this list item (a block, a section, or a file). */
-    link: Link;
-    /** The section that contains this list item. */
-    section: Link;
-    /** The path of the file that contains this item. */
-    path: string;
-    /** The line this item starts on. */
-    line: number;
-    /** The number of lines this item spans. */
-    lineCount: number;
-    /** The internal Obsidian tracker of the exact position of this line. */
-    position: Pos;
-    /** The line number of the list that this item is part of. */
-    list: number;
-    /** If present, the block ID for this item. */
-    blockId?: string;
-    /** The line number of the parent item to this list, if relevant. */
-    parent?: number;
-    /** The children elements of this list item. */
-    children: SListItem[];
-    /** Links contained inside this list item. */
-    outlinks: Link[];
-    /** The raw text of this item. */
-    text: string;
-    /**
-     * If present, overrides 'text' when rendered in task views. You should not mutate 'text' since it is used to
-     * validate a list item when editing it.
-     */
-    visual?: string;
-    /** Whether this item has any metadata annotations on it. */
-    annotated?: boolean;
-    /** Any tags present in this task. */
-    tags: string[];
-    /** @deprecated use 'children' instead. */
-    subtasks: SListItem[];
-    /** @deprecated use 'task' instead. */
-    real: boolean;
-    /** @deprecated use 'section' instead. */
-    header: Link;
-    /** Additional fields added by annotations. */
-    [key: string]: any;
+  /** The symbol used to start this list item, like '1.' or '1)' or '*'. */
+  symbol: string;
+  /** A link to the closest thing to this list item (a block, a section, or a file). */
+  link: Link;
+  /** The section that contains this list item. */
+  section: Link;
+  /** The path of the file that contains this item. */
+  path: string;
+  /** The line this item starts on. */
+  line: number;
+  /** The number of lines this item spans. */
+  lineCount: number;
+  /** The internal Obsidian tracker of the exact position of this line. */
+  position: Pos;
+  /** The line number of the list that this item is part of. */
+  list: number;
+  /** If present, the block ID for this item. */
+  blockId?: string;
+  /** The line number of the parent item to this list, if relevant. */
+  parent?: number;
+  /** The children elements of this list item. */
+  children: SListItem[];
+  /** Links contained inside this list item. */
+  outlinks: Link[];
+  /** The raw text of this item. */
+  text: string;
+  /**
+   * If present, overrides 'text' when rendered in task views. You should not mutate 'text' since it is used to
+   * validate a list item when editing it.
+   */
+  visual?: string;
+  /** Whether this item has any metadata annotations on it. */
+  annotated?: boolean;
+  /** Any tags present in this task. */
+  tags: string[];
+  /** @deprecated use 'children' instead. */
+  subtasks: SListItem[];
+  /** @deprecated use 'task' instead. */
+  real: boolean;
+  /** @deprecated use 'section' instead. */
+  header: Link;
+  /** Additional fields added by annotations. */
+  [key: string]: any;
 }
 /** A serialized list item as seen by users; this is not a task. */
 export interface SListEntry extends SListItemBase {
-    task: false;
+  task: false;
 }
 /** A serialized task. */
 export interface STask extends SListItemBase {
-    task: true;
-    /** The status of this task, the text between the brackets ('[ ]'). Will be a space if the task is currently unchecked. */
-    status: string;
-    /** Indicates whether the task has any value other than empty space. */
-    checked: boolean;
-    /** Indicates whether the task explicitly has been marked "completed" ('x' or 'X'). */
-    completed: boolean;
-    /** Indicates whether the task and ALL subtasks have been completed. */
-    fullyCompleted: boolean;
-    /** If present, then the time that this task was created. */
-    created?: Literal;
-    /** If present, then the time that this task was due. */
-    due?: Literal;
-    /** If present, then the time that this task was completed. */
-    completion?: Literal;
-    /** If present, then the day that this task can be started. */
-    start?: Literal;
-    /** If present, then the day that work on this task is scheduled. */
-    scheduled?: Literal;
+  task: true;
+  /** The status of this task, the text between the brackets ('[ ]'). Will be a space if the task is currently unchecked. */
+  status: string;
+  /** Indicates whether the task has any value other than empty space. */
+  checked: boolean;
+  /** Indicates whether the task explicitly has been marked "completed" ('x' or 'X'). */
+  completed: boolean;
+  /** Indicates whether the task and ALL subtasks have been completed. */
+  fullyCompleted: boolean;
+  /** If present, then the time that this task was created. */
+  created?: Literal;
+  /** If present, then the time that this task was due. */
+  due?: Literal;
+  /** If present, then the time that this task was completed. */
+  completion?: Literal;
+  /** If present, then the day that this task can be started. */
+  start?: Literal;
+  /** If present, then the day that work on this task is scheduled. */
+  scheduled?: Literal;
 }

package/dist/lib/obsidian/@types/Dataview/data-model/transferable.d.ts

@@ -1,7 +1,7 @@
 /** Simplifies passing dataview values across the JS web worker barrier. */
 export declare namespace Transferable {
-    /** Convert a literal value to a serializer-friendly transferable value. */
-    function transferable(value: any): any;
-    /** Convert a transferable value back to a literal value we can work with. */
-    function value(transferable: any): any;
+  /** Convert a literal value to a serializer-friendly transferable value. */
+  function transferable(value: any): any;
+  /** Convert a transferable value back to a literal value we can work with. */
+  function value(transferable: any): any;
 }