DTO · api-quick-parts.ts

6 interfaces and 5 type aliases — quick parts: galleries, insertion modes, selection, and building-block storage.

Internal contract

These types describe the exchange inside the desktop SumDoc window. For embedding in your product, use the Rust Session Protocol or the browser surface interface.

Some types include internal tags such as backlog_id: "D38" or sharedSceneOwner: "D5" — these are the task numbers the feature was filed under inside the team. They appear in the response, but embedding doesn’t need them: there’s no reason to parse or store them.

Contract module: api-quick-parts.ts.

Types on this page — 11

• ShellQuickPartGallery
• ShellQuickPartInsertionMode
• ShellQuickPartStoryKind
• ShellQuickPartsFieldScope
• ShellQuickPartSelection
• ShellQuickPartTarget
• ShellQuickPartBuildingBlock
• ShellQuickPartsStoreSnapshot
• ShellQuickPartsDocumentOperation
• ShellQuickPartsDocumentResult
• FastDocQuickPartsApi

ShellQuickPartGallery

TypeAliasDeclaration · api-quick-parts.ts

type ShellQuickPartGallery = "quick-parts" | "autotext";

ShellQuickPartInsertionMode

TypeAliasDeclaration · api-quick-parts.ts

type ShellQuickPartInsertionMode = "content" | "paragraph" | "page";

ShellQuickPartStoryKind

TypeAliasDeclaration · api-quick-parts.ts

type ShellQuickPartStoryKind = "body" | "table-cell" | "header" | "footer" | "footnote" | "endnote" | "text-box";

ShellQuickPartsFieldScope

TypeAliasDeclaration · api-quick-parts.ts

type ShellQuickPartsFieldScope = "current" | "selection" | "all";

ShellQuickPartSelection

InterfaceDeclaration · api-quick-parts.ts

interface ShellQuickPartSelection {
  storyKind: ShellQuickPartStoryKind;
  storyIndex: number;
  tableCellIndex: number | null;
  blockStart: number;
  blockEnd: number;
}

ShellQuickPartTarget

InterfaceDeclaration · api-quick-parts.ts

interface ShellQuickPartTarget {
  storyKind: ShellQuickPartStoryKind;
  storyIndex: number;
  tableCellIndex: number | null;
  blockIndex: number | null;
  insertionMode: ShellQuickPartInsertionMode;
}

ShellQuickPartBuildingBlock

InterfaceDeclaration · api-quick-parts.ts

interface ShellQuickPartBuildingBlock {
  id: string;
  name: string;
  gallery: ShellQuickPartGallery;
  category: string;
  description: string;
  insertionMode: ShellQuickPartInsertionMode;
  fragmentFile: string;
  fragmentSha256: string;
  sourceSelection: ShellQuickPartSelection;
  createdAt: string;
  updatedAt: string;
}

ShellQuickPartsStoreSnapshot

InterfaceDeclaration · api-quick-parts.ts

interface ShellQuickPartsStoreSnapshot {
  schema: "fastdoc.quick-parts-store.v1";
  version: 1;
  revision: number;
  updatedAt: string;
  blocks: ShellQuickPartBuildingBlock[];
  storePath: string;
  recoveredFrom: "primary" | "backup" | "empty";
  recoveryReason: string | null;
}

ShellQuickPartsDocumentOperation

TypeAliasDeclaration · api-quick-parts.ts

type ShellQuickPartsDocumentOperation = {
  operationKind: "insert-building-block";
  blockId: string;
  target: ShellQuickPartTarget;
} | {
operationKind: "update-document-properties";
properties: {
  title?: string;
  author?: string;
  subject?: string;
  company?: string;
  keywords?: string;
  comments?: string;
  custom?: Record<string, string>;
};
} | {
operationKind: "insert-field";
field: {
  instruction: string;
  result?: string | null;
  locked?: boolean;
  target: ShellQuickPartTarget;
};
} | {
operationKind: "replace-field";
field: {
  instruction: string;
  result?: string | null;
  locked?: boolean;
};
selection: ShellQuickPartSelection;
} | {
operationKind: "set-field-lock";
locked: boolean;
scope?: ShellQuickPartsFieldScope;
selection?: ShellQuickPartSelection | null;
updateAll?: boolean;
} | {
operationKind: "update-fields";
scope?: ShellQuickPartsFieldScope;
selection?: ShellQuickPartSelection | null;
updateAll?: boolean;
} | {
operationKind: "toggle-field-display";
showCodes: boolean;
};

ShellQuickPartsDocumentResult

InterfaceDeclaration · api-quick-parts.ts

interface ShellQuickPartsDocumentResult extends Record<string, unknown> {
  applied: true;
  outputPath: string;
  operationKind: string;
  reopened: boolean;
}

FastDocQuickPartsApi

InterfaceDeclaration · api-quick-parts.ts

interface FastDocQuickPartsApi {
  listQuickPartsBuildingBlocks(): Promise<ShellQuickPartsStoreSnapshot>;
  createQuickPartsBuildingBlock(request: {
      name: string;
      gallery: ShellQuickPartGallery;
      category: string;
      description?: string;
      insertionMode: ShellQuickPartInsertionMode;
      sourcePath?: string | null;
      sourceSelection: ShellQuickPartSelection;
  }): Promise<ShellQuickPartsStoreSnapshot>;
  updateQuickPartsBuildingBlock(request: {
      id: string;
      expectedRevision?: number | null;
      name?: string;
      gallery?: ShellQuickPartGallery;
      category?: string;
      description?: string;
      insertionMode?: ShellQuickPartInsertionMode;
  }): Promise<ShellQuickPartsStoreSnapshot>;
  deleteQuickPartsBuildingBlock(request: {
      id: string;
      expectedRevision?: number | null;
  }): Promise<ShellQuickPartsStoreSnapshot>;
  applyQuickPartsDocumentOperation(request: ShellQuickPartsDocumentOperation & {
      sourcePath?: string | null;
      reopenAfterWrite?: boolean;
  }): Promise<ShellQuickPartsDocumentResult>;
}