feat(sdk): bump socket-cli v1.x to @socketsecurity/sdk 4.x (SURF-1446 + SURF-742)

package.json

@@ -125,7 +125,7 @@
     "@socketregistry/packageurl-js": "1.0.9",
     "@socketsecurity/config": "3.0.1",
     "@socketsecurity/registry": "1.1.17",
-    "@socketsecurity/sdk": "1.4.96",
+    "@socketsecurity/sdk": "4.0.3",
     "@types/blessed": "0.1.25",
     "@types/cmd-shim": "5.0.2",
     "@types/js-yaml": "4.0.9",

src/commands/audit-log/output-audit-log.mts

@@ -120,25 +120,29 @@ export async function outputAsJson(
       org: orgSlug,
       page,
       perPage,
-      logs: auditLogs.data.results.map(log => {
-        // Note: The subset is pretty arbitrary
-        const {
-          created_at,
-          event_id,
-          ip_address,
-          type,
-          user_agent,
-          user_email,
-        } = log
-        return {
-          event_id,
-          created_at,
-          ip_address,
-          type,
-          user_agent,
-          user_email,
-        }
-      }),
+      logs: auditLogs.data.results.map(
+        (
+          log: SocketSdkSuccessResult<'getAuditLogEvents'>['data']['results'][number],
+        ) => {
+          // Note: The subset is pretty arbitrary
+          const {
+            created_at,
+            event_id,
+            ip_address,
+            type,
+            user_agent,
+            user_email,
+          } = log
+          return {
+            event_id,
+            created_at,
+            ip_address,
+            type,
+            user_agent,
+            user_email,
+          }
+        },
+      ),
     },
   })
 }
@@ -196,14 +200,18 @@ async function outputWithBlessed(
   orgSlug: string,
 ) {
   const filteredLogs = data.results
-  const formattedOutput = filteredLogs.map(logs => [
-    logs.event_id ?? '',
-    msAtHome(logs.created_at ?? ''),
-    logs.type ?? '',
-    logs.user_email ?? '',
-    logs.ip_address ?? '',
-    logs.user_agent ?? '',
-  ])
+  const formattedOutput: string[][] = filteredLogs.map(
+    (
+      logs: SocketSdkSuccessResult<'getAuditLogEvents'>['data']['results'][number],
+    ) => [
+      logs.event_id ?? '',
+      msAtHome(logs.created_at ?? ''),
+      logs.type ?? '',
+      logs.user_email ?? '',
+      logs.ip_address ?? '',
+      logs.user_agent ?? '',
+    ],
+  )
   const headers = [
     ' Event id',
     ' Created at',

src/commands/fix/coana-fix.mts

@@ -158,6 +158,7 @@ export async function coanaFix(
   const sockSdk = sockSdkCResult.data
 
   const supportedFilesCResult = await fetchSupportedScanFileNames({
+    orgSlug,
     spinner: silence ? undefined : spinner,
     silence,
   })
@@ -209,7 +210,9 @@ export async function coanaFix(
     }
   }
   const uploadCResult = await handleApiCall(
-    sockSdk.uploadManifestFiles(orgSlug, scanFilepaths, cwd),
+    sockSdk.uploadManifestFiles(orgSlug, scanFilepaths, {
+      pathsRelativeTo: cwd,
+    }),
     {
       description: 'upload manifests',
       spinner,

src/commands/login/attempt-login.mts

@@ -71,8 +71,8 @@ export async function attemptLogin(
   const enterpriseOrgs = getEnterpriseOrgs(organizations)
 
   const enforcedChoices: OrgChoices = enterpriseOrgs.map(org => ({
-    name: org.name ?? 'undefined',
-    value: org.id,
+    name: org['name'] ?? 'undefined',
+    value: org['id'],
   }))
 
   let enforcedOrgs: string[] = []

src/commands/organization/fetch-organization-list.mts

@@ -5,7 +5,7 @@ import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
 import type { SetupSdkOptions } from '../../utils/sdk.mts'
-import type { SocketSdk, SocketSdkSuccessResult } from '@socketsecurity/sdk'
+import type { OrganizationsResult, SocketSdk } from '@socketsecurity/sdk'
 
 export type FetchOrganizationOptions = {
   description?: string | undefined
@@ -20,8 +20,7 @@ export type EnterpriseOrganization = Omit<Organization, 'plan'> & {
 
 export type EnterpriseOrganizations = EnterpriseOrganization[]
 
-export type Organization =
-  SocketSdkSuccessResult<'getOrganizations'>['data']['organizations'][string]
+export type Organization = OrganizationsResult['data']['organizations'][number]
 
 export type Organizations = Organization[]
 
@@ -51,7 +50,7 @@ export async function fetchOrganization(
     sockSdk = sockSdkCResult.data
   }
 
-  const orgsCResult = await handleApiCall(sockSdk.getOrganizations(), {
+  const orgsCResult = await handleApiCall(sockSdk.listOrganizations(), {
     description,
     silence,
   })

src/commands/package/output-purls-shallow-score.mts

@@ -241,20 +241,24 @@ export function preProcess(
         row.score.license = artifact.score?.license || 100
       }
 
-      artifact.alerts?.forEach(({ severity, type }) => {
-        row.alerts.set(`${type}:${severity}`, {
-          type: (type as string) ?? 'unknown',
-          severity: (severity as string) ?? 'none',
-        })
-      })
+      artifact.alerts?.forEach(
+        ({ severity, type }: NonNullable<typeof artifact.alerts>[number]) => {
+          row.alerts.set(`${type}:${severity}`, {
+            type: (type as string) ?? 'unknown',
+            severity: (severity as string) ?? 'none',
+          })
+        },
+      )
     } else {
       const alerts = new Map<string, { type: string; severity: string }>()
-      artifact.alerts?.forEach(({ severity, type }) => {
-        alerts.set(`${type}:${severity}`, {
-          type: (type as string) ?? 'unknown',
-          severity: (severity as string) ?? 'none',
-        })
-      })
+      artifact.alerts?.forEach(
+        ({ severity, type }: NonNullable<typeof artifact.alerts>[number]) => {
+          alerts.set(`${type}:${severity}`, {
+            type: (type as string) ?? 'unknown',
+            severity: (severity as string) ?? 'none',
+          })
+        },
+      )
 
       rows.set(purl, {
         ecosystem: artifact.type,

src/commands/repository/fetch-create-repo.mts

@@ -3,7 +3,7 @@ import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
 import type { SetupSdkOptions } from '../../utils/sdk.mts'
-import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
+import type { RepositoryResult } from '@socketsecurity/sdk'
 
 export type FetchCreateRepoConfig = {
   defaultBranch: string
@@ -21,7 +21,7 @@ export type FetchCreateRepoOptions = {
 export async function fetchCreateRepo(
   config: FetchCreateRepoConfig,
   options?: FetchCreateRepoOptions | undefined,
-): Promise<CResult<SocketSdkSuccessResult<'createOrgRepo'>['data']>> {
+): Promise<CResult<RepositoryResult['data']>> {
   const {
     defaultBranch,
     description,
@@ -43,12 +43,11 @@ export async function fetchCreateRepo(
   const sockSdk = sockSdkCResult.data
 
   return await handleApiCall(
-    sockSdk.createOrgRepo(orgSlug, {
+    sockSdk.createRepository(orgSlug, repoName, {
       default_branch: defaultBranch,
       description,
       homepage,
-      name: repoName,
-      visibility,
+      visibility: visibility as 'private' | 'public',
     }),
     { description: 'to create a repository' },
   )

src/commands/repository/fetch-delete-repo.mts

@@ -3,7 +3,7 @@ import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
 import type { SetupSdkOptions } from '../../utils/sdk.mts'
-import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
+import type { DeleteResult } from '@socketsecurity/sdk'
 
 export type FetchDeleteRepoOptions = {
   sdkOpts?: SetupSdkOptions | undefined
@@ -13,7 +13,7 @@ export async function fetchDeleteRepo(
   orgSlug: string,
   repoName: string,
   options?: FetchDeleteRepoOptions | undefined,
-): Promise<CResult<SocketSdkSuccessResult<'deleteOrgRepo'>['data']>> {
+): Promise<CResult<DeleteResult['data']>> {
   const { sdkOpts } = {
     __proto__: null,
     ...options,
@@ -25,7 +25,7 @@ export async function fetchDeleteRepo(
   }
   const sockSdk = sockSdkCResult.data
 
-  return await handleApiCall(sockSdk.deleteOrgRepo(orgSlug, repoName), {
+  return await handleApiCall(sockSdk.deleteRepository(orgSlug, repoName), {
     description: 'to delete a repository',
   })
 }

src/commands/repository/fetch-list-all-repos.mts

@@ -3,7 +3,7 @@ import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
 import type { SetupSdkOptions } from '../../utils/sdk.mts'
-import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
+import type { RepositoriesListResult } from '@socketsecurity/sdk'
 
 export type FetchListAllReposOptions = {
   direction?: string | undefined
@@ -14,7 +14,7 @@ export type FetchListAllReposOptions = {
 export async function fetchListAllRepos(
   orgSlug: string,
   options?: FetchListAllReposOptions | undefined,
-): Promise<CResult<SocketSdkSuccessResult<'getOrgRepoList'>['data']>> {
+): Promise<CResult<RepositoriesListResult['data']>> {
   const { direction, sdkOpts, sort } = {
     __proto__: null,
     ...options,
@@ -26,7 +26,7 @@ export async function fetchListAllRepos(
   }
   const sockSdk = sockSdkCResult.data
 
-  const rows: SocketSdkSuccessResult<'getOrgRepoList'>['data']['results'] = []
+  const rows: RepositoriesListResult['data']['results'] = []
   let protection = 0
   let nextPage = 0
   while (nextPage >= 0) {
@@ -39,11 +39,11 @@ export async function fetchListAllRepos(
     }
     // eslint-disable-next-line no-await-in-loop
     const orgRepoListCResult = await handleApiCall(
-      sockSdk.getOrgRepoList(orgSlug, {
-        sort,
-        direction,
-        per_page: String(100), // max
-        page: String(nextPage),
+      sockSdk.listRepositories(orgSlug, {
+        ...(sort ? { sort: sort as 'name' | 'updated_at' | 'created_at' } : {}),
+        ...(direction ? { direction: direction as 'asc' | 'desc' } : {}),
+        per_page: 100, // max
+        page: nextPage,
       }),
       { description: 'list of repositories' },
     )

src/commands/repository/fetch-list-repos.mts

@@ -3,7 +3,7 @@ import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
 import type { SetupSdkOptions } from '../../utils/sdk.mts'
-import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
+import type { RepositoriesListResult } from '@socketsecurity/sdk'
 
 export type FetchListReposConfig = {
   direction: string
@@ -20,7 +20,7 @@ export type FetchListReposOptions = {
 export async function fetchListRepos(
   config: FetchListReposConfig,
   options?: FetchListReposOptions | undefined,
-): Promise<CResult<SocketSdkSuccessResult<'getOrgRepoList'>['data']>> {
+): Promise<CResult<RepositoriesListResult['data']>> {
   const { direction, orgSlug, page, perPage, sort } = {
     __proto__: null,
     ...config,
@@ -38,11 +38,11 @@ export async function fetchListRepos(
   const sockSdk = sockSdkCResult.data
 
   return await handleApiCall(
-    sockSdk.getOrgRepoList(orgSlug, {
-      sort,
-      direction,
-      per_page: String(perPage),
-      page: String(page),
+    sockSdk.listRepositories(orgSlug, {
+      ...(sort ? { sort: sort as 'name' | 'updated_at' | 'created_at' } : {}),
+      ...(direction ? { direction: direction as 'asc' | 'desc' } : {}),
+      per_page: perPage,
+      page,
     }),
     { description: 'list of repositories' },
   )

src/commands/repository/fetch-update-repo.mts

@@ -3,7 +3,7 @@ import { setupSdk } from '../../utils/sdk.mts'
 
 import type { CResult } from '../../types.mts'
 import type { SetupSdkOptions } from '../../utils/sdk.mts'
-import type { SocketSdkSuccessResult } from '@socketsecurity/sdk'
+import type { RepositoryResult } from '@socketsecurity/sdk'
 
 export type FetchUpdateRepoConfig = {
   defaultBranch: string
@@ -21,7 +21,7 @@ export type FetchUpdateRepoOptions = {
 export async function fetchUpdateRepo(
   config: FetchUpdateRepoConfig,
   options?: FetchUpdateRepoOptions | undefined,
-): Promise<CResult<SocketSdkSuccessResult<'updateOrgRepo'>['data']>> {
+): Promise<CResult<RepositoryResult['data']>> {
   const {
     defaultBranch,
     description,
@@ -43,7 +43,7 @@ export async function fetchUpdateRepo(
   const sockSdk = sockSdkCResult.data
 
   return await handleApiCall(
-    sockSdk.updateOrgRepo(orgSlug, repoName, {
+    sockSdk.updateRepository(orgSlug, repoName, {
       default_branch: defaultBranch,
       description,
       homepage,