silverbullet/packages/common/spaces/space_primitives.ts

import { Plug } from "@plugos/plugos/plug";
import { AttachmentMeta, PageMeta } from "../types";

export interface SpacePrimitives {
  // Pages
  fetchPageList(): Promise<{ pages: Set<PageMeta>; nowTimestamp: number }>;
  readPage(name: string): Promise<{ text: string; meta: PageMeta }>;
  getPageMeta(name: string): Promise<PageMeta>;
  writePage(
    name: string,
    text: string,
    selfUpdate?: boolean,
    lastModified?: number
  ): Promise<PageMeta>;
  deletePage(name: string): Promise<void>;

  // Attachments
  fetchAttachmentList(): Promise<{
    attachments: Set<AttachmentMeta>;
    nowTimestamp: number;
  }>;
  readAttachment(
    name: string
  ): Promise<{ buffer: ArrayBuffer; meta: AttachmentMeta }>;
  getAttachmentMeta(name: string): Promise<AttachmentMeta>;
  writeAttachment(
    name: string,
    blob: ArrayBuffer,
    selfUpdate?: boolean,
    lastModified?: number
  ): Promise<AttachmentMeta>;
  deleteAttachment(name: string): Promise<void>;

  // Plugs
  proxySyscall(plug: Plug<any>, name: string, args: any[]): Promise<any>;
  invokeFunction(
    plug: Plug<any>,
    env: string,
    name: string,
    args: any[]
  ): Promise<any>;
}