@ms-cloudpack/path-string-parsing 1.0.2 → 1.1.0

package/lib/parseImportString.d.ts

@@ -1,7 +1,24 @@
 export type ImportStringResult = {
-    packageName: string | undefined;
-    version: string | undefined;
-    importPath: string | undefined;
+    packageName: string;
+    /** Optional package version (default: empty string) */
+    version: string;
+    /**
+     * Optional import path (default: `'.'`).
+     * If this is set to a non-default value, it will be normalized to start with `./`.
+     */
+    importPath: string;
 };
+/**
+ * Parse an import path: usually this will be a standard JS import, but this function also allows
+ * an optional `@version` suffix after the package name.
+ *
+ * Examples of supported import strings:
+ * - `foo`
+ * - `foo@1.2.3`
+ * - `foo@1.2.3/path/to/file`
+ * - `@foo/bar`
+ * - `@foo/bar@1.2.3`
+ * - `@foo/bar@1.2.3/path/to/file`
+ */
 export declare function parseImportString(importString?: string): ImportStringResult;
 //# sourceMappingURL=parseImportString.d.ts.map

package/lib/parseImportString.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parseImportString.d.ts","sourceRoot":"","sources":["../src/parseImportString.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,wBAAgB,iBAAiB,CAAC,YAAY,SAAK,GAAG,kBAAkB,CAWvE"}
+{"version":3,"file":"parseImportString.d.ts","sourceRoot":"","sources":["../src/parseImportString.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,SAAK,GAAG,kBAAkB,CAYvE"}

package/lib/parseImportString.js

@@ -1,10 +1,24 @@
 import { safeRelativePath } from './safeRelativePath.js';
+/**
+ * Parse an import path: usually this will be a standard JS import, but this function also allows
+ * an optional `@version` suffix after the package name.
+ *
+ * Examples of supported import strings:
+ * - `foo`
+ * - `foo@1.2.3`
+ * - `foo@1.2.3/path/to/file`
+ * - `@foo/bar`
+ * - `@foo/bar@1.2.3`
+ * - `@foo/bar@1.2.3/path/to/file`
+ */
 export function parseImportString(importString = '') {
-    const matches = importString.match(/[/]?(@[-_a-z-A-Z0-9.]+\/[-_a-z-A-Z0-9.]+|[-_a-zA-Z0-9.]+)(@([-_a-zA-Z-0-9.]+))?(\/([-_/a-zA-Z0-9.]+))?/) || [];
+    const matches = importString.match(
+    //   1: packageName          2: version      3: importPath
+    /^\/?((?:@[-\w.]+\/)?[-\w.]+)(?:@([-\w.]+))?(?:\/([-\w./]+))?/) || [];
     return {
         packageName: matches[1] || '.',
-        version: matches[3] || '',
-        importPath: safeRelativePath(matches[5]),
+        version: matches[2] || '',
+        importPath: safeRelativePath(matches[3]),
     };
 }
 //# sourceMappingURL=parseImportString.js.map

package/lib/parseImportString.js.map

@@ -1 +1 @@
-{"version":3,"file":"parseImportString.js","sourceRoot":"","sources":["../src/parseImportString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAQzD,MAAM,UAAU,iBAAiB,CAAC,YAAY,GAAG,EAAE;IACjD,MAAM,OAAO,GACX,YAAY,CAAC,KAAK,CAChB,wGAAwG,CACzG,IAAI,EAAE,CAAC;IAEV,OAAO;QACL,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG;QAC9B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE;QACzB,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KACzC,CAAC;AACJ,CAAC","sourcesContent":["import { safeRelativePath } from './safeRelativePath.js';\n\nexport type ImportStringResult = {\n  packageName: string | undefined;\n  version: string | undefined;\n  importPath: string | undefined;\n};\n\nexport function parseImportString(importString = ''): ImportStringResult {\n  const matches =\n    importString.match(\n      /[/]?(@[-_a-z-A-Z0-9.]+\\/[-_a-z-A-Z0-9.]+|[-_a-zA-Z0-9.]+)(@([-_a-zA-Z-0-9.]+))?(\\/([-_/a-zA-Z0-9.]+))?/,\n    ) || [];\n\n  return {\n    packageName: matches[1] || '.',\n    version: matches[3] || '',\n    importPath: safeRelativePath(matches[5]),\n  };\n}\n"]}
+{"version":3,"file":"parseImportString.js","sourceRoot":"","sources":["../src/parseImportString.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAazD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,iBAAiB,CAAC,YAAY,GAAG,EAAE;IACjD,MAAM,OAAO,GACX,YAAY,CAAC,KAAK;IAChB,0DAA0D;IAC1D,8DAA8D,CAC/D,IAAI,EAAE,CAAC;IAEV,OAAO;QACL,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG;QAC9B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE;QACzB,UAAU,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;KACzC,CAAC;AACJ,CAAC","sourcesContent":["import { safeRelativePath } from './safeRelativePath.js';\n\nexport type ImportStringResult = {\n  packageName: string;\n  /** Optional package version (default: empty string) */\n  version: string;\n  /**\n   * Optional import path (default: `'.'`).\n   * If this is set to a non-default value, it will be normalized to start with `./`.\n   */\n  importPath: string;\n};\n\n/**\n * Parse an import path: usually this will be a standard JS import, but this function also allows\n * an optional `@version` suffix after the package name.\n *\n * Examples of supported import strings:\n * - `foo`\n * - `foo@1.2.3`\n * - `foo@1.2.3/path/to/file`\n * - `@foo/bar`\n * - `@foo/bar@1.2.3`\n * - `@foo/bar@1.2.3/path/to/file`\n */\nexport function parseImportString(importString = ''): ImportStringResult {\n  const matches =\n    importString.match(\n      //   1: packageName          2: version      3: importPath\n      /^\\/?((?:@[-\\w.]+\\/)?[-\\w.]+)(?:@([-\\w.]+))?(?:\\/([-\\w./]+))?/,\n    ) || [];\n\n  return {\n    packageName: matches[1] || '.',\n    version: matches[2] || '',\n    importPath: safeRelativePath(matches[3]),\n  };\n}\n"]}

package/lib/safeRelativePath.d.ts

@@ -1,5 +1,6 @@
 /**
- * Ensures the give relative path starts with a ./
+ * If the given relative path is non-empty, ensure it starts with `./`.
+ * Returns `.` if the given path is empty or undefined (or already `.`).
  */
 export declare function safeRelativePath(originalPath: string | undefined): string;
 //# sourceMappingURL=safeRelativePath.d.ts.map

package/lib/safeRelativePath.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"safeRelativePath.d.ts","sourceRoot":"","sources":["../src/safeRelativePath.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAezE"}
+{"version":3,"file":"safeRelativePath.d.ts","sourceRoot":"","sources":["../src/safeRelativePath.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAezE"}

package/lib/safeRelativePath.js

@@ -1,9 +1,10 @@
 import { slash } from './slash.js';
 /**
- * Ensures the give relative path starts with a ./
+ * If the given relative path is non-empty, ensure it starts with `./`.
+ * Returns `.` if the given path is empty or undefined (or already `.`).
  */
 export function safeRelativePath(originalPath) {
-    if (!originalPath || originalPath.length === 0 || originalPath === '.') {
+    if (!originalPath || originalPath === '.') {
         return '.';
     }
     // Ensure we have the right slashes.

package/lib/safeRelativePath.js.map

@@ -1 +1 @@
-{"version":3,"file":"safeRelativePath.js","sourceRoot":"","sources":["../src/safeRelativePath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,YAAgC;IAC/D,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,IAAI,YAAY,KAAK,GAAG,EAAE;QACtE,OAAO,GAAG,CAAC;KACZ;IAED,oCAAoC;IACpC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;IAEnC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QAChC,OAAO,GAAG,GAAG,YAAY,CAAC;KAC3B;SAAM,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACxC,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,KAAK,YAAY,EAAE,CAAC;AAC7B,CAAC","sourcesContent":["import { slash } from './slash.js';\n\n/**\n * Ensures the give relative path starts with a ./\n */\nexport function safeRelativePath(originalPath: string | undefined): string {\n  if (!originalPath || originalPath.length === 0 || originalPath === '.') {\n    return '.';\n  }\n\n  // Ensure we have the right slashes.\n  originalPath = slash(originalPath);\n\n  if (originalPath.startsWith('/')) {\n    return '.' + originalPath;\n  } else if (originalPath.startsWith('./')) {\n    return originalPath;\n  }\n\n  return `./${originalPath}`;\n}\n"]}
+{"version":3,"file":"safeRelativePath.js","sourceRoot":"","sources":["../src/safeRelativePath.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,YAAgC;IAC/D,IAAI,CAAC,YAAY,IAAI,YAAY,KAAK,GAAG,EAAE;QACzC,OAAO,GAAG,CAAC;KACZ;IAED,oCAAoC;IACpC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC;IAEnC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QAChC,OAAO,GAAG,GAAG,YAAY,CAAC;KAC3B;SAAM,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACxC,OAAO,YAAY,CAAC;KACrB;IAED,OAAO,KAAK,YAAY,EAAE,CAAC;AAC7B,CAAC","sourcesContent":["import { slash } from './slash.js';\n\n/**\n * If the given relative path is non-empty, ensure it starts with `./`.\n * Returns `.` if the given path is empty or undefined (or already `.`).\n */\nexport function safeRelativePath(originalPath: string | undefined): string {\n  if (!originalPath || originalPath === '.') {\n    return '.';\n  }\n\n  // Ensure we have the right slashes.\n  originalPath = slash(originalPath);\n\n  if (originalPath.startsWith('/')) {\n    return '.' + originalPath;\n  } else if (originalPath.startsWith('./')) {\n    return originalPath;\n  }\n\n  return `./${originalPath}`;\n}\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.35.2"
+      "packageVersion": "7.36.4"
     }
   ]
 }

package/package.json

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