@openrewrite/rewrite 8.68.0-20251202-044649 → 8.68.0-20251202-154952

package/dist/javascript/node-resolution-result.d.ts

@@ -0,0 +1,204 @@
+import { Marker, Markers } from "../markers";
+import { UUID } from "../uuid";
+export declare const NodeResolutionResultKind: "org.openrewrite.javascript.marker.NodeResolutionResult";
+export declare const DependencyKind: "org.openrewrite.javascript.marker.NodeResolutionResult$Dependency";
+export declare const ResolvedDependencyKind: "org.openrewrite.javascript.marker.NodeResolutionResult$ResolvedDependency";
+/**
+ * Parsed package.json content structure.
+ */
+export interface PackageJsonContent {
+    readonly name?: string;
+    readonly version?: string;
+    readonly description?: string;
+    readonly dependencies?: Record<string, string>;
+    readonly devDependencies?: Record<string, string>;
+    readonly peerDependencies?: Record<string, string>;
+    readonly optionalDependencies?: Record<string, string>;
+    readonly bundledDependencies?: string[];
+    readonly bundleDependencies?: string[];
+    readonly engines?: Record<string, string>;
+}
+/**
+ * Package entry in a package-lock.json packages map.
+ */
+export interface PackageLockEntry {
+    readonly version?: string;
+    readonly resolved?: string;
+    readonly integrity?: string;
+    readonly license?: string;
+    readonly dependencies?: Record<string, string>;
+    readonly devDependencies?: Record<string, string>;
+    readonly peerDependencies?: Record<string, string>;
+    readonly optionalDependencies?: Record<string, string>;
+    readonly engines?: Record<string, string> | string[];
+}
+/**
+ * Parsed package-lock.json content structure (npm lockfile v3 format).
+ */
+export interface PackageLockContent {
+    readonly name?: string;
+    readonly version?: string;
+    readonly lockfileVersion?: number;
+    readonly packages?: Record<string, PackageLockEntry>;
+}
+/**
+ * Represents the package manager used by a Node.js project.
+ */
+export declare const enum PackageManager {
+    Npm = "Npm",
+    YarnClassic = "YarnClassic",
+    YarnBerry = "YarnBerry",
+    Pnpm = "Pnpm",
+    Bun = "Bun"
+}
+/**
+ * Represents the scope/source of an npmrc configuration.
+ * Listed from lowest to highest priority.
+ */
+export declare const enum NpmrcScope {
+    Global = "Global",// $PREFIX/etc/npmrc
+    User = "User",// $HOME/.npmrc
+    Project = "Project"
+}
+export declare const NpmrcKind: "org.openrewrite.javascript.marker.NodeResolutionResult$Npmrc";
+/**
+ * Represents npm configuration from a specific scope.
+ * Multiple Npmrc objects can be collected (one per scope) to allow
+ * recipes to merge configurations or modify specific scopes.
+ */
+export interface Npmrc {
+    readonly kind: typeof NpmrcKind;
+    readonly scope: NpmrcScope;
+    readonly properties: Record<string, string>;
+}
+/**
+ * Represents a dependency request as declared in package.json.
+ * This is what a package asks for (name + version constraint).
+ *
+ * When the same name+versionConstraint appears multiple times, the same
+ * Dependency instance is reused. This enables reference deduplication
+ * during RPC serialization via asRef().
+ */
+export interface Dependency {
+    readonly kind: typeof DependencyKind;
+    readonly name: string;
+    readonly versionConstraint: string;
+    readonly resolved?: ResolvedDependency;
+}
+/**
+ * Represents a resolved dependency from package-lock.json.
+ * This is what was actually installed (name + resolved version + its own dependencies).
+ *
+ * Each ResolvedDependency's dependency arrays contain Dependency objects (requests),
+ * which can be looked up in NodeResolutionResult.resolvedDependencies to find their resolved versions.
+ */
+export interface ResolvedDependency {
+    readonly kind: typeof ResolvedDependencyKind;
+    readonly name: string;
+    readonly version: string;
+    readonly dependencies?: Dependency[];
+    readonly devDependencies?: Dependency[];
+    readonly peerDependencies?: Dependency[];
+    readonly optionalDependencies?: Dependency[];
+    readonly engines?: Record<string, string>;
+    readonly license?: string;
+}
+/**
+ * Contains metadata about a Node.js project, parsed from package.json and package-lock.json.
+ * Attached as a marker to JS.CompilationUnit to provide dependency context for recipes.
+ *
+ * Similar to MavenResolutionResult marker, this allows recipes to:
+ * - Query project dependencies
+ * - Check if specific packages are in use
+ * - Modify dependencies programmatically
+ * - Understand the project structure
+ *
+ * The model separates requests (Dependency) from resolutions (ResolvedDependency):
+ * - The dependency arrays contain Dependency objects (what was requested)
+ * - The resolvedDependencies list contains what was actually installed
+ */
+export interface NodeResolutionResult extends Marker {
+    readonly kind: typeof NodeResolutionResultKind;
+    readonly id: UUID;
+    readonly name?: string;
+    readonly version?: string;
+    readonly description?: string;
+    readonly path: string;
+    readonly workspacePackagePaths?: string[];
+    readonly dependencies: Dependency[];
+    readonly devDependencies: Dependency[];
+    readonly peerDependencies: Dependency[];
+    readonly optionalDependencies: Dependency[];
+    readonly bundledDependencies: Dependency[];
+    readonly resolvedDependencies: ResolvedDependency[];
+    readonly packageManager?: PackageManager;
+    readonly engines?: Record<string, string>;
+    readonly npmrcConfigs?: Npmrc[];
+}
+/**
+ * Creates a NodeResolutionResult marker from a package.json file.
+ * Should be called during parsing to attach to JS.CompilationUnit.
+ *
+ * All Dependency instances are wrapped with asRef() to enable
+ * reference deduplication during RPC serialization.
+ *
+ * @param path Path to the package.json file
+ * @param packageJsonContent Parsed package.json content
+ * @param packageLockContent Optional parsed package-lock.json content for resolution info
+ * @param workspacePackagePaths Optional resolved paths to workspace package.json files (only for workspace root)
+ * @param packageManager Optional package manager that was detected from lock file
+ * @param npmrcConfigs Optional npm configuration from various scopes
+ */
+export declare function createNodeResolutionResultMarker(path: string, packageJsonContent: PackageJsonContent, packageLockContent?: PackageLockContent, workspacePackagePaths?: string[], packageManager?: PackageManager, npmrcConfigs?: Npmrc[]): NodeResolutionResult;
+/**
+ * Helper function to find a NodeResolutionResult marker on a compilation unit.
+ */
+export declare function findNodeResolutionResult(cu: {
+    markers: Markers;
+}): NodeResolutionResult | undefined;
+/**
+ * Reads .npmrc configurations from all scope levels.
+ * Returns an array of Npmrc objects, one for each scope that has configuration.
+ *
+ * Scopes (from lowest to highest priority):
+ * - Global: $PREFIX/etc/npmrc (npm's installation directory)
+ * - User: $HOME/.npmrc (user's home directory)
+ * - Project: .npmrc in project root (sibling of package.json)
+ * - Env: npm_config_* environment variables
+ *
+ * @param projectDir The project directory containing package.json
+ * @returns Promise resolving to array of Npmrc objects for each scope with configuration
+ */
+export declare function readNpmrcConfigs(projectDir: string): Promise<Npmrc[]>;
+/**
+ * Helper functions for querying dependencies
+ */
+export declare namespace NodeResolutionResultQueries {
+    /**
+     * Get all dependency requests from all scopes.
+     */
+    function getAllDependencies(project: NodeResolutionResult): Dependency[];
+    /**
+     * Check if project has a specific dependency request, optionally filtered by scope.
+     */
+    function hasDependency(project: NodeResolutionResult, packageName: string, scope?: 'dependencies' | 'devDependencies' | 'peerDependencies' | 'optionalDependencies' | 'bundledDependencies'): boolean;
+    /**
+     * Find a specific dependency request by name across all scopes.
+     */
+    function findDependency(project: NodeResolutionResult, packageName: string): Dependency | undefined;
+    /**
+     * Get all dependency requests matching a predicate.
+     */
+    function findDependencies(project: NodeResolutionResult, predicate: (dep: Dependency) => boolean): Dependency[];
+    /**
+     * Get all resolved dependencies with a specific name (handles multiple versions).
+     * Returns an empty array if no versions are found.
+     *
+     * For navigation, prefer using the Dependency.resolved property:
+     * @example
+     * const express = project.dependencies.find(d => d.name === 'express')?.resolved;
+     * const accepts = express?.dependencies?.find(d => d.name === 'accepts')?.resolved;
+     */
+    function getAllResolvedVersions(project: NodeResolutionResult, packageName: string): ResolvedDependency[];
+}
+//# sourceMappingURL=node-resolution-result.d.ts.map

package/dist/javascript/node-resolution-result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"node-resolution-result.d.ts","sourceRoot":"","sources":["../../src/javascript/node-resolution-result.ts"],"names":[],"mappings":"AAeA,OAAO,EAAa,MAAM,EAAE,OAAO,EAAC,MAAM,YAAY,CAAC;AACvD,OAAO,EAAW,IAAI,EAAC,MAAM,SAAS,CAAC;AASvC,eAAO,MAAM,wBAAwB,EAAG,wDAAiE,CAAC;AAC1G,eAAO,MAAM,cAAc,EAAG,mEAA4E,CAAC;AAC3G,eAAO,MAAM,sBAAsB,EAAG,2EAAoF,CAAC;AAE3H;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/C,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnD,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IACxC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/C,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnD,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,MAAM,EAAE,CAAC;CACxD;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;CACxD;AAED;;GAEG;AACH,0BAAkB,cAAc;IAC5B,GAAG,QAAQ;IACX,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,IAAI,SAAS;IACb,GAAG,QAAQ;CACd;AAED;;;GAGG;AACH,0BAAkB,UAAU;IACxB,MAAM,WAAW,CAAQ,oBAAoB;IAC7C,IAAI,SAAS,CAAY,eAAe;IACxC,OAAO,YAAY;CACtB;AAED,eAAO,MAAM,SAAS,EAAG,8DAAuE,CAAC;AAEjG;;;;GAIG;AACH,MAAM,WAAW,KAAK;IAClB,QAAQ,CAAC,IAAI,EAAE,OAAO,SAAS,CAAC;IAChC,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;IAC3B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACvB,QAAQ,CAAC,IAAI,EAAE,OAAO,cAAc,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;CAC1C;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAC/B,QAAQ,CAAC,IAAI,EAAE,OAAO,sBAAsB,CAAC;IAC7C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAGzB,QAAQ,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,CAAC;IACrC,QAAQ,CAAC,eAAe,CAAC,EAAE,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,UAAU,EAAE,CAAC;IACzC,QAAQ,CAAC,oBAAoB,CAAC,EAAE,UAAU,EAAE,CAAC;IAG7C,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAG1C,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,oBAAqB,SAAQ,MAAM;IAChD,QAAQ,CAAC,IAAI,EAAE,OAAO,wBAAwB,CAAC;IAC/C,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC;IAGlB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAGtB,QAAQ,CAAC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAG1C,QAAQ,CAAC,YAAY,EAAE,UAAU,EAAE,CAAC;IACpC,QAAQ,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC;IACvC,QAAQ,CAAC,gBAAgB,EAAE,UAAU,EAAE,CAAC;IACxC,QAAQ,CAAC,oBAAoB,EAAE,UAAU,EAAE,CAAC;IAC5C,QAAQ,CAAC,mBAAmB,EAAE,UAAU,EAAE,CAAC;IAI3C,QAAQ,CAAC,oBAAoB,EAAE,kBAAkB,EAAE,CAAC;IAGpD,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAC;IAGzC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAG1C,QAAQ,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC;CACnC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gCAAgC,CAC5C,IAAI,EAAE,MAAM,EACZ,kBAAkB,EAAE,kBAAkB,EACtC,kBAAkB,CAAC,EAAE,kBAAkB,EACvC,qBAAqB,CAAC,EAAE,MAAM,EAAE,EAChC,cAAc,CAAC,EAAE,cAAc,EAC/B,YAAY,CAAC,EAAE,KAAK,EAAE,GACvB,oBAAoB,CAsVtB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,EAAE,EAAE;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,GAAG,oBAAoB,GAAG,SAAS,CAEnG;AAiDD;;;;;;;;;;;;GAYG;AACH,wBAAsB,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAgF3E;AAED;;GAEG;AACH,yBAAiB,2BAA2B,CAAC;IAEzC;;OAEG;IACH,SAAgB,kBAAkB,CAAC,OAAO,EAAE,oBAAoB,GAAG,UAAU,EAAE,CAQ9E;IAED;;OAEG;IACH,SAAgB,aAAa,CACzB,OAAO,EAAE,oBAAoB,EAC7B,WAAW,EAAE,MAAM,EACnB,KAAK,CAAC,EAAE,cAAc,GAAG,iBAAiB,GAAG,kBAAkB,GAAG,sBAAsB,GAAG,qBAAqB,GACjH,OAAO,CAKT;IAED;;OAEG;IACH,SAAgB,cAAc,CAC1B,OAAO,EAAE,oBAAoB,EAC7B,WAAW,EAAE,MAAM,GACpB,UAAU,GAAG,SAAS,CAExB;IAED;;OAEG;IACH,SAAgB,gBAAgB,CAC5B,OAAO,EAAE,oBAAoB,EAC7B,SAAS,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,GACxC,UAAU,EAAE,CAEd;IAED;;;;;;;;OAQG;IACH,SAAgB,sBAAsB,CAClC,OAAO,EAAE,oBAAoB,EAC7B,WAAW,EAAE,MAAM,GACpB,kBAAkB,EAAE,CAEtB;CACJ"}