Skip to content

Compatibility and deployment ​

Browsers and frameworks ​

Use current Chrome, Edge or Firefox, or Safari 15 and above, with native custom elements and shadow DOM.

IntegrationVersions and setup
React16.14, 18 and 19; wrappers use the host's React
Custom elementsRegister the focused entry in the application bundle
VueConfigure the compiler to treat sea-* tags as custom elements
AngularInclude CUSTOM_ELEMENTS_SCHEMA for templates containing widget tags

Application integration provides React function, React class and custom-element examples.

Focused imports and bundle size ​

Import the components used by the document intake example through their focused entries:

ts
import { SeaContextProvider } from "@sea-dev/widget-lit/react/context";
import { SeaProcess } from "@sea-dev/widget-lit/react/process";
import { SeaUpload } from "@sea-dev/widget-lit/react/upload";
import { SeaFileBrowser } from "@sea-dev/widget-lit/react/file-browser";
import { SeaForm } from "@sea-dev/widget-lit/react/form";
import { SeaSourceViewer } from "@sea-dev/widget-lit/react/source-viewer";
import { SeaManualInput } from "@sea-dev/widget-lit/react/manual-input";

React wrappers use the host's React. PDF.js, the PDF worker and WebAssembly parsers load in lazy modules when their features are used.

Worker and WASM assets ​

The package bundles the PDF.js 4.8.69 worker and its WebAssembly parsers. React wrappers and Web components load them automatically with default Vite settings. PDF processing runs in a browser worker. Deploy the complete application build and preserve the generated module URLs.

For a fixed worker URL, copy node_modules/@sea-dev/widget-lit/dist/pdf.worker.min.mjs into your application's public assets. Set workerUrl on source or PDF viewers, or SeaPdfViewer.workerSrc before the first viewer mounts. Keep the worker and widget package at matching versions.

For example, when the worker is hosted at /assets/pdf.worker.min.mjs:

ts
import { SeaPdfViewer } from "@sea-dev/widget-lit/pdf-viewer";

SeaPdfViewer.workerSrc = "/assets/pdf.worker.min.mjs";

The default worker uses a browser-generated Blob URL. Allow blob: in worker-src, following Authentication and security. Use a fixed worker URL when the host's policy requires it.

API and document access ​

The API needs no origin setting. It accepts browser requests from any origin and authenticates them with the credential. Document storage has its own origin and CORS policy. Allow your application's browser origin there, or configure documentProxy on the widget or context. The proxy receives the signed URL in a url query parameter.

The browser must reach the API over the deployment's network. Authentication and security supplies the content policy directives.

Versions ​

Install a specific package archive and retain its lockfile. Upgrade or roll back by selecting another supplied version and rebuilding your application. Use focused imports for the components in each screen.

Upgrade component imports and bindings together to the API documented for the supplied package. SeaForm is the existing data viewer with a clearer name. The previous data-viewer names and import paths remain compatibility aliases to the same implementation.

SeaUpload and sea-upload are the canonical upload names. SeaUploadStatus, sea-upload-status, @sea-dev/widget-lit/upload-status and @sea-dev/widget-lit/react/upload-status remain compatibility aliases to the same implementation. The React alias renders sea-upload; update CSS targeting the old tag when migrating React imports.

Existing submission-based widgets use the same context connection described in Sea context.

Run composition migration ​

Set apiUrl, the credential, locale and source access settings on SeaContextProvider, then mount SeaProcess with an existing run ID and place individual widgets inside it. Sea context also supports page metadata as an API host fallback.

SeaDocumentIntake and its focused imports are removed. Copy the document intake example into the host application. Configure uploads and forms through their own properties and set placement with host CSS. Existing submission-based form and source views also require Sea context.

Bind SeaUpload.stepLabel to the extraction step's document input. The SDK manages the batch and refreshes the run; host effects and selection handlers are unnecessary. Upload covers the run-bound workflow and existing submission compatibility mode.

The bundled tRPC adapter reports 501 for unsupported process, run-step upload and manual-input operations. Use the REST client or a WidgetTransport implementing the required operations.

Changelog ​

Unreleased ​

  • Duplicate submissions for one ordinary output form on a single step prefer populated data and display equivalent copies consistently. Competing populated results require an output selection.
  • Source panels show an empty state before documents are uploaded and open the source when processing completes.
  • Check findings are removed: sea-check-findings, SeaCheckFindings, their focused entries and the review transport operations. The run review endpoints return 404. Labelled check outputs remain in SeaForm.
  • The pipeline step role validation is removed. Existing validation steps are deleted, and creating or updating a step with that role returns 400.

0.3.0 ​

  • Required Sea context with shared selection, citation handling and interaction tracking.
  • Composition around an existing run, with unique step-label binding, an optional step-role constraint and step groups.
  • Canonical SeaForm name for the existing data viewer, with compatibility aliases for its previous names and import paths.
  • Document intake as host-owned example markup and CSS using the individual widgets.
  • A source viewer for PDFs, images and spreadsheets.
  • Manual input that saves and finalises the run's required form.
  • Additional field presentation settings, correction reasons and per-field overrides.
  • Host-supplied check findings and resolution actions.
  • Check findings save the selected decisions together through Save all.
  • Document URL rewriting and proxy settings.
  • Duplicate custom-element registration is skipped with a warning.
  • Arabic numeric entry, spreadsheet text alignment and fixture layout fixes.
  • PDF load failures show details and a storage CORS hint.
  • Focused component and React entry points.
  • The banking-classic and indigo theme presets.
  • Typed event detail exports for form changes, uploads and expired spreadsheet links.
  • Upload and create operations retry rate limits with backoff. Polling continues with backoff.
  • Correction drawers confirm discarding unsaved changes.
  • Single field requires a backend binding. Deal activity takes its connection from sea-context.
  • Submission analytics and Form inspector are removed.