@plaudit/webpack-extensions 3.21.2 → 4.0.0

package/dist/shared.d.ts

@@ -1,14 +1,5 @@
-import { PHPFile, PHPWriter } from "@plaudit/php-writer";
-import { HereOrNowDoc } from "@plaudit/php-writer/expressions";
-import type { Options as PostcssFunctionsOptions } from "postcss-functions";
-import { type AssetInfo, type Compilation, type Configuration, type Entrypoint, WebpackError } from "webpack";
-import { SourceType } from "./utils/entrypoint-resolution-logic";
-import type { NormalizedEnqueuingControlFlags } from "./utils/path-query-and-related-helpers";
-export * from "./utils/entrypoint-resolution-logic";
-export type WPModuleDependency = string | {
-    id: string;
-    import?: string;
-};
+import type { Compilation } from "webpack";
+import type { PlauditWordpressWebpackConfig, WPModuleDependency } from "./api";
 export type ParsedAssetJson = {
     dependencies: WPModuleDependency[];
     module_dependencies?: WPModuleDependency[];
@@ -17,174 +8,7 @@ export type ParsedAssetJson = {
     handle?: string;
 };
 export type ParsedAssetsJson = Record<string, ParsedAssetJson>;
-export declare function isParsedAssetsJson(thing: any): thing is ParsedAssetsJson;
-type BaseRestType = [/* dependencies: */ WPModuleDependency[], /* version: */ string];
-export type AssetMetaSegment = {
-    inlinedAsset: InlinedAsset;
-    assetContents: string;
-};
-export type BaseHandleData = {
-    src: string;
-    rest: BaseRestType | [...BaseRestType, ScriptArgsObject];
-};
-export type ScriptArgsObject = {
-    strategy?: 'defer' | 'async';
-    in_footer?: boolean;
-    fetchpriority?: 'auto' | 'low' | 'high';
-    module_dependencies?: WPModuleDependency[];
-};
-export type InlinedAsset = {
-    position?: 'before' | 'after';
-    omitRegistration?: boolean;
-};
-export type IAHandleData = BaseHandleData & AssetMetaSegment;
-export type HandleData = BaseHandleData & (AssetMetaSegment | {
-    inlinedAsset?: undefined;
-    assetContents?: string;
-});
-type OptionalLocationMeta = {
-    supports_hook_name?: boolean;
-    additional_action_code?: {
-        before?(writer: PHPWriter): unknown;
-        after?(writer: PHPWriter): unknown;
-    };
-    alternate_names?: [string, ...string[]];
-};
-export declare const standardLocationNamesMeta: {
-    readonly clientView: {
-        readonly action: "wp_enqueue_scripts";
-        readonly alternate_names: ["client-view", "view"];
-    };
-    readonly clientEditor: {
-        readonly action: "enqueue_block_editor_assets";
-        readonly alternate_names: ["client-editor", "editor"];
-    };
-    readonly blockAssets: {
-        readonly action: "enqueue_block_assets";
-        readonly alternate_names: ["block-assets"];
-    };
-    readonly admin: {
-        readonly action: "admin_enqueue_scripts";
-        readonly supports_hook_name: true;
-    };
-    readonly login: {
-        readonly action: "login_enqueue_scripts";
-    };
-    readonly customizer: {
-        readonly action: "customize_controls_enqueue_scripts";
-    };
-    readonly analytics: {
-        readonly action: "plaudit_enqueue_analytics";
-    };
-};
-export type StandardLocationNameMeta = {
-    action: typeof standardLocationNamesMeta[keyof typeof standardLocationNamesMeta]['action'];
-} & OptionalLocationMeta;
-export type StandardLocationNames = keyof typeof standardLocationNamesMeta;
-export declare function isStandardLocationName(name: string): name is StandardLocationNames;
-export declare function iterableStandardLocationNamesMeta(): [StandardLocationNames, StandardLocationNameMeta][];
-export declare function normalizeLocationName(name: string): StandardLocationNames | 'register';
-type LocationWithHookNameSupport = boolean | number | string | string[] | {
-    hook_name?: string | string[];
-    priority?: number;
-};
-type InputRegisterScriptArgs = ScriptArgsObject | boolean | 'lazy' | 'eager' | 'inline';
-export declare function isRegisterScriptArgsShorthandName(name: string): name is Extract<InputRegisterScriptArgs, string>;
-export type RealUsageLocations = {
-    [K in StandardLocationNames]?: typeof standardLocationNamesMeta[K] extends {
-        supports_hook_name: true;
-    } ? LocationWithHookNameSupport : boolean | number;
-};
-export type UsageLocations = RealUsageLocations & {
-    register?: boolean | number;
-    inline?: number;
-    handle?: string | ((generatedHandle: string) => string) | {
-        niceName: string;
-    };
-    registerScriptArgs?: InputRegisterScriptArgs;
-};
-export type NormalizedUsageLocations = Omit<UsageLocations, 'registerScriptArgs'> & {
-    registerScriptArgs?: InputRegisterScriptArgs;
-};
-export declare function isNormalizedUsageLocations(usageLocations: UsageLocations): usageLocations is NormalizedUsageLocations;
-export type EnqueuedAssetType = 'script' | 'script_module' | 'style';
-export type ExtendedHandleData = HandleData & {
-    locations: UsageLocations;
-    handleName?: UsageLocations['handle'];
-    lazyLoader: string | undefined;
-    type: EnqueuedAssetType;
-    associatedInlinedHandles?: ExtendedHandleData[];
-};
-export declare function convertHookLocationToNamesAndPriority(hookLocation: NonNullable<Exclude<UsageLocations[keyof typeof standardLocationNamesMeta], false>>): [string[], number];
-export declare function hasDeferringStrategy(handle: HandleData): boolean;
-/**
- * @return {@code true} -> "can share the same handle", {@code false} -> "cannot be merged", {@code 'dependent'} -> "one handle can be listed as a dependency of the other"
- */
-export declare function canMergeHandles(handleA: ExtendedHandleData, handleB: ExtendedHandleData): boolean | 'dependent';
-export declare function constantKeys<K extends string, V>(object: {
-    [k in K]?: V;
-}): K[];
-export declare function constantEntries<K extends string, V>(object: {
-    [k in K]: V;
-}): [K, V][];
-export declare function determineCurrentSourceType(dest: string | AdvancedOutputConfig, srcIsDirectory: boolean): SourceType;
-export type ObjectIndividualExternalDepConfig = {
-    import?: string | [string, ...string[]];
-    handle: string;
-};
-export type IndividualExternalDepConfig = string | ObjectIndividualExternalDepConfig;
-export type Externals = {
-    [dep: string]: IndividualExternalDepConfig;
-};
-export type AdvancedOutputConfig = {
-    destination?: string;
-    withLegacyBlocksIn?: string | undefined | false;
-    additionalDependencies?: string[];
-    directoryLayout?: SourceType;
-    assumeGlobalizedPlauditLibraries?: boolean;
-    externalize?: Required<Configuration>['output']['library'];
-    bundleAnalyzer?: boolean | 'no-auto-open';
-    locations?: UsageLocations | UsageLocations['handle'];
-    lazyLoader?: string;
-    enqueuingFlags?: NormalizedEnqueuingControlFlags;
-};
-type OptionalCfgFields = 'directoryLayout' | 'externalize' | 'lazyLoader';
-export type VerifiedAdvancedOutputConfig = Required<Omit<AdvancedOutputConfig, 'locations' | 'enqueuingFlags' | OptionalCfgFields>> & Pick<AdvancedOutputConfig, OptionalCfgFields> & {
-    enqueuingFlags: NormalizedEnqueuingControlFlags | undefined;
-    locations: NormalizedUsageLocations;
-    pathQueryParameters?: PathQueryParameters;
-};
-export type SourcesObject = Record<string, string | AdvancedOutputConfig | boolean>;
-export type PlauditWordpressWebpackConfig = {
-    standard?: '2026-03-13';
-    standaloneBlocks?: boolean;
-    variables?: Record<string, any>;
-    verbose?: boolean;
-    src?: string[] | SourcesObject;
-    stats?: Configuration['stats'];
-    postcss?: {
-        functions?: (variables: (name: string) => unknown) => PostcssFunctionsOptions['functions'];
-    };
-    externals?: Externals;
-    assumeGlobalizedPlauditLibraries?: boolean;
-    useWebpackResourceFiltering?: boolean;
-    outputDir?: string;
-    extensionsVersion?: 1 | 2 | 3;
-    targetHandlePrefix?: string;
-    plainEntrypointsVersion?: 1 | 2;
-    srcDir?: string;
-    srcPrefixes?: string[];
-    useUnifiedLoader?: boolean;
-    includePostInitFallback?: boolean;
-    omitDistDev?: boolean;
-    onlyRunPostCSSOnPCSS?: boolean;
-    targetNamespace?: string;
-    useBlockSupportsAsThemeJsonDefaults?: boolean;
-};
-export type VerifiedPlauditWordpressWebpackConfig = Required<Omit<PlauditWordpressWebpackConfig, 'variables' | 'src' | 'externals' | 'standard'>> & {
-    variablesFilePath?: string;
-    currentVariables: Record<string, any>;
-} & Pick<PlauditWordpressWebpackConfig, 'externals'>;
+export declare function isParsedAssetsJson(thing: unknown): thing is ParsedAssetsJson;
 /** Unified-loader watch output: `dist` → `dist-dev` when SERVER_MODE is development. */
 export declare function shouldWriteDistDev(config: Pick<PlauditWordpressWebpackConfig, 'outputDir' | 'useUnifiedLoader' | 'omitDistDev'>): boolean;
 /**
@@ -192,32 +16,7 @@ export declare function shouldWriteDistDev(config: Pick<PlauditWordpressWebpackC
  * @returns true for `dist-dev` (or any `*-dev` output folder produced by {@link shouldWriteDistDev}).
  */
 export declare function isDistDevOutputPath(outputPath: string): boolean;
-export declare function applyStandards(config: PlauditWordpressWebpackConfig): {
-    readonly standard?: '2026-03-13';
-    readonly standaloneBlocks?: boolean;
-    readonly variables?: Record<string, any>;
-    readonly verbose?: boolean;
-    readonly src?: string[] | SourcesObject;
-    readonly stats?: Configuration['stats'];
-    readonly postcss?: {
-        functions?: (variables: (name: string) => unknown) => PostcssFunctionsOptions['functions'];
-    };
-    readonly externals?: Externals;
-    readonly assumeGlobalizedPlauditLibraries?: boolean;
-    readonly targetHandlePrefix?: string;
-    readonly srcPrefixes?: string[];
-    readonly includePostInitFallback?: boolean;
-    readonly omitDistDev?: boolean;
-    readonly targetNamespace?: string;
-    readonly useBlockSupportsAsThemeJsonDefaults?: boolean;
-    useWebpackResourceFiltering?: boolean | undefined;
-    extensionsVersion?: 1 | 2 | 3 | undefined;
-    plainEntrypointsVersion?: 1 | 2 | undefined;
-    srcDir?: string | undefined;
-    outputDir?: string | undefined;
-    useUnifiedLoader?: boolean | undefined;
-    onlyRunPostCSSOnPCSS?: boolean | undefined;
-};
+export declare function applyStandards(config: PlauditWordpressWebpackConfig): PlauditWordpressWebpackConfig;
 export declare function resolveStandard(standard: PlauditWordpressWebpackConfig['standard']): {
     readonly useWebpackResourceFiltering: true;
     readonly extensionsVersion: 3;
@@ -227,85 +26,13 @@ export declare function resolveStandard(standard: PlauditWordpressWebpackConfig[
     readonly useUnifiedLoader: true;
     readonly onlyRunPostCSSOnPCSS: true;
 } | undefined;
-export type FileSegmentBlockEntrypointInfo = {
-    blockJsonOrigin: string;
-    entrypointField: EntrypointFields[number];
-    handleGroup: ReturnType<typeof getHandleGroup>;
-    originalValue: string;
-    entrypointName: string;
-    handle: string;
-    dest: VerifiedAdvancedOutputConfig;
-    absoluteSrc: string;
-    pathQueryParameters: PathQueryParameters | undefined;
-    enqueuingFlags: NormalizedEnqueuingControlFlags | undefined;
-};
-export type PathQueryParameters = Record<string, unknown | [unknown, ...unknown[]]>;
-export type BlockEntrypointInfo = FileSegmentBlockEntrypointInfo | {
-    dest: VerifiedAdvancedOutputConfig;
-    purpose: string;
-    absoluteSrc: string;
-};
-export type MinimumViableMetadata = {
-    dest: VerifiedAdvancedOutputConfig;
-    absoluteSrc: string;
-};
-export declare function convertUsageLocationsHandleToEmittableHandle(handle: UsageLocations['handle'], handlePrefix: string, handleSuffix: string): string;
-export declare function makeEmittableConfigPHP(data: any, asFullFile: boolean, parentIndent?: string): string;
-export declare const entrypointFields: readonly ["editorStyle", "viewStyle", "style", "editorScript", "viewScript", "script", "viewScriptModule"];
-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;
-export declare const scriptWithoutModuleExtension: RegExp;
-export declare const scriptWithModuleExtension: RegExp;
-export declare const styleExtension: RegExp;
-export declare function scriptOrStyleTest(entryPath: string, scriptExtension: RegExp): "" | "script" | "style";
-export declare function isStyleField(field: string): field is 'style' | 'viewStyle' | 'editorStyle';
-export declare function isScriptModuleField(field: string): field is 'viewScriptModule';
 export declare function mergeModuleDependencyArrays(a: WPModuleDependency[] | undefined, b: WPModuleDependency[] | undefined): WPModuleDependency[] | undefined;
-export declare function getHandleGroup(field: string): 'styleHandles' | 'scriptHandles' | 'scriptModuleHandles';
-export type StripFirstTwoItems<A extends any[]> = A extends [any, any, ...rest: infer R] ? R : never;
-export declare function hasAtLeastOneItem<T>(list: T[]): list is [T, ...T[]];
-export type TupleOf<T, N extends number> = N extends N ? number extends N ? T[] : _TupleOf<T, N, []> : never;
-type _TupleOf<T, N extends number, R extends unknown[]> = R['length'] extends N ? R : _TupleOf<T, N, [T, ...R]>;
-export declare function arrayIsLength<T, N extends number>(arr: T[] | null | undefined, length: N): arr is TupleOf<T, N>;
-export declare function kebabCase(value: string): string;
-export declare function camelCaseForPHPLabels(value: string): string;
-export declare function newCleanWebpackError(error: string | ConstructorParameters<typeof WebpackError>): WebpackError;
-export declare function newWebpackErrorForFile(error: string | ConstructorParameters<typeof WebpackError>, file: string): WebpackError;
-/**
- * The primary benefit of emitting a function instead of baking its contents into each function that uses it is that it allows us to avoid recomputing the base uri multiple times
- */
-export declare function emitResolveBaseUriFunction(writer: PHPFile | PHPWriter): void;
 export declare function getAssetsJson(compilation: Compilation): ParsedAssetsJson;
-export type ParsedAssetJsonProvider = (entrypoint: Entrypoint, metadata: MinimumViableMetadata) => {
-    assetName: string;
-    assetData: ParsedAssetsJson[string];
-} | undefined;
-export declare function getParsedAssetsJsonDataForEntrypoint(compilation: Compilation, entrypoint: Entrypoint, metadata: MinimumViableMetadata): {
-    assetName: string;
-    assetData: ParsedAssetsJson[string];
-} | undefined;
-export declare function emitPHPWriterAsAsset(writer: PHPWriter | PHPFile, compilation: Compilation, file: string, assetInfo?: AssetInfo): void;
+export declare function tryGetAssetsJson(compilation: Compilation): ParsedAssetsJson | undefined;
 export declare function dedent(text: TemplateStringsArray, ...values: unknown[]): string;
 export declare function resolveLegacyBlockScriptsInFolder(folder: string): string[];
-/**
- * @param compilation
- * @param writer
- * @param handle
- * @param type 'script_module' is NOT supported at this time; however, it is *handled* in this function
- * @param handleData
- */
-export declare function appendAddInlineAssetCall(compilation: Compilation, writer: PHPWriter, handle: string, type: EnqueuedAssetType, handleData: IAHandleData): void;
-export declare function wrapInlineAssetContents(compilation: Compilation, wrapperIdPrefix: string, handle: string, contents: string): HereOrNowDoc;
-export declare function synchronousDirIterator(dirPath: string): Generator<import("node:fs").Dirent<string>, void, unknown>;
-/**
- * A type-guarded version of `instanceof Error` for Node.js.
- * @author Joseph JDBar Barron
- * @link https://dev.to/jdbar
- */
-export declare function instanceOfNodeError<T extends new (...args: any) => Error>(value: unknown, errorType: T): value is InstanceType<T> & NodeJS.ErrnoException;
-/**
- * This tests if the name starts with a "~", is equal to "example" or "examples", or includes "example" as a name segment
- */
-export declare function shouldBeSkipped(name: string): boolean;
+export type PromiseWithResolversAndValue<T> = ReturnType<typeof Promise.withResolvers<T>> & {
+    value: T | undefined;
+};
+export declare function promiseWithResolversAndValue<T>(): PromiseWithResolversAndValue<T>;
+//# sourceMappingURL=shared.d.ts.map

package/dist/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../src/shared.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,SAAS,CAAC;AAEzC,OAAO,KAAK,EAAC,6BAA6B,EAAE,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAG7E,MAAM,MAAM,eAAe,GAAG;IAC7B,YAAY,EAAE,kBAAkB,EAAE,CAAC;IACnC,mBAAmB,CAAC,EAAE,kBAAkB,EAAE,CAAC;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AACF,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AAC/D,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,gBAAgB,CAc5E;AAED,wFAAwF;AACxF,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC,6BAA6B,EAAE,WAAW,GAAC,kBAAkB,GAAC,aAAa,CAAC,GAAG,OAAO,CAErI;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAE/D;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,6BAA6B,GAAG,6BAA6B,CAYnG;AACD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,6BAA6B,CAAC,UAAU,CAAC;;gCAK5D,CAAC;sCACK,CAAC;qBAClB,KAAK;wBACF,MAAM;;;cAOpB;AAED,wBAAgB,2BAA2B,CAAC,CAAC,EAAE,kBAAkB,EAAE,GAAC,SAAS,EAAE,CAAC,EAAE,kBAAkB,EAAE,GAAC,SAAS,oCA0B/G;AAGD,wBAAgB,aAAa,CAAC,WAAW,EAAE,WAAW,oBAMrD;AACD,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,gCASxD;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,UAqBtE;AAED,wBAAgB,iCAAiC,CAAC,MAAM,EAAE,MAAM,YAa/D;AAED,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAC;IAAC,KAAK,EAAE,CAAC,GAAC,SAAS,CAAA;CAAC,CAAC;AAC/G,wBAAgB,4BAA4B,CAAC,CAAC,KAAK,4BAA4B,CAAC,CAAC,CAAC,CAYjF"}