obsidian-dev-utils 16.3.0 → 16.4.1

package/dist/lib/obsidian/@types/Dataview/expression/functions.d.ts

@@ -1,7 +1,10 @@
 /** Default function implementations for the expression evaluator. */
-import type { Literal } from "../data-model/value.d.ts";
-import type { LiteralReprAll, LiteralTypeOrAll } from "./binaryop.d.ts";
-import type { Context } from "./context.d.ts";
+import type { Literal } from '../data-model/value.d.ts';
+import type {
+  LiteralReprAll,
+  LiteralTypeOrAll
+} from './binaryop.d.ts';
+import type { Context } from './context.d.ts';
 /**
  * A function implementation which takes in a function context and a variable number of arguments. Throws an error if an
  * invalid number/type of arguments are passed.
@@ -11,126 +14,135 @@ export type FunctionImpl = (context: Context, ...rest: Literal[]) => Literal;
 export type BoundFunctionImpl = (...args: Literal[]) => Literal;
 /** A function variant used in the function builder which holds the argument types. */
 interface FunctionVariant {
-    args: LiteralTypeOrAll[];
-    varargs: boolean;
-    /** The implementing function for this specific variant. */
-    impl: FunctionImpl;
+  args: LiteralTypeOrAll[];
+  varargs: boolean;
+  /** The implementing function for this specific variant. */
+  impl: FunctionImpl;
 }
 /**
  * Allows for the creation of functions that check the number and type of their arguments, and dispatch
  * to different implementations based on the types of the inputs.
  */
 export declare class FunctionBuilder {
-    name: string;
-    variants: FunctionVariant[];
-    vectorized: Record<number, number[]>;
-    constructor(name: string);
-    /** Add a general function variant which accepts any number of arguments of any type. */
-    vararg(impl: FunctionImpl): FunctionBuilder;
-    /** Add a function variant which takes in a single argument. */
-    add1<T extends LiteralTypeOrAll>(argType: T, impl: (a: LiteralReprAll<T>, context: Context) => Literal): FunctionBuilder;
-    /** Add a function variant which takes in two typed arguments. */
-    add2<T extends LiteralTypeOrAll, U extends LiteralTypeOrAll>(arg1: T, arg2: U, impl: (a: LiteralReprAll<T>, b: LiteralReprAll<U>, context: Context) => Literal): FunctionBuilder;
-    /** Add a function variant which takes in three typed arguments. */
-    add3<T extends LiteralTypeOrAll, U extends LiteralTypeOrAll, V extends LiteralTypeOrAll>(arg1: T, arg2: U, arg3: V, impl: (a: LiteralReprAll<T>, b: LiteralReprAll<U>, c: LiteralReprAll<V>, context: Context) => Literal): FunctionBuilder;
-    /** Add vectorized variants which accept the given number of arguments and delegate. */
-    vectorize(numArgs: number, positions: number[]): FunctionBuilder;
-    /** Return a function which checks the number and type of arguments, passing them on to the first matching variant. */
-    build(): FunctionImpl;
+  name: string;
+  variants: FunctionVariant[];
+  vectorized: Record<number, number[]>;
+  constructor(name: string);
+  /** Add a general function variant which accepts any number of arguments of any type. */
+  vararg(impl: FunctionImpl): FunctionBuilder;
+  /** Add a function variant which takes in a single argument. */
+  add1<T extends LiteralTypeOrAll>(argType: T, impl: (a: LiteralReprAll<T>, context: Context) => Literal): FunctionBuilder;
+  /** Add a function variant which takes in two typed arguments. */
+  add2<T extends LiteralTypeOrAll, U extends LiteralTypeOrAll>(
+    arg1: T,
+    arg2: U,
+    impl: (a: LiteralReprAll<T>, b: LiteralReprAll<U>, context: Context) => Literal
+  ): FunctionBuilder;
+  /** Add a function variant which takes in three typed arguments. */
+  add3<T extends LiteralTypeOrAll, U extends LiteralTypeOrAll, V extends LiteralTypeOrAll>(
+    arg1: T,
+    arg2: U,
+    arg3: V,
+    impl: (a: LiteralReprAll<T>, b: LiteralReprAll<U>, c: LiteralReprAll<V>, context: Context) => Literal
+  ): FunctionBuilder;
+  /** Add vectorized variants which accept the given number of arguments and delegate. */
+  vectorize(numArgs: number, positions: number[]): FunctionBuilder;
+  /** Return a function which checks the number and type of arguments, passing them on to the first matching variant. */
+  build(): FunctionImpl;
 }
 /** Utilities for managing function implementations. */
 export declare namespace Functions {
-    /** Bind a context to a function implementation, yielding a function which does not need the context argument. */
-    function bind(func: FunctionImpl, context: Context): BoundFunctionImpl;
-    /** Bind a context to all functions in the given map, yielding a new map of bound functions. */
-    function bindAll(funcs: Record<string, FunctionImpl>, context: Context): Record<string, BoundFunctionImpl>;
+  /** Bind a context to a function implementation, yielding a function which does not need the context argument. */
+  function bind(func: FunctionImpl, context: Context): BoundFunctionImpl;
+  /** Bind a context to all functions in the given map, yielding a new map of bound functions. */
+  function bindAll(funcs: Record<string, FunctionImpl>, context: Context): Record<string, BoundFunctionImpl>;
 }
 /**
  * Collection of all defined functions; defined here so that they can be called from within dataview,
  * and test code.
  */
 export declare namespace DefaultFunctions {
-    const typeOf: FunctionImpl;
-    /** Compute the length of a data type. */
-    const length: FunctionImpl;
-    /** List constructor function. */
-    const list: FunctionImpl;
-    /** Object constructor function. */
-    const object: FunctionImpl;
-    /** Internal link constructor function. */
-    const link: FunctionImpl;
-    /** Embed and un-embed a link. */
-    const embed: FunctionImpl;
-    /** External link constructor function. */
-    const elink: FunctionImpl;
-    /** Date constructor function. */
-    const date: FunctionImpl;
-    /** Duration constructor function. */
-    const dur: FunctionImpl;
-    /** Format a date using a luxon/moment-style date format. */
-    const dateformat: FunctionImpl;
-    const durationformat: FunctionImpl;
-    const localtime: FunctionImpl;
-    /** Number constructor function. */
-    const number: FunctionImpl;
-    /** Format a number using a standard currency format. */
-    const currencyformat: FunctionImpl;
-    /**
-     * Convert any value to a reasonable internal string representation. Most useful for dates, strings, numbers, and
-     * so on.
-     */
-    const string: FunctionImpl;
-    const round: FunctionImpl;
-    const trunc: FunctionImpl;
-    const floor: FunctionImpl;
-    const ceil: FunctionImpl;
-    const min: FunctionImpl;
-    const max: FunctionImpl;
-    const minby: FunctionImpl;
-    const maxby: FunctionImpl;
-    const striptime: FunctionImpl;
-    const contains: FunctionImpl;
-    const icontains: FunctionImpl;
-    const econtains: FunctionImpl;
-    const containsword: FunctionImpl;
-    /** Extract 0 or more keys from a given object via indexing. */
-    const extract: FunctionImpl;
-    const reverse: FunctionImpl;
-    const sort: FunctionImpl;
-    const regextest: FunctionImpl;
-    const regexmatch: FunctionImpl;
-    const regexreplace: FunctionImpl;
-    const lower: FunctionImpl;
-    const upper: FunctionImpl;
-    const replace: FunctionImpl;
-    /** Split a string on a given string. */
-    const split: FunctionImpl;
-    const startswith: FunctionImpl;
-    const endswith: FunctionImpl;
-    const padleft: FunctionImpl;
-    const padright: FunctionImpl;
-    const substring: FunctionImpl;
-    const truncate: FunctionImpl;
-    const fdefault: FunctionImpl;
-    const ldefault: FunctionImpl;
-    const choice: FunctionImpl;
-    const hash: FunctionImpl;
-    const reduce: FunctionImpl;
-    const sum: FunctionImpl;
-    const average: FunctionImpl;
-    const product: FunctionImpl;
-    const join: FunctionImpl;
-    const any: FunctionImpl;
-    const all: FunctionImpl;
-    const none: FunctionImpl;
-    const filter: FunctionImpl;
-    const unique: FunctionImpl;
-    const map: FunctionImpl;
-    const nonnull: FunctionImpl;
-    /** Gets an object containing a link's own properties */
-    const meta: FunctionImpl;
-    const flat: FunctionImpl;
-    const slice: FunctionImpl;
+  const typeOf: FunctionImpl;
+  /** Compute the length of a data type. */
+  const length: FunctionImpl;
+  /** List constructor function. */
+  const list: FunctionImpl;
+  /** Object constructor function. */
+  const object: FunctionImpl;
+  /** Internal link constructor function. */
+  const link: FunctionImpl;
+  /** Embed and un-embed a link. */
+  const embed: FunctionImpl;
+  /** External link constructor function. */
+  const elink: FunctionImpl;
+  /** Date constructor function. */
+  const date: FunctionImpl;
+  /** Duration constructor function. */
+  const dur: FunctionImpl;
+  /** Format a date using a luxon/moment-style date format. */
+  const dateformat: FunctionImpl;
+  const durationformat: FunctionImpl;
+  const localtime: FunctionImpl;
+  /** Number constructor function. */
+  const number: FunctionImpl;
+  /** Format a number using a standard currency format. */
+  const currencyformat: FunctionImpl;
+  /**
+   * Convert any value to a reasonable internal string representation. Most useful for dates, strings, numbers, and
+   * so on.
+   */
+  const string: FunctionImpl;
+  const round: FunctionImpl;
+  const trunc: FunctionImpl;
+  const floor: FunctionImpl;
+  const ceil: FunctionImpl;
+  const min: FunctionImpl;
+  const max: FunctionImpl;
+  const minby: FunctionImpl;
+  const maxby: FunctionImpl;
+  const striptime: FunctionImpl;
+  const contains: FunctionImpl;
+  const icontains: FunctionImpl;
+  const econtains: FunctionImpl;
+  const containsword: FunctionImpl;
+  /** Extract 0 or more keys from a given object via indexing. */
+  const extract: FunctionImpl;
+  const reverse: FunctionImpl;
+  const sort: FunctionImpl;
+  const regextest: FunctionImpl;
+  const regexmatch: FunctionImpl;
+  const regexreplace: FunctionImpl;
+  const lower: FunctionImpl;
+  const upper: FunctionImpl;
+  const replace: FunctionImpl;
+  /** Split a string on a given string. */
+  const split: FunctionImpl;
+  const startswith: FunctionImpl;
+  const endswith: FunctionImpl;
+  const padleft: FunctionImpl;
+  const padright: FunctionImpl;
+  const substring: FunctionImpl;
+  const truncate: FunctionImpl;
+  const fdefault: FunctionImpl;
+  const ldefault: FunctionImpl;
+  const choice: FunctionImpl;
+  const hash: FunctionImpl;
+  const reduce: FunctionImpl;
+  const sum: FunctionImpl;
+  const average: FunctionImpl;
+  const product: FunctionImpl;
+  const join: FunctionImpl;
+  const any: FunctionImpl;
+  const all: FunctionImpl;
+  const none: FunctionImpl;
+  const filter: FunctionImpl;
+  const unique: FunctionImpl;
+  const map: FunctionImpl;
+  const nonnull: FunctionImpl;
+  /** Gets an object containing a link's own properties */
+  const meta: FunctionImpl;
+  const flat: FunctionImpl;
+  const slice: FunctionImpl;
 }
 /** Default function implementations for the expression evaluator. */
 export declare const DEFAULT_FUNCTIONS: Record<string, FunctionImpl>;

package/dist/lib/obsidian/@types/Dataview/expression/parse.d.ts

@@ -1,61 +1,81 @@
-import type { DateTime, Duration } from "luxon";
-import type { Literal, Link } from "../data-model/value.d.ts";
-import * as P from "parsimmon";
-import type { BinaryOp, Field, LambdaField, ListField, LiteralField, ObjectField, VariableField } from "./field.d.ts";
-import type { FolderSource, NegatedSource, Source, TagSource, CsvSource } from "../data-index/source.d.ts";
-import type { Result } from "../api/result.d.ts";
+import type {
+  DateTime,
+  Duration
+} from 'luxon';
+import * as P from 'parsimmon';
+import type { Result } from '../api/result.d.ts';
+import type {
+  CsvSource,
+  FolderSource,
+  NegatedSource,
+  Source,
+  TagSource
+} from '../data-index/source.d.ts';
+import type {
+  Link,
+  Literal
+} from '../data-model/value.d.ts';
+import type {
+  BinaryOp,
+  Field,
+  LambdaField,
+  ListField,
+  LiteralField,
+  ObjectField,
+  VariableField
+} from './field.d.ts';
 /** Provides a lookup table for unit durations of the given type. */
 export declare const DURATION_TYPES: {
-    year: Duration;
-    years: Duration;
-    yr: Duration;
-    yrs: Duration;
-    month: Duration;
-    months: Duration;
-    mo: Duration;
-    mos: Duration;
-    week: Duration;
-    weeks: Duration;
-    wk: Duration;
-    wks: Duration;
-    w: Duration;
-    day: Duration;
-    days: Duration;
-    d: Duration;
-    hour: Duration;
-    hours: Duration;
-    hr: Duration;
-    hrs: Duration;
-    h: Duration;
-    minute: Duration;
-    minutes: Duration;
-    min: Duration;
-    mins: Duration;
-    m: Duration;
-    second: Duration;
-    seconds: Duration;
-    sec: Duration;
-    secs: Duration;
-    s: Duration;
+  year: Duration;
+  years: Duration;
+  yr: Duration;
+  yrs: Duration;
+  month: Duration;
+  months: Duration;
+  mo: Duration;
+  mos: Duration;
+  week: Duration;
+  weeks: Duration;
+  wk: Duration;
+  wks: Duration;
+  w: Duration;
+  day: Duration;
+  days: Duration;
+  d: Duration;
+  hour: Duration;
+  hours: Duration;
+  hr: Duration;
+  hrs: Duration;
+  h: Duration;
+  minute: Duration;
+  minutes: Duration;
+  min: Duration;
+  mins: Duration;
+  m: Duration;
+  second: Duration;
+  seconds: Duration;
+  sec: Duration;
+  secs: Duration;
+  s: Duration;
 };
 /** Shorthand for common dates (relative to right now). */
 export declare const DATE_SHORTHANDS: {
-    now: () => DateTime;
-    today: () => DateTime;
-    yesterday: () => DateTime;
-    tomorrow: () => DateTime;
-    sow: () => DateTime;
-    "start-of-week": () => DateTime;
-    eow: () => DateTime;
-    "end-of-week": () => DateTime;
-    soy: () => DateTime;
-    "start-of-year": () => DateTime;
-    eoy: () => DateTime;
-    "end-of-year": () => DateTime;
-    som: () => DateTime;
-    "start-of-month": () => DateTime;
-    eom: () => DateTime;
-    "end-of-month": () => DateTime;
+  now: () => DateTime;
+  today: () => DateTime;
+  yesterday: () => DateTime;
+  tomorrow: () => DateTime;
+  sow: () => DateTime;
+  'start-of-week': () => DateTime;
+  eow: () => DateTime;
+  'end-of-week': () => DateTime;
+  soy: () => DateTime;
+  'start-of-year': () => DateTime;
+  eoy: () => DateTime;
+  'end-of-year': () => DateTime;
+  som: () => DateTime;
+  'start-of-month': () => DateTime;
+  eom: () => DateTime;
+  'end-of-month': () => DateTime;
 };
 /**
  * Keywords which cannot be used as variables directly. Use `row.<thing>` if it is a variable you have defined and want
@@ -68,72 +88,72 @@ export declare function parseInnerLink(rawlink: string): Link;
 export declare function createBinaryParser<T, U>(child: P.Parser<T>, sep: P.Parser<U>, combine: (a: T, b: U, c: T) => T): P.Parser<T>;
 export declare function chainOpt<T>(base: P.Parser<T>, ...funcs: ((r: T) => P.Parser<T>)[]): P.Parser<T>;
 export type PostfixFragment = {
-    type: "dot";
-    field: string;
+  type: 'dot';
+  field: string;
 } | {
-    type: "index";
-    field: Field;
+  type: 'index';
+  field: Field;
 } | {
-    type: "function";
-    fields: Field[];
+  type: 'function';
+  fields: Field[];
 };
 export interface ExpressionLanguage {
-    number: number;
-    string: string;
-    escapeCharacter: string;
-    bool: boolean;
-    tag: string;
-    identifier: string;
-    link: Link;
-    embedLink: Link;
-    rootDate: DateTime;
-    dateShorthand: keyof typeof DATE_SHORTHANDS;
-    date: DateTime;
-    datePlus: DateTime;
-    durationType: keyof typeof DURATION_TYPES;
-    duration: Duration;
-    rawNull: string;
-    binaryPlusMinus: BinaryOp;
-    binaryMulDiv: BinaryOp;
-    binaryCompareOp: BinaryOp;
-    binaryBooleanOp: BinaryOp;
-    tagSource: TagSource;
-    csvSource: CsvSource;
-    folderSource: FolderSource;
-    parensSource: Source;
-    atomSource: Source;
-    linkIncomingSource: Source;
-    linkOutgoingSource: Source;
-    negateSource: NegatedSource;
-    binaryOpSource: Source;
-    source: Source;
-    variableField: VariableField;
-    numberField: LiteralField;
-    boolField: LiteralField;
-    stringField: LiteralField;
-    dateField: LiteralField;
-    durationField: LiteralField;
-    linkField: LiteralField;
-    nullField: LiteralField;
-    listField: ListField;
-    objectField: ObjectField;
-    atomInlineField: Literal;
-    inlineFieldList: Literal[];
-    inlineField: Literal;
-    negatedField: Field;
-    atomField: Field;
-    indexField: Field;
-    lambdaField: LambdaField;
-    dotPostfix: PostfixFragment;
-    indexPostfix: PostfixFragment;
-    functionPostfix: PostfixFragment;
-    binaryMulDivField: Field;
-    binaryPlusMinusField: Field;
-    binaryCompareField: Field;
-    binaryBooleanField: Field;
-    binaryOpField: Field;
-    parensField: Field;
-    field: Field;
+  number: number;
+  string: string;
+  escapeCharacter: string;
+  bool: boolean;
+  tag: string;
+  identifier: string;
+  link: Link;
+  embedLink: Link;
+  rootDate: DateTime;
+  dateShorthand: keyof typeof DATE_SHORTHANDS;
+  date: DateTime;
+  datePlus: DateTime;
+  durationType: keyof typeof DURATION_TYPES;
+  duration: Duration;
+  rawNull: string;
+  binaryPlusMinus: BinaryOp;
+  binaryMulDiv: BinaryOp;
+  binaryCompareOp: BinaryOp;
+  binaryBooleanOp: BinaryOp;
+  tagSource: TagSource;
+  csvSource: CsvSource;
+  folderSource: FolderSource;
+  parensSource: Source;
+  atomSource: Source;
+  linkIncomingSource: Source;
+  linkOutgoingSource: Source;
+  negateSource: NegatedSource;
+  binaryOpSource: Source;
+  source: Source;
+  variableField: VariableField;
+  numberField: LiteralField;
+  boolField: LiteralField;
+  stringField: LiteralField;
+  dateField: LiteralField;
+  durationField: LiteralField;
+  linkField: LiteralField;
+  nullField: LiteralField;
+  listField: ListField;
+  objectField: ObjectField;
+  atomInlineField: Literal;
+  inlineFieldList: Literal[];
+  inlineField: Literal;
+  negatedField: Field;
+  atomField: Field;
+  indexField: Field;
+  lambdaField: LambdaField;
+  dotPostfix: PostfixFragment;
+  indexPostfix: PostfixFragment;
+  functionPostfix: PostfixFragment;
+  binaryMulDivField: Field;
+  binaryPlusMinusField: Field;
+  binaryCompareField: Field;
+  binaryBooleanField: Field;
+  binaryOpField: Field;
+  parensField: Field;
+  field: Field;
 }
 export declare const EXPRESSION: P.TypedLanguage<ExpressionLanguage>;
 /**

package/dist/lib/obsidian/@types/Dataview/index.d.ts

@@ -1,17 +1,51 @@
-export type { DataviewApi } from "./api/plugin-api.d.ts";
-export type { DateTime, Duration } from "luxon";
-export type { Link, DataObject, LiteralType, Literal, LiteralRepr, WrappedLiteral, LiteralWrapper, Widget, } from "./data-model/value.d.ts";
-export type { Result, Success, Failure } from "./api/result.d.ts";
-export type { DataArray } from "./api/data-array.d.ts";
-export type { ListItem, PageMetadata } from "./data-model/markdown.d.ts";
-export type { FullIndex, PrefixIndex, IndexMap } from "./data-index/index.d.ts";
-export type { SMarkdownPage, SListEntry, STask } from "./data-model/serialized/markdown.d.ts";
-export type { DURATION_TYPES, DATE_SHORTHANDS, KEYWORDS, ExpressionLanguage, EXPRESSION, parseField, } from "./expression/parse.d.ts";
-export type { QUERY_LANGUAGE } from "./query/parse.d.ts";
-export type { Query } from "./query/query.d.ts";
-import type { DataviewApi } from "./api/plugin-api.d.ts";
-import "obsidian";
-import type { App } from "obsidian";
+export type {
+  DateTime,
+  Duration
+} from 'luxon';
+export type { DataArray } from './api/data-array.d.ts';
+export type { DataviewApi } from './api/plugin-api.d.ts';
+export type {
+  Failure,
+  Result,
+  Success
+} from './api/result.d.ts';
+export type {
+  FullIndex,
+  IndexMap,
+  PrefixIndex
+} from './data-index/index.d.ts';
+export type {
+  ListItem,
+  PageMetadata
+} from './data-model/markdown.d.ts';
+export type {
+  SListEntry,
+  SMarkdownPage,
+  STask
+} from './data-model/serialized/markdown.d.ts';
+export type {
+  DataObject,
+  Link,
+  Literal,
+  LiteralRepr,
+  LiteralType,
+  LiteralWrapper,
+  Widget,
+  WrappedLiteral
+} from './data-model/value.d.ts';
+export type {
+  DATE_SHORTHANDS,
+  DURATION_TYPES,
+  EXPRESSION,
+  ExpressionLanguage,
+  KEYWORDS,
+  parseField
+} from './expression/parse.d.ts';
+export type { QUERY_LANGUAGE } from './query/parse.d.ts';
+export type { Query } from './query/query.d.ts';
+import type { DataviewApi } from './api/plugin-api.d.ts';
+import 'obsidian';
+import type { App } from 'obsidian';
 /**
  * Get the current Dataview API from the app if provided; if not, it is inferred from the global API object installed
  * on the window.