@ms-cloudpack/path-string-parsing 1.2.0 → 1.2.1

package/lib/normalizeRelativePath.d.ts

@@ -1,7 +1,10 @@
 /**
  * Normalize a path:
- * - If it's empty, undefined, or `'.'`, return `'.'`.
+ * - If it's empty, undefined, or `.`, return `.`.
  * - If it's relative, normalize slashes and ensure it starts with `./`.
+ * - If it starts with `/`, add a leading `.` (this is an absolute path but is sometimes treated
+ *   as package-relative)
+ * - If it's an absolute Windows path (starts with a drive letter), throw an error.
  * - If it's absolute, throw an error (since this likely indicates a bug in the calling code).
  *
  * Note that this will NOT remove a trailing slash (if present).

package/lib/normalizeRelativePath.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalizeRelativePath.d.ts","sourceRoot":"","sources":["../src/normalizeRelativePath.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAgB9E"}
+{"version":3,"file":"normalizeRelativePath.d.ts","sourceRoot":"","sources":["../src/normalizeRelativePath.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CA6B9E"}

package/lib/normalizeRelativePath.js

@@ -1,8 +1,11 @@
 import { slash } from './slash.js';
 /**
  * Normalize a path:
- * - If it's empty, undefined, or `'.'`, return `'.'`.
+ * - If it's empty, undefined, or `.`, return `.`.
  * - If it's relative, normalize slashes and ensure it starts with `./`.
+ * - If it starts with `/`, add a leading `.` (this is an absolute path but is sometimes treated
+ *   as package-relative)
+ * - If it's an absolute Windows path (starts with a drive letter), throw an error.
  * - If it's absolute, throw an error (since this likely indicates a bug in the calling code).
  *
  * Note that this will NOT remove a trailing slash (if present).
@@ -11,14 +14,24 @@ export function normalizeRelativePath(originalPath) {
     if (!originalPath || originalPath === '.') {
         return '.';
     }
-    // Throw if the path is absolute.
-    // NOTE: Don't use the `path` module because this function is used by `parseImportString`, which
-    // is used in the browser by the overlay.
-    if (originalPath[0] === '/' || /^[a-zA-Z]:[\\/]/.test(originalPath)) {
-        throw new Error(`Expected a relative path, but received an absolute path: ${originalPath}`);
+    // Throw on an absolute Windows path: this is definitely absolute regardless of the context it
+    // came from, and if the calling code attempts to join it to another path as if it was relative,
+    // that will have bad results. It's more likely on Windows that we could unintentionally end up
+    // with an absolute path since there's no way to do relative paths across drive letters
+    // (path.relative() will return an absolute path), so we throw here to make it clear that
+    // Cloudpack needs to have specific handling for any cases where that might be possible.
+    if (/^[a-zA-Z]:[\\/]/.test(originalPath)) {
+        throw new Error(`Received an absolute path where a relative path was expected: ${originalPath}.\n` +
+            'This indicates a bug in Cloudpack, likely due to calling path.relative() with two Windows paths ' +
+            'on different drives (which returns an absolute path) and then assuming the result is relative.');
     }
     // Ensure we have the right slashes.
-    originalPath = slash(originalPath);
-    return originalPath.startsWith('./') ? originalPath : `./${originalPath}`;
+    const normalizedPath = slash(originalPath);
+    if (normalizedPath[0] === '/') {
+        // Technically a path starting with / is absolute, but it's possible that package.json
+        // entry points like "main" could also use a leading slash to indicate the package root.
+        return '.' + normalizedPath;
+    }
+    return normalizedPath.startsWith('./') ? normalizedPath : `./${normalizedPath}`;
 }
 //# sourceMappingURL=normalizeRelativePath.js.map

package/lib/normalizeRelativePath.js.map

@@ -1 +1 @@
-{"version":3,"file":"normalizeRelativePath.js","sourceRoot":"","sources":["../src/normalizeRelativePath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,YAAgC;IACpE,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,GAAG,EAAE,CAAC;QAC1C,OAAO,GAAG,CAAC;IACb,CAAC;IAED,iCAAiC;IACjC,gGAAgG;IAChG,yCAAyC;IACzC,IAAI,YAAY,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,4DAA4D,YAAY,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,oCAAoC;IACpC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;IAEnC,OAAO,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,YAAY,EAAE,CAAC;AAC5E,CAAC","sourcesContent":["import { slash } from './slash.js';\n\n/**\n * Normalize a path:\n * - If it's empty, undefined, or `'.'`, return `'.'`.\n * - If it's relative, normalize slashes and ensure it starts with `./`.\n * - If it's absolute, throw an error (since this likely indicates a bug in the calling code).\n *\n * Note that this will NOT remove a trailing slash (if present).\n */\nexport function normalizeRelativePath(originalPath: string | undefined): string {\n  if (!originalPath || originalPath === '.') {\n    return '.';\n  }\n\n  // Throw if the path is absolute.\n  // NOTE: Don't use the `path` module because this function is used by `parseImportString`, which\n  // is used in the browser by the overlay.\n  if (originalPath[0] === '/' || /^[a-zA-Z]:[\\\\/]/.test(originalPath)) {\n    throw new Error(`Expected a relative path, but received an absolute path: ${originalPath}`);\n  }\n\n  // Ensure we have the right slashes.\n  originalPath = slash(originalPath);\n\n  return originalPath.startsWith('./') ? originalPath : `./${originalPath}`;\n}\n"]}
+{"version":3,"file":"normalizeRelativePath.js","sourceRoot":"","sources":["../src/normalizeRelativePath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,qBAAqB,CAAC,YAAgC;IACpE,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,GAAG,EAAE,CAAC;QAC1C,OAAO,GAAG,CAAC;IACb,CAAC;IAED,8FAA8F;IAC9F,gGAAgG;IAChG,+FAA+F;IAC/F,uFAAuF;IACvF,yFAAyF;IACzF,wFAAwF;IACxF,IAAI,iBAAiB,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CACb,iEAAiE,YAAY,KAAK;YAChF,kGAAkG;YAClG,gGAAgG,CACnG,CAAC;IACJ,CAAC;IAED,oCAAoC;IACpC,MAAM,cAAc,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;IAE3C,IAAI,cAAc,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC;QAC9B,sFAAsF;QACtF,wFAAwF;QACxF,OAAO,GAAG,GAAG,cAAc,CAAC;IAC9B,CAAC;IAED,OAAO,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,KAAK,cAAc,EAAE,CAAC;AAClF,CAAC","sourcesContent":["import { slash } from './slash.js';\n\n/**\n * Normalize a path:\n * - If it's empty, undefined, or `.`, return `.`.\n * - If it's relative, normalize slashes and ensure it starts with `./`.\n * - If it starts with `/`, add a leading `.` (this is an absolute path but is sometimes treated\n *   as package-relative)\n * - If it's an absolute Windows path (starts with a drive letter), throw an error.\n * - If it's absolute, throw an error (since this likely indicates a bug in the calling code).\n *\n * Note that this will NOT remove a trailing slash (if present).\n */\nexport function normalizeRelativePath(originalPath: string | undefined): string {\n  if (!originalPath || originalPath === '.') {\n    return '.';\n  }\n\n  // Throw on an absolute Windows path: this is definitely absolute regardless of the context it\n  // came from, and if the calling code attempts to join it to another path as if it was relative,\n  // that will have bad results. It's more likely on Windows that we could unintentionally end up\n  // with an absolute path since there's no way to do relative paths across drive letters\n  // (path.relative() will return an absolute path), so we throw here to make it clear that\n  // Cloudpack needs to have specific handling for any cases where that might be possible.\n  if (/^[a-zA-Z]:[\\\\/]/.test(originalPath)) {\n    throw new Error(\n      `Received an absolute path where a relative path was expected: ${originalPath}.\\n` +\n        'This indicates a bug in Cloudpack, likely due to calling path.relative() with two Windows paths ' +\n        'on different drives (which returns an absolute path) and then assuming the result is relative.',\n    );\n  }\n\n  // Ensure we have the right slashes.\n  const normalizedPath = slash(originalPath);\n\n  if (normalizedPath[0] === '/') {\n    // Technically a path starting with / is absolute, but it's possible that package.json\n    // entry points like \"main\" could also use a leading slash to indicate the package root.\n    return '.' + normalizedPath;\n  }\n\n  return normalizedPath.startsWith('./') ? normalizedPath : `./${normalizedPath}`;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ms-cloudpack/path-string-parsing",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Common path-related string parsing utilities for Cloudpack",
   "license": "MIT",
   "type": "module",