API overview

import { PrintLinkClient } from '@printlink/sdk';

const client = new PrintLinkClient({
  appName: 'My business app',         // shown in the pairing prompt and site list
  channel: 'erp',                     // optional: distinguish apps on one machine
  endpoint: 'ws://127.0.0.1:17888/ws',// optional, this is the default
  requestTimeoutMs: 30_000,           // optional per-request timeout
});

detect() → connect() → ensureAuthorized() → calls … → close()

interface JobPrintParams {
  queueId: string;
  source: PrintSource;       // { items: SourceItem[] }, 1..=50
  options?: PrintOptions;    // see the print options page
  profileId?: string;        // omitted = printer default; '' = explicitly none
  profileMode?: 'default' | 'explicit' | 'none';
  title?: string;            // shown in the console job list
  idempotencyKey?: string;   // 1..128 visible ASCII; a repeat runs once
  channel?: string;          // ^[a-z][a-z0-9_-]*$, up to 64 characters
}

type SourceItem =
  | { type: 'image'; asset?: AssetRef; remote?: { url: string }; pageLayout?: PageLayout }
  | { type: 'pdf'; asset: AssetRef; pageRange?: string }
  | { type: 'html'; asset?: AssetRef; remote?: { url: string }; pageRange?: string }
  | { type: 'document'; document: PrintDocument; data?: unknown };

interface PreviewOpenResult {
  previewSessionId: string;
  pageCount: number;
  artifactSha256: string;
  warnings: PrintWarning[];
  windowShown: boolean;
  source: SourceSummary;    // which output pages each item covers
}

interface PreviewUpdateParams {
  previewSessionId: string;
  source?: PrintSource;                 // full replacement
  options?: PrintOptions;               // full replacement
  pageLayout?: PreviewPageLayoutUpdate; // targeted update
  queueId?: string;
  profileId?: string;
  profileMode?: 'default' | 'explicit' | 'none';
}

type PreviewPageLayoutUpdate =
  | { scope: 'all'; layout: PageLayoutPreset }
  | { scope: 'image'; itemIndex: number; layout: PageLayout };

type PageLayoutPreset =
  | { mode: 'auto' }      // scale to fit the printable area, centred, no cropping
  | { mode: 'actual' }    // 1:1, centred, cropped where it overflows
  | { mode: 'fill' };     // scale up to cover, cropping the overflow

type PageLayout =
  | PageLayoutPreset
  | {
      mode: 'custom';
      horizontal?: 'left' | 'center' | 'right';
      vertical?: 'top' | 'center' | 'bottom';
      size?: { widthMm?: number; heightMm?: number };   // exclusive with scalePercent
      scalePercent?: number;                             // (0, 1000]
      offset?: { xMm?: number; yMm?: number };
      rotate?: 0 | 90 | 180 | 270;
      flipHorizontal?: boolean;
      flipVertical?: boolean;
    };

interface AssetRef { id: string; sha256: string; mime: string; size: number }

interface PreviewGetPageResult {
  pageIndex: number;
  widthPx: number;
  heightPx: number;
  pngBase64: string;
  origin: { itemIndex: number; kind: string; itemPageIndex: number };
  pageLayout: PageLayout;          // the layout actually used, always present
  layout?: PageLayoutGeometry;     // millimetre geometry
}