@servicenow/sdk 1.0.6 → 2.0.1

package/README.md

@@ -1,86 +1,34 @@
 # 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.
+The ServiceNow software development kit (SDK) provides the core libraries and tools for authoring applications with application metadata written in code using the ServiceNow Fluent language, as well as server-side JavaScript modules and third-party libraries. The SDK aims to transform the ServiceNow development experience by providing a source-driven model with modern, industry-standard development paradigms.
 
-# Overview
+## Prerequisites
 
-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)
+- Node.js `v18.16.1`
+- npm `v8.19.3`
 
 ## 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
+```sh
 npm install --global @servicenow/sdk
 ```
 
-## Usage
-
-### Authentication
-
-Authenticate with a ServiceNow instance using a user account with an `admin` role.
-
-```bash
-now-sdk auth save default
-```
-
-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
+## Upgrading
 
-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
+```sh
+now-sdk upgrade
 ```
 
-### Synchronizing changes from the instance
+## Documentation
 
-Download application metadata from an instance and update the metadata XML files in your local application to match.
+- [Using the ServiceNow SDK CLI](https://docs.servicenow.com/bundle/xanadu-application-development/page/build/servicenow-sdk/reference/servicenow-sdk-cli-commands.html)
+- [Overview of the ServiceNow Fluent Language](https://docs.servicenow.com/bundle/xanadu-application-development/page/build/servicenow-sdk/concept/servicenow-fluent.html)
+- [Installing the Fluent VS Code Extension](https://docs.servicenow.com/bundle/xanadu-application-development/page/build/servicenow-sdk/task/install-fluent-language-extension-vs-code.html)
 
-```bash
-now-sdk fetch
-```
+## Release Notes
 
-## What to do next
+View the release notes on the [ServiceNow documentation site](https://docs.servicenow.com/bundle/xanadu-release-notes/page/release-notes/now-platform-app-engine/servicenow-sdk-rn.html).
 
-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).
+## Known Issues
 
+View the list of known issues on the [ServiceNow support site](https://support.servicenow.com/problem_list.do?sysparm_query=u_product_initial_taxonomy=a859dddac3773510f9691f0fb00131ba^stateNOT%20IN23,3).

package/bin/debug.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node --inspect-brk
 
-require('../dist/index.js')
+require('@servicenow/sdk-cli')

package/bin/index.js

@@ -1,2 +1,3 @@
 #!/usr/bin/env node
-require('../dist/index.js')
+
+require('@servicenow/sdk-cli')

package/dist/api/index.d.ts

@@ -0,0 +1 @@
+export * from '@servicenow/sdk-api';