@wp-typia/project-tools 0.23.1 → 0.24.0

package/dist/runtime/cli-add-workspace-rest-php-templates.js

@@ -1,125 +1,7 @@
 import { quotePhpString } from "./php-utils.js";
 import { toTitleCase } from "./string-case.js";
-function buildRestResourceRouteRegistrations(restResourceSlug, methods, functions, options) {
-    const collectionRoutes = [];
-    const itemRoutes = [];
-    const readPermissionCallback = options.permissionCallback
-        ? quotePhpString(options.permissionCallback)
-        : quotePhpString("__return_true");
-    const writePermissionCallback = options.permissionCallback
-        ? quotePhpString(options.permissionCallback)
-        : options.controllerVariableName
-            ? `array( ${options.controllerVariableName}, 'can_manage_rest_resource' )`
-            : quotePhpString(functions.canWriteFunctionName);
-    const buildRouteCallback = (functionName, methodName) => options.controllerVariableName
-        ? `array( ${options.controllerVariableName}, '${methodName}' )`
-        : quotePhpString(functionName);
-    if (methods.includes("list")) {
-        collectionRoutes.push(`\t\tarray(
-\t\t\t'methods'             => WP_REST_Server::READABLE,
-\t\t\t'callback'            => ${buildRouteCallback(functions.listHandlerName, "list_items")},
-\t\t\t'permission_callback' => ${readPermissionCallback},
-\t\t)`);
-    }
-    if (methods.includes("create")) {
-        collectionRoutes.push(`\t\tarray(
-\t\t\t'methods'             => WP_REST_Server::CREATABLE,
-\t\t\t'callback'            => ${buildRouteCallback(functions.createHandlerName, "create_item")},
-\t\t\t'permission_callback' => ${writePermissionCallback},
-\t\t)`);
-    }
-    if (methods.includes("read")) {
-        itemRoutes.push(`\t\tarray(
-\t\t\t'methods'             => WP_REST_Server::READABLE,
-\t\t\t'callback'            => ${buildRouteCallback(functions.readHandlerName, "read_item")},
-\t\t\t'permission_callback' => ${readPermissionCallback},
-\t\t)`);
-    }
-    if (methods.includes("update")) {
-        itemRoutes.push(`\t\tarray(
-\t\t\t'methods'             => WP_REST_Server::EDITABLE,
-\t\t\t'callback'            => ${buildRouteCallback(functions.updateHandlerName, "update_item")},
-\t\t\t'permission_callback' => ${writePermissionCallback},
-\t\t)`);
-    }
-    if (methods.includes("delete")) {
-        itemRoutes.push(`\t\tarray(
-\t\t\t'methods'             => WP_REST_Server::DELETABLE,
-\t\t\t'callback'            => ${buildRouteCallback(functions.deleteHandlerName, "delete_item")},
-\t\t\t'permission_callback' => ${writePermissionCallback},
-\t\t)`);
-    }
-    const registrations = [];
-    if (collectionRoutes.length > 0) {
-        registrations.push(`\tregister_rest_route(
-\t\t$namespace,
-\t\t'/${restResourceSlug}',
-\t\tarray(
-${collectionRoutes.join(",\n")}
-\t\t)
-\t);`);
-    }
-    if (itemRoutes.length > 0) {
-        registrations.push(`\tregister_rest_route(
-\t\t$namespace,
-\t\t${quotePhpString(options.routePattern)},
-\t\tarray(
-${itemRoutes.join(",\n")}
-\t\t)
-\t);`);
-    }
-    return registrations.join("\n\n");
-}
-function normalizeGlobalPhpClassName(classReference) {
-    const normalized = classReference.startsWith("\\")
-        ? classReference.slice(1)
-        : classReference;
-    return /^[A-Za-z_][A-Za-z0-9_]*$/u.test(normalized) ? normalized : undefined;
-}
-function toPhpClassConstantReference(classReference) {
-    const normalized = classReference.startsWith("\\")
-        ? classReference
-        : `\\${classReference}`;
-    return `${normalized}::class`;
-}
-function buildRestResourceControllerClassSource(options) {
-    const controllerClassName = normalizeGlobalPhpClassName(options.controllerClass);
-    if (!controllerClassName) {
-        return "";
-    }
-    const extendsClause = options.controllerExtends
-        ? ` extends ${options.controllerExtends.startsWith("\\") ? options.controllerExtends : `\\${options.controllerExtends}`}`
-        : "";
-    return `
-if ( ! class_exists( ${quotePhpString(controllerClassName)} ) ) {
-\tclass ${controllerClassName}${extendsClause} {
-\t\tpublic function can_manage_rest_resource() {
-\t\t\treturn ${options.functions.canWriteFunctionName}();
-\t\t}
-
-\t\tpublic function list_items( WP_REST_Request $request ) {
-\t\t\treturn ${options.functions.listHandlerName}( $request );
-\t\t}
-
-\t\tpublic function read_item( WP_REST_Request $request ) {
-\t\t\treturn ${options.functions.readHandlerName}( $request );
-\t\t}
-
-\t\tpublic function create_item( WP_REST_Request $request ) {
-\t\t\treturn ${options.functions.createHandlerName}( $request );
-\t\t}
-
-\t\tpublic function update_item( WP_REST_Request $request ) {
-\t\t\treturn ${options.functions.updateHandlerName}( $request );
-\t\t}
-
-\t\tpublic function delete_item( WP_REST_Request $request ) {
-\t\t\treturn ${options.functions.deleteHandlerName}( $request );
-\t\t}
-\t}
-}
-`;
-}
+import { buildRestResourceControllerBootstrapSource, buildRestResourceControllerClassSource, buildRestResourceRouteRegistrations, } from "./cli-add-workspace-rest-resource-php-routing-template.js";
+export { buildWorkspaceRestSchemaHelperPhpSource, } from "./cli-add-workspace-rest-schema-helper-php-template.js";
 /**
  * Build the PHP route/controller glue for generated workspace REST resources.
  *
@@ -176,15 +58,7 @@ export function buildRestResourcePhpSource(restResourceSlug, namespace, phpPrefi
             },
         })
         : "";
-    const controllerBootstrapSource = options.controllerClass
-        ? `\t\t$controller_class = ${toPhpClassConstantReference(options.controllerClass)};
-\t\tif ( ! class_exists( $controller_class ) ) {
-\t\t\treturn;
-\t\t}
-\t\t$controller = new $controller_class();
-
-`
-        : "";
+    const controllerBootstrapSource = buildRestResourceControllerBootstrapSource(options.controllerClass);
     return `<?php
 if ( ! defined( 'ABSPATH' ) ) {
 \treturn;
@@ -483,196 +357,3 @@ ${routeRegistrations}
 add_action( 'rest_api_init', '${registerRoutesFunctionName}' );
 `;
 }
-/**
- * Build the shared PHP helper loaded by workspace bootstraps for generated REST schemas.
- *
- * @param phpPrefix Plugin-scoped PHP function prefix.
- * @returns PHP source for `inc/rest-schema.php`.
- */
-export function buildWorkspaceRestSchemaHelperPhpSource(phpPrefix) {
-    return `<?php
-if ( ! defined( 'ABSPATH' ) ) {
-\treturn;
-}
-
-if ( ! function_exists( '${phpPrefix}_is_valid_rest_schema_key' ) ) {
-\tfunction ${phpPrefix}_is_valid_rest_schema_key( $value ) {
-\t\treturn is_string( $value ) && 1 === preg_match( '/\\A[A-Za-z0-9_-]+\\z/', $value );
-\t}
-}
-
-if ( ! function_exists( '${phpPrefix}_is_valid_rest_resource_slug' ) ) {
-\tfunction ${phpPrefix}_is_valid_rest_resource_slug( $value ) {
-\t\treturn is_string( $value ) && 1 === preg_match( '/\\A[a-z0-9]+(?:-[a-z0-9]+)*\\z/', $value );
-\t}
-}
-
-if ( ! function_exists( '${phpPrefix}_resolve_rest_schema_paths' ) ) {
-\tfunction ${phpPrefix}_resolve_rest_schema_paths( $schema_name, $options = array() ) {
-\t\tif ( ! ${phpPrefix}_is_valid_rest_schema_key( $schema_name ) ) {
-\t\t\treturn new WP_Error(
-\t\t\t\t'invalid_rest_schema_name',
-\t\t\t\t'Invalid REST schema name.',
-\t\t\t\tarray( 'status' => 500 )
-\t\t\t);
-\t\t}
-
-\t\t$options      = is_array( $options ) ? $options : array();
-\t\t$project_root = dirname( __DIR__ );
-\t\t$paths        = array();
-
-\t\tif ( isset( $options['resource'] ) && '' !== $options['resource'] ) {
-\t\t\tif ( ! ${phpPrefix}_is_valid_rest_resource_slug( $options['resource'] ) ) {
-\t\t\t\treturn new WP_Error(
-\t\t\t\t\t'invalid_rest_schema_resource',
-\t\t\t\t\t'Invalid REST schema resource slug.',
-\t\t\t\t\tarray( 'status' => 500 )
-\t\t\t\t);
-\t\t\t}
-
-\t\t\t$resource_slug = $options['resource'];
-\t\t\t$paths[]       = __DIR__ . '/rest-schemas/rest/' . $resource_slug . '/' . $schema_name . '.schema.json';
-\t\t\t$paths[]       = $project_root . '/src/rest/' . $resource_slug . '/api-schemas/' . $schema_name . '.schema.json';
-\t\t}
-
-\t\tif ( isset( $options['paths'] ) && is_array( $options['paths'] ) ) {
-\t\t\tforeach ( $options['paths'] as $schema_path ) {
-\t\t\t\tif ( is_string( $schema_path ) && '' !== $schema_path && ! in_array( $schema_path, $paths, true ) ) {
-\t\t\t\t\t$paths[] = $schema_path;
-\t\t\t\t}
-\t\t\t}
-\t\t}
-
-\t\treturn $paths;
-\t}
-}
-
-if ( ! function_exists( '${phpPrefix}_load_rest_schema' ) ) {
-\tfunction ${phpPrefix}_load_rest_schema( $schema_name, $options = array() ) {
-\t\t$schema_paths = ${phpPrefix}_resolve_rest_schema_paths( $schema_name, $options );
-\t\tif ( is_wp_error( $schema_paths ) ) {
-\t\t\treturn $schema_paths;
-\t\t}
-
-\t\tforeach ( $schema_paths as $schema_path ) {
-\t\t\tif ( ! is_file( $schema_path ) ) {
-\t\t\t\tcontinue;
-\t\t\t}
-
-\t\t\tif ( ! is_readable( $schema_path ) ) {
-\t\t\t\treturn new WP_Error(
-\t\t\t\t\t'unreadable_rest_schema',
-\t\t\t\t\t'Generated REST schema is not readable.',
-\t\t\t\t\tarray(
-\t\t\t\t\t\t'path'   => $schema_path,
-\t\t\t\t\t\t'status' => 500,
-\t\t\t\t\t)
-\t\t\t\t);
-\t\t\t}
-
-\t\t\t$schema_json = file_get_contents( $schema_path );
-\t\t\tif ( false === $schema_json ) {
-\t\t\t\treturn new WP_Error(
-\t\t\t\t\t'rest_schema_read_failed',
-\t\t\t\t\t'Generated REST schema could not be read.',
-\t\t\t\t\tarray(
-\t\t\t\t\t\t'path'   => $schema_path,
-\t\t\t\t\t\t'status' => 500,
-\t\t\t\t\t)
-\t\t\t\t);
-\t\t\t}
-
-\t\t\t$decoded = json_decode( $schema_json, true );
-\t\t\tif ( ! is_array( $decoded ) ) {
-\t\t\t\treturn new WP_Error(
-\t\t\t\t\t'malformed_rest_schema',
-\t\t\t\t\t'Generated REST schema contains malformed JSON.',
-\t\t\t\t\tarray(
-\t\t\t\t\t\t'json_error' => json_last_error_msg(),
-\t\t\t\t\t\t'path'       => $schema_path,
-\t\t\t\t\t\t'status'     => 500,
-\t\t\t\t\t)
-\t\t\t\t);
-\t\t\t}
-
-\t\t\treturn $decoded;
-\t\t}
-
-\t\treturn new WP_Error(
-\t\t\t'missing_rest_schema',
-\t\t\t'Generated REST schema could not be found.',
-\t\t\tarray(
-\t\t\t\t'paths'  => $schema_paths,
-\t\t\t\t'schema' => $schema_name,
-\t\t\t\t'status' => 500,
-\t\t\t)
-\t\t);
-\t}
-}
-
-if ( ! function_exists( '${phpPrefix}_prepare_rest_schema_for_wordpress' ) ) {
-\tfunction ${phpPrefix}_prepare_rest_schema_for_wordpress( $schema ) {
-\t\tif ( ! is_array( $schema ) ) {
-\t\t\treturn $schema;
-\t\t}
-
-\t\tunset( $schema['$schema'], $schema['title'] );
-
-\t\tforeach ( array( 'properties', 'patternProperties', 'definitions', '$defs' ) as $schema_map_key ) {
-\t\t\tif ( ! isset( $schema[ $schema_map_key ] ) || ! is_array( $schema[ $schema_map_key ] ) ) {
-\t\t\t\tcontinue;
-\t\t\t}
-
-\t\t\tforeach ( $schema[ $schema_map_key ] as $key => $property_schema ) {
-\t\t\t\t$schema[ $schema_map_key ][ $key ] = ${phpPrefix}_prepare_rest_schema_for_wordpress( $property_schema );
-\t\t\t}
-\t\t}
-
-\t\tforeach ( array( 'items', 'additionalProperties', 'contains', 'propertyNames', 'not', 'if', 'then', 'else' ) as $nested_schema_key ) {
-\t\t\tif ( isset( $schema[ $nested_schema_key ] ) && is_array( $schema[ $nested_schema_key ] ) ) {
-\t\t\t\t$schema[ $nested_schema_key ] = ${phpPrefix}_prepare_rest_schema_for_wordpress( $schema[ $nested_schema_key ] );
-\t\t\t}
-\t\t}
-
-\t\tforeach ( array( 'allOf', 'anyOf', 'oneOf' ) as $schema_list_key ) {
-\t\t\tif ( ! isset( $schema[ $schema_list_key ] ) || ! is_array( $schema[ $schema_list_key ] ) ) {
-\t\t\t\tcontinue;
-\t\t\t}
-
-\t\t\tforeach ( $schema[ $schema_list_key ] as $index => $variant_schema ) {
-\t\t\t\t$schema[ $schema_list_key ][ $index ] = ${phpPrefix}_prepare_rest_schema_for_wordpress( $variant_schema );
-\t\t\t}
-\t\t}
-
-\t\treturn $schema;
-\t}
-}
-
-if ( ! function_exists( '${phpPrefix}_get_wordpress_rest_schema' ) ) {
-\tfunction ${phpPrefix}_get_wordpress_rest_schema( $schema_name, $options = array() ) {
-\t\t$schema = ${phpPrefix}_load_rest_schema( $schema_name, $options );
-\t\tif ( is_wp_error( $schema ) ) {
-\t\t\treturn $schema;
-\t\t}
-
-\t\treturn ${phpPrefix}_prepare_rest_schema_for_wordpress( $schema );
-\t}
-}
-
-if ( ! function_exists( '${phpPrefix}_validate_and_sanitize_rest_payload' ) ) {
-\tfunction ${phpPrefix}_validate_and_sanitize_rest_payload( $value, $schema_name, $param_name, $options = array() ) {
-\t\t$rest_schema = ${phpPrefix}_get_wordpress_rest_schema( $schema_name, $options );
-\t\tif ( is_wp_error( $rest_schema ) ) {
-\t\t\treturn $rest_schema;
-\t\t}
-
-\t\t$validation = rest_validate_value_from_schema( $value, $rest_schema, $param_name );
-\t\tif ( is_wp_error( $validation ) ) {
-\t\t\treturn $validation;
-\t\t}
-
-\t\treturn rest_sanitize_value_from_schema( $value, $rest_schema, $param_name );
-\t}
-}
-`;
-}

package/dist/runtime/cli-add-workspace-rest-resource-php-routing-template.d.ts

@@ -0,0 +1,33 @@
+import { type RestResourceMethodId } from "./cli-add-shared.js";
+export interface RestResourcePhpFunctionNames {
+    canWriteFunctionName: string;
+    createHandlerName: string;
+    deleteHandlerName: string;
+    listHandlerName: string;
+    readHandlerName: string;
+    updateHandlerName: string;
+}
+/**
+ * Build the `register_rest_route` calls for generated REST resource PHP files.
+ */
+export declare function buildRestResourceRouteRegistrations(restResourceSlug: string, methods: RestResourceMethodId[], functions: RestResourcePhpFunctionNames, options: {
+    controllerVariableName?: string;
+    permissionCallback?: string;
+    routePattern: string;
+}): string;
+/**
+ * Normalize a configured PHP class name into a global `::class` reference.
+ */
+export declare function toPhpClassConstantReference(classReference: string): string;
+/**
+ * Build an optional controller shim class for generated REST resource handlers.
+ */
+export declare function buildRestResourceControllerClassSource(options: {
+    controllerClass: string;
+    controllerExtends?: string;
+    functions: RestResourcePhpFunctionNames;
+}): string;
+/**
+ * Build the controller instantiation block used inside REST route registration.
+ */
+export declare function buildRestResourceControllerBootstrapSource(controllerClass: string | undefined): string;

package/dist/runtime/cli-add-workspace-rest-resource-php-routing-template.js

@@ -0,0 +1,145 @@
+import { quotePhpString } from "./php-utils.js";
+/**
+ * Build the `register_rest_route` calls for generated REST resource PHP files.
+ */
+export function buildRestResourceRouteRegistrations(restResourceSlug, methods, functions, options) {
+    const collectionRoutes = [];
+    const itemRoutes = [];
+    const readPermissionCallback = options.permissionCallback
+        ? quotePhpString(options.permissionCallback)
+        : quotePhpString("__return_true");
+    const writePermissionCallback = options.permissionCallback
+        ? quotePhpString(options.permissionCallback)
+        : options.controllerVariableName
+            ? `array( ${options.controllerVariableName}, 'can_manage_rest_resource' )`
+            : quotePhpString(functions.canWriteFunctionName);
+    const buildRouteCallback = (functionName, methodName) => options.controllerVariableName
+        ? `array( ${options.controllerVariableName}, '${methodName}' )`
+        : quotePhpString(functionName);
+    if (methods.includes("list")) {
+        collectionRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::READABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.listHandlerName, "list_items")},
+\t\t\t'permission_callback' => ${readPermissionCallback},
+\t\t)`);
+    }
+    if (methods.includes("create")) {
+        collectionRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::CREATABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.createHandlerName, "create_item")},
+\t\t\t'permission_callback' => ${writePermissionCallback},
+\t\t)`);
+    }
+    if (methods.includes("read")) {
+        itemRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::READABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.readHandlerName, "read_item")},
+\t\t\t'permission_callback' => ${readPermissionCallback},
+\t\t)`);
+    }
+    if (methods.includes("update")) {
+        itemRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::EDITABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.updateHandlerName, "update_item")},
+\t\t\t'permission_callback' => ${writePermissionCallback},
+\t\t)`);
+    }
+    if (methods.includes("delete")) {
+        itemRoutes.push(`\t\tarray(
+\t\t\t'methods'             => WP_REST_Server::DELETABLE,
+\t\t\t'callback'            => ${buildRouteCallback(functions.deleteHandlerName, "delete_item")},
+\t\t\t'permission_callback' => ${writePermissionCallback},
+\t\t)`);
+    }
+    const registrations = [];
+    if (collectionRoutes.length > 0) {
+        registrations.push(`\tregister_rest_route(
+\t\t$namespace,
+\t\t'/${restResourceSlug}',
+\t\tarray(
+${collectionRoutes.join(",\n")}
+\t\t)
+\t);`);
+    }
+    if (itemRoutes.length > 0) {
+        registrations.push(`\tregister_rest_route(
+\t\t$namespace,
+\t\t${quotePhpString(options.routePattern)},
+\t\tarray(
+${itemRoutes.join(",\n")}
+\t\t)
+\t);`);
+    }
+    return registrations.join("\n\n");
+}
+function normalizeGlobalPhpClassName(classReference) {
+    const normalized = classReference.startsWith("\\")
+        ? classReference.slice(1)
+        : classReference;
+    return /^[A-Za-z_][A-Za-z0-9_]*$/u.test(normalized) ? normalized : undefined;
+}
+/**
+ * Normalize a configured PHP class name into a global `::class` reference.
+ */
+export function toPhpClassConstantReference(classReference) {
+    const normalized = classReference.startsWith("\\")
+        ? classReference
+        : `\\${classReference}`;
+    return `${normalized}::class`;
+}
+/**
+ * Build an optional controller shim class for generated REST resource handlers.
+ */
+export function buildRestResourceControllerClassSource(options) {
+    const controllerClassName = normalizeGlobalPhpClassName(options.controllerClass);
+    if (!controllerClassName) {
+        return "";
+    }
+    const extendsClause = options.controllerExtends
+        ? ` extends ${options.controllerExtends.startsWith("\\") ? options.controllerExtends : `\\${options.controllerExtends}`}`
+        : "";
+    return `
+if ( ! class_exists( ${quotePhpString(controllerClassName)} ) ) {
+\tclass ${controllerClassName}${extendsClause} {
+\t\tpublic function can_manage_rest_resource() {
+\t\t\treturn ${options.functions.canWriteFunctionName}();
+\t\t}
+
+\t\tpublic function list_items( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.listHandlerName}( $request );
+\t\t}
+
+\t\tpublic function read_item( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.readHandlerName}( $request );
+\t\t}
+
+\t\tpublic function create_item( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.createHandlerName}( $request );
+\t\t}
+
+\t\tpublic function update_item( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.updateHandlerName}( $request );
+\t\t}
+
+\t\tpublic function delete_item( WP_REST_Request $request ) {
+\t\t\treturn ${options.functions.deleteHandlerName}( $request );
+\t\t}
+\t}
+}
+`;
+}
+/**
+ * Build the controller instantiation block used inside REST route registration.
+ */
+export function buildRestResourceControllerBootstrapSource(controllerClass) {
+    if (!controllerClass) {
+        return "";
+    }
+    return `\t\t$controller_class = ${toPhpClassConstantReference(controllerClass)};
+\t\tif ( ! class_exists( $controller_class ) ) {
+\t\t\treturn;
+\t\t}
+\t\t$controller = new $controller_class();
+
+`;
+}

package/dist/runtime/cli-add-workspace-rest-resource-sync-anchors.d.ts

@@ -0,0 +1,9 @@
+import type { WorkspaceProject } from "./workspace-project.js";
+/**
+ * Ensure sync-rest can repair and validate plugin-level REST resources.
+ *
+ * @param workspace Workspace project whose sync-rest script should be patched.
+ * @returns A promise that resolves after the sync-rest script is updated.
+ * @throws When the generated sync-rest anchors cannot be found.
+ */
+export declare function ensureRestResourceSyncScriptAnchors(workspace: WorkspaceProject): Promise<void>;