@socketsecurity/sdk 1.9.1 → 1.9.2

package/CHANGELOG.md

@@ -4,6 +4,11 @@ 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.9.2](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.9.2) - 2025-10-04
+
+### Changed
+- Improved TypeScript type definitions - All optional properties now include explicit `| undefined` type annotations for better type narrowing and null safety
+
 ## [1.9.1](https://github.com/SocketDev/socket-sdk-js/releases/tag/v1.9.1) - 2025-10-03
 
 ### Changed

package/README.md

@@ -1,13 +1,12 @@
 # @socketsecurity/sdk
 
 [![Socket Badge](https://socket.dev/api/badge/npm/package/@socketsecurity/sdk)](https://socket.dev/npm/package/@socketsecurity/sdk)
-[![npm version](https://img.shields.io/npm/v/@socketsecurity/sdk.svg?style=flat)](https://www.npmjs.com/package/@socketsecurity/sdk)
-[![TypeScript types](https://img.shields.io/npm/types/@socketsecurity/sdk.svg?style=flat)](https://www.npmjs.com/package/@socketsecurity/sdk)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/SocketDev/eslint-config)
+[![CI](https://github.com/SocketDev/socket-sdk-js/actions/workflows/ci.yml/badge.svg)](https://github.com/SocketDev/socket-sdk-js/actions/workflows/ci.yml)
+
 [![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)
 
-SDK for the Socket API client, generated by `api`.
+Official SDK for Socket.dev - Programmatic access to security analysis, vulnerability scanning, and compliance monitoring for your software supply chain.
 
 ## Usage
 

package/dist/http-client.d.ts

@@ -65,7 +65,7 @@ export declare function getResponse(req: ClientRequest): Promise<IncomingMessage
  * @throws {ResponseError} When response has non-2xx status code
  * @throws {SyntaxError} When response body contains invalid JSON
  */
-export declare function getResponseJson(response: IncomingMessage, method?: string): Promise<import("@socketsecurity/registry/lib/json").JsonValue | undefined>;
+export declare function getResponseJson(response: IncomingMessage, method?: string | undefined): Promise<import("@socketsecurity/registry/lib/json").JsonValue | undefined>;
 /**
  * Check if HTTP response has a successful status code (2xx range).
  * Returns true for status codes between 200-299, false otherwise.
@@ -75,4 +75,4 @@ export declare function isResponseOk(response: IncomingMessage): boolean;
  * Transform artifact data based on authentication status.
  * Filters and compacts response data for public/free-tier users.
  */
-export declare function reshapeArtifactForPublicPolicy<T extends Record<string, any>>(data: T, isAuthenticated: boolean, actions?: string): T;
+export declare function reshapeArtifactForPublicPolicy<T extends Record<string, any>>(data: T, isAuthenticated: boolean, actions?: string | undefined): T;

package/dist/quota-utils.d.ts

@@ -4,48 +4,48 @@ interface ApiRequirement {
     permissions: string[];
 }
 /**
- * Get quota cost for a specific SDK method.
- * Returns the number of quota units consumed by the method.
+ * Calculate total quota cost for multiple SDK method calls.
+ * Returns sum of quota units for all specified methods.
  */
-export declare function getQuotaCost(methodName: SocketSdkOperations | string): number;
+export declare function calculateTotalQuotaCost(methodNames: Array<SocketSdkOperations | string>): number;
 /**
- * Get required permissions for a specific SDK method.
- * Returns array of permission strings needed to call the method.
+ * Get all available SDK methods with their requirements.
+ * Returns complete mapping of methods to quota and permissions.
  */
-export declare function getRequiredPermissions(methodName: SocketSdkOperations | string): string[];
+export declare function getAllMethodRequirements(): Record<string, ApiRequirement>;
 /**
  * Get complete requirement information for a SDK method.
  * Returns both quota cost and required permissions.
  */
 export declare function getMethodRequirements(methodName: SocketSdkOperations | string): ApiRequirement;
 /**
- * Calculate total quota cost for multiple SDK method calls.
- * Returns sum of quota units for all specified methods.
+ * Get all methods that require specific permissions.
+ * Returns methods that need any of the specified permissions.
  */
-export declare function calculateTotalQuotaCost(methodNames: Array<SocketSdkOperations | string>): number;
+export declare function getMethodsByPermissions(permissions: string[]): string[];
 /**
  * Get all methods that consume a specific quota amount.
  * Useful for finding high-cost or free operations.
  */
 export declare function getMethodsByQuotaCost(quotaCost: number): string[];
 /**
- * Get all methods that require specific permissions.
- * Returns methods that need any of the specified permissions.
- */
-export declare function getMethodsByPermissions(permissions: string[]): string[];
-/**
- * Check if user has sufficient quota for method calls.
- * Returns true if available quota covers the total cost.
+ * Get quota cost for a specific SDK method.
+ * Returns the number of quota units consumed by the method.
  */
-export declare function hasQuotaForMethods(availableQuota: number, methodNames: Array<SocketSdkOperations | string>): boolean;
+export declare function getQuotaCost(methodName: SocketSdkOperations | string): number;
 /**
  * Get quota usage summary grouped by cost levels.
  * Returns methods categorized by their quota consumption.
  */
 export declare function getQuotaUsageSummary(): Record<string, string[]>;
 /**
- * Get all available SDK methods with their requirements.
- * Returns complete mapping of methods to quota and permissions.
+ * Get required permissions for a specific SDK method.
+ * Returns array of permission strings needed to call the method.
  */
-export declare function getAllMethodRequirements(): Record<string, ApiRequirement>;
+export declare function getRequiredPermissions(methodName: SocketSdkOperations | string): string[];
+/**
+ * Check if user has sufficient quota for method calls.
+ * Returns true if available quota covers the total cost.
+ */
+export declare function hasQuotaForMethods(availableQuota: number, methodNames: Array<SocketSdkOperations | string>): boolean;
 export {};

package/dist/quota-utils.js

@@ -1,14 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getQuotaCost = getQuotaCost;
-exports.getRequiredPermissions = getRequiredPermissions;
-exports.getMethodRequirements = getMethodRequirements;
 exports.calculateTotalQuotaCost = calculateTotalQuotaCost;
-exports.getMethodsByQuotaCost = getMethodsByQuotaCost;
+exports.getAllMethodRequirements = getAllMethodRequirements;
+exports.getMethodRequirements = getMethodRequirements;
 exports.getMethodsByPermissions = getMethodsByPermissions;
-exports.hasQuotaForMethods = hasQuotaForMethods;
+exports.getMethodsByQuotaCost = getMethodsByQuotaCost;
+exports.getQuotaCost = getQuotaCost;
 exports.getQuotaUsageSummary = getQuotaUsageSummary;
-exports.getAllMethodRequirements = getAllMethodRequirements;
+exports.getRequiredPermissions = getRequiredPermissions;
+exports.hasQuotaForMethods = hasQuotaForMethods;
 /** @fileoverview Quota utility functions for Socket SDK method cost lookup. */
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
@@ -33,28 +33,28 @@ function loadRequirements() {
     }
 }
 /**
- * Get quota cost for a specific SDK method.
- * Returns the number of quota units consumed by the method.
+ * Calculate total quota cost for multiple SDK method calls.
+ * Returns sum of quota units for all specified methods.
  */
-function getQuotaCost(methodName) {
-    const reqs = loadRequirements();
-    const requirement = reqs.api[methodName];
-    if (!requirement) {
-        throw new Error(`Unknown SDK method: "${methodName}"`);
-    }
-    return requirement.quota;
+function calculateTotalQuotaCost(methodNames) {
+    return methodNames.reduce((total, methodName) => {
+        return total + getQuotaCost(methodName);
+    }, 0);
 }
 /**
- * Get required permissions for a specific SDK method.
- * Returns array of permission strings needed to call the method.
+ * Get all available SDK methods with their requirements.
+ * Returns complete mapping of methods to quota and permissions.
  */
-function getRequiredPermissions(methodName) {
+function getAllMethodRequirements() {
     const reqs = loadRequirements();
-    const requirement = reqs.api[methodName];
-    if (!requirement) {
-        throw new Error(`Unknown SDK method: "${methodName}"`);
-    }
-    return [...requirement.permissions];
+    const result = {};
+    Object.entries(reqs.api).forEach(([methodName, requirement]) => {
+        result[methodName] = {
+            permissions: [...requirement.permissions],
+            quota: requirement.quota,
+        };
+    });
+    return result;
 }
 /**
  * Get complete requirement information for a SDK method.
@@ -67,18 +67,22 @@ function getMethodRequirements(methodName) {
         throw new Error(`Unknown SDK method: "${methodName}"`);
     }
     return {
-        quota: requirement.quota,
         permissions: [...requirement.permissions],
+        quota: requirement.quota,
     };
 }
 /**
- * Calculate total quota cost for multiple SDK method calls.
- * Returns sum of quota units for all specified methods.
+ * Get all methods that require specific permissions.
+ * Returns methods that need any of the specified permissions.
  */
-function calculateTotalQuotaCost(methodNames) {
-    return methodNames.reduce((total, methodName) => {
-        return total + getQuotaCost(methodName);
-    }, 0);
+function getMethodsByPermissions(permissions) {
+    const reqs = loadRequirements();
+    return Object.entries(reqs.api)
+        .filter(([, requirement]) => {
+        return permissions.some(permission => requirement.permissions.includes(permission));
+    })
+        .map(([methodName]) => methodName)
+        .sort();
 }
 /**
  * Get all methods that consume a specific quota amount.
@@ -92,25 +96,16 @@ function getMethodsByQuotaCost(quotaCost) {
         .sort();
 }
 /**
- * Get all methods that require specific permissions.
- * Returns methods that need any of the specified permissions.
+ * Get quota cost for a specific SDK method.
+ * Returns the number of quota units consumed by the method.
  */
-function getMethodsByPermissions(permissions) {
+function getQuotaCost(methodName) {
     const reqs = loadRequirements();
-    return Object.entries(reqs.api)
-        .filter(([, requirement]) => {
-        return permissions.some(permission => requirement.permissions.includes(permission));
-    })
-        .map(([methodName]) => methodName)
-        .sort();
-}
-/**
- * Check if user has sufficient quota for method calls.
- * Returns true if available quota covers the total cost.
- */
-function hasQuotaForMethods(availableQuota, methodNames) {
-    const totalCost = calculateTotalQuotaCost(methodNames);
-    return availableQuota >= totalCost;
+    const requirement = reqs.api[methodName];
+    if (!requirement) {
+        throw new Error(`Unknown SDK method: "${methodName}"`);
+    }
+    return requirement.quota;
 }
 /**
  * Get quota usage summary grouped by cost levels.
@@ -133,17 +128,22 @@ function getQuotaUsageSummary() {
     return summary;
 }
 /**
- * Get all available SDK methods with their requirements.
- * Returns complete mapping of methods to quota and permissions.
+ * Get required permissions for a specific SDK method.
+ * Returns array of permission strings needed to call the method.
  */
-function getAllMethodRequirements() {
+function getRequiredPermissions(methodName) {
     const reqs = loadRequirements();
-    const result = {};
-    Object.entries(reqs.api).forEach(([methodName, requirement]) => {
-        result[methodName] = {
-            quota: requirement.quota,
-            permissions: [...requirement.permissions],
-        };
-    });
-    return result;
+    const requirement = reqs.api[methodName];
+    if (!requirement) {
+        throw new Error(`Unknown SDK method: "${methodName}"`);
+    }
+    return [...requirement.permissions];
+}
+/**
+ * Check if user has sufficient quota for method calls.
+ * Returns true if available quota covers the total cost.
+ */
+function hasQuotaForMethods(availableQuota, methodNames) {
+    const totalCost = calculateTotalQuotaCost(methodNames);
+    return availableQuota >= totalCost;
 }