@sonisoft/now-sdk-ext-core 2.5.1 β†’ 2.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +96 -27
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,17 +2,31 @@
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@sonisoft/now-sdk-ext-core.svg)](https://www.npmjs.com/package/@sonisoft/now-sdk-ext-core)
4
4
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
5
- [![Node.js Version](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)](https://nodejs.org)
5
+ [![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen)](https://nodejs.org)
6
6
 
7
7
  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.
8
8
 
9
9
  ## ✨ Features
10
10
 
11
11
  - πŸš€ **Application Management** - Install, upgrade, and manage ServiceNow applications programmatically
12
+ - πŸͺ **Store Application Management** - Search, install, and update apps from the ServiceNow Store
12
13
  - πŸ§ͺ **ATF Test Execution** - Run automated tests and get detailed results
13
14
  - πŸ“Š **Real-time Log Monitoring** - Tail ServiceNow logs with two efficient methods
14
15
  - πŸ”„ **AMB (Asynchronous Message Bus)** - WebSocket-based real-time event monitoring
15
16
  - πŸ“ **Background Script Execution** - Execute server-side scripts programmatically
17
+ - πŸ“‹ **Scope Management** - Set/get current application scope programmatically
18
+ - πŸ“¦ **Update Set Management** - Create, clone, inspect, and manage update sets
19
+ - πŸ” **Code Search** - Search across platform code, apps, and tables
20
+ - πŸ—„οΈ **Schema Discovery** - Discover table schemas, explain fields, validate catalogs
21
+ - πŸ“Ž **Attachment Management** - Upload, list, and retrieve file attachments
22
+ - ⚑ **Batch Operations** - Bulk create/update with variable substitution and query-based bulk operations
23
+ - πŸ”§ **Workflow Management** - Create complete workflows programmatically
24
+ - πŸ“Œ **Task Operations** - Add comments, assign tasks, resolve/close incidents
25
+ - πŸ”— **Script Sync** - Bidirectional sync of scripts between local files and instance
26
+ - πŸ“ˆ **Aggregate Queries** - COUNT, AVG, MIN, MAX, SUM with GROUP BY via Stats API
27
+ - πŸ₯ **Instance Health** - Version, cluster, stuck jobs, semaphore monitoring
28
+ - πŸ—ΊοΈ **CMDB Relationships** - Query and traverse CI relationship graphs
29
+ - πŸ”Ž **Instance Discovery** - List tables, scoped apps, store apps, and plugins
16
30
  - πŸ” **Authentication** - Seamless integration with ServiceNow CLI authentication
17
31
  - πŸ“‘ **Table API** - Full CRUD operations on ServiceNow tables
18
32
  - πŸ› οΈ **Type-Safe** - Complete TypeScript definitions for all APIs
@@ -25,9 +39,9 @@ npm install @sonisoft/now-sdk-ext-core
25
39
 
26
40
  ### Prerequisites
27
41
 
28
- - Node.js 14.x or higher
42
+ - Node.js 18.x or higher
29
43
  - ServiceNow CLI configured with instance credentials
30
- - TypeScript 4.x or higher (optional, for TypeScript projects)
44
+ - TypeScript 5.x or higher (optional, for TypeScript projects)
31
45
 
32
46
  ### ServiceNow CLI Setup
33
47
 
@@ -359,29 +373,60 @@ console.log('Return value:', result.result);
359
373
 
360
374
  - **`ServiceNowInstance`** - Instance connection and configuration
361
375
  - **`ServiceNowRequest`** - HTTP request handling with authentication
362
- - **`TableAPIRequest`** - ServiceNow Table API wrapper
376
+ - **`TableAPIRequest`** - ServiceNow Table API wrapper (CRUD)
363
377
 
364
378
  ### Application Management
365
379
 
366
- - **`ApplicationManager`** - High-level application management
380
+ - **`ApplicationManager`** - Install, upgrade, and validate applications via batch definitions
367
381
  - **`AppRepoApplication`** - App repository operations
368
- - **`BatchDefinition`** - Batch installation definitions
369
- - **`CompanyApplications`** - Company application queries
382
+ - **`CompanyApplications`** - Store application search, install, update, and progress tracking
383
+
384
+ ### Scope & Configuration
385
+
386
+ - **`ScopeManager`** - Set/get current application scope, list and retrieve applications
387
+ - **`UpdateSetManager`** - Create, clone, inspect, move records, and manage update sets
370
388
 
371
389
  ### Testing & Automation
372
390
 
373
- - **`ATFTestExecutor`** - ATF test execution and monitoring
374
- - **`BackgroundScriptExecutor`** - Server-side script execution
391
+ - **`ATFTestExecutor`** - ATF test execution and monitoring with progress tracking
392
+ - **`BackgroundScriptExecutor`** - Server-side GlideScript execution
393
+
394
+ ### Code & Schema
395
+
396
+ - **`CodeSearch`** - Search across platform code by term, app, or table
397
+ - **`SchemaDiscovery`** - Discover table schemas, explain fields, validate catalog items
398
+
399
+ ### Data Operations
400
+
401
+ - **`AttachmentManager`** - Upload, list, and retrieve file attachments
402
+ - **`BatchOperations`** - Sequential bulk create/update with variable substitution
403
+ - **`QueryBatchOperations`** - Query-based bulk update/delete with dry-run safety
404
+
405
+ ### Workflow & Task
406
+
407
+ - **`WorkflowManager`** - Create complete workflows with activities, transitions, and conditions
408
+ - **`TaskOperations`** - Add comments, assign tasks, resolve/close incidents, approve changes
409
+
410
+ ### Scripting
411
+
412
+ - **`ScriptSync`** - Bidirectional sync of Script Includes, Business Rules, and more
375
413
 
376
- ### Logging & Monitoring
414
+ ### Monitoring & Discovery
377
415
 
378
- - **`SyslogReader`** - Log querying and real-time monitoring
379
- - **`AMBClient`** - Real-time event subscriptions
416
+ - **`AggregateQuery`** - COUNT, AVG, MIN, MAX, SUM with GROUP BY via Stats API
417
+ - **`InstanceHealth`** - Version, cluster nodes, stuck jobs, semaphores, operational counts
418
+ - **`CMDBRelationships`** - Query direct relationships and traverse CI graphs (BFS)
419
+ - **`InstanceDiscovery`** - List tables, scoped apps, store apps, and plugins
420
+
421
+ ### Logging & Real-time Events
422
+
423
+ - **`SyslogReader`** - Log querying, formatting, export, and real-time tailing
424
+ - **`AMBClient`** - WebSocket-based real-time event subscriptions
380
425
  - **`MessageClientBuilder`** - AMB client configuration
381
426
 
382
427
  ### Utilities
383
428
 
384
- - **`Logger`** - Winston-based logging
429
+ - **`Logger`** - Winston-based logging with file output
385
430
  - **`NowStringUtil`** - String manipulation utilities
386
431
  - **`AppUtil`** - Application utility functions
387
432
 
@@ -460,14 +505,41 @@ node docs/examples/syslog-tail.mjs your-instance error ./logs/errors.log
460
505
 
461
506
  Comprehensive documentation is available in the `/docs` directory:
462
507
 
508
+ **Getting Started:**
463
509
  - **[Getting Started](./docs/GettingStarted.md)** - Setup and basic usage
464
510
  - **[API Reference](./docs/APIReference.md)** - Complete API documentation
511
+ - **[Examples](./docs/examples/)** - Working code examples
512
+
513
+ **Application & Scope Management:**
465
514
  - **[Application Manager](./docs/ApplicationManager.md)** - Application management guide
515
+ - **[Store Applications](./docs/CompanyApplications.md)** - Store app search, install, and update
516
+ - **[Scope Manager](./docs/ScopeManager.md)** - Application scope management
517
+ - **[Update Set Manager](./docs/UpdateSetManager.md)** - Update set lifecycle management
518
+
519
+ **Code, Schema & Search:**
520
+ - **[Code Search](./docs/CodeSearch.md)** - Platform code search
521
+ - **[Schema Discovery](./docs/SchemaDiscovery.md)** - Table schema and field discovery
522
+
523
+ **Data Operations:**
524
+ - **[Attachment Manager](./docs/AttachmentManager.md)** - File attachment operations
525
+ - **[Batch Operations](./docs/BatchOperations.md)** - Bulk create/update with variable substitution
526
+ - **[Query Batch Operations](./docs/QueryBatchOperations.md)** - Query-based bulk update/delete
527
+
528
+ **Workflow, Task & Scripting:**
529
+ - **[Workflow Manager](./docs/WorkflowManager.md)** - Programmatic workflow creation
530
+ - **[Task Operations](./docs/TaskOperations.md)** - ITSM task management
531
+ - **[Script Sync](./docs/ScriptSync.md)** - Bidirectional script synchronization
532
+
533
+ **Monitoring & Discovery:**
534
+ - **[Aggregate Query](./docs/AggregateQuery.md)** - Stats API aggregations
535
+ - **[Instance Health](./docs/InstanceHealth.md)** - Health monitoring
536
+ - **[CMDB Relationships](./docs/CMDBRelationships.md)** - CI relationship graph traversal
537
+ - **[Instance Discovery](./docs/InstanceDiscovery.md)** - Table, app, and plugin discovery
538
+
539
+ **Testing & Logging:**
466
540
  - **[ATF Test Executor](./docs/ATFTestExecutor.md)** - Testing automation
467
541
  - **[Syslog Reader](./docs/SyslogReader.md)** - Log monitoring guide
468
542
  - **[ChannelAjax Tailing](./docs/SyslogReaderChannelAjax.md)** - Advanced log tailing
469
- - **[AMB Guide](./docs/AMB_FIX_SUMMARY.md)** - Real-time event monitoring
470
- - **[Examples](./docs/examples/)** - Working code examples
471
543
 
472
544
  ## πŸ”§ Advanced Configuration
473
545
 
@@ -559,12 +631,14 @@ try {
559
631
 
560
632
  ## πŸ“¦ Dependencies
561
633
 
562
- - `@servicenow/sdk` - ServiceNow SDK
563
- - `@servicenow/sdk-cli` - ServiceNow CLI tools
564
- - `cometd` - WebSocket support for AMB
565
- - `xml2js` - XML parsing
566
- - `winston` - Logging
634
+ - `@servicenow/sdk` / `@servicenow/sdk-cli` / `@servicenow/sdk-core` - ServiceNow SDK and CLI tools
567
635
  - `axios` - HTTP client
636
+ - `cometd` / `cometd-nodejs-client` - WebSocket support for AMB
637
+ - `winston` - Logging
638
+ - `xml2js` / `fast-xml-parser` - XML parsing
639
+ - `ws` - WebSocket client
640
+ - `zod` - Runtime schema validation
641
+ - `lodash` - Utility functions
568
642
 
569
643
  ## πŸ§ͺ Testing
570
644
 
@@ -623,15 +697,10 @@ For issues, questions, or contributions:
623
697
 
624
698
  - [ ] GraphQL API support
625
699
  - [ ] Webhook integration
626
- - [ ] Enhanced batch operations
627
- - [ ] Performance metrics
628
- - [ ] CLI tool package
700
+ - [ ] Performance metrics dashboard
701
+ - [ ] Standalone CLI tool package
629
702
  - [ ] Plugin development tools
630
703
 
631
- ## πŸ“ˆ Version History
632
-
633
- See [CHANGELOG](./CHANGELOG.md) for version history and release notes.
634
-
635
704
  ---
636
705
 
637
706
  **Made with ❀️ for the ServiceNow Developer Community**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sonisoft/now-sdk-ext-core",
3
- "version": "2.5.1",
3
+ "version": "2.5.2",
4
4
  "description": "Comprehensive TypeScript library extending ServiceNow SDK with application management, ATF testing, real-time log monitoring, AMB event subscriptions, and automation tools",
5
5
  "keywords": [
6
6
  "servicenow",
@@ -16,7 +16,7 @@
16
16
  ],
17
17
  "repository": {
18
18
  "type": "git",
19
- "url": "https://git.sonisoft.io/sonisoft/now-sdk-ext-core.git"
19
+ "url": "https://github.com/sonisoft-cnanda/now-dev.git"
20
20
  },
21
21
  "type": "module",
22
22
  "author": "",