@plaudit/webpack-extensions 3.21.2 → 4.0.0

package/dist/api/entries/identifiers.d.ts

@@ -0,0 +1,84 @@
+import type { DelegateContext, VerifiedAdvancedDestinationConfig } from "../shared-types";
+import type { HandleConfig } from "./dependencies";
+import { type NormalizedEnqueuingControlFlags } from "./flag-logic";
+import { type EnqueuedAssetType, type NormalizedUsageLocations, type UsageLocations } from "./locations";
+export declare const DEFAULT_WP_HOOK_PRIORITY = 10;
+export type ProcessedEntrypointIdentifier = Readonly<{
+    filePath: string;
+    flags: NormalizedEnqueuingControlFlags;
+    handleConfig?: HandleConfig;
+    locations: NormalizedUsageLocations;
+    /**
+     * This is only used to communicate what the niceName *could have been* to allow for nicer default handleSuffix values
+     */
+    niceName?: string;
+    type: EnqueuedAssetType;
+    /**
+     * TODO: Maybe remove - we can probably get away with just signalling that there wasn't an explicitly-set niceName
+     * These are used later on in the process to allow us to have nicer deduplicated handles
+     */
+    orderedLocationSpecifiers: string[];
+    orderedLocationNameAndFlagSpecifiers: string[];
+}>;
+type PEIDirVersion = Omit<ProcessedEntrypointIdentifier, 'type'> & {
+    type: false;
+};
+type ConfigFlags = {
+    /**
+     * Tells the function to return the parsed entrypoint even if there aren't any location-encoding parts
+     */
+    assumePreEncodedLocations?: boolean;
+    /**
+     * This is provided to allow parsing of config directories. It skips tokenizing the identifier name and only concerns itself with a potential query
+     */
+    allowDirectories?: boolean;
+};
+type ExistingConfig = Partial<Pick<VerifiedAdvancedDestinationConfig, 'locations' | 'flags' | 'handle'>>;
+/**
+ * Parses the given filename according to the following spec:
+ * <ul>
+ *     <li>The filename is a dot-separated series of segments</li>
+ *     <li>
+ *         The first and last segments are treated specially
+ *         <ul>
+ *             <li>The last segment is the extension, and is used to determine the type of the file ('script', 'style', or 'script-module')</li>
+ *             <li>The first segment can be suffixed with or be equal to a specific type name ('script'|'style'|'script-module'), in which case, the type detected from the extension will be overridden with it and the "override" will be removed from the name segment in further processing</li>
+ *         </ul>
+ *     </li>
+ *     <li>
+ *         Segments can be either flags, locations, or modifiers
+ *         <ul>
+ *             <li>Flags are: 'in-footer', 'in-header', "strategy=('eager'|'lazy'|'defer'|'async')", 'lazy', 'eager', and "inline[=('before'|'after')]"</li>
+ *             <li>Locations are: the standard locations and their alternate names, 'both', and 'register'</li>
+ *             <li>Modifiers are: 'priority' and 'hook_name' (only available in the global and hook-name-supporting location name contexts respectively)</li>
+ *         </ul>
+ *     </li>
+ *     <li>Modifiers are always applied to the preceding location. If a location has not yet been specified in the name, the modifier's value is used as the default for any location that does not specify that modifier</li>
+ * </ul>
+ *
+ * @param rawIdentifier a string that identifies a file on disk. It may be prefixed with "file:" and may include a URL-style query
+ * @param existingConfig if there is a pre-existing config (i.e. from a webpack.config.js file) it should be passed here
+ * @param delegateContext contextual information used to communicate things that are determined by the current context within the webpack pipeline like error handling mechanisms
+ * @param configFlags any config flags
+ */
+export declare function parseEntrypointIdentifier(rawIdentifier: string, existingConfig: ExistingConfig | undefined, delegateContext?: DelegateContext, configFlags?: ConfigFlags): ProcessedEntrypointIdentifier | PEIDirVersion | undefined;
+type BlockEntrypointLocations = Pick<ProcessedEntrypointIdentifier['locations'], 'clientEditor' | 'clientView'>;
+export type ParseResultForBlock = Readonly<{
+    [K in keyof ProcessedEntrypointIdentifier]: K extends 'locations' ? BlockEntrypointLocations : ProcessedEntrypointIdentifier[K];
+}>;
+export declare function parseEntrypointIdentifierForBlock(filename: string, assumePreEncodedLocations: boolean, delegateContext?: DelegateContext, existingConfig?: ExistingConfig): ParseResultForBlock | undefined;
+/**
+ * This handles detecting all keys of standardLocationNamesMeta as well as the values listed in their associated alternate_names properties
+ * It MUST be kept in sync with standardLocationNamesMeta
+ * @param segment
+ */
+export declare function extractLocationFromPropertyEncodingFilenameSegment(segment: string): {
+    readonly locationName: false;
+    readonly priority?: undefined;
+} | {
+    readonly locationName: "admin" | "analytics" | "blockAssets" | "clientEditor" | "clientView" | "customizer" | "lazyLoader" | "login" | "register" | undefined;
+    readonly priority: number | true;
+};
+export declare function normalizeAndMergeUsageLocations(rawLocations: UsageLocations | undefined, computedLocations: NormalizedUsageLocations | undefined, file?: string): NormalizedUsageLocations;
+export {};
+//# sourceMappingURL=identifiers.d.ts.map

package/dist/api/entries/identifiers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifiers.d.ts","sourceRoot":"","sources":["../../../src/api/entries/identifiers.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,eAAe,EAAE,iCAAiC,EAAC,MAAM,iBAAiB,CAAC;AAExF,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAEN,KAAK,+BAA+B,EAEpC,MAAM,cAAc,CAAC;AACtB,OAAO,EACoC,KAAK,iBAAiB,EACM,KAAK,wBAAwB,EACxE,KAAK,cAAc,EAC9C,MAAM,aAAa,CAAC;AAIrB,eAAO,MAAM,wBAAwB,KAAK,CAAC;AAE3C,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAAC;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,+BAA+B,CAAC;IACvC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,SAAS,EAAE,wBAAwB,CAAC;IACpC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,iBAAiB,CAAC;IAExB;;;OAGG;IACH,yBAAyB,EAAE,MAAM,EAAE,CAAC;IACpC,oCAAoC,EAAE,MAAM,EAAE,CAAC;CAC/C,CAAC,CAAC;AACH,KAAK,aAAa,GAAG,IAAI,CAAC,6BAA6B,EAAE,MAAM,CAAC,GAAC;IAAC,IAAI,EAAE,KAAK,CAAA;CAAC,CAAC;AAM/E,KAAK,WAAW,GAAG;IAClB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAC;AAEF,KAAK,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,iCAAiC,EAAE,WAAW,GAAC,OAAO,GAAC,QAAQ,CAAC,CAAC,CAAC;AAErG;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,yBAAyB,CACxC,aAAa,EAAE,MAAM,EAAE,cAAc,EAAE,cAAc,GAAC,SAAS,EAAE,eAAe,GAAE,eAAoB,EAAE,WAAW,GAAE,WAAgB,GACnI,6BAA6B,GAAC,aAAa,GAAC,SAAS,CAkPvD;AAmLD,KAAK,wBAAwB,GAAG,IAAI,CAAC,6BAA6B,CAAC,WAAW,CAAC,EAAE,cAAc,GAAC,YAAY,CAAC,CAAC;AAC9G,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC;KAAE,CAAC,IAAI,MAAM,6BAA6B,GAAG,CAAC,SAAS,WAAW,GAAG,wBAAwB,GAAG,6BAA6B,CAAC,CAAC,CAAC;CAAC,CAAC,CAAC;AAG9K,wBAAgB,iCAAiC,CAChD,QAAQ,EAAE,MAAM,EAAE,yBAAyB,EAAE,OAAO,EAAE,eAAe,GAAE,eAAoB,EAAE,cAAc,CAAC,EAAE,cAAc,GAC1H,mBAAmB,GAAC,SAAS,CA0B/B;AAID;;;;GAIG;AACH,wBAAgB,kDAAkD,CAAC,OAAO,EAAE,MAAM;;;;;;EAgBjF;AAED,wBAAgB,+BAA+B,CAAC,YAAY,EAAE,cAAc,GAAC,SAAS,EAAE,iBAAiB,EAAE,wBAAwB,GAAC,SAAS,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,wBAAwB,CAgFtL"}