fuc-new/doc/node_modules/@vuepress/plugin-replace-assets/lib/node/index.d.ts

import { Plugin } from 'vuepress/core';
import { VitePlugin, WebpackPluginInstance } from 'unplugin';

/**
 * Assets Replacement Target Path
 * - `string`: Directly concatenated before the original path
 * - `(url) => string`: Custom replacement method, returns the new path
 *
 * 资源替换目标路径
 * - `string`: 直接拼接在原始路径前面
 * - `(url) => string`: 自定义替换方法，返回新路径
 */
type Replacement = string | ((url: string) => string);
/**
 * Assets Replacement Rule
 *
 * 资源替换规则
 */
interface ReplacementRule {
    /**
     * Assets Matching
     *
     * - `RegExp`: Match using regular expression
     * - `string`: Match using string
     *   - Strings starting with `^` or ending with `$` are automatically converted to regular expressions
     *   - For ordinary strings, checks if they appear at the start or end
     *
     * 资源匹配
     *
     * - `RegExp`: 匹配正则
     * - `string`: 匹配字符串
     *   - 以 `^` 开头或以 `$` 结尾的字符串，会自动转换为正则
     *   - 普通字符串检查是否以其作为开头或结尾
     *
     * @example
     * ```
     * '^/foo/'
     * '.jpg$'
     * /\.jpg$/
     * ```
     */
    find: RegExp | string;
    /**
     * Assets Replacement Target Path
     * - `string`: Directly concatenated before the original path
     * - `(url) => string`: Custom replacement method, returns the new path
     *
     * 资源替换目标路径
     * - `string`: 直接拼接在原始路径前面
     * - `(url) => string`: 自定义替换方法，返回新路径
     *
     * @example
     * ```
     * 'https://example.com'
     * (url) => `https://example.com${url}`
     * ```
     */
    replacement: Replacement;
}
interface ReplaceAssetsOptions {
    /**
     * Custom Assets Replacement Rules
     *
     * 自定义资源替换规则
     *
     * @example
     * ```ts
     * {
     *   rules: [{
     *     find: /^\/images\/.*\.(jpe?g|png|gif|svg)$/,
     *     replacement: 'https://cdn.example.com/images/',
     *   }]
     * }
     * ```
     */
    rules?: ReplacementRule | ReplacementRule[];
    /**
     * Built-in image matching rules, designed to match and find common image paths starting with `^/images/`
     *
     * 内置的图片匹配规则，匹配查找 `^/images/` 开头的常见的图片路径
     *
     * @example
     * ```
     * {
     *   image: 'https://example.com'
     * }
     * ```
     */
    image?: Replacement;
    /**
     * Built-in media matching rules, designed to match and locate common media paths such as videos and audio that start with `^/medias/`.
     *
     * 内置的媒体匹配规则，匹配查找 `^/medias/` 开头的常见的视频、音频等媒体路径
     *
     * @example
     * ```
     * {
     *   media: 'https://example.com'
     * }
     * ```
     */
    media?: Replacement;
    /**
     * Equivalent to setting both {@link ReplaceAssetsOptions.image image} and {@link ReplaceAssetsOptions.media media} simultaneously.
     *
     * 相当于同时设置 {@link ReplaceAssetsOptions.image image} 和 {@link ReplaceAssetsOptions.media media}
     *
     * @example
     * ```
     * {
     *   all: 'https://example.com'
     * }
     * ```
     */
    all?: Replacement;
}
/**
 * Assets Replacement Plugin Options
 *
 * 资源替换插件配置项
 */
type ReplaceAssetsPluginOptions = ReplaceAssetsOptions | Replacement | ReplacementRule | ReplacementRule[];

/**
 * Plugin for replacing assets path
 *
 * 资源路径替换插件
 *
 * @example
 * ```
 * export default defineUserConfig({
 *   plugins: [
 *     replaceAssetsPlugin('https://cnd.example.com')
 *   ]
 * })
 * ```
 */
declare const replaceAssetsPlugin: (options?: ReplaceAssetsPluginOptions) => Plugin;

declare const createFindPattern: (dir: string, extensions: string[]) => RegExp;
/**
 * Normalize replacement rules
 */
declare const normalizeRules: (options?: ReplaceAssetsPluginOptions) => ReplacementRule[];

/**
 * Check if url matches find
 */
declare const isMatchUrl: (find: RegExp | string, url: string) => boolean;
/**
 * Replace asset with rules
 *
 * @example
 * ```ts
 * replacementAssetWithRules([{ find: '/foo/', replacement: 'https://example.com' }], '/foo/a.jpg')
 * // -> 'https://example.com/foo/a.jpg'
 * ```
 */
declare const replacementAssetWithRules: (rules: ReplacementRule[], url: string) => string | void;
declare const transformAssets: (code: string, pattern: RegExp, rules: ReplacementRule[]) => string;

declare const createVitePluginReplaceAssets: () => (options: ReplacementRule[]) => VitePlugin | VitePlugin[];
declare const createWebpackPluginReplaceAssets: () => (options: ReplacementRule[]) => WebpackPluginInstance;

export { createFindPattern, createVitePluginReplaceAssets, createWebpackPluginReplaceAssets, isMatchUrl, normalizeRules, replaceAssetsPlugin, replacementAssetWithRules, transformAssets };
export type { ReplaceAssetsOptions, ReplaceAssetsPluginOptions, Replacement, ReplacementRule };