@socketsecurity/sdk 3.0.27 → 3.0.29
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 +12 -0
- package/README.md +48 -13
- package/dist/index.mjs +3529 -57
- package/dist/testing.mjs +250 -1
- package/package.json +3 -4
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,18 @@ 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.0.29](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.0.29) - 2025-11-01
|
|
8
|
+
|
|
9
|
+
### Changed
|
|
10
|
+
|
|
11
|
+
- Moved `@socketsecurity/lib` and `@socketregistry/packageurl-js` to devDependencies (bundled SDK has no runtime dependencies)
|
|
12
|
+
|
|
13
|
+
## [3.0.28](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.0.28) - 2025-11-01
|
|
14
|
+
|
|
15
|
+
### Changed
|
|
16
|
+
|
|
17
|
+
- Updated `@socketsecurity/lib` to v3.0.3
|
|
18
|
+
|
|
7
19
|
## [3.0.27](https://github.com/SocketDev/socket-sdk-js/releases/tag/v3.0.27) - 2025-10-31
|
|
8
20
|
|
|
9
21
|
### Changed
|
package/README.md
CHANGED
|
@@ -8,6 +8,27 @@
|
|
|
8
8
|
|
|
9
9
|
JavaScript SDK for [Socket.dev](https://socket.dev/) API - Security analysis, vulnerability scanning, and compliance monitoring for software supply chains.
|
|
10
10
|
|
|
11
|
+
## Table of Contents
|
|
12
|
+
|
|
13
|
+
- [Installation](#installation)
|
|
14
|
+
- [Quick Start](#quick-start)
|
|
15
|
+
- [API Methods](#api-methods) - [Full API Reference](./docs/api-reference.md)
|
|
16
|
+
- [Documentation](#documentation)
|
|
17
|
+
- [Examples](#examples)
|
|
18
|
+
|
|
19
|
+
## At a Glance
|
|
20
|
+
|
|
21
|
+
| Feature | Description |
|
|
22
|
+
|---------|-------------|
|
|
23
|
+
| **Package Analysis** | Quick security checks for npm packages |
|
|
24
|
+
| **Full Scans** | Deep analysis with SBOM support |
|
|
25
|
+
| **Batch Operations** | Analyze multiple packages efficiently |
|
|
26
|
+
| **Policy Management** | Configure security & license rules |
|
|
27
|
+
| **Quota Utilities** | Cost calculation & planning helpers |
|
|
28
|
+
| **TypeScript** | Full type safety with auto-generated types |
|
|
29
|
+
|
|
30
|
+
**Requirements:** Node.js 18+ • ESM only (v2.0+)
|
|
31
|
+
|
|
11
32
|
## Installation
|
|
12
33
|
|
|
13
34
|
```bash
|
|
@@ -142,19 +163,33 @@ Raw API access: `getApi()` • `sendApi()`
|
|
|
142
163
|
|
|
143
164
|
[→ Documentation](./docs/api-reference.md#advanced-query-methods)
|
|
144
165
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
**[
|
|
150
|
-
|
|
151
|
-
**[
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
166
|
+
## Documentation
|
|
167
|
+
|
|
168
|
+
| Guide | Description |
|
|
169
|
+
|-------|-------------|
|
|
170
|
+
| **[API Reference](./docs/api-reference.md)** | Complete API method documentation |
|
|
171
|
+
| **[Usage Examples](./docs/usage-examples.md)** | Real-world patterns and code samples |
|
|
172
|
+
| **[Getting Started](./docs/getting-started.md)** | Development setup and workflow |
|
|
173
|
+
| **[Quota Management](./docs/quota-management.md)** | Cost tiers (0/10/100) and utilities |
|
|
174
|
+
| **[Testing Guide](./docs/dev/testing.md)** | Test helpers, fixtures, and patterns |
|
|
175
|
+
| **[Method Reference](./docs/when-to-use-what.md)** | Quick method selection guide |
|
|
176
|
+
|
|
177
|
+
## Examples
|
|
178
|
+
|
|
179
|
+
See **[usage-examples.md](./docs/usage-examples.md)** for complete examples including:
|
|
180
|
+
- Package security analysis
|
|
181
|
+
- Batch operations
|
|
182
|
+
- Full scans with SBOM
|
|
183
|
+
- Policy management
|
|
184
|
+
- Quota planning
|
|
185
|
+
|
|
186
|
+
## Related Projects
|
|
187
|
+
|
|
188
|
+
| Project | Description |
|
|
189
|
+
|---------|-------------|
|
|
190
|
+
| [Socket.dev API](https://docs.socket.dev/reference) | Official REST API documentation |
|
|
191
|
+
| [Socket CLI](https://github.com/SocketDev/socket-cli) | Command-line interface |
|
|
192
|
+
| [Socket GitHub App](https://github.com/apps/socket-security) | Automated GitHub integration |
|
|
158
193
|
|
|
159
194
|
## License
|
|
160
195
|
|