@socketsecurity/sdk 1.11.2 → 2.0.1

package/CHANGELOG.md

@@ -4,6 +4,43 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [2.0.1](https://github.com/SocketDev/socket-sdk-js/releases/tag/v2.0.1) - 2025-10-21
+
+### Changed
+- Use `@socketsecurity/lib` under the hood
+- Synced OpenAPI type definitions with latest API specification
+  - Added documentation for `scan_type` query parameter on manifest upload endpoint (used for categorizing multiple SBOM heads per repository branch)
+  - Improved TypeScript helper types (`OpReturnType`, `OpErrorType`) for better type inference and error handling
+
+## [2.0.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v2.0.0) - 2025-10-10
+
+### Changed
+- **BREAKING**: Migrated to ESM-only module format
+  - Package is now ESM-only (`"type": "module"` in package.json)
+  - All output files use `.mjs` extension for JavaScript
+  - TypeScript declaration files use `.d.mts` extension
+  - CommonJS (`require()`) is no longer supported
+- Simplified build process for ESM-only output
+- Updated TypeScript configuration to use ESM module resolution
+- Improved code splitting for better tree-shaking with ESM
+
+### Removed
+- **BREAKING**: Removed CommonJS support and exports
+- Removed CommonJS-specific build configurations
+
+### Migration Guide
+To migrate from v1.x to v2.0:
+1. Ensure your project supports ESM modules (Node.js 14+ with `"type": "module"` or `.mjs` extensions)
+2. Update imports from CommonJS `require()` to ESM `import` statements:
+   ```javascript
+   // Before (v1.x)
+   const { SocketSdk } = require('@socketsecurity/sdk');
+
+   // After (v2.0)
+   import { SocketSdk } from '@socketsecurity/sdk';
+   ```
+3. If your project still requires CommonJS, consider staying on v1.x or using a transpiler
+
 ## [1.11.2](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.11.2) - 2025-10-07
 
 ### Fixed

package/README.md

@@ -6,7 +6,7 @@
 [![Follow @SocketSecurity](https://img.shields.io/twitter/follow/SocketSecurity?style=social)](https://twitter.com/SocketSecurity)
 [![Follow @socket.dev on Bluesky](https://img.shields.io/badge/Follow-@socket.dev-1DA1F2?style=social&logo=bluesky)](https://bsky.app/profile/socket.dev)
 
-Official SDK for [Socket.dev](https://socket.dev/) - Programmatic access to security analysis, vulnerability scanning, and compliance monitoring for your software supply chain.
+JavaScript SDK for [Socket.dev](https://socket.dev/) API - Security analysis, vulnerability scanning, and compliance monitoring for software supply chains.
 
 ## Installation
 
@@ -14,6 +14,8 @@ Official SDK for [Socket.dev](https://socket.dev/) - Programmatic access to secu
 pnpm add @socketsecurity/sdk
 ```
 
+**Note:** Version 2.0+ is ESM-only. For CommonJS support, use version 1.x.
+
 ## Quick Start
 
 ```typescript
@@ -46,137 +48,107 @@ const batchResult = await client.batchPackageFetch({
 })
 ```
 
-**[→ Configuration Options](./docs/API.md#configuration)**
+**[→ Configuration](./docs/guides/api-reference.md#configuration)**
 
 ## API Methods
 
-<details>
-<summary><strong>Package Analysis</strong> - Quick security checks</summary>
+### Package Analysis
 
-`batchPackageFetch()` • `batchPackageStream()` • `getIssuesByNpmPackage()` • `getScoreByNpmPackage()`
+Quick security checks: `batchPackageFetch()` • `batchPackageStream()` • `getIssuesByNpmPackage()` • `getScoreByNpmPackage()`
 
-[→ Documentation](./docs/API.md#package-analysis)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#package-analysis)
 
-<details>
-<summary><strong>Scanning & Analysis</strong> - Project scanning</summary>
+### Scanning & Analysis
 
-`createDependenciesSnapshot()` • `createOrgFullScan()` • `createScanFromFilepaths()` • `getScan()` • `getScanList()` • `getSupportedScanFiles()`
+Project scanning: `createDependenciesSnapshot()` • `createOrgFullScan()` • `createScanFromFilepaths()` • `getScan()` • `getScanList()` • `getSupportedScanFiles()`
 
-[→ Documentation](./docs/API.md#scanning--analysis)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#scanning--analysis)
 
-<details>
-<summary><strong>Organization Management</strong> - Orgs and repos</summary>
+### Organization Management
 
-`getOrganizations()` • `createOrgRepo()` • `getOrgRepo()` • `getOrgRepoList()` • `updateOrgRepo()` • `deleteOrgRepo()`
+Organizations and repositories: `getOrganizations()` • `createOrgRepo()` • `getOrgRepo()` • `getOrgRepoList()` • `updateOrgRepo()` • `deleteOrgRepo()`
 
-[→ Documentation](./docs/API.md#organization-management)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#organization-management)
 
-<details>
-<summary><strong>Policy & Settings</strong> - Security configuration</summary>
+### Policy & Settings
 
-`getOrgSecurityPolicy()` • `updateOrgSecurityPolicy()` • `getOrgLicensePolicy()` • `updateOrgLicensePolicy()` • `postSettings()`
+Security configuration: `getOrgSecurityPolicy()` • `updateOrgSecurityPolicy()` • `getOrgLicensePolicy()` • `updateOrgLicensePolicy()` • `postSettings()`
 
-[→ Documentation](./docs/API.md#policy--settings)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#policy--settings)
 
-<details>
-<summary><strong>Full Scan Management</strong> - Deep analysis</summary>
+### Full Scan Management
 
-`getOrgFullScanList()` • `getOrgFullScanMetadata()` • `getOrgFullScanBuffered()` • `streamOrgFullScan()` • `deleteOrgFullScan()`
+Deep analysis: `getOrgFullScanList()` • `getOrgFullScanMetadata()` • `getOrgFullScanBuffered()` • `streamOrgFullScan()` • `deleteOrgFullScan()`
 
-[→ Documentation](./docs/API.md#full-scan-management)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#full-scan-management)
 
-<details>
-<summary><strong>Diff Scans</strong> - Compare scans</summary>
+### Diff Scans
 
-`createOrgDiffScanFromIds()` • `getDiffScanById()` • `listOrgDiffScans()` • `deleteOrgDiffScan()`
+Scan comparison: `createOrgDiffScanFromIds()` • `getDiffScanById()` • `listOrgDiffScans()` • `deleteOrgDiffScan()`
 
-[→ Documentation](./docs/API.md#diff-scans)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#diff-scans)
 
-<details>
-<summary><strong>Patches & Vulnerabilities</strong> - Security fixes</summary>
+### Patches & Vulnerabilities
 
-`streamPatchesFromScan()` • `viewPatch()`
+Security fixes: `streamPatchesFromScan()` • `viewPatch()`
 
-[→ Documentation](./docs/API.md#patches--vulnerabilities)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#patches--vulnerabilities)
 
-<details>
-<summary><strong>Alert & Triage</strong> - Alert management</summary>
+### Alert & Triage
 
-`getOrgTriage()` • `updateOrgAlertTriage()`
+Alert management: `getOrgTriage()` • `updateOrgAlertTriage()`
 
-[→ Documentation](./docs/API.md#alert--triage)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#alert--triage)
 
-<details>
-<summary><strong>Export & Integration</strong> - SBOM export</summary>
+### Export & Integration
 
-`exportCDX()` • `exportSPDX()` • `searchDependencies()` • `uploadManifestFiles()`
+SBOM export: `exportCDX()` • `exportSPDX()` • `searchDependencies()` • `uploadManifestFiles()`
 
-[→ Documentation](./docs/API.md#export--integration)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#export--integration)
 
-<details>
-<summary><strong>Repository Labels</strong> - Categorization</summary>
+### Repository Labels
 
-`createOrgRepoLabel()` • `getOrgRepoLabel()` • `getOrgRepoLabelList()` • `updateOrgRepoLabel()` • `deleteOrgRepoLabel()`
+Categorization: `createOrgRepoLabel()` • `getOrgRepoLabel()` • `getOrgRepoLabelList()` • `updateOrgRepoLabel()` • `deleteOrgRepoLabel()`
 
-[→ Documentation](./docs/API.md#repository-labels)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#repository-labels)
 
-<details>
-<summary><strong>Analytics & Monitoring</strong> - Usage metrics</summary>
+### Analytics & Monitoring
 
-`getQuota()` • `getOrgAnalytics()` • `getRepoAnalytics()` • `getAuditLogEvents()`
+Usage metrics: `getQuota()` • `getOrgAnalytics()` • `getRepoAnalytics()` • `getAuditLogEvents()`
 
-[→ Documentation](./docs/API.md#analytics--monitoring)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#analytics--monitoring)
 
-<details>
-<summary><strong>Authentication & Access</strong> - API tokens</summary>
+### Authentication & Access
 
-`getAPITokens()` • `postAPIToken()` • `postAPITokensRotate()` • `postAPITokensRevoke()` • `postAPITokenUpdate()`
+API tokens: `getAPITokens()` • `postAPIToken()` • `postAPITokensRotate()` • `postAPITokensRevoke()` • `postAPITokenUpdate()`
 
-[→ Documentation](./docs/API.md#authentication--access)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#authentication--access)
 
-<details>
-<summary><strong>Entitlements</strong> - Feature access</summary>
+### Entitlements
 
-`getEnabledEntitlements()` • `getEntitlements()`
+Feature access: `getEnabledEntitlements()` • `getEntitlements()`
 
-[→ Documentation](./docs/API.md#entitlements)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#entitlements)
 
-<details>
-<summary><strong>Quota Utilities</strong> - Cost helpers</summary>
+### Quota Utilities
 
-`getQuotaCost()` • `getRequiredPermissions()` • `calculateTotalQuotaCost()` • `hasQuotaForMethods()` • `getMethodsByQuotaCost()` • `getMethodsByPermissions()` • `getQuotaUsageSummary()` • `getAllMethodRequirements()`
+Cost helpers: `getQuotaCost()` • `getRequiredPermissions()` • `calculateTotalQuotaCost()` • `hasQuotaForMethods()` • `getMethodsByQuotaCost()` • `getMethodsByPermissions()` • `getQuotaUsageSummary()` • `getAllMethodRequirements()`
 
-[→ Documentation](./docs/QUOTA.md)
-</details>
+[→ Documentation](./docs/guides/quota-management.md)
 
-<details>
-<summary><strong>Advanced Query Methods</strong> - Raw API</summary>
+### Advanced Query Methods
 
-`getApi()` • `sendApi()`
+Raw API access: `getApi()` • `sendApi()`
 
-[→ Documentation](./docs/API.md#advanced-query-methods)
-</details>
+[→ Documentation](./docs/guides/api-reference.md#advanced-query-methods)
 
-**[→ Complete API Reference](./docs/API.md)**
+**[→ API Reference](./docs/guides/api-reference.md)**
 
-**[→ Usage Examples](./docs/EXAMPLES.md)**
+**[→ Examples](./docs/guides/usage-examples.md)**
 
-**[→ Quota Management](./docs/QUOTA.md)** - Cost tiers: 0 units (free), 10 units (standard), 100 units (batch/uploads)
+**[→ Quota Management](./docs/guides/quota-management.md)** - Cost tiers: 0 (free), 10 (standard), 100 (batch/uploads)
 
-**[→ Testing Utilities](./docs/TESTING.md)** - Mock factories, fixtures, and type guards for SDK testing
+**[→ Testing Utilities](./docs/guides/dev/testing.md)** - Mock factories, fixtures, type guards
 
 ## See Also
 

package/dist/cacache-BCCSM36H.mjs

@@ -0,0 +1,2 @@
+/* Socket SDK ESM - Built with esbuild */
+import{a}from"./chunk-3V7KNFWE.mjs";import"./chunk-LHGMBIJS.mjs";import"./chunk-UKECVIRQ.mjs";export default a();