@lwrjs/shared-utils 0.4.6 → 0.5.2

package/build/cjs/env.cjs

@@ -0,0 +1,17 @@
+var __defProp = Object.defineProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", {value: true});
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {get: all[name], enumerable: true});
+};
+
+// packages/@lwrjs/shared-utils/src/env.ts
+__markAsModule(exports);
+__export(exports, {
+  getExperimentalFeatures: () => getExperimentalFeatures
+});
+function getExperimentalFeatures() {
+  return {
+    ENABLE_FINGERPRINTS: process.env.ENABLE_FINGERPRINTS !== void 0 && process.env.ENABLE_FINGERPRINTS === "true" ? true : false
+  };
+}

package/build/cjs/index.cjs

@@ -30,3 +30,4 @@ __exportStar(exports, __toModule(require("./import-metadata.cjs")));
 __exportStar(exports, __toModule(require("./graph.cjs")));
 __exportStar(exports, __toModule(require("./mappings.cjs")));
 __exportStar(exports, __toModule(require("./metrics.cjs")));
+__exportStar(exports, __toModule(require("./env.cjs")));

package/build/cjs/mappings.cjs

@@ -31,23 +31,21 @@ var import_graph = __toModule(require("./graph.cjs"));
 var import_identity = __toModule(require("./identity.cjs"));
 async function getImportMetadataMappings(moduleIds, runtimeEnvironment, runtimeParams, moduleRegistry, moduleBundler) {
   const visitedCache = new Map();
-  const importMetadata = {
-    imports: {}
+  let importMetadata = {
+    imports: {},
+    index: {}
   };
   for (const moduleId of moduleIds) {
     const specifier = moduleId.specifier;
     if (!visitedCache.has(specifier)) {
       const depth = {static: import_graph.GraphDepth.ALL, dynamic: 0};
       const moduleGraph = await (0, import_graph.getModuleGraphs)(moduleId.specifier, {includeUris: true, includeLinkedDefinitions: true, depth}, moduleRegistry, runtimeEnvironment.bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams, visitedCache);
-      Object.assign(importMetadata.imports, toImportMetadata(moduleGraph).imports);
+      importMetadata = await toImportMetadata(moduleGraph, importMetadata, moduleRegistry, runtimeEnvironment, runtimeParams);
     }
   }
   return importMetadata;
 }
-function toImportMetadata(moduleGraph, existingImportMetadata) {
-  const importMetadata = {
-    imports: {}
-  };
+async function toImportMetadata(moduleGraph, existingImportMetadata = {imports: {}, index: {}}, moduleRegistry, runtimeEnvironment, runtimeParams = {}) {
   const specifier = moduleGraph.graphs[0].specifier;
   const uri = moduleGraph.uriMap[specifier];
   const definition = moduleGraph.linkedDefinitions[specifier];
@@ -57,9 +55,8 @@ function toImportMetadata(moduleGraph, existingImportMetadata) {
   if (!definition) {
     throw new Error("Linked module definition was not included in the graph: " + specifier);
   }
-  if (!importMetadata.imports[uri]) {
-    importMetadata.imports[uri] = normalizedIncludedModules(definition);
-  }
+  const rootMetadata = await normalizeImportMetadata(specifier, uri, definition, moduleRegistry, runtimeEnvironment, runtimeParams);
+  let importMetadata = mergeImportMetadata(existingImportMetadata, rootMetadata);
   const depSpecifiers = moduleGraph.graphs[0].static;
   for (const depSpecifier of depSpecifiers) {
     const depUri = moduleGraph.uriMap[depSpecifier];
@@ -67,18 +64,58 @@ function toImportMetadata(moduleGraph, existingImportMetadata) {
     if (!depUri) {
       throw new Error("URI was not included in the graph for dependent: " + depSpecifier);
     }
-    if (!depSpecifier) {
+    if (!depDef) {
       throw new Error("Linked dependent module definition was not included in the graph: " + depSpecifier);
     }
     if (!importMetadata.imports[depUri]) {
-      importMetadata.imports[depUri] = normalizedIncludedModules(depDef);
+      const depMetadata = await normalizeImportMetadata((0, import_identity.getSpecifier)(depDef), depUri, depDef, moduleRegistry, runtimeEnvironment, runtimeParams);
+      importMetadata = mergeImportMetadata(importMetadata, depMetadata);
     }
   }
-  if (existingImportMetadata?.imports) {
-    importMetadata.imports = Object.assign(importMetadata.imports, existingImportMetadata.imports);
-  }
   return importMetadata;
 }
+function mergeImportMetadata(existing, newMetadata) {
+  return {
+    imports: {
+      ...existing.imports,
+      ...newMetadata.imports
+    },
+    index: {
+      ...existing.index,
+      ...newMetadata.index
+    }
+  };
+}
+async function normalizeImportMetadata(specifier, uri, definition, moduleRegistry, moduleRuntimeEnvironment, runtimeParams) {
+  const specifiers = normalizedIncludedModules(definition);
+  const imports = {};
+  imports[uri] = specifiers;
+  const index = await createIndex(specifiers, moduleRegistry, moduleRuntimeEnvironment, runtimeParams);
+  if (!(specifier in index)) {
+    index[specifier] = uri;
+  }
+  return {
+    imports,
+    index
+  };
+}
 function normalizedIncludedModules(definition) {
   return (0, import_identity.isBundleDefinition)(definition) ? [(0, import_identity.getSpecifier)(definition), ...definition.bundleRecord.includedModules] : [(0, import_identity.getSpecifier)(definition)];
 }
+async function createIndex(specifiers, moduleRegistry, runtimeEnvironment, runtimeParams) {
+  const index = {};
+  const moduleRuntimeEnvironment = {...runtimeEnvironment, bundle: false};
+  async function getUri(specifier) {
+    const moduleId = (0, import_identity.explodeSpecifier)(specifier);
+    if (!moduleId.version) {
+      throw new Error("Module specifier must include a version: " + specifier);
+    }
+    index[specifier] = await moduleRegistry.resolveModuleUri({...moduleId, version: moduleId.version}, moduleRuntimeEnvironment, runtimeParams);
+  }
+  const promises = [];
+  for (const specifier of specifiers) {
+    promises.push(getUri(specifier));
+  }
+  await Promise.all(promises);
+  return index;
+}

package/build/es/env.d.ts

@@ -0,0 +1,3 @@
+import { ExperimentalFeatures } from '@lwrjs/types';
+export declare function getExperimentalFeatures(): ExperimentalFeatures;
+//# sourceMappingURL=env.d.ts.map

package/build/es/env.js

@@ -0,0 +1,9 @@
+export function getExperimentalFeatures() {
+    return {
+        // DEFAULT ENABLE_FINGERPRINTS = false;
+        ENABLE_FINGERPRINTS: process.env.ENABLE_FINGERPRINTS !== undefined && process.env.ENABLE_FINGERPRINTS === 'true'
+            ? true
+            : false,
+    };
+}
+//# sourceMappingURL=env.js.map

package/build/es/graph.js

@@ -49,12 +49,16 @@ defRegistry, runtimeEnvironment, runtimeParams) {
                 }
                 if (depth.static === GraphDepth.ALL) {
                     if (visited.has(impSpecifier)) {
+                        // eslint-disable-next-line no-await-in-loop
                         await flatten(impSpecifier, flattened, graphIdx, visited);
                     }
                     else {
                         const moduleDef = isBundler(defRegistry)
-                            ? await defRegistry.getModuleBundle(imp, runtimeEnvironment, runtimeParams)
-                            : await defRegistry.getModule(imp, runtimeParams);
+                            ? // eslint-disable-next-line no-await-in-loop
+                                await defRegistry.getModuleBundle(imp, runtimeEnvironment, runtimeParams)
+                            : // eslint-disable-next-line no-await-in-loop
+                                await defRegistry.getModule(imp, runtimeParams);
+                        // eslint-disable-next-line no-await-in-loop
                         await traverse(moduleDef, depth, flattened, graphIdx, visited, defRegistry, runtimeEnvironment, runtimeParams);
                     }
                 }
@@ -71,12 +75,16 @@ defRegistry, runtimeEnvironment, runtimeParams) {
                 }
                 if (visited.has(impSpecifier)) {
                     // flatten already known sub graphs
+                    // eslint-disable-next-line no-await-in-loop
                     await flatten(impSpecifier, flattened, graphIdx + 1, visited);
                 }
                 else {
                     const moduleDef = isBundler(defRegistry)
-                        ? await defRegistry.getModuleBundle(imp, runtimeEnvironment, runtimeParams)
-                        : await defRegistry.getModule(imp, runtimeParams);
+                        ? // eslint-disable-next-line no-await-in-loop
+                            await defRegistry.getModuleBundle(imp, runtimeEnvironment, runtimeParams)
+                        : // eslint-disable-next-line no-await-in-loop
+                            await defRegistry.getModule(imp, runtimeParams);
+                    // eslint-disable-next-line no-await-in-loop
                     await traverse(moduleDef, depth, flattened, graphIdx + 1, visited, defRegistry, runtimeEnvironment, runtimeParams);
                 }
             }
@@ -115,7 +123,9 @@ options, moduleRegistry, defRegistry, runtimeEnvironment, runtimeParams, visited
     const uriMap = {};
     if (options.includeUris) {
         for (const visitedSpecifier of acc.keys()) {
+            // eslint-disable-next-line no-await-in-loop
             const moduleId = await getVersionedModuleId(visitedSpecifier, moduleRegistry);
+            // eslint-disable-next-line no-await-in-loop
             const uri = await moduleRegistry.resolveModuleUri(moduleId, runtimeEnvironment, runtimeParams);
             uriMap[visitedSpecifier] = uri;
         }
@@ -123,10 +133,13 @@ options, moduleRegistry, defRegistry, runtimeEnvironment, runtimeParams, visited
     const linkedDefinitions = {};
     if (options.includeLinkedDefinitions) {
         for (const visitedSpecifier of acc.keys()) {
+            // eslint-disable-next-line no-await-in-loop
             const versionedModuleId = await getVersionedModuleId(visitedSpecifier, moduleRegistry);
             const module = isBundler(defRegistry)
-                ? await defRegistry.getModuleBundle(versionedModuleId, runtimeEnvironment, runtimeParams)
-                : await defRegistry.getLinkedModule(versionedModuleId, runtimeEnvironment, runtimeParams);
+                ? // eslint-disable-next-line no-await-in-loop
+                    await defRegistry.getModuleBundle(versionedModuleId, runtimeEnvironment, runtimeParams)
+                : // eslint-disable-next-line no-await-in-loop
+                    await defRegistry.getLinkedModule(versionedModuleId, runtimeEnvironment, runtimeParams);
             linkedDefinitions[visitedSpecifier] = module;
         }
     }

package/build/es/index.d.ts

@@ -9,4 +9,5 @@ export * from './import-metadata.js';
 export * from './graph.js';
 export * from './mappings.js';
 export * from './metrics.js';
+export * from './env.js';
 //# sourceMappingURL=index.d.ts.map

package/build/es/index.js

@@ -9,4 +9,5 @@ export * from './import-metadata.js';
 export * from './graph.js';
 export * from './mappings.js';
 export * from './metrics.js';
+export * from './env.js';
 //# sourceMappingURL=index.js.map

package/build/es/mappings.d.ts

@@ -11,9 +11,9 @@ export declare function getImportMetadataMappings(moduleIds: AbstractModuleId[],
  * You can pass in an existing set of import metadata and the result will merge the imports.
  * If there is a duplicate uri the merge will keep the one from the existing metadata.
  *
- * @param moduleGraph FlattenedModuleGraphs created by the grpah shared util
+ * @param moduleGraph FlattenedModuleGraphs created by the graph shared util
  * @param existingImportMetadata Optional existing ImportMetadata.  If provided the results will be a merge the two sets of URI mappings.
- * @returns Retruns ImportMetadata from a module graph in the format here -> https://rfcs.lwc.dev/rfcs/lws/0000-mapping-api#uri-mapping-resource-specification
+ * @returns Returns ImportMetadata from a module graph in the format here -> https://rfcs.lwc.dev/rfcs/lws/0000-mapping-api#uri-mapping-resource-specification
  */
-export declare function toImportMetadata(moduleGraph: FlattenedModuleGraphs, existingImportMetadata?: ImportMetadata): ImportMetadata;
+export declare function toImportMetadata(moduleGraph: FlattenedModuleGraphs, existingImportMetadata: ImportMetadata | undefined, moduleRegistry: ModuleRegistry, runtimeEnvironment: RuntimeEnvironment, runtimeParams?: RuntimeParams): Promise<ImportMetadata>;
 //# sourceMappingURL=mappings.d.ts.map

package/build/es/mappings.js

@@ -1,12 +1,13 @@
 import { getModuleGraphs, GraphDepth } from './graph.js';
-import { getSpecifier, isBundleDefinition } from './identity.js';
+import { explodeSpecifier, getSpecifier, isBundleDefinition } from './identity.js';
 /**
  * Get the Import Metadata for the LWR Mapping Api (https://rfcs.lwc.dev/rfcs/lws/0000-mapping-api)
  */
 export async function getImportMetadataMappings(moduleIds, runtimeEnvironment, runtimeParams, moduleRegistry, moduleBundler) {
     const visitedCache = new Map();
-    const importMetadata = {
+    let importMetadata = {
         imports: {},
+        index: {},
     };
     for (const moduleId of moduleIds) {
         const specifier = moduleId.specifier;
@@ -14,11 +15,13 @@ export async function getImportMetadataMappings(moduleIds, runtimeEnvironment, r
         if (!visitedCache.has(specifier)) {
             // Traversal of the Module Graph is done to get all the URLS for discoverable static dependencies.
             const depth = { static: GraphDepth.ALL, dynamic: 0 };
+            // eslint-disable-next-line no-await-in-loop
             const moduleGraph = await getModuleGraphs(moduleId.specifier, 
             // include uris and linked definitions
             { includeUris: true, includeLinkedDefinitions: true, depth }, moduleRegistry, runtimeEnvironment.bundle ? moduleBundler : moduleRegistry, runtimeEnvironment, runtimeParams, visitedCache);
             // Root module
-            Object.assign(importMetadata.imports, toImportMetadata(moduleGraph).imports);
+            // eslint-disable-next-line no-await-in-loop
+            importMetadata = await toImportMetadata(moduleGraph, importMetadata, moduleRegistry, runtimeEnvironment, runtimeParams);
         }
     }
     return importMetadata;
@@ -31,14 +34,12 @@ export async function getImportMetadataMappings(moduleIds, runtimeEnvironment, r
  * You can pass in an existing set of import metadata and the result will merge the imports.
  * If there is a duplicate uri the merge will keep the one from the existing metadata.
  *
- * @param moduleGraph FlattenedModuleGraphs created by the grpah shared util
+ * @param moduleGraph FlattenedModuleGraphs created by the graph shared util
  * @param existingImportMetadata Optional existing ImportMetadata.  If provided the results will be a merge the two sets of URI mappings.
- * @returns Retruns ImportMetadata from a module graph in the format here -> https://rfcs.lwc.dev/rfcs/lws/0000-mapping-api#uri-mapping-resource-specification
+ * @returns Returns ImportMetadata from a module graph in the format here -> https://rfcs.lwc.dev/rfcs/lws/0000-mapping-api#uri-mapping-resource-specification
  */
-export function toImportMetadata(moduleGraph, existingImportMetadata) {
-    const importMetadata = {
-        imports: {},
-    };
+export async function toImportMetadata(moduleGraph, existingImportMetadata = { imports: {}, index: {} }, moduleRegistry, runtimeEnvironment, runtimeParams = {}) {
+    // root module specifier
     const specifier = moduleGraph.graphs[0].specifier;
     const uri = moduleGraph.uriMap[specifier];
     const definition = moduleGraph.linkedDefinitions[specifier];
@@ -48,9 +49,9 @@ export function toImportMetadata(moduleGraph, existingImportMetadata) {
     if (!definition) {
         throw new Error('Linked module definition was not included in the graph: ' + specifier);
     }
-    if (!importMetadata.imports[uri]) {
-        importMetadata.imports[uri] = normalizedIncludedModules(definition);
-    }
+    // Merge in the existing metadata with imports for the root specifier
+    const rootMetadata = await normalizeImportMetadata(specifier, uri, definition, moduleRegistry, runtimeEnvironment, runtimeParams);
+    let importMetadata = mergeImportMetadata(existingImportMetadata, rootMetadata);
     // root module dependencies
     const depSpecifiers = moduleGraph.graphs[0].static;
     for (const depSpecifier of depSpecifiers) {
@@ -59,22 +60,70 @@ export function toImportMetadata(moduleGraph, existingImportMetadata) {
         if (!depUri) {
             throw new Error('URI was not included in the graph for dependent: ' + depSpecifier);
         }
-        if (!depSpecifier) {
+        if (!depDef) {
             throw new Error('Linked dependent module definition was not included in the graph: ' + depSpecifier);
         }
         if (!importMetadata.imports[depUri]) {
-            importMetadata.imports[depUri] = normalizedIncludedModules(depDef);
+            // eslint-disable-next-line no-await-in-loop
+            const depMetadata = await normalizeImportMetadata(getSpecifier(depDef), depUri, depDef, moduleRegistry, runtimeEnvironment, runtimeParams);
+            importMetadata = mergeImportMetadata(importMetadata, depMetadata);
         }
     }
-    if (existingImportMetadata?.imports) {
-        importMetadata.imports = Object.assign(importMetadata.imports, existingImportMetadata.imports);
-    }
     return importMetadata;
 }
+function mergeImportMetadata(existing, newMetadata) {
+    // TODO should there be an error if the metadata conflicts?
+    return {
+        imports: {
+            ...existing.imports,
+            ...newMetadata.imports,
+        },
+        index: {
+            ...existing.index,
+            ...newMetadata.index,
+        },
+    };
+}
+async function normalizeImportMetadata(specifier, uri, definition, moduleRegistry, moduleRuntimeEnvironment, runtimeParams) {
+    const specifiers = normalizedIncludedModules(definition);
+    const imports = {};
+    imports[uri] = specifiers;
+    // The index info for the modules included in a bundle
+    const index = await createIndex(specifiers, moduleRegistry, moduleRuntimeEnvironment, runtimeParams);
+    // If root specifier was not included in createIndex add an entry where the uri is the index
+    if (!(specifier in index)) {
+        index[specifier] = uri;
+    }
+    // return imports and index objects created above
+    return {
+        imports,
+        index,
+    };
+}
 // Normalized the included modules associated with either an individual module definition or Bundle definition
 function normalizedIncludedModules(definition) {
     return isBundleDefinition(definition)
         ? [getSpecifier(definition), ...definition.bundleRecord.includedModules]
         : [getSpecifier(definition)];
 }
+async function createIndex(specifiers, moduleRegistry, runtimeEnvironment, runtimeParams) {
+    const index = {};
+    // We need a runtime environment for modules when building the index for a bundle
+    const moduleRuntimeEnvironment = { ...runtimeEnvironment, bundle: false };
+    async function getUri(specifier) {
+        const moduleId = explodeSpecifier(specifier);
+        if (!moduleId.version) {
+            throw new Error('Module specifier must include a version: ' + specifier);
+        }
+        index[specifier] = await moduleRegistry.resolveModuleUri({ ...moduleId, version: moduleId.version }, moduleRuntimeEnvironment, runtimeParams);
+    }
+    // Queue up uri requests
+    const promises = [];
+    for (const specifier of specifiers) {
+        promises.push(getUri(specifier));
+    }
+    // Wait for them to finish
+    await Promise.all(promises);
+    return index;
+}
 //# sourceMappingURL=mappings.js.map

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.4.6",
+    "version": "0.5.2",
     "homepage": "https://lwr.dev/",
     "repository": {
         "type": "git",
@@ -41,11 +41,11 @@
         "slugify": "^1.4.5"
     },
     "devDependencies": {
-        "@lwrjs/diagnostics": "0.4.6",
-        "@lwrjs/types": "0.4.6"
+        "@lwrjs/diagnostics": "0.5.2",
+        "@lwrjs/types": "0.5.2"
     },
     "engines": {
         "node": ">=14.15.4 <15"
     },
-    "gitHead": "71f599b20c35d612e55312e94804a97e7cc778e1"
+    "gitHead": "3186b126bf8bf95f88a31b2ea00768e8f42e362e"
 }