@wp-typia/create-workspace-template 0.17.1 → 0.18.0

package/README.md

@@ -16,16 +16,39 @@ npm run wp-typia:add -- block my-block --template basic
 npm run wp-typia:add -- integration-env local-smoke --wp-env --release-zip --service docker-compose
 npm run wp-typia:add -- style callout-emphasis --block my-block
 npm run wp-typia:add -- transform quote-to-block --from core/quote --to my-block
+npm run wp-typia:add -- pattern hero-layout
+npm run wp-typia:add -- pattern hero-photo-section --scope section --section-role hero --tags hero,image
 npm run wp-typia:add -- binding-source hero-data
 npm run wp-typia:add -- binding-source hero-data --block my-block --attribute headline
 npm run wp-typia:add -- contract external-retrieve-response --type ExternalRetrieveResponse
 npm run wp-typia:add -- rest-resource external-record --manual --namespace legacy/v1 --route-pattern '/records/(?P<post_id>[\d]+)' --permission-callback legacy_can_read_records --controller-class Legacy\\Records\\Controller
 npm run wp-typia:add -- post-meta integration-state --post-type post --type IntegrationStateMeta
+npm run wp-typia:add -- binding-source integration-state-source --from-post-meta integration-state --meta-path status --block my-block --attribute headline
 npm run wp-typia:add -- editor-plugin review-workflow --slot sidebar
 npm run wp-typia:add -- editor-plugin seo-notes --slot document-setting-panel
 npm run wp-typia:add -- hooked-block my-block --anchor core/post-content --position after
 ```
 
+Typed block nesting rules live in `BLOCK_NESTING` inside
+`scripts/block-config.ts`. Declare `parent`, `ancestor`, or `allowedBlocks`
+relationships there and `wp-typia sync --check` will validate referenced block
+names in the workspace namespace while allowing external targets like
+`core/group`, then keep the matching `block.json` metadata current.
+Declare default editor `InnerBlocks` templates in `BLOCK_TEMPLATES` and
+`wp-typia sync` will generate `src/inner-blocks-templates.ts` with constants you
+can import from edit components.
+Pattern files listed in `PATTERNS` are parsed during the same sync flow so
+`wp-typia sync --check` can first validate typed catalog metadata such as
+duplicate slugs, `scope`, `sectionRole`, `tags`, `thumbnailUrl`, and
+`contentFile`, then catch serialized block content that violates the declared
+`allowedBlocks`, `parent`, or `ancestor` rules. Unknown or unparseable pattern
+blocks are reported as warnings so the first implementation stays non-mutating.
+The validator reads serialized `<!-- wp:* -->` block comment boundaries
+conservatively and does not execute dynamic PHP content.
+For a complete generic family with a container, section, title, body, and media
+block, see the Nesting Contracts Guide in the hosted docs and the checked
+fixture at `tests/fixtures/nested-block-family.ts`.
+
 ## CLI binary policy
 
 Official workspace projects install `wp-typia` as a local devDependency and

package/README.md.mustache

@@ -38,11 +38,33 @@ bun run wp-typia:add variation hero-card --block counter-card
 bun run wp-typia:add style callout-emphasis --block counter-card
 bun run wp-typia:add transform quote-to-counter --from core/quote --to counter-card
 bun run wp-typia:add pattern hero-layout
+bun run wp-typia:add pattern hero-photo-section --scope section --section-role hero --tags hero,image
 bun run wp-typia:add rest-resource snapshots --namespace {{namespace}}/v1 --methods list,read,create
 bun run wp-typia:add rest-resource external-record --manual --namespace legacy/v1 --route-pattern '/records/(?P<post_id>[\d]+)' --permission-callback legacy_can_read_records --controller-class Legacy\\Records\\Controller
 bun run wp-typia:add post-meta integration-state --post-type post
+bun run wp-typia:add binding-source integration-state-source --from-post-meta integration-state --meta-path status --block counter-card --attribute headline
 ```
 
+Typed block nesting rules live in `BLOCK_NESTING` inside
+`scripts/block-config.ts`. Declare `parent`, `ancestor`, or `allowedBlocks`
+relationships there and `wp-typia sync --check` will validate referenced block
+names in the workspace namespace while allowing external targets like
+`core/group`, then keep the matching `block.json` metadata current.
+Declare default editor `InnerBlocks` templates in `BLOCK_TEMPLATES` and
+`wp-typia sync` will generate `src/inner-blocks-templates.ts` with constants you
+can import from edit components.
+Pattern files listed in `PATTERNS` are parsed during the same sync flow so
+`wp-typia sync --check` can first validate typed catalog metadata such as
+duplicate slugs, `scope`, `sectionRole`, `tags`, `thumbnailUrl`, and
+`contentFile`, then catch serialized block content that violates the declared
+`allowedBlocks`, `parent`, or `ancestor` rules. Unknown or unparseable pattern
+blocks are reported as warnings so the first implementation stays non-mutating.
+The validator reads serialized `<!-- wp:* -->` block comment boundaries
+conservatively and does not execute dynamic PHP content.
+For a complete generic family with a container, section, title, body, and media
+block, see the Nesting Contracts Guide in the hosted docs and the checked
+fixture at `tests/fixtures/nested-block-family.ts`.
+
 ## CLI Commands
 
 This workspace installs the executable `wp-typia` CLI as a local devDependency

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-typia/create-workspace-template",
-  "version": "0.17.1",
+  "version": "0.18.0",
   "description": "Official empty wp-typia workspace template package",
   "packageManager": "bun@1.3.11",
   "type": "module",

package/scripts/block-config.ts.mustache

@@ -1,3 +1,8 @@
+import {
+	defineBlockNesting,
+	defineInnerBlocksTemplates,
+} from '@wp-typia/block-runtime/metadata-core';
+
 export interface WorkspaceBlockConfig {
 	slug: string;
 	attributeTypeName: string;
@@ -9,6 +14,14 @@ export interface WorkspaceBlockConfig {
 	>;
 }
 
+export const BLOCK_NESTING = defineBlockNesting( {
+	// Add parent, ancestor, and allowedBlocks relationships here.
+} );
+
+export const BLOCK_TEMPLATES = defineInnerBlocksTemplates( {
+	// Add default InnerBlocks templates here.
+} );
+
 export interface WorkspaceVariationConfig {
 	block: string;
 	file: string;
@@ -30,14 +43,22 @@ export interface WorkspaceBlockTransformConfig {
 }
 
 export interface WorkspacePatternConfig {
-	file: string;
+	contentFile?: string;
+	file?: string;
+	scope?: 'full' | 'section';
+	sectionRole?: string;
 	slug: string;
+	tags?: string[];
+	thumbnailUrl?: string;
+	title?: string;
 }
 
 export interface WorkspaceBindingSourceConfig {
 	attribute?: string;
 	block?: string;
 	editorFile: string;
+	metaPath?: string;
+	postMeta?: string;
 	serverFile: string;
 	slug: string;
 }

package/scripts/sync-types-to-block-json.ts.mustache

@@ -1,9 +1,22 @@
 /* eslint-disable no-console */
+import fs from 'node:fs';
 import path from 'node:path';
 
-import { syncBlockMetadata } from '@wp-typia/block-runtime/metadata-core';
+import {
+	formatBlockPatternContentNestingDiagnostics,
+	validateBlockPatternContentNesting,
+	syncInnerBlocksTemplateModule,
+	syncBlockMetadata,
+	validateBlockNestingContract,
+	validateInnerBlocksTemplates,
+} from '@wp-typia/block-runtime/metadata-core';
+import {
+	formatPatternCatalogDiagnostics,
+	resolvePatternCatalogContentFile,
+	validatePatternCatalog,
+} from '@wp-typia/project-tools/pattern-catalog';
 
-import { BLOCKS } from './block-config';
+import { BLOCK_NESTING, BLOCK_TEMPLATES, BLOCKS, PATTERNS } from './block-config';
 
 function parseCliOptions( argv: string[] ) {
 	const options = {
@@ -22,9 +35,129 @@ function parseCliOptions( argv: string[] ) {
 	return options;
 }
 
+function readWorkspaceBlockName( block: ( typeof BLOCKS )[ number ] ): string {
+	const blockJsonFile = path.join( 'src', 'blocks', block.slug, 'block.json' );
+	let blockJson: { name?: unknown };
+	try {
+		blockJson = JSON.parse( fs.readFileSync( blockJsonFile, 'utf8' ) ) as {
+			name?: unknown;
+		};
+	} catch ( error ) {
+		throw new Error(
+			`Failed to read block.json for block "${ block.slug }" at ${ blockJsonFile }: ${
+				error instanceof Error ? error.message : String( error )
+			}`
+		);
+	}
+	if ( typeof blockJson.name !== 'string' || blockJson.name.trim() === '' ) {
+		throw new Error( `${ blockJsonFile } must define a string "name".` );
+	}
+
+	return blockJson.name;
+}
+
+function readPatternFileContent( pattern: ( typeof PATTERNS )[ number ] ): string {
+	const patternFile = resolvePatternCatalogContentFile( pattern );
+	if ( ! patternFile ) {
+		throw new Error(
+			`Pattern "${ pattern.slug }" must declare contentFile or file in scripts/block-config.ts.`
+		);
+	}
+	try {
+		return fs.readFileSync( patternFile, 'utf8' );
+	} catch ( error ) {
+		throw new Error(
+			`Failed to read pattern "${ pattern.slug }" at ${ patternFile }: ${
+				error instanceof Error ? error.message : String( error )
+			}`
+		);
+	}
+}
+
+function validatePatternCatalogMetadata() {
+	const result = validatePatternCatalog( PATTERNS, {
+		projectDir: process.cwd(),
+	} );
+
+	if ( result.warnings.length > 0 ) {
+		console.warn(
+			`⚠️ Pattern catalog validation warnings:\n${ formatPatternCatalogDiagnostics(
+				result.warnings
+			) }`
+		);
+	}
+
+	if ( result.errors.length > 0 ) {
+		throw new Error(
+			`Pattern catalog metadata is invalid:\n${ formatPatternCatalogDiagnostics(
+				result.errors
+			) }`
+		);
+	}
+}
+
+function validatePatternContentNesting( knownBlockNames: readonly string[] ) {
+	const diagnostics = PATTERNS.flatMap( ( pattern ) => {
+		const content = readPatternFileContent( pattern );
+		return validateBlockPatternContentNesting( content, {
+			allowExternalBlockNames: true,
+			knownBlockNames,
+			nesting: BLOCK_NESTING,
+			patternFile: resolvePatternCatalogContentFile( pattern ),
+		} ).diagnostics;
+	} );
+	const warnings = diagnostics.filter(
+		( diagnostic ) => diagnostic.severity === 'warning'
+	);
+	const errors = diagnostics.filter(
+		( diagnostic ) => diagnostic.severity === 'error'
+	);
+
+	if ( warnings.length > 0 ) {
+		console.warn(
+			`⚠️ Pattern nesting validation warnings:\n${ formatBlockPatternContentNestingDiagnostics(
+				warnings
+			) }`
+		);
+	}
+
+	if ( errors.length > 0 ) {
+		throw new Error(
+			`Pattern content violates block nesting contract:\n${ formatBlockPatternContentNestingDiagnostics(
+				errors
+			) }`
+		);
+	}
+}
+
 async function main() {
 	const options = parseCliOptions( process.argv.slice( 2 ) );
 
+	const knownBlockNames = BLOCKS.map( readWorkspaceBlockName );
+	validateBlockNestingContract( BLOCK_NESTING, {
+		allowExternalBlockNames: true,
+		knownBlockNames,
+	} );
+	validateInnerBlocksTemplates( BLOCK_TEMPLATES, {
+		allowExternalBlockNames: true,
+		knownBlockNames,
+		nesting: BLOCK_NESTING,
+	} );
+	validatePatternCatalogMetadata();
+	validatePatternContentNesting( knownBlockNames );
+	await syncInnerBlocksTemplateModule(
+		{
+			allowExternalBlockNames: true,
+			knownBlockNames,
+			nesting: BLOCK_NESTING,
+			outputFile: path.join( 'src', 'inner-blocks-templates.ts' ),
+			templates: BLOCK_TEMPLATES,
+		},
+		{
+			check: options.check,
+		}
+	);
+
 	if ( BLOCKS.length === 0 ) {
 		console.log(
 			options.check
@@ -38,9 +171,12 @@ async function main() {
 		const baseDir = path.join( 'src', 'blocks', block.slug );
 		const result = await syncBlockMetadata(
 			{
+				allowExternalBlockNames: true,
 				blockJsonFile: path.join( baseDir, 'block.json' ),
 				jsonSchemaFile: path.join( baseDir, 'typia.schema.json' ),
+				knownBlockNames,
 				manifestFile: path.join( baseDir, 'typia.manifest.json' ),
+				nesting: BLOCK_NESTING,
 				openApiFile: path.join( baseDir, 'typia.openapi.json' ),
 				sourceTypeName: block.attributeTypeName,
 				typesFile: block.typesFile,

package/src/inner-blocks-templates.ts.mustache

@@ -0,0 +1,13 @@
+/* This file is generated by wp-typia. Do not edit manually. */
+
+export type WpTypiaInnerBlocksTemplateAttributes = Record<string, unknown>;
+export type WpTypiaInnerBlocksTemplateItem = [
+	blockName: string,
+	attributes?: WpTypiaInnerBlocksTemplateAttributes,
+	innerBlocks?: WpTypiaInnerBlocksTemplate,
+];
+export type WpTypiaInnerBlocksTemplate = WpTypiaInnerBlocksTemplateItem[];
+
+export const INNER_BLOCKS_TEMPLATES = {} satisfies Record<string, WpTypiaInnerBlocksTemplate>;
+
+export type WpTypiaInnerBlocksTemplateName = keyof typeof INNER_BLOCKS_TEMPLATES;

package/{{slugKebabCase}}.php.mustache

@@ -177,7 +177,11 @@ function {{phpPrefix}}_register_pattern_category() {
 }
 
 function {{phpPrefix}}_register_patterns() {
-	foreach ( glob( __DIR__ . '/src/patterns/*.php' ) ?: array() as $pattern_module ) {
+	$pattern_modules = array_merge(
+		glob( __DIR__ . '/src/patterns/*.php' ) ?: array(),
+		glob( __DIR__ . '/src/patterns/*/*.php' ) ?: array()
+	);
+	foreach ( $pattern_modules as $pattern_module ) {
 		require $pattern_module;
 	}
 }