snyk-nodejs-lockfile-parser/dist/dep-graph-builders/types.d.ts

Generate a dep tree given a lockfile

import { DepGraph } from '@snyk/dep-graph';
export type PackageJsonBase = {
    name: string;
    version: string;
    dependencies?: Record<string, string>;
    devDependencies?: Record<string, string>;
    optionalDependencies?: Record<string, string>;
    peerDependencies?: Record<string, string>;
    resolutions?: Record<string, string>;
    overrides?: Overrides;
    pnpm?: {
        overrides?: Overrides;
    };
};
export type Overrides = string | {
    [key: string]: Overrides;
};
export type PkgIdentifier = string;
export type NormalisedPkgs = Record<PkgIdentifier, {
    version: string;
    dependencies: Record<string, string>;
    optionalDependencies: Record<string, string>;
}>;
export type DepGraphBuildOptions = {
    includeDevDeps: boolean;
    includeOptionalDeps: boolean;
    strictOutOfSync: boolean;
    includePeerDeps?: boolean;
    pruneNpmStrictOutOfSync?: boolean;
};
export type LockFileParseOptions = {
    includeOptionalDeps: boolean;
};
export type ProjectParseOptions = DepGraphBuildOptions & LockFileParseOptions & {
    pruneCycles: boolean;
};
export type YarnLockV2WorkspaceArgs = {
    isWorkspacePkg: boolean;
    isRoot: boolean;
    rootResolutions: Record<string, string>;
};
export type YarnLockV2ProjectParseOptions = {
    includeDevDeps: boolean;
    includeOptionalDeps: boolean;
    strictOutOfSync: boolean;
    pruneWithinTopLevelDeps: boolean;
};
export type PruneLevel = 'cycles' | 'withinTopLevelDeps' | 'none';
export type YarnLockV1ProjectParseOptions = {
    includeDevDeps: boolean;
    includeOptionalDeps: boolean;
    includePeerDeps: boolean;
    strictOutOfSync: boolean;
    pruneLevel: PruneLevel;
};
export type Yarn1DepGraphBuildOptions = {
    includeDevDeps: boolean;
    includeOptionalDeps: boolean;
    includePeerDeps: boolean;
    strictOutOfSync: boolean;
    pruneWithinTopLevelDeps: boolean;
};
export type PnpmWorkspaceArgs = {
    isWorkspace: boolean;
    projectsVersionMap: Record<string, PnpmProject>;
};
export type PnpmProject = {
    name: string;
    version: string;
};
export type PnpmProjectParseOptions = {
    includeDevDeps: boolean;
    includePeerDeps?: boolean;
    includeOptionalDeps: boolean;
    strictOutOfSync: boolean;
    pruneWithinTopLevelDeps: boolean;
};
type NodePkgManagers = 'npm' | 'yarn' | 'pnpm';
export type ScannedNodeProject = {
    packageManager: NodePkgManagers;
    targetFile: string;
    depGraph: DepGraph;
    plugin: {
        name: string;
        runtime: string;
    };
};
export {};