mdast-control 0.1.0

package/dist/lsp/requests.d.ts

@@ -0,0 +1,215 @@
+import type { DelimitedExportOptions, DelimitedFormat, DelimitedImportOptions, TableColumnAddress, TableModel, TableSortDirection } from '../table.js';
+import { type TransportQueryMatch } from '../transport.js';
+import type { InsertPosition, MoveTargetPolicy } from '../types.js';
+export { MDAST_REQUEST_METHODS } from '../lsp-methods.js';
+export type QueryRequestParams = {
+    uri: string;
+    query: string;
+};
+export type InsertRequestParams = {
+    uri: string;
+    query: string;
+    position: InsertPosition;
+    markdown: string;
+};
+export type ReplaceRequestParams = {
+    uri: string;
+    query: string;
+    markdown: string;
+};
+export type MoveRequestParams = {
+    uri: string;
+    query: string;
+    target: string;
+    position: InsertPosition;
+    targetPolicy?: MoveTargetPolicy;
+};
+export type CopyRequestParams = MoveRequestParams;
+export type PluginRequestParams = {
+    plugin: string;
+};
+export type ElementRequestParams = {
+    element: string;
+};
+export type PluginOperationRequestParams = {
+    plugin: string;
+    operation: string;
+};
+export type PluginRunRequestParams = {
+    uri: string;
+    plugin: string;
+    operation: string;
+    query: string;
+    args?: Record<string, unknown>;
+};
+export type TableExportRequestParams = QueryRequestParams & {
+    format: DelimitedFormat;
+    options?: DelimitedExportOptions;
+};
+type TableImportRequestBase = QueryRequestParams & {
+    format: DelimitedFormat;
+    data: string;
+    options?: DelimitedImportOptions;
+};
+export type TableImportRequestParams = TableImportRequestBase & ({
+    mode: 'replace';
+    position?: never;
+} | {
+    mode: 'insert';
+    position: InsertPosition;
+});
+export type TableUpdateCellRequestParams = QueryRequestParams & {
+    row: number;
+    column: TableColumnAddress;
+    value: string;
+};
+export type TableInsertRowRequestParams = QueryRequestParams & {
+    index: number;
+    values: string[];
+};
+export type TableDeleteRowRequestParams = QueryRequestParams & {
+    row: number;
+};
+export type TableAddColumnRequestParams = QueryRequestParams & {
+    index: number;
+    header: string;
+    values?: string[];
+};
+export type TableDeleteColumnRequestParams = QueryRequestParams & {
+    column: TableColumnAddress;
+};
+export type TableSortRequestParams = TableDeleteColumnRequestParams & {
+    direction: TableSortDirection;
+};
+export declare function capabilitiesRequest(): import("../plugins.js").CapabilitiesSnapshot;
+export declare function pluginListRequest(): import("../plugins.js").PluginCapabilities[];
+export declare function pluginShowRequest(pluginId: string): import("../plugins.js").PluginCapabilities | null;
+export declare function elementCapabilitiesRequest(elementKind: string): import("../plugins.js").ElementCapabilities;
+export declare function pluginOperationRequest(pluginId: string, operationName: string): import("../plugins.js").OperationDescriptor | null;
+export declare function pluginRunRequest(markdown: string | undefined, pluginId: string, operationName: string, query: string, args?: Record<string, unknown>): import("../plugins.js").PluginRunResult | null;
+export declare function queryDocument(markdown: string, query: string): TransportQueryMatch[];
+export declare function queryRequest(markdown: string | undefined, query: string): TransportQueryMatch[];
+export declare function handleQueryRequest(markdown: string | undefined, params: QueryRequestParams): TransportQueryMatch[];
+export declare function insertIntoDocument(markdown: string, query: string, position: InsertPosition, snippet: string): {
+    inserted: number;
+    markdown: string;
+};
+export declare function insertRequest(markdown: string | undefined, query: string, position: string, snippet: string): {
+    inserted: number;
+    markdown: string;
+};
+export declare function handleInsertRequest(markdown: string | undefined, params: InsertRequestParams): {
+    inserted: number;
+    markdown: string;
+};
+export declare function deleteFromDocument(markdown: string, query: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function deleteRequest(markdown: string | undefined, query: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleDeleteRequest(markdown: string | undefined, params: QueryRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function replaceInDocument(markdown: string, query: string, snippet: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function replaceRequest(markdown: string | undefined, query: string, snippet: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleReplaceRequest(markdown: string | undefined, params: ReplaceRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function wrapInDocument(markdown: string, query: string, wrapper: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function wrapRequest(markdown: string | undefined, query: string, wrapper: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleWrapRequest(markdown: string | undefined, params: ReplaceRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function unwrapInDocument(markdown: string, query: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function unwrapRequest(markdown: string | undefined, query: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleUnwrapRequest(markdown: string | undefined, params: QueryRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function moveInDocument(markdown: string, query: string, target: string, position: InsertPosition, targetPolicy?: MoveTargetPolicy): {
+    changed: number;
+    markdown: string;
+};
+export declare function moveRequest(markdown: string | undefined, query: string, target: string, position: string, targetPolicy?: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleMoveRequest(markdown: string | undefined, params: MoveRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function copyIntoDocument(markdown: string, query: string, target: string, position: InsertPosition, targetPolicy?: MoveTargetPolicy): {
+    changed: number;
+    markdown: string;
+};
+export declare function copyRequest(markdown: string | undefined, query: string, target: string, position: string, targetPolicy?: string): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleCopyRequest(markdown: string | undefined, params: CopyRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function tableQueryRequest(markdown: string | undefined, query: string): TableModel | null;
+export declare function handleTableQueryRequest(markdown: string | undefined, params: QueryRequestParams): TableModel | null;
+export declare function tableExportRequest(markdown: string | undefined, query: string, format: DelimitedFormat, options?: DelimitedExportOptions): string | null;
+export declare function handleTableExportRequest(markdown: string | undefined, params: TableExportRequestParams): string | null;
+export declare function tableImportRequest(markdown: string | undefined, params: TableImportRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleTableImportRequest(markdown: string | undefined, params: TableImportRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleTableUpdateCellRequest(markdown: string | undefined, params: TableUpdateCellRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleTableInsertRowRequest(markdown: string | undefined, params: TableInsertRowRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleTableDeleteRowRequest(markdown: string | undefined, params: TableDeleteRowRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleTableAddColumnRequest(markdown: string | undefined, params: TableAddColumnRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleTableDeleteColumnRequest(markdown: string | undefined, params: TableDeleteColumnRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function handleTableSortRequest(markdown: string | undefined, params: TableSortRequestParams): {
+    changed: number;
+    markdown: string;
+};
+export declare function registerMdastRequestHandlers(connection: {
+    onRequest(method: string, handler: (params: unknown) => unknown): void;
+}, getText: (uri: string) => string | undefined): void;