@socketsecurity/sdk 3.1.1 → 3.1.3

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 CHANGED
@@ -4,6 +4,23 @@ 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.1.3](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.1.3) - 2025-11-04
8
+
9
+ ### Fixed
10
+
11
+ - Updated OpenAPI type generation script to automatically preserve SDK v3 method name aliases during automated syncs
12
+
13
+ ### Changed
14
+
15
+ - Updated `@socketsecurity/lib` to v3.2.4
16
+
17
+ ## [3.1.2](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.1.2) - 2025-11-02
18
+
19
+ ### Fixed
20
+
21
+ - Add type aliases in `operations` interface to map SDK v3 method names to OpenAPI operation names for TypeScript compatibility
22
+ - Update `FileValidationCallback` to use `createFullScan` instead of `createOrgFullScan`
23
+
7
24
  ## [3.1.1](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.1.1) - 2025-11-02
8
25
 
9
26
  ### Fixed
package/README.md CHANGED
@@ -27,7 +27,7 @@ JavaScript SDK for [Socket.dev](https://socket.dev/) API - Security analysis, vu
27
27
  | **Quota Utilities** | Cost calculation & planning helpers |
28
28
  | **TypeScript** | Full type safety with auto-generated types |
29
29
 
30
- **Requirements:** Node.js 18+ ESM only (v2.0+)
30
+ **Requirements:** Node.js 18+ ·ESM only (v2.0+)
31
31
 
32
32
  ## Installation
33
33
 
@@ -75,91 +75,91 @@ const batchResult = await client.batchPackageFetch({
75
75
 
76
76
  ### Package Analysis
77
77
 
78
- Quick security checks: `batchPackageFetch()` • `batchPackageStream()` • `getIssuesByNpmPackage()` • `getScoreByNpmPackage()`
78
+ Quick security checks: `batchPackageFetch()` ·`batchPackageStream()` ·`getIssuesByNpmPackage()` ·`getScoreByNpmPackage()`
79
79
 
80
80
  [→ Documentation](./docs/api-reference.md#package-analysis)
81
81
 
82
82
  ### Scanning & Analysis
83
83
 
84
- Project scanning: `createDependenciesSnapshot()` • `createOrgFullScan()` • `createScanFromFilepaths()` • `getScan()` • `getScanList()` • `getSupportedScanFiles()`
84
+ Project scanning: `createDependenciesSnapshot()` ·`createOrgFullScan()` ·`createScanFromFilepaths()` ·`getScan()` ·`getScanList()` ·`getSupportedScanFiles()`
85
85
 
86
86
  [→ Documentation](./docs/api-reference.md#scanning--analysis)
87
87
 
88
88
  ### Organization Management
89
89
 
90
- Organizations and repositories: `getOrganizations()` • `createOrgRepo()` • `getOrgRepo()` • `getOrgRepoList()` • `updateOrgRepo()` • `deleteOrgRepo()`
90
+ Organizations and repositories: `getOrganizations()` ·`createOrgRepo()` ·`getOrgRepo()` ·`getOrgRepoList()` ·`updateOrgRepo()` ·`deleteOrgRepo()`
91
91
 
92
92
  [→ Documentation](./docs/api-reference.md#organization-management)
93
93
 
94
94
  ### Policy & Settings
95
95
 
96
- Security configuration: `getOrgSecurityPolicy()` • `updateOrgSecurityPolicy()` • `getOrgLicensePolicy()` • `updateOrgLicensePolicy()` • `postSettings()`
96
+ Security configuration: `getOrgSecurityPolicy()` ·`updateOrgSecurityPolicy()` ·`getOrgLicensePolicy()` ·`updateOrgLicensePolicy()` ·`postSettings()`
97
97
 
98
98
  [→ Documentation](./docs/api-reference.md#policy--settings)
99
99
 
100
100
  ### Full Scan Management
101
101
 
102
- Deep analysis: `getOrgFullScanList()` • `getOrgFullScanMetadata()` • `getOrgFullScanBuffered()` • `streamOrgFullScan()` • `deleteOrgFullScan()`
102
+ Deep analysis: `getOrgFullScanList()` ·`getOrgFullScanMetadata()` ·`getOrgFullScanBuffered()` ·`streamOrgFullScan()` ·`deleteOrgFullScan()`
103
103
 
104
104
  [→ Documentation](./docs/api-reference.md#full-scan-management)
105
105
 
106
106
  ### Diff Scans
107
107
 
108
- Scan comparison: `createOrgDiffScanFromIds()` • `getDiffScanById()` • `listOrgDiffScans()` • `deleteOrgDiffScan()`
108
+ Scan comparison: `createOrgDiffScanFromIds()` ·`getDiffScanById()` ·`listOrgDiffScans()` ·`deleteOrgDiffScan()`
109
109
 
110
110
  [→ Documentation](./docs/api-reference.md#diff-scans)
111
111
 
112
112
  ### Patches & Vulnerabilities
113
113
 
114
- Security fixes: `streamPatchesFromScan()` • `viewPatch()`
114
+ Security fixes: `streamPatchesFromScan()` ·`viewPatch()`
115
115
 
116
116
  [→ Documentation](./docs/api-reference.md#patches--vulnerabilities)
117
117
 
118
118
  ### Alert & Triage
119
119
 
120
- Alert management: `getOrgTriage()` • `updateOrgAlertTriage()`
120
+ Alert management: `getOrgTriage()` ·`updateOrgAlertTriage()`
121
121
 
122
122
  [→ Documentation](./docs/api-reference.md#alert--triage)
123
123
 
124
124
  ### Export & Integration
125
125
 
126
- SBOM export: `exportCDX()` • `exportSPDX()` • `searchDependencies()` • `uploadManifestFiles()`
126
+ SBOM export: `exportCDX()` ·`exportSPDX()` ·`searchDependencies()` ·`uploadManifestFiles()`
127
127
 
128
128
  [→ Documentation](./docs/api-reference.md#export--integration)
129
129
 
130
130
  ### Repository Labels
131
131
 
132
- Categorization: `createOrgRepoLabel()` • `getOrgRepoLabel()` • `getOrgRepoLabelList()` • `updateOrgRepoLabel()` • `deleteOrgRepoLabel()`
132
+ Categorization: `createOrgRepoLabel()` ·`getOrgRepoLabel()` ·`getOrgRepoLabelList()` ·`updateOrgRepoLabel()` ·`deleteOrgRepoLabel()`
133
133
 
134
134
  [→ Documentation](./docs/api-reference.md#repository-labels)
135
135
 
136
136
  ### Analytics & Monitoring
137
137
 
138
- Usage metrics: `getQuota()` • `getOrgAnalytics()` • `getRepoAnalytics()` • `getAuditLogEvents()`
138
+ Usage metrics: `getQuota()` ·`getOrgAnalytics()` ·`getRepoAnalytics()` ·`getAuditLogEvents()`
139
139
 
140
140
  [→ Documentation](./docs/api-reference.md#analytics--monitoring)
141
141
 
142
142
  ### Authentication & Access
143
143
 
144
- API tokens: `getAPITokens()` • `postAPIToken()` • `postAPITokensRotate()` • `postAPITokensRevoke()` • `postAPITokenUpdate()`
144
+ API tokens: `getAPITokens()` ·`postAPIToken()` ·`postAPITokensRotate()` ·`postAPITokensRevoke()` ·`postAPITokenUpdate()`
145
145
 
146
146
  [→ Documentation](./docs/api-reference.md#authentication--access)
147
147
 
148
148
  ### Entitlements
149
149
 
150
- Feature access: `getEnabledEntitlements()` • `getEntitlements()`
150
+ Feature access: `getEnabledEntitlements()` ·`getEntitlements()`
151
151
 
152
152
  [→ Documentation](./docs/api-reference.md#entitlements)
153
153
 
154
154
  ### Quota Utilities
155
155
 
156
- Cost helpers: `getQuotaCost()` • `getRequiredPermissions()` • `calculateTotalQuotaCost()` • `hasQuotaForMethods()` • `getMethodsByQuotaCost()` • `getMethodsByPermissions()` • `getQuotaUsageSummary()` • `getAllMethodRequirements()`
156
+ Cost helpers: `getQuotaCost()` ·`getRequiredPermissions()` ·`calculateTotalQuotaCost()` ·`hasQuotaForMethods()` ·`getMethodsByQuotaCost()` ·`getMethodsByPermissions()` ·`getQuotaUsageSummary()` ·`getAllMethodRequirements()`
157
157
 
158
158
  [→ Documentation](./docs/quota-management.md)
159
159
 
160
160
  ### Advanced Query Methods
161
161
 
162
- Raw API access: `getApi()` • `sendApi()`
162
+ Raw API access: `getApi()` ·`sendApi()`
163
163
 
164
164
  [→ Documentation](./docs/api-reference.md#advanced-query-methods)
165
165