@mnaoumov/obsidian-lib 2.0.0 → 3.0.0

package/dist/lib/cjs/@types/dataview/data-index/index.d.cts

@@ -1,187 +0,0 @@
-/// <reference path="../../../library.d.cts" />
-/** Stores various indices on all files in the vault to make dataview generation fast. */
-import type { DateTime } from 'luxon' with { 'resolution-mode': 'import' };
-import type {
-  App,
-  Component,
-  MetadataCache,
-  TAbstractFile,
-  TFile,
-  Vault
-} from 'obsidian';
-import type { Result } from '../api/result.d.cjs';
-import type { LocalStorageCache } from '../data-import/persister.d.cjs';
-import type { FileImporter } from '../data-import/web-worker/import-manager.d.cjs';
-import type { PageMetadata } from '../data-model/markdown.d.cjs';
-import type { DataObject } from '../data-model/value.d.cjs';
-/** Aggregate index which has several sub-indices and will initialize all of them. */
-export declare class FullIndex extends Component {
-  app: App;
-  indexVersion: string;
-  onChange: () => void;
-  /** Generate a full index from the given vault. */
-  static create(app: App, indexVersion: string, onChange: () => void): FullIndex;
-  /** Whether all files in the vault have been indexed at least once. */
-  initialized: boolean;
-  /** I/O access to the Obsidian vault contents. */
-  vault: Vault;
-  /** Access to in-memory metadata, useful for parsing and metadata lookups. */
-  metadataCache: MetadataCache;
-  /** Persistent IndexedDB backing store, used for faster startup. */
-  persister: LocalStorageCache;
-  pages: Map<string, PageMetadata>;
-  /** Map files -> tags in that file, and tags -> files. This version includes subtags. */
-  tags: ValueCaseInsensitiveIndexMap;
-  /** Map files -> exact tags in that file, and tags -> files. This version does not automatically add subtags. */
-  etags: ValueCaseInsensitiveIndexMap;
-  /** Map files -> linked files in that file, and linked file -> files that link to it. */
-  links: IndexMap;
-  /** Search files by path prefix. */
-  prefix: PrefixIndex;
-  /** Allows for efficient lookups of whether a file is starred or not. */
-  starred: StarredCache;
-  /** Caches data in CSV files. */
-  csv: CsvCache;
-  /**
-   * The current "revision" of the index, which monotonically increases for every index change. Use this to determine
-   * if you are up to date.
-   */
-  revision: number;
-  /** Asynchronously parses files in the background using web workers. */
-  importer: FileImporter;
-  /** Construct a new index using the app data and a current data version. */
-  private constructor();
-  /** Trigger a metadata event on the metadata cache. */
-  private trigger;
-  /** "Touch" the index, incrementing the revision number and causing downstream views to reload. */
-  touch(): void;
-  /** Runs through the whole vault to set up initial file metadata. */
-  initialize(): void;
-  /** Drops the local storage cache and re-indexes all files; this should generally be used if you expect cache issues. */
-  reinitialize(): Promise<void>;
-  /** Internal asynchronous initializer. */
-  private _initialize;
-  rename(file: TAbstractFile, oldPath: string): void;
-  /** Queue a file for reloading; this is done asynchronously in the background and may take a few seconds. */
-  reload(file: TFile): Promise<{
-    cached: boolean;
-    skipped: boolean;
-  }>;
-  /** Import a file directly from disk, skipping the cache. */
-  private import;
-  /** Finish the reloading of file metadata by adding it to in memory indexes. */
-  private finish;
-}
-/** Indexes files by their full prefix - essentially a simple prefix tree. */
-export declare class PrefixIndex extends Component {
-  vault: Vault;
-  updateRevision: () => void;
-  static create(vault: Vault, updateRevision: () => void): PrefixIndex;
-  constructor(vault: Vault, updateRevision: () => void);
-  private walk;
-  /** Get the list of all files under the given path. */
-  get(prefix: string, filter?: (path: string) => boolean): Set<string>;
-  /** Determines if the given path exists in the prefix index. */
-  pathExists(path: string): boolean;
-  /** Determines if the given prefix exists in the prefix index. */
-  nodeExists(prefix: string): boolean;
-  /**
-   * Use the in-memory prefix index to convert a relative path to an absolute one.
-   */
-  resolveRelative(path: string, origin?: string): string;
-}
-/** Simple path filters which filter file types. */
-export declare namespace PathFilters {
-  function csv(path: string): boolean;
-  function markdown(path: string): boolean;
-}
-/**
- * Caches in-use CSVs to make high-frequency reloads (such as actively looking at a document
- * that uses CSV) fast.
- */
-export declare class CsvCache extends Component {
-  vault: Vault;
-  static CACHE_EXPIRY_SECONDS: number;
-  cache: Map<string, {
-    data: DataObject[];
-    loadTime: DateTime;
-  }>;
-  cacheClearInterval: number;
-  constructor(vault: Vault);
-  /** Load a CSV file from the cache, doing a fresh load if it has not been loaded. */
-  get(path: string): Promise<Result<DataObject[], string>>;
-  /** Do the actual raw loading of a CSV path (which is either local or an HTTP request). */
-  private loadInternal;
-  /** Clear old entries in the cache (as measured by insertion time). */
-  private clearOldEntries;
-}
-export type StarredEntry = {
-  type: 'group';
-  items: StarredEntry[];
-  title: string;
-} | {
-  type: 'file';
-  path: string;
-  title: string;
-} | {
-  type: 'folder';
-} | {
-  type: 'query';
-};
-/** Optional connector to the Obsidian 'Starred' plugin which allows for efficiently querying if a file is starred or not. */
-export declare class StarredCache extends Component {
-  app: App;
-  onUpdate: () => void;
-  /** Initial delay before checking the cache; we need to wait for it to asynchronously load the initial stars. */
-  static INITIAL_DELAY: number;
-  /** How frequently to check for star updates. */
-  static REFRESH_INTERVAL: number;
-  /** Set of all starred file paths. */
-  private stars;
-  constructor(app: App, onUpdate: () => void);
-  /** Determines if the given path is starred. */
-  starred(path: string): boolean;
-  private reload;
-  /** Fetch all starred files from the stars plugin, if present. */
-  private static fetch;
-}
-/** A generic index which indexes variables of the form key -> value[], allowing both forward and reverse lookups. */
-export declare class IndexMap {
-  /** Maps key -> values for that key. */
-  map: Map<string, Set<string>>;
-  /** Cached inverse map; maps value -> keys that reference that value. */
-  invMap: Map<string, Set<string>>;
-  /** Create a new, empty index map. */
-  constructor();
-  /** Returns all values for the given key. */
-  get(key: string): Set<string>;
-  /** Returns all keys that reference the given key. Mutating the returned set is not allowed. */
-  getInverse(value: string): Readonly<Set<string>>;
-  /** Sets the key to the given values; this will delete the old mapping for the key if one was present. */
-  set(key: string, values: Set<string>): this;
-  /** Clears all values for the given key so they can be re-added. */
-  delete(key: string): boolean;
-  /** Rename all references to the given key to a new value. */
-  rename(oldKey: string, newKey: string): boolean;
-  /** Clear the entire index. */
-  clear(): void;
-  static EMPTY_SET: Readonly<Set<string>>;
-}
-/** Index map wrapper which is case-insensitive in the key. */
-export declare class ValueCaseInsensitiveIndexMap {
-  delegate: IndexMap;
-  /** Create a new, empty case insensitive index map. */
-  constructor(delegate?: IndexMap);
-  /** Returns all values for the given key. */
-  get(key: string): Set<string>;
-  /** Returns all keys that reference the given value. Mutating the returned set is not allowed. */
-  getInverse(value: string): Readonly<Set<string>>;
-  /** Sets the key to the given values; this will delete the old mapping for the key if one was present. */
-  set(key: string, values: Set<string>): this;
-  /** Clears all values for the given key so they can be re-added. */
-  delete(key: string): boolean;
-  /** Rename all references to the given key to a new value. */
-  rename(oldKey: string, newKey: string): boolean;
-  /** Clear the entire index. */
-  clear(): void;
-}

package/dist/lib/cjs/@types/dataview/data-index/resolver.d.cts

@@ -1,24 +0,0 @@
-/// <reference path="../../../library.d.cts" />
-/** Collect data matching a source query. */
-import type { Result } from '../api/result.d.cjs';
-import type {
-  DataObject,
-  Literal
-} from '../data-model/value.d.cjs';
-import type { FullIndex } from './index.d.cjs';
-import type { Source } from './source.d.cjs';
-/** A data row which has an ID and associated data (like page link / page data). */
-export type Datarow<T> = {
-  id: Literal;
-  data: T;
-};
-/** Find source paths which match the given source. */
-export declare function matchingSourcePaths(source: Source, index: FullIndex, originFile?: string): Result<Set<string>, string>;
-/** Convert a path to the data for that path; usually markdown pages, but could also be other file types (like CSV).  */
-export declare function resolvePathData(path: string, index: FullIndex): Promise<Result<Datarow<DataObject>[], string>>;
-/** Convert a CSV path to the data in the CSV (in dataview format). */
-export declare function resolveCsvData(path: string, index: FullIndex): Promise<Result<Datarow<DataObject>[], string>>;
-/** Convert a path pointing to a markdown page, into the associated metadata. */
-export declare function resolveMarkdownData(path: string, index: FullIndex): Result<Datarow<DataObject>[], string>;
-/** Resolve a source to the collection of data rows that it matches. */
-export declare function resolveSource(source: Source, index: FullIndex, originFile?: string): Promise<Result<Datarow<DataObject>[], string>>;

package/dist/lib/cjs/@types/dataview/data-index/source.d.cts

@@ -1,72 +0,0 @@
-/// <reference path="../../../library.d.cts" />
-/** AST implementation for queries over data sources. */
-/** The source of files for a query. */
-export type Source = TagSource | CsvSource | FolderSource | LinkSource | EmptySource | NegatedSource | BinaryOpSource;
-/** Valid operations for combining sources. */
-export type SourceOp = '&' | '|';
-/** A tag as a source of data. */
-export interface TagSource {
-  type: 'tag';
-  /** The tag to source from. */
-  tag: string;
-}
-/** A csv as a source of data. */
-export interface CsvSource {
-  type: 'csv';
-  /** The path to the CSV file. */
-  path: string;
-}
-/** A folder prefix as a source of data. */
-export interface FolderSource {
-  type: 'folder';
-  /** The folder prefix to source from. */
-  folder: string;
-}
-/** Either incoming or outgoing links to a given file. */
-export interface LinkSource {
-  type: 'link';
-  /** The file to look for links to/from.  */
-  file: string;
-  /**
-   * The direction to look - if incoming, then all files linking to the target file. If outgoing, then all files
-   * which the file links to.
-   */
-  direction: 'incoming' | 'outgoing';
-}
-/** A source which is everything EXCEPT the files returned by the given source. */
-export interface NegatedSource {
-  type: 'negate';
-  /** The source to negate. */
-  child: Source;
-}
-/** A source which yields nothing. */
-export interface EmptySource {
-  type: 'empty';
-}
-/** A source made by combining subsources with a logical operators. */
-export interface BinaryOpSource {
-  type: 'binaryop';
-  op: SourceOp;
-  left: Source;
-  right: Source;
-}
-/** Utility functions for creating and manipulating sources. */
-export declare namespace Sources {
-  /** Create a source which searches from a tag. */
-  function tag(tag: string): TagSource;
-  /** Create a source which fetches from a CSV file. */
-  function csv(path: string): CsvSource;
-  /** Create a source which searches for files under a folder prefix. */
-  function folder(prefix: string): FolderSource;
-  /** Create a source which searches for files which link to/from a given file. */
-  function link(file: string, incoming: boolean): LinkSource;
-  /** Create a source which joins two sources by a logical operator (and/or). */
-  function binaryOp(left: Source, op: SourceOp, right: Source): Source;
-  /** Create a source which takes the intersection of two sources. */
-  function and(left: Source, right: Source): Source;
-  /** Create a source which takes the union of two sources. */
-  function or(left: Source, right: Source): Source;
-  /** Create a source which negates the underlying source. */
-  function negate(child: Source): NegatedSource;
-  function empty(): EmptySource;
-}

package/dist/lib/cjs/@types/dataview/data-model/markdown.d.cts

@@ -1,116 +0,0 @@
-/// <reference path="../../../library.d.cts" />
-import type { DateTime } from 'luxon' with { 'resolution-mode': 'import' };
-import type { Pos } from 'obsidian' with { 'resolution-mode': 'import' };
-import type { FullIndex } from '../data-index/index.d.cjs';
-import type { DataObject } from '../index.d.cjs';
-import type {
-  SListItem,
-  SMarkdownPage
-} from './serialized/markdown.d.cjs';
-import type {
-  Link,
-  Literal
-} from './value.d.cjs';
-/** 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;
-}
-/** 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;
-}
-/** 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;
-}
-export declare function addFields(fields: Map<string, Literal[]>, target: DataObject): DataObject;

package/dist/lib/cjs/@types/dataview/data-model/serialized/markdown.d.cts

@@ -1,107 +0,0 @@
-/// <reference path="../../../../library.d.cts" />
-/** Serialized / API facing data types for Dataview objects. */
-import type { DateTime } from 'luxon' with { 'resolution-mode': 'import' };
-import type { Pos } from 'obsidian' with { 'resolution-mode': 'import' };
-import type {
-  Link,
-  Literal
-} from '../value.d.cjs';
-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;
-}
-/** 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;
-}
-/** A serialized list item as seen by users; this is not a task. */
-export interface SListEntry extends SListItemBase {
-  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;
-}

package/dist/lib/cjs/@types/dataview/data-model/transferable.d.cts

@@ -1,8 +0,0 @@
-/// <reference path="../../../library.d.cts" />
-/** 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;
-}