@wp-typia/project-tools 0.23.1 → 0.24.0

package/dist/runtime/cli-add-workspace-editor-plugin-anchors.js

@@ -0,0 +1,206 @@
+import { promises as fsp } from "node:fs";
+import path from "node:path";
+import { getWorkspaceBootstrapPath, patchFile, } from "./cli-add-shared.js";
+import { appendPhpSnippetBeforeClosingTag, insertPhpSnippetBeforeWorkspaceAnchors, } from "./cli-add-workspace-mutation.js";
+import { pathExists, readOptionalUtf8File } from "./fs-async.js";
+import { findPhpFunctionRange, hasPhpFunctionDefinition, replacePhpFunctionDefinition, } from "./php-utils.js";
+import { readWorkspaceInventoryAsync } from "./workspace-inventory.js";
+const EDITOR_PLUGIN_EDITOR_SCRIPT = "build/editor-plugins/index.js";
+const EDITOR_PLUGIN_EDITOR_ASSET = "build/editor-plugins/index.asset.php";
+const EDITOR_PLUGIN_EDITOR_STYLE = "build/editor-plugins/style-index.css";
+const EDITOR_PLUGIN_EDITOR_STYLE_RTL = "build/editor-plugins/style-index-rtl.css";
+function buildEditorPluginRegistrySource(editorPluginSlugs) {
+    const importLines = editorPluginSlugs
+        .map((editorPluginSlug) => `import './${editorPluginSlug}';`)
+        .join("\n");
+    return `${importLines}${importLines ? "\n\n" : ""}// wp-typia add editor-plugin entries\n`;
+}
+/**
+ * Ensures the workspace bootstrap enqueues the shared editor plugin bundle.
+ *
+ * @param workspace Official workspace metadata used to locate and patch the bootstrap file.
+ * @returns A promise that resolves after the bootstrap anchors are present.
+ */
+export async function ensureEditorPluginBootstrapAnchors(workspace) {
+    const bootstrapPath = getWorkspaceBootstrapPath(workspace);
+    await patchFile(bootstrapPath, (source) => {
+        let nextSource = source;
+        const workspaceBaseName = workspace.packageName.split("/").pop() ?? workspace.packageName;
+        const enqueueFunctionName = `${workspace.workspace.phpPrefix}_enqueue_editor_plugins_editor`;
+        const enqueueHook = `add_action( 'enqueue_block_editor_assets', '${enqueueFunctionName}' );`;
+        const enqueueFunction = `
+
+function ${enqueueFunctionName}() {
+\t$script_path = __DIR__ . '/${EDITOR_PLUGIN_EDITOR_SCRIPT}';
+\t$asset_path  = __DIR__ . '/${EDITOR_PLUGIN_EDITOR_ASSET}';
+\t$style_path  = __DIR__ . '/${EDITOR_PLUGIN_EDITOR_STYLE}';
+\t$style_rtl_path = __DIR__ . '/${EDITOR_PLUGIN_EDITOR_STYLE_RTL}';
+
+\tif ( ! file_exists( $script_path ) || ! file_exists( $asset_path ) ) {
+\t\treturn;
+\t}
+
+\t$asset = require $asset_path;
+\tif ( ! is_array( $asset ) ) {
+\t\t$asset = array();
+\t}
+
+\twp_enqueue_script(
+\t\t'${workspaceBaseName}-editor-plugins',
+\t\tplugins_url( '${EDITOR_PLUGIN_EDITOR_SCRIPT}', __FILE__ ),
+\t\tisset( $asset['dependencies'] ) && is_array( $asset['dependencies'] ) ? $asset['dependencies'] : array(),
+\t\tisset( $asset['version'] ) ? $asset['version'] : filemtime( $script_path ),
+\t\ttrue
+\t);
+
+\tif ( file_exists( $style_path ) ) {
+\t\twp_enqueue_style(
+\t\t\t'${workspaceBaseName}-editor-plugins',
+\t\t\tplugins_url( '${EDITOR_PLUGIN_EDITOR_STYLE}', __FILE__ ),
+\t\t\tarray(),
+\t\t\tisset( $asset['version'] ) ? $asset['version'] : filemtime( $style_path )
+\t\t);
+\t\tif ( file_exists( $style_rtl_path ) ) {
+\t\t\twp_style_add_data( '${workspaceBaseName}-editor-plugins', 'rtl', 'replace' );
+\t\t}
+\t}
+}
+`;
+        if (!hasPhpFunctionDefinition(nextSource, enqueueFunctionName)) {
+            nextSource = insertPhpSnippetBeforeWorkspaceAnchors(nextSource, enqueueFunction);
+        }
+        else {
+            const requiredReferences = [
+                EDITOR_PLUGIN_EDITOR_SCRIPT,
+                EDITOR_PLUGIN_EDITOR_ASSET,
+                EDITOR_PLUGIN_EDITOR_STYLE,
+                EDITOR_PLUGIN_EDITOR_STYLE_RTL,
+                "wp_style_add_data",
+            ];
+            const functionRange = findPhpFunctionRange(nextSource, enqueueFunctionName);
+            const functionSource = functionRange
+                ? nextSource.slice(functionRange.start, functionRange.end)
+                : "";
+            const missingReferences = requiredReferences.filter((reference) => !functionSource.includes(reference));
+            if (missingReferences.length > 0) {
+                const replacedSource = replacePhpFunctionDefinition(nextSource, enqueueFunctionName, enqueueFunction);
+                if (!replacedSource) {
+                    throw new Error(`Unable to repair ${path.basename(bootstrapPath)} for ${enqueueFunctionName}.`);
+                }
+                nextSource = replacedSource;
+            }
+        }
+        if (!nextSource.includes(enqueueHook)) {
+            nextSource = appendPhpSnippetBeforeClosingTag(nextSource, enqueueHook);
+        }
+        return nextSource;
+    });
+}
+/**
+ * Ensures the workspace build script includes the shared editor plugin entry.
+ *
+ * @param workspace Official workspace metadata used to locate the build script.
+ * @returns A promise that resolves after the build script anchors are present.
+ */
+export async function ensureEditorPluginBuildScriptAnchors(workspace) {
+    const buildScriptPath = path.join(workspace.projectDir, "scripts", "build-workspace.mjs");
+    await patchFile(buildScriptPath, (source) => {
+        if (/['"]src\/editor-plugins\/index\.(?:ts|js)['"]/u.test(source)) {
+            return source;
+        }
+        const legacySharedEntriesPattern = /\[\s*['"]src\/bindings\/index\.ts['"]\s*,\s*['"]src\/bindings\/index\.js['"]\s*(?:,\s*)?\]/u;
+        const nextSource = source.replace(legacySharedEntriesPattern, `[
+\t\t'src/bindings/index.ts',
+\t\t'src/bindings/index.js',
+\t\t'src/editor-plugins/index.ts',
+\t\t'src/editor-plugins/index.js',
+\t]`);
+        if (nextSource === source) {
+            throw new Error(`Unable to update ${path.relative(workspace.projectDir, buildScriptPath)} for editor plugin shared entries.`);
+        }
+        return nextSource;
+    });
+}
+/**
+ * Ensures the workspace webpack config builds the shared editor plugin entry.
+ *
+ * @param workspace Official workspace metadata used to locate the webpack config.
+ * @returns A promise that resolves after the webpack anchors are present.
+ */
+export async function ensureEditorPluginWebpackAnchors(workspace) {
+    const webpackConfigPath = path.join(workspace.projectDir, "webpack.config.js");
+    await patchFile(webpackConfigPath, (source) => {
+        if (/['"]editor-plugins\/index['"]/u.test(source)) {
+            return source;
+        }
+        const legacySharedEntriesBlockPattern = /for\s*\(\s*const\s+relativePath\s+of\s+\[\s*['"]src\/bindings\/index\.ts['"]\s*,\s*['"]src\/bindings\/index\.js['"]\s*(?:,\s*)?\]\s*\)\s*\{[\s\S]*?entries\.push\(\s*\[\s*['"]bindings\/index['"]\s*,\s*entryPath\s*\]\s*\);\s*break;\s*\}/u;
+        const nextSharedEntriesBlock = [
+            "\tfor ( const [ entryName, candidates ] of [",
+            "\t\t[",
+            "\t\t\t'bindings/index',",
+            "\t\t\t[ 'src/bindings/index.ts', 'src/bindings/index.js' ],",
+            "\t\t],",
+            "\t\t[",
+            "\t\t\t'editor-plugins/index',",
+            "\t\t\t[ 'src/editor-plugins/index.ts', 'src/editor-plugins/index.js' ],",
+            "\t\t],",
+            "\t] ) {",
+            "\t\tfor ( const relativePath of candidates ) {",
+            "\t\t\tconst entryPath = path.resolve( process.cwd(), relativePath );",
+            "\t\t\tif ( ! fs.existsSync( entryPath ) ) {",
+            "\t\t\t\tcontinue;",
+            "\t\t\t}",
+            "",
+            "\t\t\tentries.push( [ entryName, entryPath ] );",
+            "\t\t\tbreak;",
+            "\t\t}",
+            "\t}",
+        ].join("\n");
+        const nextSource = source.replace(legacySharedEntriesBlockPattern, nextSharedEntriesBlock);
+        if (nextSource === source) {
+            throw new Error(`Unable to update ${path.relative(workspace.projectDir, webpackConfigPath)} for editor plugin shared entries.`);
+        }
+        return nextSource;
+    });
+}
+/**
+ * Resolves the editor plugin registry path, preferring existing TypeScript or JavaScript registries.
+ *
+ * @param projectDir Workspace root directory to inspect.
+ * @returns A promise for the registry path to read or write.
+ */
+export async function resolveEditorPluginRegistryPath(projectDir) {
+    const editorPluginsDir = path.join(projectDir, "src", "editor-plugins");
+    for (const candidatePath of [
+        path.join(editorPluginsDir, "index.ts"),
+        path.join(editorPluginsDir, "index.js"),
+    ]) {
+        if (await pathExists(candidatePath)) {
+            return candidatePath;
+        }
+    }
+    return path.join(editorPluginsDir, "index.ts");
+}
+async function readEditorPluginRegistrySlugs(registryPath) {
+    const source = await readOptionalUtf8File(registryPath);
+    if (source === null) {
+        return [];
+    }
+    return Array.from(source.matchAll(/^\s*import\s+['"]\.\/([^/'"]+)(?:\/index(?:\.[cm]?[jt]sx?)?)?['"];?\s*$/gmu)).map((match) => match[1]);
+}
+/**
+ * Rewrites the shared editor plugin registry with the requested plugin slug included.
+ *
+ * @param projectDir Workspace root directory that owns `src/editor-plugins`.
+ * @param editorPluginSlug Editor plugin slug that must be imported by the registry.
+ * @returns A promise that resolves after the registry has been written.
+ */
+export async function writeEditorPluginRegistry(projectDir, editorPluginSlug) {
+    const editorPluginsDir = path.join(projectDir, "src", "editor-plugins");
+    const registryPath = await resolveEditorPluginRegistryPath(projectDir);
+    await fsp.mkdir(editorPluginsDir, { recursive: true });
+    const existingEditorPluginSlugs = (await readWorkspaceInventoryAsync(projectDir)).editorPlugins.map((entry) => entry.slug);
+    const existingRegistrySlugs = await readEditorPluginRegistrySlugs(registryPath);
+    const nextEditorPluginSlugs = Array.from(new Set([...existingEditorPluginSlugs, ...existingRegistrySlugs, editorPluginSlug])).sort();
+    await fsp.writeFile(registryPath, buildEditorPluginRegistrySource(nextEditorPluginSlugs), "utf8");
+}

package/dist/runtime/cli-add-workspace-editor-plugin-source-emitters.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Render one `scripts/block-config.ts` editor-plugin inventory entry.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @param slot Canonical editor-plugin slot id.
+ * @returns TypeScript source for the inventory entry.
+ */
+export declare function buildEditorPluginConfigEntry(editorPluginSlug: string, slot: string): string;
+/**
+ * Render the generated editor-plugin model type module.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @returns TypeScript source for the plugin model type.
+ */
+export declare function buildEditorPluginTypesSource(editorPluginSlug: string): string;
+/**
+ * Render the generated editor-plugin data module.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @param slot Canonical editor-plugin slot id.
+ * @returns TypeScript source for default plugin data helpers.
+ */
+export declare function buildEditorPluginDataSource(editorPluginSlug: string, slot: string): string;
+/**
+ * Render the React surface for a generated editor plugin.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @param slot Canonical editor-plugin slot id.
+ * @param textDomain Workspace text domain used for translatable UI strings.
+ * @returns TSX source for the generated plugin surface.
+ */
+export declare function buildEditorPluginSurfaceSource(editorPluginSlug: string, slot: string, textDomain: string): string;
+/**
+ * Render the generated editor-plugin entry module.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @param namespace Workspace block namespace.
+ * @param textDomain Workspace text domain used for translatable UI strings.
+ * @returns TSX source for registering the editor plugin.
+ */
+export declare function buildEditorPluginEntrySource(editorPluginSlug: string, namespace: string, textDomain: string): string;
+/**
+ * Render the generated editor-plugin stylesheet.
+ *
+ * @returns SCSS source for the generated editor plugin shell.
+ */
+export declare function buildEditorPluginStyleSource(): string;

package/dist/runtime/cli-add-workspace-editor-plugin-source-emitters.js

@@ -0,0 +1,219 @@
+import { quoteTsString } from "./cli-add-shared.js";
+import { toPascalCase, toTitleCase } from "./string-case.js";
+/**
+ * Render one `scripts/block-config.ts` editor-plugin inventory entry.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @param slot Canonical editor-plugin slot id.
+ * @returns TypeScript source for the inventory entry.
+ */
+export function buildEditorPluginConfigEntry(editorPluginSlug, slot) {
+    return [
+        "\t{",
+        `\t\tfile: ${quoteTsString(`src/editor-plugins/${editorPluginSlug}/index.tsx`)},`,
+        `\t\tslug: ${quoteTsString(editorPluginSlug)},`,
+        `\t\tslot: ${quoteTsString(slot)},`,
+        "\t},",
+    ].join("\n");
+}
+/**
+ * Render the generated editor-plugin model type module.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @returns TypeScript source for the plugin model type.
+ */
+export function buildEditorPluginTypesSource(editorPluginSlug) {
+    const typeName = `${toPascalCase(editorPluginSlug)}EditorPluginModel`;
+    return `export interface ${typeName} {
+\tprimaryActionLabel: string;
+\tsummary: string;
+}
+`;
+}
+/**
+ * Render the generated editor-plugin data module.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @param slot Canonical editor-plugin slot id.
+ * @returns TypeScript source for default plugin data helpers.
+ */
+export function buildEditorPluginDataSource(editorPluginSlug, slot) {
+    const typeName = `${toPascalCase(editorPluginSlug)}EditorPluginModel`;
+    const pluginTitle = toTitleCase(editorPluginSlug);
+    const modelFactoryName = `get${toPascalCase(editorPluginSlug)}EditorPluginModel`;
+    const enabledFactoryName = `is${toPascalCase(editorPluginSlug)}Enabled`;
+    return `import type { ${typeName} } from './types';
+
+export const EDITOR_PLUGIN_SLOT = ${quoteTsString(slot)} as const;
+export const REQUIRED_CAPABILITY = 'edit_posts' as const;
+
+const DEFAULT_EDITOR_PLUGIN_MODEL: ${typeName} = {
+\tprimaryActionLabel: ${quoteTsString(`Review ${pluginTitle}`)},
+\tsummary: ${quoteTsString(`Replace this summary with your ${pluginTitle} workflow state.`)},
+};
+
+export function ${modelFactoryName}(): ${typeName} {
+\treturn DEFAULT_EDITOR_PLUGIN_MODEL;
+}
+
+export function ${enabledFactoryName}(): boolean {
+\treturn true;
+}
+`;
+}
+/**
+ * Render the React surface for a generated editor plugin.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @param slot Canonical editor-plugin slot id.
+ * @param textDomain Workspace text domain used for translatable UI strings.
+ * @returns TSX source for the generated plugin surface.
+ */
+export function buildEditorPluginSurfaceSource(editorPluginSlug, slot, textDomain) {
+    const pascalName = toPascalCase(editorPluginSlug);
+    const modelFactoryName = `get${pascalName}EditorPluginModel`;
+    const enabledFactoryName = `is${pascalName}Enabled`;
+    const componentName = `${pascalName}Surface`;
+    if (slot === "document-setting-panel") {
+        return `import { Button } from '@wordpress/components';
+import { PluginDocumentSettingPanel } from '@wordpress/editor';
+import { __ } from '@wordpress/i18n';
+
+import { ${modelFactoryName}, ${enabledFactoryName} } from './data';
+import './style.scss';
+
+export interface ${componentName}Props {
+\tsurfaceName: string;
+\ttitle: string;
+}
+
+export function ${componentName}( {
+\tsurfaceName,
+\ttitle,
+}: ${componentName}Props ) {
+\tif ( ! ${enabledFactoryName}() ) {
+\t\treturn null;
+\t}
+
+\tconst editorPluginModel = ${modelFactoryName}();
+
+\treturn (
+\t\t<PluginDocumentSettingPanel
+\t\t\tclassName="wp-typia-editor-plugin-shell"
+\t\t\tname={ surfaceName }
+\t\t\ttitle={ title }
+\t\t>
+\t\t\t<p>{ editorPluginModel.summary }</p>
+\t\t\t<Button variant="secondary">
+\t\t\t\t{ editorPluginModel.primaryActionLabel }
+\t\t\t</Button>
+\t\t\t<p className="wp-typia-editor-plugin-shell__hint">
+\t\t\t\t{ __( 'Use data.ts to add post type, capability, or editor context guards before showing this panel.', ${quoteTsString(textDomain)} ) }
+\t\t\t</p>
+\t\t</PluginDocumentSettingPanel>
+\t);
+}
+`;
+    }
+    return `import { Button, PanelBody } from '@wordpress/components';
+import { PluginSidebar, PluginSidebarMoreMenuItem } from '@wordpress/editor';
+import { __ } from '@wordpress/i18n';
+
+import { ${modelFactoryName}, ${enabledFactoryName} } from './data';
+import './style.scss';
+
+export interface ${componentName}Props {
+\tsurfaceName: string;
+\ttitle: string;
+}
+
+export function ${componentName}( {
+\tsurfaceName,
+\ttitle,
+}: ${componentName}Props ) {
+\tif ( ! ${enabledFactoryName}() ) {
+\t\treturn null;
+\t}
+
+\tconst editorPluginModel = ${modelFactoryName}();
+
+\treturn (
+\t\t<>
+\t\t\t<PluginSidebarMoreMenuItem target={ surfaceName }>
+\t\t\t\t{ title }
+\t\t\t</PluginSidebarMoreMenuItem>
+\t\t\t<PluginSidebar name={ surfaceName } title={ title }>
+\t\t\t\t<div className="wp-typia-editor-plugin-shell">
+\t\t\t\t\t<PanelBody
+\t\t\t\t\t\tinitialOpen
+\t\t\t\t\t\ttitle={ __( 'Document workflow', ${quoteTsString(textDomain)} ) }
+\t\t\t\t\t>
+\t\t\t\t\t\t<p>{ editorPluginModel.summary }</p>
+\t\t\t\t\t\t<Button variant="secondary">
+\t\t\t\t\t\t\t{ editorPluginModel.primaryActionLabel }
+\t\t\t\t\t\t</Button>
+\t\t\t\t\t</PanelBody>
+\t\t\t\t</div>
+\t\t\t</PluginSidebar>
+\t\t</>
+\t);
+}
+`;
+}
+/**
+ * Render the generated editor-plugin entry module.
+ *
+ * @param editorPluginSlug Normalized editor-plugin slug.
+ * @param namespace Workspace block namespace.
+ * @param textDomain Workspace text domain used for translatable UI strings.
+ * @returns TSX source for registering the editor plugin.
+ */
+export function buildEditorPluginEntrySource(editorPluginSlug, namespace, textDomain) {
+    const pascalName = toPascalCase(editorPluginSlug);
+    const componentName = `${pascalName}Surface`;
+    const pluginName = `${namespace}-${editorPluginSlug}`;
+    const surfaceName = `${pluginName}-surface`;
+    const pluginTitle = toTitleCase(editorPluginSlug);
+    return `import { registerPlugin } from '@wordpress/plugins';
+import { __ } from '@wordpress/i18n';
+
+import { REQUIRED_CAPABILITY } from './data';
+import { ${componentName} } from './Surface';
+
+const EDITOR_PLUGIN_NAME = ${quoteTsString(pluginName)};
+const EDITOR_PLUGIN_SURFACE_NAME = ${quoteTsString(surfaceName)};
+const EDITOR_PLUGIN_TITLE = __( ${quoteTsString(pluginTitle)}, ${quoteTsString(textDomain)} );
+
+registerPlugin( EDITOR_PLUGIN_NAME, {
+\ticon: 'admin-generic',
+\trender: () => (
+\t\t<${componentName}
+\t\t\tsurfaceName={ EDITOR_PLUGIN_SURFACE_NAME }
+\t\t\ttitle={ EDITOR_PLUGIN_TITLE }
+\t\t/>
+\t),
+} );
+
+export { REQUIRED_CAPABILITY };
+`;
+}
+/**
+ * Render the generated editor-plugin stylesheet.
+ *
+ * @returns SCSS source for the generated editor plugin shell.
+ */
+export function buildEditorPluginStyleSource() {
+    return `.wp-typia-editor-plugin-shell {
+\tpadding: 16px;
+}
+
+.wp-typia-editor-plugin-shell p {
+\tmargin: 0 0 12px;
+}
+
+.wp-typia-editor-plugin-shell__hint {
+\tcolor: #757575;
+\tfont-size: 12px;
+}
+`;
+}

package/dist/runtime/cli-add-workspace-editor-plugin.d.ts

@@ -0,0 +1,22 @@
+import { type RunAddEditorPluginCommandOptions } from "./cli-add-shared.js";
+export { ensureEditorPluginBootstrapAnchors, ensureEditorPluginBuildScriptAnchors, ensureEditorPluginWebpackAnchors, resolveEditorPluginRegistryPath, writeEditorPluginRegistry, } from "./cli-add-workspace-editor-plugin-anchors.js";
+/**
+ * Add one document-level editor plugin scaffold to an official workspace project.
+ *
+ * @param options Command options for the editor-plugin scaffold workflow.
+ * @param options.cwd Working directory used to resolve the nearest official workspace.
+ * Defaults to `process.cwd()`.
+ * @param options.editorPluginName Human-entered editor-plugin name that will be
+ * normalized and validated before files are written.
+ * @param options.slot Optional editor plugin shell slot. Defaults to `sidebar`.
+ * @returns A promise that resolves with the normalized `editorPluginSlug`, chosen
+ * `slot`, and owning `projectDir` after the scaffold files and inventory entry
+ * are written successfully.
+ * @throws {Error} When the command is run outside an official workspace, when the
+ * slug or slot is invalid, or when a conflicting file or inventory entry exists.
+ */
+export declare function runAddEditorPluginCommand({ cwd, editorPluginName, slot, }: RunAddEditorPluginCommandOptions): Promise<{
+    editorPluginSlug: string;
+    projectDir: string;
+    slot: string;
+}>;

package/dist/runtime/cli-add-workspace-editor-plugin.js

@@ -0,0 +1,78 @@
+import { promises as fsp } from "node:fs";
+import path from "node:path";
+import { assertEditorPluginDoesNotExist, assertValidEditorPluginSlot, assertValidGeneratedSlug, getWorkspaceBootstrapPath, normalizeBlockSlug, rollbackWorkspaceMutation, snapshotWorkspaceFiles, } from "./cli-add-shared.js";
+import { ensureEditorPluginBootstrapAnchors, ensureEditorPluginBuildScriptAnchors, ensureEditorPluginWebpackAnchors, resolveEditorPluginRegistryPath, writeEditorPluginRegistry, } from "./cli-add-workspace-editor-plugin-anchors.js";
+import { buildEditorPluginConfigEntry, buildEditorPluginDataSource, buildEditorPluginEntrySource, buildEditorPluginStyleSource, buildEditorPluginSurfaceSource, buildEditorPluginTypesSource, } from "./cli-add-workspace-editor-plugin-source-emitters.js";
+import { appendWorkspaceInventoryEntries, readWorkspaceInventoryAsync, } from "./workspace-inventory.js";
+import { resolveWorkspaceProject } from "./workspace-project.js";
+export { ensureEditorPluginBootstrapAnchors, ensureEditorPluginBuildScriptAnchors, ensureEditorPluginWebpackAnchors, resolveEditorPluginRegistryPath, writeEditorPluginRegistry, } from "./cli-add-workspace-editor-plugin-anchors.js";
+/**
+ * Add one document-level editor plugin scaffold to an official workspace project.
+ *
+ * @param options Command options for the editor-plugin scaffold workflow.
+ * @param options.cwd Working directory used to resolve the nearest official workspace.
+ * Defaults to `process.cwd()`.
+ * @param options.editorPluginName Human-entered editor-plugin name that will be
+ * normalized and validated before files are written.
+ * @param options.slot Optional editor plugin shell slot. Defaults to `sidebar`.
+ * @returns A promise that resolves with the normalized `editorPluginSlug`, chosen
+ * `slot`, and owning `projectDir` after the scaffold files and inventory entry
+ * are written successfully.
+ * @throws {Error} When the command is run outside an official workspace, when the
+ * slug or slot is invalid, or when a conflicting file or inventory entry exists.
+ */
+export async function runAddEditorPluginCommand({ cwd = process.cwd(), editorPluginName, slot, }) {
+    const workspace = resolveWorkspaceProject(cwd);
+    const editorPluginSlug = assertValidGeneratedSlug("Editor plugin name", normalizeBlockSlug(editorPluginName), "wp-typia add editor-plugin <name> [--slot <sidebar|document-setting-panel>]");
+    const resolvedSlot = assertValidEditorPluginSlot(slot);
+    const inventory = await readWorkspaceInventoryAsync(workspace.projectDir);
+    assertEditorPluginDoesNotExist(workspace.projectDir, editorPluginSlug, inventory);
+    const blockConfigPath = path.join(workspace.projectDir, "scripts", "block-config.ts");
+    const bootstrapPath = getWorkspaceBootstrapPath(workspace);
+    const buildScriptPath = path.join(workspace.projectDir, "scripts", "build-workspace.mjs");
+    const editorPluginsIndexPath = await resolveEditorPluginRegistryPath(workspace.projectDir);
+    const webpackConfigPath = path.join(workspace.projectDir, "webpack.config.js");
+    const editorPluginDir = path.join(workspace.projectDir, "src", "editor-plugins", editorPluginSlug);
+    const entryFilePath = path.join(editorPluginDir, "index.tsx");
+    const surfaceFilePath = path.join(editorPluginDir, "Surface.tsx");
+    const dataFilePath = path.join(editorPluginDir, "data.ts");
+    const typesFilePath = path.join(editorPluginDir, "types.ts");
+    const styleFilePath = path.join(editorPluginDir, "style.scss");
+    const mutationSnapshot = {
+        fileSources: await snapshotWorkspaceFiles([
+            blockConfigPath,
+            bootstrapPath,
+            buildScriptPath,
+            editorPluginsIndexPath,
+            webpackConfigPath,
+        ]),
+        snapshotDirs: [],
+        targetPaths: [editorPluginDir],
+    };
+    try {
+        await fsp.mkdir(editorPluginDir, { recursive: true });
+        await ensureEditorPluginBootstrapAnchors(workspace);
+        await ensureEditorPluginBuildScriptAnchors(workspace);
+        await ensureEditorPluginWebpackAnchors(workspace);
+        await fsp.writeFile(entryFilePath, buildEditorPluginEntrySource(editorPluginSlug, workspace.workspace.namespace, workspace.workspace.textDomain), "utf8");
+        await fsp.writeFile(surfaceFilePath, buildEditorPluginSurfaceSource(editorPluginSlug, resolvedSlot, workspace.workspace.textDomain), "utf8");
+        await fsp.writeFile(dataFilePath, buildEditorPluginDataSource(editorPluginSlug, resolvedSlot), "utf8");
+        await fsp.writeFile(typesFilePath, buildEditorPluginTypesSource(editorPluginSlug), "utf8");
+        await fsp.writeFile(styleFilePath, buildEditorPluginStyleSource(), "utf8");
+        await writeEditorPluginRegistry(workspace.projectDir, editorPluginSlug);
+        await appendWorkspaceInventoryEntries(workspace.projectDir, {
+            editorPluginEntries: [
+                buildEditorPluginConfigEntry(editorPluginSlug, resolvedSlot),
+            ],
+        });
+        return {
+            editorPluginSlug,
+            projectDir: workspace.projectDir,
+            slot: resolvedSlot,
+        };
+    }
+    catch (error) {
+        await rollbackWorkspaceMutation(mutationSnapshot);
+        throw error;
+    }
+}

package/dist/runtime/cli-add-workspace-hooked-block.d.ts

@@ -0,0 +1,23 @@
+import type { HookedBlockPositionId } from "./hooked-blocks.js";
+import { type RunAddHookedBlockCommandOptions } from "./cli-add-shared.js";
+/**
+ * Add one `blockHooks` entry to an existing official workspace block.
+ *
+ * @param options Command options for the hooked-block workflow.
+ * @param options.anchorBlockName Full block name that will anchor the insertion.
+ * @param options.blockName Existing workspace block slug to patch.
+ * @param options.cwd Working directory used to resolve the nearest official workspace.
+ * Defaults to `process.cwd()`.
+ * @param options.position Hook position to store in `block.json`.
+ * @returns A promise that resolves with the normalized target block slug, anchor
+ * block name, position, and owning project directory after `block.json` is written.
+ * @throws {Error} When the command is run outside an official workspace, when
+ * the target block is unknown, when required flags are missing, or when the
+ * block already defines a hook for the requested anchor.
+ */
+export declare function runAddHookedBlockCommand({ anchorBlockName, blockName, cwd, position, }: RunAddHookedBlockCommandOptions): Promise<{
+    anchorBlockName: string;
+    blockSlug: string;
+    position: HookedBlockPositionId;
+    projectDir: string;
+}>;

package/dist/runtime/cli-add-workspace-hooked-block.js

@@ -0,0 +1,57 @@
+import { promises as fsp } from "node:fs";
+import path from "node:path";
+import { assertValidHookAnchor, assertValidHookedBlockPosition, getMutableBlockHooks, normalizeBlockSlug, readWorkspaceBlockJson, resolveWorkspaceBlock, rollbackWorkspaceMutation, snapshotWorkspaceFiles, } from "./cli-add-shared.js";
+import { readWorkspaceInventoryAsync } from "./workspace-inventory.js";
+import { resolveWorkspaceProject } from "./workspace-project.js";
+/**
+ * Add one `blockHooks` entry to an existing official workspace block.
+ *
+ * @param options Command options for the hooked-block workflow.
+ * @param options.anchorBlockName Full block name that will anchor the insertion.
+ * @param options.blockName Existing workspace block slug to patch.
+ * @param options.cwd Working directory used to resolve the nearest official workspace.
+ * Defaults to `process.cwd()`.
+ * @param options.position Hook position to store in `block.json`.
+ * @returns A promise that resolves with the normalized target block slug, anchor
+ * block name, position, and owning project directory after `block.json` is written.
+ * @throws {Error} When the command is run outside an official workspace, when
+ * the target block is unknown, when required flags are missing, or when the
+ * block already defines a hook for the requested anchor.
+ */
+export async function runAddHookedBlockCommand({ anchorBlockName, blockName, cwd = process.cwd(), position, }) {
+    const workspace = resolveWorkspaceProject(cwd);
+    const blockSlug = normalizeBlockSlug(blockName);
+    const inventory = await readWorkspaceInventoryAsync(workspace.projectDir);
+    resolveWorkspaceBlock(inventory, blockSlug);
+    const resolvedAnchorBlockName = assertValidHookAnchor(anchorBlockName);
+    const resolvedPosition = assertValidHookedBlockPosition(position);
+    const selfHookAnchor = `${workspace.workspace.namespace}/${blockSlug}`;
+    if (resolvedAnchorBlockName === selfHookAnchor) {
+        throw new Error("`wp-typia add hooked-block` cannot hook a block relative to its own block name.");
+    }
+    const { blockJson, blockJsonPath } = await readWorkspaceBlockJson(workspace.projectDir, blockSlug);
+    const blockJsonRelativePath = path.relative(workspace.projectDir, blockJsonPath);
+    const blockHooks = getMutableBlockHooks(blockJson, blockJsonRelativePath);
+    if (Object.prototype.hasOwnProperty.call(blockHooks, resolvedAnchorBlockName)) {
+        throw new Error(`${blockJsonRelativePath} already defines a blockHooks entry for "${resolvedAnchorBlockName}".`);
+    }
+    const mutationSnapshot = {
+        fileSources: await snapshotWorkspaceFiles([blockJsonPath]),
+        snapshotDirs: [],
+        targetPaths: [],
+    };
+    try {
+        blockHooks[resolvedAnchorBlockName] = resolvedPosition;
+        await fsp.writeFile(blockJsonPath, JSON.stringify(blockJson, null, "\t"), "utf8");
+        return {
+            anchorBlockName: resolvedAnchorBlockName,
+            blockSlug,
+            position: resolvedPosition,
+            projectDir: workspace.projectDir,
+        };
+    }
+    catch (error) {
+        await rollbackWorkspaceMutation(mutationSnapshot);
+        throw error;
+    }
+}