@socketsecurity/sdk 3.4.0 → 3.4.1
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.
- package/CHANGELOG.md +8 -0
- package/dist/index.js +2 -2
- package/package.json +2 -2
- package/types/api.d.ts +50 -16
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
|
|
|
4
4
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
|
|
6
6
|
|
|
7
|
+
## [3.4.1](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.4.1) - 2026-03-12
|
|
8
|
+
|
|
9
|
+
### Changed
|
|
10
|
+
|
|
11
|
+
- Synced OpenAPI type definitions with latest API specification
|
|
12
|
+
- Improved documentation for Org Triage API query parameters and request fields
|
|
13
|
+
- Updated `@socketsecurity/lib` to v5.8.1
|
|
14
|
+
|
|
7
15
|
## [3.4.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.4.0) - 2026-03-11
|
|
8
16
|
|
|
9
17
|
### Added
|
package/dist/index.js
CHANGED
|
@@ -71,7 +71,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
71
71
|
// package.json
|
|
72
72
|
var package_default = {
|
|
73
73
|
name: "@socketsecurity/sdk",
|
|
74
|
-
version: "3.4.
|
|
74
|
+
version: "3.4.1",
|
|
75
75
|
description: "SDK for the Socket API client",
|
|
76
76
|
homepage: "https://github.com/SocketDev/socket-sdk-js",
|
|
77
77
|
license: "MIT",
|
|
@@ -136,7 +136,7 @@ var package_default = {
|
|
|
136
136
|
},
|
|
137
137
|
dependencies: {
|
|
138
138
|
"@socketregistry/packageurl-js": "1.3.5",
|
|
139
|
-
"@socketsecurity/lib": "5.8.
|
|
139
|
+
"@socketsecurity/lib": "5.8.1",
|
|
140
140
|
"form-data": "4.0.5"
|
|
141
141
|
},
|
|
142
142
|
devDependencies: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@socketsecurity/sdk",
|
|
3
|
-
"version": "3.4.
|
|
3
|
+
"version": "3.4.1",
|
|
4
4
|
"description": "SDK for the Socket API client",
|
|
5
5
|
"homepage": "https://github.com/SocketDev/socket-sdk-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
},
|
|
66
66
|
"dependencies": {
|
|
67
67
|
"@socketregistry/packageurl-js": "1.3.5",
|
|
68
|
-
"@socketsecurity/lib": "5.8.
|
|
68
|
+
"@socketsecurity/lib": "5.8.1",
|
|
69
69
|
"form-data": "4.0.5"
|
|
70
70
|
},
|
|
71
71
|
"devDependencies": {
|
package/types/api.d.ts
CHANGED
|
@@ -466,7 +466,7 @@ export interface paths {
|
|
|
466
466
|
'/orgs/{org_slug}/triage/alerts': {
|
|
467
467
|
/**
|
|
468
468
|
* List Org Alert Triage
|
|
469
|
-
* @description
|
|
469
|
+
* @description List triage actions for an organization. Results are paginated and can be sorted by created_at or updated_at.
|
|
470
470
|
*
|
|
471
471
|
* This endpoint consumes 1 unit of your quota.
|
|
472
472
|
*
|
|
@@ -475,8 +475,8 @@ export interface paths {
|
|
|
475
475
|
*/
|
|
476
476
|
get: operations['getOrgTriage']
|
|
477
477
|
/**
|
|
478
|
-
* Update Org Alert Triage
|
|
479
|
-
* @description
|
|
478
|
+
* Create/Update Org Alert Triage
|
|
479
|
+
* @description Create or update triage actions on organization alerts. Accepts a batch of triage entries. Omit `uuid` to create a new entry; provide an existing `uuid` to update it. Use `?force=true` for broad triages that lack a specific `alertKey` or granular package information.
|
|
480
480
|
*
|
|
481
481
|
* This endpoint consumes 1 unit of your quota.
|
|
482
482
|
*
|
|
@@ -7477,7 +7477,7 @@ export interface operations {
|
|
|
7477
7477
|
}
|
|
7478
7478
|
/**
|
|
7479
7479
|
* List Org Alert Triage
|
|
7480
|
-
* @description
|
|
7480
|
+
* @description List triage actions for an organization. Results are paginated and can be sorted by created_at or updated_at.
|
|
7481
7481
|
*
|
|
7482
7482
|
* This endpoint consumes 1 unit of your quota.
|
|
7483
7483
|
*
|
|
@@ -7487,9 +7487,13 @@ export interface operations {
|
|
|
7487
7487
|
getOrgTriage: {
|
|
7488
7488
|
parameters: {
|
|
7489
7489
|
query?: {
|
|
7490
|
+
/** @description Field to sort by. One of: created_at, updated_at. */
|
|
7490
7491
|
sort?: string
|
|
7492
|
+
/** @description Sort direction. One of: asc, desc. */
|
|
7491
7493
|
direction?: string
|
|
7494
|
+
/** @description Number of results per page (1–100, default 30). */
|
|
7492
7495
|
per_page?: number
|
|
7496
|
+
/** @description Page number (1-based). */
|
|
7493
7497
|
page?: number
|
|
7494
7498
|
}
|
|
7495
7499
|
path: {
|
|
@@ -7612,8 +7616,8 @@ export interface operations {
|
|
|
7612
7616
|
}
|
|
7613
7617
|
}
|
|
7614
7618
|
/**
|
|
7615
|
-
* Update Org Alert Triage
|
|
7616
|
-
* @description
|
|
7619
|
+
* Create/Update Org Alert Triage
|
|
7620
|
+
* @description Create or update triage actions on organization alerts. Accepts a batch of triage entries. Omit `uuid` to create a new entry; provide an existing `uuid` to update it. Use `?force=true` for broad triages that lack a specific `alertKey` or granular package information.
|
|
7617
7621
|
*
|
|
7618
7622
|
* This endpoint consumes 1 unit of your quota.
|
|
7619
7623
|
*
|
|
@@ -7635,19 +7639,40 @@ export interface operations {
|
|
|
7635
7639
|
content: {
|
|
7636
7640
|
'application/json': {
|
|
7637
7641
|
alertTriage: Array<{
|
|
7638
|
-
/**
|
|
7642
|
+
/**
|
|
7643
|
+
* @description The UUID of the triage entry. Omit to create a new entry; provide to update an existing one.
|
|
7644
|
+
* @default
|
|
7645
|
+
*/
|
|
7639
7646
|
uuid?: string | null
|
|
7640
|
-
/**
|
|
7647
|
+
/**
|
|
7648
|
+
* @description The package ecosystem type (e.g., npm, pypi). Use null or "*" for wildcard.
|
|
7649
|
+
* @default
|
|
7650
|
+
*/
|
|
7641
7651
|
packageType?: string | null
|
|
7642
|
-
/**
|
|
7652
|
+
/**
|
|
7653
|
+
* @description The package namespace or scope. Use null or "*" for wildcard.
|
|
7654
|
+
* @default
|
|
7655
|
+
*/
|
|
7643
7656
|
packageNamespace?: string | null
|
|
7644
|
-
/**
|
|
7657
|
+
/**
|
|
7658
|
+
* @description The package name. Use null or "*" for wildcard.
|
|
7659
|
+
* @default
|
|
7660
|
+
*/
|
|
7645
7661
|
packageName?: string | null
|
|
7646
|
-
/**
|
|
7662
|
+
/**
|
|
7663
|
+
* @description The package version. Supports a "*" suffix for wildcard prefix matching. Use null for any version.
|
|
7664
|
+
* @default
|
|
7665
|
+
*/
|
|
7647
7666
|
packageVersion?: string | null
|
|
7648
|
-
/**
|
|
7667
|
+
/**
|
|
7668
|
+
* @description The specific alert key to target.
|
|
7669
|
+
* @default
|
|
7670
|
+
*/
|
|
7649
7671
|
alertKey?: string | null
|
|
7650
|
-
/**
|
|
7672
|
+
/**
|
|
7673
|
+
* @description The alert type (e.g., criticalCVE, highCVE).
|
|
7674
|
+
* @default
|
|
7675
|
+
*/
|
|
7651
7676
|
alertType?: string | null
|
|
7652
7677
|
/**
|
|
7653
7678
|
* @description Whether a fix is available, unavailable, or * for any
|
|
@@ -7664,16 +7689,25 @@ export interface operations {
|
|
|
7664
7689
|
* @enum {string}
|
|
7665
7690
|
*/
|
|
7666
7691
|
kevs?: 'exist' | 'none' | '*'
|
|
7667
|
-
/**
|
|
7692
|
+
/**
|
|
7693
|
+
* @description CVE or GHSA ID to match against.
|
|
7694
|
+
* @default
|
|
7695
|
+
*/
|
|
7668
7696
|
cveOrGhsaId?: string | null
|
|
7669
7697
|
/**
|
|
7670
7698
|
* @description The reachability of the alert, can be reachable, unreachable, other, or * for any
|
|
7671
7699
|
* @enum {string}
|
|
7672
7700
|
*/
|
|
7673
7701
|
reachability?: 'reachable' | 'unreachable' | 'other' | '*'
|
|
7674
|
-
/**
|
|
7702
|
+
/**
|
|
7703
|
+
* @description CVSS score comparison operator and value (e.g., >=7.5, >5.0, ==8.0).
|
|
7704
|
+
* @default
|
|
7705
|
+
*/
|
|
7675
7706
|
cvssScoreCmp?: string | null
|
|
7676
|
-
/**
|
|
7707
|
+
/**
|
|
7708
|
+
* @description A note or comment for the triage action.
|
|
7709
|
+
* @default
|
|
7710
|
+
*/
|
|
7677
7711
|
note?: string
|
|
7678
7712
|
/**
|
|
7679
7713
|
* @description The triage state of the alert
|