@lapis-notes/api 0.1.0

package/dist/bases.d.ts

@@ -0,0 +1,281 @@
+import { DateTime, Duration } from "luxon";
+import type { App, RenderContext } from "./context.svelte";
+import { Component } from "./view.svelte";
+import type { TFile, TFolder } from "./storage/fs";
+export type BasesPropertyType = "note" | "formula" | "file";
+export type BasesPropertyId = string | `${BasesPropertyType}.${string}`;
+export interface BasesProperty {
+    type: BasesPropertyType;
+    name: string;
+}
+export type BasesSortConfig = {
+    property: BasesPropertyId;
+    direction: "ASC" | "DESC";
+};
+export interface FormulaContext {
+}
+export declare abstract class Value {
+    static type: string;
+    abstract get value(): unknown;
+    static equals(a: Value | null, b: Value | null): boolean;
+    static looseEquals(a: Value | null, b: Value | null): boolean;
+    abstract toString(): string;
+    abstract isTruthy(): boolean;
+    equals(other: this): boolean;
+    looseEquals(other: Value): boolean;
+    renderTo(el: HTMLElement, ctx: RenderContext): void;
+}
+export declare abstract class NotNullValue extends Value {
+    isTruthy(): boolean;
+}
+export declare abstract class PrimitiveValue<T> extends NotNullValue {
+    readonly value: T;
+    constructor(value: T);
+    toString(): string;
+    isTruthy(): boolean;
+    equals(other: this): boolean;
+}
+export declare class NullValue extends Value {
+    static value: NullValue;
+    get value(): null;
+    toString(): string;
+    isTruthy(): boolean;
+    equals(other: this): boolean;
+    looseEquals(other: Value): boolean;
+}
+export declare class BooleanValue extends PrimitiveValue<boolean> {
+    static type: string;
+}
+export declare class NumberValue extends PrimitiveValue<number> {
+    static type: string;
+}
+export declare class StringValue extends PrimitiveValue<string> {
+    static type: string;
+}
+export declare class DateValue extends PrimitiveValue<DateTime> {
+    static type: string;
+    constructor(value: DateTime | Date | number | string);
+    toString(): string;
+    isTruthy(): boolean;
+    equals(other: this): boolean;
+    looseEquals(other: Value): boolean;
+    dateOnly(): DateValue;
+    relative(): string;
+    static parseFromString(input: string): DateValue | null;
+}
+export declare class DurationValue extends PrimitiveValue<Duration> {
+    static type: string;
+    constructor(value: Duration | string | number);
+    toString(): string;
+    isTruthy(): boolean;
+    equals(other: this): boolean;
+    looseEquals(other: Value): boolean;
+    addToDate(value: DateValue, subtract?: boolean): DateValue;
+    getMilliseconds(): number;
+    static parseFromString(input: string): DurationValue | null;
+    static fromMilliseconds(milliseconds: number): DurationValue;
+}
+export declare class FileValue extends NotNullValue {
+    readonly value: TFile;
+    static type: string;
+    constructor(value: TFile);
+    toString(): string;
+    equals(other: this): boolean;
+    looseEquals(other: Value): boolean;
+}
+export declare class LinkValue extends StringValue {
+}
+export declare class HTMLValue extends StringValue {
+}
+export declare class IconValue extends StringValue {
+}
+export declare class ImageValue extends StringValue {
+}
+export declare class TagValue extends StringValue {
+}
+export declare class UrlValue extends StringValue {
+}
+export declare class RegExpValue extends PrimitiveValue<RegExp> {
+    static type: string;
+}
+export declare class RelativeDateValue extends DateValue {
+}
+export declare class ListValue extends NotNullValue {
+    static type: string;
+    readonly value: Value[];
+    constructor(value?: unknown[]);
+    toString(): string;
+    isTruthy(): boolean;
+    includes(value: Value): boolean;
+    length(): number;
+    get(index: number): Value;
+    concat(other: ListValue): ListValue;
+    equals(other: this): boolean;
+}
+export declare class ObjectValue extends NotNullValue {
+    readonly value: Record<string, unknown>;
+    static type: string;
+    constructor(value: Record<string, unknown>);
+    toString(): string;
+    isTruthy(): boolean;
+    isEmpty(): boolean;
+    get(key: string): Value | null;
+}
+export declare function toValue(value: unknown): Value | null;
+export declare class BasesEntry implements FormulaContext {
+    readonly id: string;
+    readonly file: TFile;
+    readonly values: Record<string, Value | null>;
+    constructor(file: TFile, values?: Record<string, Value | null>);
+    constructor(id: string, file: TFile, values?: Record<string, Value | null>);
+    getValue(propertyId: BasesPropertyId): Value | null;
+}
+export declare class BasesEntryGroup {
+    readonly entries: BasesEntry[];
+    readonly key?: Value | undefined;
+    constructor(entries?: BasesEntry[], key?: Value | undefined);
+    hasKey(): boolean;
+}
+export declare class BasesQueryResult {
+    readonly data: BasesEntry[];
+    private readonly propertyIds;
+    private readonly groupBy?;
+    constructor(data?: BasesEntry[], propertyIds?: BasesPropertyId[], groupBy?: (BasesPropertyId | null) | undefined);
+    get groupedData(): BasesEntryGroup[];
+    get properties(): BasesPropertyId[];
+    getSummaryValue(queryController: QueryController, entries: BasesEntry[], prop: BasesPropertyId, summaryKey: string): Value;
+}
+export declare class QueryController extends Component {
+    readonly app: App;
+    constructor(application?: App);
+}
+export interface BasesOption {
+    key: string;
+    type: string;
+    displayName: string;
+    shouldHide?: () => boolean;
+}
+export interface BasesTextOption extends BasesOption {
+    type: "text";
+    default?: string;
+    placeholder?: string;
+}
+export interface BasesMultitextOption extends BasesOption {
+    type: "multitext";
+    default?: string[];
+}
+export interface BasesToggleOption extends BasesOption {
+    type: "toggle";
+    default?: boolean;
+}
+export interface BasesSliderOption extends BasesOption {
+    type: "slider";
+    default?: number;
+    min?: number;
+    max?: number;
+    step?: number;
+    instant?: boolean;
+}
+export interface BasesDropdownOption extends BasesOption {
+    type: "dropdown";
+    default?: string;
+    options: Record<string, string>;
+}
+export interface BasesFileOption extends BasesOption {
+    type: "file";
+    default?: string;
+    placeholder?: string;
+    filter?: (file: TFile) => boolean;
+}
+export interface BasesFolderOption extends BasesOption {
+    type: "folder";
+    default?: string;
+    placeholder?: string;
+    filter?: (folder: TFolder) => boolean;
+}
+export interface BasesFormulaOption extends BasesOption {
+    type: "formula";
+    default?: string;
+    placeholder?: string;
+}
+export interface BasesPropertyOption extends BasesOption {
+    type: "property";
+    default?: string;
+    placeholder?: string;
+    filter?: (prop: BasesPropertyId) => boolean;
+}
+export interface BasesOptionGroup {
+    type: "group";
+    displayName: string;
+    items: BasesOptions[];
+    shouldHide?: () => boolean;
+}
+export type BasesOptions = BasesTextOption | BasesMultitextOption | BasesToggleOption | BasesSliderOption | BasesDropdownOption | BasesFileOption | BasesFolderOption | BasesFormulaOption | BasesPropertyOption;
+export type BasesAllOptions = BasesOptions | BasesOptionGroup;
+export interface BasesConfigFileView {
+    type: string;
+    name: string;
+    filters?: BasesConfigFileFilter;
+    groupBy?: {
+        property: BasesPropertyId;
+        direction: "ASC" | "DESC";
+    };
+    order?: string[];
+    sort?: BasesSortConfig[];
+    summaries?: Record<string, string>;
+    [key: string]: unknown;
+}
+export type BasesConfigFileFilter = string | {
+    and: BasesConfigFileFilter[];
+} | {
+    or: BasesConfigFileFilter[];
+} | {
+    not: BasesConfigFileFilter[];
+};
+export interface BasesConfigFile {
+    views?: BasesConfigFileView[];
+    properties?: Record<string, Record<string, unknown>>;
+    filters?: BasesConfigFileFilter;
+    formulas?: Record<string, string>;
+    summaries?: Record<string, string>;
+}
+export declare class BasesViewConfig {
+    private readonly config;
+    private readonly columns;
+    constructor(config?: BasesConfigFileView, columns?: Record<string, {
+        displayName?: string;
+    }>);
+    get name(): string;
+    get(key: string): unknown;
+    getAsPropertyId(key: string): BasesPropertyId | null;
+    getEvaluatedFormula(view: BasesView, key: string): Value;
+    set(key: string, value: any | null): void;
+    getOrder(): BasesPropertyId[];
+    getSort(): BasesSortConfig[];
+    getDisplayName(propertyId: BasesPropertyId): string;
+}
+export type BasesViewFactory = (controller: QueryController, el: HTMLElement) => BasesView;
+export interface BasesViewRegistration {
+    type: string;
+    name: string;
+    icon: string;
+    factory: BasesViewFactory;
+    options?: (config: BasesViewConfig) => BasesAllOptions[];
+}
+export declare abstract class BasesView extends Component {
+    readonly controller: QueryController;
+    private mountedView;
+    private mountedViewContainer;
+    abstract type: string;
+    app: App;
+    config: BasesViewConfig;
+    allProperties: BasesPropertyId[];
+    data: BasesQueryResult;
+    protected constructor(controller: QueryController);
+    protected mountViewComponent(component: any, props: Record<string, unknown>, containerEl: HTMLElement): void;
+    protected unmountViewComponent(): void;
+    onunload(): void;
+    abstract onDataUpdated(): void;
+    createFileForView(baseFileName?: string, frontmatterProcessor?: (frontmatter: any) => void): Promise<void>;
+}
+export declare function parsePropertyId(propertyId: BasesPropertyId): BasesProperty;