mirror of
https://github.com/webstudio-is/webstudio.git
synced 2026-10-30 16:47:54 +09:00
Oleg Isonen
05706b5425
Closes #6306 ## Outcome Content Block templates are now the public component model for MDX authoring. - Standard Markdown resolves through matching Content Block templates. - PascalCase JSX resolves to a named template first, then to a registered component. - Adding or changing a template immediately affects matching MDX, including content authored before that template existed. - Every supported standard MDX element is present in new Content Blocks by default. - Template `name` is a stable PascalCase JSX identifier. `label` remains optional display text only. - Lowercase JSX represents native HTML and SVG without exposing `ws.element` in authored syntax. - Unknown, ambiguous, and unsafe JSX stays in source, produces a source-ranged Builder diagnostic, and is omitted from published output. - Frontmatter images preserve exact `$ref` values and use the Asset description for `alt` text. - Keyboard and mouse insertion from the slash menu remove the trigger slash and preserve the selected template. ## Public MDX contract - Markdown is canonical for standard prose. - Lowercase JSX creates native elements: `<section><p>Text</p></section>`. - PascalCase JSX uses templates and registered components: `<PromotionCard />`, `<Heading tag="h1">Title</Heading>`, and `<YouTube src="https://youtu.be/KI5JHpzBK1s" />`. - Component-name collisions use stable qualified identifiers such as `Checkbox` and `RadixCheckbox`. - A self-closing template keeps its designed default subtree. An explicitly paired empty template clears it. - Static quoted values and bare booleans are supported. - Imports, exports, expressions, spreads, functions, executable JavaScript, unsafe attributes, `<$.*>`, and authored `<ws.element>` are rejected. - `ws` remains only for compiler primitives with no React component. ## Implementation - [x] Add stable, unique template names and keep them separate from labels. - [x] Parse and validate Markdown and JSX through their ASTs with precise source ranges. - [x] Share component identity between template JSX, Content MDX, Builder materialization, reload, copy, and publication. - [x] Resolve templates live after add, edit, rename, reorder, removal, undo/redo, collaboration updates, and reload. - [x] Preserve authored props, children, Asset references, template defaults, and the exact slash-menu template choice. - [x] Make one typed MDX semantic inventory drive default templates and slash-menu eligibility. - [x] Move component-dependent template assembly into the component registry. - [x] Replace production `$`, `animation`, and `radix` JSX namespaces with direct component imports. - [x] Keep only explicit compiler primitives in `ws` template JSX. - [x] Migrate repository templates, fixtures, stories, examples, MCP guidance, CLI guidance, and generated outputs. - [x] Add Builder unit and Playwright coverage for authoring, diagnostics, insertion, synchronization, reload, and publication. - [x] Review and update the authoritative Content Block and generated MCP documentation. ## Compatibility - Persisted project data continues to use namespaced component IDs and `ws:element` for generic HTML elements. No project-data migration is required. - Legacy `<ws.element ws:tag="…">`, `<ws.element ws:name="…">`, `<$.*>`, `<animation.*>`, and `<radix.*>` input remains readable during the compatibility window. - Current serializers and repository-owned sources emit only canonical Markdown, lowercase intrinsic JSX, or PascalCase identifiers. - Untouched user MDX is not rewritten automatically. Legacy syntax is canonicalized when its owning source is edited. - Deferred follow-up: remove legacy namespace readers and proxy support only after the canonical writer is deployed and existing projects are backfilled. This is intentionally outside this PR. ## Verification - [x] CI package tests, typechecks, lint, package boundaries, generated assets, migrations, and size checks pass. - [x] All six Builder E2E shards pass. - [x] Fixture checks pass on Ubuntu and Windows. - [x] Targeted local Content Engine, Template, SDK, registry, Project Build, migration, Builder, component, CLI, and Playwright tests pass. - [x] Runtime contracts, CLI docs, and MCP docs were regenerated from their owning sources. - [x] Local fixture generation completed without an unexpected fixture diff. - [x] Documentation impact reviewed and included in this PR. - [x] Review and approve the intentional List visual snapshot change. - [x] Run the complete agent evaluation suite after explicit approval. - [x] Run the network fixture link/sync pipeline against the matching PR deployment after explicit permission. ## Known visual change The generated List story now targets its actual default `ul` element instead of `ol`, so the default list styling appears in the visual snapshot. The visual change was reviewed and the approved visual check passes.
96 lines
3.2 KiB
JSON
96 lines
3.2 KiB
JSON
{
|
|
"name": "@webstudio-is/sdk",
|
|
"version": "0.0.0-webstudio-version",
|
|
"description": "Webstudio project data schema",
|
|
"author": "Webstudio <github@webstudio.is>",
|
|
"homepage": "https://webstudio.is",
|
|
"license": "AGPL-3.0-or-later",
|
|
"type": "module",
|
|
"exports": {
|
|
".": {
|
|
"webstudio": "./src/index.ts",
|
|
"partykit": "./src/index.ts",
|
|
"types": "./lib/types/index.d.ts",
|
|
"import": "./lib/index.js"
|
|
},
|
|
"./runtime": {
|
|
"webstudio": "./src/runtime.ts",
|
|
"types": "./lib/types/runtime.d.ts",
|
|
"import": "./lib/runtime.js"
|
|
},
|
|
"./asset-resource-limits": {
|
|
"webstudio": "./src/asset-resource-limits.ts",
|
|
"types": "./lib/types/asset-resource-limits.d.ts",
|
|
"import": "./lib/asset-resource-limits.js"
|
|
},
|
|
"./schema-org": {
|
|
"webstudio": "./src/schema-org.ts",
|
|
"types": "./lib/types/schema-org.d.ts",
|
|
"import": "./lib/schema-org.js"
|
|
},
|
|
"./link-utils": {
|
|
"webstudio": "./src/link-utils.ts",
|
|
"types": "./lib/types/link-utils.d.ts",
|
|
"import": "./lib/link-utils.js"
|
|
},
|
|
"./schema": {
|
|
"webstudio": "./src/schema.ts",
|
|
"types": "./lib/types/schema.d.ts",
|
|
"import": "./lib/schema.js"
|
|
},
|
|
"./normalize.css": {
|
|
"webstudio": "./src/__generated__/normalize.css.ts",
|
|
"types": "./lib/types/__generated__/normalize.css.d.ts",
|
|
"import": "./lib/__generated__/normalize.css.js"
|
|
},
|
|
"./core-templates": {
|
|
"webstudio": "./src/core-templates.tsx"
|
|
},
|
|
"./router-path-test-data": {
|
|
"webstudio": "./src/router-path-test-data.ts"
|
|
},
|
|
"./testing": {
|
|
"webstudio": "./src/testing.ts"
|
|
}
|
|
},
|
|
"files": [
|
|
"lib/*",
|
|
"!*.{test,stories}.*"
|
|
],
|
|
"sideEffects": false,
|
|
"scripts": {
|
|
"typecheck": "tsc --noEmit -p tsconfig.typecheck.json",
|
|
"test": "vitest run",
|
|
"build:schema-org-data": "tsx scripts/schema-org-data.ts && oxfmt src/__generated__/schema-org-data.ts",
|
|
"build:normalize.css": "tsx --conditions=webstudio ./scripts/normalize.css.ts && oxfmt src/__generated__/normalize.css.ts",
|
|
"build": "rm -rf lib && esbuild src/index.ts src/runtime.ts src/asset-resource-limits.ts src/schema-org.ts src/link-utils.ts src/schema.ts src/__generated__/normalize.css.ts --outdir=lib --bundle --format=esm --packages=external",
|
|
"dts": "tsc --project tsconfig.dts.json"
|
|
},
|
|
"dependencies": {
|
|
"@webstudio-is/content-engine": "workspace:*",
|
|
"@webstudio-is/expression": "workspace:*",
|
|
"@emotion/hash": "^0.9.2",
|
|
"@webstudio-is/css-engine": "workspace:*",
|
|
"@webstudio-is/fonts": "workspace:*",
|
|
"@webstudio-is/icons": "workspace:*",
|
|
"@webstudio-is/query-builder": "workspace:*",
|
|
"@webstudio-is/wsauth": "workspace:*",
|
|
"change-case": "^5.4.4",
|
|
"json-schema-typed": "^8.0.2",
|
|
"nanoid": "^5.1.5",
|
|
"reserved-identifiers": "^1.0.0",
|
|
"type-fest": "^4.37.0",
|
|
"warn-once": "^0.1.1",
|
|
"zod": "^4.4.3"
|
|
},
|
|
"devDependencies": {
|
|
"@types/papaparse": "^5.5.2",
|
|
"@webstudio-is/css-data": "workspace:*",
|
|
"@webstudio-is/template": "workspace:*",
|
|
"@webstudio-is/tsconfig": "workspace:*",
|
|
"html-tags": "^4.0.0",
|
|
"papaparse": "^5.5.3",
|
|
"vitest": "^3.1.2"
|
|
}
|
|
}
|