@socketsecurity/lib 5.14.0 → 5.16.0

package/dist/versions.d.ts

@@ -1,66 +1,160 @@
 /**
  * Coerce a version string to valid semver format.
+ *
+ * @example
+ * ```typescript
+ * coerceVersion('1.2')   // '1.2.0'
+ * coerceVersion('v3')    // '3.0.0'
+ * coerceVersion('abc')   // undefined
+ * ```
  */
 export declare function coerceVersion(version: string): string | undefined;
 /**
  * Compare two semantic version strings.
  * @returns -1 if v1 < v2, 0 if v1 === v2, 1 if v1 > v2, or undefined if invalid.
+ *
+ * @example
+ * ```typescript
+ * compareVersions('1.0.0', '2.0.0') // -1
+ * compareVersions('1.0.0', '1.0.0') // 0
+ * compareVersions('2.0.0', '1.0.0') // 1
+ * ```
  */
 export declare function compareVersions(v1: string, v2: string): -1 | 0 | 1 | undefined;
 /**
  * Get all versions from an array that satisfy a semver range.
+ *
+ * @example
+ * ```typescript
+ * filterVersions(['1.0.0', '1.5.0', '2.0.0'], '>=1.0.0 <2.0.0')
+ * // ['1.0.0', '1.5.0']
+ * ```
  */
 export declare function filterVersions(versions: string[], range: string): string[];
 /**
  * Get the major version number from a version string.
+ *
+ * @example
+ * ```typescript
+ * getMajorVersion('3.2.1') // 3
+ * ```
  */
 export declare function getMajorVersion(version: string): number | undefined;
 /**
  * Get the minor version number from a version string.
+ *
+ * @example
+ * ```typescript
+ * getMinorVersion('3.2.1') // 2
+ * ```
  */
 export declare function getMinorVersion(version: string): number | undefined;
 /**
  * Get the patch version number from a version string.
+ *
+ * @example
+ * ```typescript
+ * getPatchVersion('3.2.1') // 1
+ * ```
  */
 export declare function getPatchVersion(version: string): number | undefined;
 /**
  * Increment a version by the specified release type.
+ *
+ * @example
+ * ```typescript
+ * incrementVersion('1.2.3', 'patch') // '1.2.4'
+ * incrementVersion('1.2.3', 'minor') // '1.3.0'
+ * incrementVersion('1.2.3', 'major') // '2.0.0'
+ * ```
  */
 export declare function incrementVersion(version: string, release: 'major' | 'minor' | 'patch' | 'premajor' | 'preminor' | 'prepatch' | 'prerelease', identifier?: string | undefined): string | undefined;
 /**
  * Check if version1 equals version2.
+ *
+ * @example
+ * ```typescript
+ * isEqual('1.0.0', '1.0.0') // true
+ * isEqual('1.0.0', '2.0.0') // false
+ * ```
  */
 export declare function isEqual(version1: string, version2: string): boolean;
 /**
  * Check if version1 is greater than version2.
+ *
+ * @example
+ * ```typescript
+ * isGreaterThan('2.0.0', '1.0.0') // true
+ * isGreaterThan('1.0.0', '2.0.0') // false
+ * ```
  */
 export declare function isGreaterThan(version1: string, version2: string): boolean;
 /**
  * Check if version1 is greater than or equal to version2.
+ *
+ * @example
+ * ```typescript
+ * isGreaterThanOrEqual('2.0.0', '1.0.0') // true
+ * isGreaterThanOrEqual('1.0.0', '1.0.0') // true
+ * ```
  */
 export declare function isGreaterThanOrEqual(version1: string, version2: string): boolean;
 /**
  * Check if version1 is less than version2.
+ *
+ * @example
+ * ```typescript
+ * isLessThan('1.0.0', '2.0.0') // true
+ * isLessThan('2.0.0', '1.0.0') // false
+ * ```
  */
 export declare function isLessThan(version1: string, version2: string): boolean;
 /**
  * Check if version1 is less than or equal to version2.
+ *
+ * @example
+ * ```typescript
+ * isLessThanOrEqual('1.0.0', '2.0.0') // true
+ * isLessThanOrEqual('1.0.0', '1.0.0') // true
+ * ```
  */
 export declare function isLessThanOrEqual(version1: string, version2: string): boolean;
 /**
  * Validate if a string is a valid semantic version.
+ *
+ * @example
+ * ```typescript
+ * isValidVersion('1.2.3') // true
+ * isValidVersion('abc')   // false
+ * ```
  */
 export declare function isValidVersion(version: string): boolean;
 /**
  * Get the highest version from an array of versions.
+ *
+ * @example
+ * ```typescript
+ * maxVersion(['1.0.0', '2.0.0', '1.5.0']) // '2.0.0'
+ * ```
  */
 export declare function maxVersion(versions: string[]): string | undefined;
 /**
  * Get the lowest version from an array of versions.
+ *
+ * @example
+ * ```typescript
+ * minVersion(['1.0.0', '2.0.0', '1.5.0']) // '1.0.0'
+ * ```
  */
 export declare function minVersion(versions: string[]): string | undefined;
 /**
  * Parse a version string and return major, minor, patch components.
+ *
+ * @example
+ * ```typescript
+ * parseVersion('1.2.3')
+ * // { major: 1, minor: 2, patch: 3, prerelease: [], build: [] }
+ * ```
  */
 export declare function parseVersion(version: string): {
     major: number;
@@ -71,17 +165,42 @@ export declare function parseVersion(version: string): {
 } | undefined;
 /**
  * Check if a version satisfies a semver range.
+ *
+ * @example
+ * ```typescript
+ * satisfiesVersion('1.5.0', '>=1.0.0 <2.0.0') // true
+ * satisfiesVersion('3.0.0', '>=1.0.0 <2.0.0') // false
+ * ```
  */
 export declare function satisfiesVersion(version: string, range: string): boolean;
 /**
  * Sort versions in ascending order.
+ *
+ * @example
+ * ```typescript
+ * sortVersions(['2.0.0', '1.0.0', '1.5.0'])
+ * // ['1.0.0', '1.5.0', '2.0.0']
+ * ```
  */
 export declare function sortVersions(versions: string[]): string[];
 /**
  * Sort versions in descending order.
+ *
+ * @example
+ * ```typescript
+ * sortVersionsDesc(['1.0.0', '2.0.0', '1.5.0'])
+ * // ['2.0.0', '1.5.0', '1.0.0']
+ * ```
  */
 export declare function sortVersionsDesc(versions: string[]): string[];
 /**
  * Get the difference between two versions.
+ *
+ * @example
+ * ```typescript
+ * versionDiff('1.0.0', '2.0.0') // 'major'
+ * versionDiff('1.0.0', '1.1.0') // 'minor'
+ * versionDiff('1.0.0', '1.0.1') // 'patch'
+ * ```
  */
 export declare function versionDiff(version1: string, version2: string): 'major' | 'premajor' | 'minor' | 'preminor' | 'patch' | 'prepatch' | 'prerelease' | 'release' | undefined;

package/dist/words.d.ts

@@ -4,11 +4,24 @@
  */
 /**
  * Capitalize the first letter of a word.
+ *
+ * @example
+ * ```typescript
+ * capitalize('hello')  // 'Hello'
+ * capitalize('WORLD')  // 'World'
+ * capitalize('')       // ''
+ * ```
  */
 /*@__NO_SIDE_EFFECTS__*/
 export declare function capitalize(word: string): string;
 /**
  * Determine the appropriate article (a/an) for a word.
+ *
+ * @example
+ * ```typescript
+ * determineArticle('apple')   // 'an'
+ * determineArticle('banana')  // 'a'
+ * ```
  */
 /*@__NO_SIDE_EFFECTS__*/
 export declare function determineArticle(word: string): string;
@@ -17,6 +30,13 @@ export interface PluralizeOptions {
 }
 /**
  * Pluralize a word based on count.
+ *
+ * @example
+ * ```typescript
+ * pluralize('file')               // 'file'
+ * pluralize('file', { count: 3 }) // 'files'
+ * pluralize('file', { count: 0 }) // 'files'
+ * ```
  */
 /*@__NO_SIDE_EFFECTS__*/
 export declare function pluralize(word: string, options?: PluralizeOptions | undefined): string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@socketsecurity/lib",
-  "version": "5.14.0",
-  "packageManager": "pnpm@10.33.0",
+  "version": "5.16.0",
+  "packageManager": "pnpm@11.0.0-rc.0",
   "license": "MIT",
   "description": "Core utilities and infrastructure for Socket.dev security tools",
   "keywords": [
@@ -696,7 +696,7 @@
   ],
   "engines": {
     "node": ">=22",
-    "pnpm": ">=10.25.0"
+    "pnpm": ">=11.0.0-rc.0"
   },
   "sideEffects": false,
   "scripts": {
@@ -705,23 +705,25 @@
     "clean": "node scripts/build/clean.mjs",
     "cover": "node scripts/test/cover.mjs",
     "dev": "node scripts/build/main.mjs --watch",
-    "fix": "node scripts/lint.mjs --fix",
+    "fix": "node scripts/fix.mjs",
     "format": "oxfmt",
     "format:check": "oxfmt --check",
     "lint": "node scripts/lint.mjs",
     "lint:oxlint": "oxlint .",
     "lint:oxfmt": "oxfmt --check .",
+    "security": "agentshield scan && { command -v zizmor >/dev/null && zizmor .github/ || echo 'zizmor not installed — run pnpm run setup to install'; }",
     "prepare": "husky",
     "prepublishOnly": "pnpm run build",
     "test": "node scripts/test/main.mjs",
     "update": "node scripts/update.mjs"
   },
   "devDependencies": {
-    "@anthropic-ai/claude-code": "2.1.89",
+    "@anthropic-ai/claude-code": "2.1.92",
     "@babel/core": "7.28.4",
     "@babel/parser": "7.28.4",
     "@babel/traverse": "7.28.4",
     "@babel/types": "7.28.4",
+    "ecc-agentshield": "1.4.0",
     "@dotenvx/dotenvx": "1.49.0",
     "@inquirer/checkbox": "4.3.1",
     "@inquirer/confirm": "5.1.16",
@@ -735,7 +737,7 @@
     "@socketregistry/is-unicode-supported": "1.0.5",
     "@socketregistry/packageurl-js": "1.4.1",
     "@socketregistry/yocto-spinner": "1.0.25",
-    "@socketsecurity/lib-stable": "npm:@socketsecurity/lib@5.13.0",
+    "@socketsecurity/lib-stable": "npm:@socketsecurity/lib@5.15.0",
     "@types/node": "24.9.2",
     "@typescript/native-preview": "7.0.0-dev.20250920.1",
     "@vitest/coverage-v8": "4.0.3",
@@ -796,57 +798,5 @@
     "typescript": {
       "optional": true
     }
-  },
-  "pnpm": {
-    "overrides": {
-      "@inquirer/ansi": "1.0.2",
-      "@inquirer/core": "10.3.1",
-      "@inquirer/figures": "1.0.15",
-      "@npmcli/arborist": "9.1.6",
-      "@npmcli/git": "6.0.3",
-      "@npmcli/run-script": "10.0.0",
-      "@sigstore/core": "3.1.0",
-      "@sigstore/sign": "4.1.0",
-      "ansi-regex": "6.2.2",
-      "brace-expansion": "5.0.5",
-      "chownr": "3.0.0",
-      "debug": "4.4.3",
-      "execa": "5.1.1",
-      "has-flag": "5.0.1",
-      "hosted-git-info": "8.1.0",
-      "isexe": "3.1.1",
-      "lru-cache": "11.2.2",
-      "minimatch": "9.0.6",
-      "minipass": "7.1.3",
-      "minipass-fetch": "4.0.1",
-      "minipass-sized": "1.0.3",
-      "minipass@7": "7.1.3",
-      "minizlib": "3.1.0",
-      "npm-package-arg": "12.0.2",
-      "npm-pick-manifest": "10.0.0",
-      "p-map": "7.0.4",
-      "picomatch": "4.0.4",
-      "proc-log": "6.1.0",
-      "semver": "7.7.2",
-      "signal-exit": "4.1.0",
-      "spdx-expression-parse": "4.0.0",
-      "ssri": "12.0.0",
-      "string-width": "8.1.0",
-      "strip-ansi": "7.1.2",
-      "supports-color": "10.2.2",
-      "tar": "7.5.11",
-      "which": "5.0.0",
-      "wrap-ansi": "9.0.2",
-      "yoctocolors-cjs": "2.1.3"
-    },
-    "patchedDependencies": {
-      "@npmcli/run-script@10.0.0": "patches/@npmcli__run-script@10.0.0.patch",
-      "@sigstore/sign@4.1.0": "patches/@sigstore__sign@4.1.0.patch",
-      "execa@5.1.1": "patches/execa@5.1.1.patch",
-      "minipass-flush@1.0.5": "patches/minipass-flush@1.0.5.patch",
-      "minipass-pipeline@1.2.4": "patches/minipass-pipeline@1.2.4.patch",
-      "node-gyp@11.5.0": "patches/node-gyp@11.5.0.patch",
-      "minipass-sized@1.0.3": "patches/minipass-sized@1.0.3.patch"
-    }
   }
 }