@salesforce/plugin-orchestrator 1.0.18 → 1.0.21

package/oclif.manifest.json

@@ -551,6 +551,160 @@
         "update:app:orchestrator"
       ]
     },
+    "orchestrator:app:upgrade": {
+      "aliases": [],
+      "args": {},
+      "description": "Upgrade an existing orchestrated app by running its template's upgrade chains. This command allows you to apply template upgrades, reconfigure the app with new template values, and modify runtime settings while staying within the same template.\n\nYou can identify the app by either its unique ID or its name. App IDs are guaranteed to be unique, while names should be unique within an org.\n\nUse this command to run template-defined upgrade workflows that can update app configurations, apply new template versions, or reconfigure template values. This is different from the update command which only changes basic metadata like label and description.\n\nYou must have Data Cloud and Tableau Next enabled in your org and the AppFrameworkManageApp user permission to modify apps. The template ID must match the app's current template - you cannot change the underlying template an app is based on.",
+      "examples": [
+        "Upgrade an app with its current template:\n<%= config.bin %> <%= command.id %> --target-org myOrg --app-id 1zAxx000000000123 --template-id 1zDxx000000001EAA",
+        "Upgrade an app with new template values:\n<%= config.bin %> <%= command.id %> --target-org myOrg --app-name \"My App\" --template-id 1zDxx000000001EAA --template-values '{\"dataSource\":\"newSource\",\"refreshInterval\":60}'",
+        "Upgrade an app with async execution:\n<%= config.bin %> <%= command.id %> --target-org myOrg --app-id 1zAxx000000000123 --template-id 1zDxx000000001EAA --runtime-method async --log-level debug",
+        "Upgrade an app using a specific chain:\n<%= config.bin %> <%= command.id %> --target-org myOrg --app-id 1zAxx000000000123 --template-id 1zDxx000000001EAA --chain-name \"UpdateConfiguration\""
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "description": "The target org to connect to for upgrading the app.",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Login username or alias for the target org.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration.",
+          "name": "api-version",
+          "summary": "Override the API version used for API requests.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "app-id": {
+          "char": "i",
+          "description": "The unique identifier of the app to upgrade.",
+          "exclusive": [
+            "app-name"
+          ],
+          "name": "app-id",
+          "summary": "ID of the app to upgrade.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "app-name": {
+          "char": "n",
+          "description": "The name of the app to upgrade.",
+          "exclusive": [
+            "app-id"
+          ],
+          "name": "app-name",
+          "summary": "Name of the app to upgrade.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "template-id": {
+          "char": "t",
+          "description": "The unique identifier of the template to use for upgrading the app. This must match the app's current template ID. Template upgrades run the template's defined upgrade chains to reconfigure or update the app. Use \"sf orchestrator template list\" to find available template IDs.",
+          "name": "template-id",
+          "required": true,
+          "summary": "ID of the template to use for the upgrade.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "template-values": {
+          "char": "v",
+          "description": "A JSON object containing template-specific configuration values to pass to the upgrade chain. The available values depend on the template's variable definitions. For example: '{\"dataSource\":\"mySource\",\"refreshInterval\":30}'. These values customize how the template upgrade chain configures the app.",
+          "name": "template-values",
+          "summary": "Template-specific configuration values as JSON.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "runtime-method": {
+          "char": "r",
+          "description": "Specifies how the upgrade chain should be executed. Use 'sync' for synchronous execution (wait for completion) or 'async' for asynchronous execution (run in background). This affects how long the command takes to complete and how errors are handled.",
+          "name": "runtime-method",
+          "summary": "Runtime method for the upgrade execution.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "sync",
+            "async"
+          ],
+          "type": "option"
+        },
+        "log-level": {
+          "char": "l",
+          "description": "Sets the logging level for the upgrade chain execution. Higher levels provide more diagnostic information: 'debug' (most verbose), 'info' (normal), 'warn' (warnings only), or 'error' (errors only). Use 'debug' when troubleshooting upgrade issues.",
+          "name": "log-level",
+          "summary": "Log level for the upgrade execution.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "info",
+            "warn",
+            "error"
+          ],
+          "type": "option"
+        },
+        "chain-name": {
+          "char": "c",
+          "description": "The name of the specific upgrade chain to execute. If not specified, the template's default upgrade chain will be used. Different chains may perform different types of upgrades or configurations within the same template.",
+          "name": "chain-name",
+          "summary": "Specific chain name to execute for the upgrade.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "orchestrator:app:upgrade",
+      "pluginAlias": "@salesforce/plugin-orchestrator",
+      "pluginName": "@salesforce/plugin-orchestrator",
+      "pluginType": "core",
+      "state": "preview",
+      "strict": true,
+      "summary": "Upgrade an orchestrated app.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "orchestrator",
+        "app",
+        "upgrade.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "orchestrator:app:upgrade",
+        "app:orchestrator:upgrade",
+        "app:upgrade:orchestrator",
+        "orchestrator:upgrade:app",
+        "upgrade:orchestrator:app",
+        "upgrade:app:orchestrator"
+      ]
+    },
     "orchestrator:template:create": {
       "aliases": [],
       "args": {},
@@ -889,12 +1043,14 @@
     "orchestrator:template:list": {
       "aliases": [],
       "args": {},
-      "description": "Templates are reusable configurations that define the structure and settings for creating orchestrated apps. Use this command to discover available templates in your org before creating new apps.\n\nTemplates are displayed in a table format showing their name, label, ID, type, and other metadata. This information helps you choose the right template for your orchestrated app development.\n\nYou must have Data Cloud and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view templates. This command works with production orgs, sandboxes, and scratch orgs.",
+      "description": "Templates are reusable configurations that define the structure and settings for creating orchestrated apps. Use this command to discover available templates in your org before creating new apps.\n\nBy default, this command only shows custom templates created in your org. Standard Salesforce-provided templates are filtered out to reduce noise. Use the --all flag to include all templates including the standard ones.\n\nTemplates are displayed in a table format showing their name, label, ID, type, and other metadata. This information helps you choose the right template for your orchestrated app development.\n\nYou must have Data Cloud and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view templates. This command works with production orgs, sandboxes, and scratch orgs.",
       "examples": [
         "List all templates in your default org:\n<%= config.bin %> <%= command.id %>",
         "List templates in a specific org:\n<%= config.bin %> <%= command.id %> --target-org myOrg",
         "List templates using a specific API version:\n<%= config.bin %> <%= command.id %> --api-version 64.0",
-        "List templates in a sandbox org with a specific API version:\n<%= config.bin %> <%= command.id %> --target-org mySandbox --api-version 60.0"
+        "List templates in a sandbox org with a specific API version:\n<%= config.bin %> <%= command.id %> --target-org mySandbox --api-version 60.0",
+        "List all templates including standard Salesforce templates:\n<%= config.bin %> <%= command.id %> --all",
+        "List all templates in a specific org:\n<%= config.bin %> <%= command.id %> --target-org myOrg --all"
       ],
       "flags": {
         "json": {
@@ -930,6 +1086,13 @@
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
+        },
+        "all": {
+          "description": "By default, this command only shows custom templates created in your org. Use this flag to include the standard Salesforce-provided templates (those starting with 'sfdc_internal\\_\\_') in the results.",
+          "name": "all",
+          "summary": "Show all templates including standard Salesforce templates.",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": true,
@@ -1076,7 +1239,108 @@
         "update:orchestrator:template",
         "update:template:orchestrator"
       ]
+    },
+    "orchestrator:rules:eval": {
+      "aliases": [],
+      "args": {},
+      "description": "Preview how transformation rules will modify JSON documents before deploying templates. This command uses a sample transformation to test the jsonxform/transformation endpoint with built-in User and Org context variables.",
+      "examples": [
+        "Test JSON transformation with Analytics template files:\n<%= config.bin %> <%= command.id %> --template-info ./template-info.json --variables ./variables.json --rules ./rules.json --target-org myorg",
+        "Test with specific API version:\n<%= config.bin %> <%= command.id %> --template-info ./template-info.json --variables ./variables.json --rules ./rules.json --target-org myorg --api-version 60.0"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "description": "The username or alias of the target org where the jsonxform/transformation endpoint will be called. This org provides the User and Org context variables used in the transformation.",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias for the target org; overrides default target org.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "API version to use for the transformation request. Defaults to the org's configured API version.",
+          "name": "api-version",
+          "summary": "Override the api version used for api requests made by this command.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "template-info": {
+          "char": "t",
+          "description": "Path to the template-info.json file containing the base JSON document structure that will be transformed.",
+          "name": "template-info",
+          "required": true,
+          "summary": "Path to Analytics template-info.json file.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "variables": {
+          "char": "v",
+          "description": "Path to the variables.json file containing variable definitions used in transformations.",
+          "name": "variables",
+          "required": true,
+          "summary": "Path to Analytics variables.json file.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "rules": {
+          "char": "r",
+          "description": "Path to the rules.json file containing transformation rules and macro definitions.",
+          "name": "rules",
+          "required": true,
+          "summary": "Path to Analytics rules.json file.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "orchestrator:rules:eval",
+      "pluginAlias": "@salesforce/plugin-orchestrator",
+      "pluginName": "@salesforce/plugin-orchestrator",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Test JSON transformation rules using the jsonxform/transformation endpoint.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "orchestrator",
+        "rules",
+        "eval.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "orchestrator:rules:eval",
+        "rules:orchestrator:eval",
+        "rules:eval:orchestrator",
+        "orchestrator:eval:rules",
+        "eval:orchestrator:rules",
+        "eval:rules:orchestrator"
+      ]
     }
   },
-  "version": "1.0.18"
+  "version": "1.0.21"
 }

package/package.json

@@ -1,25 +1,26 @@
 {
     "name": "@salesforce/plugin-orchestrator",
     "description": "Plugin for working with SalesForce analytic apps, templates, assets and services.",
-    "version": "1.0.18",
+    "version": "1.0.21",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
+        "@inquirer/select": "^5.0.1",
         "@oclif/core": "^4",
-        "@salesforce/core": "^8.23.0",
+        "@salesforce/core": "^8.24.0",
         "@salesforce/kit": "^3.2.1",
         "@salesforce/sf-plugins-core": "^12",
         "ansis": "^3.17.0",
         "eslint": "^8.56.0"
     },
     "devDependencies": {
-        "@oclif/plugin-command-snapshot": "^5.3.6",
+        "@oclif/plugin-command-snapshot": "^5.3.8",
         "@salesforce/cli-plugins-testkit": "^5.3.41",
         "@salesforce/dev-scripts": "^11.0.2",
-        "@salesforce/plugin-command-reference": "^3.1.72",
+        "@salesforce/plugin-command-reference": "^3.1.78",
         "eslint-config-salesforce-license": "^1.0.1",
         "eslint-plugin-sf-plugin": "^1.20.31",
-        "oclif": "^4.22.24",
+        "oclif": "^4.22.50",
         "ts-node": "^10.9.2",
         "typescript": "^5.5.4"
     },
@@ -56,13 +57,28 @@
         ],
         "topics": {
             "orchestrator": {
-                "description": "Commands to work with apps and templates"
+                "description": "Commands to work with apps and templates",
+                "external": true,
+                "subtopics": {
+                    "app": {
+                        "external": true
+                    },
+                    "rules": {
+                        "external": true
+                    }
+                }
             },
             "orchestrator:app": {
                 "description": "Work with apps"
             },
             "orchestrator:template": {
                 "description": "Work with templates"
+            },
+            "orchestrator:rules": {
+                "description": "Work with transformation rules"
+            },
+            "template": {
+                "description": "description for template"
             }
         },
         "flexibleTaxonomy": true
@@ -204,10 +220,16 @@
             "output": []
         }
     },
+    "resolutions": {
+        "@types/node": "^20.0.0"
+    },
+    "overrides": {
+        "@types/node": "^20.0.0"
+    },
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-orchestrator/1.0.18.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-orchestrator/1.0.18.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-orchestrator/1.0.21.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-orchestrator/1.0.21.sig"
     }
 }