@ibexa/cohesivo-sdk-types
v0.0.7
Published
TypeScript types shared by the Ibexa front-end packages and the Ibexa DXP editor code. The package contains no runtime code, only type declarations. Add it as a `devDependency`, unless your own published declarations reference it, in which case it has to
Readme
@ibexa/cohesivo-sdk-types
TypeScript types shared by the Ibexa front-end packages and the Ibexa DXP editor code. The package contains no runtime code, only type declarations. Add it as a devDependency, unless your own published declarations reference it, in which case it has to be a dependency.
@ibexa/cohesivo-sdk-types/page-builder
The headless Page Builder protocol: the data the editor and the preview exchange over postMessage.
- The Page field value (
FieldValue,Zone,Block) and the block configuration the editor exposes. - The intent parameters saying what the editor works on.
- The message map in both directions (
PBMessages,AppMessages) and the payload of each message. - The negotiation envelopes; the runtime negotiation lives in
@ibexa/cohesivo-sdk-utils/page-builder. - Pointer and block geometry, and the editor translations shown in preview mode.
The exports are lib/page-builder/index.ts; the declarations are the reference.
Import with import type. A plain import { type X } keeps a runtime import of the module behind under verbatimModuleSyntax.
Development
npm run build # emits the declarations to dist/
npm run cs:check # prettier, eslint and tscPackages are released together from the repository root, see the root README.
