@wp-typia/project-tools 0.22.3 → 0.22.4

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

@@ -1,305 +1,7 @@
-import { type HookedBlockPositionId } from "./hooked-blocks.js";
-import { type WorkspaceInventory } from "./workspace-inventory.js";
-import { type WorkspaceProject } from "./workspace-project.js";
 export { normalizeBlockSlug, } from "./scaffold-identifiers.js";
-/**
- * Supported top-level `wp-typia add` kinds exposed by the canonical CLI.
- */
-export declare const ADD_KIND_IDS: readonly ["admin-view", "block", "variation", "style", "transform", "pattern", "binding-source", "rest-resource", "ability", "ai-feature", "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 surfaces accepted by
- * `wp-typia add editor-plugin --slot`.
- */
-export declare const EDITOR_PLUGIN_SLOT_IDS: readonly ["sidebar", "document-setting-panel"];
-export type EditorPluginSlotId = (typeof EDITOR_PLUGIN_SLOT_IDS)[number];
-export declare const EDITOR_PLUGIN_SLOT_ALIASES: {
-    readonly PluginDocumentSettingPanel: "document-setting-panel";
-    readonly PluginSidebar: "sidebar";
-    readonly "document-setting-panel": "document-setting-panel";
-    readonly sidebar: "sidebar";
-};
-export declare function resolveEditorPluginSlotAlias(slot: string): EditorPluginSlotId | undefined;
-/**
- * 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;
-    variationName: string;
-}
-/**
- * Options for `wp-typia add style`.
- *
- * @property blockName Existing workspace block slug that owns the style.
- * @property cwd Working directory used to resolve the nearest official workspace.
- * Defaults to `process.cwd()`.
- * @property styleName Human-entered style name that will be normalized into the
- * generated style slug.
- */
-export interface RunAddBlockStyleCommandOptions {
-    blockName: string;
-    cwd?: string;
-    styleName: string;
-}
-/**
- * Options for `wp-typia add transform`.
- *
- * @property cwd Working directory used to resolve the nearest official workspace.
- * Defaults to `process.cwd()`.
- * @property fromBlockName Full `namespace/block` source block name accepted by
- * WordPress block transform definitions.
- * @property toBlockName Existing workspace block slug or full block name that
- * owns the generated transform.
- * @property transformName Human-entered transform name that will be normalized
- * into the generated transform slug.
- */
-export interface RunAddBlockTransformCommandOptions {
-    cwd?: string;
-    fromBlockName: string;
-    toBlockName: string;
-    transformName: string;
-}
-export interface RunAddPatternCommandOptions {
-    cwd?: string;
-    patternName: string;
-}
-export interface RunAddBindingSourceCommandOptions {
-    attributeName?: string;
-    blockName?: string;
-    bindingSourceName: string;
-    cwd?: string;
-}
-export interface RunAddRestResourceCommandOptions {
-    cwd?: string;
-    methods?: string;
-    namespace?: string;
-    restResourceName: string;
-}
-/**
- * Options for `wp-typia add admin-view`.
- *
- * @property adminViewName Human-entered admin screen name that will be
- * normalized into the generated slug.
- * @property cwd Working directory used to resolve the nearest official workspace.
- * Defaults to `process.cwd()`.
- * @property source Optional data source locator. `rest-resource:<slug>` wires
- * the generated screen to an existing list-capable REST resource.
- * `core-data:<kind>/<name>` binds the screen to a supported WordPress-owned
- * entity collection such as `core-data:postType/post`.
- */
-export interface RunAddAdminViewCommandOptions {
-    adminViewName: string;
-    cwd?: string;
-    source?: string;
-}
-/**
- * Options for `wp-typia add ability`.
- *
- * @property cwd Working directory used to resolve the nearest official workspace.
- * Defaults to `process.cwd()`.
- * @property abilityName Human-entered workflow ability name that will be
- * normalized into the generated slug.
- */
-export interface RunAddAbilityCommandOptions {
-    abilityName: string;
-    cwd?: string;
-}
-export interface RunAddAiFeatureCommandOptions {
-    aiFeatureName: string;
-    cwd?: string;
-    namespace?: 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 `sidebar`.
- */
-export interface RunAddEditorPluginCommandOptions {
-    cwd?: string;
-    editorPluginName: string;
-    slot?: string;
-}
-export interface RunAddBlockCommandOptions {
-    alternateRenderTargets?: string;
-    blockName: string;
-    cwd?: string;
-    dataStorageMode?: string;
-    externalLayerId?: string;
-    externalLayerSource?: string;
-    innerBlocksPreset?: string;
-    persistencePolicy?: string;
-    selectExternalLayerId?: (options: Array<{
-        description?: string;
-        extends: string[];
-        id: string;
-    }>) => Promise<string>;
-    templateId?: string;
-}
-export interface WorkspaceMutationSnapshot {
-    /** Snapshots of file contents taken before the mutation starts. */
-    fileSources: Array<{
-        /** Absolute file path recorded for rollback. */
-        filePath: string;
-        /** Previous file contents, or `null` when the file did not exist. */
-        source: string | null;
-    }>;
-    /** Snapshot directories created while seeding migration history. */
-    snapshotDirs: string[];
-    /** Files or directories created by the mutation that should be removed on rollback. */
-    targetPaths: 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;
-export declare function isAddBlockTemplateId(value: string): value is AddBlockTemplateId;
-export declare function quoteTsString(value: string): string;
-/**
- * Apply a text transform to an existing file only when the contents change.
- */
-export declare function patchFile(filePath: string, transform: (source: string) => string): Promise<void>;
-/**
- * Read a file when it exists and otherwise return `null`.
- */
-export declare function readOptionalFile(filePath: string): Promise<string | null>;
-/**
- * Restore a file to its captured source, deleting it when the snapshot was `null`.
- */
-export declare function restoreOptionalFile(filePath: string, source: string | null): Promise<void>;
-/**
- * Capture the current contents of a set of workspace files for rollback.
- */
-export declare function snapshotWorkspaceFiles(filePaths: string[]): Promise<WorkspaceMutationSnapshot["fileSources"]>;
-/**
- * Undo a partially applied workspace mutation from a captured snapshot.
- */
-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 `sidebar`.
- * @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;
-};
-export declare function getMutableBlockHooks(blockJson: Record<string, unknown>, blockJsonRelativePath: string): Record<string, string>;
-type ScaffoldFilesystemCollision = {
-    label: string;
-    relativePath: string;
-};
-type ScaffoldInventoryCollision<TEntry> = {
-    entries: readonly TEntry[];
-    exists: (entry: TEntry) => boolean;
-    message: string;
-};
-/**
- * Ensure scaffold targets do not already exist on disk or in workspace inventory.
- *
- * @param options Collision checks to run before writing scaffold files.
- * @throws {Error} When a filesystem path or inventory entry already exists.
- */
-export declare function assertScaffoldDoesNotExist<TEntry>(options: {
-    projectDir: string;
-    filesystemCollisions: readonly ScaffoldFilesystemCollision[];
-    inventoryCollision?: ScaffoldInventoryCollision<TEntry>;
-}): void;
-/**
- * Ensure a block variation scaffold does not already exist.
- *
- * @param projectDir Absolute workspace root used to resolve scaffold paths.
- * @param blockSlug Existing workspace block slug that owns the variation.
- * @param variationSlug Normalized variation slug that would be created.
- * @param inventory Current workspace inventory used for duplicate detection.
- * @throws {Error} When the variation file or inventory entry already exists.
- */
-export declare function assertVariationDoesNotExist(projectDir: string, blockSlug: string, variationSlug: string, inventory: WorkspaceInventory): void;
-/**
- * Ensure a block style scaffold does not already exist.
- *
- * @param projectDir Absolute workspace root used to resolve scaffold paths.
- * @param blockSlug Existing workspace block slug that owns the style.
- * @param styleSlug Normalized style slug that would be created.
- * @param inventory Current workspace inventory used for duplicate detection.
- * @throws {Error} When the style file or inventory entry already exists.
- */
-export declare function assertBlockStyleDoesNotExist(projectDir: string, blockSlug: string, styleSlug: string, inventory: WorkspaceInventory): void;
-/**
- * Ensure a block transform scaffold does not already exist.
- *
- * @param projectDir Absolute workspace root used to resolve scaffold paths.
- * @param blockSlug Existing workspace block slug that owns the transform.
- * @param transformSlug Normalized transform slug that would be created.
- * @param inventory Current workspace inventory used for duplicate detection.
- * @throws {Error} When the transform file or inventory entry already exists.
- */
-export declare function assertBlockTransformDoesNotExist(projectDir: string, blockSlug: string, transformSlug: 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 a DataViews admin screen scaffold does not already exist on disk or in
- * the workspace inventory.
- *
- * @param projectDir Workspace root directory.
- * @param adminViewSlug Normalized admin screen slug.
- * @param inventory Parsed workspace inventory.
- * @throws {Error} When the directory, PHP bootstrap, or inventory entry already exists.
- */
-export declare function assertAdminViewDoesNotExist(projectDir: string, adminViewSlug: string, inventory: WorkspaceInventory): void;
-/**
- * Ensure a workflow ability scaffold does not already exist on disk or in the
- * workspace inventory.
- *
- * The check covers the generated `src/abilities/<slug>` directory,
- * `inc/abilities/<slug>.php`, and any matching `inventory.abilities` entry.
- *
- * @param projectDir Workspace root directory.
- * @param abilitySlug Normalized workflow ability slug.
- * @param inventory Parsed workspace inventory.
- * @throws {Error} When the ability directory, PHP bootstrap, or inventory entry already exists.
- */
-export declare function assertAbilityDoesNotExist(projectDir: string, abilitySlug: string, inventory: WorkspaceInventory): void;
-export declare function assertAiFeatureDoesNotExist(projectDir: string, aiFeatureSlug: 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.
- */
-export declare function formatAddHelpText(): string;
+export * from "./cli-add-types.js";
+export * from "./cli-add-validation.js";
+export * from "./cli-add-filesystem.js";
+export * from "./cli-add-block-json.js";
+export * from "./cli-add-collision.js";
+export * from "./cli-add-help.js";