@pnpm/lockfile.types 1.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Rico Sta. Cruz and other contributors
+Copyright (c) 2016-2024 Zoltan Kochan and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @pnpm/lockfile.types
+
+> Types for the lockfile

package/lib/index.d.ts

@@ -0,0 +1,140 @@
+import { type DependenciesMeta, type DepPath, type PatchFile, type ProjectId } from '@pnpm/types';
+export type { PatchFile, ProjectId };
+export * from './lockfileFileTypes';
+export interface LockfileSettings {
+    autoInstallPeers?: boolean;
+    excludeLinksFromLockfile?: boolean;
+    peersSuffixMaxLength?: number;
+}
+export interface Lockfile {
+    importers: Record<ProjectId, ProjectSnapshot>;
+    lockfileVersion: string;
+    time?: Record<string, string>;
+    catalogs?: CatalogSnapshots;
+    packages?: PackageSnapshots;
+    overrides?: Record<string, string>;
+    packageExtensionsChecksum?: string;
+    ignoredOptionalDependencies?: string[];
+    patchedDependencies?: Record<string, PatchFile>;
+    pnpmfileChecksum?: string;
+    settings?: LockfileSettings;
+}
+export interface LockfileV9 {
+    importers: Record<string, ProjectSnapshot>;
+    lockfileVersion: string;
+    time?: Record<string, string>;
+    snapshots?: Record<string, PackageSnapshotV7>;
+    packages?: Record<string, PackageInfo>;
+    neverBuiltDependencies?: string[];
+    onlyBuiltDependencies?: string[];
+    overrides?: Record<string, string>;
+    packageExtensionsChecksum?: string;
+    patchedDependencies?: Record<string, PatchFile>;
+    settings?: LockfileSettings;
+}
+export interface ProjectSnapshot {
+    specifiers: ResolvedDependencies;
+    dependencies?: ResolvedDependencies;
+    optionalDependencies?: ResolvedDependencies;
+    devDependencies?: ResolvedDependencies;
+    dependenciesMeta?: DependenciesMeta;
+    publishDirectory?: string;
+}
+export type ResolvedDependenciesOfImporters = Record<string, {
+    version: string;
+    specifier: string;
+}>;
+export interface PackageSnapshots {
+    [packagePath: DepPath]: PackageSnapshot;
+}
+/**
+ * tarball hosted remotely
+ */
+export interface TarballResolution {
+    type?: undefined;
+    tarball: string;
+    integrity?: string;
+    path?: string;
+}
+/**
+ * directory on a file system
+ */
+export interface DirectoryResolution {
+    type: 'directory';
+    directory: string;
+}
+/**
+ * Git repository
+ */
+export interface GitRepositoryResolution {
+    type: 'git';
+    repo: string;
+    commit: string;
+    path?: string;
+}
+export type Resolution = TarballResolution | GitRepositoryResolution | DirectoryResolution;
+export type LockfileResolution = Resolution | {
+    integrity: string;
+};
+export type PackageSnapshotV7 = Pick<PackageSnapshot, 'optional' | 'dependencies' | 'optionalDependencies' | 'transitivePeerDependencies'>;
+export type PackageInfo = Pick<PackageSnapshot, 'id' | 'patched' | 'hasBin' | 'name' | 'version' | 'resolution' | 'peerDependencies' | 'peerDependenciesMeta' | 'bundledDependencies' | 'engines' | 'cpu' | 'os' | 'libc' | 'deprecated'>;
+export interface PackageSnapshot {
+    id?: string;
+    optional?: true;
+    patched?: true;
+    hasBin?: true;
+    name?: string;
+    version?: string;
+    resolution: LockfileResolution;
+    dependencies?: ResolvedDependencies;
+    optionalDependencies?: ResolvedDependencies;
+    peerDependencies?: {
+        [name: string]: string;
+    };
+    peerDependenciesMeta?: {
+        [name: string]: {
+            optional: true;
+        };
+    };
+    transitivePeerDependencies?: string[];
+    bundledDependencies?: string[] | boolean;
+    engines?: Record<string, string> & {
+        node: string;
+    };
+    os?: string[];
+    cpu?: string[];
+    libc?: string[];
+    deprecated?: string;
+}
+export interface Dependencies {
+    [name: string]: string;
+}
+export type PackageBin = string | {
+    [name: string]: string;
+};
+/** @example
+ * {
+ *   "foo": "registry.npmjs.org/foo/1.0.1"
+ * }
+ */
+export type ResolvedDependencies = Record<string, string>;
+export interface CatalogSnapshots {
+    [catalogName: string]: {
+        [dependencyName: string]: ResolvedCatalogEntry;
+    };
+}
+export interface ResolvedCatalogEntry {
+    /**
+     * The real specifier that should be used for this dependency's catalog entry.
+     * This would be the ^1.2.3 portion of:
+     *
+     * @example
+     * catalog:
+     *   foo: ^1.2.3
+     */
+    readonly specifier: string;
+    /**
+     * The concrete version that the requested specifier resolved to. Ex: 1.2.3
+     */
+    readonly version: string;
+}

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./lockfileFileTypes"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAIA,sDAAmC"}

package/lib/lockfileFileTypes.d.ts

@@ -0,0 +1,37 @@
+import type { Lockfile, PackageSnapshot, ProjectSnapshot } from '.';
+import type { DependenciesMeta } from '@pnpm/types';
+export type LockfileFile = Omit<InlineSpecifiersLockfile, 'importers'> & Partial<InlineSpecifiersProjectSnapshot> & Partial<Pick<InlineSpecifiersLockfile, 'importers'>>;
+export type LockfileFileV9 = Omit<InlineSpecifiersLockfile, 'importers' | 'packages'> & Partial<InlineSpecifiersProjectSnapshot> & Partial<Pick<InlineSpecifiersLockfile, 'importers'>> & {
+    packages?: Record<string, Pick<PackageSnapshot, 'resolution' | 'engines' | 'cpu' | 'os' | 'hasBin' | 'name' | 'version' | 'bundledDependencies' | 'peerDependencies' | 'peerDependenciesMeta' | 'deprecated'>>;
+    snapshots?: Record<string, Pick<PackageSnapshot, 'dependencies' | 'optionalDependencies' | 'patched' | 'optional' | 'transitivePeerDependencies' | 'id'>>;
+};
+/**
+ * Similar to the current Lockfile importers format (lockfile version 5.4 at
+ * time of writing), but specifiers are moved to each ResolvedDependencies block
+ * instead of being declared on its own dictionary.
+ *
+ * This is an experiment to reduce one flavor of merge conflicts in lockfiles.
+ * For more info: https://github.com/pnpm/pnpm/issues/4725.
+ */
+export interface InlineSpecifiersLockfile extends Omit<Lockfile, 'lockfileVersion' | 'importers'> {
+    lockfileVersion: string;
+    importers?: Record<string, InlineSpecifiersProjectSnapshot>;
+}
+/**
+ * Similar to the current ProjectSnapshot interface, but omits the "specifiers"
+ * field in favor of inlining each specifier next to its version resolution in
+ * dependency blocks.
+ */
+export type InlineSpecifiersProjectSnapshot = Omit<ProjectSnapshot, 'dependencies' | 'devDependencies' | 'optionalDependencies' | 'dependenciesMeta' | 'specifiers'> & {
+    dependencies?: InlineSpecifiersResolvedDependencies;
+    devDependencies?: InlineSpecifiersResolvedDependencies;
+    optionalDependencies?: InlineSpecifiersResolvedDependencies;
+    dependenciesMeta?: DependenciesMeta;
+};
+export interface InlineSpecifiersResolvedDependencies {
+    [depName: string]: SpecifierAndResolution;
+}
+export interface SpecifierAndResolution {
+    specifier: string;
+    version: string;
+}

package/lib/lockfileFileTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=lockfileFileTypes.js.map

package/lib/lockfileFileTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lockfileFileTypes.js","sourceRoot":"","sources":["../src/lockfileFileTypes.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@pnpm/lockfile.types",
+  "version": "1.0.0",
+  "description": "Types for the pnpm-lock.yaml lockfile",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "engines": {
+    "node": ">=18.12"
+  },
+  "files": [
+    "lib",
+    "!*.map"
+  ],
+  "repository": "https://github.com/pnpm/pnpm/blob/main/lockfile/types",
+  "keywords": [
+    "pnpm9",
+    "pnpm",
+    "types",
+    "lockfile"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "homepage": "https://github.com/pnpm/pnpm/blob/main/lockfile/types#readme",
+  "funding": "https://opencollective.com/pnpm",
+  "dependencies": {
+    "@pnpm/types": "11.1.0"
+  },
+  "devDependencies": {
+    "@pnpm/lockfile.types": "1.0.0"
+  },
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\"",
+    "compile": "tsc --build && pnpm run lint --fix"
+  }
+}