@sonisoft/now-sdk-ext-cli 1.1.0-alpha.0 → 1.1.0-alpha.1

package/README.md

@@ -29,7 +29,7 @@ $ npm install -g @sonisoft/now-sdk-ext-cli
 $ nex COMMAND
 running command...
 $ nex (--version)
-@sonisoft/now-sdk-ext-cli/1.1.0-alpha.0 darwin-arm64 node-v22.6.0
+@sonisoft/now-sdk-ext-cli/1.1.0-alpha.1 darwin-arm64 node-v22.6.0
 $ nex --help [COMMAND]
 USAGE
   $ nex COMMAND
@@ -38,6 +38,7 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
+* [`nex app`](#nex-app)
 * [`nex exec SCOPE FILE`](#nex-exec-scope-file)
 * [`nex help [COMMAND]`](#nex-help-command)
 * [`nex plugins`](#nex-plugins)
@@ -51,6 +52,35 @@ USAGE
 * [`nex plugins unlink [PLUGIN]`](#nex-plugins-unlink-plugin)
 * [`nex plugins update`](#nex-plugins-update)
 
+## `nex app`
+
+Execute a local javascript file on a ServiceNow instance using Scripts - Background remotely. Returns the output/raw console output that Scripts - Background outputs to the browser in order to support the execution and result being piped to another command.
+
+```
+USAGE
+  $ nex app [--json] [-a <value>] [--log-level debug|warn|error|info|trace] [-u] [-i <value>] [-s <value>]
+
+FLAGS
+  -a, --auth=<value>           Auth alias to use.
+  -i, --applicationId=<value>  Application sys_id
+  -s, --scope=<value>          Scope of application.
+  -u, --uninstall              Uninstall the app
+
+GLOBAL FLAGS
+  --json                Format output as json.
+  --log-level=<option>  [default: info] Specify level for logging.
+                        <options: debug|warn|error|info|trace>
+
+DESCRIPTION
+  Execute a local javascript file on a ServiceNow instance using Scripts - Background remotely. Returns the output/raw
+  console output that Scripts - Background outputs to the browser in order to support the execution and result being
+  piped to another command.
+
+EXAMPLES
+  $ nex app exec global test.js --auth sn_alias
+  test
+```
+
 ## `nex exec SCOPE FILE`
 
 Execute a local javascript file on a ServiceNow instance using Scripts - Background remotely. Returns the output/raw console output that Scripts - Background outputs to the browser in order to support the execution and result being piped to another command.
@@ -99,7 +129,7 @@ DESCRIPTION
   Display help for nex.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.13/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.31/src/commands/help.ts)_
 
 ## `nex plugins`
 
@@ -122,7 +152,7 @@ EXAMPLES
   $ nex plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.45/src/commands/plugins/index.ts)_
 
 ## `nex plugins add PLUGIN`
 
@@ -196,7 +226,7 @@ EXAMPLES
   $ nex plugins inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.45/src/commands/plugins/inspect.ts)_
 
 ## `nex plugins install PLUGIN`
 
@@ -245,7 +275,7 @@ EXAMPLES
     $ nex plugins install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.45/src/commands/plugins/install.ts)_
 
 ## `nex plugins link PATH`
 
@@ -265,6 +295,7 @@ FLAGS
 
 DESCRIPTION
   Links a plugin into the CLI for development.
+
   Installation of a linked plugin will override a user-installed or core plugin.
 
   e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
@@ -275,7 +306,7 @@ EXAMPLES
   $ nex plugins link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.45/src/commands/plugins/link.ts)_
 
 ## `nex plugins remove [PLUGIN]`
 
@@ -316,7 +347,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.45/src/commands/plugins/reset.ts)_
 
 ## `nex plugins uninstall [PLUGIN]`
 
@@ -344,7 +375,7 @@ EXAMPLES
   $ nex plugins uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.45/src/commands/plugins/uninstall.ts)_
 
 ## `nex plugins unlink [PLUGIN]`
 
@@ -388,5 +419,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.45/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/dist/commands/app/index.d.ts

@@ -0,0 +1,14 @@
+import { AuthenticatedCommand } from '../../common/authenticated-command.js';
+export declare class App extends AuthenticatedCommand<typeof App> {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {
+        uninstall: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+        applicationId: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        scope: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    private _logger;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/commands/app/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commands/app/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAA;AAE5E,qBAAa,GAAI,SAAQ,oBAAoB,CAAC,OAAO,GAAG,CAAC;IAEvD,MAAM,CAAC,IAAI,KACV;IAED,MAAM,CAAC,WAAW,SAAuQ;IAEzR,MAAM,CAAC,QAAQ,WAId;IAED,MAAM,CAAC,KAAK;;;;MAKX;IAED,OAAO,CAAC,OAAO,CAAmC;IAE5C,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAqD3B"}

package/dist/commands/app/index.js

@@ -0,0 +1,67 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable perfectionist/sort-objects */
+import { Flags } from '@oclif/core';
+import { Application, BackgroundScriptExecutor, Logger, NowStringUtil } from '@sonisoft/now-sdk-ext-core';
+import fs from 'node:fs';
+import path from 'node:path';
+import { AuthenticatedCommand } from '../../common/authenticated-command.js';
+export class App extends AuthenticatedCommand {
+    static args = {};
+    static description = 'Execute a local javascript file on a ServiceNow instance using Scripts - Background remotely. Returns the output/raw console output that Scripts - Background outputs to the browser in order to support the execution and result being piped to another command.';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> exec global test.js --auth sn_alias
+test
+`,
+    ];
+    static flags = {
+        // from: Flags.string({char: 'f', description: 'Who is saying hello', required: true}),
+        uninstall: Flags.boolean({ char: 'u', description: 'Uninstall the app', required: false }),
+        applicationId: Flags.string({ char: 'i', description: 'Application sys_id', required: false }),
+        scope: Flags.string({ char: 's', description: 'Scope of application.', required: false }),
+    };
+    _logger = new Logger("AppCommand");
+    async run() {
+        const { args, flags } = await this.parse(App);
+        this.log("App command");
+        if (flags.uninstall) {
+            this.log("Uninstalling app");
+            if (NowStringUtil.isStringEmpty(flags.applicationId)) {
+                this.error("Application ID is required when uninstalling an app");
+                return;
+            }
+            if (NowStringUtil.isStringEmpty(flags.scope)) {
+                this.error("Scope is required when uninstalling an app");
+                return;
+            }
+            this.log("Passed checks. Uninstalling app.");
+            const app = new Application(this.instance, flags.scope, flags.applicationId);
+            await app.changeApplication();
+            await app.uninstall();
+        }
+        if (!NowStringUtil.isStringEmpty(args.file) && !NowStringUtil.isStringEmpty(args.scope)) {
+            try {
+                const filePath = path.resolve(args.file);
+                const script = fs.readFileSync(filePath).toString('utf8');
+                const scope = args.scope ?? "global";
+                const executor = new BackgroundScriptExecutor(this.instance, args.scope);
+                ;
+                const result = await executor.executeScript(script, scope, this.instance);
+                this._logger.debug("Ran background script", result);
+                if (result !== null && result.scriptResults !== null) {
+                    const { scriptResults } = result;
+                    for (const scriptResult of scriptResults) {
+                        this.log(scriptResult.line);
+                    }
+                }
+                else {
+                    throw new Error("Response from script execution was null or undefined. Please review logs to identify the problem.");
+                }
+            }
+            catch (error) {
+                this._logger.error("Error occurred when executing background script.", error);
+                this.error(error);
+            }
+        }
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/commands/app/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/app/index.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,+CAA+C;AAC/C,OAAO,EAAgB,KAAK,EAAC,MAAM,aAAa,CAAA;AAChD,OAAO,EAAG,WAAW,EAAE,wBAAwB,EAAG,MAAM,EAAE,aAAa,EAAuB,MAAM,4BAA4B,CAAC;AACjI,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAA;AAE5E,MAAM,OAAO,GAAI,SAAQ,oBAAgC;IAEvD,MAAM,CAAC,IAAI,GAAG,EACb,CAAA;IAED,MAAM,CAAC,WAAW,GAAG,mQAAmQ,CAAC;IAEzR,MAAM,CAAC,QAAQ,GAAG;QAChB;;CAEH;KACE,CAAA;IAED,MAAM,CAAC,KAAK,GAAG;QACb,uFAAuF;QACvF,SAAS,EAAE,KAAK,CAAC,OAAO,CAAC,EAAC,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,mBAAmB,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC;QACxF,aAAa,EAAE,KAAK,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC;QAC5F,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,uBAAuB,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC;KACxF,CAAA;IAEO,OAAO,GAAU,IAAI,MAAM,CAAC,YAAY,CAAC,CAAC;IAElD,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE5C,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAExB,IAAG,KAAK,CAAC,SAAS,EAAC,CAAC;YAClB,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAE7B,IAAG,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,EAAC,CAAC;gBACnD,IAAI,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;gBAClE,OAAO;YACT,CAAC;YAED,IAAG,aAAa,CAAC,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAAC,CAAC;gBAC3C,IAAI,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;gBACzD,OAAO;YACT,CAAC;YAED,IAAI,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;YAC7C,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,KAAe,EAAG,KAAK,CAAC,aAAuB,CAAC,CAAC;YAClG,MAAM,GAAG,CAAC,iBAAiB,EAAE,CAAC;YAC9B,MAAM,GAAG,CAAC,SAAS,EAAE,CAAC;QACxB,CAAC;QAGD,IAAG,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,EAAC,CAAC;YACtF,IAAG,CAAC;gBACF,MAAM,QAAQ,GAAU,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAChD,MAAM,MAAM,GAAU,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;gBACjE,MAAM,KAAK,GAAU,IAAI,CAAC,KAAK,IAAI,QAAQ,CAAC;gBAE5C,MAAM,QAAQ,GAA6B,IAAI,wBAAwB,CAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAE,CAAC;gBAAA,CAAC;gBACtG,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAE,CAAC;gBAC5E,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;gBACpD,IAAG,MAAM,KAAK,IAAI,IAAI,MAAM,CAAC,aAAa,KAAK,IAAI,EAAC,CAAC;oBACnD,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,CAAC;oBAC/B,KAAI,MAAM,YAAY,IAAI,aAAa,EAAC,CAAC;wBACvC,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;oBAC9B,CAAC;gBAEH,CAAC;qBAAI,CAAC;oBACJ,MAAM,IAAI,KAAK,CAAC,mGAAmG,CAAC,CAAC;gBACvH,CAAC;YAEH,CAAC;YAAA,OAAM,KAAK,EAAC,CAAC;gBACZ,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,kDAAkD,EAAE,KAAc,CAAC,CAAC;gBACvF,IAAI,CAAC,KAAK,CAAC,KAAc,CAAC,CAAC;YAC7B,CAAC;QAGH,CAAC;IAEH,CAAC"}

package/oclif.manifest.json

@@ -1,5 +1,88 @@
 {
   "commands": {
+    "app": {
+      "aliases": [],
+      "args": {},
+      "description": "Execute a local javascript file on a ServiceNow instance using Scripts - Background remotely. Returns the output/raw console output that Scripts - Background outputs to the browser in order to support the execution and result being piped to another command.",
+      "examples": [
+        "<%= config.bin %> <%= command.id %> exec global test.js --auth sn_alias\ntest\n"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "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"
+        },
+        "uninstall": {
+          "char": "u",
+          "description": "Uninstall the app",
+          "name": "uninstall",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "applicationId": {
+          "char": "i",
+          "description": "Application sys_id",
+          "name": "applicationId",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "scope": {
+          "char": "s",
+          "description": "Scope of application.",
+          "name": "scope",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "app",
+      "pluginAlias": "@sonisoft/now-sdk-ext-cli",
+      "pluginName": "@sonisoft/now-sdk-ext-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "app",
+        "index.js"
+      ]
+    },
     "exec": {
       "aliases": [],
       "args": {
@@ -69,5 +152,5 @@
       ]
     }
   },
-  "version": "1.1.0-alpha.0"
+  "version": "1.1.0-alpha.1"
 }

package/package.json

@@ -1,25 +1,24 @@
 {
   "name": "@sonisoft/now-sdk-ext-cli",
   "description": "A CLI extending the functionality of the ServiceNow SDK.",
-  "version": "1.1.0-alpha.0",
+  "version": "1.1.0-alpha.1",
   "author": "Chris Nanda",
   "bin": {
     "nex": "./bin/run.js"
   },
   "bugs": "",
   "dependencies": {
-    "@oclif/core": "^4.0.2",
     "@oclif/plugin-help": "^6.2.10",
     "@oclif/plugin-plugins": "^5.4.6",
     "@servicenow/glide": "^26.0.1",
     "@servicenow/sdk": "3.0.2",
     "@servicenow/sdk-build": "3.0.2",
+    "@servicenow/sdk-build-core": "3.0.2",
     "@servicenow/sdk-cli": "3.0.2",
     "@servicenow/sdk-cli-core": "3.0.2",
     "@servicenow/sdk-core": "3.0.2",
     "@servicenow/sdk-project": "3.0.2",
-    "@servicenow/sdk-build-core": "3.0.2",
-    "@sonisoft/now-sdk-ext-core": "^1.0.0-alpha.31",
+    "@sonisoft/now-sdk-ext-core": "^1.0.0-alpha.32",
     "@ts-morph/common": "^0.24.0",
     "cometd": "^8.0.4",
     "cometd-nodejs-client": "^2.0.0",
@@ -31,6 +30,7 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",
+    "@oclif/core": "^4.5.1",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^4",
     "@supercharge/fs": "^3.4.2",
@@ -88,6 +88,9 @@
     "topics": {
       "exec": {
         "description": "Execute scripts remotely on a ServiceNow instance. Immitates using Scripts - Background from within ServiceNow."
+      },
+      "app": {
+        "description": "Operations on ServiceNow Applications."
       }
     }
   },