Add paths utilities and update dependencies

Author: jdalton

package.json

@@ -130,7 +130,7 @@
     "@socketregistry/is-interactive": "1.0.6",
     "@socketregistry/packageurl-js": "1.1.4",
     "@socketsecurity/config": "3.0.1",
-    "@socketsecurity/registry": "1.3.7",
+    "@socketsecurity/registry": "file:/Users/jdalton/projects/socket-registry/registry/socketsecurity-registry-1.3.7.tgz",
     "@socketsecurity/sdk": "1.8.5",
     "@types/cmd-shim": "5.0.2",
     "@types/js-yaml": "4.0.9",

pnpm-lock.yaml

@@ -26,6 +26,10 @@ const BUN = regConsts.BUN
 const CHANGELOG_MD = regConsts.CHANGELOG_MD
 const CI = regConsts.CI
 const COLUMN_LIMIT = regConsts.COLUMN_LIMIT
+const CACHE_DIR = regConsts.CACHE_DIR
+const CACHE_GITHUB_DIR = regConsts.CACHE_GITHUB_DIR
+const CACHE_SOCKET_API_DIR = regConsts.CACHE_SOCKET_API_DIR
+const CACHE_TTL_DIR = regConsts.CACHE_TTL_DIR
 const DOT_GIT_DIR = regConsts.DOT_GIT_DIR
 const DOT_PACKAGE_LOCK_JSON = regConsts.DOT_PACKAGE_LOCK_JSON
 const DOT_SOCKET_DIR = regConsts.DOT_SOCKET_DIR
@@ -82,6 +86,7 @@ const REGISTRY = regConsts.REGISTRY
 const REGISTRY_SCOPE_DELIMITER = regConsts.REGISTRY_SCOPE_DELIMITER
 const RESOLUTIONS = regConsts.RESOLUTIONS
 const SOCKET_GITHUB_ORG = regConsts.SOCKET_GITHUB_ORG
+const SOCKET_CLI_APP_NAME = regConsts.SOCKET_CLI_APP_NAME
 const SOCKET_IPC_HANDSHAKE = regConsts.SOCKET_IPC_HANDSHAKE
 const SOCKET_OVERRIDE_SCOPE = regConsts.SOCKET_OVERRIDE_SCOPE
 const SOCKET_PUBLIC_API_TOKEN = regConsts.SOCKET_PUBLIC_API_TOKEN
@@ -216,6 +221,7 @@ const ALERT_TYPE_CVE = 'cve'
 const ALERT_TYPE_MEDIUM_CVE = 'mediumCVE'
 const ALERT_TYPE_MILD_CVE = 'mildCVE'
 const API_V0_URL = 'https://api.socket.dev/v0/'
+const CLI_DIR = 'cli'
 const CONFIG_KEY_API_BASE_URL = 'apiBaseUrl'
 const CONFIG_KEY_API_PROXY = 'apiProxy'
 const CONFIG_KEY_API_TOKEN = 'apiToken'
@@ -279,6 +285,7 @@ const REPORT_LEVEL_IGNORE = 'ignore'
 const REPORT_LEVEL_MONITOR = 'monitor'
 const REPORT_LEVEL_WARN = 'warn'
 const REQUIREMENTS_TXT = 'requirements.txt'
+const SEA_DIR = 'sea'
 const SEA_UPDATE_COMMAND = 'self-update'
 const SOCKET_CLI_ACCEPT_RISKS = 'SOCKET_CLI_ACCEPT_RISKS'
 const SOCKET_CLI_BIN_NAME = 'socket'
@@ -296,12 +303,18 @@ const SOCKET_JSON = 'socket.json'
 const SOCKET_WEBSITE_URL = 'https://socket.dev'
 const SOCKET_YAML = 'socket.yaml'
 const SOCKET_YML = 'socket.yml'
+const TMP_DIR = 'tmp'
 const TOKEN_PREFIX = 'sktsec_'
 const TOKEN_PREFIX_LENGTH = TOKEN_PREFIX.length
 const UPDATE_CHECK_TTL = 24 * 60 * 60 * 1_000
 const UPDATE_NOTIFIER_TIMEOUT = 10_000
 const UPDATE_STORE_DIR = '.socket/_socket'
 const UPDATE_STORE_FILE_NAME = 'update-store.json'
+const UPDATER_BACKUPS_DIR = 'backups'
+const UPDATER_DIR = 'updater'
+const UPDATER_DOWNLOADS_DIR = 'downloads'
+const UPDATER_STAGING_DIR = 'staging'
+const UPDATER_STATE_JSON = 'state.json'
 const V1_MIGRATION_GUIDE_URL = 'https://docs.socket.dev/docs/v1-migration-guide'
 
 export type Constants = Remap<
@@ -315,10 +328,15 @@ export type Constants = Remap<
     readonly ALERT_TYPE_MEDIUM_CVE: typeof ALERT_TYPE_MEDIUM_CVE
     readonly ALERT_TYPE_MILD_CVE: typeof ALERT_TYPE_MILD_CVE
     readonly API_V0_URL: typeof API_V0_URL
+    readonly CLI_DIR: typeof CLI_DIR
     readonly BUN: typeof BUN
     readonly BUN_LOCK: typeof BUN_LOCK
     readonly BUN_LOCKB: typeof BUN_LOCKB
     readonly CHANGELOG_MD: typeof CHANGELOG_MD
+    readonly CACHE_DIR: typeof CACHE_DIR
+    readonly CACHE_GITHUB_DIR: typeof CACHE_GITHUB_DIR
+    readonly CACHE_SOCKET_API_DIR: typeof CACHE_SOCKET_API_DIR
+    readonly CACHE_TTL_DIR: typeof CACHE_TTL_DIR
     readonly CONFIG_KEY_API_BASE_URL: typeof CONFIG_KEY_API_BASE_URL
     readonly CONFIG_KEY_API_PROXY: typeof CONFIG_KEY_API_PROXY
     readonly CONFIG_KEY_API_TOKEN: typeof CONFIG_KEY_API_TOKEN
@@ -337,6 +355,11 @@ export type Constants = Remap<
     readonly UPDATE_NOTIFIER_TIMEOUT: typeof UPDATE_NOTIFIER_TIMEOUT
     readonly UPDATE_STORE_DIR: typeof UPDATE_STORE_DIR
     readonly UPDATE_STORE_FILE_NAME: typeof UPDATE_STORE_FILE_NAME
+    readonly UPDATER_BACKUPS_DIR: typeof UPDATER_BACKUPS_DIR
+    readonly UPDATER_DIR: typeof UPDATER_DIR
+    readonly UPDATER_DOWNLOADS_DIR: typeof UPDATER_DOWNLOADS_DIR
+    readonly UPDATER_STAGING_DIR: typeof UPDATER_STAGING_DIR
+    readonly UPDATER_STATE_JSON: typeof UPDATER_STATE_JSON
     readonly DRY_RUN_NOT_SAVING: typeof DRY_RUN_NOT_SAVING
     readonly EMPTY_VALUE: typeof EMPTY_VALUE
     readonly ENV: ENV
@@ -406,7 +429,9 @@ export type Constants = Remap<
     readonly REPORT_LEVEL_MONITOR: typeof REPORT_LEVEL_MONITOR
     readonly REPORT_LEVEL_WARN: typeof REPORT_LEVEL_WARN
     readonly REQUIREMENTS_TXT: typeof REQUIREMENTS_TXT
+    readonly SEA_DIR: typeof SEA_DIR
     readonly RESOLUTIONS: typeof RESOLUTIONS
+    readonly SOCKET_CLI_APP_NAME: typeof SOCKET_CLI_APP_NAME
     readonly SOCKET_CLI_ACCEPT_RISKS: typeof SOCKET_CLI_ACCEPT_RISKS
     readonly SOCKET_CLI_BIN_NAME: typeof SOCKET_CLI_BIN_NAME
     readonly SOCKET_CLI_GITHUB_REPO: typeof SOCKET_CLI_GITHUB_REPO
@@ -426,6 +451,7 @@ export type Constants = Remap<
     readonly SOCKET_WEBSITE_URL: typeof SOCKET_WEBSITE_URL
     readonly SOCKET_YAML: typeof SOCKET_YAML
     readonly SOCKET_YML: typeof SOCKET_YML
+    readonly TMP_DIR: typeof TMP_DIR
     readonly TOKEN_PREFIX: typeof TOKEN_PREFIX
     readonly TOKEN_PREFIX_LENGTH: typeof TOKEN_PREFIX_LENGTH
     readonly TSCONFIG_JSON: typeof TSCONFIG_JSON
@@ -956,7 +982,12 @@ const constants: Constants = createConstantsObject(
     ALERT_TYPE_MEDIUM_CVE,
     ALERT_TYPE_MILD_CVE,
     API_V0_URL,
+    CLI_DIR,
     BUN,
+    CACHE_DIR,
+    CACHE_GITHUB_DIR,
+    CACHE_SOCKET_API_DIR,
+    CACHE_TTL_DIR,
     CONFIG_KEY_API_BASE_URL,
     CONFIG_KEY_API_PROXY,
     CONFIG_KEY_API_TOKEN,
@@ -1028,6 +1059,8 @@ const constants: Constants = createConstantsObject(
     REPORT_LEVEL_MONITOR,
     REPORT_LEVEL_WARN,
     REQUIREMENTS_TXT,
+    SEA_DIR,
+    SOCKET_CLI_APP_NAME,
     SOCKET_CLI_ACCEPT_RISKS,
     SOCKET_CLI_BIN_NAME,
     SOCKET_CLI_GITHUB_REPO,
@@ -1044,11 +1077,17 @@ const constants: Constants = createConstantsObject(
     SOCKET_WEBSITE_URL,
     SOCKET_YAML,
     SOCKET_YML,
+    TMP_DIR,
     TOKEN_PREFIX,
     TOKEN_PREFIX_LENGTH,
     TSCONFIG_JSON,
     UNKNOWN_ERROR,
     UNKNOWN_VALUE,
+    UPDATER_BACKUPS_DIR,
+    UPDATER_DIR,
+    UPDATER_DOWNLOADS_DIR,
+    UPDATER_STAGING_DIR,
+    UPDATER_STATE_JSON,
     V1_MIGRATION_GUIDE_URL,
     VLT,
     YARN,
@@ -1226,6 +1265,10 @@ export {
   ALERT_TYPE_MEDIUM_CVE,
   ALERT_TYPE_MILD_CVE,
   API_V0_URL,
+  CACHE_DIR,
+  CACHE_GITHUB_DIR,
+  CACHE_SOCKET_API_DIR,
+  CACHE_TTL_DIR,
   CONFIG_KEY_API_BASE_URL,
   CONFIG_KEY_API_PROXY,
   CONFIG_KEY_API_TOKEN,
@@ -1292,6 +1335,15 @@ export {
   REPORT_LEVEL_MONITOR,
   REPORT_LEVEL_WARN,
   REQUIREMENTS_TXT,
+  CLI_DIR,
+  SEA_DIR,
+  TMP_DIR,
+  UPDATER_BACKUPS_DIR,
+  UPDATER_DIR,
+  UPDATER_DOWNLOADS_DIR,
+  UPDATER_STAGING_DIR,
+  UPDATER_STATE_JSON,
+  SOCKET_CLI_APP_NAME,
   SOCKET_CLI_ACCEPT_RISKS,
   SOCKET_CLI_BIN_NAME,
   SOCKET_CLI_GITHUB_REPO,

src/constants.mts

@@ -43,6 +43,7 @@ import { parseUrl } from '@socketsecurity/registry/lib/url'
 
 import { debugDir, debugFn, isDebug } from './debug.mts'
 import { formatErrorWithDetail } from './errors.mts'
+import { getSocketCliGithubCacheDir } from './paths.mts'
 import constants from '../constants.mts'
 
 import type { components } from '@octokit/openapi-types'
@@ -56,7 +57,8 @@ async function readCache(
   // 5 minute in milliseconds time to live (TTL).
   ttlMs = 5 * 60 * 1000,
 ): Promise<JsonContent | undefined> {
-  const cacheJsonPath = path.join(constants.githubCachePath, `${key}.json`)
+  const githubCachePath = getSocketCliGithubCacheDir()
+  const cacheJsonPath = path.join(githubCachePath, `${key}.json`)
   const stat = safeStatsSync(cacheJsonPath)
   if (stat) {
     const isExpired = Date.now() - Number(stat.mtimeMs) > ttlMs
@@ -71,7 +73,7 @@ export async function writeCache(
   key: string,
   data: JsonContent,
 ): Promise<void> {
-  const { githubCachePath } = constants
+  const githubCachePath = getSocketCliGithubCacheDir()
   const cacheJsonPath = path.join(githubCachePath, `${key}.json`)
   if (!existsSync(githubCachePath)) {
     await fs.mkdir(githubCachePath, { recursive: true })

src/utils/github.mts

@@ -16,11 +16,14 @@ vi.mock('@socketsecurity/registry/lib/fs', () => ({
   writeJson: vi.fn(),
 }))
 
+vi.mock('./paths.mts', () => ({
+  getSocketCliGithubCacheDir: vi.fn(() => '/cache/github'),
+}))
+
 vi.mock('../constants.mts', () => {
   const kInternalsSymbol = Symbol.for('kInternalsSymbol')
   return {
     default: {
-      githubCachePath: '/cache/github',
       ENV: {
         DISABLE_GITHUB_CACHE: false,
       },
@@ -144,7 +147,6 @@ describe('github utilities', () => {
       const kInternalsSymbol = Symbol.for('kInternalsSymbol')
       vi.doMock('../constants.mts', () => ({
         default: {
-          githubCachePath: '/cache/github',
           ENV: {
             DISABLE_GITHUB_CACHE: true,
           },

src/utils/github.test.mts

@@ -0,0 +1,119 @@
+/**
+ * Path utilities for Socket CLI directories.
+ * Provides platform-aware path resolution for Socket CLI's directory structure.
+ *
+ * Directory Structure:
+ * ~/.socket/_socket/
+ * ├── cache/ttl/
+ * │   ├── github/          # GitHub API cache
+ * │   └── socket-api/      # Socket API cache
+ * ├── cli/                 # CLI-specific files
+ * ├── sea/                 # Single Executable Application build artifacts
+ * ├── tmp/                 # Temporary files
+ * └── updater/             # CLI updater files
+ *     ├── backups/         # Backup files
+ *     ├── downloads/       # Downloaded updates
+ *     ├── staging/         # Staged updates
+ *     └── state.json       # Updater state
+ */
+
+import path from 'node:path'
+
+import {
+  getSocketAppCacheDir,
+  getSocketAppCacheTtlDir,
+  getSocketCliDir,
+} from '@socketsecurity/registry/lib/paths'
+
+import constants from '../constants.mts'
+
+/**
+ * Get the Socket CLI base directory (~/.socket/_socket).
+ */
+export function getSocketCliBaseDir(): string {
+  return getSocketCliDir()
+}
+
+/**
+ * Get the Socket CLI cache directory (~/.socket/_socket/cache).
+ */
+export function getSocketCliCacheDir(): string {
+  return getSocketAppCacheDir(constants.SOCKET_CLI_APP_NAME)
+}
+
+/**
+ * Get the Socket CLI TTL cache directory (~/.socket/_socket/cache/ttl).
+ */
+export function getSocketCliCacheTtlDir(): string {
+  return getSocketAppCacheTtlDir(constants.SOCKET_CLI_APP_NAME)
+}
+
+/**
+ * Get the Socket CLI GitHub cache directory (~/.socket/_socket/cache/ttl/github).
+ */
+export function getSocketCliGithubCacheDir(): string {
+  return path.join(getSocketCliCacheTtlDir(), constants.CACHE_GITHUB_DIR)
+}
+
+/**
+ * Get the Socket CLI Socket API cache directory (~/.socket/_socket/cache/ttl/socket-api).
+ */
+export function getSocketCliSocketApiCacheDir(): string {
+  return path.join(getSocketCliCacheTtlDir(), constants.CACHE_SOCKET_API_DIR)
+}
+
+/**
+ * Get the Socket CLI directory (~/.socket/_socket/cli).
+ */
+export function getSocketCliCliDir(): string {
+  return path.join(getSocketCliBaseDir(), constants.CLI_DIR)
+}
+
+/**
+ * Get the Socket CLI SEA directory (~/.socket/_socket/sea).
+ */
+export function getSocketCliSeaDir(): string {
+  return path.join(getSocketCliBaseDir(), constants.SEA_DIR)
+}
+
+/**
+ * Get the Socket CLI temporary directory (~/.socket/_socket/tmp).
+ */
+export function getSocketCliTmpDir(): string {
+  return path.join(getSocketCliBaseDir(), constants.TMP_DIR)
+}
+
+/**
+ * Get the Socket CLI updater directory (~/.socket/_socket/updater).
+ */
+export function getSocketCliUpdaterDir(): string {
+  return path.join(getSocketCliBaseDir(), constants.UPDATER_DIR)
+}
+
+/**
+ * Get the Socket CLI updater downloads directory (~/.socket/_socket/updater/downloads).
+ */
+export function getSocketCliUpdaterDownloadsDir(): string {
+  return path.join(getSocketCliUpdaterDir(), constants.UPDATER_DOWNLOADS_DIR)
+}
+
+/**
+ * Get the Socket CLI updater backups directory (~/.socket/_socket/updater/backups).
+ */
+export function getSocketCliUpdaterBackupsDir(): string {
+  return path.join(getSocketCliUpdaterDir(), constants.UPDATER_BACKUPS_DIR)
+}
+
+/**
+ * Get the Socket CLI updater staging directory (~/.socket/_socket/updater/staging).
+ */
+export function getSocketCliUpdaterStagingDir(): string {
+  return path.join(getSocketCliUpdaterDir(), constants.UPDATER_STAGING_DIR)
+}
+
+/**
+ * Get the Socket CLI updater state file path (~/.socket/_socket/updater/state.json).
+ */
+export function getSocketCliUpdaterStateJsonPath(): string {
+  return path.join(getSocketCliUpdaterDir(), constants.UPDATER_STATE_JSON)
+}