@socketsecurity/sdk 1.9.1 → 1.10.0

package/dist/types.d.ts

@@ -19,8 +19,8 @@ export type EntitlementsResponse = {
     items: Entitlement[];
 };
 export type PatchFile = {
-    afterHash?: string;
-    beforeHash?: string;
+    afterHash?: string | undefined;
+    beforeHash?: string | undefined;
     socketBlob?: string | null;
 };
 export type Vulnerability = {
@@ -65,7 +65,7 @@ export type CompactSocketArtifact = Remap<Omit<SocketArtifact, 'alerts' | 'alert
 }>;
 export type CustomResponseType = 'response' | 'text' | 'json';
 export type GetOptions = {
-    responseType?: CustomResponseType;
+    responseType?: CustomResponseType | undefined;
     throws?: boolean | undefined;
 };
 export type GotOptions = {
@@ -73,19 +73,21 @@ export type GotOptions = {
     http?: HttpAgent | undefined;
     https?: HttpsAgent | undefined;
 };
-export type QueryParams = Record<string, any>;
+export type QueryParams = Record<string, unknown>;
 export type HeadersRecord = Record<string, string | string[]> | undefined;
+export type SocketMetricSchema = components['schemas']['SocketMetricSchema'];
+export type SocketId = components['schemas']['SocketId'];
 export type SocketArtifactWithExtras = SocketArtifact & {
-    scorecards?: any;
-    supplyChainRisk?: any;
-    topLevelAncestors?: any;
+    scorecards?: unknown | undefined;
+    supplyChainRisk?: SocketMetricSchema | undefined;
+    topLevelAncestors?: SocketId[] | undefined;
 };
 export type RequestOptions = ((HttpsRequestOptions & {
-    headers?: HeadersRecord;
+    headers?: HeadersRecord | undefined;
 }) | (HttpRequestOptions & {
-    headers?: HeadersRecord;
+    headers?: HeadersRecord | undefined;
 }) | (ClientSessionRequestOptions & {
-    headers?: HeadersRecord;
+    headers?: HeadersRecord | undefined;
 })) & {
     timeout?: number | undefined;
 };
@@ -130,6 +132,8 @@ export type SocketSdkGenericResult<T> = {
 export interface SocketSdkOptions {
     agent?: Agent | GotOptions | undefined;
     baseUrl?: string | undefined;
+    retries?: number | undefined;
+    retryDelay?: number | undefined;
     timeout?: number | undefined;
     userAgent?: string | undefined;
 }
@@ -157,3 +161,21 @@ export type BatchPackageStreamOptions = {
     concurrencyLimit?: number | undefined;
     queryParams?: QueryParams | undefined;
 };
+export type CreateDependenciesSnapshotOptions = {
+    pathsRelativeTo?: string | undefined;
+    queryParams?: QueryParams | undefined;
+};
+export type CreateOrgFullScanOptions = {
+    pathsRelativeTo?: string | undefined;
+    queryParams?: QueryParams | undefined;
+};
+export type CreateScanFromFilepathsOptions = {
+    issueRules?: Record<string, boolean> | undefined;
+    pathsRelativeTo?: string | undefined;
+};
+export type StreamOrgFullScanOptions = {
+    output?: boolean | string | undefined;
+};
+export type UploadManifestFilesOptions = {
+    pathsRelativeTo?: string | undefined;
+};

package/dist/utils.d.ts

@@ -14,7 +14,7 @@ export declare function promiseWithResolvers<T>(): ReturnType<typeof Promise.wit
  * Convert query parameters to URLSearchParams with API-compatible key normalization.
  * Transforms camelCase keys to snake_case and filters out empty values.
  */
-export declare function queryToSearchParams(init?: URLSearchParams | string | QueryParams | Iterable<[string, any]> | ReadonlyArray<[string, any]> | null | undefined): URLSearchParams;
+export declare function queryToSearchParams(init?: URLSearchParams | string | QueryParams | Iterable<[string, unknown]> | ReadonlyArray<[string, unknown]> | null | undefined): URLSearchParams;
 /**
  * Convert relative file paths to absolute paths.
  * Resolves paths relative to specified base directory or current working directory.

package/dist/utils.js

@@ -47,8 +47,8 @@ function promiseWithResolvers() {
  * Transforms camelCase keys to snake_case and filters out empty values.
  */
 function queryToSearchParams(init) {
-    const params = new URLSearchParams(init ?? '');
-    const normalized = { __proto__: null };
+    const params = new URLSearchParams(init);
+    const normalized = Object.create(null);
     const entries = params.entries();
     for (const entry of entries) {
         let key = entry[0];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socketsecurity/sdk",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "license": "MIT",
   "description": "SDK for the Socket API client",
   "author": {
@@ -28,11 +28,11 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "build": "pnpm run clean:dist && tsgo --build",
+    "build": "pnpm run clean:dist && tsgo --build .config/tsconfig.json",
     "check": "run-p -c --aggregate-output check:*",
-    "check:lint": "eslint --report-unused-disable-directives .",
+    "check:lint": "eslint --config .config/eslint.config.mjs --report-unused-disable-directives .",
     "check:lint:fix": "pnpm run check:lint -- --fix",
-    "check:tsc": "tsgo --noEmit -p tsconfig.check.json",
+    "check:tsc": "tsgo --noEmit -p .config/tsconfig.check.json",
     "lint-ci": "pnpm run check:lint",
     "coverage": "run-s coverage:*",
     "coverage:test": "run-s pretest:unit test:unit:coverage",
@@ -42,7 +42,7 @@
     "clean": "run-s -c clean:*",
     "clean:cache": "del-cli '**/.cache'",
     "clean:coverage": "del-cli '.type-coverage' 'coverage'",
-    "clean:dist": "del-cli 'dist' '**/*.tsbuildinfo'",
+    "clean:dist": "del-cli 'dist' '**/*.tsbuildinfo' '.config/*.tsbuildinfo'",
     "clean:declarations": "del-cli '*.d.ts' '!api*.d.ts'",
     "clean:node_modules": "del-cli '**/node_modules'",
     "fix": "run-s lint:fix",
@@ -52,16 +52,16 @@
     "generate-sdk:03-clean-api": "pnpm run fix && pnpm run fix",
     "knip:dependencies": "knip --dependencies",
     "knip:exports": "knip --include exports,duplicates",
-    "lint": "oxlint -c=.oxlintrc.json --ignore-path=.oxlintignore --tsconfig=tsconfig.json .",
+    "lint": "oxlint -c=.config/.oxlintrc.json --ignore-path=.config/.oxlintignore --tsconfig=.config/tsconfig.json .",
     "lint:fix": "run-s -c lint:fix:*",
-    "lint:fix:oxlint": "oxlint -c=.oxlintrc.json --ignore-path=.oxlintignore --tsconfig=tsconfig.json --quiet --fix . | dev-null",
+    "lint:fix:oxlint": "oxlint -c=.config/.oxlintrc.json --ignore-path=.config/.oxlintignore --tsconfig=.config/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:fix:eslint": "eslint --config .config/eslint.config.mjs --report-unused-disable-directives --fix . | dev-null",
     "lint-staged": "lint-staged",
     "precommit": "lint-staged",
     "prepare": "husky",
     "prepublishOnly": "echo 'ERROR: Use GitHub Actions workflow for publishing' && exit 1",
-    "pretest:unit": "dotenvx -q run -f .env.test -- pnpm run build",
+    "pretest:unit": "pnpm run build",
     "test": "run-s check test:*",
     "test:run": "node scripts/test.mjs",
     "test:unit": "dotenvx -q run -f .env.test -- vitest --run",
@@ -75,7 +75,7 @@
     "update:socket": "pnpm -r update '@socketsecurity/*' --latest"
   },
   "dependencies": {
-    "@socketsecurity/registry": "1.3.9"
+    "@socketsecurity/registry": "1.4.0"
   },
   "devDependencies": {
     "@biomejs/biome": "2.2.4",
@@ -126,7 +126,8 @@
   "files": [
     "dist/**",
     "types/**",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "requirements.json"
   ],
   "lint-staged": {
     "*.{cjs,js,json,md,mjs,mts,ts}": [
@@ -136,7 +137,7 @@
   },
   "typeCoverage": {
     "cache": true,
-    "atLeast": 95,
+    "atLeast": 99.6,
     "ignoreAsAssertion": true,
     "ignoreCatch": true,
     "ignoreEmptyType": true,

package/requirements.json

@@ -0,0 +1,232 @@
+{
+  "api": {
+    "batchPackageFetch": {
+      "quota": 100,
+      "permissions": ["packages:list"]
+    },
+    "batchPackageStream": {
+      "quota": 100,
+      "permissions": ["packages:list"]
+    },
+    "createDependenciesSnapshot": {
+      "quota": 100,
+      "permissions": ["report:write"]
+    },
+    "createOrgFullScan": {
+      "quota": 0,
+      "permissions": ["full-scans:create"]
+    },
+    "createOrgRepo": {
+      "quota": 0,
+      "permissions": ["repo:create"]
+    },
+    "createScanFromFilepaths": {
+      "quota": 100,
+      "permissions": ["report:write"]
+    },
+    "deleteOrgFullScan": {
+      "quota": 0,
+      "permissions": ["full-scans:delete"]
+    },
+    "deleteOrgRepo": {
+      "quota": 0,
+      "permissions": ["repo:delete"]
+    },
+    "getAuditLogEvents": {
+      "quota": 10,
+      "permissions": ["audit-log:list"]
+    },
+    "getEnabledEntitlements": {
+      "quota": 0,
+      "permissions": []
+    },
+    "getEntitlements": {
+      "quota": 0,
+      "permissions": []
+    },
+    "getIssuesByNpmPackage": {
+      "quota": 10,
+      "permissions": []
+    },
+    "getOrgAnalytics": {
+      "quota": 10,
+      "permissions": ["analytics:read"]
+    },
+    "getOrganizations": {
+      "quota": 0,
+      "permissions": []
+    },
+    "streamOrgFullScan": {
+      "quota": 0,
+      "permissions": ["full-scans:list"]
+    },
+    "streamPatchesFromScan": {
+      "quota": 0,
+      "permissions": ["patches:list"]
+    },
+    "getOrgFullScanBuffered": {
+      "quota": 0,
+      "permissions": ["full-scans:list"]
+    },
+    "getOrgFullScanList": {
+      "quota": 0,
+      "permissions": ["full-scans:list"]
+    },
+    "getOrgFullScanMetadata": {
+      "quota": 0,
+      "permissions": ["full-scans:list"]
+    },
+    "getOrgLicensePolicy": {
+      "quota": 0,
+      "permissions": ["settings:read"]
+    },
+    "getOrgRepo": {
+      "quota": 0,
+      "permissions": ["repo:list"]
+    },
+    "getOrgRepoList": {
+      "quota": 0,
+      "permissions": ["repo:list"]
+    },
+    "getOrgSecurityPolicy": {
+      "quota": 0,
+      "permissions": ["settings:read"]
+    },
+    "getQuota": {
+      "quota": 0,
+      "permissions": []
+    },
+    "getRepoAnalytics": {
+      "quota": 10,
+      "permissions": ["analytics:read"]
+    },
+    "getScan": {
+      "quota": 0,
+      "permissions": ["report:read"]
+    },
+    "getScanList": {
+      "quota": 0,
+      "permissions": ["report:read"]
+    },
+    "getSupportedScanFiles": {
+      "quota": 0,
+      "permissions": ["report:read"]
+    },
+    "getScoreByNpmPackage": {
+      "quota": 10,
+      "permissions": []
+    },
+    "postSettings": {
+      "quota": 0,
+      "permissions": []
+    },
+    "searchDependencies": {
+      "quota": 100,
+      "permissions": []
+    },
+    "updateOrgRepo": {
+      "quota": 0,
+      "permissions": ["repo:update"]
+    },
+    "uploadManifestFiles": {
+      "quota": 100,
+      "permissions": ["packages:upload"]
+    },
+    "viewPatch": {
+      "quota": 0,
+      "permissions": ["patches:view"]
+    },
+    "deleteReport": {
+      "quota": 0,
+      "permissions": ["report:delete"]
+    },
+    "exportCDX": {
+      "quota": 0,
+      "permissions": ["report:read"]
+    },
+    "exportSPDX": {
+      "quota": 0,
+      "permissions": ["report:read"]
+    },
+    "getAPITokens": {
+      "quota": 10,
+      "permissions": ["api-token:list"]
+    },
+    "postAPIToken": {
+      "quota": 10,
+      "permissions": ["api-token:create"]
+    },
+    "postAPITokenUpdate": {
+      "quota": 10,
+      "permissions": ["api-token:update"]
+    },
+    "postAPITokensRotate": {
+      "quota": 10,
+      "permissions": ["api-token:rotate"]
+    },
+    "postAPITokensRevoke": {
+      "quota": 10,
+      "permissions": ["api-token:revoke"]
+    },
+    "updateOrgSecurityPolicy": {
+      "quota": 0,
+      "permissions": ["settings:write"]
+    },
+    "updateOrgLicensePolicy": {
+      "quota": 0,
+      "permissions": ["settings:write"]
+    },
+    "getOrgTriage": {
+      "quota": 0,
+      "permissions": ["triage:alerts-list"]
+    },
+    "updateOrgAlertTriage": {
+      "quota": 0,
+      "permissions": ["triage:alerts-update"]
+    },
+    "getOrgRepoLabelList": {
+      "quota": 0,
+      "permissions": ["repo-label:list"]
+    },
+    "createOrgRepoLabel": {
+      "quota": 0,
+      "permissions": ["repo-label:create"]
+    },
+    "getOrgRepoLabel": {
+      "quota": 0,
+      "permissions": ["repo-label:list"]
+    },
+    "updateOrgRepoLabel": {
+      "quota": 0,
+      "permissions": ["repo-label:update"]
+    },
+    "deleteOrgRepoLabel": {
+      "quota": 0,
+      "permissions": ["repo-label:delete"]
+    },
+    "getDiffScanById": {
+      "quota": 0,
+      "permissions": ["diff-scans:list"]
+    },
+    "createOrgDiffScanFromIds": {
+      "quota": 0,
+      "permissions": ["diff-scans:create"]
+    },
+    "listOrgDiffScans": {
+      "quota": 0,
+      "permissions": ["diff-scans:list"]
+    },
+    "deleteOrgDiffScan": {
+      "quota": 0,
+      "permissions": ["diff-scans:delete"]
+    },
+    "getApi": {
+      "quota": 0,
+      "permissions": []
+    },
+    "sendApi": {
+      "quota": 0,
+      "permissions": []
+    }
+  }
+}