@sonisoft/now-sdk-ext-cli 2.0.1 → 2.3.0

package/oclif.manifest.json

@@ -1994,6 +1994,196 @@
         "cancel.js"
       ]
     },
+    "flow:copy": {
+      "aliases": [],
+      "args": {},
+      "description": "Copy an existing flow into a target scoped application.\n\nThis is the ServiceNow best practice before modifying any flow — OOB and shared flows must never be modified directly; always copy first. The copied flow lands in draft/unpublished state in the target scope.\n\nEnables the full CLI-driven flow development lifecycle:\n  copy → pull (now-sdk transform) → modify → push → test → publish\n\nFeatures:\n  • Copy flows by sys_id or scoped name\n  • Specify a display name for the new copy\n  • Target any scoped application by sys_id\n  • Returns the new flow sys_id for use in subsequent commands",
+      "examples": [
+        {
+          "description": "Copy an OOB flow into your app scope",
+          "command": "<%= config.bin %> <%= command.id %> --source-flow-id e89e3ade731310108ef62d2b04f6a744 --name \"Copy of Change - Standard\" --target-scope 4a5a6115402946939ee48e3fe80f60f8 --auth dev"
+        },
+        {
+          "description": "Copy by scoped name",
+          "command": "<%= config.bin %> <%= command.id %> -s global.change__standard -n \"My Custom Change Flow\" -t 4a5a6115402946939ee48e3fe80f60f8 --auth dev"
+        },
+        {
+          "description": "Copy with JSON output for scripting",
+          "command": "<%= config.bin %> <%= command.id %> -s e89e3ade731310108ef62d2b04f6a744 -n \"Copy\" -t 4a5a6115402946939ee48e3fe80f60f8 --json --auth dev"
+        }
+      ],
+      "flags": {
+        "json": {
+          "char": "j",
+          "description": "Output results as JSON",
+          "name": "json",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "auth": {
+          "char": "a",
+          "description": "Auth alias to use.",
+          "name": "auth",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        },
+        "source-flow-id": {
+          "char": "s",
+          "description": "Source flow sys_id or scoped name (e.g. global.change__standard)",
+          "name": "source-flow-id",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "name": {
+          "char": "n",
+          "description": "Display name for the new copied flow",
+          "name": "name",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-scope": {
+          "char": "t",
+          "description": "Scope sys_id of the target application (use `nex scope` to find scope sys_ids)",
+          "name": "target-scope",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "flow:copy",
+      "pluginAlias": "@sonisoft/now-sdk-ext-cli",
+      "pluginName": "@sonisoft/now-sdk-ext-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "flow",
+        "copy.js"
+      ]
+    },
+    "flow:details": {
+      "aliases": [],
+      "args": {},
+      "description": "Get rich execution details for a flow context.\n\nReturns per-action timing, inputs, outputs, and high-level metadata (state, runtime, who ran it, test vs production). This is the primary diagnostic command after flow test or flow run.\n\nUses the ProcessFlow operations API (GET /api/now/processflow/operations/flow/context/{id}), the same endpoint Flow Designer uses to display execution details.\n\nNOTE: Requires flow operations logging to be enabled on the instance. If the execution report is unavailable, a notice will explain why.\n\nTypical workflow:\n  flow test → flow details → diagnose → modify flow → flow test again",
+      "examples": [
+        {
+          "description": "Get execution details after testing a flow",
+          "command": "<%= config.bin %> <%= command.id %> --context-id d4e5f6789012345678abcdef01234567 --auth dev"
+        },
+        {
+          "description": "Get details with explicit scope",
+          "command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --scope x_myapp --auth dev"
+        },
+        {
+          "description": "Get details with JSON output for scripting",
+          "command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --json --auth dev"
+        }
+      ],
+      "flags": {
+        "json": {
+          "char": "j",
+          "description": "Output results as JSON",
+          "name": "json",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "auth": {
+          "char": "a",
+          "description": "Auth alias to use.",
+          "name": "auth",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        },
+        "context-id": {
+          "char": "c",
+          "description": "Flow context sys_id returned by flow test, flow run, flow subflow, or flow action",
+          "name": "context-id",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "scope": {
+          "description": "Scope sys_id for the ProcessFlow API transaction scope parameter",
+          "name": "scope",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "include-definition": {
+          "char": "d",
+          "description": "Include the full flow definition snapshot in the response",
+          "name": "include-definition",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "flow:details",
+      "pluginAlias": "@sonisoft/now-sdk-ext-cli",
+      "pluginName": "@sonisoft/now-sdk-ext-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "flow",
+        "details.js"
+      ]
+    },
     "flow:error": {
       "aliases": [],
       "args": {},
@@ -2072,6 +2262,108 @@
         "error.js"
       ]
     },
+    "flow:logs": {
+      "aliases": [],
+      "args": {},
+      "description": "Retrieve flow execution log entries for a given context.\n\nLog entries include error messages, step-level debug output, and cancellation reasons. Use this alongside flow details to get the full picture of what happened during an execution.\n\nQueries sys_flow_log entries and maps numeric log levels to human-readable names (ERROR, WARN, INFO, DEBUG).\n\nNOTE: Log entries may be empty for simple successful executions, or if the flow reporting level is set to NONE. Errors and warnings are always logged regardless of the reporting level setting.",
+      "examples": [
+        {
+          "description": "Get flow execution logs",
+          "command": "<%= config.bin %> <%= command.id %> --context-id d4e5f6789012345678abcdef01234567 --auth dev"
+        },
+        {
+          "description": "Get latest 10 log entries in reverse order",
+          "command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --limit 10 --order desc --auth dev"
+        },
+        {
+          "description": "Get logs with JSON output for scripting",
+          "command": "<%= config.bin %> <%= command.id %> -c d4e5f6789012345678abcdef01234567 --json --auth dev"
+        }
+      ],
+      "flags": {
+        "json": {
+          "char": "j",
+          "description": "Output results as JSON",
+          "name": "json",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "auth": {
+          "char": "a",
+          "description": "Auth alias to use.",
+          "name": "auth",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        },
+        "context-id": {
+          "char": "c",
+          "description": "Flow context sys_id returned by flow test, flow run, flow subflow, or flow action",
+          "name": "context-id",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "limit": {
+          "char": "l",
+          "description": "Maximum number of log entries to return",
+          "name": "limit",
+          "required": false,
+          "default": 100,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "order": {
+          "char": "o",
+          "description": "Order direction: asc (oldest first) or desc (newest first)",
+          "name": "order",
+          "required": false,
+          "default": "asc",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "asc",
+            "desc"
+          ],
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "flow:logs",
+      "pluginAlias": "@sonisoft/now-sdk-ext-cli",
+      "pluginName": "@sonisoft/now-sdk-ext-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "flow",
+        "logs.js"
+      ]
+    },
     "flow:message": {
       "aliases": [],
       "args": {},
@@ -2257,7 +2549,7 @@
     "flow:run": {
       "aliases": [],
       "args": {},
-      "description": "Execute a Flow Designer flow by scoped name.\n\nRuns a flow using the sn_fd.FlowAPI ScriptableFlowRunner. Supports foreground (synchronous) and background (asynchronous) execution modes.\n\nFeatures:\n  • Execute flows by scoped name (e.g. global.my_flow)\n  • Pass input values as JSON\n  • Foreground or background execution mode\n  • Quick mode to skip execution detail records\n  • Returns context ID, outputs, and debug information",
+      "description": "Execute a published Flow Designer flow by scoped name.\n\nRuns a flow using the sn_fd.FlowAPI ScriptableFlowRunner. Supports foreground (synchronous) and background (asynchronous) execution modes.\n\nNote: This command requires the flow to be published. For testing flows that are not yet published (draft/saved state), use `flow test` instead.\n\nFeatures:\n  • Execute flows by scoped name (e.g. global.my_flow)\n  • Pass input values as JSON\n  • Foreground or background execution mode\n  • Quick mode to skip execution detail records\n  • Returns context ID, outputs, and debug information",
       "examples": [
         {
           "description": "Run a flow in foreground mode",
@@ -2451,7 +2743,7 @@
     "flow:subflow": {
       "aliases": [],
       "args": {},
-      "description": "Execute a Flow Designer subflow by scoped name.\n\nRuns a subflow using the sn_fd.FlowAPI ScriptableFlowRunner.\n\nFeatures:\n  • Execute subflows by scoped name\n  • Pass input values as JSON\n  • Foreground or background execution mode\n  • Returns context ID, outputs, and debug information",
+      "description": "Execute a published Flow Designer subflow by scoped name.\n\nRuns a subflow using the sn_fd.FlowAPI ScriptableFlowRunner.\n\nNote: This command requires the subflow to be published. For testing flows that are not yet published (draft/saved state), use `flow test` instead.\n\nFeatures:\n  • Execute subflows by scoped name\n  • Pass input values as JSON\n  • Foreground or background execution mode\n  • Returns context ID, outputs, and debug information",
       "examples": [
         {
           "description": "Run a subflow",
@@ -2560,6 +2852,108 @@
         "subflow.js"
       ]
     },
+    "flow:test": {
+      "aliases": [],
+      "args": {},
+      "description": "Test a Flow Designer flow without requiring it to be published.\n\nInvokes the same API as the \"Test\" button in Flow Designer, running the flow in its current saved (draft) state. Unlike `flow run` which requires a published flow and uses sn_fd.FlowAPI, `flow test` works on unpublished drafts via the ProcessFlow REST API.\n\nFeatures:\n  • Test flows by sys_id or scoped name\n  • Pass trigger output values as JSON via --output-map\n  • Auto-resolves scope from flow definition if not provided\n  • Synchronous or asynchronous execution",
+      "examples": [
+        {
+          "description": "Test a flow by sys_id",
+          "command": "<%= config.bin %> <%= command.id %> --flow-id 887dda5583237210fdb8f7b6feaad32c --output-map '{\"current\":\"0ecd7552db252200a6a2b31be0b8f5e6\",\"table_name\":\"change_request\"}' --auth dev"
+        },
+        {
+          "description": "Test a flow by scoped name with explicit scope",
+          "command": "<%= config.bin %> <%= command.id %> -f x_myapp.my_flow -o '{\"current\":\"abc123\",\"table_name\":\"incident\"}' --scope x_myapp --auth dev"
+        },
+        {
+          "description": "Test with JSON output",
+          "command": "<%= config.bin %> <%= command.id %> -f 887dda5583237210fdb8f7b6feaad32c -o '{\"current\":\"abc123\"}' --json --auth dev"
+        }
+      ],
+      "flags": {
+        "json": {
+          "char": "j",
+          "description": "Output results as JSON",
+          "name": "json",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "auth": {
+          "char": "a",
+          "description": "Auth alias to use.",
+          "name": "auth",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "log-level": {
+          "helpGroup": "GLOBAL",
+          "name": "log-level",
+          "summary": "Specify level for logging.",
+          "default": "info",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "debug",
+            "warn",
+            "error",
+            "info",
+            "trace"
+          ],
+          "type": "option"
+        },
+        "flow-id": {
+          "char": "f",
+          "description": "Flow sys_id or scoped name (e.g. x_myapp.my_flow)",
+          "name": "flow-id",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "output-map": {
+          "char": "o",
+          "description": "JSON mapping of trigger output variable names to test values (e.g. '{\"current\":\"<sys_id>\",\"table_name\":\"change_request\"}')",
+          "name": "output-map",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "scope": {
+          "description": "Scope sys_id for transaction scope (auto-resolved from flow definition if omitted)",
+          "name": "scope",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "synchronous": {
+          "description": "Run test synchronously (default: true)",
+          "name": "synchronous",
+          "required": false,
+          "allowNo": true,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "flow:test",
+      "pluginAlias": "@sonisoft/now-sdk-ext-cli",
+      "pluginName": "@sonisoft/now-sdk-ext-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "flow",
+        "test.js"
+      ]
+    },
     "health:check": {
       "aliases": [],
       "args": {},
@@ -6024,5 +6418,5 @@
       ]
     }
   },
-  "version": "2.0.1"
+  "version": "2.3.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sonisoft/now-sdk-ext-cli",
   "description": "A CLI extending the functionality of the ServiceNow SDK.",
-  "version": "2.0.1",
+  "version": "2.3.0",
   "author": "Chris Nanda",
   "bin": {
     "nex": "./bin/run.js"
@@ -17,7 +17,7 @@
     "@servicenow/sdk-cli": "4.3.0",
     "@servicenow/sdk-cli-core": "3.0.3",
     "@servicenow/sdk-core": "4.3.0",
-    "@sonisoft/now-sdk-ext-core": "^3.4.0",
+    "@sonisoft/now-sdk-ext-core": "^3.8.0",
     "@ts-morph/common": "^0.24.0",
     "chalk": "^4.1.2",
     "cometd": "^8.0.4",