@wp-typia/project-tools 0.21.0 → 0.22.1

package/dist/runtime/cli-add-workspace-admin-view-scaffold.js

@@ -0,0 +1,257 @@
+import fs from 'node:fs';
+import { promises as fsp } from 'node:fs';
+import path from 'node:path';
+import { appendWorkspaceInventoryEntries, readWorkspaceInventory, } from './workspace-inventory.js';
+import { buildAdminViewConfigEntry, buildAdminViewConfigSource, buildAdminViewEntrySource, buildAdminViewPhpSource, buildAdminViewRegistrySource, buildAdminViewScreenSource, buildAdminViewStyleSource, buildAdminViewTypesSource, buildCoreDataAdminViewDataSource, buildCoreDataAdminViewScreenSource, buildDefaultAdminViewDataSource, buildRestAdminViewDataSource, } from './cli-add-workspace-admin-view-templates.js';
+import { ADMIN_VIEWS_PHP_GLOB, isAdminViewCoreDataSource, } from './cli-add-workspace-admin-view-types.js';
+import { getWorkspaceBootstrapPath, patchFile, rollbackWorkspaceMutation, snapshotWorkspaceFiles, } from './cli-add-shared.js';
+import { DEFAULT_WORDPRESS_CORE_DATA_VERSION, DEFAULT_WORDPRESS_DATA_VERSION, DEFAULT_WORDPRESS_DATAVIEWS_VERSION, DEFAULT_WP_TYPIA_DATAVIEWS_VERSION, resolveManagedPackageVersionRange, } from './package-versions.js';
+import { findPhpFunctionRange, hasPhpFunctionDefinition, replacePhpFunctionDefinition, } from './php-utils.js';
+function detectJsonIndent(source) {
+    const indentMatch = /\n([ \t]+)"/u.exec(source);
+    return indentMatch?.[1] ?? 2;
+}
+async function ensureAdminViewPackageDependencies(workspace, adminViewSource) {
+    const packageJsonPath = path.join(workspace.projectDir, 'package.json');
+    const wpTypiaDataViewsVersion = resolveManagedPackageVersionRange({
+        fallback: DEFAULT_WP_TYPIA_DATAVIEWS_VERSION,
+        packageName: '@wp-typia/dataviews',
+        workspacePackageDirName: 'wp-typia-dataviews',
+    });
+    const wordpressDataViewsVersion = resolveManagedPackageVersionRange({
+        fallback: DEFAULT_WORDPRESS_DATAVIEWS_VERSION,
+        packageName: '@wordpress/dataviews',
+    });
+    const wordpressCoreDataVersion = resolveManagedPackageVersionRange({
+        fallback: DEFAULT_WORDPRESS_CORE_DATA_VERSION,
+        packageName: '@wordpress/core-data',
+    });
+    const wordpressDataVersion = resolveManagedPackageVersionRange({
+        fallback: DEFAULT_WORDPRESS_DATA_VERSION,
+        packageName: '@wordpress/data',
+    });
+    await patchFile(packageJsonPath, (source) => {
+        const packageJson = JSON.parse(source);
+        const coreDataDependencies = isAdminViewCoreDataSource(adminViewSource)
+            ? {
+                '@wordpress/core-data': packageJson.dependencies?.['@wordpress/core-data'] ??
+                    wordpressCoreDataVersion,
+                '@wordpress/data': packageJson.dependencies?.['@wordpress/data'] ??
+                    wordpressDataVersion,
+            }
+            : {};
+        const nextDependencies = {
+            ...(packageJson.dependencies ?? {}),
+            '@wordpress/dataviews': packageJson.dependencies?.['@wordpress/dataviews'] ??
+                wordpressDataViewsVersion,
+            ...coreDataDependencies,
+        };
+        const nextDevDependencies = {
+            ...(packageJson.devDependencies ?? {}),
+            '@wp-typia/dataviews': packageJson.devDependencies?.['@wp-typia/dataviews'] ??
+                wpTypiaDataViewsVersion,
+        };
+        if (JSON.stringify(nextDependencies) ===
+            JSON.stringify(packageJson.dependencies ?? {}) &&
+            JSON.stringify(nextDevDependencies) ===
+                JSON.stringify(packageJson.devDependencies ?? {})) {
+            return source;
+        }
+        packageJson.dependencies = nextDependencies;
+        packageJson.devDependencies = nextDevDependencies;
+        return `${JSON.stringify(packageJson, null, detectJsonIndent(source))}\n`;
+    });
+}
+async function ensureAdminViewBootstrapAnchors(workspace) {
+    const bootstrapPath = getWorkspaceBootstrapPath(workspace);
+    await patchFile(bootstrapPath, (source) => {
+        let nextSource = source;
+        const loadFunctionName = `${workspace.workspace.phpPrefix}_load_admin_views`;
+        const loadHook = `add_action( 'plugins_loaded', '${loadFunctionName}' );`;
+        const loadHookPattern = new RegExp(`add_action\\(\\s*['"]plugins_loaded['"]\\s*,\\s*['"]${loadFunctionName}['"]\\s*\\)\\s*;`, 'u');
+        const loadFunction = `
+
+function ${loadFunctionName}() {
+\tforeach ( glob( __DIR__ . '${ADMIN_VIEWS_PHP_GLOB}' ) ?: array() as $admin_view_module ) {
+\t\trequire_once $admin_view_module;
+\t}
+}
+`;
+        const insertionAnchors = [
+            /add_action\(\s*["']init["']\s*,\s*["'][^"']+_load_textdomain["']\s*\);\s*\n/u,
+            /\?>\s*$/u,
+        ];
+        const insertPhpSnippet = (snippet) => {
+            for (const anchor of insertionAnchors) {
+                const candidate = nextSource.replace(anchor, (match) => `${snippet}\n${match}`);
+                if (candidate !== nextSource) {
+                    nextSource = candidate;
+                    return;
+                }
+            }
+            nextSource = `${nextSource.trimEnd()}\n${snippet}\n`;
+        };
+        const appendPhpSnippet = (snippet) => {
+            const closingTagPattern = /\?>\s*$/u;
+            if (closingTagPattern.test(nextSource)) {
+                nextSource = nextSource.replace(closingTagPattern, `${snippet}\n?>`);
+                return;
+            }
+            nextSource = `${nextSource.trimEnd()}\n${snippet}\n`;
+        };
+        if (!hasPhpFunctionDefinition(nextSource, loadFunctionName)) {
+            insertPhpSnippet(loadFunction);
+        }
+        else {
+            const functionRange = findPhpFunctionRange(nextSource, loadFunctionName);
+            const functionSource = functionRange
+                ? nextSource.slice(functionRange.start, functionRange.end)
+                : '';
+            if (!functionSource.includes(ADMIN_VIEWS_PHP_GLOB)) {
+                const replacedSource = replacePhpFunctionDefinition(nextSource, loadFunctionName, loadFunction);
+                if (!replacedSource) {
+                    throw new Error(`Unable to repair ${path.basename(bootstrapPath)} for ${loadFunctionName}.`);
+                }
+                nextSource = replacedSource;
+            }
+        }
+        if (!loadHookPattern.test(nextSource)) {
+            appendPhpSnippet(loadHook);
+        }
+        return nextSource;
+    });
+}
+async function ensureAdminViewBuildScriptAnchors(workspace) {
+    const buildScriptPath = path.join(workspace.projectDir, 'scripts', 'build-workspace.mjs');
+    await patchFile(buildScriptPath, (source) => {
+        if (/['"]src\/admin-views\/index\.(?:ts|js)['"]/u.test(source)) {
+            return source;
+        }
+        const currentSharedEntriesPattern = /(\r?\n\s*['"]src\/editor-plugins\/index\.js['"])\s*,?/u;
+        let nextSource = source.replace(currentSharedEntriesPattern, `$1,
+\t\t'src/admin-views/index.ts',
+\t\t'src/admin-views/index.js',`);
+        if (nextSource !== source) {
+            return nextSource;
+        }
+        const legacySharedEntriesPattern = /\[\s*['"]src\/bindings\/index\.ts['"]\s*,\s*['"]src\/bindings\/index\.js['"]\s*(?:,\s*)?\]/u;
+        nextSource = source.replace(legacySharedEntriesPattern, `[
+\t\t'src/bindings/index.ts',
+\t\t'src/bindings/index.js',
+\t\t'src/editor-plugins/index.ts',
+\t\t'src/editor-plugins/index.js',
+\t\t'src/admin-views/index.ts',
+\t\t'src/admin-views/index.js',
+\t]`);
+        if (nextSource !== source) {
+            return nextSource;
+        }
+        throw new Error(`Unable to update ${path.relative(workspace.projectDir, buildScriptPath)} for admin view shared entries.`);
+    });
+}
+async function ensureAdminViewWebpackAnchors(workspace) {
+    const webpackConfigPath = path.join(workspace.projectDir, 'webpack.config.js');
+    await patchFile(webpackConfigPath, (source) => {
+        if (/['"]admin-views\/index['"]/u.test(source)) {
+            return source;
+        }
+        const editorPluginEntryPattern = /(\n\s*\[\s*['"]editor-plugins\/index['"][\s\S]*?['"]src\/editor-plugins\/index\.js['"][\s\S]*?\]\s*\])\s*,?/u;
+        let nextSource = source.replace(editorPluginEntryPattern, `$1,
+\t\t[
+\t\t\t'admin-views/index',
+\t\t\t[ 'src/admin-views/index.ts', 'src/admin-views/index.js' ],
+\t\t],`);
+        if (nextSource !== source) {
+            return nextSource;
+        }
+        const legacySharedEntriesBlockPattern = /for\s*\(\s*const\s+relativePath\s+of\s+\[\s*['"]src\/bindings\/index\.ts['"]\s*,\s*['"]src\/bindings\/index\.js['"]\s*(?:,\s*)?\]\s*\)\s*\{[\s\S]*?entries\.push\(\s*\[\s*['"]bindings\/index['"]\s*,\s*entryPath\s*\]\s*\);\s*break;\s*\}/u;
+        const nextSharedEntriesBlock = `\tfor ( const [ entryName, candidates ] of [\n\t\t[\n\t\t\t'bindings/index',\n\t\t\t[ 'src/bindings/index.ts', 'src/bindings/index.js' ],\n\t\t],\n\t\t[\n\t\t\t'editor-plugins/index',\n\t\t\t[ 'src/editor-plugins/index.ts', 'src/editor-plugins/index.js' ],\n\t\t],\n\t\t[\n\t\t\t'admin-views/index',\n\t\t\t[ 'src/admin-views/index.ts', 'src/admin-views/index.js' ],\n\t\t],\n\t] ) {\n\t\tfor ( const relativePath of candidates ) {\n\t\t\tconst entryPath = path.resolve( process.cwd(), relativePath );\n\t\t\tif ( ! fs.existsSync( entryPath ) ) {\n\t\t\t\tcontinue;\n\t\t\t}\n\n\t\t\tentries.push( [ entryName, entryPath ] );\n\t\t\tbreak;\n\t\t}\n\t}`;
+        nextSource = source.replace(legacySharedEntriesBlockPattern, nextSharedEntriesBlock);
+        if (nextSource === source) {
+            throw new Error(`Unable to update ${path.relative(workspace.projectDir, webpackConfigPath)} for admin view shared entries.`);
+        }
+        return nextSource;
+    });
+}
+function resolveAdminViewRegistryPath(projectDir) {
+    const adminViewsDir = path.join(projectDir, 'src', 'admin-views');
+    return ([
+        path.join(adminViewsDir, 'index.ts'),
+        path.join(adminViewsDir, 'index.js'),
+    ].find((candidatePath) => fs.existsSync(candidatePath)) ??
+        path.join(adminViewsDir, 'index.ts'));
+}
+function readAdminViewRegistrySlugs(registryPath) {
+    if (!fs.existsSync(registryPath)) {
+        return [];
+    }
+    const source = fs.readFileSync(registryPath, 'utf8');
+    return Array.from(source.matchAll(/^\s*import\s+['"]\.\/([^/'"]+)(?:\/index(?:\.[cm]?[jt]sx?)?)?['"];?\s*$/gmu)).map((match) => match[1]);
+}
+async function writeAdminViewRegistry(projectDir, adminViewSlug) {
+    const adminViewsDir = path.join(projectDir, 'src', 'admin-views');
+    const registryPath = resolveAdminViewRegistryPath(projectDir);
+    await fsp.mkdir(adminViewsDir, { recursive: true });
+    const existingAdminViewSlugs = readWorkspaceInventory(projectDir).adminViews.map((entry) => entry.slug);
+    const existingRegistrySlugs = readAdminViewRegistrySlugs(registryPath);
+    const nextAdminViewSlugs = Array.from(new Set([
+        ...existingAdminViewSlugs,
+        ...existingRegistrySlugs,
+        adminViewSlug,
+    ])).sort();
+    await fsp.writeFile(registryPath, buildAdminViewRegistrySource(nextAdminViewSlugs), 'utf8');
+}
+export async function scaffoldAdminViewWorkspace(options) {
+    const { adminViewSlug, coreDataSource, parsedSource, restResource, workspace, } = options;
+    const blockConfigPath = path.join(workspace.projectDir, 'scripts', 'block-config.ts');
+    const bootstrapPath = getWorkspaceBootstrapPath(workspace);
+    const buildScriptPath = path.join(workspace.projectDir, 'scripts', 'build-workspace.mjs');
+    const packageJsonPath = path.join(workspace.projectDir, 'package.json');
+    const webpackConfigPath = path.join(workspace.projectDir, 'webpack.config.js');
+    const adminViewsIndexPath = resolveAdminViewRegistryPath(workspace.projectDir);
+    const adminViewDir = path.join(workspace.projectDir, 'src', 'admin-views', adminViewSlug);
+    const adminViewPhpPath = path.join(workspace.projectDir, 'inc', 'admin-views', `${adminViewSlug}.php`);
+    const mutationSnapshot = {
+        fileSources: await snapshotWorkspaceFiles([
+            adminViewsIndexPath,
+            blockConfigPath,
+            bootstrapPath,
+            buildScriptPath,
+            packageJsonPath,
+            webpackConfigPath,
+        ]),
+        snapshotDirs: [],
+        targetPaths: [adminViewDir, adminViewPhpPath],
+    };
+    try {
+        await fsp.mkdir(adminViewDir, { recursive: true });
+        await fsp.mkdir(path.dirname(adminViewPhpPath), { recursive: true });
+        await ensureAdminViewPackageDependencies(workspace, parsedSource);
+        await ensureAdminViewBootstrapAnchors(workspace);
+        await ensureAdminViewBuildScriptAnchors(workspace);
+        await ensureAdminViewWebpackAnchors(workspace);
+        await fsp.writeFile(path.join(adminViewDir, 'types.ts'), buildAdminViewTypesSource(adminViewSlug, restResource, coreDataSource), 'utf8');
+        await fsp.writeFile(path.join(adminViewDir, 'config.ts'), buildAdminViewConfigSource(adminViewSlug, workspace.workspace.textDomain, parsedSource, restResource), 'utf8');
+        await fsp.writeFile(path.join(adminViewDir, 'data.ts'), coreDataSource
+            ? buildCoreDataAdminViewDataSource(adminViewSlug, coreDataSource)
+            : restResource
+                ? buildRestAdminViewDataSource(adminViewSlug, restResource)
+                : buildDefaultAdminViewDataSource(adminViewSlug), 'utf8');
+        await fsp.writeFile(path.join(adminViewDir, 'Screen.tsx'), coreDataSource
+            ? buildCoreDataAdminViewScreenSource(adminViewSlug, workspace.workspace.textDomain)
+            : buildAdminViewScreenSource(adminViewSlug, workspace.workspace.textDomain), 'utf8');
+        await fsp.writeFile(path.join(adminViewDir, 'index.tsx'), buildAdminViewEntrySource(adminViewSlug), 'utf8');
+        await fsp.writeFile(path.join(adminViewDir, 'style.scss'), buildAdminViewStyleSource(), 'utf8');
+        await fsp.writeFile(adminViewPhpPath, buildAdminViewPhpSource(adminViewSlug, workspace), 'utf8');
+        await writeAdminViewRegistry(workspace.projectDir, adminViewSlug);
+        await appendWorkspaceInventoryEntries(workspace.projectDir, {
+            adminViewEntries: [
+                buildAdminViewConfigEntry(adminViewSlug, parsedSource),
+            ],
+        });
+    }
+    catch (error) {
+        await rollbackWorkspaceMutation(mutationSnapshot);
+        throw error;
+    }
+}

package/dist/runtime/cli-add-workspace-admin-view-source.d.ts

@@ -0,0 +1,5 @@
+import { type AdminViewRestResource, type AdminViewSource } from './cli-add-workspace-admin-view-types.js';
+export declare function assertAdminViewPackageAvailability(): void;
+export declare function parseAdminViewSource(source?: string): AdminViewSource | undefined;
+export declare function resolveRestResourceSource(restResources: AdminViewRestResource[], source: AdminViewSource | undefined): AdminViewRestResource | undefined;
+export declare function resolveAdminViewCoreDataSource(source: AdminViewSource | undefined): import("./cli-add-workspace-admin-view-types.js").AdminViewCoreDataSource | undefined;

package/dist/runtime/cli-add-workspace-admin-view-source.js

@@ -0,0 +1,86 @@
+import { assertValidGeneratedSlug } from './cli-add-shared.js';
+import { CLI_DIAGNOSTIC_CODES, createCliDiagnosticCodeError, } from './cli-diagnostics.js';
+import { ADMIN_VIEW_ALLOW_UNPUBLISHED_DATAVIEWS_ENV, ADMIN_VIEW_CORE_DATA_ENTITY_KIND_IDS, ADMIN_VIEW_CORE_DATA_ENTITY_NAME_PATTERN, ADMIN_VIEW_CORE_DATA_ENTITY_SEGMENT_PATTERN, ADMIN_VIEW_CORE_DATA_SOURCE_KIND, ADMIN_VIEW_PUBLIC_INSTALLS_ENABLED, ADMIN_VIEW_REST_SOURCE_KIND, ADMIN_VIEW_SOURCE_USAGE, isAdminViewCoreDataSource, isAdminViewRestResourceSource, } from './cli-add-workspace-admin-view-types.js';
+function isAdminViewUnpublishedDataViewsOverrideEnabled() {
+    return (process.env[ADMIN_VIEW_ALLOW_UNPUBLISHED_DATAVIEWS_ENV]?.trim() === '1');
+}
+export function assertAdminViewPackageAvailability() {
+    if (isAdminViewUnpublishedDataViewsOverrideEnabled() ||
+        ADMIN_VIEW_PUBLIC_INSTALLS_ENABLED) {
+        return;
+    }
+    throw createCliDiagnosticCodeError(CLI_DIAGNOSTIC_CODES.INVALID_ARGUMENT, '`wp-typia add admin-view` is temporarily unavailable because `@wp-typia/dataviews` is not published to npm for public installs yet.');
+}
+function assertValidCoreDataEntitySegment(label, value) {
+    const trimmed = value.trim();
+    if (!trimmed) {
+        throw new Error(`${label} is required. Use \`${ADMIN_VIEW_SOURCE_USAGE}\`.`);
+    }
+    if (!ADMIN_VIEW_CORE_DATA_ENTITY_SEGMENT_PATTERN.test(trimmed)) {
+        throw new Error(`${label} must start with a letter and contain only letters, numbers, underscores, or hyphens.`);
+    }
+    return trimmed;
+}
+function assertValidCoreDataEntityName(value) {
+    const normalized = value.trim();
+    if (!normalized) {
+        throw new Error(`Admin view source entity name is required. Use \`${ADMIN_VIEW_SOURCE_USAGE}\`.`);
+    }
+    if (!ADMIN_VIEW_CORE_DATA_ENTITY_NAME_PATTERN.test(normalized)) {
+        throw new Error('Admin view source entity name must start with a lowercase letter or number and contain only lowercase letters, numbers, underscores, or hyphens.');
+    }
+    return normalized;
+}
+function assertValidCoreDataEntityKind(value) {
+    const normalized = assertValidCoreDataEntitySegment('Admin view source entity kind', value);
+    if (!ADMIN_VIEW_CORE_DATA_ENTITY_KIND_IDS.includes(normalized)) {
+        throw new Error(`Admin view core-data sources currently support only: ${ADMIN_VIEW_CORE_DATA_ENTITY_KIND_IDS.join(', ')}.`);
+    }
+    return normalized;
+}
+export function parseAdminViewSource(source) {
+    const trimmed = source?.trim();
+    if (!trimmed) {
+        return undefined;
+    }
+    const separatorIndex = trimmed.indexOf(':');
+    const kind = separatorIndex === -1 ? trimmed : trimmed.slice(0, separatorIndex);
+    const locator = separatorIndex === -1 ? '' : trimmed.slice(separatorIndex + 1);
+    if (!locator) {
+        throw new Error('Admin view source must use `rest-resource:<slug>` or `core-data:<kind>/<name>`.');
+    }
+    if (kind === ADMIN_VIEW_REST_SOURCE_KIND) {
+        return {
+            kind,
+            slug: assertValidGeneratedSlug('Admin view source slug', locator, ADMIN_VIEW_SOURCE_USAGE),
+        };
+    }
+    if (kind === ADMIN_VIEW_CORE_DATA_SOURCE_KIND) {
+        const [entityKind, entityName, extra] = locator.split('/');
+        if (!entityKind || !entityName || extra !== undefined) {
+            throw new Error('Admin view core-data sources must use `core-data:<kind>/<name>`, for example `core-data:postType/post`.');
+        }
+        return {
+            entityKind: assertValidCoreDataEntityKind(entityKind),
+            entityName: assertValidCoreDataEntityName(entityName),
+            kind,
+        };
+    }
+    throw new Error('Admin view source must use `rest-resource:<slug>` or `core-data:<kind>/<name>`.');
+}
+export function resolveRestResourceSource(restResources, source) {
+    if (!isAdminViewRestResourceSource(source)) {
+        return undefined;
+    }
+    const restResource = restResources.find((entry) => entry.slug === source.slug);
+    if (!restResource) {
+        throw new Error(`Unknown REST resource source "${source.slug}". Choose one of: ${restResources.map((entry) => entry.slug).join(', ') || '<none>'}.`);
+    }
+    if (!restResource.methods.includes('list')) {
+        throw new Error(`REST resource source "${source.slug}" must include the list method for DataViews pagination.`);
+    }
+    return restResource;
+}
+export function resolveAdminViewCoreDataSource(source) {
+    return isAdminViewCoreDataSource(source) ? source : undefined;
+}

package/dist/runtime/cli-add-workspace-admin-view-templates.d.ts

@@ -0,0 +1,23 @@
+import { type WorkspaceProject } from './workspace-project.js';
+import { type AdminViewCoreDataSource, type AdminViewRestResource, type AdminViewSource } from './cli-add-workspace-admin-view-types.js';
+export declare function buildAdminViewConfigEntry(adminViewSlug: string, source: AdminViewSource | undefined): string;
+export declare function buildAdminViewRegistrySource(adminViewSlugs: string[]): string;
+/**
+ * Build the generated admin-view item and dataset types for the selected source.
+ */
+export declare function buildAdminViewTypesSource(adminViewSlug: string, restResource: AdminViewRestResource | undefined, coreDataSource: AdminViewCoreDataSource | undefined): string;
+/**
+ * Build the generated DataViews config source for an admin-view scaffold.
+ */
+export declare function buildAdminViewConfigSource(adminViewSlug: string, textDomain: string, source: AdminViewSource | undefined, restResource: AdminViewRestResource | undefined): string;
+export declare function buildDefaultAdminViewDataSource(adminViewSlug: string): string;
+export declare function buildRestAdminViewDataSource(adminViewSlug: string, restResource: AdminViewRestResource): string;
+/**
+ * Build a core-data-backed admin-view data module for a supported entity family.
+ */
+export declare function buildCoreDataAdminViewDataSource(adminViewSlug: string, coreDataSource: AdminViewCoreDataSource): string;
+export declare function buildAdminViewScreenSource(adminViewSlug: string, textDomain: string): string;
+export declare function buildCoreDataAdminViewScreenSource(adminViewSlug: string, textDomain: string): string;
+export declare function buildAdminViewEntrySource(adminViewSlug: string): string;
+export declare function buildAdminViewStyleSource(): string;
+export declare function buildAdminViewPhpSource(adminViewSlug: string, workspace: WorkspaceProject): string;