@socketsecurity/lib 5.27.0 → 6.0.0

package/dist/ipc-cli.d.ts

@@ -1,28 +0,0 @@
-/**
- * @fileoverview Socket CLI child-process IPC object getter.
- * Lazily builds an `IpcObject` from `SOCKET_CLI_*` environment variables so
- * child processes can read flags and tokens forwarded by the parent Socket
- * CLI without re-parsing `process.env` each call. Complements the filesystem
- * stub IPC in `@socketsecurity/lib/ipc` (`getIpcStubPath`, `writeIpcStub`)
- * for cases where data exceeds env-var size limits.
- */
-export interface IpcObject {
-    SOCKET_CLI_FIX?: string | undefined;
-    SOCKET_CLI_OPTIMIZE?: boolean | undefined;
-    SOCKET_CLI_SHADOW_ACCEPT_RISKS?: boolean | undefined;
-    SOCKET_CLI_SHADOW_API_TOKEN?: string | undefined;
-    SOCKET_CLI_SHADOW_BIN?: string | undefined;
-    SOCKET_CLI_SHADOW_PROGRESS?: boolean | undefined;
-    SOCKET_CLI_SHADOW_SILENT?: boolean | undefined;
-}
-/**
- * Get IPC data forwarded by a parent Socket CLI via `SOCKET_CLI_*` env vars.
- * Call without arguments to receive the full frozen `IpcObject`, or pass a
- * key to read a single field. The object is lazily built and cached; keys
- * that weren't set in the environment are returned as `undefined`.
- *
- * @param key - Optional `IpcObject` field name to read
- * @returns The full `IpcObject` or the value at `key` (possibly `undefined`).
- */
-export declare function getIpc(): Promise<IpcObject>;
-export declare function getIpc<K extends keyof IpcObject>(key: K): Promise<IpcObject[K]>;

package/dist/ipc.d.ts

@@ -1,76 +0,0 @@
-/**
- * @fileoverview Secure inter-process communication utilities for Socket CLI.
- * File-based stub handoff (restricted-perm temp files with unique IDs and
- * timestamps) for transferring data between processes that exceeds the size
- * or exposure limits of environment variables.
- */
-/**
- * IPC stub file interface.
- * Represents the structure of stub files used for filesystem-based IPC.
- */
-export interface IpcStub {
-    /** The actual data payload. */
-    data: unknown;
-    /** Process ID that created the stub. */
-    pid: number;
-    /** Creation timestamp for age validation. */
-    timestamp: number;
-}
-/**
- * Get the IPC stub path for a given application.
- *
- * Generates a unique file path for IPC stub files that are used to pass
- * data between processes. The stub files are stored in a hidden directory
- * within the system's temporary folder.
- *
- * ## Path Structure:
- * - Base: System temp directory (e.g., /tmp on Unix, %TEMP% on Windows)
- * - Directory: `.socket-ipc/{appName}/`
- * - Filename: `stub-{pid}.json`
- *
- * ## Security Features:
- * - Files are isolated per application via appName parameter
- * - Process ID in filename prevents collisions between concurrent processes
- * - Temporary directory location ensures automatic cleanup on system restart
- *
- * @param appName - The application identifier (e.g., 'socket-cli', 'socket-dlx')
- * @returns Full path to the IPC stub file
- *
- * @example
- * ```typescript
- * const stubPath = getIpcStubPath('socket-cli')
- * // Returns: '/tmp/.socket-ipc/socket-cli/stub-12345.json' (Unix)
- * // Returns: 'C:\\Users\\Name\\AppData\\Local\\Temp\\.socket-ipc\\socket-cli\\stub-12345.json' (Windows)
- * ```
- */
-export declare function getIpcStubPath(appName: string): string;
-/**
- * Write IPC data to a stub file for inter-process data transfer.
- *
- * Creates a stub file containing data that needs to be passed between
- * processes. The file is written with 0o600 permissions so only the
- * invoking user can read it.
- *
- * ## File Structure:
- * ```json
- * {
- *   "pid": 12345,
- *   "timestamp": 1699564234567,
- *   "data": { ... }
- * }
- * ```
- *
- * @param appName - The application identifier
- * @param data - The data to write to the stub file
- * @returns Promise resolving to the stub file path
- *
- * @example
- * ```typescript
- * const stubPath = await writeIpcStub('socket-cli', {
- *   apiToken: 'secret-token',
- *   config: { ... }
- * })
- * // Pass stubPath to child process for reading
- * ```
- */
-export declare function writeIpcStub(appName: string, data: unknown): Promise<string>;

package/dist/ipc.js

@@ -1,130 +0,0 @@
-"use strict";
-/* Socket Lib - Built with esbuild */
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var ipc_exports = {};
-__export(ipc_exports, {
-  getIpcStubPath: () => getIpcStubPath,
-  writeIpcStub: () => writeIpcStub
-});
-module.exports = __toCommonJS(ipc_exports);
-var import_node_process = __toESM(require("node:process"));
-var import_typebox = require("./external/@sinclair/typebox");
-var import_socket = require("./paths/socket");
-var import_parse = require("./schema/parse");
-var import_primordials = require("./primordials");
-const IpcStubSchema = import_typebox.Type.Object({
-  /** Process ID that created the stub. */
-  pid: import_typebox.Type.Integer({ minimum: 1 }),
-  /** Creation timestamp for age validation. */
-  timestamp: import_typebox.Type.Number({ exclusiveMinimum: 0 }),
-  /** The actual data payload. */
-  data: import_typebox.Type.Unknown()
-});
-let _fs;
-let _path;
-async function ensureIpcDirectory(filePath) {
-  const fs = /* @__PURE__ */ getFs();
-  const path = /* @__PURE__ */ getPath();
-  const dir = path.dirname(filePath);
-  await fs.promises.mkdir(dir, { recursive: true, mode: 448 });
-  if (import_node_process.default.platform === "win32") {
-    return;
-  }
-  const stats = await fs.promises.lstat(dir);
-  if (!stats.isDirectory()) {
-    throw new import_primordials.ErrorCtor(`IPC path is not a directory: ${dir}`);
-  }
-  const getuid = import_node_process.default.getuid;
-  const ownUid = typeof getuid === "function" ? getuid.call(import_node_process.default) : -1;
-  if (ownUid !== -1 && stats.uid !== ownUid) {
-    throw new import_primordials.ErrorCtor(
-      `IPC directory ${dir} is owned by another user (uid ${stats.uid}); refusing to use it.`
-    );
-  }
-  const mode = stats.mode & 511;
-  if ((mode & 63) !== 0) {
-    await fs.promises.chmod(dir, 448);
-  }
-}
-// @__NO_SIDE_EFFECTS__
-function getFs() {
-  if (_fs === void 0) {
-    _fs = require("node:fs");
-  }
-  return _fs;
-}
-// @__NO_SIDE_EFFECTS__
-function getPath() {
-  if (_path === void 0) {
-    _path = require("node:path");
-  }
-  return _path;
-}
-function getIpcStubPath(appName) {
-  const tempDir = (0, import_socket.getOsTmpDir)();
-  const path = /* @__PURE__ */ getPath();
-  const stubDir = path.join(tempDir, ".socket-ipc", appName);
-  return path.join(stubDir, `stub-${import_node_process.default.pid}.json`);
-}
-async function writeIpcStub(appName, data) {
-  const stubPath = getIpcStubPath(appName);
-  await ensureIpcDirectory(stubPath);
-  const ipcData = {
-    data,
-    pid: import_node_process.default.pid,
-    timestamp: (0, import_primordials.DateNow)()
-  };
-  const validated = (0, import_parse.parseSchema)(IpcStubSchema, ipcData);
-  const fs = /* @__PURE__ */ getFs();
-  const flags = fs.constants.O_CREAT | fs.constants.O_WRONLY | fs.constants.O_EXCL | fs.constants.O_NOFOLLOW;
-  let handle;
-  try {
-    handle = await fs.promises.open(stubPath, flags, 384);
-  } catch (e) {
-    const err = e;
-    if (err.code === "EEXIST") {
-      await fs.promises.unlink(stubPath);
-      handle = await fs.promises.open(stubPath, flags, 384);
-    } else {
-      throw err;
-    }
-  }
-  try {
-    await handle.writeFile((0, import_primordials.JSONStringify)(validated, null, 2), "utf8");
-  } finally {
-    await handle.close();
-  }
-  return stubPath;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  getIpcStubPath,
-  writeIpcStub
-});

package/dist/links.d.ts

@@ -1,69 +0,0 @@
-/**
- * @fileoverview Themed hyperlink utilities for terminal output.
- * Provides colored hyperlinks using theme configuration.
- */
-import type { ThemeName } from './themes/themes';
-import type { Theme } from './themes/types';
-/**
- * Options for creating themed links.
- */
-export type LinkOptions = {
-    /** Theme to use (overrides global) */
-    theme?: Theme | ThemeName | undefined;
-    /** Show URL as fallback if terminal doesn't support links */
-    fallback?: boolean | undefined;
-};
-/**
- * Create a themed hyperlink for terminal output.
- * The link text is colored using the theme's link color.
- *
- * Note: Most terminals support ANSI color codes but not clickable links.
- * This function colors the text but does not create clickable hyperlinks.
- * For clickable links, use a library like 'terminal-link' separately.
- *
- * @param text - Link text to display
- * @param url - URL (included in fallback mode)
- * @param options - Link configuration options
- * @returns Colored link text
- *
- * @example
- * ```ts
- * import { link } from '@socketsecurity/lib/links'
- *
- * // Use current theme
- * console.log(link('Documentation', 'https://socket.dev'))
- *
- * // Override theme
- * console.log(link('API Docs', 'https://api.socket.dev', {
- *   theme: 'coana'
- * }))
- *
- * // Show URL as fallback
- * console.log(link('GitHub', 'https://github.com', {
- *   fallback: true
- * }))
- * // Output: "GitHub (https://github.com)"
- * ```
- */
-export declare function link(text: string, url: string, options?: LinkOptions): string;
-/**
- * Create multiple themed links from an array of link specifications.
- *
- * @param links - Array of [text, url] pairs
- * @param options - Link configuration options
- * @returns Array of colored link texts
- *
- * @example
- * ```ts
- * import { links } from '@socketsecurity/lib/links'
- *
- * const formatted = links([
- *   ['Documentation', 'https://socket.dev'],
- *   ['API Reference', 'https://api.socket.dev'],
- *   ['GitHub', 'https://github.com/SocketDev']
- * ])
- *
- * formatted.forEach(link => console.log(link))
- * ```
- */
-export declare function links(linkSpecs: Array<[text: string, url: string]>, options?: LinkOptions): string[];