@pnpm/catalogs.resolver 0.1.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/catalogs.resolver
+
+> Dereferences `catalog:` protocol specifiers into usable specifiers.

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { resolveFromCatalog, type CatalogResolution, type CatalogResolutionFound, type CatalogResolutionMisconfiguration, type CatalogResolutionUnused as CatalogResolutionNotUsed, type CatalogResolutionResult, type CatalogResolver, type WantedDependency, } from './resolveFromCatalog';
+export { type CatalogResultMatcher, matchCatalogResolveResult } from './matchCatalogResolveResult';

package/lib/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchCatalogResolveResult = exports.resolveFromCatalog = void 0;
+var resolveFromCatalog_1 = require("./resolveFromCatalog");
+Object.defineProperty(exports, "resolveFromCatalog", { enumerable: true, get: function () { return resolveFromCatalog_1.resolveFromCatalog; } });
+var matchCatalogResolveResult_1 = require("./matchCatalogResolveResult");
+Object.defineProperty(exports, "matchCatalogResolveResult", { enumerable: true, get: function () { return matchCatalogResolveResult_1.matchCatalogResolveResult; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2DAS6B;AAR3B,wHAAA,kBAAkB,OAAA;AASpB,yEAAkG;AAA9D,sIAAA,yBAAyB,OAAA"}

package/lib/matchCatalogResolveResult.d.ts

@@ -0,0 +1,7 @@
+import { type CatalogResolutionUnused, type CatalogResolutionResult, type CatalogResolutionFound, type CatalogResolutionMisconfiguration } from './resolveFromCatalog';
+export interface CatalogResultMatcher<T> {
+    readonly found: (found: CatalogResolutionFound) => T;
+    readonly misconfiguration: (misconfiguration: CatalogResolutionMisconfiguration) => T;
+    readonly unused: (unused: CatalogResolutionUnused) => T;
+}
+export declare function matchCatalogResolveResult<T>(result: CatalogResolutionResult, matcher: CatalogResultMatcher<T>): T;

package/lib/matchCatalogResolveResult.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.matchCatalogResolveResult = void 0;
+function matchCatalogResolveResult(result, matcher) {
+    switch (result.type) {
+        case 'found': return matcher.found(result);
+        case 'misconfiguration': return matcher.misconfiguration(result);
+        case 'unused': return matcher.unused(result);
+    }
+}
+exports.matchCatalogResolveResult = matchCatalogResolveResult;
+//# sourceMappingURL=matchCatalogResolveResult.js.map

package/lib/matchCatalogResolveResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"matchCatalogResolveResult.js","sourceRoot":"","sources":["../src/matchCatalogResolveResult.ts"],"names":[],"mappings":";;;AAQA,SAAgB,yBAAyB,CACvC,MAA+B,EAC/B,OAAgC;IAEhC,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QACtB,KAAK,OAAO,CAAC,CAAC,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QAC1C,KAAK,kBAAkB,CAAC,CAAC,OAAO,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAA;QAChE,KAAK,QAAQ,CAAC,CAAC,OAAO,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IAC5C,CAAC;AACH,CAAC;AATD,8DASC"}

package/lib/resolveFromCatalog.d.ts

@@ -0,0 +1,49 @@
+import { PnpmError } from '@pnpm/error';
+import { type Catalogs } from '@pnpm/catalogs.types';
+export interface WantedDependency {
+    readonly pref: string;
+    readonly alias: string;
+}
+/**
+ * Dereferences a wanted dependency using the catalog protocol and returns the
+ * configured version.
+ *
+ * Example: catalog:default -> ^1.2.3
+ */
+export type CatalogResolver = (wantedDependency: WantedDependency) => CatalogResolutionResult;
+export type CatalogResolutionResult = CatalogResolutionFound | CatalogResolutionMisconfiguration | CatalogResolutionUnused;
+export interface CatalogResolutionFound {
+    readonly type: 'found';
+    readonly resolution: CatalogResolution;
+}
+export interface CatalogResolution {
+    /**
+     * The name of the catalog the resolved specifier was defined in.
+     */
+    readonly catalogName: string;
+    /**
+     * The specifier that should be used for the wanted dependency. This is a
+     * usable version that replaces the catalog protocol with the relevant user
+     * defined specifier.
+     */
+    readonly specifier: string;
+}
+/**
+ * The user misconfigured a catalog entry. The entry could be missing or
+ * invalid.
+ */
+export interface CatalogResolutionMisconfiguration {
+    readonly type: 'misconfiguration';
+    /**
+     * Convenience error to rethrow.
+     */
+    readonly error: PnpmError;
+    readonly catalogName: string;
+}
+/**
+ * The wanted dependency does not use the catalog protocol.
+ */
+export interface CatalogResolutionUnused {
+    readonly type: 'unused';
+}
+export declare function resolveFromCatalog(catalogs: Catalogs, wantedDependency: WantedDependency): CatalogResolutionResult;

package/lib/resolveFromCatalog.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveFromCatalog = void 0;
+const error_1 = require("@pnpm/error");
+const catalogs_protocol_parser_1 = require("@pnpm/catalogs.protocol-parser");
+function resolveFromCatalog(catalogs, wantedDependency) {
+    const catalogName = (0, catalogs_protocol_parser_1.parseCatalogProtocol)(wantedDependency.pref);
+    if (catalogName == null) {
+        return { type: 'unused' };
+    }
+    const catalogLookup = catalogs[catalogName]?.[wantedDependency.alias];
+    if (catalogLookup == null) {
+        return {
+            type: 'misconfiguration',
+            catalogName,
+            error: new error_1.PnpmError('CATALOG_ENTRY_NOT_FOUND_FOR_SPEC', `No catalog entry '${wantedDependency.alias}' was found for catalog '${catalogName}'.`),
+        };
+    }
+    if ((0, catalogs_protocol_parser_1.parseCatalogProtocol)(catalogLookup) != null) {
+        return {
+            type: 'misconfiguration',
+            catalogName,
+            error: new error_1.PnpmError('CATALOG_ENTRY_INVALID_RECURSIVE_DEFINITION', `Found invalid catalog entry using the catalog protocol recursively. The entry for '${wantedDependency.alias}' in catalog '${catalogName}' is invalid.`),
+        };
+    }
+    return {
+        type: 'found',
+        resolution: {
+            catalogName,
+            specifier: catalogLookup,
+        },
+    };
+}
+exports.resolveFromCatalog = resolveFromCatalog;
+//# sourceMappingURL=resolveFromCatalog.js.map

package/lib/resolveFromCatalog.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveFromCatalog.js","sourceRoot":"","sources":["../src/resolveFromCatalog.ts"],"names":[],"mappings":";;;AAAA,uCAAuC;AACvC,6EAAqE;AA0DrE,SAAgB,kBAAkB,CAAE,QAAkB,EAAE,gBAAkC;IACxF,MAAM,WAAW,GAAG,IAAA,+CAAoB,EAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IAE/D,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;QACxB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IAC3B,CAAC;IAED,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;IACrE,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;QAC1B,OAAO;YACL,IAAI,EAAE,kBAAkB;YACxB,WAAW;YACX,KAAK,EAAE,IAAI,iBAAS,CAClB,kCAAkC,EAClC,qBAAqB,gBAAgB,CAAC,KAAK,4BAA4B,WAAW,IAAI,CAAC;SAC1F,CAAA;IACH,CAAC;IAED,IAAI,IAAA,+CAAoB,EAAC,aAAa,CAAC,IAAI,IAAI,EAAE,CAAC;QAChD,OAAO;YACL,IAAI,EAAE,kBAAkB;YACxB,WAAW;YACX,KAAK,EAAE,IAAI,iBAAS,CAClB,4CAA4C,EAC5C,sFAAsF,gBAAgB,CAAC,KAAK,iBAAiB,WAAW,eAAe,CAAC;SAC3J,CAAA;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,OAAO;QACb,UAAU,EAAE;YACV,WAAW;YACX,SAAS,EAAE,aAAa;SACzB;KACF,CAAA;AACH,CAAC;AAnCD,gDAmCC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@pnpm/catalogs.resolver",
+  "version": "0.1.0",
+  "description": "Dereferences catalog protocol specifiers into usable specifiers.",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "engines": {
+    "node": ">=18.12"
+  },
+  "files": [
+    "lib",
+    "!*.map"
+  ],
+  "repository": "https://github.com/pnpm/pnpm/blob/main/catalogs/resolver",
+  "keywords": [
+    "pnpm9",
+    "pnpm",
+    "types"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "homepage": "https://github.com/pnpm/pnpm/blob/main/catalogs/resolver#readme",
+  "funding": "https://opencollective.com/pnpm",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "dependencies": {
+    "@pnpm/catalogs.protocol-parser": "^0.1.0",
+    "@pnpm/error": "^6.0.1"
+  },
+  "devDependencies": {
+    "@pnpm/catalogs.resolver": "0.1.0",
+    "@pnpm/catalogs.types": "0.1.0"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+    "compile": "tsc --build && pnpm run lint --fix",
+    "test": "pnpm run compile && pnpm run _test",
+    "_test": "jest"
+  }
+}