@wp-typia/project-tools 0.23.0 → 0.23.1

package/dist/runtime/cli-add-workspace-rest-source-emitters.d.ts

@@ -34,13 +34,17 @@ export declare function buildRestResourceConfigEntry(options: {
 export declare function buildManualRestContractConfigEntry(options: {
     auth: ManualRestContractAuthId;
     bodyTypeName?: string;
+    controllerClass?: string;
+    controllerExtends?: string;
     method: ManualRestContractHttpMethodId;
     namespace: string;
     pathPattern: string;
+    permissionCallback?: string;
     queryTypeName: string;
     responseTypeName: string;
     restResourceSlug: string;
     secretFieldName?: string;
+    secretPreserveOnEmpty?: boolean;
     secretStateFieldName?: string;
 }): string;
 /**
@@ -48,6 +52,8 @@ export declare function buildManualRestContractConfigEntry(options: {
  *
  * @param options Manual contract type naming metadata.
  * @param options.bodyTypeName Optional exported body type name.
+ * @param options.pathParameterNames Route named captures that should be present
+ * in the starter query type so generated clients can fill provider paths.
  * @param options.queryTypeName Exported query type name.
  * @param options.responseTypeName Exported response type name.
  * @param options.restResourceSlug Normalized workspace REST contract slug.
@@ -57,10 +63,12 @@ export declare function buildManualRestContractConfigEntry(options: {
  */
 export declare function buildManualRestContractTypesSource(options: {
     bodyTypeName?: string;
+    pathParameterNames?: string[];
     queryTypeName: string;
     responseTypeName: string;
     restResourceSlug: string;
     secretFieldName?: string;
+    secretPreserveOnEmpty?: boolean;
     secretStateFieldName?: string;
 }): string;
 /**

package/dist/runtime/cli-add-workspace-rest-source-emitters.js

@@ -93,12 +93,21 @@ export function buildManualRestContractConfigEntry(options) {
             ? [`\t\tbodyTypeName: ${quoteTsString(options.bodyTypeName)},`]
             : []),
         `\t\tclientFile: ${quoteTsString(`src/rest/${options.restResourceSlug}/api-client.ts`)},`,
+        ...(options.controllerClass
+            ? [`\t\tcontrollerClass: ${quoteTsString(options.controllerClass)},`]
+            : []),
+        ...(options.controllerExtends
+            ? [`\t\tcontrollerExtends: ${quoteTsString(options.controllerExtends)},`]
+            : []),
         `\t\tmethod: ${quoteTsString(options.method)},`,
         "\t\tmethods: [],",
         "\t\tmode: 'manual',",
         `\t\tnamespace: ${quoteTsString(options.namespace)},`,
         `\t\topenApiFile: ${quoteTsString(`src/rest/${options.restResourceSlug}/api.openapi.json`)},`,
         `\t\tpathPattern: ${quoteTsString(options.pathPattern)},`,
+        ...(options.permissionCallback
+            ? [`\t\tpermissionCallback: ${quoteTsString(options.permissionCallback)},`]
+            : []),
         `\t\tqueryTypeName: ${quoteTsString(options.queryTypeName)},`,
         "\t\trestManifest: defineEndpointManifest(",
         indentMultiline(JSON.stringify(manifest, null, "\t"), "\t\t\t"),
@@ -107,6 +116,9 @@ export function buildManualRestContractConfigEntry(options) {
         ...(options.secretFieldName
             ? [`\t\tsecretFieldName: ${quoteTsString(options.secretFieldName)},`]
             : []),
+        ...(options.secretPreserveOnEmpty !== undefined
+            ? [`\t\tsecretPreserveOnEmpty: ${options.secretPreserveOnEmpty},`]
+            : []),
         ...(options.secretStateFieldName
             ? [`\t\tsecretStateFieldName: ${quoteTsString(options.secretStateFieldName)},`]
             : []),
@@ -121,6 +133,8 @@ export function buildManualRestContractConfigEntry(options) {
  *
  * @param options Manual contract type naming metadata.
  * @param options.bodyTypeName Optional exported body type name.
+ * @param options.pathParameterNames Route named captures that should be present
+ * in the starter query type so generated clients can fill provider paths.
  * @param options.queryTypeName Exported query type name.
  * @param options.responseTypeName Exported response type name.
  * @param options.restResourceSlug Normalized workspace REST contract slug.
@@ -130,19 +144,26 @@ export function buildManualRestContractConfigEntry(options) {
  */
 export function buildManualRestContractTypesSource(options) {
     const title = toTitleCase(options.restResourceSlug);
+    const pathParameterNames = Array.from(new Set(options.pathParameterNames ?? []));
+    const queryFields = pathParameterNames.length > 0
+        ? pathParameterNames.map((parameterName) => `\t${parameterName}: string & tags.MinLength< 1 >;`)
+        : ["\tid?: string & tags.MinLength< 1 >;"];
     const lines = [
         "import type { tags } from '@wp-typia/block-runtime/typia-tags';",
         "",
         `export interface ${options.queryTypeName} {`,
-        "\tid?: string & tags.MinLength< 1 >;",
-        "\tpreview?: boolean;",
+        ...queryFields,
+        ...(pathParameterNames.includes("preview") ? [] : ["\tpreview?: boolean;"]),
         "}",
     ];
     if (options.bodyTypeName) {
+        const secretPreserveOnEmpty = options.secretPreserveOnEmpty ?? true;
         const secretLines = options.secretFieldName && options.secretStateFieldName
             ? [
-                `\t${options.secretFieldName}?: string & tags.MinLength< 1 > & tags.MaxLength< 4096 > & tags.Secret< ${quoteTsString(options.secretStateFieldName)} >;`,
-                `\t// ${options.secretFieldName} is write-only: persist it server-side and expose ${options.secretStateFieldName} in responses instead of returning the raw value.`,
+                `\t${options.secretFieldName}?: string${secretPreserveOnEmpty ? " & tags.MinLength< 1 >" : ""} & tags.MaxLength< 4096 > & tags.Secret< ${quoteTsString(options.secretStateFieldName)} >${secretPreserveOnEmpty ? " & tags.PreserveOnEmpty< true >" : ""};`,
+                secretPreserveOnEmpty
+                    ? `\t// ${options.secretFieldName} is write-only: omit or submit an empty value to preserve the stored secret, and expose ${options.secretStateFieldName} in responses instead of returning the raw value.`
+                    : `\t// ${options.secretFieldName} is write-only: persist it server-side and expose ${options.secretStateFieldName} in responses instead of returning the raw value.`,
             ]
             : [];
         lines.push("", `export interface ${options.bodyTypeName} {`, ...secretLines, "\tpayload: string & tags.MinLength< 1 >;", "\tcomment?: string & tags.MaxLength< 500 >;", "}");

package/dist/runtime/cli-add-workspace-rest-types.d.ts

@@ -0,0 +1,108 @@
+import type { ManualRestContractAuthId, ManualRestContractHttpMethodId, RestResourceMethodId } from "./cli-add-shared.js";
+import type { WorkspaceProject } from "./workspace-project.js";
+/**
+ * Normalized metadata returned after `wp-typia add rest-resource` completes.
+ *
+ * @property auth Manual-mode authentication policy when `mode` is `"manual"`.
+ * @property bodyTypeName Optional manual-mode request body type export.
+ * @property controllerClass Optional PHP controller class reference. Generated
+ * mode uses it for callbacks; manual mode records it as route-owner metadata.
+ * @property methods Generated-mode REST operation ids, or an empty array for
+ * manual contracts.
+ * @property mode Whether the scaffold wrote generated REST glue or a type-only
+ * manual contract.
+ * @property namespace REST namespace in `vendor/v1` format.
+ * @property projectDir Absolute workspace project directory.
+ * @property restResourceSlug Normalized kebab-case REST resource slug.
+ * @property secretPreserveOnEmpty Whether blank settings secret submissions
+ * should preserve the stored value when `secretFieldName` is set.
+ */
+export interface RunAddRestResourceCommandResult {
+    auth?: ManualRestContractAuthId;
+    bodyTypeName?: string;
+    controllerClass?: string;
+    controllerExtends?: string;
+    method?: ManualRestContractHttpMethodId;
+    methods: RestResourceMethodId[];
+    mode: "generated" | "manual";
+    namespace: string;
+    permissionCallback?: string;
+    pathPattern?: string;
+    projectDir: string;
+    queryTypeName?: string;
+    restResourceSlug: string;
+    responseTypeName?: string;
+    routePattern?: string;
+    secretFieldName?: string;
+    secretHasValueFieldName?: string;
+    secretMaskedResponseFieldName?: string;
+    secretPreserveOnEmpty?: boolean;
+    secretStateFieldName?: string;
+}
+/**
+ * Raw command options passed from the REST orchestrator into manual-mode
+ * contract scaffolding.
+ *
+ * @property auth Optional raw manual authentication id, validated before use.
+ * @property bodyTypeName Optional exported request body type name.
+ * @property method Optional raw HTTP method id, validated as a manual REST
+ * contract method.
+ * @property namespace Resolved REST namespace in `vendor/v1` format.
+ * @property pathPattern Optional manual route path pattern relative to the
+ * namespace.
+ * @property permissionCallback Optional manual route-owner permission callback
+ * metadata.
+ * @property restResourceSlug Normalized kebab-case REST resource slug.
+ * @property routePattern Optional manual route path alias for `pathPattern`.
+ * @property secretHasValueFieldName Optional alias for `secretStateFieldName`.
+ * @property secretMaskedResponseFieldName Optional alias for
+ * `secretStateFieldName`.
+ * @property secretFieldName Optional write-only request secret field.
+ * @property secretPreserveOnEmpty Optional true/false string or boolean for
+ * blank-secret preservation. Defaults to true when `secretFieldName` is set.
+ * @property workspace Resolved official workspace project.
+ */
+export interface ManualRestContractScaffoldOptions {
+    auth: string | undefined;
+    bodyTypeName: string | undefined;
+    controllerClass: string | undefined;
+    controllerExtends: string | undefined;
+    method: string | undefined;
+    namespace: string;
+    pathPattern: string | undefined;
+    permissionCallback: string | undefined;
+    queryTypeName: string | undefined;
+    responseTypeName: string | undefined;
+    restResourceSlug: string;
+    routePattern: string | undefined;
+    secretFieldName: string | undefined;
+    secretHasValueFieldName: string | undefined;
+    secretMaskedResponseFieldName: string | undefined;
+    secretPreserveOnEmpty: boolean | string | undefined;
+    secretStateFieldName: string | undefined;
+    workspace: WorkspaceProject;
+}
+/**
+ * Raw command options passed from the REST orchestrator into generated-mode
+ * resource scaffolding.
+ *
+ * @property controllerClass Optional PHP controller class reference.
+ * @property controllerExtends Optional PHP base class reference; requires
+ * `controllerClass`.
+ * @property methods Optional comma-separated REST method list validated into
+ * `RestResourceMethodId` values.
+ * @property namespace Resolved REST namespace in `vendor/v1` format.
+ * @property permissionCallback Optional PHP permission callback reference.
+ * @property restResourceSlug Normalized kebab-case REST resource slug.
+ * @property workspace Resolved official workspace project.
+ */
+export interface GeneratedRestResourceScaffoldOptions {
+    controllerClass: string | undefined;
+    controllerExtends: string | undefined;
+    methods: string | undefined;
+    namespace: string;
+    permissionCallback: string | undefined;
+    restResourceSlug: string;
+    routePattern: string | undefined;
+    workspace: WorkspaceProject;
+}

package/dist/runtime/cli-add-workspace-rest-types.js

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,5 @@
-import { type ManualRestContractAuthId, type ManualRestContractHttpMethodId, type RestResourceMethodId, type RunAddRestResourceCommandOptions } from "./cli-add-shared.js";
+import { type RunAddRestResourceCommandOptions } from "./cli-add-shared.js";
+import { type RunAddRestResourceCommandResult } from "./cli-add-workspace-rest-types.js";
 /**
  * Scaffold a workspace-level REST resource and synchronize its generated
  * TypeScript and PHP artifacts.
@@ -6,22 +7,4 @@ import { type ManualRestContractAuthId, type ManualRestContractHttpMethodId, typ
  * @param options Command options for the REST resource scaffold workflow.
  * @returns Resolved scaffold metadata for the created REST resource.
  */
-export declare function runAddRestResourceCommand({ auth, bodyTypeName, controllerClass, controllerExtends, cwd, manual, method, methods, namespace, permissionCallback, pathPattern, queryTypeName, restResourceName, responseTypeName, routePattern, secretFieldName, secretStateFieldName, }: RunAddRestResourceCommandOptions): Promise<{
-    auth?: ManualRestContractAuthId;
-    bodyTypeName?: string;
-    controllerClass?: string;
-    controllerExtends?: string;
-    method?: ManualRestContractHttpMethodId;
-    methods: RestResourceMethodId[];
-    mode: "generated" | "manual";
-    namespace: string;
-    permissionCallback?: string;
-    pathPattern?: string;
-    projectDir: string;
-    queryTypeName?: string;
-    restResourceSlug: string;
-    responseTypeName?: string;
-    routePattern?: string;
-    secretFieldName?: string;
-    secretStateFieldName?: string;
-}>;
+export declare function runAddRestResourceCommand({ auth, bodyTypeName, controllerClass, controllerExtends, cwd, manual, method, methods, namespace, permissionCallback, pathPattern, queryTypeName, restResourceName, responseTypeName, routePattern, secretFieldName, secretHasValueFieldName, secretMaskedResponseFieldName, secretPreserveOnEmpty, secretStateFieldName, }: RunAddRestResourceCommandOptions): Promise<RunAddRestResourceCommandResult>;