@lwrjs/asset-transformer 0.10.0-alpha.8 → 0.10.0

package/build/cjs/index.cjs

@@ -28,15 +28,69 @@ __export(exports, {
 });
 var import_shared_utils = __toModule(require("@lwrjs/shared-utils"));
 var import_css = __toModule(require("./metadata-collectors/css.cjs"));
+var import_path = __toModule(require("path"));
 var CSS_MIME = (0, import_shared_utils.mimeLookup)(".css");
-function defaultAssetTransformer(options) {
+function defaultAssetTransformer(_options, lwrGlobalContext) {
+  const {assetRegistry} = lwrGlobalContext;
   return {
-    name: "default-asset-transformer",
-    async extractMetadata(code, assetSource) {
+    name: "lwr-default-asset-transformer",
+    async transformUri(assetUri, assetDef, runtimeEnvironment) {
+      const {entry, uri: existingUri} = assetUri;
+      const {type, ownHash} = assetDef;
+      const {apiVersion, immutableAssets, basePath} = runtimeEnvironment;
+      const immutable = immutableAssets ? "immutable/" : "";
+      const hash = immutableAssets ? ownHash : "latest";
+      const relativePath = basePath ? (0, import_path.relative)(basePath, existingUri) : existingUri;
+      const uri = (0, import_path.join)(`${basePath}/${apiVersion}/${type}/${immutable}s/${hash}`, encodeURI(relativePath));
+      import_shared_utils.logger.debug(`[${this.name}] normalized url ${entry} -> ${uri}`);
+      return {
+        ...assetUri,
+        uri,
+        entry,
+        external: assetDef.type === "external",
+        immutable: !!immutableAssets
+      };
+    },
+    async transformSource(assetSource, runtimeEnvironment) {
       if (assetSource.mime === CSS_MIME) {
+        import_shared_utils.logger.debug(`[${this.name}] extract metadata ${assetSource.entry}`);
+        const code = assetSource.content("utf-8");
         const metadata = await (0, import_css.linkCss)(code.toString(), assetSource.entry);
-        return {metadata};
+        const linkedAsset = await linkAsset(code, {
+          ...assetSource,
+          metadata
+        }, runtimeEnvironment, assetRegistry.resolveAssetUri);
+        return {
+          source: linkedAsset,
+          metadata
+        };
       }
+      return void 0;
     }
   };
 }
+async function linkAsset(source, assetSource, runtimeEnvironment, resolveUri) {
+  const assetReferences = assetSource.metadata?.assetReferences;
+  if (Buffer.isBuffer(source) || !assetReferences || assetReferences.length === 0) {
+    return source;
+  }
+  const codeStringBuilder = (0, import_shared_utils.createStringBuilder)(source);
+  const importer = assetSource.entry;
+  for (const assetRef of assetReferences) {
+    const {
+      url,
+      relative: relative2,
+      location: {startOffset, endOffset}
+    } = assetRef;
+    if (relative2) {
+      try {
+        assetRef.override = await resolveUri({specifier: url, importer}, runtimeEnvironment);
+        const overrideUrl = assetRef.override?.uri;
+        codeStringBuilder.overwrite(startOffset, endOffset, overrideUrl || url);
+      } catch (err) {
+        import_shared_utils.logger.warn(`Failed to resolve reference '${url}' in asset '${importer}'`);
+      }
+    }
+  }
+  return codeStringBuilder.toString();
+}

package/build/es/index.d.ts

@@ -1,7 +1,7 @@
-import { AssetTransformPlugin } from '@lwrjs/types';
+import type { AssetTransformPlugin, ProviderContext } from '@lwrjs/types';
 interface AssetTransformerOptions {
     minify?: boolean;
 }
-export default function defaultAssetTransformer(options: AssetTransformerOptions): AssetTransformPlugin;
+export default function defaultAssetTransformer(_options: AssetTransformerOptions, lwrGlobalContext: ProviderContext): AssetTransformPlugin;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/build/es/index.js

@@ -1,15 +1,76 @@
-import { mimeLookup } from '@lwrjs/shared-utils';
+import { createStringBuilder, logger, mimeLookup } from '@lwrjs/shared-utils';
 import { linkCss } from './metadata-collectors/css.js';
+import { join, relative } from 'path';
 const CSS_MIME = mimeLookup('.css');
-export default function defaultAssetTransformer(options) {
+export default function defaultAssetTransformer(_options, lwrGlobalContext) {
+    const { assetRegistry } = lwrGlobalContext;
     return {
-        name: 'default-asset-transformer',
-        async extractMetadata(code, assetSource) {
+        name: 'lwr-default-asset-transformer',
+        /**
+         * Asset url normalization
+         */
+        async transformUri(assetUri, assetDef, runtimeEnvironment) {
+            const { entry, uri: existingUri } = assetUri;
+            const { type, ownHash } = assetDef;
+            const { apiVersion, immutableAssets, basePath } = runtimeEnvironment;
+            const immutable = immutableAssets ? 'immutable/' : '';
+            const hash = immutableAssets ? ownHash : 'latest';
+            const relativePath = basePath ? relative(basePath, existingUri) : existingUri;
+            const uri = join(`${basePath}/${apiVersion}/${type}/${immutable}s/${hash}`, encodeURI(relativePath));
+            logger.debug(`[${this.name}] normalized url ${entry} -> ${uri}`);
+            return {
+                ...assetUri,
+                uri,
+                entry,
+                external: assetDef.type === 'external',
+                immutable: !!immutableAssets,
+            };
+        },
+        /**
+         * Transforms CSS.  Inserts relative links
+         */
+        async transformSource(assetSource, runtimeEnvironment) {
             if (assetSource.mime === CSS_MIME) {
+                logger.debug(`[${this.name}] extract metadata ${assetSource.entry}`);
+                const code = assetSource.content('utf-8');
                 const metadata = await linkCss(code.toString(), assetSource.entry);
-                return { metadata };
+                const linkedAsset = await linkAsset(code, {
+                    ...assetSource,
+                    metadata,
+                }, runtimeEnvironment, assetRegistry.resolveAssetUri);
+                return {
+                    source: linkedAsset,
+                    metadata,
+                };
             }
+            // Source not modified move on
+            return undefined;
         },
     };
 }
+async function linkAsset(source, assetSource, runtimeEnvironment, resolveUri) {
+    const assetReferences = assetSource.metadata?.assetReferences;
+    if (Buffer.isBuffer(source) || !assetReferences || assetReferences.length === 0) {
+        return source;
+    }
+    const codeStringBuilder = createStringBuilder(source);
+    const importer = assetSource.entry;
+    for (const assetRef of assetReferences) {
+        const { url, relative, location: { startOffset, endOffset }, } = assetRef;
+        // Only override relative assets
+        if (relative) {
+            try {
+                // eslint-disable-next-line no-await-in-loop
+                assetRef.override = await resolveUri({ specifier: url, importer }, runtimeEnvironment);
+                const overrideUrl = assetRef.override?.uri;
+                codeStringBuilder.overwrite(startOffset, endOffset, overrideUrl || url);
+            }
+            catch (err) {
+                // Just logging a waring if the user cannot resolve a linked asset reference to not disrupt other linking
+                logger.warn(`Failed to resolve reference '${url}' in asset '${importer}'`);
+            }
+        }
+    }
+    return codeStringBuilder.toString();
+}
 //# sourceMappingURL=index.js.map

package/package.json

@@ -4,7 +4,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.10.0-alpha.8",
+    "version": "0.10.0",
     "homepage": "https://developer.salesforce.com/docs/platform/lwr/overview",
     "repository": {
         "type": "git",
@@ -22,6 +22,10 @@
         ".": {
             "import": "./build/es/index.js",
             "require": "./build/cjs/index.cjs"
+        },
+        "./legacy": {
+            "import": "./build/es/legacy.js",
+            "require": "./build/cjs/legacy.cjs"
         }
     },
     "files": [
@@ -29,16 +33,27 @@
         "build/**/*.cjs",
         "build/**/*.d.ts"
     ],
+    "scripts": {
+        "build": "tsc -b",
+        "clean": "rm -rf build node_modules",
+        "test": "jest"
+    },
     "dependencies": {
-        "@lwrjs/shared-utils": "0.10.0-alpha.8",
+        "@lwrjs/shared-utils": "0.10.0",
+        "fs-extra": "^11.1.1",
         "postcss": "^8.4.23",
         "postcss-value-parser": "^4.2.0"
     },
     "devDependencies": {
-        "@lwrjs/types": "0.10.0-alpha.8"
+        "@lwrjs/types": "0.10.0",
+        "jest": "^26.6.3",
+        "ts-jest": "^26.5.6"
     },
     "engines": {
-        "node": ">=16.0.0 <20"
+        "node": ">=16.0.0"
+    },
+    "volta": {
+        "extends": "../../../package.json"
     },
-    "gitHead": "46bd72343e1db7c72470033320921df3a7eff18a"
+    "gitHead": "e6deaeef3db8aa079acefed508897eca19b3218a"
 }