@visulima/package 5.0.0-alpha.11 → 5.0.0-alpha.13

package/dist/package-json.d.ts

@@ -1,138 +1,7 @@
-import type { WriteJsonOptions } from "@visulima/fs";
-import type { JsonObject, Paths } from "type-fest";
-import type { Cache, EnsurePackagesOptions, NormalizedPackageJson, PackageJson } from "./types.d.ts";
-type ReadOptions = {
-    cache?: FindPackageJsonCache | boolean;
-    ignoreWarnings?: (RegExp | string)[];
-    json5?: boolean;
-    resolveCatalogs?: boolean;
-    strict?: boolean;
-    yaml?: boolean;
-};
-export type FindPackageJsonCache = Cache<NormalizedReadResult>;
-export 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.
- */
-export 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.
- */
-export 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>`.
- */
-export declare const writePackageJson: (data: PackageJson, options?: WriteJsonOptions & {
-    cwd?: URL | string;
-}) => Promise<void>;
-export 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.
- */
-export 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.
- */
-export 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
- */
-export 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
- */
-export 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
- */
-export 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
- */
-export declare const ensurePackages: (packageJson: NormalizedPackageJson, packages: string[], installKey?: "dependencies" | "devDependencies", options?: EnsurePackagesOptions) => Promise<void>;
-export {};
+import '@visulima/fs';
+import 'type-fest';
+export { F as FindPackageJsonCache, a as NormalizedReadResult, e as ensurePackages, f as findPackageJson, b as findPackageJsonSync, g as getPackageJsonProperty, h as hasPackageJsonAnyDependency, c as hasPackageJsonProperty, p as parsePackageJson, d as parsePackageJsonSync, w as writePackageJson, i as writePackageJsonSync } from "./packem_shared/package-json.d-R9WIRfmM.js";
+import '@antfu/install-pkg';
+import '@inquirer/core';
+import '@inquirer/type';
+import 'normalize-package-data';