@wp-typia/project-tools 0.19.2 → 0.19.3

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

@@ -17,6 +17,8 @@ export declare const CLI_DIAGNOSTIC_CODES: {
     readonly MISSING_ARGUMENT: "missing-argument";
     readonly MISSING_BUILD_ARTIFACT: "missing-build-artifact";
     readonly OUTSIDE_PROJECT_ROOT: "outside-project-root";
+    readonly TEMPLATE_SOURCE_TIMEOUT: "template-source-timeout";
+    readonly TEMPLATE_SOURCE_TOO_LARGE: "template-source-too-large";
     readonly UNSUPPORTED_COMMAND: "unsupported-command";
 };
 export type CliDiagnosticCode = (typeof CLI_DIAGNOSTIC_CODES)[keyof typeof CLI_DIAGNOSTIC_CODES];

package/dist/runtime/cli-diagnostics.js

@@ -8,12 +8,15 @@ export const CLI_DIAGNOSTIC_CODES = {
     MISSING_ARGUMENT: "missing-argument",
     MISSING_BUILD_ARTIFACT: "missing-build-artifact",
     OUTSIDE_PROJECT_ROOT: "outside-project-root",
+    TEMPLATE_SOURCE_TIMEOUT: "template-source-timeout",
+    TEMPLATE_SOURCE_TOO_LARGE: "template-source-too-large",
     UNSUPPORTED_COMMAND: "unsupported-command",
 };
 const DEFAULT_CLI_FAILURE_SUMMARIES = {
     add: "Unable to complete the requested add workflow.",
     create: "Unable to complete the requested create workflow.",
     doctor: "One or more doctor checks failed.",
+    init: "Unable to preview the requested retrofit init plan.",
     mcp: "Unable to inspect or sync MCP metadata.",
     migrate: "Unable to complete the requested migration command.",
     sync: "Unable to complete the requested sync workflow.",
@@ -168,10 +171,16 @@ function inferCliDiagnosticCode(options) {
     if (/dependencies have not been installed yet/u.test(haystack)) {
         return CLI_DIAGNOSTIC_CODES.DEPENDENCIES_NOT_INSTALLED;
     }
+    if (/Timed out while .*external template|Timed out while .*npm template|Timed out while .*GitHub template/u.test(haystack)) {
+        return CLI_DIAGNOSTIC_CODES.TEMPLATE_SOURCE_TIMEOUT;
+    }
+    if (/external template size limit/u.test(haystack)) {
+        return CLI_DIAGNOSTIC_CODES.TEMPLATE_SOURCE_TOO_LARGE;
+    }
     if (options.command === "doctor") {
         return CLI_DIAGNOSTIC_CODES.DOCTOR_CHECK_FAILED;
     }
-    if (/requires <|requires --/u.test(haystack)) {
+    if (/requires <|requires --|requires a value/u.test(haystack)) {
         return CLI_DIAGNOSTIC_CODES.MISSING_ARGUMENT;
     }
     if (/Unknown .*subcommand|Unknown add kind|Unknown template|removed in favor|does not support|The Bun-free fallback runtime does not support|The positional alias only accepts/u.test(haystack)) {

package/dist/runtime/cli-help.js

@@ -17,6 +17,7 @@ export function formatHelpText() {
   wp-typia create <project-dir> [--template persistence] [--external-layer-source <./path|github:owner/repo/path[#ref]|npm-package>] [--external-layer-id <layer-id>] [--alternate-render-targets <email,mjml,plain-text>] [--data-storage <post-meta|custom-table>] [--persistence-policy <authenticated|public>] [--namespace <value>] [--text-domain <value>] [--php-prefix <value>] [--with-migration-ui] [--with-wp-env] [--with-test-preset] [--yes] [--dry-run] [--no-install] [--package-manager <id>]
   wp-typia create <project-dir> [--template compound] [--external-layer-source <./path|github:owner/repo/path[#ref]|npm-package>] [--external-layer-id <layer-id>] [--inner-blocks-preset <freeform|ordered|horizontal|locked-structure>] [--alternate-render-targets <email,mjml,plain-text>] [--data-storage <post-meta|custom-table>] [--persistence-policy <authenticated|public>] [--namespace <value>] [--text-domain <value>] [--php-prefix <value>] [--with-migration-ui] [--with-wp-env] [--with-test-preset] [--yes] [--dry-run] [--no-install] [--package-manager <id>]
   wp-typia <project-dir> [create flags...]
+  wp-typia init [project-dir]
   wp-typia add block <name> --template <basic|interactivity|persistence|compound> [--external-layer-source <./path|github:owner/repo/path[#ref]|npm-package>] [--external-layer-id <layer-id>] [--inner-blocks-preset <freeform|ordered|horizontal|locked-structure>] [--alternate-render-targets <email,mjml,plain-text>] [--data-storage <post-meta|custom-table>] [--persistence-policy <authenticated|public>]
   wp-typia add variation <name> --block <block-slug>
   wp-typia add pattern <name>
@@ -37,6 +38,7 @@ Package managers: ${PACKAGE_MANAGER_IDS.join(", ")}
 Notes:
   \`wp-typia create\` is the canonical scaffold command.
   \`wp-typia <project-dir>\` remains a backward-compatible alias to \`create\` when \`<project-dir>\` is the only positional argument.
+  \`wp-typia init\` is a preview-only retrofit planner for existing projects. It does not write files yet.
   Use \`--template workspace\` as shorthand for \`@wp-typia/create-workspace-template\`, the official empty workspace scaffold behind \`wp-typia add ...\`.
   \`query-loop\` is create-only. Use \`wp-typia create <project-dir> --template query-loop\`; \`wp-typia add block\` accepts only basic, interactivity, persistence, and compound families.
   \`add variation\` uses an existing workspace block from \`scripts/block-config.ts\`.
@@ -46,6 +48,7 @@ Notes:
   \`add editor-plugin\` scaffolds a document-level editor extension under \`src/editor-plugins/\`.
   \`add hooked-block\` patches an existing workspace block's \`block.json\` \`blockHooks\` metadata.
   \`wp-typia doctor\` always checks environment readiness and reports when it only ran environment-level diagnostics; official workspace roots also get inventory and source-tree drift checks.
+  \`wp-typia init\` previews the minimum sync/doctor/migration adoption layer for supported existing layouts before a future write mode exists.
   \`wp-typia migrate doctor --all\` checks migration target alignment, snapshots, fixtures, and generated migration artifacts.
   \`migrate\` is the canonical migration command; \`migrations\` is no longer supported.`;
 }

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

@@ -0,0 +1,49 @@
+import { type PackageManagerId } from "./package-managers.js";
+type InitPlanAction = "add" | "update";
+type InitPlanStatus = "already-initialized" | "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 {
+    path: string;
+    purpose: string;
+}
+export interface RetrofitInitPlan {
+    commandMode: "preview-only";
+    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 declare function getInitPlan(projectDir: string): RetrofitInitPlan;
+export {};

package/dist/runtime/cli-init.js

@@ -0,0 +1,354 @@
+import fs from "node:fs";
+import path from "node:path";
+import { discoverMigrationInitLayout } from "./migration-project.js";
+import { formatAddDevDependenciesCommand, formatPackageExecCommand, formatRunScript, getPackageManager, transformPackageManagerText, } from "./package-managers.js";
+import { getPackageVersions } from "./package-versions.js";
+import { parseWorkspacePackageManagerId, tryResolveWorkspaceProject, } from "./workspace-project.js";
+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.";
+const BASE_RETROFIT_SCRIPTS = {
+    sync: "tsx scripts/sync-project.ts",
+    "sync-types": "tsx scripts/sync-types-to-block-json.ts",
+    typecheck: "bun run sync --check && tsc --noEmit",
+};
+const BASE_RETROFIT_DEV_DEPENDENCIES = [
+    "@typia/unplugin",
+    "@wp-typia/block-runtime",
+    "@wp-typia/block-types",
+    "tsx",
+    "typescript",
+    "typia",
+];
+function normalizeRelativePath(value) {
+    return value.replace(/\\/gu, "/");
+}
+function readProjectPackageJson(projectDir) {
+    const packageJsonPath = path.join(projectDir, "package.json");
+    if (!fs.existsSync(packageJsonPath)) {
+        return null;
+    }
+    return JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+}
+function inferInitPackageManager(projectDir, packageJson) {
+    if (packageJson?.packageManager) {
+        return parseWorkspacePackageManagerId(packageJson.packageManager);
+    }
+    if (fs.existsSync(path.join(projectDir, "bun.lock")) ||
+        fs.existsSync(path.join(projectDir, "bun.lockb"))) {
+        return "bun";
+    }
+    if (fs.existsSync(path.join(projectDir, "pnpm-lock.yaml"))) {
+        return "pnpm";
+    }
+    if (fs.existsSync(path.join(projectDir, "yarn.lock")) ||
+        fs.existsSync(path.join(projectDir, ".yarnrc.yml"))) {
+        return "yarn";
+    }
+    return "npm";
+}
+function getWpTypiaCliSpecifier() {
+    const versions = getPackageVersions();
+    return versions.wpTypiaPackageExactVersion === "0.0.0"
+        ? "wp-typia"
+        : `wp-typia@${versions.wpTypiaPackageExactVersion}`;
+}
+function buildRequiredDevDependencyMap() {
+    const versions = getPackageVersions();
+    return {
+        "@typia/unplugin": "^12.0.1",
+        "@wp-typia/block-runtime": versions.blockRuntimePackageVersion,
+        "@wp-typia/block-types": versions.blockTypesPackageVersion,
+        tsx: "^4.20.5",
+        typescript: "^5.9.2",
+        typia: "^12.0.1",
+    };
+}
+function getExistingDependencyVersion(packageJson, name) {
+    return packageJson?.devDependencies?.[name] ?? packageJson?.dependencies?.[name];
+}
+function buildDependencyChanges(packageJson) {
+    const requiredDependencies = buildRequiredDevDependencyMap();
+    return BASE_RETROFIT_DEV_DEPENDENCIES.flatMap((name) => {
+        const requiredValue = requiredDependencies[name];
+        const currentValue = getExistingDependencyVersion(packageJson, name);
+        if (currentValue === requiredValue) {
+            return [];
+        }
+        return [
+            {
+                action: currentValue ? "update" : "add",
+                ...(currentValue ? { currentValue } : {}),
+                name,
+                requiredValue,
+            },
+        ];
+    });
+}
+function buildScriptChanges(packageJson, packageManager) {
+    const scripts = packageJson?.scripts ?? {};
+    return Object.entries(BASE_RETROFIT_SCRIPTS).flatMap(([name, commandSource]) => {
+        const requiredValue = transformPackageManagerText(commandSource, packageManager);
+        const currentValue = scripts[name];
+        if (currentValue === requiredValue) {
+            return [];
+        }
+        return [
+            {
+                action: typeof currentValue === "string" ? "update" : "add",
+                ...(typeof currentValue === "string" ? { currentValue } : {}),
+                name,
+                requiredValue,
+            },
+        ];
+    });
+}
+function buildPackageManagerFieldChange(packageJson, packageManager) {
+    if (packageManager === "npm") {
+        return undefined;
+    }
+    const requiredValue = getPackageManager(packageManager).packageManagerField;
+    const currentValue = packageJson?.packageManager;
+    if (currentValue === requiredValue) {
+        return undefined;
+    }
+    return {
+        action: typeof currentValue === "string" ? "update" : "add",
+        ...(typeof currentValue === "string" ? { currentValue } : {}),
+        requiredValue,
+    };
+}
+function buildGeneratedArtifactPaths(blockJsonFile, manifestFile) {
+    const manifestDir = path.dirname(manifestFile);
+    const artifactPaths = [
+        blockJsonFile,
+        manifestFile,
+        path.join(manifestDir, "typia.schema.json"),
+        path.join(manifestDir, "typia-validator.php"),
+        path.join(manifestDir, "typia.openapi.json"),
+    ];
+    return Array.from(new Set(artifactPaths.map((filePath) => normalizeRelativePath(filePath))));
+}
+function buildLayoutDetails(projectDir) {
+    try {
+        const discoveredLayout = discoverMigrationInitLayout(projectDir);
+        if (discoveredLayout.mode === "multi") {
+            return {
+                blockNames: discoveredLayout.blocks.map((block) => block.blockName),
+                description: `Detected a supported multi-block retrofit candidate (${discoveredLayout.blocks.length} targets).`,
+                generatedArtifacts: discoveredLayout.blocks.flatMap((block) => buildGeneratedArtifactPaths(block.blockJsonFile, block.manifestFile)),
+                kind: "multi-block",
+                notes: [
+                    "Migration bootstrap can stay optional. Add it later with `wp-typia migrate init --current-migration-version v1` once the typed sync surface is in place.",
+                ],
+            };
+        }
+        return {
+            blockNames: [discoveredLayout.block.blockName],
+            description: "Detected a supported single-block retrofit candidate.",
+            generatedArtifacts: buildGeneratedArtifactPaths(discoveredLayout.block.blockJsonFile, discoveredLayout.block.manifestFile),
+            kind: "single-block",
+            notes: discoveredLayout.block.blockJsonFile === "block.json"
+                ? [
+                    "Legacy root `block.json` layouts are still supported for retrofit planning, but newer scaffolds keep generated block metadata under `src/`.",
+                ]
+                : [],
+        };
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return {
+            blockNames: [],
+            description: "No supported retrofit layout was auto-detected yet.",
+            generatedArtifacts: [],
+            kind: "unsupported",
+            notes: [message, SUPPORTED_RETROFIT_LAYOUT_NOTE],
+        };
+    }
+}
+function hasExistingWpTypiaProjectSurface(packageJson) {
+    const scripts = packageJson?.scripts ?? {};
+    const hasSyncSurface = typeof scripts.sync === "string" || typeof scripts["sync-types"] === "string";
+    const hasRuntimeDeps = typeof getExistingDependencyVersion(packageJson, "@wp-typia/block-runtime") ===
+        "string" &&
+        typeof getExistingDependencyVersion(packageJson, "@wp-typia/block-types") ===
+            "string";
+    return hasSyncSurface && hasRuntimeDeps;
+}
+function buildPlannedFiles(layoutKind) {
+    const plannedFiles = [
+        {
+            path: "scripts/sync-types-to-block-json.ts",
+            purpose: "Generate block.json and Typia metadata artifacts from the current TypeScript source of truth.",
+        },
+        {
+            path: "scripts/sync-project.ts",
+            purpose: "Provide one shared sync entrypoint that can grow into sync-rest or workspace-aware refresh steps later.",
+        },
+    ];
+    if (layoutKind === "unsupported") {
+        plannedFiles.unshift({
+            path: "package.json",
+            purpose: "Add the minimum wp-typia devDependencies and scripts once the project matches a supported retrofit layout.",
+        });
+    }
+    return plannedFiles;
+}
+function buildChangeSummary(changes) {
+    const lines = [];
+    for (const dependencyChange of changes.packageChanges.addDevDependencies) {
+        lines.push(`devDependency ${dependencyChange.action} ${dependencyChange.name} -> ${dependencyChange.requiredValue}`);
+    }
+    if (changes.packageChanges.packageManagerField) {
+        lines.push(`packageManager ${changes.packageChanges.packageManagerField.action} -> ${changes.packageChanges.packageManagerField.requiredValue}`);
+    }
+    for (const scriptChange of changes.packageChanges.scripts) {
+        lines.push(`script ${scriptChange.action} ${scriptChange.name} -> ${scriptChange.requiredValue}`);
+    }
+    for (const filePlan of changes.plannedFiles) {
+        lines.push(`file add ${filePlan.path} (${filePlan.purpose})`);
+    }
+    for (const artifactPath of changes.generatedArtifacts) {
+        lines.push(`generated artifact ${artifactPath}`);
+    }
+    return lines;
+}
+function buildNextSteps(options) {
+    const cliSpecifier = getWpTypiaCliSpecifier();
+    const syncTypesRun = formatRunScript(options.packageManager, "sync-types");
+    const syncRun = formatRunScript(options.packageManager, "sync");
+    const doctorRun = formatPackageExecCommand(options.packageManager, cliSpecifier, "doctor");
+    const migrationInitRun = formatPackageExecCommand(options.packageManager, cliSpecifier, "migrate init --current-migration-version v1");
+    const dependencyInstallCommand = formatAddDevDependenciesCommand(options.packageManager, buildRequiredDevDependencyMapEntries());
+    if (options.layoutKind === "unsupported") {
+        return [
+            "Align the project to one of the supported retrofit layouts listed below, then rerun `wp-typia init`.",
+            dependencyInstallCommand,
+            syncTypesRun,
+            doctorRun,
+        ];
+    }
+    const steps = [
+        ...(options.changeSummaryLines.length > 0
+            ? [
+                "Apply the planned package.json changes and helper files listed below.",
+                dependencyInstallCommand,
+            ]
+            : []),
+        syncRun,
+        doctorRun,
+        `Optional migration bootstrap: ${migrationInitRun}`,
+    ];
+    return steps;
+}
+function buildRequiredDevDependencyMapEntries() {
+    return Object.entries(buildRequiredDevDependencyMap()).map(([name, version]) => `${name}@${version.replace(/^workspace:/u, "")}`);
+}
+export function getInitPlan(projectDir) {
+    const resolvedProjectDir = path.resolve(projectDir);
+    const packageJson = readProjectPackageJson(resolvedProjectDir);
+    const packageManager = inferInitPackageManager(resolvedProjectDir, packageJson);
+    const workspace = tryResolveWorkspaceProject(resolvedProjectDir);
+    if (workspace) {
+        return {
+            commandMode: "preview-only",
+            detectedLayout: {
+                blockNames: [],
+                description: "Already an official wp-typia workspace.",
+                kind: "official-workspace",
+            },
+            generatedArtifacts: [],
+            nextSteps: [
+                formatPackageExecCommand(packageManager, getWpTypiaCliSpecifier(), "doctor"),
+                "Use `wp-typia add ...` to extend this workspace instead of rerunning init.",
+            ],
+            notes: [
+                "The official workspace template already owns inventory, doctor, and add-command workflows.",
+            ],
+            packageChanges: {
+                addDevDependencies: [],
+                scripts: [],
+            },
+            plannedFiles: [],
+            packageManager,
+            projectDir: workspace.projectDir,
+            projectName: workspace.packageName,
+            status: "already-initialized",
+            summary: "This directory is already an official wp-typia workspace. No retrofit bootstrap is needed.",
+        };
+    }
+    const projectName = typeof packageJson?.name === "string" && packageJson.name.length > 0
+        ? packageJson.name
+        : path.basename(resolvedProjectDir);
+    const layout = buildLayoutDetails(resolvedProjectDir);
+    const dependencyChanges = buildDependencyChanges(packageJson);
+    const scriptChanges = buildScriptChanges(packageJson, packageManager);
+    const packageManagerFieldChange = buildPackageManagerFieldChange(packageJson, packageManager);
+    const rawPlannedFiles = layout.kind === "generated-project" || layout.kind === "official-workspace"
+        ? []
+        : buildPlannedFiles(layout.kind);
+    const hasExistingSurface = hasExistingWpTypiaProjectSurface(packageJson);
+    const status = hasExistingSurface &&
+        dependencyChanges.length === 0 &&
+        scriptChanges.length === 0 &&
+        packageManagerFieldChange === undefined
+        ? "already-initialized"
+        : "preview";
+    const plannedFiles = status === "already-initialized" ? [] : rawPlannedFiles;
+    const detectedLayout = status === "already-initialized" && hasExistingSurface
+        ? {
+            blockNames: layout.blockNames,
+            description: layout.kind === "unsupported"
+                ? "Already exposes the minimum wp-typia sync surface."
+                : `Already exposes the minimum wp-typia sync surface for ${layout.kind === "multi-block" ? "a multi-block project" : "a single-block project"}.`,
+            kind: "generated-project",
+        }
+        : {
+            blockNames: layout.blockNames,
+            description: layout.description,
+            kind: layout.kind,
+        };
+    const plan = {
+        commandMode: "preview-only",
+        detectedLayout,
+        generatedArtifacts: status === "already-initialized" && detectedLayout.kind === "generated-project"
+            ? []
+            : layout.generatedArtifacts,
+        nextSteps: buildNextSteps({
+            changeSummaryLines: buildChangeSummary({
+                generatedArtifacts: status === "already-initialized" &&
+                    detectedLayout.kind === "generated-project"
+                    ? []
+                    : layout.generatedArtifacts,
+                packageChanges: {
+                    addDevDependencies: dependencyChanges,
+                    ...(packageManagerFieldChange
+                        ? { packageManagerField: packageManagerFieldChange }
+                        : {}),
+                    scripts: scriptChanges,
+                },
+                plannedFiles,
+            }),
+            layoutKind: detectedLayout.kind,
+            packageManager,
+        }),
+        notes: Array.from(new Set([
+            "Preview only: `wp-typia init` does not write files yet.",
+            ...layout.notes,
+        ])),
+        packageChanges: {
+            addDevDependencies: dependencyChanges,
+            ...(packageManagerFieldChange
+                ? { packageManagerField: packageManagerFieldChange }
+                : {}),
+            scripts: scriptChanges,
+        },
+        plannedFiles,
+        packageManager,
+        projectDir: resolvedProjectDir,
+        projectName,
+        status,
+        summary: status === "already-initialized"
+            ? "This project already exposes the minimum wp-typia retrofit surface."
+            : "This command previews the minimum wp-typia adoption layer for the current project without rewriting it into a full scaffold.",
+    };
+    return plan;
+}

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

@@ -18,6 +18,7 @@ interface GetOptionalOnboardingOptions {
 }
 interface OptionalOnboardingGuidance {
     note: string;
+    shortNote: string;
     steps: string[];
 }
 export interface ScaffoldDryRunPlan {

package/dist/runtime/cli-scaffold.js

@@ -7,7 +7,7 @@ import { parseCompoundInnerBlocksPreset } from "./compound-inner-blocks.js";
 import { formatInstallCommand, formatRunScript, } from "./package-managers.js";
 import { getPrimaryDevelopmentScript } from "./local-dev-presets.js";
 import { createManagedTempRoot } from "./temp-roots.js";
-import { getOptionalOnboardingNote, getOptionalOnboardingSteps, } from "./scaffold-onboarding.js";
+import { getOptionalOnboardingNote, getOptionalOnboardingShortNote, getOptionalOnboardingSteps, } from "./scaffold-onboarding.js";
 import { formatNonEmptyTargetDirectoryError } from "./scaffold-bootstrap.js";
 import { OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE, isBuiltInTemplateId, } from "./template-registry.js";
 import { resolveOptionalInteractiveExternalLayerId, } from "./external-layer-selection.js";
@@ -254,6 +254,10 @@ export function getOptionalOnboarding({ availableScripts, packageManager, templa
             availableScripts,
             compoundPersistenceEnabled,
         }),
+        shortNote: getOptionalOnboardingShortNote(packageManager, templateId, {
+            availableScripts,
+            compoundPersistenceEnabled,
+        }),
         steps: getOptionalOnboardingSteps(packageManager, templateId, {
             availableScripts,
             compoundPersistenceEnabled,

package/dist/runtime/cli-templates.js

@@ -1,5 +1,4 @@
-import { OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE, getTemplateById, getTemplateSelectOptions, isBuiltInTemplateId, listTemplates, } from "./template-registry.js";
-const WORKSPACE_TEMPLATE_ALIAS = "workspace";
+import { OFFICIAL_WORKSPACE_TEMPLATE_ALIAS, OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE, getUserFacingTemplateId, getTemplateById, getTemplateSelectOptions, isBuiltInTemplateId, listTemplates, } from "./template-registry.js";
 /**
  * Format one line of template list output for a built-in template.
  *
@@ -7,7 +6,7 @@ const WORKSPACE_TEMPLATE_ALIAS = "workspace";
  * @returns One-line summary text for `templates list`.
  */
 export function formatTemplateSummary(template) {
-    return `${template.id.padEnd(14)} ${template.description}`;
+    return `${getUserFacingTemplateId(template.id).padEnd(14)} ${template.description}`;
 }
 /**
  * Format the feature and capability hint lines shown under a template summary.
@@ -17,6 +16,10 @@ export function formatTemplateSummary(template) {
  */
 export function formatTemplateFeatures(template) {
     const lines = [`  Features: ${template.features.join(" • ")}`];
+    const bestForHint = getTemplateBestForHint(template);
+    if (bestForHint) {
+        lines.push(`  Best for: ${bestForHint}`);
+    }
     const capabilityHints = getTemplateCapabilityHints(template);
     if (capabilityHints.length > 0) {
         lines.push(`  Supports: ${capabilityHints.join(" • ")}`);
@@ -26,7 +29,7 @@ export function formatTemplateFeatures(template) {
         lines.push(`  Notes: ${specialNotes.join(" • ")}`);
     }
     if (template.id === OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE) {
-        lines.push(`  Alias: ${WORKSPACE_TEMPLATE_ALIAS} (\`--template ${WORKSPACE_TEMPLATE_ALIAS}\`)`);
+        lines.push(`  Alias: ${OFFICIAL_WORKSPACE_TEMPLATE_ALIAS} (\`--template ${OFFICIAL_WORKSPACE_TEMPLATE_ALIAS}\`)`);
     }
     return lines.join("\n");
 }
@@ -43,8 +46,9 @@ export function formatTemplateFeatures(template) {
  */
 export function formatTemplateDetails(template) {
     const detailLines = [
-        template.id,
+        getUserFacingTemplateId(template.id),
         `Summary: ${template.description}`,
+        `Best for: ${getTemplateBestForHint(template)}`,
         ...getTemplateIdentityLines(template),
         `Category: ${template.defaultCategory}`,
     ];
@@ -69,6 +73,24 @@ export function formatTemplateDetails(template) {
     detailLines.push(`Features: ${template.features.join(", ")}`);
     return detailLines.join("\n");
 }
+function getTemplateBestForHint(template) {
+    if (template.id === "basic") {
+        return "minimal static-first block scaffolds with Typia validation and the lightest default surface";
+    }
+    if (template.id === "interactivity") {
+        return "interactive single-block experiences that keep client-side state and actions inside one scaffold";
+    }
+    if (template.id === "persistence") {
+        return "typed REST-backed blocks that need persistence-aware reads, writes, and schema refresh workflows";
+    }
+    if (template.id === "compound") {
+        return "parent-and-child block families that own nested authoring conventions and optional persistence wiring";
+    }
+    if (template.id === "query-loop") {
+        return "create-time `core/query` variations with connected starter patterns instead of `add block` families";
+    }
+    return "official multi-block workspaces that extend through `wp-typia add ...` and workspace doctor flows";
+}
 function getTemplateCapabilityHints(template) {
     if (template.id === "persistence" || template.id === "compound") {
         return [
@@ -99,11 +121,19 @@ function getTemplateIdentityLines(template) {
     if (template.id === OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE) {
         return [
             "Identity:",
+            `  - User-facing alias: ${OFFICIAL_WORKSPACE_TEMPLATE_ALIAS} (\`--template ${OFFICIAL_WORKSPACE_TEMPLATE_ALIAS}\`)`,
             `  - Official package: ${OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE}`,
-            `  - Alias: ${WORKSPACE_TEMPLATE_ALIAS} (\`--template ${WORKSPACE_TEMPLATE_ALIAS}\`)`,
             "Type: official workspace scaffold",
         ];
     }
+    if (template.id === "query-loop") {
+        return [
+            "Identity:",
+            "  - Built-in template id: query-loop",
+            "Type: create-time core/query variation scaffold",
+            "Output model: variation-only scaffold; does not generate block.json or Typia manifests",
+        ];
+    }
     return [
         "Identity:",
         `  - Built-in template id: ${template.id}`,

package/dist/runtime/external-template-guards.d.ts

@@ -0,0 +1,31 @@
+export declare const TEMPLATE_SOURCE_TIMEOUT_CODE: "template-source-timeout";
+export declare const TEMPLATE_SOURCE_TOO_LARGE_CODE: "template-source-too-large";
+export declare function getExternalTemplateTimeoutMs(): number;
+export declare function getExternalTemplateConfigMaxBytes(): number;
+export declare function getExternalTemplatePackageJsonMaxBytes(): number;
+export declare function getExternalTemplateMetadataMaxBytes(): number;
+export declare function getExternalTemplateTarballMaxBytes(): number;
+export declare function createExternalTemplateTimeoutError(label: string, timeoutMs: number): Error & {
+    code: typeof TEMPLATE_SOURCE_TIMEOUT_CODE;
+};
+export declare function createExternalTemplateTooLargeError(label: string, maxBytes: number): Error & {
+    code: typeof TEMPLATE_SOURCE_TOO_LARGE_CODE;
+};
+export declare function assertExternalTemplateFileSize(filePath: string, options: {
+    label: string;
+    maxBytes: number;
+}): void;
+export declare function withExternalTemplateTimeout<T>(label: string, task: Promise<T> | (() => Promise<T>), timeoutMs?: number): Promise<T>;
+export declare function fetchWithExternalTemplateTimeout(input: string, options: {
+    init?: RequestInit;
+    label: string;
+    timeoutMs?: number;
+}): Promise<Response>;
+export declare function readJsonResponseWithLimit(response: Response, options: {
+    label: string;
+    maxBytes: number;
+}): Promise<Record<string, unknown>>;
+export declare function readBufferResponseWithLimit(response: Response, options: {
+    label: string;
+    maxBytes: number;
+}): Promise<Buffer>;