@socketsecurity/sdk 1.4.93 → 1.5.0

package/CHANGELOG.md

@@ -0,0 +1,161 @@
+# Changelog
+
+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/).
+
+## [1.5.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.5.0) - 2025-09-23
+
+### Added
+- `getOrgFullScanBuffered` method for buffered full scan retrieval
+
+### Changed
+- **BREAKING:** Renamed `getOrgFullScan` to `streamOrgFullScan` for clarity
+
+### Fixed
+- Added missing `getResponseJson` call to `createScanFromFilepaths`
+- Improved handling of empty response bodies
+
+## [1.4.93](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.93) - 2025-09-15
+
+### Fixed
+- Fixed malformed part header issue for upload of manifest files
+
+## [1.4.91](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.91) - 2025-09-11
+
+### Changed
+- Improved URL handling
+
+## [1.4.90](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.90) - 2025-09-11
+
+### Fixed
+- Improved error handling
+
+## [1.4.84](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.84) - 2025-09-03
+
+### Added
+- Filter alerts by action
+
+### Changed
+- Improved JSON parsing
+
+## [1.4.82](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.82) - 2025-09-02
+
+### Changed
+- Improved public policy handling
+
+## [1.4.81](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.81) - 2025-09-02
+
+### Added
+- Add public security policy support
+
+## [1.4.79](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.79) - 2025-08-27
+
+### Fixed
+- Fixed ESM module compatibility
+
+## [1.4.77](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.77) - 2025-08-25
+
+### Added
+- Add timeout option for API requests
+
+## [1.4.73](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.73) - 2025-08-08
+
+### Fixed
+- Fixed crates ecosystem support
+
+## [1.4.72](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.72) - 2025-08-08
+
+### Fixed
+- Fixed rubygems ecosystem support
+
+## [1.4.71](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.71) - 2025-08-08
+
+### Added
+- Support for crate and rubygem ecosystems
+
+## [1.4.68](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.68) - 2025-08-02
+
+### Changed
+- Improved type definitions
+- Memory usage optimizations
+
+## [1.4.66](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.66) - 2025-07-29
+
+### Fixed
+- Fixed file upload timing issue
+- Fixed multipart form data formatting
+
+## [1.4.64](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.64) - 2025-07-22
+
+### Changed
+- Improved method signatures
+
+## [1.4.62](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.62) - 2025-07-21
+
+### Fixed
+- Fixed query parameter handling for empty values
+
+## [1.4.61](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.61) - 2025-07-21
+
+### Changed
+- Improved query parameter normalization
+
+## [1.4.60](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.60) - 2025-07-21
+
+### Changed
+- Renamed result type for clarity
+
+## [1.4.59](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.59) - 2025-07-20
+
+### Added
+- Add alias types for improved developer experience
+
+## [1.4.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.4.0) - 2025-05-01
+
+### Added
+- Full scans feature support
+- Audit log and repos features
+- Organization security policy support (getOrgSecurityPolicy)
+
+### Changed
+- Improved TypeScript type exports
+- Enhanced ESM and CJS dual package support
+
+## [1.3.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.3.0) - 2025-03-01
+
+### Added
+- Support for multiple ecosystem types
+- Enhanced error handling and reporting
+
+### Changed
+- Improved API client architecture
+- Better TypeScript type definitions
+
+## [1.2.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.2.0) - 2025-01-15
+
+### Added
+- File upload support for manifest files
+- Request body creation for file paths
+
+### Changed
+- Enhanced multipart form data handling
+- Improved streaming support
+
+## [1.1.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.1.0) - 2024-11-01
+
+### Added
+- Query parameter normalization
+- Enhanced search parameter handling
+
+### Changed
+- Improved URL parsing and handling
+- Better error messages
+
+## [1.0.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.0.0) - 2024-09-01
+
+### Added
+- Initial release of Socket SDK for JavaScript
+- Full Socket API client implementation
+- TypeScript support with comprehensive type definitions
+- Dual ESM/CJS package support

package/README.md

@@ -11,7 +11,7 @@ SDK for the Socket API client, generated by `api`.
 ## Usage
 
 ```bash
-npm install @socketsecurity/sdk
+pnpm add @socketsecurity/sdk
 ```
 
 ### ESM / TypeScript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socketsecurity/sdk",
-  "version": "1.4.93",
+  "version": "1.5.0",
   "license": "MIT",
   "description": "SDK for the Socket API client",
   "author": {
@@ -43,65 +43,25 @@
     "./types/api.d.ts": "./types/api.d.ts",
     "./package.json": "./package.json"
   },
-  "scripts": {
-    "build": "npm run clean && run-p -c --aggregate-output build:* && run-p -c --aggregate-output build:clean:*",
-    "build:cjs": "dotenvx -q run -f .env.local -- tsc",
-    "build:esm": "dotenvx -q run -f .env.local -- tsc -p tsconfig.esm.json",
-    "build:clean:cjs": "dotenvx -q run -f .env.local -- node scripts/rename-dist-cjs-files.mjs",
-    "build:clean:esm": "dotenvx -q run -f .env.local -- node scripts/rename-dist-esm-files.mjs",
-    "check": "run-p -c --aggregate-output check:*",
-    "check:lint": "dotenvx -q run -f .env.local -- eslint --report-unused-disable-directives .",
-    "check:lint:fix": "npm run check:lint -- --fix",
-    "check:tsc": "dotenvx -q run -f .env.local -- tsc",
-    "coverage": "run-s coverage:*",
-    "coverage:test": "run-s test:prepare test:unit:coverage",
-    "coverage:type": "dotenvx -q run -f .env.local -- type-coverage --detail",
-    "clean": "run-p -c --aggregate-output clean:*",
-    "clean:dist": "del-cli 'dist'",
-    "clean:declarations": "del-cli '*.d.ts' '!api*.d.ts'",
-    "fix": "run-s lint:fix check:lint:fix",
-    "generate-sdk": "run-s generate-sdk:*",
-    "generate-sdk:01-prettify": "dotenvx -q run -f .env.local -- node scripts/prettify-base-json.mjs",
-    "generate-sdk:02-generate": "dotenvx -q run -f .env.local -- node scripts/generate-types.mjs > types/api.d.ts",
-    "generate-sdk:03-clean-api": "npm run fix && npm run fix",
-    "knip:dependencies": "knip --dependencies",
-    "knip:exports": "knip --include exports,duplicates",
-    "lint": "dotenvx -q run -f .env.local -- oxlint -c=.oxlintrc.json --ignore-path=.oxlintignore --tsconfig=tsconfig.json .",
-    "lint:fix": "run-s -c lint:fix:*",
-    "lint:fix:oxlint": "dotenvx -q run -f .env.local -- oxlint -c=.oxlintrc.json --ignore-path=.oxlintignore --tsconfig=tsconfig.json --quiet --fix . | dev-null",
-    "lint:fix:biome": "dotenvx -q run -f .env.local -- biome format --log-level=none --fix . | dev-null",
-    "lint:fix:eslint": "dotenvx -q run -f .env.local -- eslint --report-unused-disable-directives --fix . | dev-null",
-    "lint-staged": "dotenvx -q run -f .env.local -- lint-staged",
-    "precommit": "lint-staged",
-    "prepare": "dotenvx -q run -f .env.local -- husky",
-    "prepublishOnly": "run-s build",
-    "test": "run-s check test:*",
-    "test:prepare": "dotenvx -q run -f .env.test -- npm run build",
-    "test:unit": "dotenvx -q run -f .env.test -- vitest --run",
-    "test:unit:update": "dotenvx -q run -f .env.test -- vitest --run --update",
-    "test:unit:coverage": "dotenvx -q run -f .env.test -- vitest run --coverage",
-    "test-ci": "run-s build test:*",
-    "update": "run-p --aggregate-output update:**",
-    "update:deps": "npx --yes npm-check-updates"
-  },
   "dependencies": {
-    "@socketsecurity/registry": "1.1.8"
+    "@socketsecurity/registry": "1.2.0"
   },
   "devDependencies": {
     "@biomejs/biome": "2.2.4",
     "@dotenvx/dotenvx": "1.49.0",
     "@eslint/compat": "1.3.2",
     "@eslint/js": "9.35.0",
-    "@types/node": "24.3.1",
+    "@types/node": "24.4.0",
     "@typescript-eslint/parser": "8.43.0",
+    "@typescript/native-preview": "7.0.0-dev.20250912.1",
     "@vitest/coverage-v8": "3.2.4",
     "del-cli": "6.0.0",
     "dev-null-cli": "2.0.0",
     "eslint": "9.35.0",
     "eslint-import-resolver-typescript": "4.4.4",
     "eslint-plugin-import-x": "4.16.1",
-    "eslint-plugin-jsdoc": "56.1.2",
-    "eslint-plugin-n": "17.21.3",
+    "eslint-plugin-jsdoc": "57.0.8",
+    "eslint-plugin-n": "17.22.0",
     "eslint-plugin-sort-destructure-keys": "2.0.0",
     "eslint-plugin-unicorn": "56.0.1",
     "globals": "16.4.0",
@@ -113,25 +73,27 @@
     "npm-run-all2": "8.0.4",
     "openapi-typescript": "6.7.6",
     "oxlint": "1.15.0",
+    "taze": "19.6.0",
+    "trash": "10.0.0",
     "type-coverage": "2.29.7",
-    "typescript": "5.9.2",
     "typescript-eslint": "8.43.0",
-    "vitest": "3.2.4"
-  },
-  "overrides": {
-    "vite": "7.1.5"
+    "vitest": "3.2.4",
+    "yargs-parser": "^22.0.0",
+    "yoctocolors": "2.1.2"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=18",
+    "pnpm": ">=10.16.0"
   },
   "files": [
     "dist/**",
-    "types/**"
+    "types/**",
+    "CHANGELOG.md"
   ],
   "lint-staged": {
     "*.{cjs,js,json,md,mjs,mts,ts}": [
-      "npm run lint -- --fix",
-      "npm run lint:fix:fast -- --no-errors-on-unmatched --files-ignore-unknown=true --colors=off"
+      "pnpm run lint:fix:oxlint",
+      "pnpm run lint:fix:biome -- --no-errors-on-unmatched --files-ignore-unknown=true --colors=off"
     ]
   },
   "typeCoverage": {
@@ -144,5 +106,52 @@
     "ignore-type-assertion": true,
     "ignore-files": "test/*",
     "strict": true
+  },
+  "scripts": {
+    "build": "pnpm run clean:dist && run-p -c --aggregate-output build:* && run-p -c --aggregate-output build:clean:*",
+    "build:cjs": "dotenvx -q run -f .env.local -- tsgo",
+    "build:esm": "dotenvx -q run -f .env.local -- tsgo -p tsconfig.esm.json",
+    "build:clean:cjs": "dotenvx -q run -f .env.local -- node scripts/rename-dist-cjs-files.mjs",
+    "build:clean:esm": "dotenvx -q run -f .env.local -- node scripts/rename-dist-esm-files.mjs",
+    "check": "run-p -c --aggregate-output check:*",
+    "check:lint": "dotenvx -q run -f .env.local -- eslint --report-unused-disable-directives .",
+    "check:lint:fix": "pnpm run check:lint -- --fix",
+    "check:tsc": "dotenvx -q run -f .env.local -- tsgo --noEmit -p tsconfig.check.json",
+    "check-ci": "pnpm run check:lint",
+    "coverage": "run-s coverage:*",
+    "coverage:test": "run-s test:prepare test:unit:coverage",
+    "coverage:type": "dotenvx -q run -f .env.local -- type-coverage",
+    "coverage:type:verbose": "dotenvx -q run -f .env.local -- type-coverage --detail",
+    "coverage:percent": "node scripts/get-coverage-percentage.mjs",
+    "clean": "run-s -c clean:*",
+    "clean:cache": "del-cli '**/.cache'",
+    "clean:coverage": "del-cli '.type-coverage' 'coverage'",
+    "clean:dist": "del-cli 'dist'",
+    "clean:declarations": "del-cli '*.d.ts' '!api*.d.ts'",
+    "clean:node_modules": "del-cli '**/node_modules'",
+    "fix": "run-s lint:fix",
+    "generate-sdk": "run-s generate-sdk:*",
+    "generate-sdk:01-prettify": "dotenvx -q run -f .env.local -- node scripts/prettify-base-json.mjs",
+    "generate-sdk:02-generate": "dotenvx -q run -f .env.local -- node scripts/generate-types.mjs > types/api.d.ts",
+    "generate-sdk:03-clean-api": "pnpm run fix && pnpm run fix",
+    "knip:dependencies": "knip --dependencies",
+    "knip:exports": "knip --include exports,duplicates",
+    "lint": "dotenvx -q run -f .env.local -- oxlint -c=.oxlintrc.json --ignore-path=.oxlintignore --tsconfig=tsconfig.json .",
+    "lint:fix": "run-s -c lint:fix:*",
+    "lint:fix:oxlint": "dotenvx -q run -f .env.local -- oxlint -c=.oxlintrc.json --ignore-path=.oxlintignore --tsconfig=tsconfig.json --quiet --fix . | dev-null",
+    "lint:fix:biome": "dotenvx -q run -f .env.local -- biome format --log-level=none --fix . | dev-null",
+    "lint:fix:eslint": "dotenvx -q run -f .env.local -- eslint --report-unused-disable-directives --fix . | dev-null",
+    "lint-staged": "dotenvx -q run -f .env.local -- lint-staged",
+    "precommit": "lint-staged",
+    "test": "run-s check test:*",
+    "test:prepare": "dotenvx -q run -f .env.test -- pnpm run build",
+    "test:unit": "dotenvx -q run -f .env.test -- vitest --run",
+    "test:unit:update": "dotenvx -q run -f .env.test -- vitest --run --update",
+    "test:unit:coverage": "dotenvx -q run -f .env.test -- vitest run --coverage",
+    "test-ci": "run-s build test:*",
+    "test-pre-commit": "dotenvx -q run -f .env.precommit -- pnpm test",
+    "update": "run-p --aggregate-output update:**",
+    "update:deps": "taze",
+    "update:socket": "pnpm update '@socketsecurity/*' --latest"
   }
-}
+}

package/types/api-helpers.d.ts

@@ -1,6 +1,6 @@
 declare type ValueOf<
   ObjectType,
-  ValueType extends keyof ObjectType = keyof ObjectType
+  ValueType extends keyof ObjectType = keyof ObjectType,
 > = ObjectType[ValueType]
 
 // Based on openapi-typescript-fetch.

package/types/api.d.ts

@@ -6126,6 +6126,32 @@ export interface operations {
                * @default
                */
               head_full_scan_id?: string | null
+              integration_meta?: {
+                /** @enum {string} */
+                type?: 'github'
+                value?: {
+                  /**
+                   * @description The GitHub installation_id of the active associated Socket GitHub App
+                   * @default
+                   */
+                  installation_id: string
+                  /**
+                   * @description The GitHub login name that the active Socket GitHub App installation is installed to
+                   * @default
+                   */
+                  installation_login: string
+                  /**
+                   * @description The name of the associated GitHub repo.
+                   * @default
+                   */
+                  repo_name: string | null
+                  /**
+                   * @description The id of the associated GitHub repo.
+                   * @default
+                   */
+                  repo_id: string | null
+                }
+              } | null
               /**
                * @description The name of the repository
                * @default
@@ -6255,6 +6281,32 @@ export interface operations {
              * @default
              */
             head_full_scan_id?: string | null
+            integration_meta?: {
+              /** @enum {string} */
+              type?: 'github'
+              value?: {
+                /**
+                 * @description The GitHub installation_id of the active associated Socket GitHub App
+                 * @default
+                 */
+                installation_id: string
+                /**
+                 * @description The GitHub login name that the active Socket GitHub App installation is installed to
+                 * @default
+                 */
+                installation_login: string
+                /**
+                 * @description The name of the associated GitHub repo.
+                 * @default
+                 */
+                repo_name: string | null
+                /**
+                 * @description The id of the associated GitHub repo.
+                 * @default
+                 */
+                repo_id: string | null
+              }
+            } | null
             /**
              * @description The name of the repository
              * @default
@@ -6344,6 +6396,32 @@ export interface operations {
              * @default
              */
             head_full_scan_id: string | null
+            integration_meta: {
+              /** @enum {string} */
+              type?: 'github'
+              value?: {
+                /**
+                 * @description The GitHub installation_id of the active associated Socket GitHub App
+                 * @default
+                 */
+                installation_id: string
+                /**
+                 * @description The GitHub login name that the active Socket GitHub App installation is installed to
+                 * @default
+                 */
+                installation_login: string
+                /**
+                 * @description The name of the associated GitHub repo.
+                 * @default
+                 */
+                repo_name: string | null
+                /**
+                 * @description The id of the associated GitHub repo.
+                 * @default
+                 */
+                repo_id: string | null
+              }
+            } | null
             /**
              * @description The name of the repository
              * @default
@@ -6475,6 +6553,32 @@ export interface operations {
              * @default
              */
             head_full_scan_id?: string | null
+            integration_meta?: {
+              /** @enum {string} */
+              type?: 'github'
+              value?: {
+                /**
+                 * @description The GitHub installation_id of the active associated Socket GitHub App
+                 * @default
+                 */
+                installation_id: string
+                /**
+                 * @description The GitHub login name that the active Socket GitHub App installation is installed to
+                 * @default
+                 */
+                installation_login: string
+                /**
+                 * @description The name of the associated GitHub repo.
+                 * @default
+                 */
+                repo_name: string | null
+                /**
+                 * @description The id of the associated GitHub repo.
+                 * @default
+                 */
+                repo_id: string | null
+              }
+            } | null
             /**
              * @description The name of the repository
              * @default
@@ -11861,6 +11965,7 @@ export interface operations {
           | 'ChangePlanSubscriptionSeats'
           | 'CreateApiToken'
           | 'CreateLabel'
+          | 'DeleteFullScan'
           | 'DeleteLabel'
           | 'DeleteLabelSetting'
           | 'DeleteReport'