Types & Errors

Supporting data types are listed below. Error codes describe failures, not a guarantee that every method emits every code. Permission and lifetime checks happen in the host. Preserve user input on failure; do not retry non-idempotent writes blindly. Text edit stale and save conflict are result statuses, not error codes. Imported Eidos data types belong to @eidos.space/eidos-file; DOM and ECMAScript types use their standard definitions.

Usage guide: files. API index.

Signatures, parameters and return types are generated from the SDK. Optional members are not available in every host and context.

PluginIconDefinition

Source

export type PluginIconDefinition = string | {
    paths: string[];
} | {
    src: string;
} | {
    file: string;
};

ResourceSource

Source

export type ResourceSource = {
    kind: "file";
    path: string;
    editor?: string;
} | {
    kind: "eidos-view";
    path: string;
    tableId: string;
    viewId: string;
};

ResourceViewInfo

Source

export type ResourceViewInfo = {
    kind: "file";
    editor: string;
    name: string;
    type: string;
} | {
    kind?: "eidos-view";
    tableId: string;
    tableName: string;
    viewId: string;
    name: string;
    type: string;
};

ViewCapability

Source

export type ViewCapability = "document" | "eidos/schema" | "eidos/table" | "eidos/config";

FileHookEventType

Source

export type FileHookEventType = "document.saved" | "file.renamed";

FileHookEvent

Source

FileHookEvent.type

type: FileHookEventType;

FileHookEvent.operationId

operationId: string;

FileHookEvent.source

source: "local" | "plugin" | "sync";

FileHookEvent.path

path: string;

FileHookEvent.previousPath

previousPath?: string;

FileHookEvent.previousText

previousText?: string;

FileHookEvent.document

document: {
    text: string;
    version: string;
};

Related types: FileHookEventType.

FileHookPlan

Source

FileHookPlan.text

text?: string;

FileHookPlan.name

name?: string;

FormatterInput

Source

FormatterInput.text

text: string;

FormatterInput.path

path: string;

FormatterInput.signal

signal: AbortSignal;

Disposable

Source

Disposable.dispose

dispose(): void;

Returns: void.

BackgroundMessage

Source

export type BackgroundMessage = null | boolean | number | string | BackgroundMessage[] | {
    [key: string]: BackgroundMessage;
};

FileStat

Source

FileStat.path

readonly path: string;

FileStat.name

readonly name: string;

FileStat.extension

readonly extension: string;

FileStat.size

readonly size: number;

FileStat.isDirectory

readonly isDirectory: boolean;

FileStat.modifiedAtMs

readonly modifiedAtMs?: number;

FileListOptions

Source

FileListOptions.extensions

extensions?: string[];

FileListOptions.recursive

recursive?: boolean;

FileListOptions.includeDirectories

includeDirectories?: boolean;

FileMetaValue

Source

export type FileMetaValue = null | string | number | boolean | FileMetaValue[] | {
    [key: string]: FileMetaValue;
};

FileMetaValues

Source

export type FileMetaValues = Record<string, FileMetaValue>;

Related types: FileMetaValue.

FileMetaPatch

Source

FileMetaPatch.set

set?: FileMetaValues;

FileMetaPatch.remove

remove?: string[];

Related types: FileMetaValues.

ExplorerState

Source

ExplorerState.rootDirectory

rootDirectory: string | null;

ExplorerState.activePath

activePath: string | null;

ExplorerState.sort

sort: {
    by: "name" | "modified" | "type";
    direction: "ascending" | "descending";
};

FileMetadata

Source

FileMetadata.path

readonly path: string;

FileMetadata.name

readonly name: string;

FileMetadata.baseName

readonly baseName: string;

FileMetadata.extension

readonly extension: string;

FileMetadata.mimeType

readonly mimeType?: string;

FileMetadata.size

readonly size: number;

FileRef

Source

interface FileRef extends Partial<FileMetadata> { /* members below */ }

FileRef.id

readonly id: string;

Related types: FileMetadata.

ViewBinding

Source

export type ViewBinding = {
    kind: "page";
    route: string;
} | {
    kind: "file";
    file: FileRef;
    location?: {
        kind: "eidos-table";
        tableId: string;
        viewId: string;
    };
};

Related types: FileRef.

ActionBinding

Source

export type ActionBinding = {
    kind: "workspace";
} | {
    kind: "file";
    file: FileRef;
};

Related types: FileRef.

TableActionItem

Source

TableActionItem.id

id: string;

TableActionItem.title

title: string;

TableActionItem.icon

icon?: {
    paths: string[];
};

TableActionItem.targets

targets: Array<"row" | "selection" | "view">;

TableActionRecord

Source

TableActionRecord.id

id: string;

TableActionRecord.values

values: Record<string, LogicalValue>;

TableActionRecord.readToken

readToken: string;

PluginPackage

Source

PluginPackage.format

format: 1 | 2 | 3;

PluginPackage.manifest

manifest: PluginManifest;

PluginPackage.modules

modules: Record<string, string>;

PluginPackage.resources

resources?: Record<string, string>;

Related types: PluginManifest.

TextSnapshot

Source

TextSnapshot.text

text: string;

TextSnapshot.version

version: string;

TextSnapshot.encoding

encoding: "utf-8" | "utf-16le" | "utf-16be";

TextSnapshot.bom

bom: boolean;

TextSnapshot.dirty

dirty: boolean;

TextSnapshot.conflicted

conflicted: boolean;

EidosConfigSnapshot

Source

EidosConfigSnapshot.value

value: JsonObject | null;

EidosConfigSnapshot.version

version: string;

EidosTableSnapshot

Source

EidosTableSnapshot.fields

fields: EidosFileFieldInfo[];

EidosTableSnapshot.view

view: EidosFileViewInfo;

TableAggregateMetric

Source

export type TableAggregateMetric = "count" | "sum" | "average" | "min" | "max";

TableAggregateDateInterval

Source

export type TableAggregateDateInterval = "exact" | "day" | "month" | "year";

TableAggregateOptions

Source

TableAggregateOptions.groupBy

groupBy?: {
    fieldId: string;
    dateInterval?: TableAggregateDateInterval;
};

TableAggregateOptions.metric

metric: {
    fieldId?: string;
    op: TableAggregateMetric;
};

TableAggregateOptions.sort

sort?: "label" | "value-desc" | "value-asc";

Related types: TableAggregateDateInterval, TableAggregateMetric.

TableAggregateItem

Source

TableAggregateItem.key

key: unknown;

TableAggregateItem.label

label: string;

TableAggregateItem.value

value: number;

TableAggregateResult

Source

TableAggregateResult.items

items: TableAggregateItem[];

TableAggregateResult.totalRecords

totalRecords: number;

Related types: TableAggregateItem.

SettingValue

Source

export type SettingValue = boolean | string | number;

FileExportRequest

Source

FileExportRequest.name

name: string;

FileExportRequest.mimeType

mimeType: string;

FileExportRequest.data

data: Uint8Array;

FileExportResult

Source

export type FileExportResult = {
    status: "saved" | "download-started" | "cancelled";
};

ObserverErrorHandler

Source

export type ObserverErrorHandler = (error: {
    code: string;
    message: string;
}) => void;

PluginErrorCode

Source

export type PluginErrorCode = "INVALID_REQUEST" | "UNSUPPORTED_API" | "PERMISSION_DENIED" | "DOCUMENT_UNAVAILABLE" | "INSTANCE_CLOSED" | "STALE_REVISION" | "ALREADY_EXISTS" | "BUSY" | "TOO_LARGE" | "IO_ERROR" | "TIMEOUT" | "CANCELLED" | "REGISTRATION_CONFLICT" | "DEPENDENCY_MISSING" | "SOURCE_INVALID";