balm-core 5.2.0 → 6.0.0-alpha.0

package/dist/index.d.cts

@@ -0,0 +1,559 @@
+import { AcceptedPlugin } from 'postcss';
+import { MinifyOptions } from 'terser';
+import webpack, { Configuration } from 'webpack';
+import { RollupOptions, OutputOptions } from 'rollup';
+import * as esbuild from 'esbuild';
+import fg from 'fast-glob';
+
+type LooseObject = Record<string, any>;
+type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+type BalmEntry = string | string[] | Record<string, string | string[]>;
+interface BalmRoots {
+    source: string;
+    tmp: string;
+    target: string;
+}
+interface BalmPathMap {
+    base: string;
+    html: string;
+    css: string;
+    js: string;
+    img: string;
+    font: string;
+    media: string;
+}
+interface BalmPaths {
+    source: BalmPathMap;
+    tmp: Omit<BalmPathMap, 'html'>;
+    target: Omit<BalmPathMap, 'html'>;
+}
+interface BalmStyles {
+    extname: string;
+    minify: boolean;
+    atImportPaths: string[];
+    alias: Record<string, string>;
+    options: Record<string, any>;
+    sassOptions: Record<string, any>;
+    lessOptions: Record<string, any>;
+    postcssLoaderOptions: Record<string, any>;
+    postcssPlugins: any[];
+    sprites: string[];
+    spriteOptions: Record<string, any>;
+}
+declare enum BundlerType {
+    webpack = "webpack",
+    rollup = "rollup",
+    esbuild = "esbuild"
+}
+interface BalmScripts {
+    bundler: BundlerType | 'webpack' | 'rollup' | 'esbuild';
+    minify: boolean;
+    minifyOptions: Record<string, any>;
+    entry: BalmEntry;
+    target: string | string[];
+    library: string | Record<string, any>;
+    libraryTarget: string;
+    externals: string | string[] | Record<string, any> | RegExp | Function;
+    injectHtml: boolean;
+    htmlName: string;
+    alias: Record<string, string>;
+    plugins: any[];
+    loaders: any[];
+    defaultLoaders: {
+        html?: boolean;
+        css?: boolean;
+        js?: boolean;
+        url?: boolean;
+    };
+    options: Record<string, any>;
+    esbuildOptions: Record<string, any>;
+    rollupOptions: Record<string, any>;
+    webpackOptions: Record<string, any>;
+    useCache: boolean;
+}
+interface BalmHtml {
+    options: Record<string, any>;
+}
+interface BalmAssets {
+    root: string;
+    mainDir: string;
+    subDir: string;
+    buildDir: string;
+    virtualDir: string;
+    cache: boolean;
+    options: {
+        fileNameManifest?: string;
+        dontRenameFile?: (string | RegExp)[];
+        dontUpdateReference?: (string | RegExp)[];
+        hashLength?: number;
+        [key: string]: any;
+    };
+    includes: string[];
+    excludes: string[];
+    static?: string;
+    [key: string]: any;
+}
+interface BalmServer {
+    host: string | null;
+    port: number;
+    open: boolean | string;
+    proxy: boolean | Record<string, any> | Array<Record<string, any>>;
+    proxyOptions: boolean | Record<string, any> | Array<Record<string, any>>;
+    historyOptions: boolean | Record<string, any>;
+    useHMR: boolean;
+    options: Record<string, any>;
+}
+interface BalmPwa {
+    enabled: boolean;
+    mode: 'generateSW' | 'injectManifest';
+    version: string;
+    manifest: string;
+    swSrcFilename: string;
+    swDestFilename: string;
+    options: Record<string, any>;
+}
+interface BalmFtp {
+    options: Record<string, any>;
+    watchFiles: string[];
+}
+interface BalmImages {
+    plugins: any[];
+}
+interface BalmEnv {
+    isProd: boolean;
+    isDev: boolean;
+    isTest: boolean;
+    inFrontend: boolean;
+    inSSR: boolean;
+    inDesktopApp: boolean;
+    isMP: boolean;
+}
+interface BalmWorkspaces {
+    local: string;
+    global: string;
+}
+type BalmWorkspaceConfig = string | {
+    local?: string;
+    global?: string;
+};
+interface BalmConfig {
+    workspace: string;
+    workspaces: BalmWorkspaces;
+    alias: Record<string, string>;
+    env: BalmEnv;
+    inFrontend: boolean;
+    useDefaults: boolean;
+    roots: BalmRoots;
+    paths: BalmPaths;
+    styles: BalmStyles;
+    scripts: BalmScripts;
+    html: BalmHtml;
+    assets: BalmAssets;
+    server: BalmServer;
+    pwa: BalmPwa;
+    ftp: BalmFtp;
+    images: BalmImages;
+    logs: {
+        level: number;
+    };
+    src: BalmPathMap;
+    dest: BalmPathMap & {
+        static: string;
+    };
+    [key: string]: any;
+}
+type BalmCustomConfig = Omit<DeepPartial<BalmConfig>, 'workspace'> & {
+    workspace?: BalmWorkspaceConfig;
+};
+interface RenameOptions {
+    dirname?: string;
+    prefix?: string;
+    basename?: string;
+    suffix?: string;
+    extname?: string;
+}
+interface ReplaceOptions {
+    substr: string | RegExp;
+    replacement: string | ((substring: string, ...args: any[]) => string);
+}
+interface TemplateOption {
+    input: string;
+    output: string;
+    renameOptions?: string | Function | RenameOptions;
+}
+interface TaskContext {
+    config: BalmConfig;
+}
+type TaskFn = (context: TaskContext) => Promise<any> | any;
+
+interface TaskOptions {
+    name: string;
+    deps?: string[];
+    description?: string;
+    hidden?: boolean;
+}
+declare abstract class BaseTask {
+    name: string;
+    deps: string[];
+    description?: string;
+    hidden: boolean;
+    constructor(options: TaskOptions);
+    abstract run(config: BalmConfig): Promise<void> | void;
+}
+declare class FunctionTask extends BaseTask {
+    private fn;
+    constructor(name: string, fn: (config: BalmConfig) => Promise<void> | void, deps?: string[]);
+    run(config: BalmConfig): Promise<void>;
+}
+
+declare class TaskDAG {
+    private tasks;
+    registerTask(task: BaseTask): void;
+    getTask(name: string): BaseTask | undefined;
+    hasTask(name: string): boolean;
+    clear(): void;
+    /**
+     * Run a list of tasks in strict series
+     */
+    runSeries(taskNames: string[], config: BalmConfig): Promise<void>;
+    /**
+     * Run a list of tasks in parallel
+     */
+    runParallel(taskNames: string[], config: BalmConfig): Promise<void>;
+    /**
+     * Execute a single task resolving its dependencies first
+     */
+    executeTask(taskName: string, config: BalmConfig, executed?: Set<string>): Promise<void>;
+}
+
+declare class BalmHooks {
+    private dag;
+    private recipeIndex;
+    constructor(dag: TaskDAG);
+    private addRecipeTask;
+    copy(input: string | string[], output: string, options?: {
+        rename?: RenameOptions | string | Function;
+    }): this;
+    remove(target: string | string[]): this;
+    replace(input: string | string[], output: string, options: ReplaceOptions | ReplaceOptions[]): this;
+    sass(input: string | string[], output: string, options?: {}): this;
+    less(input: string | string[], output: string, options?: {}): this;
+    css(input: string | string[], output: string, options?: {}): this;
+    webpack(entry?: any, output?: string, customOptions?: {}): this;
+    rollup(input?: any, output?: any, customInputOptions?: {}, customOutputOptions?: {}): this;
+    esbuild(entryPoints?: any, outdir?: string, customOptions?: {}): this;
+    js(input?: any, output?: any, options?: {}): this;
+    publish(input?: string | TemplateOption[], output?: string, renameOptions?: string | Function | RenameOptions): this;
+    generateSW(options?: {}): this;
+    injectManifest(options?: {}): this;
+    ftp(localFiles?: string | string[], options?: {}): this;
+    zip(input?: string | string[], output?: string, filename?: string): this;
+    serve(): this;
+}
+
+declare class Balm {
+    private _config;
+    private dag;
+    beforeTask?: () => Promise<void> | void;
+    afterTask?: () => Promise<void> | void;
+    readonly Bundler: typeof BundlerType;
+    constructor();
+    get config(): BalmConfig;
+    set config(customConfig: BalmCustomConfig);
+    go(recipe?: (mix: BalmHooks) => void): Promise<void>;
+    reset(): void;
+}
+declare const balm: Balm;
+
+declare const ASSETS_TYPES: string[];
+declare const PUBLIC_URL = "%PUBLIC_URL%";
+declare const CHUNK: {
+    dir: string;
+};
+declare const ASSET: {
+    dir: string;
+};
+declare const ASSET_EXT: {
+    styles: string[];
+    scripts: string[];
+    images: string[];
+    fonts: string[];
+    media: string[];
+};
+
+declare function createDefaultConfig(workspace?: string): BalmConfig;
+
+declare function resolveConfig(customConfig?: BalmCustomConfig, defaultWorkspace?: string): BalmConfig;
+
+interface VirtualFileOptions {
+    cwd: string;
+    base: string;
+    path: string;
+    contents: Buffer | string;
+}
+declare class VirtualFile {
+    cwd: string;
+    base: string;
+    path: string;
+    contents: Buffer;
+    revPathOriginal?: string;
+    constructor(options: VirtualFileOptions);
+    get relative(): string;
+    get extname(): string;
+    set extname(val: string);
+    get basename(): string;
+    set basename(val: string);
+    get stem(): string;
+    set stem(val: string);
+    toString(encoding?: BufferEncoding): string;
+    clone(): VirtualFile;
+}
+
+type TransformFn = (file: VirtualFile) => Promise<VirtualFile | VirtualFile[] | null | void> | VirtualFile | VirtualFile[] | null | void;
+interface PipelineOptions {
+    cwd?: string;
+    base?: string;
+    allowEmpty?: boolean;
+}
+declare class Pipeline {
+    private cwd;
+    private base?;
+    private allowEmpty;
+    private files;
+    private transforms;
+    constructor(options?: PipelineOptions);
+    static from(patterns: string | string[], options?: PipelineOptions): Pipeline;
+    src(patterns: string | string[], options?: PipelineOptions): this;
+    pipe(transform: TransformFn): this;
+    process(): Promise<VirtualFile[]>;
+    dest(outDir: string): Promise<string[]>;
+}
+
+interface SassTransformOptions {
+    includePaths?: string[];
+    alias?: Record<string, string>;
+    style?: 'expanded' | 'compressed';
+    sourceMap?: boolean;
+    [key: string]: any;
+}
+declare function transformSass(options?: SassTransformOptions): TransformFn;
+
+interface LessTransformOptions {
+    paths?: string[];
+    alias?: Record<string, string>;
+    [key: string]: any;
+}
+declare function transformLess(options?: LessTransformOptions): TransformFn;
+
+interface PostcssTransformOptions {
+    plugins?: AcceptedPlugin[];
+    minify?: boolean;
+    [key: string]: any;
+}
+declare function transformPostcss(options?: PostcssTransformOptions): TransformFn;
+
+declare function transformHtmlmin(options?: Record<string, any>): TransformFn;
+
+declare function transformTerser(options?: MinifyOptions): TransformFn;
+
+declare function transformReplace(options: ReplaceOptions | ReplaceOptions[] | string | RegExp, replacement?: string | ((substring: string, ...args: any[]) => string)): TransformFn;
+
+declare function transformRename(options?: string | Function | RenameOptions): TransformFn;
+
+interface CacheTransformOptions {
+    fileNameManifest?: string;
+    dontRenameFile?: (string | RegExp)[];
+    dontUpdateReference?: (string | RegExp)[];
+    hashLength?: number;
+    [key: string]: any;
+}
+declare class AssetRevisioner {
+    private options;
+    private manifest;
+    constructor(options?: CacheTransformOptions);
+    process(files: VirtualFile[]): VirtualFile[];
+}
+
+declare function runWebpack(config: BalmConfig, customOptions?: Configuration): Promise<webpack.Stats | undefined>;
+
+declare function runRollup(config: BalmConfig, customInputOptions?: RollupOptions, customOutputOptions?: OutputOptions): Promise<void>;
+
+declare function runEsbuild(config: BalmConfig, customOptions?: esbuild.BuildOptions): Promise<esbuild.BuildResult>;
+
+declare class CleanTask extends BaseTask {
+    constructor();
+    run(config: BalmConfig): Promise<void>;
+}
+
+declare class StyleTask extends BaseTask {
+    constructor();
+    run(config: BalmConfig): Promise<void>;
+}
+
+declare class ScriptTask extends BaseTask {
+    constructor();
+    run(config: BalmConfig): Promise<void>;
+}
+
+declare class HtmlTask extends BaseTask {
+    constructor();
+    run(config: BalmConfig): Promise<void>;
+}
+
+interface CopyTaskOptions {
+    input: string | string[];
+    output: string;
+    rename?: RenameOptions | string | Function;
+}
+declare class CopyTask extends BaseTask {
+    private options;
+    constructor(options: CopyTaskOptions);
+    run(config: BalmConfig): Promise<void>;
+}
+
+declare class RemoveTask extends BaseTask {
+    private target;
+    constructor(target: string | string[]);
+    run(config: BalmConfig): Promise<void>;
+}
+
+interface ReplaceTaskOptions {
+    input: string | string[];
+    output: string;
+    options: ReplaceOptions | ReplaceOptions[];
+}
+declare class ReplaceTask extends BaseTask {
+    private taskOptions;
+    constructor(taskOptions: ReplaceTaskOptions);
+    run(config: BalmConfig): Promise<void>;
+}
+
+declare class CacheTask extends BaseTask {
+    constructor();
+    run(config: BalmConfig): Promise<void>;
+}
+
+interface PublishTaskOptions {
+    input?: string | TemplateOption[];
+    output?: string;
+    renameOptions?: string | Function | RenameOptions;
+}
+declare class PublishTask extends BaseTask {
+    private options;
+    constructor(options?: PublishTaskOptions);
+    run(config: BalmConfig): Promise<void>;
+    private publishItem;
+}
+
+interface PwaTaskOptions {
+    mode?: 'generateSW' | 'injectManifest';
+    options?: Record<string, any>;
+}
+declare class PwaTask extends BaseTask {
+    private options;
+    constructor(options?: PwaTaskOptions);
+    run(config: BalmConfig): Promise<void>;
+}
+
+interface ZipTaskOptions {
+    input?: string | string[];
+    output?: string;
+    filename?: string;
+}
+declare class ZipTask extends BaseTask {
+    private options;
+    constructor(options?: ZipTaskOptions);
+    run(config: BalmConfig): Promise<void>;
+}
+
+interface FtpTaskOptions {
+    localFiles?: string | string[];
+    options?: {
+        host?: string;
+        port?: number;
+        username?: string;
+        password?: string;
+        privateKey?: string;
+        remotePath?: string;
+        [key: string]: any;
+    };
+}
+declare class FtpTask extends BaseTask {
+    private ftpOptions;
+    constructor(ftpOptions?: FtpTaskOptions);
+    run(config: BalmConfig): Promise<void>;
+}
+
+declare class ServerTask extends BaseTask {
+    private watcher;
+    private wsServer;
+    private clients;
+    constructor();
+    broadcast(data: {
+        type: 'reload' | 'reload-css';
+        file?: string;
+    }): void;
+    run(config: BalmConfig): Promise<void>;
+}
+
+declare enum LogLevel {
+    Debug = 0,
+    Info = 1,
+    Warn = 2,
+    Error = 3,
+    Silent = 4
+}
+declare class Logger {
+    level: LogLevel;
+    private formatTag;
+    private timestamp;
+    debug(tag: string, message: any, ...args: any[]): void;
+    info(tag: string, message: any, ...args: any[]): void;
+    success(tag: string, message: any, ...args: any[]): void;
+    warn(tag: string, message: any, ...args: any[]): void;
+    error(tag: string, message: any, ...args: any[]): void;
+    time(label: string): () => void;
+}
+declare const logger: Logger;
+
+declare class FileSystem {
+    workspace: string;
+    resolveApp(...paths: string[]): string;
+    absPath(filePath: string): string;
+    absPaths(filePaths: string | string[]): string | string[];
+    exists(targetPath: string): Promise<boolean>;
+    existsSync(targetPath: string): boolean;
+    ensureDir(dirPath: string): Promise<void>;
+    readFile(filePath: string, encoding?: BufferEncoding): Promise<string>;
+    readBuffer(filePath: string): Promise<Buffer>;
+    writeFile(filePath: string, data: string | Buffer): Promise<void>;
+    remove(targetPath: string | string[]): Promise<string[]>;
+    copyFile(src: string, dest: string): Promise<void>;
+    copyDir(srcDir: string, destDir: string): Promise<void>;
+    matchFiles(patterns: string | string[], options?: fg.Options): Promise<string[]>;
+    hash(content: string | Buffer, length?: number): string;
+}
+declare const file: FileSystem;
+
+declare function isObject(val: any): val is Record<string, any>;
+declare function isArray(val: any): val is any[];
+declare function isString(val: any): val is string;
+declare function isFunction(val: any): val is Function;
+declare function isBoolean(val: any): val is boolean;
+declare function deepMerge<T extends Record<string, any>>(target: T, ...sources: any[]): T;
+declare function toNamespace(name: string | string[], namespace?: string): string | string[];
+
+interface WorkspacePaths {
+    local: string;
+    global: string;
+}
+declare function setWorkspaces(local?: string, global?: string): void;
+declare function getWorkspaces(): WorkspacePaths;
+declare function localWorkspace(subPath?: string): string;
+declare function globalWorkspace(subPath?: string): string;
+declare const localResolve: typeof localWorkspace;
+declare const globalResolve: typeof globalWorkspace;
+
+export { ASSET, ASSETS_TYPES, ASSET_EXT, AssetRevisioner, Balm, type BalmAssets, type BalmConfig, type BalmCustomConfig, type BalmEntry, type BalmEnv, type BalmFtp, BalmHooks, type BalmHtml, type BalmImages, type BalmPathMap, type BalmPaths, type BalmPwa, type BalmRoots, type BalmScripts, type BalmServer, type BalmStyles, type BalmWorkspaceConfig, type BalmWorkspaces, BaseTask, BundlerType, CHUNK, CacheTask, type CacheTransformOptions, CleanTask, CopyTask, type CopyTaskOptions, type DeepPartial, FileSystem, FtpTask, type FtpTaskOptions, FunctionTask, HtmlTask, type LessTransformOptions, LogLevel, type LooseObject, PUBLIC_URL, Pipeline, type PipelineOptions, type PostcssTransformOptions, PublishTask, type PublishTaskOptions, PwaTask, type PwaTaskOptions, RemoveTask, type RenameOptions, type ReplaceOptions, ReplaceTask, type ReplaceTaskOptions, type SassTransformOptions, ScriptTask, ServerTask, StyleTask, type TaskContext, TaskDAG, type TaskFn, type TaskOptions, type TemplateOption, type TransformFn, VirtualFile, type VirtualFileOptions, type WorkspacePaths, ZipTask, type ZipTaskOptions, balm, createDefaultConfig, deepMerge, balm as default, file, getWorkspaces, globalResolve, globalWorkspace, isArray, isBoolean, isFunction, isObject, isString, localResolve, localWorkspace, logger, resolveConfig, runEsbuild, runRollup, runWebpack, setWorkspaces, toNamespace, transformHtmlmin, transformLess, transformPostcss, transformRename, transformReplace, transformSass, transformTerser };