@macrulez/devtoolz 0.3.2 → 0.4.0

package/dist/commands/image-batch/run.d.ts

@@ -0,0 +1,122 @@
+import type { VibesOptions } from '../../format/vibes.js';
+import { type TerminalIO } from '../../utils/tty.js';
+import { type CodecMap, type OutputFormatName, type QualityInput } from './codecs.js';
+import { type BatchConfig, type PlaceholderSettings } from './config.js';
+import type { Fit } from './geometry.js';
+import { type ConflictPrompt, type OverwriteMode } from './overwrite.js';
+import { type Placement, type SharpFn } from './plan.js';
+import type { SharpenSpec } from './sharpen.js';
+export interface BatchOverrides {
+    widths?: number[];
+    heights?: number[];
+    formats?: string[];
+    quality?: QualityInput;
+    codecs?: CodecMap;
+    fit?: Fit;
+    name?: string;
+    flatten?: boolean | string;
+    longEdge?: number[];
+    shortEdge?: number[];
+    megapixels?: number[];
+    percent?: number[];
+    matchOrientation?: boolean;
+    maxBytes?: number;
+    sharpen?: Partial<SharpenSpec>;
+}
+export interface BatchProgress {
+    done: number;
+    total: number;
+}
+export interface ReplaceSummary {
+    count: number;
+    bytes: number;
+    backupDir: string | null;
+}
+export interface ImageBatchOptions {
+    paths: string[];
+    cwd: string;
+    out?: string;
+    beside?: boolean;
+    replace?: boolean;
+    backup?: string | false;
+    onlyIfSmaller?: boolean;
+    config?: BatchConfig;
+    configLabel?: string;
+    overrides?: BatchOverrides;
+    recursive?: boolean;
+    extensions?: string[];
+    ignoreGlobs?: string[];
+    respectGitignore?: boolean;
+    include?: string[];
+    exclude?: string[];
+    flat?: boolean;
+    list?: boolean;
+    select?: boolean;
+    overwrite?: OverwriteMode;
+    force?: boolean;
+    placeholders?: PlaceholderSettings;
+    emit?: string;
+    keyPrefix?: string;
+    cache?: string | false;
+    cacheBase?: string;
+    concurrency?: number;
+    maxPixels?: number;
+    dryRun?: boolean;
+    assumeYes?: boolean;
+    sharp?: SharpFn;
+    io?: TerminalIO;
+    interactive?: boolean;
+    prompt?: ConflictPrompt;
+    confirm?: (summary: ReplaceSummary) => Promise<boolean>;
+    now?: Date;
+    style?: VibesOptions;
+    onProgress?: (progress: BatchProgress) => void;
+}
+export type JobStatus = 'written' | 'up-to-date' | 'skipped' | 'conflict' | 'would-write' | 'would-overwrite' | 'replaced' | 'kept' | 'already-processed' | 'would-replace' | 'would-keep' | 'error';
+export interface BatchJobResult {
+    source: string;
+    output: string;
+    recipe: string;
+    format: OutputFormatName;
+    width: number;
+    height: number;
+    status: JobStatus;
+    bytes?: number;
+    before?: number;
+    message?: string;
+}
+export interface BatchSourceSummary {
+    file: string;
+    width: number;
+    height: number;
+    format: string;
+    bytes: number;
+}
+export interface ImageBatchReport {
+    placement: Placement;
+    out: string;
+    backupDir?: string;
+    backupEnabled: boolean;
+    configLabel?: string;
+    dryRun: boolean;
+    listOnly: boolean;
+    sources: BatchSourceSummary[];
+    failures: {
+        file: string;
+        message: string;
+    }[];
+    unmatched: string[];
+    derived: string[];
+    vectors: string[];
+    results: BatchJobResult[];
+    counts: Record<JobStatus, number>;
+    deduped: number;
+    bytesIn: number;
+    bytesOut: number;
+    emitPath?: string;
+    aborted: boolean;
+    cancelled: boolean;
+    nothingSelected: boolean;
+    exitCode: number;
+}
+export declare function runImageBatch(options: ImageBatchOptions): Promise<ImageBatchReport>;