@plaudit/webpack-extensions 2.32.0 → 2.34.0

package/build/wordpress-scripts-wrapper/BlockJSONManagingPlugin.d.ts

@@ -2,7 +2,7 @@ import { type Compilation, type Compiler, type WebpackPluginInstance } from "web
 export default class BlockJSONManagingPlugin implements WebpackPluginInstance {
     private readonly standaloneBlocks;
     private readonly processingModules;
-    private static readonly sourceToOutputMappingCache;
+    private static readonly mappableKeys;
     private static readonly blockJsonToEntrypointsMap;
     private static readonly blockJsonRawDependenciesMap;
     private static readonly blockJSONAssetSourceDirs;
@@ -13,6 +13,9 @@ export default class BlockJSONManagingPlugin implements WebpackPluginInstance {
     static resolveDestinationBySourceExtension(srcPath: string, entrypoint: Compilation['asyncEntrypoints'][number]): string | undefined;
     static findCommonAncestor(...paths: string[]): string[];
     static findRelativeRouteBetween(path1: string, path2: string): string;
+    private static remapReferencedPHPFilesOnKey;
     private static hashThingForAsset;
     private static stripFilePrefix;
+    private static incorporateRemappedValue;
+    private static deriveAdditionalFilesMappableKey;
 }

package/build/wordpress-scripts-wrapper/BlockJSONManagingPlugin.js

@@ -11,7 +11,9 @@ const php_serializer_1 = __importDefault(require("./php-serializer"));
 class BlockJSONManagingPlugin {
     standaloneBlocks;
     processingModules;
-    static sourceToOutputMappingCache = new Map();
+    static mappableKeys = [
+        "editorStyle", "style", "viewStyle", "editorScript", "script", "viewScript", "viewScriptModule", "scriptModule"
+    ];
     static blockJsonToEntrypointsMap = new Map();
     static blockJsonRawDependenciesMap = new Map();
     static blockJSONAssetSourceDirs = new Map();
@@ -51,13 +53,20 @@ class BlockJSONManagingPlugin {
                             if (!destPath) {
                                 continue;
                             }
-                            const entryMeta = { hash: entrypoint.getEntrypointChunk().hash ?? destPath, path: destPath };
+                            const entrypointChunk = entrypoint.getEntrypointChunk();
+                            const additionalFiles = [];
+                            for (const entrypointChunkFile of entrypointChunk.files) {
+                                if (!entrypointChunkFile.endsWith(".asset.php") && entrypointChunkFile !== destPath) {
+                                    additionalFiles.push(entrypointChunkFile);
+                                }
+                            }
+                            const entryMeta = { hash: entrypointChunk.hash ?? destPath, path: destPath };
                             const currentEntrypoints = BlockJSONManagingPlugin.blockJsonToEntrypointsMap.get(name);
                             if (currentEntrypoints) {
-                                currentEntrypoints.set(srcPath, entryMeta);
+                                currentEntrypoints.set(srcPath, [entryMeta, additionalFiles]);
                             }
                             else {
-                                BlockJSONManagingPlugin.blockJsonToEntrypointsMap.set(name, new Map([[srcPath, entryMeta]]));
+                                BlockJSONManagingPlugin.blockJsonToEntrypointsMap.set(name, new Map([[srcPath, [entryMeta, additionalFiles]]]));
                             }
                         }
                     }
@@ -70,25 +79,20 @@ class BlockJSONManagingPlugin {
                     return;
                 }
                 const blockDirConfigData = {};
-                const mappableKeys = ["editorStyle", "style", "viewStyle", "viewScript", "script", "editorScript", "viewScriptModule", "scriptModule"];
                 const remapValue = (value, name) => {
                     if (value.startsWith("file:")) {
-                        let res = BlockJSONManagingPlugin.sourceToOutputMappingCache.get(`${name};${value}`);
-                        if (res !== undefined) {
-                            return res;
-                        }
                         const sourceDir = BlockJSONManagingPlugin.blockJSONAssetSourceDirs.get(name) ?? node_path_1.default.dirname(name);
                         const inputPath = node_path_1.default.normalize(node_path_1.default.join(sourceDir, value.substring(5)));
-                        const output = BlockJSONManagingPlugin.blockJsonToEntrypointsMap.get(name)?.get(inputPath);
-                        if (output !== undefined) {
+                        const outputAndAdditionalFiles = BlockJSONManagingPlugin.blockJsonToEntrypointsMap.get(name)?.get(inputPath);
+                        if (outputAndAdditionalFiles !== undefined) {
+                            const [output, additionalFiles] = outputAndAdditionalFiles;
                             const prefix = value.startsWith("./", 5) ? "./" : "";
                             const relativePath = node_path_1.default.relative(node_path_1.default.dirname(name), output.path);
                             const res = [`file:${prefix}${relativePath}`, output.hash];
-                            BlockJSONManagingPlugin.sourceToOutputMappingCache.set(`${name};${value}`, res);
-                            return res;
+                            return [res, additionalFiles.map(additionalFile => `file:./${node_path_1.default.relative(node_path_1.default.dirname(name), additionalFile)}`)];
                         }
                     }
-                    return [value, ""];
+                    return [[value, ""], []];
                 };
                 for (const [name, sourceDir] of currentBlockJSONAssets) {
                     const assetContents = compilation.assets[name]?.buffer().toString();
@@ -98,21 +102,27 @@ class BlockJSONManagingPlugin {
                     blockDirConfigData[name] = true;
                     const json = JSON.parse(assetContents);
                     let compositeHash = "";
-                    for (const mappableKey of mappableKeys) {
+                    const tempMappedKeys = {};
+                    for (const mappableKey of BlockJSONManagingPlugin.mappableKeys) {
                         if (mappableKey in json) {
                             const unmappedValue = json[mappableKey];
                             if (Array.isArray(unmappedValue)) {
-                                const remappedValue = unmappedValue.map(value => remapValue(value, name));
-                                json[mappableKey] = remappedValue.map(([resource]) => resource);
-                                compositeHash += "~" + remappedValue.map(([_, hash]) => hash).join("~");
+                                for (const uv of unmappedValue) {
+                                    const [remappedValue, additionalValues] = remapValue(uv, name);
+                                    BlockJSONManagingPlugin.incorporateRemappedValue(tempMappedKeys, mappableKey, remappedValue[0], additionalValues);
+                                    compositeHash += "~" + remappedValue[1];
+                                }
                             }
                             else if (typeof unmappedValue === 'string') {
-                                const remappedValue = remapValue(unmappedValue, name);
-                                json[mappableKey] = remappedValue[0];
+                                const [remappedValue, additionalValues] = remapValue(unmappedValue, name);
+                                BlockJSONManagingPlugin.incorporateRemappedValue(tempMappedKeys, mappableKey, remappedValue[0], additionalValues);
                                 compositeHash += "~" + remappedValue[1];
                             }
                         }
                     }
+                    for (const [mappableKey, mappedValue] of Object.entries(tempMappedKeys)) {
+                        json[mappableKey] = mappedValue;
+                    }
                     if (json["version"]) {
                         json["version"] = `${json["version"]}-${BlockJSONManagingPlugin.hashThingForAsset(compositeHash)}`;
                     }
@@ -121,32 +131,8 @@ class BlockJSONManagingPlugin {
                     }
                     const outputDir = node_path_1.default.join(compiler.outputPath, node_path_1.default.dirname(name));
                     const pathsNeedRemapping = !this.standaloneBlocks && json["plaudit"] !== "simple";
-                    const rawSetupFiles = json["plaudit"]?.["setup"]
-                        ? (typeof json["plaudit"]["setup"] === 'string' ? [json["plaudit"]["setup"]] : json["plaudit"]["setup"])
-                        : ["setup.php"];
-                    const setupFiles = pathsNeedRemapping
-                        ? rawSetupFiles
-                            .map(p => node_path_1.default.normalize(node_path_1.default.join(sourceDir, BlockJSONManagingPlugin.stripFilePrefix(p))))
-                            .filter(p => node_fs_1.default.existsSync(p))
-                            .map(p => `file:./${BlockJSONManagingPlugin.findRelativeRouteBetween(outputDir, p)}`)
-                        : rawSetupFiles
-                            .filter(p => node_fs_1.default.existsSync(node_path_1.default.normalize(node_path_1.default.join(sourceDir, BlockJSONManagingPlugin.stripFilePrefix(p)))));
-                    if (setupFiles.length === 0) {
-                        if (json["plaudit"]?.["setup"] !== undefined) {
-                            delete json["plaudit"]["setup"];
-                        }
-                    }
-                    else {
-                        if (typeof json["plaudit"] !== 'object') {
-                            if (json["plaudit"] === "native") {
-                                json["plaudit"] = { type: "native" };
-                            }
-                            else {
-                                json["plaudit"] = {};
-                            }
-                        }
-                        json["plaudit"]["setup"] = setupFiles.length === 1 ? setupFiles[0] : setupFiles;
-                    }
+                    BlockJSONManagingPlugin.remapReferencedPHPFilesOnKey(json, "setup", pathsNeedRemapping, sourceDir, outputDir, compilation, true);
+                    BlockJSONManagingPlugin.remapReferencedPHPFilesOnKey(json, "variations", pathsNeedRemapping, sourceDir, outputDir, compilation, false);
                     if (json["acf"]) {
                         if (json["acf"]["renderTemplate"]) {
                             json["render_template"] = json["acf"]["renderTemplate"];
@@ -232,11 +218,108 @@ class BlockJSONManagingPlugin {
         route.push(node_path_1.default.relative(commonAncestor.join(node_path_1.default.sep), path2));
         return route.join(node_path_1.default.sep);
     }
+    static remapReferencedPHPFilesOnKey(json, key, pathsNeedRemapping, sourceDir, outputDir, compilation, inPlaudit) {
+        const rawValue = (inPlaudit ? json["plaudit"] : json)?.[key];
+        let rawFiles;
+        let deleteOnEmpty = true;
+        if (typeof rawValue === 'string') {
+            rawFiles = [rawValue];
+        }
+        else if (Array.isArray(rawValue) && rawValue.length > 0) {
+            const fileReferences = rawValue.filter((value) => typeof value === 'string' && value.startsWith("file:./"));
+            if (fileReferences.length === rawValue.length) {
+                rawFiles = fileReferences;
+            }
+            else {
+                if (fileReferences.length !== 0) {
+                    const error = new webpack_1.WebpackError(`Encountered a block with a mixture of file-reference and non-file-reference elements in the "${inPlaudit ? 'plaudit.' : ''}${key}" property`);
+                    error.file = node_path_1.default.join(sourceDir, 'block.json');
+                    compilation.warnings.push(error);
+                    rawFiles = fileReferences;
+                }
+                else {
+                    rawFiles = [`${key}.php`]; // We want to emit an error if both an appropriately-named file AND an incompatible value exist, so we still need to do the check
+                }
+                deleteOnEmpty = false;
+            }
+        }
+        else {
+            if (rawValue && (!Array.isArray(rawValue) || rawValue.length === 0)) {
+                deleteOnEmpty = false;
+            }
+            rawFiles = [`${key}.php`];
+        }
+        const mappedFiles = pathsNeedRemapping
+            ? rawFiles
+                .map(p => node_path_1.default.normalize(node_path_1.default.join(sourceDir, BlockJSONManagingPlugin.stripFilePrefix(p))))
+                .filter(p => node_fs_1.default.existsSync(p))
+                .map(p => `file:./${BlockJSONManagingPlugin.findRelativeRouteBetween(outputDir, p)}`)
+            : rawFiles
+                .filter(p => node_fs_1.default.existsSync(node_path_1.default.normalize(node_path_1.default.join(sourceDir, BlockJSONManagingPlugin.stripFilePrefix(p)))));
+        if (mappedFiles.length === 0) {
+            if (deleteOnEmpty && rawValue !== undefined) {
+                delete (inPlaudit ? json["plaudit"] : json)[key];
+            }
+        }
+        else {
+            if (inPlaudit && typeof json["plaudit"] !== 'object') {
+                if (json["plaudit"] === "native") {
+                    json["plaudit"] = { type: "native" };
+                }
+                else {
+                    json["plaudit"] = {};
+                }
+            }
+            (inPlaudit ? json["plaudit"] : json)[key] = mappedFiles.length === 1 ? mappedFiles[0] : mappedFiles;
+        }
+    }
     static hashThingForAsset(thing) {
         return node_crypto_1.default.createHash('md5').update(thing).digest("hex").substring(0, 20).toLowerCase();
     }
     static stripFilePrefix(file) {
         return file.startsWith("file:./") ? file.substring(7) : file;
     }
+    static incorporateRemappedValue(mappedKeys, mappableKey, remappedValue, additionalValues) {
+        if (typeof mappedKeys[mappableKey] === 'string') {
+            mappedKeys[mappableKey] = [mappedKeys[mappableKey], remappedValue];
+        }
+        else if (Array.isArray(mappedKeys[mappableKey])) {
+            mappedKeys[mappableKey].push(remappedValue);
+        }
+        else {
+            mappedKeys[mappableKey] = remappedValue;
+        }
+        if (additionalValues.length) {
+            const additionalValuesMappableKey = BlockJSONManagingPlugin.deriveAdditionalFilesMappableKey(mappableKey);
+            if (typeof mappedKeys[additionalValuesMappableKey] === 'string') {
+                mappedKeys[additionalValuesMappableKey] = [mappedKeys[additionalValuesMappableKey], ...additionalValues];
+            }
+            else if (Array.isArray(mappedKeys[additionalValuesMappableKey])) {
+                mappedKeys[additionalValuesMappableKey].push(...additionalValues);
+            }
+            else {
+                mappedKeys[additionalValuesMappableKey] = additionalValues;
+            }
+        }
+    }
+    static deriveAdditionalFilesMappableKey(mappableKey) {
+        let value;
+        if (mappableKey.endsWith("tyle")) { // If the original file was a stylesheet, then any additional files will be imported via the script tags
+            value = this.mappableKeys[this.mappableKeys.indexOf(mappableKey) + 3];
+        }
+        else if (mappableKey.endsWith("cript")) { // If the original file was a script, then any additional files will be imported via the style tags
+            value = this.mappableKeys[this.mappableKeys.indexOf(mappableKey) - 3];
+        }
+        else if (mappableKey === "viewScriptModule") {
+            return "viewStyle";
+        }
+        else if (mappableKey === "scriptModule") {
+            return "style";
+        }
+        if (value === undefined) {
+            throw new webpack_1.WebpackError(`Encountered a mappable key (${mappableKey}) that has additional files but no valid mapping for them`);
+        }
+        return value;
+    }
 }
 exports.default = BlockJSONManagingPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plaudit/webpack-extensions",
-  "version": "2.32.0",
+  "version": "2.34.0",
   "scripts": {
     "prepublishOnly": "rm -rf build && mkdir build && tsc",
     "build": "tsc",