@ms-cloudpack/path-utilities 2.8.3 → 3.0.0

package/lib/resolve.d.ts

@@ -1,8 +1,12 @@
 /**
- * Resolves a package path given the parent path.
+ * Resolves a package name given the parent path. This uses the `resolve` package (which does not
+ * respect exports maps) to resolve `${packageName}/package.json`.
+ *
+ * (To resolve a path respecting exports maps, use `resolveModule` instead.)
+ *
  * @param packageName - The package name.
  * @param parentPath - The parent path.
- * @returns The resolved absolute package path.
+ * @returns The resolved absolute path to the package root, or undefined if it couldn't be resolved.
  */
 export declare function resolve(packageName: string, parentPath: string): Promise<string | undefined>;
 //# sourceMappingURL=resolve.d.ts.map

package/lib/resolve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,wBAAsB,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAgBlG"}
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,wBAAsB,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAgBlG"}

package/lib/resolve.js

@@ -1,26 +1,30 @@
 import path from 'path';
 import resolvePackage from 'resolve';
 /**
- * Resolves a package path given the parent path.
+ * Resolves a package name given the parent path. This uses the `resolve` package (which does not
+ * respect exports maps) to resolve `${packageName}/package.json`.
+ *
+ * (To resolve a path respecting exports maps, use `resolveModule` instead.)
+ *
  * @param packageName - The package name.
  * @param parentPath - The parent path.
- * @returns The resolved absolute package path.
+ * @returns The resolved absolute path to the package root, or undefined if it couldn't be resolved.
  */
 export async function resolve(packageName, parentPath) {
     const packageRootImport = path.join(packageName, 'package.json');
-    return new Promise((success) => {
+    return new Promise((promiseResolve) => {
         try {
             resolvePackage(packageRootImport, { basedir: parentPath, preserveSymlinks: false }, (err, resolvedPath) => {
                 if (err || !resolvedPath) {
-                    success(undefined);
+                    promiseResolve(undefined);
                 }
                 else {
-                    success(path.dirname(resolvedPath));
+                    promiseResolve(path.dirname(resolvedPath));
                 }
             });
         }
         catch (e) {
-            success(undefined);
+            promiseResolve(undefined);
         }
     });
 }

package/lib/resolve.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.js","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,cAAc,MAAM,SAAS,CAAC;AAErC;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,WAAmB,EAAE,UAAkB;IACnE,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IAEjE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,IAAI,CAAC;YACH,cAAc,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE;gBACxG,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;oBACzB,OAAO,CAAC,SAAS,CAAC,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;gBACtC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,SAAS,CAAC,CAAC;QACrB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import path from 'path';\nimport resolvePackage from 'resolve';\n\n/**\n * Resolves a package path given the parent path.\n * @param packageName - The package name.\n * @param parentPath - The parent path.\n * @returns The resolved absolute package path.\n */\nexport async function resolve(packageName: string, parentPath: string): Promise<string | undefined> {\n  const packageRootImport = path.join(packageName, 'package.json');\n\n  return new Promise((success) => {\n    try {\n      resolvePackage(packageRootImport, { basedir: parentPath, preserveSymlinks: false }, (err, resolvedPath) => {\n        if (err || !resolvedPath) {\n          success(undefined);\n        } else {\n          success(path.dirname(resolvedPath));\n        }\n      });\n    } catch (e) {\n      success(undefined);\n    }\n  });\n}\n"]}
+{"version":3,"file":"resolve.js","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,cAAc,MAAM,SAAS,CAAC;AAErC;;;;;;;;;GASG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,WAAmB,EAAE,UAAkB;IACnE,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IAEjE,OAAO,IAAI,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;QACpC,IAAI,CAAC;YACH,cAAc,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,EAAE,YAAY,EAAE,EAAE;gBACxG,IAAI,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;oBACzB,cAAc,CAAC,SAAS,CAAC,CAAC;gBAC5B,CAAC;qBAAM,CAAC;oBACN,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,cAAc,CAAC,SAAS,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import path from 'path';\nimport resolvePackage from 'resolve';\n\n/**\n * Resolves a package name given the parent path. This uses the `resolve` package (which does not\n * respect exports maps) to resolve `${packageName}/package.json`.\n *\n * (To resolve a path respecting exports maps, use `resolveModule` instead.)\n *\n * @param packageName - The package name.\n * @param parentPath - The parent path.\n * @returns The resolved absolute path to the package root, or undefined if it couldn't be resolved.\n */\nexport async function resolve(packageName: string, parentPath: string): Promise<string | undefined> {\n  const packageRootImport = path.join(packageName, 'package.json');\n\n  return new Promise((promiseResolve) => {\n    try {\n      resolvePackage(packageRootImport, { basedir: parentPath, preserveSymlinks: false }, (err, resolvedPath) => {\n        if (err || !resolvedPath) {\n          promiseResolve(undefined);\n        } else {\n          promiseResolve(path.dirname(resolvedPath));\n        }\n      });\n    } catch (e) {\n      promiseResolve(undefined);\n    }\n  });\n}\n"]}

package/lib/resolveModule.d.ts

@@ -1,9 +1,32 @@
+interface ResolveModuleCommonParams {
+    /** Specifier to resolve */
+    importSpecifier: string;
+    /** If true, keep symlinks instead of resolving them */
+    preserveSymlinks?: boolean;
+}
 /**
- * Resolve a module specifier to a file url (with protocol ie: file:). Throws if it can't be resolved.
- * @returns - The resolved file url as a string.
+ * Resolve a module specifier to a file URL using `import-meta-resolve` (which respects exports maps).
+ * Throws if it can't be resolved.
+ * (The parent to start resolution from can be specified as either a file path or URL.)
+ *
+ * WARNING: As of writing, this only uses Node-appropriate export conditions, and so is only
+ * intended to be used for resolving things such as config files and webpack loaders.
+ *
+ * @returns The resolved file URL.
  */
-export declare function resolveModule(params: {
-    importSpecifier: string;
+export declare function resolveModule(params: ResolveModuleCommonParams & {
+    /**
+     * Parent file path **(not URL)** to start resolving from.
+     * (Use `parentUrl` for a file URL.)
+     */
+    parentPath: string;
+}): URL;
+export declare function resolveModule(params: ResolveModuleCommonParams & {
+    /**
+     * Parent URL to start resolving from, such as `import.meta.url` of the calling file.
+     * (Use `parentPath` for a file path.)
+     */
     parentUrl: string;
-}): string;
+}): URL;
+export {};
 //# sourceMappingURL=resolveModule.d.ts.map

package/lib/resolveModule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolveModule.d.ts","sourceRoot":"","sources":["../src/resolveModule.ts"],"names":[],"mappings":"AAOA;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE;IAAE,eAAe,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAK5F"}
+{"version":3,"file":"resolveModule.d.ts","sourceRoot":"","sources":["../src/resolveModule.ts"],"names":[],"mappings":"AAQA,UAAU,yBAAyB;IACjC,2BAA2B;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,yBAAyB,GAAG;IAClC;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,GAEA,GAAG,CAAC;AACP,wBAAgB,aAAa,CAC3B,MAAM,EAAE,yBAAyB,GAAG;IAClC;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,GACA,GAAG,CAAC"}

package/lib/resolveModule.js

@@ -1,15 +1,13 @@
+import { makeUrl } from '@ms-cloudpack/path-string-parsing';
 import { moduleResolve } from 'import-meta-resolve';
 import { pathToFileURL } from 'url';
 // Conditions used for resolution if the package has an exports map.
 // More could be added later if desired ("default" is implicitly included).
 const conditions = new Set(['import', 'require', 'node']);
-/**
- * Resolve a module specifier to a file url (with protocol ie: file:). Throws if it can't be resolved.
- * @returns - The resolved file url as a string.
- */
 export function resolveModule(params) {
-    const { importSpecifier, parentUrl } = params;
-    const resolvedUrl = moduleResolve(importSpecifier, pathToFileURL(parentUrl), conditions);
-    return resolvedUrl.toString();
+    const { importSpecifier, preserveSymlinks } = params;
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- types verify one or the other is set
+    const parentUrl = params.parentPath ? pathToFileURL(params.parentPath) : makeUrl(params.parentUrl);
+    return moduleResolve(importSpecifier, parentUrl, conditions, preserveSymlinks);
 }
 //# sourceMappingURL=resolveModule.js.map

package/lib/resolveModule.js.map

@@ -1 +1 @@
-{"version":3,"file":"resolveModule.js","sourceRoot":"","sources":["../src/resolveModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,oEAAoE;AACpE,2EAA2E;AAC3E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,MAAsD;IAClF,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;IAE9C,MAAM,WAAW,GAAG,aAAa,CAAC,eAAe,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,CAAC;IACzF,OAAO,WAAW,CAAC,QAAQ,EAAE,CAAC;AAChC,CAAC","sourcesContent":["import { moduleResolve } from 'import-meta-resolve';\nimport { pathToFileURL } from 'url';\n\n// Conditions used for resolution if the package has an exports map.\n// More could be added later if desired (\"default\" is implicitly included).\nconst conditions = new Set(['import', 'require', 'node']);\n\n/**\n * Resolve a module specifier to a file url (with protocol ie: file:). Throws if it can't be resolved.\n * @returns - The resolved file url as a string.\n */\nexport function resolveModule(params: { importSpecifier: string; parentUrl: string }): string {\n  const { importSpecifier, parentUrl } = params;\n\n  const resolvedUrl = moduleResolve(importSpecifier, pathToFileURL(parentUrl), conditions);\n  return resolvedUrl.toString();\n}\n"]}
+{"version":3,"file":"resolveModule.js","sourceRoot":"","sources":["../src/resolveModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,KAAK,CAAC;AAEpC,oEAAoE;AACpE,2EAA2E;AAC3E,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;AAsC1D,MAAM,UAAU,aAAa,CAC3B,MAGC;IAED,MAAM,EAAE,eAAe,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC;IACrD,4GAA4G;IAC5G,MAAM,SAAS,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,SAAU,CAAC,CAAC;IAEpG,OAAO,aAAa,CAAC,eAAe,EAAE,SAAS,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;AACjF,CAAC","sourcesContent":["import { makeUrl } from '@ms-cloudpack/path-string-parsing';\nimport { moduleResolve } from 'import-meta-resolve';\nimport { pathToFileURL } from 'url';\n\n// Conditions used for resolution if the package has an exports map.\n// More could be added later if desired (\"default\" is implicitly included).\nconst conditions = new Set(['import', 'require', 'node']);\n\ninterface ResolveModuleCommonParams {\n  /** Specifier to resolve */\n  importSpecifier: string;\n  /** If true, keep symlinks instead of resolving them */\n  preserveSymlinks?: boolean;\n}\n\n/**\n * Resolve a module specifier to a file URL using `import-meta-resolve` (which respects exports maps).\n * Throws if it can't be resolved.\n * (The parent to start resolution from can be specified as either a file path or URL.)\n *\n * WARNING: As of writing, this only uses Node-appropriate export conditions, and so is only\n * intended to be used for resolving things such as config files and webpack loaders.\n *\n * @returns The resolved file URL.\n */\nexport function resolveModule(\n  params: ResolveModuleCommonParams & {\n    /**\n     * Parent file path **(not URL)** to start resolving from.\n     * (Use `parentUrl` for a file URL.)\n     */\n    parentPath: string;\n  },\n  // Returning a URL object makes it clear that the result is a file URL, not a path.\n): URL;\nexport function resolveModule(\n  params: ResolveModuleCommonParams & {\n    /**\n     * Parent URL to start resolving from, such as `import.meta.url` of the calling file.\n     * (Use `parentPath` for a file path.)\n     */\n    parentUrl: string;\n  },\n): URL;\nexport function resolveModule(\n  params: ResolveModuleCommonParams & {\n    parentPath?: string;\n    parentUrl?: string;\n  },\n): URL {\n  const { importSpecifier, preserveSymlinks } = params;\n  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- types verify one or the other is set\n  const parentUrl = params.parentPath ? pathToFileURL(params.parentPath) : makeUrl(params.parentUrl!);\n\n  return moduleResolve(importSpecifier, parentUrl, conditions, preserveSymlinks);\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/path-utilities",
-  "version": "2.8.3",
+  "version": "3.0.0",
   "description": "Path utilities for Cloudpack.",
   "license": "MIT",
   "type": "module",
@@ -31,7 +31,7 @@
     "workspace-tools": "^0.38.0"
   },
   "devDependencies": {
-    "@ms-cloudpack/common-types": "^0.24.2",
+    "@ms-cloudpack/common-types": "^0.24.3",
     "@ms-cloudpack/eslint-plugin-internal": "^0.0.1",
     "@ms-cloudpack/scripts": "^0.0.1",
     "@ms-cloudpack/test-utilities": "^0.5.0"