* 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.
392 lines
11 KiB
TypeScript
392 lines
11 KiB
TypeScript
/**
|
|
* Stage API - Canvas Operations
|
|
*
|
|
* Factory function that creates the canvas namespace of the Stage API.
|
|
* Handles background, theme, highlight, spotlight, laser, and zoom effects.
|
|
* Uses useCanvasStore for visual overlay effects.
|
|
*/
|
|
|
|
import type { SlideContent } from '@/lib/types/stage';
|
|
import type { SlideTheme, SlideBackground } from '@openmaic/dsl';
|
|
import { useCanvasStore } from '@/lib/store/canvas';
|
|
import type { StageStore, APIResult, HighlightOptions, SpotlightOptions } from './stage-api-types';
|
|
import { getScene } from './stage-api-defaults';
|
|
|
|
/**
|
|
* Create the canvas operations API
|
|
*
|
|
* @param store - Zustand store instance
|
|
* @returns Canvas namespace API
|
|
*/
|
|
export function createCanvasAPI(store: StageStore) {
|
|
return {
|
|
/**
|
|
* Set background
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @param background - Background settings
|
|
* @returns Whether successful
|
|
*/
|
|
setBackground(sceneId: string, background: SlideBackground): APIResult<boolean> {
|
|
try {
|
|
const state = store.getState();
|
|
const scene = getScene(state.scenes, sceneId);
|
|
|
|
if (!scene || scene.type !== 'slide') {
|
|
return { success: false, error: 'Invalid scene' };
|
|
}
|
|
|
|
const content = scene.content as SlideContent;
|
|
|
|
const newScenes = state.scenes.map((s) => {
|
|
if (s.id === sceneId) {
|
|
return {
|
|
...s,
|
|
content: {
|
|
...content,
|
|
canvas: {
|
|
...content.canvas,
|
|
background,
|
|
},
|
|
},
|
|
updatedAt: Date.now(),
|
|
};
|
|
}
|
|
return s;
|
|
});
|
|
|
|
store.setState({ scenes: newScenes });
|
|
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Set theme
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @param theme - Theme settings
|
|
* @returns Whether successful
|
|
*/
|
|
setTheme(sceneId: string, theme: Partial<SlideTheme>): APIResult<boolean> {
|
|
try {
|
|
const state = store.getState();
|
|
const scene = getScene(state.scenes, sceneId);
|
|
|
|
if (!scene || scene.type !== 'slide') {
|
|
return { success: false, error: 'Invalid scene' };
|
|
}
|
|
|
|
const content = scene.content as SlideContent;
|
|
|
|
const newScenes = state.scenes.map((s) => {
|
|
if (s.id === sceneId) {
|
|
return {
|
|
...s,
|
|
content: {
|
|
...content,
|
|
canvas: {
|
|
...content.canvas,
|
|
theme: {
|
|
...content.canvas.theme,
|
|
...theme,
|
|
},
|
|
},
|
|
},
|
|
updatedAt: Date.now(),
|
|
};
|
|
}
|
|
return s;
|
|
});
|
|
|
|
store.setState({ scenes: newScenes });
|
|
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Highlight an element (teaching feature)
|
|
*
|
|
* Emphasize an element by adding a highlight border or shadow
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @param elementId - Element ID
|
|
* @param options - Highlight options
|
|
* @returns Whether successful
|
|
*/
|
|
highlight(
|
|
sceneId: string,
|
|
elementId: string,
|
|
options: HighlightOptions = {},
|
|
): APIResult<boolean> {
|
|
const { duration, color = '#ff6b6b', style = 'outline' } = options;
|
|
|
|
try {
|
|
// Use the new Canvas Store highlight overlay API
|
|
// Advantage: does not modify the element itself, purely visual effect
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.setHighlight([elementId], {
|
|
color,
|
|
opacity: style === 'fill' ? 0.3 : 0.5,
|
|
borderWidth: 3,
|
|
animated: true,
|
|
});
|
|
|
|
// If duration is set, automatically clear the highlight
|
|
if (duration) {
|
|
setTimeout(() => {
|
|
canvasStore.clearHighlight();
|
|
}, duration);
|
|
}
|
|
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Spotlight effect (teaching feature)
|
|
*
|
|
* Highlight a specific element while dimming everything else
|
|
* Note: this requires a mask layer in the frontend rendering layer
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @param elementId - Element ID
|
|
* @param options - Spotlight options
|
|
* @returns Whether successful
|
|
*/
|
|
spotlight(
|
|
sceneId: string,
|
|
elementId: string,
|
|
options: SpotlightOptions = {},
|
|
): APIResult<boolean> {
|
|
try {
|
|
// Use Canvas Store's spotlight API
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.setSpotlight(elementId, options);
|
|
|
|
// If duration is set, automatically clear the spotlight
|
|
if (options.duration) {
|
|
setTimeout(() => {
|
|
canvasStore.clearSpotlight();
|
|
}, options.duration);
|
|
}
|
|
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Clear all highlight and spotlight effects
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @returns Whether successful
|
|
*/
|
|
clearHighlights(_sceneId: string): APIResult<boolean> {
|
|
try {
|
|
// Use Canvas Store to clear all teaching effects
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.clearHighlight();
|
|
canvasStore.clearSpotlight();
|
|
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Clear spotlight effect
|
|
*
|
|
* @returns Whether successful
|
|
*/
|
|
clearSpotlight(_sceneId?: string): APIResult<boolean> {
|
|
try {
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.clearSpotlight();
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Set percentage-mode spotlight
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @param elementId - Element ID
|
|
* @param geometry - Percentage geometry info
|
|
* @param options - Spotlight options
|
|
* @returns Whether successful
|
|
*/
|
|
setSpotlightPercentage(
|
|
sceneId: string,
|
|
elementId: string,
|
|
geometry: import('@/lib/types/action').PercentageGeometry,
|
|
options: SpotlightOptions = {},
|
|
): APIResult<boolean> {
|
|
try {
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.setSpotlightPercentage(elementId, geometry, options);
|
|
|
|
if (options.duration) {
|
|
setTimeout(() => {
|
|
canvasStore.clearSpotlight();
|
|
}, options.duration);
|
|
}
|
|
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Set laser pointer effect
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @param elementId - Element ID
|
|
* @param geometry - Percentage geometry info
|
|
* @param options - Laser pointer options
|
|
* @returns Whether successful
|
|
*/
|
|
setLaser(
|
|
sceneId: string,
|
|
elementId: string,
|
|
geometry: import('@/lib/types/action').PercentageGeometry,
|
|
options: import('@/lib/store/canvas').LaserOptions = {},
|
|
): APIResult<boolean> {
|
|
try {
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.setLaser(elementId, options);
|
|
|
|
if (options.duration) {
|
|
setTimeout(() => {
|
|
canvasStore.clearLaser();
|
|
}, options.duration);
|
|
}
|
|
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Clear laser pointer effect
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @returns Whether successful
|
|
*/
|
|
clearLaser(_sceneId: string): APIResult<boolean> {
|
|
try {
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.clearLaser();
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Set zoom effect
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @param elementId - Element ID
|
|
* @param geometry - Percentage geometry info
|
|
* @param scale - Zoom scale
|
|
* @returns Whether successful
|
|
*/
|
|
setZoom(
|
|
sceneId: string,
|
|
elementId: string,
|
|
geometry: import('@/lib/types/action').PercentageGeometry,
|
|
scale: number,
|
|
): APIResult<boolean> {
|
|
try {
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.setZoom(elementId, scale);
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Clear zoom effect
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @returns Whether successful
|
|
*/
|
|
clearZoom(_sceneId: string): APIResult<boolean> {
|
|
try {
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.clearZoom();
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Clear all visual effects (spotlight, laser, zoom, etc.)
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @returns Whether successful
|
|
*/
|
|
clearAllEffects(_sceneId: string): APIResult<boolean> {
|
|
try {
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.clearAllEffects();
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Highlight multiple elements in batch
|
|
*
|
|
* @param sceneId - Scene ID
|
|
* @param elementIds - Element ID list
|
|
* @param options - Highlight options
|
|
* @returns Whether successful
|
|
*/
|
|
highlightMultiple(
|
|
sceneId: string,
|
|
elementIds: string[],
|
|
options: HighlightOptions = {},
|
|
): APIResult<boolean> {
|
|
const { duration, color = '#ff6b6b' } = options;
|
|
|
|
try {
|
|
const canvasStore = useCanvasStore.getState();
|
|
canvasStore.setHighlight(elementIds, {
|
|
color,
|
|
opacity: 0.3,
|
|
borderWidth: 3,
|
|
animated: true,
|
|
});
|
|
|
|
if (duration) {
|
|
setTimeout(() => {
|
|
canvasStore.clearHighlight();
|
|
}, duration);
|
|
}
|
|
|
|
return { success: true, data: true };
|
|
} catch (error) {
|
|
return { success: false, error: String(error) };
|
|
}
|
|
},
|
|
};
|
|
}
|