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

64 lines
1.6 KiB
JavaScript

import { nodeResolve } from '@rollup/plugin-node-resolve';
import commonjs from '@rollup/plugin-commonjs';
import typescript from '@rollup/plugin-typescript';
const external = [
/^@openmaic\/dsl($|\/)/,
/^react($|\/)/,
/^react-dom($|\/)/,
/^motion($|\/)/,
/^katex($|\/)/,
/^echarts($|\/)/,
/^shiki($|\/)/,
/^lucide-react($|\/)/,
/^tinycolor2($|\/)/,
/^tailwind-merge($|\/)/,
/^clsx($|\/)/,
/^html-to-image($|\/)/,
/^html2canvas-pro($|\/)/,
];
const onwarn = (warning) => {
if (warning.code === 'CIRCULAR_DEPENDENCY') return;
if (warning.code === 'MODULE_LEVEL_DIRECTIVE') return;
console.warn(`(!) ${warning.message}`);
};
const plugins = [
nodeResolve({ browser: true, preferBuiltins: false }),
commonjs(),
typescript({
tsconfig: './tsconfig.json',
declaration: false,
declarationMap: false,
rootDir: 'src',
}),
];
const entries = {
index: 'src/index.ts',
'elements/index': 'src/elements/index.ts',
'types/index': 'src/types/index.ts',
'snapshot/index': 'src/snapshot/index.ts',
};
// ESM-only: @openmaic/dsl (kept external) is ESM-only, so a CJS renderer bundle
// could not `require('@openmaic/dsl')`. Ship ESM only and don't advertise a
// `require` entry we can't honor. Consumers use bundlers (Next/Vite) or native ESM.
const buildBundle = () => ({
input: entries,
external,
onwarn,
output: {
dir: 'dist',
format: 'es',
entryFileNames: '[name].js',
chunkFileNames: 'chunks/[name]-[hash].js',
preserveModulesRoot: 'src',
sourcemap: true,
},
plugins,
});
export default buildBundle();