[skip-validate-pr] fix: rename --template-info flag to --document (#120)

* fix: rename --template-info flag to --document for clarity

Author: rvwatch

command-snapshot.json

@@ -75,8 +75,8 @@
     "alias": [],
     "command": "orchestrator:rules:eval",
     "flagAliases": [],
-    "flagChars": ["o", "r", "t", "v"],
-    "flags": ["api-version", "flags-dir", "json", "rules", "target-org", "template-info", "variables"],
+    "flagChars": ["d", "o", "r", "v"],
+    "flags": ["api-version", "document", "flags-dir", "json", "rules", "target-org", "variables"],
     "plugin": "@salesforce/plugin-orchestrator"
   },
   {

messages/orchestrator.rules.eval.md

@@ -22,13 +22,13 @@ Override the api version used for api requests made by this command.
 
 API version to use for the transformation request. Defaults to the org's configured API version.
 
-# flags.template-info.summary
+# flags.document.summary
 
-Path to Analytics template-info.json file.
+Path to JSON document file to transform.
 
-# flags.template-info.description
+# flags.document.description
 
-Path to the template-info.json file containing the base JSON document structure that will be transformed.
+Path to the JSON document file (dashboard, lens, etc.) that will be transformed by the rules.
 
 # flags.variables.summary
 
@@ -48,8 +48,8 @@ Path to the rules.json file containing transformation rules and macro definition
 
 # examples
 
-- Test JSON transformation with Analytics template files:
-  <%= config.bin %> <%= command.id %> --template-info ./template-info.json --variables ./variables.json --rules ./rules.json --target-org myorg
+- Test JSON transformation with Analytics files:
+  <%= config.bin %> <%= command.id %> --document ./dashboard.json --variables ./variables.json --rules ./rules.json --target-org myorg
 
 - Test with specific API version:
-  <%= config.bin %> <%= command.id %> --template-info ./template-info.json --variables ./variables.json --rules ./rules.json --target-org myorg --api-version 60.0
+  <%= config.bin %> <%= command.id %> --document ./dashboard.json --variables ./variables.json --rules ./rules.json --target-org myorg --api-version 60.0

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/plugin-orchestrator",
   "description": "Plugin for working with SalesForce analytic apps, templates, assets and services.",
-  "version": "1.0.21",
+  "version": "1.0.20",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/cli/issues",
   "dependencies": {

src/commands/orchestrator/rules/eval.ts

@@ -85,10 +85,10 @@ export default class TemplateEval extends SfCommand<TemplatePreviewResult> {
       summary: messages.getMessage('flags.api-version.summary'),
       description: messages.getMessage('flags.api-version.description'),
     }),
-    'template-info': Flags.file({
-      char: 't',
-      summary: messages.getMessage('flags.template-info.summary'),
-      description: messages.getMessage('flags.template-info.description'),
+    document: Flags.file({
+      char: 'd',
+      summary: messages.getMessage('flags.document.summary'),
+      description: messages.getMessage('flags.document.description'),
       required: true,
     }),
     variables: Flags.file({
@@ -159,26 +159,26 @@ export default class TemplateEval extends SfCommand<TemplatePreviewResult> {
     }
   }
 
-  private async getTemplatePayload(flags: { 'template-info': string; variables: string; rules: string }): Promise<{
+  private async getTemplatePayload(flags: { document: string; variables: string; rules: string }): Promise<{
     template: TemplateInfo;
     payload: TransformationPayload;
   }> {
-    return this.getDirectFilePayload(flags['template-info'], flags['variables'], flags['rules']);
+    return this.getDirectFilePayload(flags.document, flags.variables, flags.rules);
   }
 
   private async getDirectFilePayload(
-    templateInfoFile: string,
+    documentFile: string,
     variablesFile: string,
     rulesFile: string
   ): Promise<{
     template: TemplateInfo;
     payload: TransformationPayload;
   }> {
-    this.log(`Loading template info: ${templateInfoFile}`);
+    this.log(`Loading document: ${documentFile}`);
 
-    // Read and parse the template-info file
-    const templateInfoContent = await fs.readFile(templateInfoFile, 'utf8');
-    const document = JSON.parse(templateInfoContent) as unknown;
+    // Read and parse the document file
+    const documentContent = await fs.readFile(documentFile, 'utf8');
+    const document = JSON.parse(documentContent) as unknown;
 
     // Read variables file
     this.log(`Loading variables: ${variablesFile}`);
@@ -193,7 +193,7 @@ export default class TemplateEval extends SfCommand<TemplatePreviewResult> {
     return {
       template: {
         name: 'Direct Files',
-        path: templateInfoFile,
+        path: documentFile,
         source: 'local' as const,
       },
       payload: {