@sonisoft/now-sdk-ext-core 2.5.1 → 3.0.0

package/README.md

@@ -2,17 +2,31 @@
 
 [![npm version](https://img.shields.io/npm/v/@sonisoft/now-sdk-ext-core.svg)](https://www.npmjs.com/package/@sonisoft/now-sdk-ext-core)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
-[![Node.js Version](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)](https://nodejs.org)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org)
 
 A comprehensive TypeScript library that extends the ServiceNow SDK with powerful features for application management, automated testing, log monitoring, and more. Perfect for CI/CD pipelines, development automation, and DevOps workflows.
 
 ## ✨ Features
 
 - 🚀 **Application Management** - Install, upgrade, and manage ServiceNow applications programmatically
+- 🏪 **Store Application Management** - Search, install, and update apps from the ServiceNow Store
 - 🧪 **ATF Test Execution** - Run automated tests and get detailed results
 - 📊 **Real-time Log Monitoring** - Tail ServiceNow logs with two efficient methods
 - 🔄 **AMB (Asynchronous Message Bus)** - WebSocket-based real-time event monitoring
 - 📝 **Background Script Execution** - Execute server-side scripts programmatically
+- 📋 **Scope Management** - Set/get current application scope programmatically
+- 📦 **Update Set Management** - Create, clone, inspect, and manage update sets
+- 🔍 **Code Search** - Search across platform code, apps, and tables
+- 🗄️ **Schema Discovery** - Discover table schemas, explain fields, validate catalogs
+- 📎 **Attachment Management** - Upload, list, and retrieve file attachments
+- ⚡ **Batch Operations** - Bulk create/update with variable substitution and query-based bulk operations
+- 🔧 **Workflow Management** - Create complete workflows programmatically
+- 📌 **Task Operations** - Add comments, assign tasks, resolve/close incidents
+- 🔗 **Script Sync** - Bidirectional sync of scripts between local files and instance
+- 📈 **Aggregate Queries** - COUNT, AVG, MIN, MAX, SUM with GROUP BY via Stats API
+- 🏥 **Instance Health** - Version, cluster, stuck jobs, semaphore monitoring
+- 🗺️ **CMDB Relationships** - Query and traverse CI relationship graphs
+- 🔎 **Instance Discovery** - List tables, scoped apps, store apps, and plugins
 - 🔐 **Authentication** - Seamless integration with ServiceNow CLI authentication
 - 📡 **Table API** - Full CRUD operations on ServiceNow tables
 - 🛠️ **Type-Safe** - Complete TypeScript definitions for all APIs
@@ -25,9 +39,9 @@ npm install @sonisoft/now-sdk-ext-core
 
 ### Prerequisites
 
-- Node.js 14.x or higher
+- Node.js 18.x or higher
 - ServiceNow CLI configured with instance credentials
-- TypeScript 4.x or higher (optional, for TypeScript projects)
+- TypeScript 5.x or higher (optional, for TypeScript projects)
 
 ### ServiceNow CLI Setup
 
@@ -39,6 +53,32 @@ npm install -g @servicenow/sdk
 snc configure profile set
 ```
 
+## ⚠️ Breaking Change — v3.0.0 (ServiceNow SDK 4.3.0)
+
+> **If you are upgrading from v2.x, read this first.**
+>
+> This version upgrades the underlying ServiceNow SDK dependencies from **4.2.x to 4.3.0**. ServiceNow 4.3.0 **changed how credential aliases are stored**, replacing the previous `keytar`-based credential store with a new implementation.
+>
+> **What this means for you:**
+> - Credential aliases created with ServiceNow SDK 4.2.x **cannot be read** by SDK 4.3.x
+> - You **must re-create all instance aliases** after upgrading
+>
+> **Migration steps:**
+> ```bash
+> # 1. Update the global CLI
+> npm install -g @servicenow/sdk@4.3.0
+>
+> # 2. Re-add each instance alias
+> snc configure profile set
+> # — or —
+> npx @servicenow/sdk auth --add <your-alias>
+>
+> # 3. Verify your aliases work
+> npx @servicenow/sdk auth --list
+> ```
+>
+> All API surfaces in this library remain unchanged — only the underlying authentication storage has changed.
+
 ## 🚀 Quick Start
 
 ### Basic Connection
@@ -359,29 +399,60 @@ console.log('Return value:', result.result);
 
 - **`ServiceNowInstance`** - Instance connection and configuration
 - **`ServiceNowRequest`** - HTTP request handling with authentication
-- **`TableAPIRequest`** - ServiceNow Table API wrapper
+- **`TableAPIRequest`** - ServiceNow Table API wrapper (CRUD)
 
 ### Application Management
 
-- **`ApplicationManager`** - High-level application management
+- **`ApplicationManager`** - Install, upgrade, and validate applications via batch definitions
 - **`AppRepoApplication`** - App repository operations
-- **`BatchDefinition`** - Batch installation definitions
-- **`CompanyApplications`** - Company application queries
+- **`CompanyApplications`** - Store application search, install, update, and progress tracking
+
+### Scope & Configuration
+
+- **`ScopeManager`** - Set/get current application scope, list and retrieve applications
+- **`UpdateSetManager`** - Create, clone, inspect, move records, and manage update sets
 
 ### Testing & Automation
 
-- **`ATFTestExecutor`** - ATF test execution and monitoring
-- **`BackgroundScriptExecutor`** - Server-side script execution
+- **`ATFTestExecutor`** - ATF test execution and monitoring with progress tracking
+- **`BackgroundScriptExecutor`** - Server-side GlideScript execution
+
+### Code & Schema
+
+- **`CodeSearch`** - Search across platform code by term, app, or table
+- **`SchemaDiscovery`** - Discover table schemas, explain fields, validate catalog items
+
+### Data Operations
+
+- **`AttachmentManager`** - Upload, list, and retrieve file attachments
+- **`BatchOperations`** - Sequential bulk create/update with variable substitution
+- **`QueryBatchOperations`** - Query-based bulk update/delete with dry-run safety
+
+### Workflow & Task
+
+- **`WorkflowManager`** - Create complete workflows with activities, transitions, and conditions
+- **`TaskOperations`** - Add comments, assign tasks, resolve/close incidents, approve changes
+
+### Scripting
 
-### Logging & Monitoring
+- **`ScriptSync`** - Bidirectional sync of Script Includes, Business Rules, and more
 
-- **`SyslogReader`** - Log querying and real-time monitoring
-- **`AMBClient`** - Real-time event subscriptions
+### Monitoring & Discovery
+
+- **`AggregateQuery`** - COUNT, AVG, MIN, MAX, SUM with GROUP BY via Stats API
+- **`InstanceHealth`** - Version, cluster nodes, stuck jobs, semaphores, operational counts
+- **`CMDBRelationships`** - Query direct relationships and traverse CI graphs (BFS)
+- **`InstanceDiscovery`** - List tables, scoped apps, store apps, and plugins
+
+### Logging & Real-time Events
+
+- **`SyslogReader`** - Log querying, formatting, export, and real-time tailing
+- **`AMBClient`** - WebSocket-based real-time event subscriptions
 - **`MessageClientBuilder`** - AMB client configuration
 
 ### Utilities
 
-- **`Logger`** - Winston-based logging
+- **`Logger`** - Winston-based logging with file output
 - **`NowStringUtil`** - String manipulation utilities
 - **`AppUtil`** - Application utility functions
 
@@ -460,14 +531,41 @@ node docs/examples/syslog-tail.mjs your-instance error ./logs/errors.log
 
 Comprehensive documentation is available in the `/docs` directory:
 
+**Getting Started:**
 - **[Getting Started](./docs/GettingStarted.md)** - Setup and basic usage
 - **[API Reference](./docs/APIReference.md)** - Complete API documentation
+- **[Examples](./docs/examples/)** - Working code examples
+
+**Application & Scope Management:**
 - **[Application Manager](./docs/ApplicationManager.md)** - Application management guide
+- **[Store Applications](./docs/CompanyApplications.md)** - Store app search, install, and update
+- **[Scope Manager](./docs/ScopeManager.md)** - Application scope management
+- **[Update Set Manager](./docs/UpdateSetManager.md)** - Update set lifecycle management
+
+**Code, Schema & Search:**
+- **[Code Search](./docs/CodeSearch.md)** - Platform code search
+- **[Schema Discovery](./docs/SchemaDiscovery.md)** - Table schema and field discovery
+
+**Data Operations:**
+- **[Attachment Manager](./docs/AttachmentManager.md)** - File attachment operations
+- **[Batch Operations](./docs/BatchOperations.md)** - Bulk create/update with variable substitution
+- **[Query Batch Operations](./docs/QueryBatchOperations.md)** - Query-based bulk update/delete
+
+**Workflow, Task & Scripting:**
+- **[Workflow Manager](./docs/WorkflowManager.md)** - Programmatic workflow creation
+- **[Task Operations](./docs/TaskOperations.md)** - ITSM task management
+- **[Script Sync](./docs/ScriptSync.md)** - Bidirectional script synchronization
+
+**Monitoring & Discovery:**
+- **[Aggregate Query](./docs/AggregateQuery.md)** - Stats API aggregations
+- **[Instance Health](./docs/InstanceHealth.md)** - Health monitoring
+- **[CMDB Relationships](./docs/CMDBRelationships.md)** - CI relationship graph traversal
+- **[Instance Discovery](./docs/InstanceDiscovery.md)** - Table, app, and plugin discovery
+
+**Testing & Logging:**
 - **[ATF Test Executor](./docs/ATFTestExecutor.md)** - Testing automation
 - **[Syslog Reader](./docs/SyslogReader.md)** - Log monitoring guide
 - **[ChannelAjax Tailing](./docs/SyslogReaderChannelAjax.md)** - Advanced log tailing
-- **[AMB Guide](./docs/AMB_FIX_SUMMARY.md)** - Real-time event monitoring
-- **[Examples](./docs/examples/)** - Working code examples
 
 ## 🔧 Advanced Configuration
 
@@ -559,12 +657,14 @@ try {
 
 ## 📦 Dependencies
 
-- `@servicenow/sdk` - ServiceNow SDK
-- `@servicenow/sdk-cli` - ServiceNow CLI tools
-- `cometd` - WebSocket support for AMB
-- `xml2js` - XML parsing
-- `winston` - Logging
+- `@servicenow/sdk` 4.3.0 / `@servicenow/sdk-cli` 4.3.0 / `@servicenow/sdk-core` 4.3.0 - ServiceNow SDK and CLI tools
 - `axios` - HTTP client
+- `cometd` / `cometd-nodejs-client` - WebSocket support for AMB
+- `winston` - Logging
+- `xml2js` / `fast-xml-parser` - XML parsing
+- `ws` - WebSocket client
+- `zod` - Runtime schema validation
+- `lodash` - Utility functions
 
 ## 🧪 Testing
 
@@ -623,15 +723,10 @@ For issues, questions, or contributions:
 
 - [ ] GraphQL API support
 - [ ] Webhook integration
-- [ ] Enhanced batch operations
-- [ ] Performance metrics
-- [ ] CLI tool package
+- [ ] Performance metrics dashboard
+- [ ] Standalone CLI tool package
 - [ ] Plugin development tools
 
-## 📈 Version History
-
-See [CHANGELOG](./CHANGELOG.md) for version history and release notes.
-
 ---
 
 **Made with ❤️ for the ServiceNow Developer Community**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sonisoft/now-sdk-ext-core",
-  "version": "2.5.1",
+  "version": "3.0.0",
   "description": "Comprehensive TypeScript library extending ServiceNow SDK with application management, ATF testing, real-time log monitoring, AMB event subscriptions, and automation tools",
   "keywords": [
     "servicenow",
@@ -16,7 +16,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://git.sonisoft.io/sonisoft/now-sdk-ext-core.git"
+    "url": "https://github.com/sonisoft-cnanda/now-dev.git"
   },
   "type": "module",
   "author": "",
@@ -57,11 +57,11 @@
   "types": "./dist/index.d.ts",
   "dependencies": {
     "@servicenow/glide": "^26.0.1",
-    "@servicenow/sdk": "4.2.0",
-    "@servicenow/sdk-build-core": "4.0.2",
-    "@servicenow/sdk-cli": "4.2.0",
-    "@servicenow/sdk-cli-core": "3.0.2",
-    "@servicenow/sdk-core": "4.2.0",
+    "@servicenow/sdk": "4.3.0",
+    "@servicenow/sdk-build-core": "4.3.0",
+    "@servicenow/sdk-cli": "4.3.0",
+    "@servicenow/sdk-cli-core": "3.0.3",
+    "@servicenow/sdk-core": "4.3.0",
     "@ts-morph/common": "^0.24.0",
     "@types/mock-fs": "^4.13.4",
     "@types/node-gzip": "^1.1.3",
@@ -125,6 +125,7 @@
     "@types/ws": "^8.5.12",
     "chai": "5.1.1",
     "concurrently": "8.2.2",
+    "conventional-changelog-conventionalcommits": "^9.1.0",
     "create-ts-index": "^1.14.0",
     "ctix": "^2.6.4",
     "diff": "^5.1.0",