@socketsecurity/sdk 3.3.0 → 3.4.0

package/dist/socket-sdk-class.d.ts

@@ -112,7 +112,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/createorgfullscan
      * @apiEndpoint POST /orgs/{org_slug}/full-scans
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes full-scans:create
      * @throws {Error} When server returns 5xx status codes
      */
@@ -121,9 +121,42 @@ export declare class SocketSdk {
      * Create a diff scan from two full scan IDs.
      * Compares two existing full scans to identify changes.
      *
+     * @param orgSlug - Organization identifier
+     * @param options - Diff scan creation options
+     * @param options.after - ID of the after/head full scan (newer)
+     * @param options.before - ID of the before/base full scan (older)
+     * @param options.description - Description of the diff scan
+     * @param options.external_href - External URL to associate with the diff scan
+     * @param options.merge - Set true for merged commits, false for open PR diffs
+     * @returns Diff scan details
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.createOrgDiffScanFromIds('my-org', {
+     *   before: 'scan-id-1',
+     *   after: 'scan-id-2',
+     *   description: 'Compare versions',
+     *   merge: false
+     * })
+     *
+     * if (result.success) {
+     *   console.log('Diff scan created:', result.data.diff_scan.id)
+     * }
+     * ```
+     *
+     * @see https://docs.socket.dev/reference/createorgdiffscanfromids
+     * @apiEndpoint POST /orgs/{org_slug}/diff-scans/from-ids
+     * @quota 0 units
+     * @scopes diff-scans:create, full-scans:list
      * @throws {Error} When server returns 5xx status codes
      */
-    createOrgDiffScanFromIds(orgSlug: string, queryParams?: QueryParams | undefined): Promise<SocketSdkResult<'createOrgDiffScanFromIds'>>;
+    createOrgDiffScanFromIds(orgSlug: string, options: {
+        after: string;
+        before: string;
+        description?: string | undefined;
+        external_href?: string | undefined;
+        merge?: boolean | undefined;
+    }): Promise<SocketSdkResult<'createOrgDiffScanFromIds'>>;
     /**
      * Create a full scan from an archive file (.tar, .tar.gz/.tgz, or .zip).
      * Uploads and scans a compressed archive of project files.
@@ -177,15 +210,22 @@ export declare class SocketSdk {
      * Registers a repository for monitoring and security scanning.
      *
      * @param orgSlug - Organization identifier
-     * @param params - Repository configuration (name, description, homepage, etc.)
+     * @param repoSlug - Repository name/slug
+     * @param params - Additional repository configuration
+     * @param params.archived - Whether the repository is archived
+     * @param params.default_branch - Default branch of the repository
+     * @param params.description - Description of the repository
+     * @param params.homepage - Homepage URL of the repository
+     * @param params.visibility - Visibility setting ('public' or 'private')
+     * @param params.workspace - Workspace of the repository
      * @returns Created repository details
      *
      * @example
      * ```typescript
-     * const result = await sdk.createRepository('my-org', {
-     *   name: 'my-repo',
+     * const result = await sdk.createRepository('my-org', 'my-repo', {
      *   description: 'My project repository',
-     *   homepage: 'https://example.com'
+     *   homepage: 'https://example.com',
+     *   visibility: 'private'
      * })
      *
      * if (result.success) {
@@ -195,11 +235,18 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/createorgrepo
      * @apiEndpoint POST /orgs/{org_slug}/repos
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo:write
      * @throws {Error} When server returns 5xx status codes
      */
-    createRepository(orgSlug: string, params?: QueryParams | undefined): Promise<RepositoryResult | StrictErrorResult>;
+    createRepository(orgSlug: string, repoSlug: string, params?: {
+        archived?: boolean | undefined;
+        default_branch?: null | string | undefined;
+        description?: null | string | undefined;
+        homepage?: null | string | undefined;
+        visibility?: 'private' | 'public' | undefined;
+        workspace?: string | undefined;
+    } | undefined): Promise<RepositoryResult | StrictErrorResult>;
     /**
      * Create a new repository label for an organization.
      *
@@ -221,7 +268,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/createorgrepolabel
      * @apiEndpoint POST /orgs/{org_slug}/repos/labels
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo-label:create
      * @throws {Error} When server returns 5xx status codes
      */
@@ -246,7 +293,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/deleteorgfullscan
      * @apiEndpoint DELETE /orgs/{org_slug}/full-scans/{full_scan_id}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes full-scans:delete
      * @throws {Error} When server returns 5xx status codes
      */
@@ -290,7 +337,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/deleteorgrepo
      * @apiEndpoint DELETE /orgs/{org_slug}/repos/{repo_slug}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo:write
      * @throws {Error} When server returns 5xx status codes
      */
@@ -315,7 +362,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/deleteorgrepolabel
      * @apiEndpoint DELETE /orgs/{org_slug}/repos/labels/{label_id}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo-label:delete
      * @throws {Error} When server returns 5xx status codes
      */
@@ -402,7 +449,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/exportopenvex
      * @apiEndpoint GET /orgs/{org_slug}/export/openvex/{id}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes report:read
      * @throws {Error} When server returns 5xx status codes
      */
@@ -447,6 +494,35 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     getDiffScanById(orgSlug: string, diffScanId: string): Promise<SocketSdkResult<'getDiffScanById'>>;
+    /**
+     * Get GitHub-flavored markdown comments for a diff scan.
+     * Returns dependency overview and alert comments suitable for pull requests.
+     *
+     * @param orgSlug - Organization identifier
+     * @param diffScanId - Diff scan identifier
+     * @param options - Optional query parameters
+     * @param options.github_installation_id - GitHub installation ID for settings
+     * @returns Diff scan metadata with formatted markdown comments
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.getDiffScanGfm('my-org', 'diff-scan-id')
+     *
+     * if (result.success) {
+     *   console.log(result.data.dependency_overview_comment)
+     *   console.log(result.data.dependency_alert_comment)
+     * }
+     * ```
+     *
+     * @see https://docs.socket.dev/reference/getdiffscangfm
+     * @apiEndpoint GET /orgs/{org_slug}/diff-scans/{diff_scan_id}/gfm
+     * @quota 0 units
+     * @scopes diff-scans:list
+     * @throws {Error} When server returns 5xx status codes
+     */
+    getDiffScanGfm(orgSlug: string, diffScanId: string, options?: {
+        github_installation_id?: string | undefined;
+    } | undefined): Promise<SocketSdkResult<'GetDiffScanGfm'>>;
     /**
      * Retrieve the enabled entitlements for an organization.
      *
@@ -483,7 +559,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorgfullscan
      * @apiEndpoint GET /orgs/{org_slug}/full-scans/{full_scan_id}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes full-scans:list
      * @throws {Error} When server returns 5xx status codes
      */
@@ -510,7 +586,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorgfullscanmetadata
      * @apiEndpoint GET /orgs/{org_slug}/full-scans/{full_scan_id}/metadata
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes full-scans:list
      * @throws {Error} When server returns 5xx status codes
      */
@@ -733,7 +809,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorgrepo
      * @apiEndpoint GET /orgs/{org_slug}/repos/{repo_slug}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo:read
      * @throws {Error} When server returns 5xx status codes
      */
@@ -760,7 +836,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorgrepolabel
      * @apiEndpoint GET /orgs/{org_slug}/repos/labels/{label_id}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo-label:list
      * @throws {Error} When server returns 5xx status codes
      */
@@ -772,10 +848,39 @@ export declare class SocketSdk {
      * @throws {Error} When server returns 5xx status codes
      */
     getScoreByNpmPackage(pkgName: string, version: string): Promise<SocketSdkResult<'getScoreByNPMPackage'>>;
+    /**
+     * Get list of supported file types for full scan generation.
+     * Returns glob patterns for supported manifest files, lockfiles, and configuration formats.
+     *
+     * Files whose names match the patterns returned by this endpoint can be uploaded
+     * for report generation. Examples include `package.json`, `package-lock.json`, and `yarn.lock`.
+     *
+     * @param orgSlug - Organization identifier
+     * @returns Nested object with environment and file type patterns
+     *
+     * @example
+     * ```typescript
+     * const result = await sdk.getSupportedFiles('my-org')
+     *
+     * if (result.success) {
+     *   console.log('NPM patterns:', result.data.NPM)
+     *   console.log('PyPI patterns:', result.data.PyPI)
+     * }
+     * ```
+     *
+     * @see https://docs.socket.dev/reference/getsupportedfiles
+     * @apiEndpoint GET /orgs/{org_slug}/supported-files
+     * @quota 0 units
+     * @scopes No scopes required, but authentication is required
+     * @throws {Error} When server returns 5xx status codes
+     */
+    getSupportedFiles(orgSlug: string): Promise<SocketSdkResult<'getSupportedFiles'>>;
     /**
      * Get list of file types and formats supported for scanning.
      * Returns supported manifest files, lockfiles, and configuration formats.
      *
+     * @deprecated Use getSupportedFiles() instead. This endpoint has been deprecated
+     * since 2023-01-15 and now uses the /report/supported endpoint.
      * @throws {Error} When server returns 5xx status codes
      */
     getSupportedScanFiles(): Promise<SocketSdkResult<'getReportSupportedFiles'>>;
@@ -806,7 +911,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorgfullscanlist
      * @apiEndpoint GET /orgs/{org_slug}/full-scans
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes full-scans:list
      * @throws {Error} When server returns 5xx status codes
      */
@@ -831,7 +936,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorganizations
      * @apiEndpoint GET /organizations
-     * @quota 1 unit
+     * @quota 0 units
      * @throws {Error} When server returns 5xx status codes
      */
     listOrganizations(): Promise<OrganizationsResult | StrictErrorResult>;
@@ -868,7 +973,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorgrepolist
      * @apiEndpoint GET /orgs/{org_slug}/repos
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo:list
      * @throws {Error} When server returns 5xx status codes
      */
@@ -896,7 +1001,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorgrepolabellist
      * @apiEndpoint GET /orgs/{org_slug}/repos/labels
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo-label:list
      * @throws {Error} When server returns 5xx status codes
      */
@@ -978,7 +1083,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/rescanorgfullscan
      * @apiEndpoint POST /orgs/{org_slug}/full-scans/{full_scan_id}/rescan
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes full-scans:create
      * @throws {Error} When server returns 5xx status codes
      */
@@ -1029,7 +1134,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/getorgfullscan
      * @apiEndpoint GET /orgs/{org_slug}/full-scans/{full_scan_id}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes full-scans:list
      * @throws {Error} When server returns 5xx status codes
      */
@@ -1122,7 +1227,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/updateorgrepo
      * @apiEndpoint POST /orgs/{org_slug}/repos/{repo_slug}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo:write
      * @throws {Error} When server returns 5xx status codes
      */
@@ -1149,7 +1254,7 @@ export declare class SocketSdk {
      *
      * @see https://docs.socket.dev/reference/updateorgrepolabel
      * @apiEndpoint PUT /orgs/{org_slug}/repos/labels/{label_id}
-     * @quota 1 unit
+     * @quota 0 units
      * @scopes repo-label:update
      * @throws {Error} When server returns 5xx status codes
      */

package/dist/types-strict.d.ts

@@ -50,6 +50,7 @@ export type FullScanItem = {
     repository_id: string;
     repository_slug: string;
     scan_state?: 'pending' | 'precrawl' | 'resolve' | 'scan' | null | undefined;
+    scan_type?: string | null | undefined;
     updated_at: string;
     workspace?: string | undefined;
 };
@@ -79,6 +80,7 @@ export type ListFullScansOptions = {
     per_page?: number | undefined;
     pull_request?: string | undefined;
     repo?: string | undefined;
+    scan_type?: string | undefined;
     sort?: 'name' | 'created_at' | undefined;
     startAfterCursor?: string | undefined;
     use_cursor?: boolean | undefined;
@@ -93,6 +95,7 @@ export type ListRepositoriesOptions = {
     page?: number | undefined;
     per_page?: number | undefined;
     sort?: string | undefined;
+    workspace?: string | undefined;
 };
 /**
  * Strict type for organization item.
@@ -109,7 +112,50 @@ export type OrganizationItem = {
  */
 export type RepositoriesListData = {
     nextPage?: number | null | undefined;
-    results: RepositoryItem[];
+    results: RepositoryListItem[];
+};
+/**
+ * Strict type for repository list item.
+ */
+export type RepositoryListItem = {
+    archived: boolean;
+    created_at: string;
+    default_branch: string | null;
+    description: string | null;
+    head_full_scan_id: string | null;
+    homepage: string | null;
+    id: string;
+    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 | undefined;
+    name: string;
+    slug: string;
+    updated_at: string;
+    visibility: 'public' | 'private';
+    workspace: string;
 };
 /**
  * Strict type for repository item.
@@ -149,7 +195,7 @@ export type RepositoryItem = {
         };
     } | null;
     name: string;
-    slig?: string | undefined;
+    slig: string;
     slug: string;
     updated_at: string;
     visibility: 'public' | 'private';

package/dist/types.d.ts

@@ -140,6 +140,7 @@ export type SocketSdkErrorResult<T extends SocketSdkOperations> = {
     error: string;
     status: number;
     success: false;
+    url?: string | undefined;
     _operation?: T | undefined;
 };
 export type SocketSdkResult<T extends SocketSdkOperations> = SocketSdkSuccessResult<T> | SocketSdkErrorResult<T>;
@@ -168,6 +169,7 @@ export type SocketSdkGenericResult<T> = {
     error: string;
     status: number;
     success: false;
+    url?: string | undefined;
 };
 /**
  * Result from file validation callback.
@@ -268,14 +270,13 @@ export interface SocketSdkOptions {
         onResponse?: ((info: ResponseInfo) => void) | undefined;
     } | undefined;
     /**
-     * Number of retry attempts on failure (default: 0, retries disabled).
-     * Retries are opt-in following Node.js fs.rm() pattern.
-     * Recommended: 3 for production, 0 for testing.
+     * Number of retry attempts on failure (default: 3).
+     * Uses exponential backoff between retries.
      */
     retries?: number | undefined;
     /**
-     * Initial delay in milliseconds between retries (default: 100).
-     * Uses exponential backoff: 100ms, 200ms, 400ms, etc.
+     * Initial delay in milliseconds between retries (default: 1000).
+     * Uses exponential backoff: 1000ms, 2000ms, 4000ms, etc.
      */
     retryDelay?: number | undefined;
     /** Request timeout in milliseconds */

package/package.json

@@ -1,19 +1,25 @@
 {
   "name": "@socketsecurity/sdk",
-  "version": "3.3.0",
-  "packageManager": "pnpm@10.28.1",
-  "license": "MIT",
+  "version": "3.4.0",
   "description": "SDK for the Socket API client",
+  "homepage": "https://github.com/SocketDev/socket-sdk-js",
+  "license": "MIT",
   "author": {
     "name": "Socket Inc",
     "email": "eng@socket.dev",
     "url": "https://socket.dev"
   },
-  "homepage": "https://github.com/SocketDev/socket-sdk-js",
   "repository": {
     "type": "git",
     "url": "git://github.com/SocketDev/socket-sdk-js.git"
   },
+  "files": [
+    "CHANGELOG.md",
+    "data/*.json",
+    "dist/*.d.ts",
+    "dist/*.js",
+    "types/*.d.ts"
+  ],
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -42,6 +48,8 @@
     "clean": "node scripts/clean.mjs",
     "cover": "node scripts/cover.mjs",
     "fix": "node scripts/lint.mjs --fix",
+    "format": "oxfmt .",
+    "format:check": "oxfmt --check .",
     "generate-sdk": "node scripts/generate-sdk.mjs",
     "lint": "node scripts/lint.mjs",
     "precommit": "pnpm run check --lint --staged",
@@ -49,7 +57,7 @@
     "ci:validate": "node scripts/ci-validate.mjs",
     "prepublishOnly": "echo 'ERROR: Use GitHub Actions workflow for publishing' && exit 1",
     "publish": "node scripts/publish.mjs",
-    "publish:ci": "node scripts/publish.mjs --skip-git --skip-build --tag ${DIST_TAG:-latest}",
+    "publish:ci": "node scripts/publish.mjs --tag ${DIST_TAG:-latest}",
     "claude": "node scripts/claude.mjs",
     "test": "node scripts/test.mjs",
     "type": "tsgo --noEmit -p .config/tsconfig.check.json",
@@ -57,7 +65,7 @@
   },
   "dependencies": {
     "@socketregistry/packageurl-js": "1.3.5",
-    "@socketsecurity/lib": "5.5.3",
+    "@socketsecurity/lib": "5.8.0",
     "form-data": "4.0.5"
   },
   "devDependencies": {
@@ -65,40 +73,46 @@
     "@babel/parser": "7.26.3",
     "@babel/traverse": "7.26.4",
     "@babel/types": "7.26.3",
-    "@biomejs/biome": "2.2.4",
-    "@dotenvx/dotenvx": "^1.51.4",
-    "@eslint/compat": "1.3.2",
-    "@eslint/js": "9.35.0",
+    "@dotenvx/dotenvx": "1.54.1",
+    "@oxlint/migrate": "1.52.0",
+    "@sveltejs/acorn-typescript": "1.0.8",
     "@types/babel__traverse": "7.28.0",
     "@types/node": "24.9.2",
     "@typescript/native-preview": "7.0.0-dev.20250926.1",
     "@vitest/coverage-v8": "4.0.3",
-    "@sveltejs/acorn-typescript": "1.0.8",
     "acorn": "8.15.0",
     "del": "8.0.1",
     "dev-null-cli": "2.0.0",
     "esbuild": "0.25.11",
-    "eslint": "9.35.0",
-    "eslint-import-resolver-typescript": "4.4.4",
-    "eslint-plugin-import-x": "4.16.1",
-    "eslint-plugin-jsdoc": "57.0.8",
-    "eslint-plugin-n": "17.23.1",
-    "eslint-plugin-sort-destructure-keys": "2.0.0",
-    "eslint-plugin-unicorn": "56.0.1",
     "fast-glob": "3.3.3",
-    "globals": "16.4.0",
     "http2-wrapper": "2.2.1",
     "husky": "9.1.7",
     "magic-string": "0.30.14",
     "nock": "14.0.10",
     "openapi-typescript": "6.7.6",
+    "oxfmt": "0.37.0",
+    "oxlint": "1.52.0",
     "semver": "7.7.2",
     "taze": "19.9.2",
     "type-coverage": "2.29.7",
-    "typescript-eslint": "8.44.1",
-    "vitest": "4.0.3",
-    "yoctocolors-cjs": "2.1.3"
+    "vitest": "4.0.3"
+  },
+  "typeCoverage": {
+    "atLeast": 99,
+    "cache": true,
+    "ignore-files": "test/*",
+    "ignore-non-null-assertion": true,
+    "ignore-type-assertion": true,
+    "ignoreAsAssertion": true,
+    "ignoreCatch": true,
+    "ignoreEmptyType": true,
+    "strict": true
+  },
+  "engines": {
+    "node": ">=18",
+    "pnpm": ">=10.25.0"
   },
+  "packageManager": "pnpm@10.32.1",
   "pnpm": {
     "ignoredBuiltDependencies": [
       "esbuild",
@@ -107,27 +121,5 @@
     "overrides": {
       "vite": "7.1.12"
     }
-  },
-  "engines": {
-    "node": ">=18",
-    "pnpm": ">=10.25.0"
-  },
-  "files": [
-    "CHANGELOG.md",
-    "data/*.json",
-    "dist/*.d.ts",
-    "dist/*.js",
-    "types/*.d.ts"
-  ],
-  "typeCoverage": {
-    "cache": true,
-    "atLeast": 99,
-    "ignoreAsAssertion": true,
-    "ignoreCatch": true,
-    "ignoreEmptyType": true,
-    "ignore-non-null-assertion": true,
-    "ignore-type-assertion": true,
-    "ignore-files": "test/*",
-    "strict": true
   }
 }