* chore(packages): publish the @openmaic/* SDK family to npm (#778) Prepares the @openmaic/{dsl,renderer,importer} family for its first npm publish, and moves the SDK packages onto the @openmaic scope. Why the scope move: the @maic org name is unavailable on npm (an unscoped `maic` package already holds the name), so @maic/* is not claimable. @openmaic matches the project name, the scope is free, and the repo already ships an @openmaic/docs package — so the SDK family now lines up with that convention. - rename @maic/{dsl,renderer,importer} -> @openmaic/* across packages, the workspace glob, the package dir, and all import sites; lockfile regenerated - renderer: add publishConfig (public, registry.npmjs.org) — was missing, so a scoped publish would default to the wrong registry / restricted access - importer: add a files allowlist (dist, README, LICENSE) and drop the fragile .npmignore blacklist that shipped src; add an exports map so ESM consumers resolve dist/index.js instead of falling back to the .cjs main - all three: add a prepublishOnly build (+ test/typecheck) guard so a publish can never ship a stale or empty dist - add a tag-triggered publish workflow with npm provenance, pinned by name to the three @openmaic packages so the vendored forks (mathml2omml, pptxgenjs) are never published Refs #778, #720 (Phase 1). * fix(packages): address cross-review on the @openmaic publish prep Cross-review (Claude /code-review + codex) on this PR surfaced: - renderer's advertised CJS entry was broken: it keeps @openmaic/dsl external and imports a runtime enum from it, but dsl is ESM-only (no `require` condition), so `require('@openmaic/renderer')` would throw ERR_PACKAGE_PATH_NOT_EXPORTED. Make renderer ESM-only: drop the `.cjs` rollup output, `main` now points at the ESM build, and the `require` conditions are removed from `exports`. (importer is unaffected — it bundles dsl, so its CJS build still works.) - prepublishOnly re-ran the test suite during `pnpm -r publish`, so a flaky test after dsl had already published gave a non-atomic partial release. Reduce prepublishOnly to a build-only guard (never ship stale/empty dist) and move the real test/typecheck gate into the workflow, before any publish. - document that an @openmaic/* tag publishes the whole family via `pnpm -r` (pnpm skips already-published versions); the tag is a release marker, not a per-package gate. Verified: dsl + renderer + importer build; renderer emits ESM only (0 .cjs), all exports entries resolve; `npm pack` ships dist + README + LICENSE with no src leak; frozen-lockfile passes. Refs #778. * style: reflow @openmaic/dsl type imports past print-width after rename The @maic -> @openmaic rename lengthened two single-line type imports past prettier's 100-col width; prettier --check flagged them. Pure formatting. Refs #778. * docs(importer): mark @openmaic/importer browser-only (cr-loop accepted limitation) codex cross-review flagged that the published @openmaic/importer throws `XMLHttpRequest is not a constructor` when loaded in a pure Node process — its rollup build is browser-targeted (`nodeResolve({browser:true})` + a browser pdf.js build). The app only consumes it client-side ('use client'), so this is by design. Document it as an accepted limitation: prominent browser-only note in the README and a `browser` field in the manifest. Refs #778.
218 lines
6.2 KiB
Markdown
218 lines
6.2 KiB
Markdown
# @openmaic/renderer
|
||
|
||
React component for rendering PPTist-style `Slide` JSON. Extracted from [OpenMAIC](https://github.com/THU-MAIC/OpenMAIC).
|
||
|
||
> **v1 = read-only canvas.** Editing (selection, drag/resize, ProseMirror inline editor) is planned for v2.
|
||
|
||
## Install
|
||
|
||
```bash
|
||
pnpm add @openmaic/renderer
|
||
# or
|
||
npm install @openmaic/renderer
|
||
```
|
||
|
||
Required peers:
|
||
|
||
- `react >= 18`
|
||
- `react-dom >= 18`
|
||
- `motion >= 11`
|
||
- `tailwindcss >= 4` — **the package emits Tailwind 4 arbitrary-value classes, consumers must use Tailwind 4**
|
||
|
||
Optional peers (install only if your slides use the corresponding element type):
|
||
|
||
- `echarts >= 5` — for chart elements
|
||
- `shiki >= 1` — for code elements
|
||
|
||
## Quickstart
|
||
|
||
```tsx
|
||
import { SlideCanvas, type Slide } from '@openmaic/renderer';
|
||
|
||
const slide: Slide = {
|
||
id: 'demo-1',
|
||
viewportSize: 1000,
|
||
viewportRatio: 0.5625,
|
||
theme: {
|
||
backgroundColor: '#ffffff',
|
||
themeColors: ['#5b8def'],
|
||
fontColor: '#222222',
|
||
fontName: 'sans-serif',
|
||
},
|
||
elements: [
|
||
{
|
||
type: 'text',
|
||
id: 't1',
|
||
left: 100,
|
||
top: 80,
|
||
width: 800,
|
||
height: 60,
|
||
rotate: 0,
|
||
content: '<p>Hello, Slide</p>',
|
||
defaultFontName: 'sans-serif',
|
||
defaultColor: '#222',
|
||
},
|
||
],
|
||
background: { type: 'solid', color: '#ffffff' },
|
||
};
|
||
|
||
export default function Demo() {
|
||
return (
|
||
<div style={{ width: 800, height: 450 }}>
|
||
<SlideCanvas slide={slide} />
|
||
</div>
|
||
);
|
||
}
|
||
```
|
||
|
||
The canvas auto-fits its parent container. The parent must have a defined `width × height`.
|
||
|
||
## API
|
||
|
||
### `<SlideCanvas slide effects? renderImage? renderVideo? onElementClick? scale? background? />`
|
||
|
||
The main read-only entry. Reads everything from props; zero global state.
|
||
|
||
```ts
|
||
interface SlideCanvasProps {
|
||
slide?: Slide; // required unless via <SlideRendererProvider>
|
||
scale?: number; // omit = auto-fit container
|
||
background?: SlideBackground; // overrides slide.background
|
||
effects?: SlideEffects; // laser / spotlight / highlight / zoom, all default off
|
||
renderImage?: (el, src) => ReactNode;
|
||
renderVideo?: (el) => ReactNode;
|
||
onElementClick?: (el, event) => void;
|
||
className?: string;
|
||
style?: CSSProperties;
|
||
}
|
||
```
|
||
|
||
### Play-time effects
|
||
|
||
All effects are off by default. Pass any combination via `effects`:
|
||
|
||
```tsx
|
||
<SlideCanvas
|
||
slide={slide}
|
||
effects={{
|
||
laser: { elementId: 't1', color: '#ff3b30' },
|
||
spotlight: { elementId: 't1' },
|
||
highlight: { elementId: 't1', color: '#ff6b6b', animated: true },
|
||
zoom: { elementId: 't1', scale: 1.5 },
|
||
}}
|
||
/>
|
||
```
|
||
|
||
### Media injection slots
|
||
|
||
The package's `BaseImageElement` and `BaseVideoElement` render plain `<img>` / `<video>` and know nothing about your media pipeline. Inject business behaviour via the `renderImage` / `renderVideo` slots:
|
||
|
||
```tsx
|
||
<SlideCanvas
|
||
slide={slide}
|
||
renderImage={(el, src) => (
|
||
src.startsWith('placeholder:')
|
||
? <MyPlaceholder taskId={src} />
|
||
: <img src={resolveCdnUrl(src)} alt="" style={{ width: '100%', height: '100%' }} />
|
||
)}
|
||
/>
|
||
```
|
||
|
||
### `<SlideRendererProvider>` + `useSlideContext()`
|
||
|
||
Optional high-order pattern when sibling overlays need the same slide data:
|
||
|
||
```tsx
|
||
import { SlideRendererProvider, SlideCanvas, useSlideContext } from '@openmaic/renderer';
|
||
|
||
function MyAnnotationLayer() {
|
||
const { slide } = useSlideContext();
|
||
return <div>Annotations for {slide.id}</div>;
|
||
}
|
||
|
||
<SlideRendererProvider slide={slide} scale={0.9}>
|
||
<SlideCanvas /> {/* reads slide/scale from context */}
|
||
<MyAnnotationLayer />
|
||
</SlideRendererProvider>
|
||
```
|
||
|
||
### Granular components — `@openmaic/renderer/elements`
|
||
|
||
If you want to compose your own layout instead of using `SlideCanvas`, the 9 base elements are exported individually:
|
||
|
||
```ts
|
||
import {
|
||
BaseTextElement, BaseShapeElement, BaseImageElement,
|
||
BaseLineElement, BaseChartElement, BaseLatexElement,
|
||
BaseTableElement, BaseVideoElement, BaseCodeElement,
|
||
ElementOutline,
|
||
} from '@openmaic/renderer/elements';
|
||
```
|
||
|
||
Each accepts `{ elementInfo: PPTXxxElement }`. Image/Video also take a render slot.
|
||
|
||
### Types — `@openmaic/renderer/types`
|
||
|
||
```ts
|
||
import type {
|
||
Slide, PPTElement, SlideBackground, SlideTheme,
|
||
PPTTextElement, PPTShapeElement, PPTImageElement,
|
||
PPTLineElement, PPTChartElement, PPTLatexElement,
|
||
PPTTableElement, PPTVideoElement, PPTCodeElement,
|
||
ImageElementClip, ImageElementFilters,
|
||
Gradient, GradientType, PPTElementOutline, PPTElementShadow,
|
||
SlideEffects, LaserEffectOptions, SpotlightEffectOptions,
|
||
HighlightEffectOptions, ZoomEffectOptions,
|
||
} from '@openmaic/renderer/types';
|
||
```
|
||
|
||
## Tailwind 4 setup
|
||
|
||
Ensure your `tailwind.config.{ts,js}` includes the package source:
|
||
|
||
```js
|
||
export default {
|
||
content: [
|
||
'./src/**/*.{ts,tsx}',
|
||
'./node_modules/@openmaic/renderer/dist/**/*.{js,cjs}',
|
||
],
|
||
};
|
||
```
|
||
|
||
## Fonts (optional, CDN-hosted)
|
||
|
||
Slides imported from PowerPoint often reference Chinese faces that aren't
|
||
installed on the viewer's machine. The package ships a `fonts.css` with
|
||
`@font-face` rules for a small whitelist of self-hosted CJK faces — import it
|
||
once at your app shell to make those faces available:
|
||
|
||
```ts
|
||
import '@openmaic/renderer/fonts.css';
|
||
```
|
||
|
||
> **Runtime dependency — read this.** The `@font-face` `src` URLs point at an
|
||
> external font host (`https://file.maic.chat/fonts/<name>.woff2`); the woff2
|
||
> files are **not** bundled in the package. So this is a hard runtime dependency:
|
||
> the host must be **reachable and CORS-enabled** from the consumer's app, or the
|
||
> browser will **silently fall back to system fonts** (no error, just different
|
||
> glyphs/metrics). If you need a different origin (self-hosting, air-gapped, a
|
||
> private CDN), change `FONT_CDN_BASE_URL` in `fonts.config.mjs` and regenerate
|
||
> with `pnpm run genfonts`.
|
||
>
|
||
> The import is **optional** — slides render fine without it, using whatever
|
||
> fonts the system provides. See [FONTS.md](./FONTS.md) for the face list and
|
||
> their licenses.
|
||
|
||
## Companion package
|
||
|
||
[`@openmaic/importer`](../importer) converts `.pptx` files to the same `Slide[]` shape, so you can do `.pptx → @openmaic/renderer` end-to-end.
|
||
|
||
## See also
|
||
|
||
- [DESIGN.md](./DESIGN.md) — package design decisions and scope
|
||
- v2 will add editing (`<SlideEditor editable onChange />`); the read-only `<SlideCanvas>` API will remain stable
|
||
|
||
## License
|
||
|
||
MIT
|