@socketsecurity/lib 4.4.0 → 5.0.0

package/dist/dlx.d.ts

@@ -1,104 +0,0 @@
-/**
- * Generate a cache directory name using npm/npx approach.
- * Uses first 16 characters of SHA-512 hash (like npm/npx).
- *
- * Rationale for SHA-512 truncated (vs full SHA-256):
- * - Matches npm/npx ecosystem behavior
- * - Shorter paths for Windows MAX_PATH compatibility (260 chars)
- * - 16 hex chars = 64 bits = acceptable collision risk for local cache
- * - Collision probability ~1 in 18 quintillion with 1000 entries
- *
- * Input strategy (aligned with npx):
- * - npx uses package spec strings (e.g., '@scope/pkg@1.0.0', 'prettier@3.0.0')
- * - Caller provides complete spec string with version for accurate cache keying
- * - For package installs: Use PURL-style spec with version
- *   Examples: 'npm:prettier@3.0.0', 'pypi:requests@2.31.0', 'gem:rails@7.0.0'
- *   Note: Socket uses shorthand format without 'pkg:' prefix
- *   (handled by @socketregistry/packageurl-js)
- * - For binary downloads: Use URL:name for uniqueness
- *
- * Reference: npm/cli v11.6.2 libnpmexec/lib/index.js#L233-L244
- * https://github.com/npm/cli/blob/v11.6.2/workspaces/libnpmexec/lib/index.js#L233-L244
- * Implementation: packages.map().sort().join('\n') → SHA-512 → slice(0,16)
- * npx hashes the package spec (name@version), not just name
- */
-export declare function generateCacheKey(spec: string): string;
-/**
- * Clear all DLX package installations.
- */
-export declare function clearDlx(): Promise<void>;
-/**
- * Clear all DLX package installations synchronously.
- */
-export declare function clearDlxSync(): void;
-/**
- * Check if the DLX directory exists.
- */
-export declare function dlxDirExists(): boolean;
-/**
- * Check if the DLX directory exists asynchronously.
- */
-export declare function dlxDirExistsAsync(): Promise<boolean>;
-/**
- * Ensure the DLX directory exists, creating it if necessary.
- */
-export declare function ensureDlxDir(): Promise<void>;
-/**
- * Ensure the DLX directory exists synchronously, creating it if necessary.
- */
-export declare function ensureDlxDirSync(): void;
-/**
- * Get the installed package directory within DLX node_modules.
- */
-export declare function getDlxInstalledPackageDir(packageName: string): string;
-/**
- * Get the DLX installation directory for a specific package.
- */
-export declare function getDlxPackageDir(packageName: string): string;
-/**
- * Get the package.json path for a DLX installed package.
- */
-export declare function getDlxPackageJsonPath(packageName: string): string;
-/**
- * Get the node_modules directory for a DLX package installation.
- */
-export declare function getDlxPackageNodeModulesDir(packageName: string): string;
-/**
- * Check if a file path is within the Socket DLX directory.
- * This is useful for determining if a binary or file is managed by Socket's DLX system.
- *
- * @param filePath - Absolute or relative path to check
- * @returns true if the path is within ~/.socket/_dlx/, false otherwise
- *
- * @example
- * ```typescript
- * isInSocketDlx('/home/user/.socket/_dlx/abc123/bin/socket') // true
- * isInSocketDlx('/usr/local/bin/socket') // false
- * isInSocketDlx(process.argv[0]) // Check if current binary is in DLX
- * ```
- */
-export declare function isInSocketDlx(filePath: string): boolean;
-/**
- * Check if a package is installed in DLX.
- */
-export declare function isDlxPackageInstalled(packageName: string): boolean;
-/**
- * Check if a package is installed in DLX asynchronously.
- */
-export declare function isDlxPackageInstalledAsync(packageName: string): Promise<boolean>;
-/**
- * List all packages installed in DLX.
- */
-export declare function listDlxPackages(): string[];
-/**
- * List all packages installed in DLX asynchronously.
- */
-export declare function listDlxPackagesAsync(): Promise<string[]>;
-/**
- * Remove a DLX package installation.
- */
-export declare function removeDlxPackage(packageName: string): Promise<void>;
-/**
- * Remove a DLX package installation synchronously.
- */
-export declare function removeDlxPackageSync(packageName: string): void;

package/dist/dlx.js

@@ -1,220 +0,0 @@
-"use strict";
-/* Socket Lib - Built with esbuild */
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var dlx_exports = {};
-__export(dlx_exports, {
-  clearDlx: () => clearDlx,
-  clearDlxSync: () => clearDlxSync,
-  dlxDirExists: () => dlxDirExists,
-  dlxDirExistsAsync: () => dlxDirExistsAsync,
-  ensureDlxDir: () => ensureDlxDir,
-  ensureDlxDirSync: () => ensureDlxDirSync,
-  generateCacheKey: () => generateCacheKey,
-  getDlxInstalledPackageDir: () => getDlxInstalledPackageDir,
-  getDlxPackageDir: () => getDlxPackageDir,
-  getDlxPackageJsonPath: () => getDlxPackageJsonPath,
-  getDlxPackageNodeModulesDir: () => getDlxPackageNodeModulesDir,
-  isDlxPackageInstalled: () => isDlxPackageInstalled,
-  isDlxPackageInstalledAsync: () => isDlxPackageInstalledAsync,
-  isInSocketDlx: () => isInSocketDlx,
-  listDlxPackages: () => listDlxPackages,
-  listDlxPackagesAsync: () => listDlxPackagesAsync,
-  removeDlxPackage: () => removeDlxPackage,
-  removeDlxPackageSync: () => removeDlxPackageSync
-});
-module.exports = __toCommonJS(dlx_exports);
-var import_crypto = require("crypto");
-var import_fs = require("./fs");
-var import_normalize = require("./paths/normalize");
-var import_socket = require("./paths/socket");
-var import_promises = require("./promises");
-let _fs;
-// @__NO_SIDE_EFFECTS__
-function getFs() {
-  if (_fs === void 0) {
-    _fs = require("node:fs");
-  }
-  return _fs;
-}
-function generateCacheKey(spec) {
-  return (0, import_crypto.createHash)("sha512").update(spec).digest("hex").substring(0, 16);
-}
-let _path;
-// @__NO_SIDE_EFFECTS__
-function getPath() {
-  if (_path === void 0) {
-    _path = require("node:path");
-  }
-  return _path;
-}
-async function clearDlx() {
-  const packages = await listDlxPackagesAsync();
-  await (0, import_promises.pEach)(packages, (pkg) => removeDlxPackage(pkg));
-}
-function clearDlxSync() {
-  const packages = listDlxPackages();
-  for (const pkg of packages) {
-    removeDlxPackageSync(pkg);
-  }
-}
-function dlxDirExists() {
-  const fs = /* @__PURE__ */ getFs();
-  return fs.existsSync((0, import_socket.getSocketDlxDir)());
-}
-async function dlxDirExistsAsync() {
-  const fs = /* @__PURE__ */ getFs();
-  try {
-    await fs.promises.access((0, import_socket.getSocketDlxDir)());
-    return true;
-  } catch {
-    return false;
-  }
-}
-async function ensureDlxDir() {
-  await (0, import_fs.safeMkdir)((0, import_socket.getSocketDlxDir)());
-}
-function ensureDlxDirSync() {
-  (0, import_fs.safeMkdirSync)((0, import_socket.getSocketDlxDir)());
-}
-function getDlxInstalledPackageDir(packageName) {
-  const path = /* @__PURE__ */ getPath();
-  return (0, import_normalize.normalizePath)(
-    path.join(getDlxPackageNodeModulesDir(packageName), packageName)
-  );
-}
-function getDlxPackageDir(packageName) {
-  const path = /* @__PURE__ */ getPath();
-  return (0, import_normalize.normalizePath)(path.join((0, import_socket.getSocketDlxDir)(), packageName));
-}
-function getDlxPackageJsonPath(packageName) {
-  const path = /* @__PURE__ */ getPath();
-  return (0, import_normalize.normalizePath)(
-    path.join(getDlxInstalledPackageDir(packageName), "package.json")
-  );
-}
-function getDlxPackageNodeModulesDir(packageName) {
-  const path = /* @__PURE__ */ getPath();
-  return (0, import_normalize.normalizePath)(path.join(getDlxPackageDir(packageName), "node_modules"));
-}
-function isInSocketDlx(filePath) {
-  if (!filePath) {
-    return false;
-  }
-  const path = /* @__PURE__ */ getPath();
-  const dlxDir = (0, import_socket.getSocketDlxDir)();
-  const absolutePath = (0, import_normalize.normalizePath)(path.resolve(filePath));
-  return absolutePath.startsWith(`${dlxDir}/`);
-}
-function isDlxPackageInstalled(packageName) {
-  const fs = /* @__PURE__ */ getFs();
-  return fs.existsSync(getDlxInstalledPackageDir(packageName));
-}
-async function isDlxPackageInstalledAsync(packageName) {
-  const fs = /* @__PURE__ */ getFs();
-  try {
-    await fs.promises.access(getDlxInstalledPackageDir(packageName));
-    return true;
-  } catch {
-    return false;
-  }
-}
-function listDlxPackages() {
-  try {
-    return (0, import_fs.readDirNamesSync)((0, import_socket.getSocketDlxDir)(), { sort: true });
-  } catch {
-    return [];
-  }
-}
-async function listDlxPackagesAsync() {
-  const fs = /* @__PURE__ */ getFs();
-  try {
-    const entries = await fs.promises.readdir((0, import_socket.getSocketDlxDir)(), {
-      withFileTypes: true
-    });
-    return entries.filter((e) => e.isDirectory()).map((e) => e.name).sort();
-  } catch {
-    return [];
-  }
-}
-async function removeDlxPackage(packageName) {
-  const packageDir = getDlxPackageDir(packageName);
-  try {
-    await (0, import_fs.safeDelete)(packageDir, { recursive: true, force: true });
-  } catch (e) {
-    throw new Error(`Failed to remove DLX package "${packageName}"`, {
-      cause: e
-    });
-  }
-}
-function removeDlxPackageSync(packageName) {
-  const fs = /* @__PURE__ */ getFs();
-  const packageDir = getDlxPackageDir(packageName);
-  try {
-    fs.rmSync(packageDir, { recursive: true, force: true });
-  } catch (e) {
-    const code = e.code;
-    if (code === "EACCES" || code === "EPERM") {
-      throw new Error(
-        `Permission denied removing DLX package "${packageName}"
-Directory: ${packageDir}
-To resolve:
-  1. Check file/directory permissions
-  2. Close any programs using files in this directory
-  3. Try running with elevated privileges if necessary
-  4. Manually remove: rm -rf "${packageDir}"`,
-        { cause: e }
-      );
-    }
-    if (code === "EROFS") {
-      throw new Error(
-        `Cannot remove DLX package "${packageName}" from read-only filesystem
-Directory: ${packageDir}
-The filesystem is mounted read-only.`,
-        { cause: e }
-      );
-    }
-    throw new Error(
-      `Failed to remove DLX package "${packageName}"
-Directory: ${packageDir}
-Check permissions and ensure no programs are using this directory.`,
-      { cause: e }
-    );
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  clearDlx,
-  clearDlxSync,
-  dlxDirExists,
-  dlxDirExistsAsync,
-  ensureDlxDir,
-  ensureDlxDirSync,
-  generateCacheKey,
-  getDlxInstalledPackageDir,
-  getDlxPackageDir,
-  getDlxPackageJsonPath,
-  getDlxPackageNodeModulesDir,
-  isDlxPackageInstalled,
-  isDlxPackageInstalledAsync,
-  isInSocketDlx,
-  listDlxPackages,
-  listDlxPackagesAsync,
-  removeDlxPackage,
-  removeDlxPackageSync
-});

package/dist/json.d.ts

@@ -1,196 +0,0 @@
-/**
- * JSON primitive types: `null`, `boolean`, `number`, or `string`.
- *
- * @example
- * ```ts
- * const primitives: JsonPrimitive[] = [null, true, 42, 'hello']
- * ```
- */
-export type JsonPrimitive = null | boolean | number | string;
-/**
- * Any valid JSON value: primitive, object, or array.
- *
- * @example
- * ```ts
- * const values: JsonValue[] = [
- *   null,
- *   true,
- *   42,
- *   'hello',
- *   { key: 'value' },
- *   [1, 2, 3]
- * ]
- * ```
- */
-export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
-/**
- * A JSON object with string keys and JSON values.
- *
- * @example
- * ```ts
- * const obj: JsonObject = {
- *   name: 'example',
- *   count: 42,
- *   active: true,
- *   nested: { key: 'value' }
- * }
- * ```
- */
-export interface JsonObject {
-    [key: string]: JsonValue;
-}
-/**
- * A JSON array containing JSON values.
- *
- * @example
- * ```ts
- * const arr: JsonArray = [1, 'two', { three: 3 }, [4, 5]]
- * ```
- */
-export interface JsonArray extends Array<JsonValue> {
-}
-/**
- * Reviver function for transforming parsed JSON values.
- * Called for each key-value pair during parsing.
- *
- * @param key - The object key or array index being parsed
- * @param value - The parsed value
- * @returns The transformed value (or original if no transform needed)
- *
- * @example
- * ```ts
- * // Convert date strings to Date objects
- * const reviver: JsonReviver = (key, value) => {
- *   if (typeof value === 'string' && /^\d{4}-\d{2}-\d{2}/.test(value)) {
- *     return new Date(value)
- *   }
- *   return value
- * }
- * ```
- */
-export type JsonReviver = (key: string, value: unknown) => unknown;
-/**
- * Options for JSON parsing operations.
- */
-export interface JsonParseOptions {
-    /**
-     * Optional filepath for improved error messages.
-     * When provided, errors will be prefixed with the filepath.
-     *
-     * @example
-     * ```ts
-     * // Error message will be: "config.json: Unexpected token } in JSON"
-     * jsonParse('invalid', { filepath: 'config.json' })
-     * ```
-     */
-    filepath?: string | undefined;
-    /**
-     * Optional reviver function to transform parsed values.
-     * Called for each key-value pair during parsing.
-     *
-     * @example
-     * ```ts
-     * // Convert ISO date strings to Date objects
-     * const options = {
-     *   reviver: (key, value) => {
-     *     if (typeof value === 'string' && /^\d{4}-\d{2}-\d{2}/.test(value)) {
-     *       return new Date(value)
-     *     }
-     *     return value
-     *   }
-     * }
-     * ```
-     */
-    reviver?: JsonReviver | undefined;
-    /**
-     * Whether to throw on parse errors.
-     * When `false`, returns `undefined` instead of throwing.
-     *
-     * @default true
-     *
-     * @example
-     * ```ts
-     * // Throws error
-     * jsonParse('invalid', { throws: true })
-     *
-     * // Returns undefined
-     * const result = jsonParse('invalid', { throws: false })
-     * ```
-     */
-    throws?: boolean | undefined;
-}
-/**
- * Check if a value is a JSON primitive type.
- * JSON primitives are: `null`, `boolean`, `number`, or `string`.
- *
- * @param value - Value to check
- * @returns `true` if value is a JSON primitive, `false` otherwise
- *
- * @example
- * ```ts
- * isJsonPrimitive(null) // => true
- * isJsonPrimitive(true) // => true
- * isJsonPrimitive(42) // => true
- * isJsonPrimitive('hello') // => true
- * isJsonPrimitive({}) // => false
- * isJsonPrimitive([]) // => false
- * isJsonPrimitive(undefined) // => false
- * ```
- */
-/*@__NO_SIDE_EFFECTS__*/
-export declare function isJsonPrimitive(value: unknown): value is JsonPrimitive;
-/**
- * Parse JSON content with automatic Buffer handling and BOM stripping.
- * Provides safer JSON parsing with helpful error messages and optional error suppression.
- *
- * Features:
- * - Automatic UTF-8 Buffer conversion
- * - BOM (Byte Order Mark) stripping for cross-platform compatibility
- * - Enhanced error messages with filepath context
- * - Optional error suppression (returns `undefined` instead of throwing)
- * - Optional reviver for transforming parsed values
- *
- * @param content - JSON string or Buffer to parse
- * @param options - Optional parsing configuration
- * @returns Parsed JSON value, or `undefined` if parsing fails and `throws` is `false`
- *
- * @throws {SyntaxError} When JSON is invalid and `throws` is `true` (default)
- *
- * @example
- * ```ts
- * // Basic usage
- * const data = jsonParse('{"name":"example"}')
- * console.log(data.name) // => 'example'
- *
- * // Parse Buffer with UTF-8 BOM
- * const buffer = Buffer.from('\uFEFF{"value":42}')
- * const data = jsonParse(buffer)
- * console.log(data.value) // => 42
- *
- * // Enhanced error messages with filepath
- * try {
- *   jsonParse('invalid', { filepath: 'config.json' })
- * } catch (err) {
- *   console.error(err.message)
- *   // => "config.json: Unexpected token i in JSON at position 0"
- * }
- *
- * // Suppress errors
- * const result = jsonParse('invalid', { throws: false })
- * console.log(result) // => undefined
- *
- * // Transform values with reviver
- * const json = '{"created":"2024-01-15T10:30:00Z"}'
- * const data = jsonParse(json, {
- *   reviver: (key, value) => {
- *     if (key === 'created' && typeof value === 'string') {
- *       return new Date(value)
- *     }
- *     return value
- *   }
- * })
- * console.log(data.created instanceof Date) // => true
- * ```
- */
-/*@__NO_SIDE_EFFECTS__*/
-export declare function jsonParse(content: string | Buffer, options?: JsonParseOptions | undefined): JsonValue | undefined;