@socketsecurity/lib 5.28.0 → 6.0.1

package/dist/env/socket-cli.d.ts

@@ -1,214 +1,198 @@
 /**
- * @fileoverview Socket CLI environment variables.
- * Provides typed getters for SOCKET_CLI_* environment variables (excluding shadow).
+ * @file Socket CLI environment variables. Provides typed getters for
+ *   SOCKET_CLI_* environment variables (excluding shadow).
  */
 /**
  * Whether to accept all Socket CLI risks (alternative name).
  *
- * @returns Whether to accept all risks
- *
  * @example
- * ```typescript
- * import { getSocketCliAcceptRisks } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliAcceptRisks } from '@socketsecurity/lib/env/socket-cli'
  *
- * if (getSocketCliAcceptRisks()) {
- *   console.log('All risks accepted')
- * }
- * ```
+ *   if (getSocketCliAcceptRisks()) {
+ *     console.log('All risks accepted')
+ *   }
+ *   ```
+ *
+ * @returns Whether to accept all risks
  */
 export declare function getSocketCliAcceptRisks(): boolean;
 /**
- * Socket CLI API base URL (alternative name).
- * Checks SOCKET_CLI_API_BASE_URL first, then falls back to legacy SOCKET_SECURITY_API_BASE_URL.
- *
- * @returns API base URL or undefined
+ * Socket CLI API base URL (alternative name). Checks SOCKET_CLI_API_BASE_URL
+ * first, then falls back to legacy SOCKET_SECURITY_API_BASE_URL.
  *
  * @example
- * ```typescript
- * import { getSocketCliApiBaseUrl } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliApiBaseUrl } from '@socketsecurity/lib/env/socket-cli'
+ *
+ *   const baseUrl = getSocketCliApiBaseUrl()
+ *   // e.g. 'https://api.socket.dev' or undefined
+ *   ```
  *
- * const baseUrl = getSocketCliApiBaseUrl()
- * // e.g. 'https://api.socket.dev' or undefined
- * ```
+ * @returns API base URL or undefined
  */
 export declare function getSocketCliApiBaseUrl(): string | undefined;
 /**
- * Proxy URL for Socket CLI API requests (alternative name).
- * Checks SOCKET_CLI_API_PROXY, SOCKET_SECURITY_API_PROXY, then standard proxy env vars.
- * Follows the same precedence as v1.x: HTTPS_PROXY → https_proxy → HTTP_PROXY → http_proxy.
- *
- * @returns API proxy URL or undefined
+ * Proxy URL for Socket CLI API requests (alternative name). Checks
+ * SOCKET_CLI_API_PROXY, SOCKET_SECURITY_API_PROXY, then standard proxy env
+ * vars. Follows the same precedence as v1.x: HTTPS_PROXY → https_proxy →
+ * HTTP_PROXY → http_proxy.
  *
  * @example
- * ```typescript
- * import { getSocketCliApiProxy } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliApiProxy } from '@socketsecurity/lib/env/socket-cli'
+ *
+ *   const proxy = getSocketCliApiProxy()
+ *   // e.g. 'http://proxy.example.com:8080' or undefined
+ *   ```
  *
- * const proxy = getSocketCliApiProxy()
- * // e.g. 'http://proxy.example.com:8080' or undefined
- * ```
+ * @returns API proxy URL or undefined
  */
 export declare function getSocketCliApiProxy(): string | undefined;
 /**
  * Timeout in milliseconds for Socket CLI API requests (alternative name).
  *
- * @returns API timeout in milliseconds
- *
  * @example
- * ```typescript
- * import { getSocketCliApiTimeout } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliApiTimeout } from '@socketsecurity/lib/env/socket-cli'
  *
- * const timeout = getSocketCliApiTimeout()
- * // e.g. 30000 or 0 if not set
- * ```
+ *   const timeout = getSocketCliApiTimeout()
+ *   // e.g. 30000 or 0 if not set
+ *   ```
+ *
+ * @returns API timeout in milliseconds
  */
 export declare function getSocketCliApiTimeout(): number;
 /**
- * Socket CLI API authentication token.
- * Checks SOCKET_API_TOKEN (canonical), then the legacy names
- * SOCKET_CLI_API_TOKEN, SOCKET_CLI_API_KEY, SOCKET_SECURITY_API_TOKEN,
- * SOCKET_SECURITY_API_KEY. Maintains full v1.x backward compatibility.
- *
- * @returns API token or undefined
+ * Bootstrap cache directory path. Set by bootstrap wrappers to pass dlx cache
+ * location to CLI.
  *
  * @example
- * ```typescript
- * import { getSocketCliApiToken } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliBootstrapCacheDir } from '@socketsecurity/lib/env/socket-cli'
  *
- * const token = getSocketCliApiToken()
- * // e.g. a Socket API token string or undefined
- * ```
- */
-export declare function getSocketCliApiToken(): string | undefined;
-/**
- * Bootstrap cache directory path.
- * Set by bootstrap wrappers to pass dlx cache location to CLI.
+ *   const cacheDir = getSocketCliBootstrapCacheDir()
+ *   // e.g. '/tmp/.socket-cli-cache' or undefined
+ *   ```
  *
  * @returns Bootstrap cache directory or undefined
- *
- * @example
- * ```typescript
- * import { getSocketCliBootstrapCacheDir } from '@socketsecurity/lib/env/socket-cli'
- *
- * const cacheDir = getSocketCliBootstrapCacheDir()
- * // e.g. '/tmp/.socket-cli-cache' or undefined
- * ```
  */
 export declare function getSocketCliBootstrapCacheDir(): string | undefined;
 /**
- * Bootstrap package spec (e.g., @socketsecurity/cli@^2.0.11).
- * Set by bootstrap wrappers (SEA/smol/npm) to pass package spec to CLI.
- *
- * @returns Bootstrap package spec or undefined
+ * Bootstrap package spec (e.g., @socketsecurity/cli@^2.0.11). Set by bootstrap
+ * wrappers (SEA/smol/npm) to pass package spec to CLI.
  *
  * @example
- * ```typescript
- * import { getSocketCliBootstrapSpec } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliBootstrapSpec } from '@socketsecurity/lib/env/socket-cli'
  *
- * const spec = getSocketCliBootstrapSpec()
- * // e.g. '@socketsecurity/cli@^2.0.11' or undefined
- * ```
+ *   const spec = getSocketCliBootstrapSpec()
+ *   // e.g. '@socketsecurity/cli@^2.0.11' or undefined
+ *   ```
+ *
+ * @returns Bootstrap package spec or undefined
  */
 export declare function getSocketCliBootstrapSpec(): string | undefined;
 /**
  * Socket CLI configuration file path (alternative name).
  *
- * @returns Config file path or undefined
- *
  * @example
- * ```typescript
- * import { getSocketCliConfig } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliConfig } from '@socketsecurity/lib/env/socket-cli'
+ *
+ *   const config = getSocketCliConfig()
+ *   // e.g. '/tmp/project/socket.yml' or undefined
+ *   ```
  *
- * const config = getSocketCliConfig()
- * // e.g. '/tmp/project/socket.yml' or undefined
- * ```
+ * @returns Config file path or undefined
  */
 export declare function getSocketCliConfig(): string | undefined;
 /**
  * Controls Socket CLI fix mode.
  *
- * @returns Fix mode value or undefined
- *
  * @example
- * ```typescript
- * import { getSocketCliFix } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliFix } from '@socketsecurity/lib/env/socket-cli'
+ *
+ *   const fix = getSocketCliFix()
+ *   // e.g. 'true' or undefined
+ *   ```
  *
- * const fix = getSocketCliFix()
- * // e.g. 'true' or undefined
- * ```
+ * @returns Fix mode value or undefined
  */
 export declare function getSocketCliFix(): string | undefined;
 /**
- * Socket CLI GitHub authentication token.
- * Checks SOCKET_CLI_GITHUB_TOKEN, SOCKET_SECURITY_GITHUB_PAT, then falls back to GITHUB_TOKEN.
- *
- * @returns GitHub token or undefined
+ * Socket CLI GitHub authentication token. Checks SOCKET_CLI_GITHUB_TOKEN,
+ * SOCKET_SECURITY_GITHUB_PAT, then falls back to GITHUB_TOKEN.
  *
  * @example
- * ```typescript
- * import { getSocketCliGithubToken } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliGithubToken } from '@socketsecurity/lib/env/socket-cli'
  *
- * const token = getSocketCliGithubToken()
- * // e.g. 'ghp_abc123...' or undefined
- * ```
+ *   const token = getSocketCliGithubToken()
+ *   // e.g. 'ghp_abc123...' or undefined
+ *   ```
+ *
+ * @returns GitHub token or undefined
  */
 export declare function getSocketCliGithubToken(): string | undefined;
 /**
  * Whether to skip Socket CLI API token requirement (alternative name).
  *
- * @returns Whether to skip API token requirement
- *
  * @example
- * ```typescript
- * import { getSocketCliNoApiToken } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliNoApiToken } from '@socketsecurity/lib/env/socket-cli'
+ *
+ *   if (getSocketCliNoApiToken()) {
+ *     console.log('API token requirement skipped')
+ *   }
+ *   ```
  *
- * if (getSocketCliNoApiToken()) {
- *   console.log('API token requirement skipped')
- * }
- * ```
+ * @returns Whether to skip API token requirement
  */
 export declare function getSocketCliNoApiToken(): boolean;
 /**
  * Controls Socket CLI optimization mode.
  *
- * @returns Whether optimization mode is enabled
- *
  * @example
- * ```typescript
- * import { getSocketCliOptimize } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliOptimize } from '@socketsecurity/lib/env/socket-cli'
+ *
+ *   if (getSocketCliOptimize()) {
+ *     console.log('Optimization mode enabled')
+ *   }
+ *   ```
  *
- * if (getSocketCliOptimize()) {
- *   console.log('Optimization mode enabled')
- * }
- * ```
+ * @returns Whether optimization mode is enabled
  */
 export declare function getSocketCliOptimize(): boolean;
 /**
- * Socket CLI organization slug identifier (alternative name).
- * Checks SOCKET_CLI_ORG_SLUG first, then falls back to SOCKET_ORG_SLUG.
- *
- * @returns Organization slug or undefined
+ * Socket CLI organization slug identifier (alternative name). Checks
+ * SOCKET_CLI_ORG_SLUG first, then falls back to SOCKET_ORG_SLUG.
  *
  * @example
- * ```typescript
- * import { getSocketCliOrgSlug } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliOrgSlug } from '@socketsecurity/lib/env/socket-cli'
  *
- * const slug = getSocketCliOrgSlug()
- * // e.g. 'my-org' or undefined
- * ```
+ *   const slug = getSocketCliOrgSlug()
+ *   // e.g. 'my-org' or undefined
+ *   ```
+ *
+ * @returns Organization slug or undefined
  */
 export declare function getSocketCliOrgSlug(): string | undefined;
 /**
  * Whether to view all Socket CLI risks (alternative name).
  *
- * @returns Whether to view all risks
- *
  * @example
- * ```typescript
- * import { getSocketCliViewAllRisks } from '@socketsecurity/lib/env/socket-cli'
+ *   ;```typescript
+ *   import { getSocketCliViewAllRisks } from '@socketsecurity/lib/env/socket-cli'
+ *
+ *   if (getSocketCliViewAllRisks()) {
+ *     console.log('Viewing all risks')
+ *   }
+ *   ```
  *
- * if (getSocketCliViewAllRisks()) {
- *   console.log('Viewing all risks')
- * }
- * ```
+ * @returns Whether to view all risks
  */
 export declare function getSocketCliViewAllRisks(): boolean;

package/dist/env/socket-cli.js

@@ -24,7 +24,6 @@ __export(socket_cli_exports, {
   getSocketCliApiBaseUrl: () => getSocketCliApiBaseUrl,
   getSocketCliApiProxy: () => getSocketCliApiProxy,
   getSocketCliApiTimeout: () => getSocketCliApiTimeout,
-  getSocketCliApiToken: () => getSocketCliApiToken,
   getSocketCliBootstrapCacheDir: () => getSocketCliBootstrapCacheDir,
   getSocketCliBootstrapSpec: () => getSocketCliBootstrapSpec,
   getSocketCliConfig: () => getSocketCliConfig,
@@ -36,11 +35,12 @@ __export(socket_cli_exports, {
   getSocketCliViewAllRisks: () => getSocketCliViewAllRisks
 });
 module.exports = __toCommonJS(socket_cli_exports);
-var import_helpers = require("./helpers");
+var import_boolean = require("./boolean");
+var import_number = require("./number");
 var import_rewire = require("./rewire");
 // @__NO_SIDE_EFFECTS__
 function getSocketCliAcceptRisks() {
-  return (0, import_helpers.envAsBoolean)((0, import_rewire.getEnvValue)("SOCKET_CLI_ACCEPT_RISKS"));
+  return (0, import_boolean.envAsBoolean)((0, import_rewire.getEnvValue)("SOCKET_CLI_ACCEPT_RISKS"));
 }
 // @__NO_SIDE_EFFECTS__
 function getSocketCliApiBaseUrl() {
@@ -52,11 +52,7 @@ function getSocketCliApiProxy() {
 }
 // @__NO_SIDE_EFFECTS__
 function getSocketCliApiTimeout() {
-  return (0, import_helpers.envAsNumber)((0, import_rewire.getEnvValue)("SOCKET_CLI_API_TIMEOUT"));
-}
-// @__NO_SIDE_EFFECTS__
-function getSocketCliApiToken() {
-  return (0, import_rewire.getEnvValue)("SOCKET_API_TOKEN") || (0, import_rewire.getEnvValue)("SOCKET_CLI_API_TOKEN") || (0, import_rewire.getEnvValue)("SOCKET_CLI_API_KEY") || (0, import_rewire.getEnvValue)("SOCKET_SECURITY_API_TOKEN") || (0, import_rewire.getEnvValue)("SOCKET_SECURITY_API_KEY");
+  return (0, import_number.envAsNumber)((0, import_rewire.getEnvValue)("SOCKET_CLI_API_TIMEOUT"));
 }
 // @__NO_SIDE_EFFECTS__
 function getSocketCliBootstrapCacheDir() {
@@ -80,11 +76,11 @@ function getSocketCliGithubToken() {
 }
 // @__NO_SIDE_EFFECTS__
 function getSocketCliNoApiToken() {
-  return (0, import_helpers.envAsBoolean)((0, import_rewire.getEnvValue)("SOCKET_CLI_NO_API_TOKEN"));
+  return (0, import_boolean.envAsBoolean)((0, import_rewire.getEnvValue)("SOCKET_CLI_NO_API_TOKEN"));
 }
 // @__NO_SIDE_EFFECTS__
 function getSocketCliOptimize() {
-  return (0, import_helpers.envAsBoolean)((0, import_rewire.getEnvValue)("SOCKET_CLI_OPTIMIZE"));
+  return (0, import_boolean.envAsBoolean)((0, import_rewire.getEnvValue)("SOCKET_CLI_OPTIMIZE"));
 }
 // @__NO_SIDE_EFFECTS__
 function getSocketCliOrgSlug() {
@@ -92,7 +88,7 @@ function getSocketCliOrgSlug() {
 }
 // @__NO_SIDE_EFFECTS__
 function getSocketCliViewAllRisks() {
-  return (0, import_helpers.envAsBoolean)((0, import_rewire.getEnvValue)("SOCKET_CLI_VIEW_ALL_RISKS"));
+  return (0, import_boolean.envAsBoolean)((0, import_rewire.getEnvValue)("SOCKET_CLI_VIEW_ALL_RISKS"));
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
@@ -100,7 +96,6 @@ function getSocketCliViewAllRisks() {
   getSocketCliApiBaseUrl,
   getSocketCliApiProxy,
   getSocketCliApiTimeout,
-  getSocketCliApiToken,
   getSocketCliBootstrapCacheDir,
   getSocketCliBootstrapSpec,
   getSocketCliConfig,