@autobe/agent 0.30.0-dev.20260315 → 0.30.0

package/lib/orchestrate/interface/programmers/AutoBeInterfaceAuthorizationProgrammer.js

@@ -48,18 +48,18 @@ var AutoBeInterfaceAuthorizationProgrammer;
                 path: `${props.accessor}.authorizationActor`,
                 expected: JSON.stringify(props.actor.name),
                 value: props.operation.authorizationActor,
-                description: utils_1.StringUtil.trim `
-          The authorizationActor must match the actor associated with
-          this authorization operation.
-
-          If this is just a mistake, please change the value accordingly.
-          
-          Otherwise you actually made for another actor, please entirely
-          remake the operation for the correct actor. The other actor
-          was already defined elsewhere.
-
-          - Expected actor: ${JSON.stringify(props.actor.name)}
-          - Provided actor: ${JSON.stringify(props.operation.authorizationActor)}
+                description: utils_1.StringUtil.trim `
+          The authorizationActor must match the actor associated with
+          this authorization operation.
+
+          If this is just a mistake, please change the value accordingly.
+          
+          Otherwise you actually made for another actor, please entirely
+          remake the operation for the correct actor. The other actor
+          was already defined elsewhere.
+
+          - Expected actor: ${JSON.stringify(props.actor.name)}
+          - Provided actor: ${JSON.stringify(props.operation.authorizationActor)}
         `,
             });
         if (props.operation.authorizationType !== "join" &&
@@ -72,19 +72,19 @@ var AutoBeInterfaceAuthorizationProgrammer;
                 path: `${props.accessor}.parameters`,
                 expected: "[] // (empty array)",
                 value: props.operation.parameters,
-                description: utils_1.StringUtil.trim `
-          Authorization operations (join/login/refresh) cannot have 
-          path parameters. All necessary data must be provided in 
-          the request body.
-
-          Remove the parameters from the operation.
-
-          Also ensure the following properties are correct:
-
-          - AutoBeOpenApi.IOperation.specification
-          - AutoBeOpenApi.IOperation.description
-          - AutoBeOpenApi.IOperation.requestBody
-          - AutoBeOpenApi.IOperation.responseBody
+                description: utils_1.StringUtil.trim `
+          Authorization operations (join/login/refresh) cannot have 
+          path parameters. All necessary data must be provided in 
+          the request body.
+
+          Remove the parameters from the operation.
+
+          Also ensure the following properties are correct:
+
+          - AutoBeOpenApi.IOperation.specification
+          - AutoBeOpenApi.IOperation.description
+          - AutoBeOpenApi.IOperation.requestBody
+          - AutoBeOpenApi.IOperation.responseBody
         `,
             });
         // special authorization cases
@@ -103,16 +103,16 @@ var AutoBeInterfaceAuthorizationProgrammer;
                 path: `${props.accessor}.requestBody`,
                 expected: `AutoBeOpenApi.IRequestBody // typeName: ${requestTypeName}`,
                 value: props.operation.requestBody,
-                description: utils_1.StringUtil.trim `
-          Request body is required for authentication 
-          ${props.operation.authorizationType} operation.
-
-          Write the requestBody with typeName exactly "${requestTypeName}".
-
-          Also ensure the following properties are correct:
-          
-          - AutoBeOpenApi.IOperation.specification
-          - AutoBeOpenApi.IOperation.description
+                description: utils_1.StringUtil.trim `
+          Request body is required for authentication 
+          ${props.operation.authorizationType} operation.
+
+          Write the requestBody with typeName exactly "${requestTypeName}".
+
+          Also ensure the following properties are correct:
+          
+          - AutoBeOpenApi.IOperation.specification
+          - AutoBeOpenApi.IOperation.description
         `,
             });
         else if (props.operation.requestBody.typeName !== requestTypeName)
@@ -120,16 +120,16 @@ var AutoBeInterfaceAuthorizationProgrammer;
                 path: `${props.accessor}.requestBody.typeName`,
                 expected: `AutoBeOpenApi.IOperation with requestBody.typeName: ${requestTypeName}`,
                 value: props.operation.requestBody.typeName,
-                description: utils_1.StringUtil.trim `
-          Wrong request body type name: "${props.operation.requestBody.typeName}"
-
-          Fix the requestBody.typeName to exactly "${requestTypeName}".
-
-          Also ensure the following properties are correct:
-          
-          - AutoBeOpenApi.IOperation.specification
-          - AutoBeOpenApi.IOperation.description
-          - AutoBeOpenApi.IOperation.requestBody.description
+                description: utils_1.StringUtil.trim `
+          Wrong request body type name: "${props.operation.requestBody.typeName}"
+
+          Fix the requestBody.typeName to exactly "${requestTypeName}".
+
+          Also ensure the following properties are correct:
+          
+          - AutoBeOpenApi.IOperation.specification
+          - AutoBeOpenApi.IOperation.description
+          - AutoBeOpenApi.IOperation.requestBody.description
         `,
             });
         // validate response body
@@ -139,15 +139,15 @@ var AutoBeInterfaceAuthorizationProgrammer;
                 path: `${props.accessor}.responseBody`,
                 expected: `AutoBeOpenApi.IResponseBody // typeName: ${responseTypeName}`,
                 value: props.operation.responseBody,
-                description: utils_1.StringUtil.trim `
-          Response body is required for authentication ${props.operation.authorizationType} operation.
-
-          Write the responseBody with typeName exactly "${responseTypeName}".
-
-          Also ensure the following properties are correct:
-          
-          - AutoBeOpenApi.IOperation.specification
-          - AutoBeOpenApi.IOperation.description
+                description: utils_1.StringUtil.trim `
+          Response body is required for authentication ${props.operation.authorizationType} operation.
+
+          Write the responseBody with typeName exactly "${responseTypeName}".
+
+          Also ensure the following properties are correct:
+          
+          - AutoBeOpenApi.IOperation.specification
+          - AutoBeOpenApi.IOperation.description
         `,
             });
         else if (props.operation.responseBody.typeName !== responseTypeName)
@@ -155,15 +155,15 @@ var AutoBeInterfaceAuthorizationProgrammer;
                 path: `${props.accessor}.responseBody.typeName`,
                 expected: JSON.stringify(responseTypeName),
                 value: props.operation.responseBody.typeName,
-                description: utils_1.StringUtil.trim `
-          Wrong response body type name: "${props.operation.responseBody.typeName}"
-
-          Fix the responseBody.typeName to exactly "${responseTypeName}".
-          Also ensure the following properties are correct:
-
-          - AutoBeOpenApi.IOperation.specification
-          - AutoBeOpenApi.IOperation.description
-          - AutoBeOpenApi.IOperation.responseBody.description
+                description: utils_1.StringUtil.trim `
+          Wrong response body type name: "${props.operation.responseBody.typeName}"
+
+          Fix the responseBody.typeName to exactly "${responseTypeName}".
+          Also ensure the following properties are correct:
+
+          - AutoBeOpenApi.IOperation.specification
+          - AutoBeOpenApi.IOperation.description
+          - AutoBeOpenApi.IOperation.responseBody.description
         `,
             });
     };
@@ -184,22 +184,22 @@ var AutoBeInterfaceAuthorizationProgrammer;
                 props.errors.push({
                     path: props.accessor,
                     value: props.operations,
-                    expected: utils_1.StringUtil.trim `
-            {
-              ...(AutoBeOpenApi.IOperation data),
-              authorizationType: "${type}"
-            }
+                    expected: utils_1.StringUtil.trim `
+            {
+              ...(AutoBeOpenApi.IOperation data),
+              authorizationType: "${type}"
+            }
           `,
-                    description: utils_1.StringUtil.trim `
-            There must be an operation that has defined 
-            (AutoBeOpenApi.IOperation.authorizationType := "${type}")
-            for the "${props.actor.name}" role's authorization activity; "${type}".
-
-            However, none of the operations have the 
-            (AutoBeOpenApi.IOperation.authorizationType := "${type}") value, 
-            so that the "${props.actor.name}" cannot perform the authorization ${type} activity.
-
-            Please make that operation at the next function calling. You have to do it.
+                    description: utils_1.StringUtil.trim `
+            There must be an operation that has defined 
+            (AutoBeOpenApi.IOperation.authorizationType := "${type}")
+            for the "${props.actor.name}" role's authorization activity; "${type}".
+
+            However, none of the operations have the 
+            (AutoBeOpenApi.IOperation.authorizationType := "${type}") value, 
+            so that the "${props.actor.name}" cannot perform the authorization ${type} activity.
+
+            Please make that operation at the next function calling. You have to do it.
           `,
                 });
             else if (count > 1)
@@ -207,18 +207,18 @@ var AutoBeInterfaceAuthorizationProgrammer;
                     path: props.accessor,
                     value: props.operations,
                     expected: `Only one operation with authorizationType "${type}"`,
-                    description: utils_1.StringUtil.trim `
-            There must be only one operation that has defined 
-            (AutoBeOpenApi.IOperation.authorizationType := "${type}")
-            for the "${props.actor.name}" role's authorization activity; "${type}".
-
-            However, multiple operations (${count} operations) have the
-            (AutoBeOpenApi.IOperation.authorizationType := "${type}") value,
-            so that the "${props.actor.name}" cannot determine which operation to use
-            for the authorization ${type} activity.
-
-            Please ensure that only one operation is defined for each
-            authorizationType per actor.
+                    description: utils_1.StringUtil.trim `
+            There must be only one operation that has defined 
+            (AutoBeOpenApi.IOperation.authorizationType := "${type}")
+            for the "${props.actor.name}" role's authorization activity; "${type}".
+
+            However, multiple operations (${count} operations) have the
+            (AutoBeOpenApi.IOperation.authorizationType := "${type}") value,
+            so that the "${props.actor.name}" cannot determine which operation to use
+            for the authorization ${type} activity.
+
+            Please ensure that only one operation is defined for each
+            authorizationType per actor.
           `,
                 });
         }

package/lib/orchestrate/interface/programmers/AutoBeInterfaceEndpointProgrammer.js

@@ -98,12 +98,12 @@ var AutoBeInterfaceEndpointProgrammer;
                     path: `${props.path}.authorizationActors[${i}]`,
                     expected: props.actors.map((a) => JSON.stringify(a.name)).join(" | "),
                     value: actorName,
-                    description: utils_1.StringUtil.trim `
-            Actor "${actorName}" is not defined in the roles list.
-
-            Please select one of them below, or do not define (\`null\`):
-
-            ${props.actors.map((actor) => `- ${actor.name}`).join("\n")}
+                    description: utils_1.StringUtil.trim `
+            Actor "${actorName}" is not defined in the roles list.
+
+            Please select one of them below, or do not define (\`null\`):
+
+            ${props.actors.map((actor) => `- ${actor.name}`).join("\n")}
           `,
                 });
         });

package/lib/orchestrate/interface/programmers/AutoBeInterfaceEndpointReviewProgrammer.js

@@ -15,22 +15,22 @@ var AutoBeInterfaceEndpointReviewProgrammer;
                         path: `${props.path}[${i}].endpoint`,
                         expected: `An endpoint matching one of the provided designs (path + method)`,
                         value: revise.endpoint,
-                        description: utils_1.StringUtil.trim `
-              The endpoint referenced in this revision does not exist in the
-              provided designs list.
-
-              You can only use keep, update, or erase for endpoints that were
-              given to you for review. Check the path and method carefully -
-              they must match exactly.
-
-              If you want to add a new endpoint that doesn't exist yet, use the
-              "create" revision type instead.
-
-              Here are all valid endpoints you can reference:
-
-              | Method | Path |
-              |--------|------|
-              ${props.designs.map((d) => `| ${d.endpoint.method} | ${d.endpoint.path} |`).join("\n")}
+                        description: utils_1.StringUtil.trim `
+              The endpoint referenced in this revision does not exist in the
+              provided designs list.
+
+              You can only use keep, update, or erase for endpoints that were
+              given to you for review. Check the path and method carefully -
+              they must match exactly.
+
+              If you want to add a new endpoint that doesn't exist yet, use the
+              "create" revision type instead.
+
+              Here are all valid endpoints you can reference:
+
+              | Method | Path |
+              |--------|------|
+              ${props.designs.map((d) => `| ${d.endpoint.method} | ${d.endpoint.path} |`).join("\n")}
             `,
                     });
             }
@@ -67,15 +67,15 @@ var AutoBeInterfaceEndpointReviewProgrammer;
                     path: `${props.path}[]`,
                     value: undefined,
                     expected: `AutoBeInterfaceEndpointRevise (corresponding to the design with path: ${design.endpoint.path} and method: ${design.endpoint.method})`,
-                    description: utils_1.StringUtil.trim `
-            Every endpoint in the provided designs list MUST have a
-            corresponding revision.
-
-            You cannot omit any endpoint - if an endpoint is correct and needs
-            no changes, use the "keep" revision type to explicitly approve it.
-
-            This ensures complete review coverage with no accidentally skipped
-            endpoints.
+                    description: utils_1.StringUtil.trim `
+            Every endpoint in the provided designs list MUST have a
+            corresponding revision.
+
+            You cannot omit any endpoint - if an endpoint is correct and needs
+            no changes, use the "keep" revision type to explicitly approve it.
+
+            This ensures complete review coverage with no accidentally skipped
+            endpoints.
           `,
                 });
         }

package/lib/orchestrate/interface/programmers/AutoBeInterfaceOperationProgrammer.js

@@ -18,11 +18,11 @@ var AutoBeInterfaceOperationProgrammer;
                 path: `${props.accessor}.requestBody`,
                 expected: "null (GET method cannot have request body)",
                 value: props.operation.requestBody,
-                description: utils_1.StringUtil.trim `
-          GET method cannot have request body per HTTP specification.
-
-          Fix: Change method to "patch" for complex queries, 
-          or set requestBody to null.
+                description: utils_1.StringUtil.trim `
+          GET method cannot have request body per HTTP specification.
+
+          Fix: Change method to "patch" for complex queries, 
+          or set requestBody to null.
         `,
             });
         // operation name
@@ -31,12 +31,12 @@ var AutoBeInterfaceOperationProgrammer;
                 path: `${props.accessor}.name`,
                 expected: "<valid_variable_name>",
                 value: props.operation.name,
-                description: utils_1.StringUtil.trim `
-            Operation name "${props.operation.name}" is not a valid 
-            JavaScript variable name.
-            
-            It will be used as a controller method name, so it must be 
-            a valid identifier.
+                description: utils_1.StringUtil.trim `
+            Operation name "${props.operation.name}" is not a valid 
+            JavaScript variable name.
+            
+            It will be used as a controller method name, so it must be 
+            a valid identifier.
           `,
             });
         else if (props.operation.name === "index") {
@@ -45,12 +45,12 @@ var AutoBeInterfaceOperationProgrammer;
                     path: `${props.accessor}.method`,
                     expected: `"patch" when operation name is "index", or change operation name to something else`,
                     value: props.operation.method,
-                    description: utils_1.StringUtil.trim `
-            Operation name "index" is reserved for getting list of resources,
-            or pagination of the resources.
-            
-            Fix: Change method to "patch" when using "index" as operation name.
-            Otherwise, change operation name to something else.
+                    description: utils_1.StringUtil.trim `
+            Operation name "index" is reserved for getting list of resources,
+            or pagination of the resources.
+            
+            Fix: Change method to "patch" when using "index" as operation name.
+            Otherwise, change operation name to something else.
           `,
                 });
             if (props.operation.responseBody === null)
@@ -58,12 +58,12 @@ var AutoBeInterfaceOperationProgrammer;
                     path: `${props.accessor}.responseBody`,
                     expected: `AutoBeOpenApi.IResponseBody (typeName: "IPageIResource") when operation name is "index"`,
                     value: props.operation.responseBody,
-                    description: utils_1.StringUtil.trim `
-            Operation name "index" is reserved for getting list of resources,
-            so response body must be a paginated type "IPageIResource".
-
-            Fix: Change response body type to paginated type "IPageIResource",
-            or change operation name to something else.
+                    description: utils_1.StringUtil.trim `
+            Operation name "index" is reserved for getting list of resources,
+            so response body must be a paginated type "IPageIResource".
+
+            Fix: Change response body type to paginated type "IPageIResource",
+            or change operation name to something else.
           `,
                 });
             else if (props.operation.responseBody.typeName.startsWith("IPage") === false)
@@ -71,12 +71,12 @@ var AutoBeInterfaceOperationProgrammer;
                     path: `${props.accessor}.responseBody.typeName`,
                     expected: `"IPage${props.operation.responseBody.typeName}", or change operation name to something else`,
                     value: props.operation.responseBody.typeName,
-                    description: utils_1.StringUtil.trim `
-            Operation name "index" is reserved for getting list of resources,
-            so response body type must be paginated type "IPageIResource".
-
-            Fix: Change response body type to paginated type "IPage${props.operation.responseBody.typeName}",
-            or change operation name to something else.
+                    description: utils_1.StringUtil.trim `
+            Operation name "index" is reserved for getting list of resources,
+            so response body type must be paginated type "IPageIResource".
+
+            Fix: Change response body type to paginated type "IPage${props.operation.responseBody.typeName}",
+            or change operation name to something else.
           `,
                 });
         }
@@ -124,10 +124,10 @@ var AutoBeInterfaceOperationProgrammer;
                     path: `${props.accessor}.parameters[${i}]`,
                     expected: `removed, or expressed in AutoBeOpenApi.IOperation.path`,
                     value: p,
-                    description: utils_1.StringUtil.trim `
-            Parameter "${p.name}" is defined but not used in path "${props.operation.path}".
-
-            Fix: Remove parameter at index ${i}, or add {${p.name}} to the path.
+                    description: utils_1.StringUtil.trim `
+            Parameter "${p.name}" is defined but not used in path "${props.operation.path}".
+
+            Fix: Remove parameter at index ${i}, or add {${p.name}} to the path.
           `,
                 });
             parameterNames.add(p.name);
@@ -138,12 +138,12 @@ var AutoBeInterfaceOperationProgrammer;
                 path: `${props.accessor}.parameters`,
                 expected: `All parameter names must be unique`,
                 value: props.operation.parameters,
-                description: utils_1.StringUtil.trim `
-          Duplicate parameter names found: ${props.operation.parameters.length} parameters, but only ${parameterNames.size} unique names.
-
-          Parameters: ${props.operation.parameters.map((p, idx) => `[${idx}]="${p.name}"`).join(", ")}
-
-          Fix: Remove duplicate parameter definitions.
+                description: utils_1.StringUtil.trim `
+          Duplicate parameter names found: ${props.operation.parameters.length} parameters, but only ${parameterNames.size} unique names.
+
+          Parameters: ${props.operation.parameters.map((p, idx) => `[${idx}]="${p.name}"`).join(", ")}
+
+          Fix: Remove duplicate parameter definitions.
         `,
             });
         const symbols = props.operation.path
@@ -157,12 +157,12 @@ var AutoBeInterfaceOperationProgrammer;
                     path: `${props.accessor}.path`,
                     expected: `removed, or defined in AutoBeOpenApi.IOperation.parameters[]`,
                     value: s,
-                    description: utils_1.StringUtil.trim `
-            Path contains "{${s}}" but no corresponding parameter definition exists.
-
-            Current parameters: ${props.operation.parameters.length === 0 ? "[]" : `[${props.operation.parameters.map((p) => `"${p.name}"`).join(", ")}]`}
-
-            Fix: Add parameter definition for "${s}", or remove {${s}} from path.
+                    description: utils_1.StringUtil.trim `
+            Path contains "{${s}}" but no corresponding parameter definition exists.
+
+            Current parameters: ${props.operation.parameters.length === 0 ? "[]" : `[${props.operation.parameters.map((p) => `"${p.name}"`).join(", ")}]`}
+
+            Fix: Add parameter definition for "${s}", or remove {${s}} from path.
           `,
                 });
         });
@@ -173,15 +173,15 @@ var AutoBeInterfaceOperationProgrammer;
                 path: `${props.accessor}.path`,
                 expected: `All path parameter names must be unique`,
                 value: props.operation.path,
-                description: utils_1.StringUtil.trim `
-          Duplicate path parameter names: ${symbols.length} parameters, 
-          but only ${uniqueSymbols.size} unique names in "${props.operation.path}".
-
-          Path parameters: ${symbols.map((s, idx) => `[${idx}]="{${s}}"`).join(", ")}
-
-          Fix: Rename duplicate parameters to be unique. 
-          
-          (e.g., {userId} and {postId} instead of {userId} twice).
+                description: utils_1.StringUtil.trim `
+          Duplicate path parameter names: ${symbols.length} parameters, 
+          but only ${uniqueSymbols.size} unique names in "${props.operation.path}".
+
+          Path parameters: ${symbols.map((s, idx) => `[${idx}]="{${s}}"`).join(", ")}
+
+          Fix: Rename duplicate parameters to be unique. 
+          
+          (e.g., {userId} and {postId} instead of {userId} twice).
         `,
             });
     };
@@ -191,10 +191,10 @@ var AutoBeInterfaceOperationProgrammer;
                 path: props.path,
                 value: props.body,
                 expected: "null",
-                description: utils_1.StringUtil.trim `
-          Type "${props.body.typeName}" is not valid for ${props.kind}. 
-          
-          Use null for empty ${props.kind}.
+                description: utils_1.StringUtil.trim `
+          Type "${props.body.typeName}" is not valid for ${props.kind}. 
+          
+          Use null for empty ${props.kind}.
         `,
             });
         else if (props.body.typeName === "number" ||
@@ -204,11 +204,11 @@ var AutoBeInterfaceOperationProgrammer;
                 path: `${props.path}.typeName`,
                 value: props.body.typeName,
                 expected: "An object reference type encapsulating the primitive type",
-                description: utils_1.StringUtil.trim `
-          Primitive type "${props.body.typeName}" not allowed 
-          for ${props.kind}. 
-          
-          Encapsulate in object type (e.g., I${props.body.typeName[0].toUpperCase()}${props.body.typeName.slice(1)}Value).
+                description: utils_1.StringUtil.trim `
+          Primitive type "${props.body.typeName}" not allowed 
+          for ${props.kind}. 
+          
+          Encapsulate in object type (e.g., I${props.body.typeName[0].toUpperCase()}${props.body.typeName.slice(1)}Value).
         `,
             });
         else if (props.body.typeName === "object" ||
@@ -218,8 +218,8 @@ var AutoBeInterfaceOperationProgrammer;
                 path: `${props.path}.typeName`,
                 value: props.body.typeName,
                 expected: "An object reference type",
-                description: utils_1.StringUtil.trim `
-          Type "${props.body.typeName}" is a reserved word. Use a different type name.
+                description: utils_1.StringUtil.trim `
+          Type "${props.body.typeName}" is a reserved word. Use a different type name.
         `,
             });
         else if (props.body.typeName.startsWith("I") === false) {
@@ -227,12 +227,12 @@ var AutoBeInterfaceOperationProgrammer;
                 path: `${props.path}.typeName`,
                 value: props.body.typeName,
                 expected: "Type name starting with 'I' (e.g., IUser, IProduct, IOrder)",
-                description: utils_1.StringUtil.trim `
-          Type name "${props.body.typeName}" must start with 'I' prefix 
-          per AutoBE naming convention.
-
-          Fix: Rename to "I${props.body.typeName.charAt(0).toUpperCase()}${props.body.typeName.slice(1)}" 
-          (e.g., IUser, IProduct).
+                description: utils_1.StringUtil.trim `
+          Type name "${props.body.typeName}" must start with 'I' prefix 
+          per AutoBE naming convention.
+
+          Fix: Rename to "I${props.body.typeName.charAt(0).toUpperCase()}${props.body.typeName.slice(1)}" 
+          (e.g., IUser, IProduct).
         `,
             });
         }