The SDK is free to try. Production use, or shipping on any origin other than your development one, needs a commercial license with an unlocked, origin-bound build.
API reference
The complete @squareys/webdecks-sdk surface — every class, method, property and constant — generated from the SDK's own TSDoc, with full-text search and cross-links.
The reference is generated by TypeDoc as part of the site build (bun run build in website/) and served at/sdk/reference/api/. Its search box covers every symbol and its doc comments.
New to the SDK? Start with Getting started, then open thelive examples. The map below orients you before you dive in — each entry links straight into its generated page.
Core
Engine-agnostic primitives shared by all three facades: the module attach/ABI gate, the WebGPU device and live viewport, the cached-wrapper base, and the selection/clipboard base.
HandleThe base for every wrapper — a numeric handle plus a back-pointer to its module. Getters read live; identity is a === test.
GpuDeviceThe engine's WebGPU device, adapter and queue as real JS objects, plus the ready / lost / slowbackend lifecycle events.
ViewportA live WebGPU view of the open model, presented directly to a host canvas through the swapchain. Damage-driven, with automatic resize, device-pixel-ratio and zoom.
SelectionThe shared selection base carrying the uniform clipboard verbs (copy / cut / paste); each facade narrows it with its own caret and range API.
Documents
The WebDocs surface. Attach a DocumentModule, open or import a .docx, and drive the document model.
DocumentModuleAttach the SDK to a loaded WebDocs engine, open the document facade, create a live viewport, and share a host device.
DocumentCounts, paragraph navigation, text insertion and formatting, find/replace, undo/redo, header/footer authoring, and export to docx / odt / pdf.
Paragraph · RunA paragraph's style, alignment, spacing and runs; a run's format bitmask, colour, font family and size.
DocumentSelectionThe caret and selection as (paragraph, byteOffset) pairs, with named character / word / line / document motions.
Spreadsheets
The WebSheets surface. Attach a SpreadsheetModule, open or load a workbook, and edit cells, ranges, charts and pivots.
SpreadsheetModuleAttach the SDK to a loaded WebSheets engine and reach the workbook facade.
Spreadsheet · SheetSheets, the active sheet, recalculation, defined names, find/replace and undo/redo; per-sheet cells, ranges, charts, pivots, rows/columns and page setup.
Cell · RangeA cell's value, formula, format and colours (chainable setters); a range's fill, borders, aggregates, conditional formats and validation.
SheetSelectionThe active cell and anchor, range selection, paste-special and selection aggregates.
Presentations
The WebDecks surface. Attach a PresentationModule, open or import a deck, and author slides, shapes and text.
PresentationModuleAttach the SDK to a loaded WebDecks engine and reach the deck facade.
Presentation · SlideSlides, current-slide navigation, add-slide, find/replace, undo/redo, and export to pptx / odp / webdeck; per-slide shape navigation, text boxes, shapes, tables and notes.
Shape · TextFrameA node's type, rect, rotation, visibility, z-order and hyperlink; a text box's text frame for reading and setting text.
PresentationSelectionThe selected-object count, the primary object, select-all / deselect, and the current slide.
The SDK is free to try. Production use, or shipping on any origin other than your development one, needs a commercial license with an unlocked, origin-bound build.