@wp-typia/project-tools 0.22.5 → 0.22.7

package/dist/runtime/cli-init-templates.js

@@ -0,0 +1,244 @@
+import path from "node:path";
+import { quoteTsString } from "./cli-add-shared.js";
+import { updateWorkspaceInventorySource } from "./workspace-inventory.js";
+function buildRetrofitBlockConfigEntry(target) {
+    return [
+        "\t{",
+        `\t\tslug: ${quoteTsString(target.slug)},`,
+        `\t\tattributeTypeName: ${quoteTsString(target.attributeTypeName)},`,
+        `\t\tblockJsonFile: ${quoteTsString(target.blockJsonFile)},`,
+        `\t\tmanifestFile: ${quoteTsString(target.manifestFile)},`,
+        `\t\ttypesFile: ${quoteTsString(target.typesFile)},`,
+        "\t},",
+    ].join("\n");
+}
+/**
+ * Generate the `scripts/block-config.ts` source for retrofit block targets.
+ *
+ * @param targets Existing block targets detected by the init plan.
+ * @returns Complete TypeScript source for the generated block config helper.
+ */
+export function buildRetrofitBlockConfigSource(targets) {
+    const blockEntries = targets.map(buildRetrofitBlockConfigEntry).join("\n");
+    const baseSource = `export interface WorkspaceBlockConfig {
+\tattributeTypeName: string;
+\tapiTypesFile?: string;
+\tblockJsonFile?: string;
+\tmanifestFile?: string;
+\topenApiFile?: string;
+\trestManifest?: ReturnType<
+\t\ttypeof import( '@wp-typia/block-runtime/metadata-core' ).defineEndpointManifest
+\t>;
+\tslug: string;
+\ttypesFile: string;
+}
+
+export const BLOCKS: WorkspaceBlockConfig[] = [
+${blockEntries}
+];
+`;
+    return `${updateWorkspaceInventorySource(baseSource)}\n`;
+}
+/**
+ * Generate the `scripts/sync-types-to-block-json.ts` helper source.
+ *
+ * @returns Complete TypeScript source for the metadata sync helper.
+ */
+export function buildRetrofitSyncTypesScriptSource() {
+    return `/* eslint-disable no-console */
+import path from 'node:path';
+
+import { syncBlockMetadata } from '@wp-typia/block-runtime/metadata-core';
+
+import { BLOCKS } from './block-config';
+
+function parseCliOptions( argv: string[] ) {
+\tconst options = {
+\t\tcheck: false,
+\t};
+
+\tfor ( const argument of argv ) {
+\t\tif ( argument === '--check' ) {
+\t\t\toptions.check = true;
+\t\t\tcontinue;
+\t\t}
+
+\t\tthrow new Error( \`Unknown sync-types flag: \${ argument }\` );
+\t}
+
+\treturn options;
+}
+
+async function main() {
+\tconst options = parseCliOptions( process.argv.slice( 2 ) );
+
+\tif ( BLOCKS.length === 0 ) {
+\t\tconsole.log(
+\t\t\toptions.check
+\t\t\t\t? 'ℹ️ No retrofit blocks are registered yet. \`sync-types --check\` is already clean.'
+\t\t\t\t: 'ℹ️ No retrofit blocks are registered yet. Add one block target to scripts/block-config.ts before rerunning sync-types.'
+\t\t);
+\t\treturn;
+\t}
+
+\tfor ( const block of BLOCKS ) {
+\t\tconst blockDir = path.dirname( block.typesFile );
+\t\tconst blockJsonFile =
+\t\t\tblock.blockJsonFile ?? path.join( blockDir, 'block.json' );
+\t\tconst manifestFile =
+\t\t\tblock.manifestFile ?? path.join( blockDir, 'typia.manifest.json' );
+\t\tconst manifestDir = path.dirname( manifestFile );
+\t\tconst result = await syncBlockMetadata(
+\t\t\t{
+\t\t\t\tblockJsonFile,
+\t\t\t\tjsonSchemaFile: path.join( manifestDir, 'typia.schema.json' ),
+\t\t\t\tmanifestFile,
+\t\t\t\topenApiFile: path.join( manifestDir, 'typia.openapi.json' ),
+\t\t\t\tsourceTypeName: block.attributeTypeName,
+\t\t\t\ttypesFile: block.typesFile,
+\t\t\t},
+\t\t\t{
+\t\t\t\tcheck: options.check,
+\t\t\t}
+\t\t);
+\t\tfor ( const warning of result.lossyProjectionWarnings ) {
+\t\t\tconsole.warn( \`⚠️ \${ block.slug }: \${ warning }\` );
+\t\t}
+\t\tfor ( const warning of result.phpGenerationWarnings ) {
+\t\t\tconsole.warn( \`⚠️ \${ block.slug }: \${ warning }\` );
+\t\t}
+
+\t\tconsole.log(
+\t\t\toptions.check
+\t\t\t\t? \`✅ \${ block.slug }: block.json, typia.manifest.json, typia-validator.php, typia.schema.json, and typia.openapi.json are already up to date with the TypeScript types!\`
+\t\t\t\t: \`✅ \${ block.slug }: block.json, typia.manifest.json, typia-validator.php, typia.schema.json, and typia.openapi.json were generated from TypeScript types!\`
+\t\t);
+\t\tconsole.log( '📝 Generated attributes:', result.attributeNames );
+\t}
+}
+
+main().catch( ( error ) => {
+\tconsole.error( '❌ Type sync failed:', error );
+\tprocess.exit( 1 );
+} );
+`;
+}
+/**
+ * Generate the `scripts/sync-project.ts` orchestration helper source.
+ *
+ * @returns Complete TypeScript source for the project sync entrypoint.
+ */
+export function buildRetrofitSyncProjectScriptSource() {
+    return `/* eslint-disable no-console */
+import { spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import path from 'node:path';
+
+interface SyncCliOptions {
+\tcheck: boolean;
+}
+
+function parseCliOptions( argv: string[] ): SyncCliOptions {
+\tconst options: SyncCliOptions = {
+\t\tcheck: false,
+\t};
+
+\tfor ( const argument of argv ) {
+\t\tif ( argument === '--check' ) {
+\t\t\toptions.check = true;
+\t\t\tcontinue;
+\t\t}
+
+\t\tthrow new Error( \`Unknown sync flag: \${ argument }\` );
+\t}
+
+\treturn options;
+}
+
+function getSyncScriptEnv() {
+\tconst binaryDirectory = path.join( process.cwd(), 'node_modules', '.bin' );
+\tconst inheritedPath =
+\t\tprocess.env.PATH ??
+\t\tprocess.env.Path ??
+\t\tObject.entries( process.env ).find(
+\t\t\t( [ key ] ) => key.toLowerCase() === 'path'
+\t\t)?.[ 1 ] ??
+\t\t'';
+\tconst nextPath = fs.existsSync( binaryDirectory )
+\t\t? \`\${ binaryDirectory }\${ path.delimiter }\${ inheritedPath }\`
+\t\t: inheritedPath;
+\tconst env: NodeJS.ProcessEnv = {
+\t\t...process.env,
+\t};
+
+\tfor ( const key of Object.keys( env ) ) {
+\t\tif ( key.toLowerCase() === 'path' ) {
+\t\t\tdelete env[ key ];
+\t\t}
+\t}
+
+\tenv.PATH = nextPath;
+
+\treturn env;
+}
+
+function runSyncScript( scriptPath: string, options: SyncCliOptions ) {
+\tconst args = [ scriptPath ];
+\tif ( options.check ) {
+\t\targs.push( '--check' );
+\t}
+
+\tconst result = spawnSync( 'tsx', args, {
+\t\tcwd: process.cwd(),
+\t\tenv: getSyncScriptEnv(),
+\t\tshell: process.platform === 'win32',
+\t\tstdio: 'inherit',
+\t} );
+
+\tif ( result.error ) {
+\t\tif ( ( result.error as NodeJS.ErrnoException ).code === 'ENOENT' ) {
+\t\t\tthrow new Error(
+\t\t\t\t'Unable to resolve \`tsx\` for project sync. Install project dependencies or rerun the command through your package manager.'
+\t\t\t);
+\t\t}
+
+\t\tthrow result.error;
+\t}
+
+\tif ( result.status !== 0 ) {
+\t\tthrow new Error( \`Sync script failed: \${ scriptPath }\` );
+\t}
+}
+
+async function main() {
+\tconst options = parseCliOptions( process.argv.slice( 2 ) );
+\tconst syncTypesScriptPath = path.join( 'scripts', 'sync-types-to-block-json.ts' );
+
+\trunSyncScript( syncTypesScriptPath, options );
+
+\tconsole.log(
+\t\toptions.check
+\t\t\t? '✅ Generated project metadata is already synchronized.'
+\t\t\t: '✅ Generated project metadata was synchronized.'
+\t);
+}
+
+main().catch( ( error ) => {
+\tconsole.error( '❌ Project sync failed:', error );
+\tprocess.exit( 1 );
+} );
+`;
+}
+/**
+ * Build the helper file source map written by `wp-typia init --apply`.
+ *
+ * @param blockTargets Existing block targets detected by the init plan.
+ * @returns Relative helper file paths mapped to their generated source.
+ */
+export function buildRetrofitHelperFiles(blockTargets) {
+    return {
+        [path.join("scripts", "block-config.ts")]: buildRetrofitBlockConfigSource(blockTargets),
+        [path.join("scripts", "sync-project.ts")]: buildRetrofitSyncProjectScriptSource(),
+        [path.join("scripts", "sync-types-to-block-json.ts")]: buildRetrofitSyncTypesScriptSource(),
+    };
+}

package/dist/runtime/cli-init-types.d.ts

@@ -0,0 +1,84 @@
+import type { PackageManagerId } from "./package-managers.js";
+import type { WorkspacePackageJson } from "./workspace-project.js";
+export type InitCommandMode = "apply" | "preview-only";
+export type InitPlanAction = "add" | "update";
+export type InitPlanStatus = "already-initialized" | "applied" | "preview";
+export type InitPlanLayoutKind = "generated-project" | "multi-block" | "official-workspace" | "single-block" | "unsupported";
+export interface InitDependencyChange {
+    action: InitPlanAction;
+    currentValue?: string;
+    name: string;
+    requiredValue: string;
+}
+export interface InitScriptChange {
+    action: InitPlanAction;
+    currentValue?: string;
+    name: string;
+    requiredValue: string;
+}
+export interface InitPackageManagerFieldChange {
+    action: InitPlanAction;
+    currentValue?: string;
+    requiredValue: string;
+}
+export interface InitFilePlan {
+    action: InitPlanAction;
+    path: string;
+    purpose: string;
+}
+/**
+ * One existing block target that `wp-typia init` can retrofit into the shared
+ * sync surface.
+ *
+ * Each path stays relative to the project root so generated helper scripts can
+ * resolve the current block metadata and TypeScript source of truth without
+ * guessing layout-specific locations.
+ */
+export interface RetrofitInitBlockTarget {
+    attributeTypeName: string;
+    blockJsonFile: string;
+    blockName: string;
+    manifestFile: string;
+    saveFile: string;
+    slug: string;
+    typesFile: string;
+}
+/**
+ * Preview or apply result returned by `wp-typia init`.
+ *
+ * The plan describes the detected retrofit layout, package-level mutations,
+ * helper files, next steps, and any warnings gathered while preparing or
+ * applying the minimum sync surface for an existing project.
+ */
+export interface RetrofitInitPlan {
+    blockTargets: RetrofitInitBlockTarget[];
+    commandMode: InitCommandMode;
+    detectedLayout: {
+        blockNames: string[];
+        description: string;
+        kind: InitPlanLayoutKind;
+    };
+    generatedArtifacts: string[];
+    nextSteps: string[];
+    notes: string[];
+    packageChanges: {
+        addDevDependencies: InitDependencyChange[];
+        packageManagerField?: InitPackageManagerFieldChange;
+        scripts: InitScriptChange[];
+    };
+    plannedFiles: InitFilePlan[];
+    packageManager: PackageManagerId;
+    projectDir: string;
+    projectName: string;
+    status: InitPlanStatus;
+    summary: string;
+}
+export type ProjectPackageJson = WorkspacePackageJson & {
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    private?: boolean;
+    version?: string;
+};
+export declare const SUPPORTED_RETROFIT_LAYOUT_NOTE = "Supported retrofit layouts currently mirror the migration bootstrap detector: `src/block.json` + `src/types.ts` + `src/save.tsx`, legacy root `block.json` + `src/types.ts` + `src/save.tsx`, or multi-block `src/blocks/*/block.json` workspaces.";
+export declare const RETROFIT_APPLY_PREVIEW_NOTE = "If you rerun with `wp-typia init --apply`, package.json and generated helper files are snapshotted and rolled back automatically if a write fails.";
+export declare const RETROFIT_ROLLBACK_NOTE = "Apply mode writes package.json and generated helper files with rollback-on-failure protection.";

package/dist/runtime/cli-init-types.js

@@ -0,0 +1,3 @@
+export const SUPPORTED_RETROFIT_LAYOUT_NOTE = "Supported retrofit layouts currently mirror the migration bootstrap detector: `src/block.json` + `src/types.ts` + `src/save.tsx`, legacy root `block.json` + `src/types.ts` + `src/save.tsx`, or multi-block `src/blocks/*/block.json` workspaces.";
+export const RETROFIT_APPLY_PREVIEW_NOTE = "If you rerun with `wp-typia init --apply`, package.json and generated helper files are snapshotted and rolled back automatically if a write fails.";
+export const RETROFIT_ROLLBACK_NOTE = "Apply mode writes package.json and generated helper files with rollback-on-failure protection.";

package/dist/runtime/cli-init.d.ts

@@ -1,102 +1,7 @@
-import { type PackageManagerId } from "./package-managers.js";
-type InitCommandMode = "apply" | "preview-only";
-type InitPlanAction = "add" | "update";
-type InitPlanStatus = "already-initialized" | "applied" | "preview";
-type InitPlanLayoutKind = "generated-project" | "multi-block" | "official-workspace" | "single-block" | "unsupported";
-interface InitDependencyChange {
-    action: InitPlanAction;
-    currentValue?: string;
-    name: string;
-    requiredValue: string;
-}
-interface InitScriptChange {
-    action: InitPlanAction;
-    currentValue?: string;
-    name: string;
-    requiredValue: string;
-}
-interface InitPackageManagerFieldChange {
-    action: InitPlanAction;
-    currentValue?: string;
-    requiredValue: string;
-}
-interface InitFilePlan {
-    action: InitPlanAction;
-    path: string;
-    purpose: string;
-}
-/**
- * One existing block target that `wp-typia init` can retrofit into the shared
- * sync surface.
- *
- * Each path stays relative to the project root so generated helper scripts can
- * resolve the current block metadata and TypeScript source of truth without
- * guessing layout-specific locations.
- */
-export interface RetrofitInitBlockTarget {
-    attributeTypeName: string;
-    blockJsonFile: string;
-    blockName: string;
-    manifestFile: string;
-    saveFile: string;
-    slug: string;
-    typesFile: string;
-}
-/**
- * Preview or apply result returned by `wp-typia init`.
- *
- * The plan describes the detected retrofit layout, package-level mutations,
- * helper files, next steps, and any warnings gathered while preparing or
- * applying the minimum sync surface for an existing project.
- */
-export interface RetrofitInitPlan {
-    blockTargets: RetrofitInitBlockTarget[];
-    commandMode: InitCommandMode;
-    detectedLayout: {
-        blockNames: string[];
-        description: string;
-        kind: InitPlanLayoutKind;
-    };
-    generatedArtifacts: string[];
-    nextSteps: string[];
-    notes: string[];
-    packageChanges: {
-        addDevDependencies: InitDependencyChange[];
-        packageManagerField?: InitPackageManagerFieldChange;
-        scripts: InitScriptChange[];
-    };
-    plannedFiles: InitFilePlan[];
-    packageManager: PackageManagerId;
-    projectDir: string;
-    projectName: string;
-    status: InitPlanStatus;
-    summary: string;
-}
-/**
- * Inspect one project directory and return the current retrofit init plan.
- *
- * @param projectDir Project root or nested path that should be analyzed.
- * @param options Optional package-manager override used for emitted scripts and
- * follow-up guidance.
- * @returns The preview-only retrofit init plan for the resolved project.
- */
-export declare function getInitPlan(projectDir: string, options?: {
-    packageManager?: string;
-}): RetrofitInitPlan;
-/**
- * Apply the previewed retrofit init plan to disk.
- *
- * The command snapshots package.json and generated helper targets before
- * writing, then rolls those files back automatically if any write fails.
- *
- * @param projectDir Project root that should receive the retrofit surface.
- * @param options Optional package-manager override used for emitted scripts and
- * follow-up guidance.
- * @returns The applied retrofit init plan describing the persisted changes.
- */
-export declare function applyInitPlan(projectDir: string, options?: {
-    packageManager?: string;
-}): Promise<RetrofitInitPlan>;
+import type { RetrofitInitPlan } from "./cli-init-types.js";
+export { applyInitPlan } from "./cli-init-apply.js";
+export { getInitPlan } from "./cli-init-plan.js";
+export type { InitCommandMode, InitDependencyChange, InitFilePlan, InitPackageManagerFieldChange, InitPlanAction, InitPlanLayoutKind, InitPlanStatus, InitScriptChange, RetrofitInitBlockTarget, RetrofitInitPlan, } from "./cli-init-types.js";
 /**
  * Execute `wp-typia init` in preview or apply mode.
  *
@@ -110,4 +15,3 @@ export declare function runInitCommand(options: {
     packageManager?: string;
     projectDir: string;
 }): Promise<RetrofitInitPlan>;
-export {};