@visulima/package 5.0.0-alpha.3 → 5.0.0-alpha.30

package/dist/packem_shared/package-json.d-R9WIRfmM.d.ts

@@ -0,0 +1,173 @@
+import { WriteJsonOptions } from '@visulima/fs';
+import { PackageJson as PackageJson$1, Paths, JsonObject } from 'type-fest';
+import { InstallPackageOptions } from '@antfu/install-pkg';
+import { Theme } from '@inquirer/core';
+import { PartialDeep } from '@inquirer/type';
+import { Package } from 'normalize-package-data';
+type NormalizedPackageJson = Package & PackageJson;
+type PackageJson = PackageJson$1;
+type Cache<T = unknown> = Map<string, T>;
+type EnsurePackagesOptions = {
+  /** Configuration for user confirmation prompts when installing packages */
+  confirm?: {
+    /** Default value for the confirmation prompt */
+    default?: boolean;
+    /** Message to display in the confirmation prompt, or a function that receives packages array */
+    message: string | ((packages: string[]) => string);
+    /** Theme configuration for the prompt interface */
+    theme?: PartialDeep<Theme>;
+    /** Function to transform the boolean value for display */
+    transformer?: (value: boolean) => string;
+  };
+  /** Current working directory for package operations */
+  cwd?: URL | string;
+  /** Whether to include regular dependencies in the operation */
+  deps?: boolean;
+  /** Whether to include development dependencies in the operation */
+  devDeps?: boolean;
+  /** Additional options for package installation (excluding cwd and dev which are handled separately) */
+  installPackage?: Omit<InstallPackageOptions, "cwd" | "dev">;
+  /** Custom logger interface for warning messages */
+  logger?: {
+    warn: (message: string) => void;
+  };
+  /** Whether to include peer dependencies in the operation */
+  peerDeps?: boolean;
+  /** Whether to throw an error when warnings are logged instead of just logging them */
+  throwOnWarn?: boolean;
+};
+type ReadOptions = {
+  cache?: FindPackageJsonCache | boolean;
+  ignoreWarnings?: (RegExp | string)[];
+  json5?: boolean;
+  resolveCatalogs?: boolean;
+  strict?: boolean;
+  yaml?: boolean;
+};
+type FindPackageJsonCache = Cache<NormalizedReadResult>;
+type NormalizedReadResult = {
+  packageJson: NormalizedPackageJson;
+  path: string;
+};
+/**
+* An asynchronous function to find the package.json, package.yaml, or package.json5 file in the specified directory or its parent directories.
+* @param cwd The current working directory.
+* @param options Configuration options including yaml, json5, and resolveCatalogs flags.
+* @returns A `Promise` that resolves to an object containing the parsed package data and the file path.
+* The type of the returned promise is `Promise&lt;NormalizedReadResult>`.
+* @throws {Error} If no package file can be found or if strict mode is enabled and normalize warnings are thrown.
+*/
+declare const findPackageJson: (cwd?: URL | string, options?: ReadOptions) => Promise<NormalizedReadResult>;
+/**
+* A synchronous function to find the package.json, package.yaml, or package.json5 file in the specified directory or its parent directories.
+* @param cwd The current working directory.
+* @param options Configuration options including yaml, json5, and resolveCatalogs flags.
+* @returns An object containing the parsed package data and the file path.
+* @throws {Error} If no package file can be found or if strict mode is enabled and normalize warnings are thrown.
+*/
+declare const findPackageJsonSync: (cwd?: URL | string, options?: ReadOptions) => NormalizedReadResult;
+/**
+* An asynchronous function to write the package.json file with the given data.
+* @param data The package.json data to write. The data is an intersection type of `PackageJson` and a record where keys are `string` and values can be any type.
+* @param options Optional. The options for writing the package.json. If not provided, an empty object will be used `{}`.
+* This is an intersection type of `WriteJsonOptions` and a record with an optional `cwd` key which type is `Options["cwd"]`.
+* `cwd` represents the current working directory. If not specified, the default working directory will be used.
+* @returns A `Promise` that resolves once the package.json file has been written. The type of the returned promise is `Promise&lt;void>`.
+*/
+declare const writePackageJson: (data: PackageJson, options?: WriteJsonOptions & {
+  cwd?: URL | string;
+}) => Promise<void>;
+declare const writePackageJsonSync: (data: PackageJson, options?: WriteJsonOptions & {
+  cwd?: URL | string;
+}) => void;
+/**
+* A synchronous function to parse the package.json, package.yaml, or package.json5 file/object/string and return normalize the data.
+* @param packageFile
+* @param options
+* @param options.cache Cache for parsed results (only applies to file paths)
+* @param options.ignoreWarnings List of warning messages or patterns to skip in strict mode
+* @param options.resolveCatalogs Whether to resolve pnpm catalog references
+* @param options.strict Whether to throw errors on normalization warnings
+* @param options.yaml Whether to enable package.yaml parsing (default: true)
+* @param options.json5 Whether to enable package.json5 parsing (default: true)
+* @returns
+* @throws {Error} If the packageFile parameter is not an object or a string or if strict mode is enabled and normalize warnings are thrown.
+*/
+declare const parsePackageJsonSync: (packageFile: JsonObject | string, options?: {
+  cache?: Cache<NormalizedPackageJson> | boolean;
+  ignoreWarnings?: (RegExp | string)[];
+  json5?: boolean;
+  resolveCatalogs?: boolean;
+  strict?: boolean;
+  yaml?: boolean;
+}) => NormalizedPackageJson;
+/**
+* An asynchronous function to parse the package.json, package.yaml, or package.json5 file/object/string and return normalize the data.
+* @param packageFile
+* @param options
+* @param options.cache Cache for parsed results (only applies to file paths)
+* @param options.ignoreWarnings List of warning messages or patterns to skip in strict mode
+* @param options.strict Whether to throw errors on normalization warnings
+* @param options.resolveCatalogs Whether to resolve pnpm catalog references
+* @param options.yaml Whether to enable package.yaml parsing (default: true)
+* @param options.json5 Whether to enable package.json5 parsing (default: true)
+* @returns
+* @throws {Error} If the packageFile parameter is not an object or a string or if strict mode is enabled and normalize warnings are thrown.
+*/
+declare const parsePackageJson: (packageFile: JsonObject | string, options?: {
+  cache?: Cache<NormalizedPackageJson> | boolean;
+  ignoreWarnings?: (RegExp | string)[];
+  json5?: boolean;
+  resolveCatalogs?: boolean;
+  strict?: boolean;
+  yaml?: boolean;
+}) => Promise<NormalizedPackageJson>;
+/**
+* An asynchronous function to get the value of a property from the package.json file.
+* @param packageJson
+* @param property
+* @param defaultValue
+* @returns
+*/
+declare const getPackageJsonProperty: <T = unknown>(packageJson: NormalizedPackageJson, property: Paths<NormalizedPackageJson>, defaultValue?: T) => T;
+/**
+* An asynchronous function to check if a property exists in the package.json file.
+* @param packageJson
+* @param property
+* @returns
+*/
+declare const hasPackageJsonProperty: (packageJson: NormalizedPackageJson, property: Paths<NormalizedPackageJson>) => boolean;
+/**
+* An asynchronous function to check if any of the specified dependencies exist in the package.json file.
+* @param packageJson
+* @param arguments_
+* @param options
+* @param options.peerDeps Whether to include peer dependencies
+* @returns
+*/
+declare const hasPackageJsonAnyDependency: (packageJson: NormalizedPackageJson, arguments_: string[], options?: {
+  peerDeps?: boolean;
+}) => boolean;
+/**
+* An asynchronous function to ensure that the specified packages are installed in the package.json file.
+* If the packages are not installed, the user will be prompted to install them.
+* If the user agrees, the packages will be installed.
+* If the user declines, the function will return without installing the packages.
+* If the user does not respond, the function will return without installing the packages.
+* @param packageJson
+* @param packages
+* @param installKey
+* @param options
+* @param options.deps Whether to include regular dependencies
+* @param options.devDeps Whether to include development dependencies
+* @param options.peerDeps Whether to include peer dependencies
+* @param options.throwOnWarn Whether to throw an error when warnings are logged instead of just logging them
+* @param options.logger Whether to use a custom logger
+* @param options.confirm Whether to use a custom confirmation prompt
+* @param options.installPackage Whether to use a custom installation package
+* @param options.cwd Whether to use a custom current working directory
+* @param options.dev Whether to use a custom installation key
+* @returns
+*/
+declare const ensurePackages: (packageJson: NormalizedPackageJson, packages: string[], installKey?: "dependencies" | "devDependencies", options?: EnsurePackagesOptions) => Promise<void>;
+export { EnsurePackagesOptions as E, FindPackageJsonCache as F, NormalizedPackageJson as N, PackageJson as P, NormalizedReadResult as a, findPackageJsonSync as b, hasPackageJsonProperty as c, parsePackageJsonSync as d, ensurePackages as e, findPackageJson as f, getPackageJsonProperty as g, hasPackageJsonAnyDependency as h, writePackageJsonSync as i, parsePackageJson as p, writePackageJson as w };

package/dist/pnpm.d.ts

@@ -1,18 +1,19 @@
-import type { JsonObject } from "type-fest";
-export type PnpmCatalog = Record<string, string>;
-export type PnpmCatalogs = {
-    catalog?: PnpmCatalog;
-    catalogs?: Record<string, PnpmCatalog>;
+import { JsonObject } from 'type-fest';
+type PnpmCatalog = Record<string, string>;
+type PnpmCatalogs = {
+  catalog?: PnpmCatalog;
+  catalogs?: Record<string, PnpmCatalog>;
 };
 /** Checks if a package directory is included in the workspace packages configuration. */
-export declare const isPackageInWorkspace: (workspacePath: string, packagePath: string, workspacePackages: string[]) => boolean;
+declare const isPackageInWorkspace: (workspacePath: string, packagePath: string, workspacePackages: string[]) => boolean;
 /** Reads, parses, and resolves catalogs from a pnpm-workspace file found by walking up the directory tree. */
-export declare const readPnpmCatalogs: (packagePath: string) => Promise<PnpmCatalogs | undefined>;
+declare const readPnpmCatalogs: (packagePath: string) => Promise<PnpmCatalogs | undefined>;
 /** Reads, parses, and resolves catalogs from a pnpm-workspace file found by walking up the directory tree (synchronous). */
-export declare const readPnpmCatalogsSync: (packagePath: string) => PnpmCatalogs | undefined;
+declare const readPnpmCatalogsSync: (packagePath: string) => PnpmCatalogs | undefined;
 /** Resolves a single catalog reference to its actual version. */
-export declare const resolveCatalogReference: (packageName: string, versionSpec: string, catalogs: PnpmCatalogs) => string | undefined;
+declare const resolveCatalogReference: (packageName: string, versionSpec: string, catalogs: PnpmCatalogs) => string | undefined;
 /** Resolves catalog references in a single dependency object. */
-export declare const resolveDependenciesCatalogReferences: (dependencies: Record<string, string>, catalogs: PnpmCatalogs) => void;
+declare const resolveDependenciesCatalogReferences: (dependencies: Record<string, string>, catalogs: PnpmCatalogs) => void;
 /** Resolves catalog references in package.json dependencies using the provided catalogs. */
-export declare const resolveCatalogReferences: (packageJson: JsonObject, catalogs: PnpmCatalogs) => void;
+declare const resolveCatalogReferences: (packageJson: JsonObject, catalogs: PnpmCatalogs) => void;
+export { PnpmCatalog, PnpmCatalogs, isPackageInWorkspace, readPnpmCatalogs, readPnpmCatalogsSync, resolveCatalogReference, resolveCatalogReferences, resolveDependenciesCatalogReferences };

package/dist/pnpm.js

@@ -1 +1 @@
-var y=Object.defineProperty;var f=(t,a)=>y(t,"name",{value:a,configurable:!0});import{findUpSync as u,findUp as m}from"@visulima/fs";import{readYamlSync as v,readYaml as k}from"@visulima/fs/yaml";import{dirname as l,relative as b}from"@visulima/path";var h=Object.defineProperty,i=f((t,a)=>h(t,"name",{value:a,configurable:!0}),"c");const d=i((t,a,e)=>{const c=l(t),o=l(a),g=o===c?".":b(c,o);return e.some(p=>{const n=p.startsWith("./")?p.slice(2):p,s=g.startsWith("./")?g.slice(2):g;if(n==="."&&s===".")return!0;if(n.endsWith("/**")){const r=n.slice(0,-3);return s===r||s.startsWith(`${r}/`)}if(n.endsWith("/*")){const r=n.slice(0,-2);return r===""?s!=="."&&!s.includes("/"):s.startsWith(`${r}/`)||s===r}return s===n||s.startsWith(`${n}/`)})},"isPackageInWorkspace"),D=i(async t=>{const a=await m("pnpm-workspace.yaml",{cwd:l(t),type:"file"});if(!a)return;const e=await k(a),c=Array.isArray(e.packages)?e.packages:[];if(!d(a,t,c))return;const o={};return e.catalog&&typeof e.catalog=="object"&&(o.catalog=e.catalog),e.catalogs&&typeof e.catalogs=="object"&&(o.catalogs=e.catalogs),Object.keys(o).length>0?o:void 0},"readPnpmCatalogs"),A=i(t=>{const a=u("pnpm-workspace.yaml",{cwd:l(t),type:"file"});if(!a)return;const e=v(a),c=Array.isArray(e.packages)?e.packages:[];if(!d(a,t,c))return;const o={};return e.catalog&&typeof e.catalog=="object"&&(o.catalog=e.catalog),e.catalogs&&typeof e.catalogs=="object"&&(o.catalogs=e.catalogs),Object.keys(o).length>0?o:void 0},"readPnpmCatalogsSync"),C=i((t,a,e)=>{if(a==="catalog:")return e.catalog?.[t];if(a.startsWith("catalog:")){const c=a.slice(8);return e.catalogs?.[c]?.[t]}},"resolveCatalogReference"),W=i((t,a)=>{for(const[e,c]of Object.entries(t)){if(typeof c!="string")continue;const o=C(e,c,a);o&&(t[e]=o)}},"resolveDependenciesCatalogReferences"),O=i((t,a)=>{const e=["dependencies","devDependencies","peerDependencies","optionalDependencies"];for(const c of e){if(!t[c]||typeof t[c]!="object")continue;const o=t[c];W(o,a)}},"resolveCatalogReferences");export{d as isPackageInWorkspace,D as readPnpmCatalogs,A as readPnpmCatalogsSync,C as resolveCatalogReference,O as resolveCatalogReferences,W as resolveDependenciesCatalogReferences};
+var y=Object.defineProperty;var f=(t,a)=>y(t,"name",{value:a,configurable:!0});import{findUpSync as u,findUp as m}from"@visulima/fs";import{readYamlSync as v,readYaml as k}from"@visulima/fs/yaml";import{dirname as l,relative as b}from"@visulima/path";var h=Object.defineProperty,i=f((t,a)=>h(t,"name",{value:a,configurable:!0}),"c");const d=i((t,a,e)=>{const o=l(t),s=l(a),g=s===o?".":b(o,s);return e.some(p=>{const n=p.startsWith("./")?p.slice(2):p,c=g.startsWith("./")?g.slice(2):g;if(n==="."&&c===".")return!0;if(n.endsWith("/**")){const r=n.slice(0,-3);return c===r||c.startsWith(`${r}/`)}if(n.endsWith("/*")){const r=n.slice(0,-2);return r===""?c!=="."&&!c.includes("/"):c.startsWith(`${r}/`)||c===r}return c===n||c.startsWith(`${n}/`)})},"isPackageInWorkspace"),D=i(async t=>{const a=await m("pnpm-workspace.yaml",{cwd:l(t),type:"file"});if(!a)return;const e=await k(a),o=Array.isArray(e.packages)?e.packages:[];if(!d(a,t,o))return;const s={};return e.catalog&&typeof e.catalog=="object"&&(s.catalog=e.catalog),e.catalogs&&typeof e.catalogs=="object"&&(s.catalogs=e.catalogs),Object.keys(s).length>0?s:void 0},"readPnpmCatalogs"),A=i(t=>{const a=u("pnpm-workspace.yaml",{cwd:l(t),type:"file"});if(!a)return;const e=v(a),o=Array.isArray(e.packages)?e.packages:[];if(!d(a,t,o))return;const s={};return e.catalog&&typeof e.catalog=="object"&&(s.catalog=e.catalog),e.catalogs&&typeof e.catalogs=="object"&&(s.catalogs=e.catalogs),Object.keys(s).length>0?s:void 0},"readPnpmCatalogsSync"),C=i((t,a,e)=>{if(a==="catalog:")return e.catalog?.[t];if(a.startsWith("catalog:")){const o=a.slice(8);return e.catalogs?.[o]?.[t]}},"resolveCatalogReference"),W=i((t,a)=>{for(const[e,o]of Object.entries(t)){if(typeof o!="string")continue;const s=C(e,o,a);s&&(t[e]=s)}},"resolveDependenciesCatalogReferences"),O=i((t,a)=>{const e=["dependencies","devDependencies","peerDependencies","optionalDependencies"];for(const o of e){if(!t[o]||typeof t[o]!="object")continue;const s=t[o];W(s,a)}},"resolveCatalogReferences");export{d as isPackageInWorkspace,D as readPnpmCatalogs,A as readPnpmCatalogsSync,C as resolveCatalogReference,O as resolveCatalogReferences,W as resolveDependenciesCatalogReferences};

package/package.json

@@ -1,41 +1,39 @@
 {
   "name": "@visulima/package",
-  "version": "5.0.0-alpha.3",
+  "version": "5.0.0-alpha.30",
   "description": "A comprehensive package management utility that helps you find root directories, monorepos, package managers, and parse package.json, package.yaml, and package.json5 files with advanced features like catalog resolution.",
   "keywords": [
     "anolilab",
+    "bun",
     "find",
     "find-monorepo-root",
-    "find-up-pkg",
     "find-package-manager",
+    "find-up-pkg",
+    "json5",
     "mono-repo",
     "monorepo",
+    "npm",
     "package",
     "package-json",
     "package-manager",
     "package.json",
-    "package.yaml",
     "package.json5",
+    "package.yaml",
     "packages",
     "pkg-dir",
     "pkg-manager",
     "pkg-types",
     "pkg-up",
+    "pnpm",
     "read-pkg",
     "read-pkg-up",
     "root",
-    "pnpm",
-    "bun",
-    "npm",
-    "yarn",
+    "visulima",
     "yaml",
-    "json5",
-    "visulima"
+    "yarn"
   ],
-  "homepage": "https://www.visulima.com/docs/package/package",
-  "bugs": {
-    "url": "https://github.com/visulima/visulima/issues"
-  },
+  "homepage": "https://visulima.com/packages/package/",
+  "bugs": "https://github.com/visulima/visulima/issues",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/visulima/visulima.git",
@@ -79,6 +77,10 @@
       "types": "./dist/package-manager.d.ts",
       "default": "./dist/package-manager.js"
     },
+    "./lockfile": {
+      "types": "./dist/lockfile.d.ts",
+      "default": "./dist/lockfile.js"
+    },
     "./pnpm": {
       "types": "./dist/pnpm.d.ts",
       "default": "./dist/pnpm.js"
@@ -97,15 +99,14 @@
   ],
   "dependencies": {
     "@antfu/install-pkg": "^1.1.0",
-    "@visulima/fs": "5.0.0-alpha.3",
-    "@visulima/path": "3.0.0-alpha.4",
+    "@visulima/fs": "5.0.0-alpha.31",
+    "@visulima/path": "3.0.0-alpha.12",
     "json5": "^2.2.3",
-    "normalize-package-data": "^8.0.0",
-    "type-fest": "^5.3.1",
-    "yaml": "^2.8.2"
+    "normalize-package-data": "^9.0.0",
+    "yaml": "2.9.0"
   },
   "engines": {
-    "node": ">=22.13 <=25.x"
+    "node": "^22.14.0 || >=24.10.0"
   },
   "os": [
     "darwin",

package/dist/error/package-not-found-error.d.ts

@@ -1,15 +0,0 @@
-/**
- * Error thrown when a package was not found.
- */
-declare class PackageNotFoundError extends Error {
-    /**
-     * @param packageName The name of the package that was not found.
-     * @param packageManager The package manager used to install the package.
-     */
-    constructor(packageName: string[] | string, packageManager?: string);
-    get code(): string;
-    set code(_name: string);
-    get name(): string;
-    set name(_name: string);
-}
-export default PackageNotFoundError;

package/dist/packem_shared/PackageNotFoundError-BictYTIA.js

@@ -1 +0,0 @@
-var o=Object.defineProperty;var a=(t,e)=>o(t,"name",{value:e,configurable:!0});import{findPackageManagerSync as n}from"../package-manager.js";var c=Object.defineProperty,i=a((t,e)=>c(t,"name",{value:e,configurable:!0}),"t");class g extends Error{static{a(this,"u")}static{i(this,"PackageNotFoundError")}constructor(e,r){if(typeof e=="string"&&(e=[e]),e.length===0){super("Package was not found.");return}if(r===void 0)try{r=n().packageManager}catch{}r===void 0&&(r="npm"),super(`Package '${e.join(" ")}' was not found. Please install it using '${r} install ${e.join(" ")}'`)}get code(){return"PACKAGE_NOT_FOUND"}set code(e){throw new Error("Cannot overwrite code PACKAGE_NOT_FOUND")}get name(){return"PackageNotFoundError"}set name(e){throw new Error("Cannot overwrite name of PackageNotFoundError")}}export{g as default};

package/dist/types.d.ts

@@ -1,37 +0,0 @@
-import type { InstallPackageOptions } from "@antfu/install-pkg";
-import type { Theme } from "@inquirer/core";
-import type { PartialDeep } from "@inquirer/type";
-import type { Package as normalizePackage } from "normalize-package-data";
-import type { PackageJson as typeFestPackageJson } from "type-fest";
-export type NormalizedPackageJson = normalizePackage & PackageJson;
-export type PackageJson = typeFestPackageJson;
-export type Cache<T = any> = Map<string, T>;
-export type EnsurePackagesOptions = {
-    /** Configuration for user confirmation prompts when installing packages */
-    confirm?: {
-        /** Default value for the confirmation prompt */
-        default?: boolean;
-        /** Message to display in the confirmation prompt, or a function that receives packages array */
-        message: string | ((packages: string[]) => string);
-        /** Theme configuration for the prompt interface */
-        theme?: PartialDeep<Theme>;
-        /** Function to transform the boolean value for display */
-        transformer?: (value: boolean) => string;
-    };
-    /** Current working directory for package operations */
-    cwd?: URL | string;
-    /** Whether to include regular dependencies in the operation */
-    deps?: boolean;
-    /** Whether to include development dependencies in the operation */
-    devDeps?: boolean;
-    /** Additional options for package installation (excluding cwd and dev which are handled separately) */
-    installPackage?: Omit<InstallPackageOptions, "cwd" | "dev">;
-    /** Custom logger interface for warning messages */
-    logger?: {
-        warn: (message: string) => void;
-    };
-    /** Whether to include peer dependencies in the operation */
-    peerDeps?: boolean;
-    /** Whether to throw an error when warnings are logged instead of just logging them */
-    throwOnWarn?: boolean;
-};

package/dist/utils/confirm.d.ts

@@ -1,11 +0,0 @@
-import type { EnsurePackagesOptions } from "../types.d.ts";
-type ConfirmOptions = EnsurePackagesOptions["confirm"] & {
-    message: string;
-};
-/**
- * Creates a styled confirmation prompt using readline.
- * @param options Configuration options for the confirmation prompt
- * @returns A promise that resolves to true if confirmed, false otherwise
- */
-declare const confirm: (options: ConfirmOptions) => Promise<boolean>;
-export default confirm;

package/dist/utils/is-node.d.ts

@@ -1,2 +0,0 @@
-declare const isNode: boolean;
-export default isNode;