@wp-typia/project-tools 0.22.9 → 0.23.0

package/dist/runtime/workspace-inventory.d.ts

@@ -1,252 +1,5 @@
-export interface WorkspaceBlockInventoryEntry {
-    apiTypesFile?: string;
-    attributeTypeName?: string;
-    openApiFile?: string;
-    slug: string;
-    typesFile: string;
-}
-export interface WorkspaceVariationInventoryEntry {
-    block: string;
-    file: string;
-    slug: string;
-}
-export interface WorkspaceBlockStyleInventoryEntry {
-    block: string;
-    file: string;
-    slug: string;
-}
-export interface WorkspaceBlockTransformInventoryEntry {
-    block: string;
-    file: string;
-    from: string;
-    slug: string;
-    to: string;
-}
-export interface WorkspacePatternInventoryEntry {
-    file: string;
-    slug: string;
-}
-export interface WorkspaceBindingSourceInventoryEntry {
-    attribute?: string;
-    block?: string;
-    editorFile: string;
-    serverFile: string;
-    slug: string;
-}
-/**
- * REST-resource entry parsed from `scripts/block-config.ts`.
- *
- * Each file path is stored relative to the workspace root so doctor checks and
- * workspace mutation helpers can resolve the generated TypeScript, OpenAPI, and
- * PHP route artifacts without guessing their locations.
- */
-export interface WorkspaceRestResourceInventoryEntry {
-    apiFile: string;
-    clientFile: string;
-    dataFile: string;
-    methods: string[];
-    namespace: string;
-    openApiFile: string;
-    phpFile: string;
-    slug: string;
-    typesFile: string;
-    validatorsFile: string;
-}
-/**
- * Ability entry parsed from `scripts/block-config.ts`.
- *
- * Each file path stays relative to the workspace root so doctor checks, schema
- * sync scripts, and generated admin/editor helpers can resolve typed workflow
- * artifacts without guessing their locations.
- */
-export interface WorkspaceAbilityInventoryEntry {
-    clientFile: string;
-    configFile: string;
-    dataFile: string;
-    inputSchemaFile: string;
-    inputTypeName: string;
-    outputSchemaFile: string;
-    outputTypeName: string;
-    phpFile: string;
-    slug: string;
-    typesFile: string;
-}
-/**
- * AI-feature entry parsed from `scripts/block-config.ts`.
- *
- * Each file path stays relative to the workspace root so doctor checks, add
- * workflows, and split sync scripts can reason about the REST and AI-safe
- * artifacts without guessing their locations.
- */
-export interface WorkspaceAiFeatureInventoryEntry {
-    aiSchemaFile: string;
-    apiFile: string;
-    clientFile: string;
-    dataFile: string;
-    namespace: string;
-    openApiFile: string;
-    phpFile: string;
-    slug: string;
-    typesFile: string;
-    validatorsFile: string;
-}
-/**
- * DataViews admin-screen entry parsed from `scripts/block-config.ts`.
- *
- * @property file Relative path to the generated admin view shared entry file.
- * @property phpFile Relative path to the generated WordPress admin page glue.
- * @property slug Normalized admin view slug.
- * @property source Optional source locator such as `rest-resource:products` or
- * `core-data:postType/post`.
- */
-export interface WorkspaceAdminViewInventoryEntry {
-    file: string;
-    phpFile: string;
-    slug: string;
-    source?: string;
-}
-/**
- * Editor-plugin entry parsed from `scripts/block-config.ts`.
- *
- * @property file Relative path to the generated editor plugin entry file.
- * @property slug Normalized editor plugin slug.
- * @property slot Canonical editor shell slot for the plugin scaffold.
- */
-export interface WorkspaceEditorPluginInventoryEntry {
-    file: string;
-    slug: string;
-    slot: string;
-}
-export interface WorkspaceInventory {
-    adminViews: WorkspaceAdminViewInventoryEntry[];
-    bindingSources: WorkspaceBindingSourceInventoryEntry[];
-    blockConfigPath: string;
-    blocks: WorkspaceBlockInventoryEntry[];
-    blockStyles: WorkspaceBlockStyleInventoryEntry[];
-    blockTransforms: WorkspaceBlockTransformInventoryEntry[];
-    abilities: WorkspaceAbilityInventoryEntry[];
-    aiFeatures: WorkspaceAiFeatureInventoryEntry[];
-    hasAbilitiesSection: boolean;
-    hasAdminViewsSection: boolean;
-    hasBindingSourcesSection: boolean;
-    hasAiFeaturesSection: boolean;
-    hasBlockStylesSection: boolean;
-    hasBlockTransformsSection: boolean;
-    hasEditorPluginsSection: boolean;
-    hasPatternsSection: boolean;
-    hasRestResourcesSection: boolean;
-    hasVariationsSection: boolean;
-    editorPlugins: WorkspaceEditorPluginInventoryEntry[];
-    patterns: WorkspacePatternInventoryEntry[];
-    restResources: WorkspaceRestResourceInventoryEntry[];
-    source: string;
-    variations: WorkspaceVariationInventoryEntry[];
-}
-export type WorkspaceBlockSelectOption = {
-    description: string;
-    name: string;
-    value: string;
-};
-export declare const BLOCK_CONFIG_ENTRY_MARKER = "\t// wp-typia add block entries";
-export declare const VARIATION_CONFIG_ENTRY_MARKER = "\t// wp-typia add variation entries";
-export declare const BLOCK_STYLE_CONFIG_ENTRY_MARKER = "\t// wp-typia add style entries";
-export declare const BLOCK_TRANSFORM_CONFIG_ENTRY_MARKER = "\t// wp-typia add transform entries";
-export declare const PATTERN_CONFIG_ENTRY_MARKER = "\t// wp-typia add pattern entries";
-export declare const BINDING_SOURCE_CONFIG_ENTRY_MARKER = "\t// wp-typia add binding-source entries";
-export declare const REST_RESOURCE_CONFIG_ENTRY_MARKER = "\t// wp-typia add rest-resource entries";
-export declare const ABILITY_CONFIG_ENTRY_MARKER = "\t// wp-typia add ability entries";
-export declare const AI_FEATURE_CONFIG_ENTRY_MARKER = "\t// wp-typia add ai-feature entries";
-export declare const ADMIN_VIEW_CONFIG_ENTRY_MARKER = "\t// wp-typia add admin-view entries";
-/**
- * Marker used to append generated editor-plugin entries into `EDITOR_PLUGINS`.
- */
-export declare const EDITOR_PLUGIN_CONFIG_ENTRY_MARKER = "\t// wp-typia add editor-plugin entries";
-type WorkspaceInventoryUpdateOptions = {
-    abilityEntries?: string[];
-    adminViewEntries?: string[];
-    aiFeatureEntries?: string[];
-    blockEntries?: string[];
-    blockStyleEntries?: string[];
-    blockTransformEntries?: string[];
-    bindingSourceEntries?: string[];
-    editorPluginEntries?: string[];
-    patternEntries?: string[];
-    restResourceEntries?: string[];
-    transformSource?: (source: string) => string;
-    variationEntries?: string[];
-};
-/**
- * Parse workspace inventory entries from the source of `scripts/block-config.ts`.
- *
- * @param source Raw TypeScript source from `scripts/block-config.ts`.
- * @returns Parsed inventory sections without the resolved `blockConfigPath`.
- * @throws {Error} When `BLOCKS` is missing or any inventory entry is malformed.
- */
-export declare function parseWorkspaceInventorySource(source: string): Omit<WorkspaceInventory, "blockConfigPath">;
-/**
- * Synchronously read and parse the canonical workspace inventory file.
- *
- * This compatibility helper is intentionally sync-only for callers that expose
- * synchronous APIs. Prefer `readWorkspaceInventoryAsync()` from async command
- * paths so workspace reads do not block the event loop.
- *
- * @param projectDir Workspace root directory.
- * @returns Parsed `WorkspaceInventory` including the resolved `blockConfigPath`.
- * @throws {Error} When `scripts/block-config.ts` is missing or invalid.
- */
-export declare function readWorkspaceInventory(projectDir: string): WorkspaceInventory;
-/**
- * Asynchronously read and parse the canonical workspace inventory file.
- *
- * @param projectDir Workspace root directory.
- * @returns Parsed `WorkspaceInventory` including the resolved `blockConfigPath`.
- * @throws {Error} When `scripts/block-config.ts` is missing or invalid.
- */
-export declare function readWorkspaceInventoryAsync(projectDir: string): Promise<WorkspaceInventory>;
-/**
- * Synchronously return select options for the current workspace block inventory.
- *
- * The `description` field mirrors `block.typesFile`, while `name` and `value`
- * both map to the block slug for use in interactive add flows.
- *
- * @deprecated Use `getWorkspaceBlockSelectOptionsAsync()` from async command
- * paths. This helper intentionally remains sync-only for compatibility callers.
- *
- * @param projectDir Workspace root directory.
- * @returns Block options for variation-target selection.
- */
-export declare function getWorkspaceBlockSelectOptions(projectDir: string): WorkspaceBlockSelectOption[];
-/**
- * Asynchronously return select options for the current workspace block inventory.
- *
- * The returned option shape matches `getWorkspaceBlockSelectOptions()` while
- * avoiding synchronous inventory reads in interactive or async command paths.
- *
- * @param projectDir Workspace root directory.
- * @returns Block options for variation-target selection.
- */
-export declare function getWorkspaceBlockSelectOptionsAsync(projectDir: string): Promise<WorkspaceBlockSelectOption[]>;
-/**
- * Update `scripts/block-config.ts` source text with additional inventory entries.
- *
- * Missing inventory sections for variations, patterns, binding sources, REST
- * resources, workflow abilities, AI features, editor plugins, block styles, and
- * block transforms are created
- * automatically before new entries are appended at their marker comments.
- * When provided, `transformSource` runs before any entries are inserted.
- *
- * @param source Existing `scripts/block-config.ts` source.
- * @param options Entry lists plus an optional source transformer.
- * @returns Updated source text with all requested inventory entries appended.
- */
-export declare function updateWorkspaceInventorySource(source: string, options?: WorkspaceInventoryUpdateOptions): string;
-/**
- * Append new entries to the canonical workspace inventory file on disk.
- *
- * @param projectDir Workspace root directory.
- * @param options Entry lists and optional source transform passed through to
- * `updateWorkspaceInventorySource`.
- * @returns Resolves once `scripts/block-config.ts` has been updated if needed.
- */
-export declare function appendWorkspaceInventoryEntries(projectDir: string, options: Parameters<typeof updateWorkspaceInventorySource>[1]): Promise<void>;
-export {};
+export { ABILITY_CONFIG_ENTRY_MARKER, ADMIN_VIEW_CONFIG_ENTRY_MARKER, AI_FEATURE_CONFIG_ENTRY_MARKER, BINDING_SOURCE_CONFIG_ENTRY_MARKER, BLOCK_CONFIG_ENTRY_MARKER, BLOCK_STYLE_CONFIG_ENTRY_MARKER, BLOCK_TRANSFORM_CONFIG_ENTRY_MARKER, CONTRACT_CONFIG_ENTRY_MARKER, EDITOR_PLUGIN_CONFIG_ENTRY_MARKER, PATTERN_CONFIG_ENTRY_MARKER, POST_META_CONFIG_ENTRY_MARKER, REST_RESOURCE_CONFIG_ENTRY_MARKER, VARIATION_CONFIG_ENTRY_MARKER, } from "./workspace-inventory-templates.js";
+export { parseWorkspaceInventorySource } from "./workspace-inventory-parser.js";
+export { getWorkspaceBlockSelectOptions, getWorkspaceBlockSelectOptionsAsync, readWorkspaceInventory, readWorkspaceInventoryAsync, } from "./workspace-inventory-read.js";
+export { appendWorkspaceInventoryEntries, updateWorkspaceInventorySource, } from "./workspace-inventory-mutations.js";
+export type { WorkspaceAbilityInventoryEntry, WorkspaceAdminViewInventoryEntry, WorkspaceAiFeatureInventoryEntry, WorkspaceBindingSourceInventoryEntry, WorkspaceBlockInventoryEntry, WorkspaceBlockSelectOption, WorkspaceBlockStyleInventoryEntry, WorkspaceBlockTransformInventoryEntry, WorkspaceContractInventoryEntry, WorkspaceEditorPluginInventoryEntry, WorkspaceInventory, WorkspacePatternInventoryEntry, WorkspacePostMetaInventoryEntry, WorkspaceRestResourceInventoryEntry, WorkspaceVariationInventoryEntry, } from "./workspace-inventory-types.js";