Skip to content

armgit / macro

Public Imported from GitHub
0

Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.

4.5 KB
Raw Blame
/**
 * Messages exchanged with a `.fig` engine worker.
 *
 * Requests are correlated by `id`. A worker hosts one file. Queries (layers,
 * hit tests, properties) are served before queued tile renders so the UI
 * stays responsive while tiles rasterize, and queued renders can be
 * cancelled when the view moves on.
 */

import type { FileSummary, PageLayout } from './types';

/** Engine methods answered with JSON. */
export type QueryMethod =
  | 'summary'
  | 'layers'
  | 'rows'
  | 'nodeInfo'
  | 'hitTest'
  | 'ancestry'
  | 'geometry'
  | 'outline'
  | 'search'
  | 'pageColors'
  | 'components'
  | 'styles'
  | 'variables'
  | 'designInfo'
  | 'inRect'
  | 'exportSvg'
  | 'vectorNetwork'
  | 'prototype'
  | 'layoutAids'
  | 'exportables'
  | 'fonts'
  | 'textGeometry'
  | 'libraryStatus'
  | 'libraryAssets'
  | 'libraryUses'
  | 'liftPlan';

export type FigRequest =
  | {
      id: number;
      kind: 'open';
      bytes: ArrayBuffer;
      module?: WebAssembly.Module;
    }
  | { id: number; kind: 'openPage'; page: number }
  | {
      id: number;
      kind: 'render';
      page: number;
      x: number;
      y: number;
      scale: number;
      width: number;
      height: number;
      outline: boolean;
      /** Lower renders first. */
      priority: number;
      /** Only some layers (`LayersSpec` JSON); all when absent. */
      layers?: string;
    }
  | { id: number; kind: 'cancel'; ids: number[] }
  | {
      id: number;
      kind: 'query';
      method: QueryMethod;
      args: (string | number | null)[];
    }
  | { id: number; kind: 'export'; page: number; node: string; scale: number }
  | { id: number; kind: 'thumbnail' }
  /** Exports layers with presets (`ExportRequest` JSON). */
  | { id: number; kind: 'exportFiles'; page: number; request: string }
  | { id: number; kind: 'exportFramesPdf'; page: number }
  | {
      id: number;
      kind: 'edit';
      page: number;
      /** `remote`: other people's changes (outside the undo history). */
      action: 'apply' | 'undo' | 'redo' | 'remote';
      /** `Op[]` JSON, for `apply`. */
      ops?: string;
      /** Steps with the same key in a row undo as one (a drag). */
      coalesce?: string;
      /** `EntryChange[]` JSON, for `remote`. */
      changes?: string;
    }
  | {
      id: number;
      kind: 'enableCollab';
      session: number;
      baseBlobs: number | null;
    }
  | { id: number; kind: 'collabChanges' }
  | { id: number; kind: 'save' }
  | { id: number; kind: 'blank'; name: string; module?: WebAssembly.Module }
  | { id: number; kind: 'addImage'; hash: string; bytes: ArrayBuffer }
  | {
      id: number;
      kind: 'registerFont';
      bytes: ArrayBuffer;
      /** The family to register it as (else the one it names). */
      family: string | null;
    }
  /** Copies layers (`string[]` JSON) as a clipboard payload. */
  | { id: number; kind: 'copy'; page: number; ids: string }
  | {
      id: number;
      kind: 'paste';
      page: number;
      /** A `.fig` document of copied layers. */
      document: ArrayBuffer;
      /** A ZIP of the images they use. */
      images: ArrayBuffer | null;
      /** `PasteSpec` JSON. */
      spec: string;
    }
  /** A package of library assets (`string[]` JSON of keys). */
  | { id: number; kind: 'libraryPackage'; keys: string }
  | {
      id: number;
      kind: 'importLibrary';
      page: number;
      /** A package from another file's `libraryPackage`. */
      document: ArrayBuffer;
      images: ArrayBuffer | null;
      /** `LibrarySpec` JSON. */
      spec: string;
    }
  /** A PNG of a layer on any canvas, fitted in `size` pixels. */
  | { id: number; kind: 'nodeThumbnail'; node: string; size: number };

export type FigResponse =
  | { id: number; ok: true; kind: 'open'; summary: FileSummary }
  | { id: number; ok: true; kind: 'openPage'; layout: PageLayout }
  | {
      id: number;
      ok: true;
      kind: 'render';
      bitmap: ImageBitmap;
      millis: number;
    }
  | { id: number; ok: true; kind: 'query'; json: string }
  | { id: number; ok: true; kind: 'png'; bytes: ArrayBuffer | null }
  | {
      id: number;
      ok: true;
      kind: 'file';
      name: string;
      mime: string;
      bytes: ArrayBuffer;
    }
  | { id: number; ok: true; kind: 'edit'; json: string }
  | { id: number; ok: true; kind: 'saved'; bytes: ArrayBuffer }
  | {
      id: number;
      ok: true;
      kind: 'copied';
      document: ArrayBuffer;
      images: ArrayBuffer;
    }
  | { id: number; ok: true; kind: 'cancelled' }
  | { id: number; ok: false; error: string; trapped: boolean };