@socketsecurity/sdk 1.7.0 → 1.8.1

package/CHANGELOG.md

@@ -4,6 +4,21 @@ 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.8.1](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.8.1) - 2025-09-29
+
+### Changed
+- Update test infrastructure and build configuration
+
+## [1.8.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.8.0) - 2025-09-27
+
+### Added
+- Quota utility functions for API cost management in `quota-utils.ts`
+- New exported functions: `checkQuota`, `formatQuotaReport`, `getEstimatedCost`, `getMethodCost`, `getQuotaSummary`, `isWithinQuota`
+- Example files demonstrating quota usage patterns
+
+### Changed
+- Improved error handling for quota utilities
+
 ## [1.7.0](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.7.0) - 2025-09-26
 
 ### Added

package/README.md

@@ -30,6 +30,36 @@ if (res.success) {
 }
 ```
 
+### Quota Management Example
+
+```javascript
+import {
+  SocketSdk,
+  getQuotaCost,
+  calculateTotalQuotaCost,
+  hasQuotaForMethods
+} from '@socketsecurity/sdk'
+
+const client = new SocketSdk('your-api-key')
+
+// Check quota cost before making API calls
+const batchCost = getQuotaCost('batchPackageFetch') // Returns: 100
+const analyticsCost = getQuotaCost('getOrgAnalytics') // Returns: 10
+
+// Calculate total cost for multiple operations
+const operations = ['batchPackageFetch', 'getOrgAnalytics', 'uploadManifestFiles']
+const totalCost = calculateTotalQuotaCost(operations) // Returns: 210
+
+// Check if you have sufficient quota
+const quotaRes = await client.getQuota()
+if (quotaRes.success && hasQuotaForMethods(quotaRes.data.quota, operations)) {
+  // Proceed with API calls
+  console.log(`Sufficient quota available: ${quotaRes.data.quota} units`)
+} else {
+  console.log('Insufficient quota - consider using free alternatives')
+}
+```
+
 ### CommonJS
 
 ```javascript
@@ -70,7 +100,8 @@ The Socket SDK provides programmatic access to Socket.dev's security analysis pl
 ### Authentication & Access
 - **API Tokens**: Create, rotate, update, and revoke organization API tokens
 - **Entitlements**: View enabled Socket products and features
-- **Quota Management**: Monitor API usage limits and quotas
+- **Quota Management**: Monitor API usage limits, quotas, and plan method calls
+- **Quota Utilities**: Pre-calculate costs, check permissions, and optimize API usage
 
 ### Advanced Features
 - **Patches**: View and stream security patches for vulnerabilities
@@ -154,6 +185,16 @@ The Socket SDK provides programmatic access to Socket.dev's security analysis pl
   * Returns statistical analysis for specified time period
 * `getQuota()` - Get current API quota usage
   * Returns remaining requests, rate limits, and quota reset times
+
+### Quota Utility Functions
+* `getQuotaCost(methodName)` - Get quota cost for any SDK method
+* `getRequiredPermissions(methodName)` - Get required permissions for SDK method
+* `calculateTotalQuotaCost(methodNames[])` - Calculate total cost for multiple methods
+* `hasQuotaForMethods(availableQuota, methodNames[])` - Check if quota is sufficient
+* `getMethodsByQuotaCost(cost)` - Find methods by quota cost (0, 10, 100 units)
+* `getMethodsByPermissions(permissions[])` - Find methods requiring specific permissions
+* `getQuotaUsageSummary()` - Get summary of all methods grouped by quota cost
+* `getAllMethodRequirements()` - Get complete mapping of methods to costs and permissions
 * `getRepoAnalytics(repo, time)` - Get repository analytics
   * Returns security metrics, dependency trends, and vulnerability statistics
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socketsecurity/sdk",
-  "version": "1.7.0",
+  "version": "1.8.1",
   "license": "MIT",
   "description": "SDK for the Socket API client",
   "author": {
@@ -28,41 +28,41 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "pnpm run clean:dist && dotenvx -q run -f .env.local -- tsgo",
+    "build": "pnpm run clean:dist && tsgo --build",
     "check": "run-p -c --aggregate-output check:*",
-    "check:lint": "dotenvx -q run -f .env.local -- eslint --report-unused-disable-directives .",
+    "check:lint": "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:tsc": "pnpm run build && 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:test": "run-s pretest:unit test:unit:coverage",
+    "coverage:type": "type-coverage",
+    "coverage:type:verbose": "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:dist": "del-cli 'dist' '**/*.tsbuildinfo'",
     "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:01-prettify": "node scripts/prettify-base-json.mjs",
+    "generate-sdk:02-generate": "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": "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",
+    "lint:fix:oxlint": "oxlint -c=.oxlintrc.json --ignore-path=.oxlintignore --tsconfig=tsconfig.json --quiet --fix . | dev-null",
+    "lint:fix:biome": "biome format --log-level=none --fix . | dev-null",
+    "lint:fix:eslint": "eslint --report-unused-disable-directives --fix . | dev-null",
+    "lint-staged": "lint-staged",
     "precommit": "lint-staged",
-    "prepare": "dotenvx -q run -f .env.local -- husky",
-    "prepublishOnly": "run-s build",
+    "prepare": "husky",
+    "prepublishOnly": "pnpm run build",
+    "pretest:unit": "dotenvx -q run -f .env.test -- pnpm run build",
     "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",
@@ -80,9 +80,10 @@
     "@dotenvx/dotenvx": "1.49.0",
     "@eslint/compat": "1.3.2",
     "@eslint/js": "9.35.0",
-    "@types/node": "24.4.0",
-    "@typescript-eslint/parser": "8.43.0",
-    "@typescript/native-preview": "7.0.0-dev.20250912.1",
+    "@types/node": "24.5.2",
+    "@typescript-eslint/eslint-plugin": "8.44.1",
+    "@typescript-eslint/parser": "8.44.1",
+    "@typescript/native-preview": "7.0.0-dev.20250926.1",
     "@vitest/coverage-v8": "3.2.4",
     "del-cli": "6.0.0",
     "dev-null-cli": "2.0.0",
@@ -90,7 +91,7 @@
     "eslint-import-resolver-typescript": "4.4.4",
     "eslint-plugin-import-x": "4.16.1",
     "eslint-plugin-jsdoc": "57.0.8",
-    "eslint-plugin-n": "17.22.0",
+    "eslint-plugin-n": "17.23.1",
     "eslint-plugin-sort-destructure-keys": "2.0.0",
     "eslint-plugin-unicorn": "56.0.1",
     "globals": "16.4.0",
@@ -105,7 +106,7 @@
     "taze": "19.6.0",
     "trash": "10.0.0",
     "type-coverage": "2.29.7",
-    "typescript-eslint": "8.43.0",
+    "typescript-eslint": "8.44.1",
     "vitest": "3.2.4",
     "yargs-parser": "22.0.0",
     "yoctocolors": "2.1.2"