snyk-nodejs-lockfile-parser

buildDepGraphFromCliOutput: (
    rawCliOutput: string,
    lockfileContent: string,
    manifestFileContent: string
) => DepGraph;

buildDepGraphYarnLockV1Simple: (
    extractedYarnLockV1Pkgs: NormalisedPkgs,
    pkgJson: PackageJsonBase,
    options: Yarn1DepGraphBuildOptions
) => Promise<import('@snyk/dep-graph').DepGraph>;

buildDepGraphYarnLockV1SimpleCyclesPruned: (
    extractedYarnLockV1Pkgs: NormalisedPkgs,
    pkgJson: PackageJsonBase,
    options: DepGraphBuildOptions
) => Promise<import('@snyk/dep-graph').DepGraph>;

buildDepGraphYarnLockV1Workspace: (
    extractedYarnLockV1Pkgs: NormalisedPkgs,
    pkgJson: PackageJsonBase,
    workspacePkgNameToVersion: Record<string, string>,
    options: DepGraphBuildOptions
) => Promise<import('@snyk/dep-graph').DepGraph>;

buildDepGraphYarnLockV1WorkspaceCyclesPruned: (
    extractedYarnLockV1Pkgs: NormalisedPkgs,
    pkgJson: PackageJsonBase,
    workspacePkgNameToVersion: Record<string, string>,
    options: DepGraphBuildOptions
) => Promise<import('@snyk/dep-graph').DepGraph>;

buildDepGraphYarnLockV2Simple: (
    extractedYarnLockV2Pkgs: NormalisedPkgs,
    pkgJson: PackageJsonBase,
    options: YarnLockV2ProjectParseOptions,
    workspaceArgs?: YarnLockV2WorkspaceArgs
) => Promise<import('@snyk/dep-graph').DepGraph>;

buildDepTree: (
    manifestFileContents: string,
    lockFileContents: string,
    includeDev?: boolean,
    lockfileType?: LockfileType,
    strictOutOfSync?: boolean,
    defaultManifestFileName?: string
) => Promise<PkgTree>;

buildDepTreeFromFiles: (
    root: string,
    manifestFilePath: string,
    lockFilePath: string,
    includeDev?: boolean,
    strictOutOfSync?: boolean,
    honorAliases?: boolean
) => Promise<PkgTree>;

extractPkgsFromYarnLockV1: (yarnLockContent: string) => NormalisedPkgs;

extractPkgsFromYarnLockV2: (yarnLockContent: string) => NormalisedPkgs;

getLockfileVersionFromFile: (targetFile: string) => NodeLockfileVersion;

getNpmLockfileVersion: (
    lockFileContents: string
) =>
    | NodeLockfileVersion.NpmLockV1
    | NodeLockfileVersion.NpmLockV2
    | NodeLockfileVersion.NpmLockV3;

getPnpmLockfileParser: (
    pnpmLockContent: string | undefined,
    lockfileVersion?: NodeLockfileVersion,
    workspaceArgs?: PnpmWorkspaceArgs
) => PnpmLockfileParser;

getPnpmLockfileVersion: (
    lockFileContents: string
) =>
    | NodeLockfileVersion.PnpmLockV5
    | NodeLockfileVersion.PnpmLockV6
    | NodeLockfileVersion.PnpmLockV9;

getPnpmWorkspaces: (workspacesYamlFile: string) => string[];

getYarnLockfileType: (
    lockFileContents: string,
    root?: string,
    lockFilePath?: string
) => LockfileType;

getYarnLockfileVersion: (
    lockFileContents: string
) => NodeLockfileVersion.YarnLockV1 | NodeLockfileVersion.YarnLockV2;

getYarnWorkspaces: (targetFile: string) => string[] | false;

getYarnWorkspacesFromFiles: (
    root: any,
    manifestFilePath: string
) => string[] | false;

parseNpmLockV2Project: (
    pkgJsonContent: string,
    pkgLockContent: string,
    options: ProjectParseOptions
) => Promise<DepGraph>;

parsePkgJson: (pkgJsonContent: string) => PackageJsonBase;

parsePnpmProject: (
    pkgJsonContent: string,
    pnpmLockContent: string | undefined,
    options: PnpmProjectParseOptions,
    lockfileVersion?: NodeLockfileVersion
) => Promise<DepGraph>;

parsePnpmWorkspace: (
    root: string,
    workspaceDir: string,
    options: PnpmProjectParseOptions
) => Promise<ScannedNodeProject[]>;

parsePnpmWorkspaceProject: (
    pkgJsonContent: string,
    pnpmLockfileContents: string,
    options: PnpmProjectParseOptions,
    importer: string,
    lockfileVersion?: NodeLockfileVersion
) => Promise<DepGraph>;

parseYarnLockV1Project: (
    pkgJsonContent: string,
    yarnLockContent: string,
    options: YarnLockV1ProjectParseOptions
) => Promise<import('@snyk/dep-graph').DepGraph>;

parseYarnLockV1WorkspaceProject: (
    yarnLockContent: string,
    workspacePackagesPkgJsons: string[],
    options: ProjectParseOptions
) => Promise<DepGraph[]>;

parseYarnLockV2Project: (
    pkgJsonContent: string,
    yarnLockContent: string,
    options: YarnLockV2ProjectParseOptions,
    workspaceArgs?: YarnLockV2WorkspaceArgs
) => Promise<DepGraph>;

type NormalisedPkgs = Record<
    PkgIdentifier,
    {
        version: string;
        resolution?: string;
        dependencies: Record<string, string>;
        optionalDependencies: Record<string, string>;
    }
>;

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;
    };
    aliases?: Record<
        string,
        {
            aliasName: string;
            aliasTargetDepName: string;
            semver: string;
            version: string | null;
        }
    >;
};

type ProjectParseOptions = DepGraphBuildOptions &
    LockFileParseOptions & {
        pruneCycles: boolean;
    };

type NormalisedPkgs = Record<
    PkgIdentifier,
    {
        version: string;
        resolution?: string;
        dependencies: Record<string, string>;
        optionalDependencies: Record<string, string>;
    }
>;

type YarnLockV2ProjectParseOptions = {
    includeDevDeps: boolean;
    includeOptionalDeps: boolean;
    strictOutOfSync: boolean;
    pruneWithinTopLevelDeps: boolean;
    honorAliases?: boolean;
};