@servicenow/sdk 1.0.2 → 1.0.6

package/README.md

@@ -1,24 +1,86 @@
-# @servicenow/sdk
+# ServiceNow SDK
 
-The Servicenow SDK!
+Use the ServiceNow software development kit (SDK) to add JavaScript modules and third-party libraries to applications locally and upload changes to an instance of the Now Platform.
 
-## Pre-requisites
+# Overview
 
-* Node.js v16
-* npm v8
+With the ServiceNow SDK, developers can create and modify scoped applications with custom modules and third-party libraries in Visual Studio Code and deploy those applications to a non-production instance on the Washington DC release. Writing ServiceNow applications outside of a ServiceNow instance enables you to use industry-standard development practices and familiar tools and catch errors at build-time rather than at run-time only.
+
+For more information see the [SDK Overview documentation](https://docs.servicenow.com/bundle/washingtondc-api-reference/page/script/sdk/concept/servicenow-sdk.html) or the [CLI Overview](https://docs.servicenow.com/bundle/washingtondc-api-reference/page/script/sdk/reference/servicenow-sdk-cli-commands.html)
 
 ## Installation
 
+Install the ServiceNow software development kit (SDK) locally using Node Package Manager (npm).
+
+### Before you begin
+
+Your system must meet the following requirements to use npm to install the SDK:
+* Node.js v16.16.0 or later
+* npm v8.11.0 or later
+
+To install or upgrade Node.js or npm, see the [installation instructions](https://docs.npmjs.com/cli/v8/configuring-npm/install) on the npm website.
+
+### Procedure
+
+1. Open a command-line tool on your system.
+2. Verify that your system meets the requirements.
+    a. Enter `node –v`​ to check if you have Node.js installed and which version.
+    b. Enter `npm –v`​ to check if you have npm installed and which version.
+3. Enter the following command to install the SDK:
 ```bash
 npm install --global @servicenow/sdk
 ```
 
 ## Usage
 
-### Command list
+### Authentication
+
+Authenticate with a ServiceNow instance using a user account with an `admin` role.
 
 ```bash
-now-sdk --help
+now-sdk auth save default
 ```
 
-Refer to [ServiceNow ](https://docs.servicenow.com/bundle/washingtondc-api-reference/page/script/sdk/reference/servicenow-sdk-cli-commands.html) docs for more information
+View credentials saved in the device keychain or credential manager on your system.
+
+```bash
+now-sdk auth list
+```
+
+### Creating an app
+
+Create a new scoped application, optionally including a sample table.
+
+**Note**: Replace `{vendorprefix}` with your organization's unique scope prefix.
+```bash
+now-sdk create sdk_demo x_{vendorprefix}_demo --sampleTable
+```
+
+### Building code changes
+
+Compile source files and generate a deployable package. Third-party library dependencies are converted into XML files that can be installed with the application.
+
+```bash
+now-sdk build
+```
+
+### Deploying app updates
+
+Deploy an application to an instance. Before using the deploy command, you must use the build command to generate a deployable package.
+
+```bash
+now-sdk deploy
+```
+
+### Synchronizing changes from the instance
+
+Download application metadata from an instance and update the metadata XML files in your local application to match.
+
+```bash
+now-sdk fetch
+```
+
+## What to do next
+
+Use the ServiceNow SDK to create a scoped application or convert an existing application for use with the SDK. For more information, see [Create or convert an application with the ServiceNow SDK](https://docs.servicenow.com/bundle/washingtondc-api-reference/page/script/sdk/task/create-application-now-sdk.html).
+

package/dist/command/build/index.js

@@ -83,7 +83,11 @@ exports.build = {
                 writeMetrics(workingDir);
             }
             catch (error) {
-                logger.error(error instanceof Error ? (_a = error.stack) !== null && _a !== void 0 ? _a : error.message : error, error);
+                const errorMessage = error instanceof Error ? error.message : error;
+                if (args.debug) {
+                    logger.error(error instanceof Error ? (_a = error.stack) !== null && _a !== void 0 ? _a : error.message : error, error);
+                }
+                logger.error(errorMessage);
             }
         });
     },

package/dist/command/build/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/command/build/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,0DAA4B;AAC5B,qCAAgC;AAWnB,QAAA,KAAK,GAAsC;IACpD,OAAO,EAAE,gBAAgB;IACzB,QAAQ,EAAE,gEAAgE;IAC1E,OAAO,EAAE,CAAC,KAAW,EAAE,EAAE;QACrB,OAAO,KAAK;aACP,UAAU,CAAC,QAAQ,EAAE;YAClB,QAAQ,EAAE,wBAAwB;YAClC,OAAO,EAAE,IAAA,UAAG,GAAE;YACd,IAAI,EAAE,QAAQ;SACjB,CAAC;aACD,MAAM,CAAC,OAAO,EAAE;YACb,QAAQ,EAAE,oBAAoB;YAC9B,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,SAAS;SAClB,CAAC;aACD,MAAM,CAAC,kBAAkB,EAAE;YACxB,QAAQ,EAAE,iEAAiE;YAC3E,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;SAClB,CAAC;aACD,MAAM,CAAC,MAAM,EAAE;YACZ,QAAQ,EAAE,8BAA8B;YACxC,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;SAClB,CAAC;aACD,MAAM,CAAC,UAAU,EAAE;YAChB,QAAQ,EAAE,yDAAyD;YACnE,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;SACb,CAAC;aACD,MAAM,CAAC,cAAc,EAAE;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,MAAM,EAAE,IAAI;SACf,CAAC,CAAA;IACV,CAAC;IACD,OAAO,EAAE,UAAgB,IAAmC;;;YACxD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,wDAAwD,CAAC,CAAA;YACzF,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAA;YAE9C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,sDAAsD,CAAC,CAAA;YACtF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,qDAAqD,CAAC,CAAA;YACpF,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,iEAAiE,CAAC,CAAA;YAC3G,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,MAAM,CACxC,qEAAqE,CACxE,CAAA;YACD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,wDAAwD,CAAC,CAAA;YAC1F,MAAM,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,GAAG,MAAM,MAAM,CAC1E,uDAAuD,CAC1D,CAAA;YACD,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,MAAM,CAAC,uDAAuD,CAAC,CAAA;YACpG,IAAI,CAAC;gBACD,MAAM,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC5C,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAA;gBAChD,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAA;gBAC5C,MAAM,KAAK,CAAC,UAAU,CAAC,CAAA;gBACvB,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,UAAU,EAAE,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;gBAC1F,MAAM,eAAe,CAAC,UAAU,EAAE,eAAe,EAAE,YAAY,CAAC,CAAA;gBAChE,IAAI,kBAAkB,EAAE,CAAC;oBACrB,MAAM,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;gBACzC,CAAC;gBACD,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBACnC,MAAM,IAAI,CAAC,UAAU,EAAE,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;gBAClE,kBAAkB,CAAC,UAAU,CAAC,CAAA;gBAC9B,YAAY,CAAC,UAAU,CAAC,CAAA;YAC5B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,MAAA,KAAK,CAAC,KAAK,mCAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,KAAgB,EAAE,KAAK,CAAC,CAAA;YAClG,CAAC;;KACJ;CACJ,CAAA;AAED,SAAe,YAAY,CAAC,UAAkB;;QAC1C,MAAM,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,GAAG,MAAM,MAAM,CAClE,gDAAgD,CACnD,CAAA;QAED,oBAAoB,CAAC,CAAC,4BAA4B,EAAE,2BAA2B,CAAC,EAAE,UAAU,CAAC,CAAA;QAC7F,uBAAuB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAA;IACtD,CAAC;CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/command/build/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,0DAA4B;AAC5B,qCAAgC;AAWnB,QAAA,KAAK,GAAsC;IACpD,OAAO,EAAE,gBAAgB;IACzB,QAAQ,EAAE,gEAAgE;IAC1E,OAAO,EAAE,CAAC,KAAW,EAAE,EAAE;QACrB,OAAO,KAAK;aACP,UAAU,CAAC,QAAQ,EAAE;YAClB,QAAQ,EAAE,wBAAwB;YAClC,OAAO,EAAE,IAAA,UAAG,GAAE;YACd,IAAI,EAAE,QAAQ;SACjB,CAAC;aACD,MAAM,CAAC,OAAO,EAAE;YACb,QAAQ,EAAE,oBAAoB;YAC9B,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,SAAS;SAClB,CAAC;aACD,MAAM,CAAC,kBAAkB,EAAE;YACxB,QAAQ,EAAE,iEAAiE;YAC3E,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;SAClB,CAAC;aACD,MAAM,CAAC,MAAM,EAAE;YACZ,QAAQ,EAAE,8BAA8B;YACxC,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;SAClB,CAAC;aACD,MAAM,CAAC,UAAU,EAAE;YAChB,QAAQ,EAAE,yDAAyD;YACnE,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;SACb,CAAC;aACD,MAAM,CAAC,cAAc,EAAE;YACpB,QAAQ,EAAE,kFAAkF;YAC5F,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,MAAM,EAAE,IAAI;SACf,CAAC,CAAA;IACV,CAAC;IACD,OAAO,EAAE,UAAgB,IAAmC;;;YACxD,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,MAAM,CAAC,wDAAwD,CAAC,CAAA;YACzF,MAAM,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAA;YAE9C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,sDAAsD,CAAC,CAAA;YACtF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,qDAAqD,CAAC,CAAA;YACpF,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,MAAM,CAAC,iEAAiE,CAAC,CAAA;YAC3G,MAAM,EAAE,mBAAmB,EAAE,GAAG,MAAM,MAAM,CACxC,qEAAqE,CACxE,CAAA;YACD,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,MAAM,CAAC,wDAAwD,CAAC,CAAA;YAC1F,MAAM,EAAE,sBAAsB,EAAE,6BAA6B,EAAE,GAAG,MAAM,MAAM,CAC1E,uDAAuD,CAC1D,CAAA;YACD,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,MAAM,CAAC,uDAAuD,CAAC,CAAA;YACpG,IAAI,CAAC;gBACD,MAAM,UAAU,GAAG,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC5C,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAA;gBAChD,MAAM,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAA;gBAC5C,MAAM,KAAK,CAAC,UAAU,CAAC,CAAA;gBACvB,MAAM,YAAY,GAAG,MAAM,mBAAmB,CAAC,UAAU,EAAE,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;gBAC1F,MAAM,eAAe,CAAC,UAAU,EAAE,eAAe,EAAE,YAAY,CAAC,CAAA;gBAChE,IAAI,kBAAkB,EAAE,CAAC;oBACrB,MAAM,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;gBACzC,CAAC;gBACD,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBACnC,MAAM,IAAI,CAAC,UAAU,EAAE,6BAA6B,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;gBAClE,kBAAkB,CAAC,UAAU,CAAC,CAAA;gBAC9B,YAAY,CAAC,UAAU,CAAC,CAAA;YAC5B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,KAAgB,CAAA;gBAC/E,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACb,MAAM,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,MAAA,KAAK,CAAC,KAAK,mCAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,KAAgB,EAAE,KAAK,CAAC,CAAA;gBAClG,CAAC;gBACD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;YAC9B,CAAC;;KACJ;CACJ,CAAA;AAED,SAAe,YAAY,CAAC,UAAkB;;QAC1C,MAAM,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,GAAG,MAAM,MAAM,CAClE,gDAAgD,CACnD,CAAA;QAED,oBAAoB,CAAC,CAAC,4BAA4B,EAAE,2BAA2B,CAAC,EAAE,UAAU,CAAC,CAAA;QAC7F,uBAAuB,CAAC,aAAa,EAAE,UAAU,CAAC,CAAA;IACtD,CAAC;CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@servicenow/sdk",
-    "version": "1.0.2",
+    "version": "1.0.6",
     "description": "ServiceNow SDK CLI",
     "license": "MIT",
     "bin": {
@@ -24,7 +24,7 @@
     },
     "dependencies": {
         "@inquirer/prompts": "3.1.1",
-        "@servicenow/sdk-cli-core": "*",
+        "@servicenow/sdk-cli-core": "1.0.6",
         "chalk": "4.1.2",
         "yargs": "17.6.2",
         "semver": "7.5.4"
@@ -36,7 +36,7 @@
         "keytar": "7.9.0"
     },
     "engines": {
-        "node": "16.16.0",
-        "npm": "8.11.0"
+        "node": ">=16.16.0",
+        "npm": ">=8.11.0"
     }
-}
+}

package/src/command/build/index.ts

@@ -81,7 +81,11 @@ export const build: CommandModule<unknown, Arguments> = {
             moveDependencyXmls(workingDir)
             writeMetrics(workingDir)
         } catch (error) {
-            logger.error(error instanceof Error ? error.stack ?? error.message : (error as string), error)
+            const errorMessage = error instanceof Error ? error.message : (error as string)
+            if (args.debug) {
+                logger.error(error instanceof Error ? error.stack ?? error.message : (error as string), error)
+            }
+            logger.error(errorMessage)
         }
     },
 }