openmaic-custom/lib/api/stage-api-whiteboard.ts
wyuc 7cb129183d
chore(packages): publish the @openmaic/* SDK family to npm (#778) (#780)
* 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.
2026-06-24 15:12:23 +08:00

256 lines
8.0 KiB
TypeScript

/**
* Stage API - Whiteboard Management
*
* Factory function that creates the whiteboard namespace of the Stage API.
* Handles whiteboard CRUD and whiteboard element operations.
*/
import type { Whiteboard } from '@/lib/types/stage';
import type { PPTElement } from '@openmaic/dsl';
import type { StageStore, APIResult } from './stage-api-types';
import { generateId } from './stage-api-defaults';
/**
* Create the whiteboard management API
*
* @param store - Zustand store instance
* @returns Whiteboard namespace API
*/
export function createWhiteboardAPI(store: StageStore) {
const whiteboardAPI = {
/**
* Create a whiteboard
*
* @returns Whether successful
*/
create(): APIResult<Whiteboard> {
try {
const state = store.getState();
const whiteboard: Whiteboard = {
id: generateId('whiteboard'),
viewportSize: 1000,
viewportRatio: 16 / 9,
elements: [],
background: {
type: 'solid',
color: '#ffffff',
},
animations: [],
};
const whiteboardList = state.stage?.whiteboard
? [...state.stage.whiteboard, whiteboard]
: [whiteboard];
store.setState({
stage: { ...state.stage, whiteboard: whiteboardList },
});
return { success: true, data: whiteboard };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Get a whiteboard
*
* @returns The most recently created whiteboard object
*/
get(): APIResult<Whiteboard> {
try {
const state = store.getState();
if (!state.stage?.whiteboard || state.stage.whiteboard.length === 0) {
return whiteboardAPI.create();
}
return { success: true, data: state.stage.whiteboard.at(-1) };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Update a whiteboard
*
* @param updates - Fields to update
* @param whiteboardId - Whiteboard ID
* @returns Whether successful
*/
update(updates: Partial<Whiteboard>, whiteboardId: string): APIResult<boolean> {
try {
const state = store.getState();
const whiteboard = state.stage?.whiteboard?.find((wb) => wb.id === whiteboardId);
if (!whiteboard) return { success: false, error: 'Whiteboard not found' };
const newWhiteboard = { ...whiteboard, ...updates };
const whiteboardList = state.stage!.whiteboard!.map((wb) =>
wb.id === whiteboardId ? newWhiteboard : wb,
);
store.setState({
stage: { ...state.stage, whiteboard: whiteboardList },
});
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Delete a whiteboard
*
* @param whiteboardId - Whiteboard ID
* @returns Whether successful
*/
delete(whiteboardId: string): APIResult<boolean> {
try {
const state = store.getState();
const whiteboardList = state.stage!.whiteboard!.filter((wb) => wb.id !== whiteboardId);
store.setState({
stage: { ...state.stage, whiteboard: whiteboardList },
});
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Get all whiteboards
*
* @returns List of all whiteboards
*/
list(): APIResult<Whiteboard[]> {
try {
const state = store.getState();
return { success: true, data: state.stage!.whiteboard! };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Get a whiteboard element
*
* @param elementId - Element ID
* @param whiteboardId - Whiteboard ID
* @returns Element object
*/
getElement(elementId: string, whiteboardId: string): APIResult<PPTElement> {
try {
const state = store.getState();
const whiteboard = state.stage!.whiteboard!.find((wb) => wb.id === whiteboardId);
if (!whiteboard) return { success: false, error: 'Whiteboard not found' };
return {
success: true,
data: whiteboard.elements.find((el) => el.id === elementId),
};
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Add a whiteboard element
*
* @param element - Element object
* @param whiteboardId - Whiteboard ID
* @returns Whether successful
*/
addElement(element: PPTElement, whiteboardId: string): APIResult<boolean> {
try {
const state = store.getState();
const whiteboard = state.stage!.whiteboard!.find((wb) => wb.id === whiteboardId);
if (!whiteboard) return { success: false, error: 'Whiteboard not found' };
const newElement = {
...element,
id: element.id || generateId(element.type),
};
const newWhiteboard = {
...whiteboard,
elements: [...whiteboard.elements, newElement],
};
const whiteboardList = state.stage!.whiteboard!.map((wb) =>
wb.id === whiteboardId ? newWhiteboard : wb,
);
store.setState({
stage: { ...state.stage, whiteboard: whiteboardList },
});
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Delete a whiteboard element
*
* @param elementId - Element ID
* @param whiteboardId - Whiteboard ID
* @returns Whether successful
*/
deleteElement(elementId: string, whiteboardId: string): APIResult<boolean> {
try {
const state = store.getState();
const whiteboard = state.stage!.whiteboard!.find((wb) => wb.id === whiteboardId);
if (!whiteboard) return { success: false, error: 'Whiteboard not found' };
const newWhiteboard = {
...whiteboard,
elements: whiteboard.elements.filter((el) => el.id !== elementId),
};
const whiteboardList = state.stage!.whiteboard!.map((wb) =>
wb.id === whiteboardId ? newWhiteboard : wb,
);
store.setState({
stage: { ...state.stage, whiteboard: whiteboardList },
});
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Update a whiteboard element
*
* @param element - Element object
* @param whiteboardId - Whiteboard ID
* @returns Whether successful
*/
updateElement(element: PPTElement, whiteboardId: string): APIResult<boolean> {
try {
const state = store.getState();
const whiteboard = state.stage!.whiteboard!.find((wb) => wb.id === whiteboardId);
if (!whiteboard) return { success: false, error: 'Whiteboard not found' };
const newWhiteboard = {
...whiteboard,
elements: whiteboard.elements.map((el) => (el.id === element.id ? element : el)),
};
const whiteboardList = state.stage!.whiteboard!.map((wb) =>
wb.id === whiteboardId ? newWhiteboard : wb,
);
store.setState({
stage: { ...state.stage, whiteboard: whiteboardList },
});
return { success: true, data: true };
} catch (error) {
return { success: false, error: String(error) };
}
},
/**
* Get whiteboard element list
*
* @param whiteboardId - Whiteboard ID
* @returns Element list
*/
listElements(whiteboardId: string): APIResult<PPTElement[]> {
try {
const state = store.getState();
const whiteboard = state.stage!.whiteboard!.find((wb) => wb.id === whiteboardId);
if (!whiteboard) return { success: false, error: 'Whiteboard not found' };
return { success: true, data: whiteboard.elements };
} catch (error) {
return { success: false, error: String(error) };
}
},
};
return whiteboardAPI;
}