@sonisoft/now-sdk-ext-cli 1.0.0-alpha.0

package/README.md

@@ -0,0 +1,392 @@
+@sonisoft/now-sdk-ext-cli
+=================
+
+A CLI extending the functionality of the ServiceNow SDK.
+
+Future capabilities will be expanded, but currently this CLI will allow you to execute a javascript file that resides on your local computer in a ServiceNow instance remotely.
+This mimicks the functionality of using Scripts - Background and has all of the caveats and warnings carried in doing so.
+
+This library extends the ServiceNow SDK published originally in Washington DC.  Currently you must use the ServiceNow SDK to configure your authentication credentials for a particular ServiceNow instance. Then the credential alias configured using the ServiceNow SDK can be passed
+to the command(s) below.
+
+The library has a built in dependency for @servicenow/sdk version 2.0.1. 
+You will need to install the SDK globally separately in order to use the now-sdk command.
+
+Note: 
+One of the current limitations of the ServiceNow SDK is that it does not work if Multifactor Authentication is enable on the user that is being used with the SDK. 
+Either MFA on the instance needs to be turned off, or the local user account being used needs to be excluded from the MFA configuration.
+-- Future work of this CLI is intended to overcome this issue.
+
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @sonisoft/now-sdk-ext-cli
+$ nex COMMAND
+running command...
+$ nex (--version)
+@sonisoft/now-sdk-ext-cli/1.0.0-alpha.0 darwin-arm64 node-v22.2.0
+$ nex --help [COMMAND]
+USAGE
+  $ nex COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`nex exec SCOPE FILE`](#nex-exec-scope-file)
+* [`nex help [COMMAND]`](#nex-help-command)
+* [`nex plugins`](#nex-plugins)
+* [`nex plugins add PLUGIN`](#nex-plugins-add-plugin)
+* [`nex plugins:inspect PLUGIN...`](#nex-pluginsinspect-plugin)
+* [`nex plugins install PLUGIN`](#nex-plugins-install-plugin)
+* [`nex plugins link PATH`](#nex-plugins-link-path)
+* [`nex plugins remove [PLUGIN]`](#nex-plugins-remove-plugin)
+* [`nex plugins reset`](#nex-plugins-reset)
+* [`nex plugins uninstall [PLUGIN]`](#nex-plugins-uninstall-plugin)
+* [`nex plugins unlink [PLUGIN]`](#nex-plugins-unlink-plugin)
+* [`nex plugins update`](#nex-plugins-update)
+
+## `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.
+
+```
+USAGE
+  $ nex exec SCOPE FILE [--json] [-a <value>] [--log-level debug|warn|error|info|trace]
+
+ARGUMENTS
+  SCOPE  Scope to execute file in.
+  FILE   File to execute in scripts background.
+
+FLAGS
+  -a, --auth=<value>  Auth alias to use.
+
+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 exec exec global test.js --auth sn_alias
+  test
+```
+
+## `nex help [COMMAND]`
+
+Display help for nex.
+
+```
+USAGE
+  $ nex help [COMMAND...] [-n]
+
+ARGUMENTS
+  COMMAND...  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for nex.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.13/src/commands/help.ts)_
+
+## `nex plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ nex plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ nex plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/index.ts)_
+
+## `nex plugins add PLUGIN`
+
+Installs a plugin into nex.
+
+```
+USAGE
+  $ nex plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into nex.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the NEX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the NEX_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ nex plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ nex plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ nex plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ nex plugins add someuser/someplugin
+```
+
+## `nex plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ nex plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN...  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+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)_
+
+## `nex plugins install PLUGIN`
+
+Installs a plugin into nex.
+
+```
+USAGE
+  $ nex plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into nex.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the NEX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the NEX_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ nex plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ nex plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ nex plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ 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)_
+
+## `nex plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ nex plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+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'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+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)_
+
+## `nex plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ nex plugins remove [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ nex plugins unlink
+  $ nex plugins remove
+
+EXAMPLES
+  $ nex plugins remove myplugin
+```
+
+## `nex plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ nex plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --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)_
+
+## `nex plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ nex plugins uninstall [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ nex plugins unlink
+  $ nex plugins remove
+
+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)_
+
+## `nex plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ nex plugins unlink [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  PLUGIN...  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ nex plugins unlink
+  $ nex plugins remove
+
+EXAMPLES
+  $ nex plugins unlink myplugin
+```
+
+## `nex plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ nex plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.10/src/commands/plugins/update.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+// eslint-disable-next-line n/shebang
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

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

@@ -0,0 +1,13 @@
+import { AuthenticatedCommand } from '../../common/authenticated-command.js';
+export declare class Exec extends AuthenticatedCommand<typeof Exec> {
+    static args: {
+        scope: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
+        file: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    private _logger;
+    run(): Promise<void>;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commands/exec/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAA;AAE5E,qBAAa,IAAK,SAAQ,oBAAoB,CAAC,OAAO,IAAI,CAAC;IAEzD,MAAM,CAAC,IAAI;;;MAGV;IAED,MAAM,CAAC,WAAW,SAAuQ;IAEzR,MAAM,CAAC,QAAQ,WAId;IAED,MAAM,CAAC,KAAK,KAEX;IAED,OAAO,CAAC,OAAO,CAAoC;IAE7C,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CA+B3B"}

package/dist/commands/exec/index.js

@@ -0,0 +1,51 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable perfectionist/sort-objects */
+import { Args } from '@oclif/core';
+import { 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 Exec extends AuthenticatedCommand {
+    static args = {
+        scope: Args.string({ description: 'Scope to execute file in.', required: true }),
+        file: Args.string({ description: 'File to execute in scripts background.', required: true }),
+    };
+    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}),
+    };
+    _logger = new Logger("ExecCommand");
+    async run() {
+        const { args, flags } = await this.parse(Exec);
+        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/exec/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/exec/index.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,+CAA+C;AAC/C,OAAO,EAAC,IAAI,EAAiB,MAAM,aAAa,CAAA;AAChD,OAAO,EAAmC,wBAAwB,EAAG,MAAM,EAAE,aAAa,EAAuB,MAAM,4BAA4B,CAAC;AACpJ,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,oBAAoB,EAAE,MAAM,uCAAuC,CAAA;AAE5E,MAAM,OAAO,IAAK,SAAQ,oBAAiC;IAEzD,MAAM,CAAC,IAAI,GAAG;QACZ,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,2BAA2B,EAAE,QAAQ,EAAE,IAAI,EAAC,CAAC;QAC9E,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,EAAC,WAAW,EAAE,wCAAwC,EAAE,QAAQ,EAAE,IAAI,EAAC,CAAC;KAC3F,CAAA;IAED,MAAM,CAAC,WAAW,GAAG,mQAAmQ,CAAC;IAEzR,MAAM,CAAC,QAAQ,GAAG;QAChB;;CAEH;KACE,CAAA;IAED,MAAM,CAAC,KAAK,GAAG;IACb,uFAAuF;KACxF,CAAA;IAEO,OAAO,GAAU,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC;IAEnD,KAAK,CAAC,GAAG;QACP,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE7C,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,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAE,CAAC;gBAAA,CAAC;gBACrG,MAAM,MAAM,GAAmC,MAAM,QAAQ,CAAC,aAAa,CAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAE,CAAC;gBAC5G,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/dist/common/authenticated-command.d.ts

@@ -0,0 +1,21 @@
+import { Command, Interfaces } from '@oclif/core';
+import { Logger, ServiceNowInstance } from '@sonisoft/now-sdk-ext-core';
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<T['flags'] & typeof AuthenticatedCommand['baseFlags']>;
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export declare abstract class AuthenticatedCommand<T extends typeof Command> extends Command {
+    static baseFlags: {
+        auth: Interfaces.OptionFlag<string | undefined, Interfaces.CustomOptions>;
+        'log-level': Interfaces.OptionFlag<"info" | "debug" | "warn" | "error" | "trace", Interfaces.CustomOptions>;
+    };
+    static enableJsonFlag: boolean;
+    protected args: Args<T>;
+    protected authLogger: Logger;
+    protected flags: Flags<T>;
+    protected instance: ServiceNowInstance;
+    protected catch(err: {
+        exitCode?: number;
+    } & Error): Promise<any>;
+    protected finally(_: Error | undefined): Promise<any>;
+    init(): Promise<void>;
+}
+//# sourceMappingURL=authenticated-command.d.ts.map

package/dist/common/authenticated-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticated-command.d.ts","sourceRoot":"","sources":["../../src/common/authenticated-command.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAS,UAAU,EAAE,MAAM,aAAa,CAAA;AAExD,OAAO,EAAsB,MAAM,EAAE,kBAAkB,EAA8B,MAAM,4BAA4B,CAAC;AAExH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,OAAO,OAAO,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,OAAO,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAA;AAC7H,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,OAAO,OAAO,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;AAE/E,8BAAsB,oBAAoB,CAAC,CAAC,SAAS,OAAO,OAAO,CAAE,SAAQ,OAAO;IAElF,MAAM,CAAC,SAAS;;;MASf;IAGC,MAAM,CAAC,cAAc,UAAO;IAE5B,SAAS,CAAC,IAAI,EAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,SAAS,CAAC,UAAU,EAAC,MAAM,CAAsC;IACjE,SAAS,CAAC,KAAK,EAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAG3B,SAAS,CAAC,QAAQ,EAAE,kBAAkB,CAAC;cAEzB,KAAK,CAAC,GAAG,EAAE;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;cAQrD,OAAO,CAAC,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IAK9C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CA+BnC"}

package/dist/common/authenticated-command.js

@@ -0,0 +1,60 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Command, Flags } from '@oclif/core';
+import { CredentialWrapper, Logger, ServiceNowInstance } from '@sonisoft/now-sdk-ext-core';
+export class AuthenticatedCommand extends Command {
+    //   // define flags that can be inherited by any command that extends BaseCommand
+    static baseFlags = {
+        'auth': Flags.string({ char: 'a', description: 'Auth alias to use.', required: false }),
+        'log-level': Flags.option({
+            default: 'info',
+            helpGroup: 'GLOBAL',
+            options: ['debug', 'warn', 'error', 'info', 'trace'],
+            summary: 'Specify level for logging.',
+        })(),
+    };
+    // add the --json flag
+    static enableJsonFlag = true;
+    args;
+    authLogger = new Logger("AuthenticatedCommand");
+    flags;
+    instance;
+    async catch(err) {
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        this.authLogger.error("Globally caught exception occurred.", err);
+        return super.catch(err);
+    }
+    async finally(_) {
+        // called after run and catch regardless of whether or not the command errored
+        return super.finally(_);
+    }
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            args: this.ctor.args,
+            baseFlags: super.ctor.baseFlags,
+            enableJsonFlag: this.ctor.enableJsonFlag,
+            flags: this.ctor.flags,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+        const wrapper = new CredentialWrapper();
+        const credential = await (flags.auth ? wrapper.getStoredCredentialsByAlias(flags.auth) : wrapper.getStoredCredentialsByAlias('fluent-default'));
+        this.authLogger.debug("Credentials Received: ", credential);
+        if (credential) {
+            const snSettings = {
+                alias: flags.auth,
+                host: credential.host,
+                password: credential.password,
+                username: credential.username,
+            };
+            this.authLogger.debug("SN auth settings to instantiate ServiceNowInstance object: ", snSettings);
+            this.instance = new ServiceNowInstance(snSettings);
+        }
+        else {
+            this.authLogger.error("Either credential not found or no credentials created.", { args: this.args, flags: this.flags });
+        }
+    }
+}
+//# sourceMappingURL=authenticated-command.js.map

package/dist/common/authenticated-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authenticated-command.js","sourceRoot":"","sources":["../../src/common/authenticated-command.ts"],"names":[],"mappings":"AAAA,uDAAuD;AAEvD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAc,MAAM,aAAa,CAAA;AAExD,OAAO,EAAE,iBAAiB,EAAG,MAAM,EAAE,kBAAkB,EAA8B,MAAM,4BAA4B,CAAC;AAKxH,MAAM,OAAgB,oBAA+C,SAAQ,OAAO;IACpF,kFAAkF;IAChF,MAAM,CAAC,SAAS,GAAG;QACjB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,EAAC,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,oBAAoB,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC;QACrF,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAU;YAC7D,OAAO,EAAE,4BAA4B;SAEtC,CAAC,EAAE;KACL,CAAA;IAEC,sBAAsB;IACtB,MAAM,CAAC,cAAc,GAAG,IAAI,CAAA;IAElB,IAAI,CAAW;IACf,UAAU,GAAU,IAAI,MAAM,CAAC,sBAAsB,CAAC,CAAC;IACvD,KAAK,CAAY;IAGjB,QAAQ,CAAqB;IAE/B,KAAK,CAAC,KAAK,CAAC,GAAgC;QACpD,yDAAyD;QACzD,mDAAmD;QACnD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAC;QAElE,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACzB,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,CAAoB;QAC1C,8EAA8E;QAC9E,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC;YACrC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACpB,SAAS,EAAG,KAAK,CAAC,IAAoC,CAAC,SAAS;YAChE,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc;YACxC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;YACtB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;SACzB,CAAC,CAAA;QAEF,IAAI,CAAC,KAAK,GAAG,KAAiB,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAe,CAAA;QAG3B,MAAM,OAAO,GAAqB,IAAI,iBAAiB,EAAE,CAAC;QAC1D,MAAM,UAAU,GAAS,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,2BAA2B,CAAE,gBAAgB,CAAC,CAAC,CAAC;QACvJ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,wBAAwB,EAAE,UAAU,CAAC,CAAC;QAC5D,IAAG,UAAU,EAAC,CAAC;YACZ,MAAM,UAAU,GAA8B;gBACzC,KAAK,EAAE,KAAK,CAAC,IAAI;gBACjB,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,QAAQ,EAAE,UAAU,CAAC,QAAQ;gBAC7B,QAAQ,EAAE,UAAU,CAAC,QAAQ;aAChC,CAAA;YACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,6DAA6D,EAAE,UAAU,CAAC,CAAC;YACjG,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAkB,CAAC,UAAU,CAAC,CAAC;QACvD,CAAC;aAAI,CAAC;YACF,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,wDAAwD,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAC,CAAC,CAAC;QAC1H,CAAC;IAEH,CAAC"}

package/dist/common/base-command.d.ts

@@ -0,0 +1,19 @@
+import { Command, Interfaces } from '@oclif/core';
+import { Logger } from '@sonisoft/now-sdk-ext-core';
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<T['flags'] & typeof BaseCommand['baseFlags']>;
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export declare abstract class BaseCommand<T extends typeof Command> extends Command {
+    static baseFlags: {
+        'log-level': Interfaces.OptionFlag<"info" | "debug" | "warn" | "error" | "trace", Interfaces.CustomOptions>;
+    };
+    static enableJsonFlag: boolean;
+    protected args: Args<T>;
+    protected flags: Flags<T>;
+    protected logger: Logger;
+    protected catch(err: {
+        exitCode?: number;
+    } & Error): Promise<any>;
+    protected finally(_: Error | undefined): Promise<any>;
+    init(): Promise<void>;
+}
+//# sourceMappingURL=base-command.d.ts.map

package/dist/common/base-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-command.d.ts","sourceRoot":"","sources":["../../src/common/base-command.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,OAAO,EAAS,UAAU,EAAC,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAEnD,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,OAAO,OAAO,IAAI,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,OAAO,WAAW,CAAC,WAAW,CAAC,CAAC,CAAA;AACpH,MAAM,MAAM,IAAI,CAAC,CAAC,SAAS,OAAO,OAAO,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAA;AAE/E,8BAAsB,WAAW,CAAC,CAAC,SAAS,OAAO,OAAO,CAAE,SAAQ,OAAO;IAEzE,MAAM,CAAC,SAAS;;MAOf;IAGD,MAAM,CAAC,cAAc,UAAO;IAE5B,SAAS,CAAC,IAAI,EAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,SAAS,CAAC,KAAK,EAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3B,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;cAET,KAAK,CAAC,GAAG,EAAE;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC;cAQrD,OAAO,CAAC,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC;IAO9C,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAenC"}

package/dist/common/base-command.js

@@ -0,0 +1,43 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Command, Flags } from '@oclif/core';
+import { Logger } from '@sonisoft/now-sdk-ext-core';
+export class BaseCommand extends Command {
+    // define flags that can be inherited by any command that extends BaseCommand
+    static baseFlags = {
+        'log-level': Flags.option({
+            default: 'info',
+            helpGroup: 'GLOBAL',
+            options: ['debug', 'warn', 'error', 'info', 'trace'],
+            summary: 'Specify level for logging.',
+        })(),
+    };
+    // add the --json flag
+    static enableJsonFlag = true;
+    args;
+    flags;
+    logger;
+    async catch(err) {
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        this.logger.error("Globally caught exception occurred.", err);
+        return super.catch(err);
+    }
+    async finally(_) {
+        // called after run and catch regardless of whether or not the command errored
+        return super.finally(_);
+    }
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            args: this.ctor.args,
+            baseFlags: super.ctor.baseFlags,
+            enableJsonFlag: this.ctor.enableJsonFlag,
+            flags: this.ctor.flags,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+        this.logger = new Logger("");
+    }
+}
+//# sourceMappingURL=base-command.js.map

package/dist/common/base-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-command.js","sourceRoot":"","sources":["../../src/common/base-command.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,OAAO,EAAC,OAAO,EAAE,KAAK,EAAa,MAAM,aAAa,CAAA;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAKnD,MAAM,OAAgB,WAAsC,SAAQ,OAAO;IACzE,6EAA6E;IAC7E,MAAM,CAAC,SAAS,GAAG;QACjB,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC;YACxB,OAAO,EAAE,MAAM;YACf,SAAS,EAAE,QAAQ;YACnB,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAU;YAC7D,OAAO,EAAE,4BAA4B;SACtC,CAAC,EAAE;KACL,CAAA;IAED,sBAAsB;IACtB,MAAM,CAAC,cAAc,GAAG,IAAI,CAAA;IAElB,IAAI,CAAW;IACf,KAAK,CAAY;IACjB,MAAM,CAAS;IAEf,KAAK,CAAC,KAAK,CAAC,GAAgC;QACpD,yDAAyD;QACzD,mDAAmD;QACnD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qCAAqC,EAAE,GAAG,CAAC,CAAC;QAE9D,OAAO,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACzB,CAAC;IAES,KAAK,CAAC,OAAO,CAAC,CAAoB;QAC1C,8EAA8E;QAG9E,OAAO,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACzB,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,KAAK,CAAC,IAAI,EAAE,CAAA;QAClB,MAAM,EAAC,IAAI,EAAE,KAAK,EAAC,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC;YACrC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI;YACpB,SAAS,EAAG,KAAK,CAAC,IAA2B,CAAC,SAAS;YACvD,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc;YACxC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK;YACtB,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;SACzB,CAAC,CAAA;QACF,IAAI,CAAC,KAAK,GAAG,KAAiB,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAe,CAAA;QAG3B,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { run } from '@oclif/core';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAC,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { run } from '@oclif/core';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAC,MAAM,aAAa,CAAA"}

package/oclif.manifest.json

@@ -0,0 +1,73 @@
+{
+  "commands": {
+    "exec": {
+      "aliases": [],
+      "args": {
+        "scope": {
+          "description": "Scope to execute file in.",
+          "name": "scope",
+          "required": true
+        },
+        "file": {
+          "description": "File to execute in scripts background.",
+          "name": "file",
+          "required": true
+        }
+      },
+      "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"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "exec",
+      "pluginAlias": "@sonisoft/now-sdk-ext-cli",
+      "pluginName": "@sonisoft/now-sdk-ext-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "exec",
+        "index.js"
+      ]
+    }
+  },
+  "version": "1.0.0-alpha.0"
+}

package/package.json

@@ -0,0 +1,111 @@
+{
+  "name": "@sonisoft/now-sdk-ext-cli",
+  "description": "A CLI extending the functionality of the ServiceNow SDK.",
+  "version": "1.0.0-alpha.0",
+  "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": "2.0.1",
+    "@servicenow/sdk-build": "2.0.1",
+    "@servicenow/sdk-cli": "2.0.1",
+    "@servicenow/sdk-cli-core": "2.0.1",
+    "@servicenow/sdk-core": "2.0.1",
+    "@servicenow/sdk-project": "2.0.1",
+    "@sonisoft/now-sdk-ext-core": "^1.0.0-alpha.6",
+    "@ts-morph/common": "^0.24.0",
+    "cometd": "^8.0.4",
+    "cometd-nodejs-client": "^2.0.0",
+    "fast-xml-parser": "^4.4.1",
+    "fs-extra": "^11.2.0",
+    "winston": "3.14.2",
+    "ws": "^8.18.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@jest/globals": "^29.7.0",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^4",
+    "@supercharge/fs": "^3.4.2",
+    "@types/chai": "^4",
+    "@types/jest": "^29.5.12",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "@typescript-eslint/typescript-estree": "^8.4.0",
+    "chai": "^4",
+    "eslint": "^8",
+    "eslint-config-oclif": "^5.2.1",
+    "eslint-config-oclif-typescript": "^3.1.10",
+    "eslint-config-prettier": "^9",
+    "jest": "^29.7.0",
+    "jest-junit": "^16.0.0",
+    "oclif": "^4",
+    "rimraf": "^6.0.1",
+    "shx": "^0.3.3",
+    "ts-jest": "^29.2.5",
+    "ts-jest-mocker": "^1.0.0",
+    "ts-node": "10.9.2",
+    "tslint": "^5.20.1",
+    "typescript": "^5.5.4"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "/bin",
+    "/dist",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "",
+  "keywords": [
+    "oclif"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "type": "module",
+  "oclif": {
+    "bin": "nex",
+    "commands": {
+      "strategy": "pattern",
+      "target": "./dist/commands",
+      "globPatterns": [
+        "**/*.+(js|cjs|mjs|ts|tsx|mts|cts)",
+        "!**/*.+(d.*|test.*|spec.*|helpers.*)?(x)"
+      ]
+    },
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "exec": {
+        "description": "Execute scripts remotely on a ServiceNow instance. Immitates using Scripts - Background from within ServiceNow."
+      }
+    }
+  },
+  "repository": "",
+  "scripts": {
+    "prepublish": "npm version prerelease",
+    "publish-registry": "npm publish",
+    "clean": "rimraf dist && rimraf tsconfig.tsbuildinfo",
+    "alpha": "npm version premajor --preid alpha",
+    "beta": " npm version premajor --preid beta",
+    "buildts": "tsc -p ./",
+    "buildp": "npm run buildts && npm run lint",
+    "build": "npm run clean && npm run buildts",
+    "lint": "eslint . --ext .ts",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "npm run lint",
+    "prepack": "oclif manifest && oclif readme",
+    "test": "node --experimental-vm-modules node_modules/.bin/jest --forceExit --verbose=true --silent=false --json=false --useStderr=false",
+    "version": "oclif readme && git add README.md"
+  },
+  "types": "dist/index.d.ts"
+}