@wp-typia/create-workspace-template 0.16.0 → 0.17.0

package/README.md

@@ -12,10 +12,13 @@ The generated project starts with an empty `src/blocks/*` workspace shell and is
 
 ```bash
 wp-typia add block my-block --template basic
+wp-typia add integration-env local-smoke --wp-env --service docker-compose
 wp-typia add style callout-emphasis --block my-block
 wp-typia add transform quote-to-block --from core/quote --to my-block
 wp-typia add binding-source hero-data
 wp-typia add binding-source hero-data --block my-block --attribute headline
+wp-typia add contract external-retrieve-response --type ExternalRetrieveResponse
+wp-typia add post-meta integration-state --post-type post --type IntegrationStateMeta
 wp-typia add editor-plugin review-workflow --slot sidebar
 wp-typia add editor-plugin seo-notes --slot document-setting-panel
 wp-typia add hooked-block my-block --anchor core/post-content --position after

package/README.md.mustache

@@ -20,8 +20,8 @@ wp-typia add block counter-card --template persistence --data-storage custom-tab
 wp-typia add block faq-stack --template compound --data-storage custom-table --persistence-policy public
 ```
 
-Variations, block styles, transforms, patterns, and REST resources can also be
-added after the first block exists:
+Variations, block styles, transforms, patterns, REST resources, and post meta
+contracts can also be added after the first block exists:
 
 ```bash
 wp-typia add variation hero-card --block counter-card
@@ -29,6 +29,7 @@ wp-typia add style callout-emphasis --block counter-card
 wp-typia add transform quote-to-counter --from core/quote --to counter-card
 wp-typia add pattern hero-layout
 wp-typia add rest-resource snapshots --namespace {{namespace}}/v1 --methods list,read,create
+wp-typia add post-meta integration-state --post-type post
 ```
 
 ## Development

package/package.json

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

package/scripts/block-config.ts.mustache

@@ -42,22 +42,65 @@ export interface WorkspaceBindingSourceConfig {
 	slug: string;
 }
 
-export interface WorkspaceRestResourceConfig {
+export interface WorkspaceContractConfig {
+	schemaFile: string;
+	slug: string;
+	sourceTypeName: string;
+	typesFile: string;
+}
+
+export interface WorkspaceRestResourceBaseConfig {
 	apiFile: string;
+	auth?: 'authenticated' | 'public' | 'public-write-protected';
+	bodyTypeName?: string;
 	clientFile: string;
-	dataFile: string;
-	methods: Array< 'list' | 'read' | 'create' | 'update' | 'delete' >;
+	controllerClass?: string;
+	controllerExtends?: string;
 	namespace: string;
 	openApiFile: string;
-	phpFile: string;
+	permissionCallback?: string;
 	restManifest?: ReturnType<
 		typeof import( '@wp-typia/block-runtime/metadata-core' ).defineEndpointManifest
 	>;
+	secretFieldName?: string;
+	secretStateFieldName?: string;
 	slug: string;
 	typesFile: string;
 	validatorsFile: string;
 }
 
+export interface GeneratedWorkspaceRestResourceConfig extends WorkspaceRestResourceBaseConfig {
+	dataFile: string;
+	methods: Array< 'list' | 'read' | 'create' | 'update' | 'delete' >;
+	mode?: 'generated';
+	phpFile: string;
+	routePattern?: string;
+}
+
+export interface ManualWorkspaceRestResourceConfig extends WorkspaceRestResourceBaseConfig {
+	method: 'DELETE' | 'GET' | 'PATCH' | 'POST' | 'PUT';
+	methods: [];
+	mode: 'manual';
+	pathPattern: string;
+	queryTypeName: string;
+	responseTypeName: string;
+}
+
+export type WorkspaceRestResourceConfig =
+	| GeneratedWorkspaceRestResourceConfig
+	| ManualWorkspaceRestResourceConfig;
+
+export interface WorkspacePostMetaConfig {
+	metaKey: string;
+	phpFile: string;
+	postType: string;
+	schemaFile: string;
+	showInRest: boolean;
+	slug: string;
+	sourceTypeName: string;
+	typesFile: string;
+}
+
 export interface WorkspaceEditorPluginConfig {
 	file: string;
 	slug: string;
@@ -95,10 +138,18 @@ export const BINDING_SOURCES: WorkspaceBindingSourceConfig[] = [
 	// wp-typia add binding-source entries
 ];
 
+export const CONTRACTS: WorkspaceContractConfig[] = [
+	// wp-typia add contract entries
+];
+
 export const REST_RESOURCES: WorkspaceRestResourceConfig[] = [
 	// wp-typia add rest-resource entries
 ];
 
+export const POST_META: WorkspacePostMetaConfig[] = [
+	// wp-typia add post-meta entries
+];
+
 export const EDITOR_PLUGINS: WorkspaceEditorPluginConfig[] = [
 	// wp-typia add editor-plugin entries
 ];

package/scripts/sync-rest-contracts.ts.mustache

@@ -10,8 +10,12 @@ import {
 
 import {
 	BLOCKS,
+	CONTRACTS,
+	POST_META,
 	REST_RESOURCES,
 	type WorkspaceBlockConfig,
+	type WorkspaceContractConfig,
+	type WorkspacePostMetaConfig,
 	type WorkspaceRestResourceConfig,
 } from './block-config';
 
@@ -66,6 +70,34 @@ function isWorkspaceRestResource(
 	);
 }
 
+function isWorkspaceStandaloneContract(
+	contract: WorkspaceContractConfig
+): contract is WorkspaceContractConfig & {
+	schemaFile: string;
+	sourceTypeName: string;
+	typesFile: string;
+} {
+	return (
+		typeof contract.schemaFile === 'string' &&
+		typeof contract.sourceTypeName === 'string' &&
+		typeof contract.typesFile === 'string'
+	);
+}
+
+function isWorkspacePostMetaContract(
+	postMeta: WorkspacePostMetaConfig
+): postMeta is WorkspacePostMetaConfig & {
+	schemaFile: string;
+	sourceTypeName: string;
+	typesFile: string;
+} {
+	return (
+		typeof postMeta.schemaFile === 'string' &&
+		typeof postMeta.sourceTypeName === 'string' &&
+		typeof postMeta.typesFile === 'string'
+	);
+}
+
 async function assertTypeArtifactsCurrent( block: WorkspaceBlockConfig ) {
 	const report = await runSyncBlockMetadata(
 		{
@@ -97,13 +129,20 @@ async function assertTypeArtifactsCurrent( block: WorkspaceBlockConfig ) {
 async function main() {
 	const options = parseCliOptions( process.argv.slice( 2 ) );
 	const restBlocks = BLOCKS.filter( isRestEnabledBlock );
+	const standaloneContracts = CONTRACTS.filter( isWorkspaceStandaloneContract );
+	const postMetaContracts = POST_META.filter( isWorkspacePostMetaContract );
 	const restResources = REST_RESOURCES.filter( isWorkspaceRestResource );
 
-	if ( restBlocks.length === 0 && restResources.length === 0 ) {
+	if (
+		restBlocks.length === 0 &&
+		standaloneContracts.length === 0 &&
+		postMetaContracts.length === 0 &&
+		restResources.length === 0
+	) {
 		console.log(
 			options.check
-				? 'ℹ️ No REST-enabled workspace blocks or plugin-level REST resources are registered yet. `sync-rest --check` is already clean.'
-				: 'ℹ️ No REST-enabled workspace blocks or plugin-level REST resources are registered yet.'
+				? 'ℹ️ No REST-enabled workspace blocks, standalone contracts, post meta contracts, or plugin-level REST resources are registered yet. `sync-rest --check` is already clean.'
+				: 'ℹ️ No REST-enabled workspace blocks, standalone contracts, post meta contracts, or plugin-level REST resources are registered yet.'
 		);
 		return;
 	}
@@ -167,6 +206,32 @@ async function main() {
 		);
 	}
 
+	for ( const contract of standaloneContracts ) {
+		await syncTypeSchemas(
+			{
+				jsonSchemaFile: contract.schemaFile,
+				sourceTypeName: contract.sourceTypeName,
+				typesFile: contract.typesFile,
+			},
+			{
+				check: options.check,
+			}
+		);
+	}
+
+	for ( const postMeta of postMetaContracts ) {
+		await syncTypeSchemas(
+			{
+				jsonSchemaFile: postMeta.schemaFile,
+				sourceTypeName: postMeta.sourceTypeName,
+				typesFile: postMeta.typesFile,
+			},
+			{
+				check: options.check,
+			}
+		);
+	}
+
 	for ( const resource of restResources ) {
 		const contracts = resource.restManifest.contracts;
 
@@ -218,8 +283,8 @@ async function main() {
 
 	console.log(
 		options.check
-			? '✅ REST contract schemas, portable API clients, and endpoint-aware OpenAPI documents are already up to date for workspace blocks and plugin-level resources!'
-			: '✅ REST contract schemas, portable API clients, and endpoint-aware OpenAPI documents generated for workspace blocks and plugin-level resources!'
+			? '✅ REST contract schemas, standalone schemas, post meta schemas, portable API clients, and endpoint-aware OpenAPI documents are already up to date for workspace blocks, standalone contracts, post meta contracts, and plugin-level resources!'
+			: '✅ REST contract schemas, standalone schemas, post meta schemas, portable API clients, and endpoint-aware OpenAPI documents generated for workspace blocks, standalone contracts, post meta contracts, and plugin-level resources!'
 	);
 }