@plaudit/webpack-extensions 2.76.2 → 2.78.0

package/README.md

@@ -23,58 +23,7 @@ This suite generates loader code that uses the most efficient mechanisms availab
 The same file structure (both in the webpack.config.js file and the actual directory tree) can be used in plugins and themes.
 
 # Usage
-## An Example Config
-NOTE: This config assumes that `require_once __DIR__.'/dist/unified-loader.php';` has been added to the theme's functions.php file or the plugin's main PHP file
-
-```javascript
-module.exports = require("@plaudit/webpack-extensions/wordpress-scripts-wrapper")({
-	src: {
-		"blocks": true, // By default, a directory is assumed to contain WordPress blocks, so we don't need to do anything other than tell WebPack to include it
-		"extensions": { // Extensions need to have their directory layout specified, but the loader is automatically generated, so there's no need to specify an output path
-			directoryLayout: 'extensions'
-		},
-		"site/index-header.ts": { // "Plain" entrypoints (i.e. those not associated with a block or extension) can have their usage locations specified, at which point they will also be automatically loaded
-			locations: {
-				clientView: true,
-				registerScriptArgs: false
-			}
-		},
-		"site/index-footer.ts": {
-			withLegacyBlocksIn: "blocks",
-			locations: {
-				clientView: true,
-				registerScriptArgs: {strategy: "defer", in_footer: true}
-			}
-		},
-		"site/wp-admin.ts": {
-			locations: {
-				admin: true
-			}
-		},
-		"site/wp-admin.pcss": {
-			locations: {
-				admin: true
-			}
-		},
-		"site/block-editor.pcss": {
-			locations: {
-				clientEditor: true
-			}
-		},
-		"site/public.pcss": {
-			locations: {
-				clientView: true
-			}
-		}
-	},
-	useWebpackResourceFiltering: true,
-	extensionsVersion: 2,
-	plainEntrypointsVersion: 2,
-	srcDir: "src",
-	outputDir: "dist",
-	useUnifiedLoader: true
-});
-```
+Check out the [User Guide](USER-GUIDE.md) file.
 
 # Development
 

package/build/plugins/PlainEntrypointsConfigFileGeneratorPlugin.d.ts

@@ -1,4 +1,4 @@
-import { BlockEntrypointInfo, UsageLocations, ParsedAssetJsonProvider } from "../shared";
+import { BlockEntrypointInfo, ParsedAssetJsonProvider, NormalizedUsageLocations } from "../shared";
 import type { VerifiedPlauditWordpressWebpackConfig } from "../utils/common-config-helpers";
 import { AbstractBiPhasicGroupAndEntryPlugin, EntryProvider } from "./AbstractBiPhasicGroupAndEntryPlugin";
 import { Compilation } from "webpack";
@@ -8,7 +8,7 @@ export declare class PlainEntrypointsConfigFileGeneratorPlugin extends AbstractB
     private readonly usageLocations;
     private readonly useUnifiedLoader;
     private static readonly semaphore;
-    constructor(config: VerifiedPlauditWordpressWebpackConfig, buildRoot: string, outputDir: string, usageLocations: UsageLocations, useUnifiedLoader: boolean, context: string, entry: EntryProvider<BlockEntrypointInfo>);
+    constructor(config: VerifiedPlauditWordpressWebpackConfig, buildRoot: string, outputDir: string, usageLocations: NormalizedUsageLocations, useUnifiedLoader: boolean, context: string, entry: EntryProvider<BlockEntrypointInfo>);
     private generatePlainEntrypointsLoader;
     private static addHandlesToHandleLists;
     private static appendEnqueuingHandleLists;

package/build/plugins/UnifiedLoaderGenerator.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnifiedLoaderGenerator = void 0;
 const node_path_1 = __importDefault(require("node:path"));
 const php_writer_1 = require("@plaudit/php-writer");
+const expressions_1 = require("@plaudit/php-writer/expressions");
 const AbstractBiPhasicGroupPlugin_1 = require("./AbstractBiPhasicGroupPlugin");
 const shared_1 = require("../shared");
 const pseduo_semaphore_1 = require("../utils/pseduo-semaphore");
@@ -59,6 +60,17 @@ class UnifiedLoaderGenerator extends AbstractBiPhasicGroupPlugin_1.AbstractBiPha
             if (this.config.useUnifiedLoader) {
                 compilation.hooks.afterProcessAssets.tap(this.constructor.name, () => {
                     const writer = new php_writer_1.PHPWriter();
+                    if (compilation.outputOptions.path?.endsWith("-dev")) {
+                        compilation['.gitignore' in compilation.assets ? 'updateAsset' : 'emitAsset']('.gitignore', new webpack_1.sources.RawSource('**'), { size: 2 });
+                    }
+                    else {
+                        const devLoaderPath = expressions_1.Op.concat(expressions_1.Constants.__DIR__, '-dev/unified-loader.php');
+                        writer
+                            .if(expressions_1.Op.binary(expressions_1.Op.binary(expressions_1.Expr.call('wp_get_environment_type', []), ' === ', 'development'), ' && ', expressions_1.Expr.call('file_exists', [devLoaderPath])))
+                            .require(devLoaderPath, { once: true })
+                            .append("return;")
+                            .endIf();
+                    }
                     if (groupedLoaderInfo.some(wc => wc.requiresBaseURI)) {
                         (0, shared_1.emitResolveBaseUriFunction)(writer);
                     }

package/build/plugins/dependency-extraction-webpack-plugin-config-builder.js

@@ -98,6 +98,12 @@ function plauditRequestToExternal(ext) {
         else if (request.startsWith('@plaudit/gutenberg-api-extensions')) {
             return handleExternalizingEqualsPossibleExternal({ import: ['plaudit', 'gutenbergApiExtensions'], handle: "" }, ext)?.import;
         }
+        else if (request.startsWith('@plaudit/wp-consent-api')) {
+            return handleExternalizingEqualsPossibleExternal({ import: ['plaudit'], handle: "" }, ext)?.import;
+        }
+        else if (request.startsWith('@plaudit/analytics-integrations-api')) {
+            return handleExternalizingEqualsPossibleExternal({ import: ['plaudit', 'analyticsIntegrations', 'api'], handle: "" }, ext)?.import;
+        }
         return undefined;
     };
 }
@@ -108,6 +114,12 @@ function plauditRequestToHandle(request) {
     else if (request.startsWith('@plaudit/gutenberg-api-extensions')) {
         return 'plaudit-gutenberg-api-extensions';
     }
+    else if (request.startsWith('@plaudit/wp-consent-api')) {
+        return 'wp-consent-api';
+    }
+    else if (request.startsWith('@plaudit/analytics-integrations-api')) {
+        return 'plaudit/analytics-integrations/api';
+    }
     return undefined;
 }
 function curryRequestHandlers(primary, secondary) {

package/build/shared.d.ts

@@ -45,8 +45,12 @@ export type UsageLocations = {
 } & {
     register?: boolean | number;
     handle?: string | ((generatedHandle: string) => string);
+    registerScriptArgs?: ScriptArgsObject | boolean | 'lazy';
+};
+export type NormalizedUsageLocations = Omit<UsageLocations, 'registerScriptArgs'> & {
     registerScriptArgs?: ScriptArgsObject | boolean;
 };
+export declare function isNormalizedUsageLocations(usageLocations: UsageLocations): usageLocations is NormalizedUsageLocations;
 export declare function constantKeys<K extends string, V>(object: {
     [k in K]: V;
 }): K[];
@@ -79,7 +83,7 @@ export type AdvancedOutputConfig = {
 };
 type OptionalCfgFields = 'directoryLayout' | 'externalize' | 'lazyLoader';
 export type VerifiedAdvancedOutputConfig = Required<Omit<AdvancedOutputConfig, 'locations' | OptionalCfgFields>> & Pick<AdvancedOutputConfig, OptionalCfgFields> & {
-    locations: UsageLocations;
+    locations: NormalizedUsageLocations;
 };
 export type SourcesObject = Record<string, string | AdvancedOutputConfig | boolean>;
 export type PlauditWordpressWebpackConfig = {
@@ -126,8 +130,8 @@ export type MinimumViableMetadata = {
 };
 export declare function convertUsageLocationsHandleToEmittableHandle(handle: UsageLocations['handle'], generatedHandle: string): string;
 export declare function makeEmittableConfigPHP(data: any, asFullFile: boolean, parentIndent?: string): string;
-export type EntrypointFields = ["viewScriptModule", "scriptModule"] | ["editorStyle", "viewStyle", "style", "editorScript", "viewScript", "script"];
-export declare const entrypointFields: ReadonlyArray<EntrypointFields[number]>;
+export declare const entrypointFields: readonly ["editorStyle", "viewStyle", "style", "editorScript", "viewScript", "script", "viewScriptModule", "scriptModule"];
+export type EntrypointFields = (typeof entrypointFields[number])[];
 export declare function convertEntrypointFieldForAssetType(entrypointField: EntrypointFields[number], assetType: 'script' | 'style'): EntrypointFields[number];
 export declare function leadingSlashIt(pathOrSomething: string): string;
 export declare const scriptExtension: RegExp;

package/build/shared.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.styleExtension = exports.scriptWithModuleExtension = exports.scriptWithoutModuleExtension = exports.scriptExtension = exports.entrypointFields = exports.standardLocationNamesMeta = void 0;
 exports.isParsedAssetsJson = isParsedAssetsJson;
+exports.isNormalizedUsageLocations = isNormalizedUsageLocations;
 exports.constantKeys = constantKeys;
 exports.constantEntries = constantEntries;
 exports.determineCurrentSourceType = determineCurrentSourceType;
@@ -52,6 +53,9 @@ exports.standardLocationNamesMeta = {
     admin: { action: "admin_enqueue_scripts" }, login: { action: "login_enqueue_scripts" }, customizer: { action: "customize_controls_enqueue_scripts" },
     analytics: { action: "plaudit_enqueue_analytics" }
 };
+function isNormalizedUsageLocations(usageLocations) {
+    return typeof usageLocations.registerScriptArgs !== 'string';
+}
 function constantKeys(object) {
     return Object.keys(object);
 }
@@ -85,9 +89,7 @@ function makeEmittableConfigPHP(data, asFullFile, parentIndent = "") {
         .replaceAll(/'rest' => \[\n\t+(\[(?:'[^']+')?]),\n\t+('[^']+')(?:,\n\t+(\[[^\n]+]))?\n\t+]/gs, (_, deps, hash, args) => `'rest' => [${[deps, hash, args].filter(value => !!value).join(", ")}]`);
     return asFullFile ? `<?php return ${prettyPrintedMetadata};` : prettyPrintedMetadata.trim();
 }
-exports.entrypointFields = [
-    "editorStyle", "viewStyle", "style", "editorScript", "viewScript", "script", "viewScriptModule", "scriptModule"
-];
+exports.entrypointFields = ["editorStyle", "viewStyle", "style", "editorScript", "viewScript", "script", "viewScriptModule", "scriptModule"];
 function convertEntrypointFieldForAssetType(entrypointField, assetType) {
     // Using these word fragments instead of the full words allows us to avoid having to deal with the capitalization of the first letter
     const searchRep = assetType === 'script' ? ['tyle', 'cript'] : ['cript', 'tyle'];

package/build/wordpress-scripts-wrapper.js

@@ -157,7 +157,11 @@ function injectSupportForInliningSVGsAsStrings(rules) {
     });
 }
 function buildVerifiedConfig(config) {
-    const { standaloneBlocks = false, stats = 'errors-warnings', variables: rawVariables, verbose = process.argv.includes('--verbose') || process.env['VERBOSE'] === 'true', postcss = {}, externals, assumeGlobalizedPlauditLibraries = true, processTranslationConfigs = true, combineAssetMetadata = true, useWebpackResourceFiltering = true, outputDir = "", plainEntrypointsVersion = 1, srcDir = "", useUnifiedLoader = false, includePostInitFallback = false } = config;
+    const { standaloneBlocks = false, stats = 'errors-warnings', variables: rawVariables, verbose = process.argv.includes('--verbose') || process.env['VERBOSE'] === 'true', postcss = {}, externals, assumeGlobalizedPlauditLibraries = true, processTranslationConfigs = true, combineAssetMetadata = true, useWebpackResourceFiltering = true, plainEntrypointsVersion = 1, srcDir = "", useUnifiedLoader = false, includePostInitFallback = false } = config;
+    let outputDir = config.outputDir ?? "";
+    if (outputDir && useUnifiedLoader && (process.env['SERVER_MODE'] ?? 'development') === 'development') {
+        outputDir += "-dev";
+    }
     let srcPrefixes;
     const trailingSlashedSrcDir = srcDir && !srcDir.endsWith("/") ? srcDir + "/" : srcDir;
     if (config.srcPrefixes === undefined) {
@@ -214,15 +218,25 @@ function buildVerifiedConfig(config) {
         const normalizedParts = { additionalDependencies, assumeGlobalizedPlauditLibraries, bundleAnalyzer, directoryLayout, externalize, withLegacyBlocksIn, lazyLoader };
         const locations = typeof rawSource[1].locations === 'string' || typeof rawSource[1].locations === 'function'
             ? { handle: rawSource[1].locations } : rawSource[1].locations ?? {};
+        let normalizedLocations;
+        if ((0, shared_1.isNormalizedUsageLocations)(locations)) {
+            normalizedLocations = locations;
+        }
+        else if (locations.registerScriptArgs === 'lazy') {
+            normalizedLocations = { ...locations, registerScriptArgs: { strategy: 'defer', in_footer: true } };
+        }
+        else {
+            throw new ReferenceError("The only supported string value for registerScript args is 'lazy'");
+        }
         if (destination !== undefined) {
             const effectiveDestination = toEffectiveWebpackDestination(destination);
             allocatedDestinations[effectiveDestination] = rawSource[0]; // We need to pre-populate the allocatedDestinations map with statically-declared destinations
-            return [rawSource[0], { ...normalizedParts, locations, destination, effectiveDestination, staticallyDeclaredDestination: true }];
+            return [rawSource[0], { ...normalizedParts, locations: normalizedLocations, destination, effectiveDestination, staticallyDeclaredDestination: true }];
         }
         else {
             const naiveDestination = deriveNaiveDestinationFromUnverifiedSourceEntry(rawSource, srcPrefixes);
             const effectiveDestination = toEffectiveWebpackDestination(naiveDestination);
-            return [rawSource[0], { ...normalizedParts, locations, destination: naiveDestination, effectiveDestination, staticallyDeclaredDestination: false }];
+            return [rawSource[0], { ...normalizedParts, locations: normalizedLocations, destination: naiveDestination, effectiveDestination, staticallyDeclaredDestination: false }];
         }
     });
     const dynamicEffectiveDestinationsWithExpectedNaiveDuplicates = partiallyVerifiedSources

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plaudit/webpack-extensions",
-  "version": "2.76.2",
+  "version": "2.78.0",
   "license": "SEE LICENSE IN LICENSE.md",
   "files": [
     "/build"
@@ -20,9 +20,9 @@
     }
   },
   "devDependencies": {
-    "@plaudit/gutenberg-api-extensions": "^2.80.1",
+    "@plaudit/gutenberg-api-extensions": "^2.81.0",
     "@types/browser-sync-webpack-plugin": "^2.2.5",
-    "@types/node": "^24.10.1",
+    "@types/node": "^24.10.4",
     "@types/postcss-functions": "^4.0.4",
     "@types/tapable": "^2.3.0",
     "@types/webpack": "^5.28.5",
@@ -41,7 +41,7 @@
     "@plaudit/postcss-variables": "^1.1.0",
     "@wordpress/dependency-extraction-webpack-plugin": "^6.36.0",
     "@wordpress/scripts": "^30.27.0",
-    "autoprefixer": "^10.4.22",
+    "autoprefixer": "^10.4.23",
     "browser-sync": "^3.0.4",
     "copy-webpack-plugin": "10.2.4",
     "cssnano": "^6.1.2",
@@ -61,7 +61,7 @@
     "postcss-reporter": "^7.1.0",
     "postcss-simple-vars": "^7.0.1",
     "postcss-url": "^10.1.3",
-    "webpack": "^5.103.0",
+    "webpack": "^5.104.0",
     "webpack-remove-empty-scripts": "^1.1.1",
     "xml-formatter": "^3.6.7"
   },