@wp-typia/project-tools 0.16.14 → 0.18.0

package/dist/runtime/cli-add-shared.d.ts

@@ -4,13 +4,25 @@ import { type WorkspaceProject } from "./workspace-project.js";
 /**
  * Supported top-level `wp-typia add` kinds exposed by the canonical CLI.
  */
-export declare const ADD_KIND_IDS: readonly ["block", "variation", "pattern", "binding-source", "hooked-block"];
+export declare const ADD_KIND_IDS: readonly ["block", "variation", "pattern", "binding-source", "rest-resource", "hooked-block", "editor-plugin"];
 export type AddKindId = (typeof ADD_KIND_IDS)[number];
+/**
+ * Supported plugin-level REST resource methods accepted by
+ * `wp-typia add rest-resource --methods`.
+ */
+export declare const REST_RESOURCE_METHOD_IDS: readonly ["list", "read", "create", "update", "delete"];
+export type RestResourceMethodId = (typeof REST_RESOURCE_METHOD_IDS)[number];
+/**
+ * Supported editor-plugin shell slots accepted by `wp-typia add editor-plugin --slot`.
+ */
+export declare const EDITOR_PLUGIN_SLOT_IDS: readonly ["PluginSidebar"];
+export type EditorPluginSlotId = (typeof EDITOR_PLUGIN_SLOT_IDS)[number];
 /**
  * Supported built-in block families accepted by `wp-typia add block --template`.
  */
 export declare const ADD_BLOCK_TEMPLATE_IDS: readonly ["basic", "interactivity", "persistence", "compound"];
 export type AddBlockTemplateId = (typeof ADD_BLOCK_TEMPLATE_IDS)[number];
+export declare const REST_RESOURCE_NAMESPACE_PATTERN: RegExp;
 export interface RunAddVariationCommandOptions {
     blockName: string;
     cwd?: string;
@@ -24,12 +36,32 @@ export interface RunAddBindingSourceCommandOptions {
     bindingSourceName: string;
     cwd?: string;
 }
+export interface RunAddRestResourceCommandOptions {
+    cwd?: string;
+    methods?: string;
+    namespace?: string;
+    restResourceName: string;
+}
 export interface RunAddHookedBlockCommandOptions {
     anchorBlockName: string;
     blockName: string;
     cwd?: string;
     position: string;
 }
+/**
+ * Options for `wp-typia add editor-plugin`.
+ *
+ * @property cwd Working directory used to resolve the nearest official workspace.
+ * Defaults to `process.cwd()`.
+ * @property editorPluginName Human-entered editor plugin name that will be
+ * normalized into the generated slug.
+ * @property slot Optional editor shell slot. Defaults to `PluginSidebar`.
+ */
+export interface RunAddEditorPluginCommandOptions {
+    cwd?: string;
+    editorPluginName: string;
+    slot?: string;
+}
 export interface RunAddBlockCommandOptions {
     blockName: string;
     cwd?: string;
@@ -59,6 +91,9 @@ export interface WorkspaceMutationSnapshot {
 }
 export declare function normalizeBlockSlug(input: string): string;
 export declare function assertValidGeneratedSlug(label: string, slug: string, usage: string): string;
+export declare function assertValidRestResourceNamespace(namespace: string): string;
+export declare function resolveRestResourceNamespace(workspaceNamespace: string, namespace?: string): string;
+export declare function assertValidRestResourceMethods(methods?: string): RestResourceMethodId[];
 export declare function assertValidHookedBlockPosition(position: string): HookedBlockPositionId;
 export declare function getWorkspaceBootstrapPath(workspace: WorkspaceProject): string;
 export declare function buildWorkspacePhpPrefix(workspacePhpPrefix: string, slug: string): string;
@@ -86,6 +121,14 @@ export declare function snapshotWorkspaceFiles(filePaths: string[]): Promise<Wor
 export declare function rollbackWorkspaceMutation(snapshot: WorkspaceMutationSnapshot): Promise<void>;
 export declare function resolveWorkspaceBlock(inventory: WorkspaceInventory, blockSlug: string): WorkspaceInventory["blocks"][number];
 export declare function assertValidHookAnchor(anchorBlockName: string): string;
+/**
+ * Validate and normalize the editor plugin shell slot.
+ *
+ * @param slot Optional shell slot. Defaults to `PluginSidebar`.
+ * @returns The canonical editor plugin slot id.
+ * @throws {Error} When the slot is not supported by the workspace scaffold.
+ */
+export declare function assertValidEditorPluginSlot(slot?: string): EditorPluginSlotId;
 export declare function readWorkspaceBlockJson(projectDir: string, blockSlug: string): {
     blockJson: Record<string, unknown>;
     blockJsonPath: string;
@@ -94,6 +137,17 @@ export declare function getMutableBlockHooks(blockJson: Record<string, unknown>,
 export declare function assertVariationDoesNotExist(projectDir: string, blockSlug: string, variationSlug: string, inventory: WorkspaceInventory): void;
 export declare function assertPatternDoesNotExist(projectDir: string, patternSlug: string, inventory: WorkspaceInventory): void;
 export declare function assertBindingSourceDoesNotExist(projectDir: string, bindingSourceSlug: string, inventory: WorkspaceInventory): void;
+export declare function assertRestResourceDoesNotExist(projectDir: string, restResourceSlug: string, inventory: WorkspaceInventory): void;
+/**
+ * Ensure an editor plugin scaffold does not already exist on disk or in the
+ * workspace inventory.
+ *
+ * @param projectDir Workspace root directory.
+ * @param editorPluginSlug Normalized editor plugin slug.
+ * @param inventory Parsed workspace inventory.
+ * @throws {Error} When the directory or inventory entry already exists.
+ */
+export declare function assertEditorPluginDoesNotExist(projectDir: string, editorPluginSlug: string, inventory: WorkspaceInventory): void;
 /**
  * Returns help text for the canonical `wp-typia add` subcommands.
  */

package/dist/runtime/cli-add-shared.js

@@ -8,7 +8,30 @@ import { WORKSPACE_TEMPLATE_PACKAGE, } from "./workspace-project.js";
 /**
  * Supported top-level `wp-typia add` kinds exposed by the canonical CLI.
  */
-export const ADD_KIND_IDS = ["block", "variation", "pattern", "binding-source", "hooked-block"];
+export const ADD_KIND_IDS = [
+    "block",
+    "variation",
+    "pattern",
+    "binding-source",
+    "rest-resource",
+    "hooked-block",
+    "editor-plugin",
+];
+/**
+ * Supported plugin-level REST resource methods accepted by
+ * `wp-typia add rest-resource --methods`.
+ */
+export const REST_RESOURCE_METHOD_IDS = [
+    "list",
+    "read",
+    "create",
+    "update",
+    "delete",
+];
+/**
+ * Supported editor-plugin shell slots accepted by `wp-typia add editor-plugin --slot`.
+ */
+export const EDITOR_PLUGIN_SLOT_IDS = ["PluginSidebar"];
 /**
  * Supported built-in block families accepted by `wp-typia add block --template`.
  */
@@ -19,6 +42,7 @@ export const ADD_BLOCK_TEMPLATE_IDS = [
     "compound",
 ];
 const WORKSPACE_GENERATED_SLUG_PATTERN = /^[a-z][a-z0-9-]*$/;
+export const REST_RESOURCE_NAMESPACE_PATTERN = /^[a-z][a-z0-9-]*(?:\/[a-z0-9-]+)+$/u;
 export function normalizeBlockSlug(input) {
     return toKebabCase(input);
 }
@@ -31,6 +55,33 @@ export function assertValidGeneratedSlug(label, slug, usage) {
     }
     return slug;
 }
+export function assertValidRestResourceNamespace(namespace) {
+    const trimmed = namespace.trim();
+    if (!trimmed) {
+        throw new Error("REST resource namespace is required. Use `--namespace <vendor/v1>` or let the workspace default apply.");
+    }
+    if (!REST_RESOURCE_NAMESPACE_PATTERN.test(trimmed)) {
+        throw new Error("REST resource namespace must use lowercase slash-separated segments like `demo-space/v1`.");
+    }
+    return trimmed;
+}
+export function resolveRestResourceNamespace(workspaceNamespace, namespace) {
+    return assertValidRestResourceNamespace(namespace ?? `${workspaceNamespace}/v1`);
+}
+export function assertValidRestResourceMethods(methods) {
+    const rawMethods = typeof methods === "string" && methods.trim().length > 0
+        ? methods.split(",").map((value) => value.trim()).filter(Boolean)
+        : ["list", "read", "create"];
+    const normalizedMethods = Array.from(new Set(rawMethods));
+    const invalidMethods = normalizedMethods.filter((method) => !REST_RESOURCE_METHOD_IDS.includes(method));
+    if (invalidMethods.length > 0) {
+        throw new Error(`REST resource methods must be a comma-separated list of: ${REST_RESOURCE_METHOD_IDS.join(", ")}.`);
+    }
+    if (normalizedMethods.length === 0) {
+        throw new Error("REST resource methods must include at least one of: list, read, create, update, delete.");
+    }
+    return normalizedMethods;
+}
 export function assertValidHookedBlockPosition(position) {
     if (HOOKED_BLOCK_POSITION_IDS.includes(position)) {
         return position;
@@ -121,6 +172,19 @@ export function assertValidHookAnchor(anchorBlockName) {
     }
     return trimmed;
 }
+/**
+ * Validate and normalize the editor plugin shell slot.
+ *
+ * @param slot Optional shell slot. Defaults to `PluginSidebar`.
+ * @returns The canonical editor plugin slot id.
+ * @throws {Error} When the slot is not supported by the workspace scaffold.
+ */
+export function assertValidEditorPluginSlot(slot = "PluginSidebar") {
+    if (EDITOR_PLUGIN_SLOT_IDS.includes(slot)) {
+        return slot;
+    }
+    throw new Error(`Editor plugin slot must be one of: ${EDITOR_PLUGIN_SLOT_IDS.join(", ")}.`);
+}
 export function readWorkspaceBlockJson(projectDir, blockSlug) {
     const blockJsonPath = path.join(projectDir, "src", "blocks", blockSlug, "block.json");
     if (!fs.existsSync(blockJsonPath)) {
@@ -179,6 +243,37 @@ export function assertBindingSourceDoesNotExist(projectDir, bindingSourceSlug, i
         throw new Error(`A binding source inventory entry already exists for ${bindingSourceSlug}. Choose a different name.`);
     }
 }
+export function assertRestResourceDoesNotExist(projectDir, restResourceSlug, inventory) {
+    const restResourceDir = path.join(projectDir, "src", "rest", restResourceSlug);
+    const restResourcePhpPath = path.join(projectDir, "inc", "rest", `${restResourceSlug}.php`);
+    if (fs.existsSync(restResourceDir)) {
+        throw new Error(`A REST resource already exists at ${path.relative(projectDir, restResourceDir)}. Choose a different name.`);
+    }
+    if (fs.existsSync(restResourcePhpPath)) {
+        throw new Error(`A REST resource bootstrap already exists at ${path.relative(projectDir, restResourcePhpPath)}. Choose a different name.`);
+    }
+    if (inventory.restResources.some((entry) => entry.slug === restResourceSlug)) {
+        throw new Error(`A REST resource inventory entry already exists for ${restResourceSlug}. Choose a different name.`);
+    }
+}
+/**
+ * Ensure an editor plugin scaffold does not already exist on disk or in the
+ * workspace inventory.
+ *
+ * @param projectDir Workspace root directory.
+ * @param editorPluginSlug Normalized editor plugin slug.
+ * @param inventory Parsed workspace inventory.
+ * @throws {Error} When the directory or inventory entry already exists.
+ */
+export function assertEditorPluginDoesNotExist(projectDir, editorPluginSlug, inventory) {
+    const editorPluginDir = path.join(projectDir, "src", "editor-plugins", editorPluginSlug);
+    if (fs.existsSync(editorPluginDir)) {
+        throw new Error(`An editor plugin already exists at ${path.relative(projectDir, editorPluginDir)}. Choose a different name.`);
+    }
+    if (inventory.editorPlugins.some((entry) => entry.slug === editorPluginSlug)) {
+        throw new Error(`An editor plugin inventory entry already exists for ${editorPluginSlug}. Choose a different name.`);
+    }
+}
 /**
  * Returns help text for the canonical `wp-typia add` subcommands.
  */
@@ -188,12 +283,16 @@ export function formatAddHelpText() {
   wp-typia add variation <name> --block <block-slug>
   wp-typia add pattern <name>
   wp-typia add binding-source <name>
+  wp-typia add rest-resource <name> [--namespace <vendor/v1>] [--methods <list,read,create,update,delete>]
   wp-typia add hooked-block <block-slug> --anchor <anchor-block-name> --position <${HOOKED_BLOCK_POSITION_IDS.join("|")}>
+  wp-typia add editor-plugin <name> [--slot <${EDITOR_PLUGIN_SLOT_IDS.join("|")}>]
 
 Notes:
   \`wp-typia add\` runs only inside official ${WORKSPACE_TEMPLATE_PACKAGE} workspaces.
   \`add variation\` targets an existing block slug from \`scripts/block-config.ts\`.
   \`add pattern\` scaffolds a namespaced PHP pattern shell under \`src/patterns/\`.
   \`add binding-source\` scaffolds shared PHP and editor registration under \`src/bindings/\`.
-  \`add hooked-block\` patches an existing workspace block's \`block.json\` \`blockHooks\` metadata.`;
+  \`add rest-resource\` scaffolds plugin-level TypeScript REST contracts under \`src/rest/\` and PHP route glue under \`inc/rest/\`.
+  \`add hooked-block\` patches an existing workspace block's \`block.json\` \`blockHooks\` metadata.
+  \`add editor-plugin\` scaffolds a document-level editor extension under \`src/editor-plugins/\`.`;
 }

package/dist/runtime/cli-add-workspace-assets.d.ts

@@ -1,4 +1,24 @@
-import { type RunAddBindingSourceCommandOptions, type RunAddPatternCommandOptions } from "./cli-add-shared.js";
+import { type RunAddBindingSourceCommandOptions, type RunAddEditorPluginCommandOptions, type RunAddPatternCommandOptions } from "./cli-add-shared.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 `PluginSidebar`.
+ * @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;
+}>;
 /**
  * Add one PHP block pattern shell to an official workspace project.
  *