@node-minify/types 10.0.0-next.0 → 10.0.1

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @node-minify/types
 
+## 10.0.1
+
+### Patch Changes
+
+- d722b73: test: verify OIDC publishing with fixed workflow config
+
+## 10.0.0
+
+### Major Changes
+
+- 4406c0c: ## v10.0.0
+
+  ### Breaking Changes
+
+  - **ESM Only**: The package is now pure ESM. Requires Node.js 20+.
+  - **Async API**: Callback support has been removed. All `minify()` calls must use `await` or `.then()`.
+  - **Named Exports**: All packages now use named exports (e.g., `import { minify } from '@node-minify/core'`).
+  - **Sync/Async Split**: Sync functions have been removed or split.
+  - **Deprecations**:
+    - `@node-minify/babel-minify` (deprecated)
+    - `@node-minify/uglify-es` (deprecated)
+    - `@node-minify/yui` (deprecated)
+    - `@node-minify/sqwish` (deprecated)
+    - `@node-minify/crass` (deprecated)
+
+  ### Features & Improvements
+
+  - **Build System**: Switched from `tsup` to `tsdown` for faster and more reliable builds.
+  - **Core**: Moved file I/O operations from compressors to core for better consistency.
+  - **Output**: Support for array output with input/output validation.
+  - **Security**: Replaced `html-minifier` with `html-minifier-next`.
+  - **Typings**: Improved TypeScript definitions and coverage.
+  - **Dependencies**: Updated all dependencies.
+
+  ### Bug Fixes
+
+  - Fixed various import issues and build warnings.
+  - Corrected explicit file extensions in imports.
+
 ## 10.0.0-next.0
 
 ### Major Changes

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Rodolphe Stoclin
+Copyright (c) 2025 Rodolphe Stoclin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -6,8 +6,8 @@
   <br>
   <a href="https://npmjs.org/package/@node-minify/types"><img src="https://img.shields.io/npm/v/@node-minify/types.svg"></a>
   <a href="https://npmjs.org/package/@node-minify/types"><img src="https://img.shields.io/npm/dm/@node-minify/types.svg"></a>
-  <a href="https://github.com/srod/node-minify/actions"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fsrod%2Fnode-minify%2Fbadge%3Fref%3Ddevelop&style=flat" /></a>
-  <a href="https://codecov.io/gh/srod/node-minify"><img src="https://codecov.io/gh/srod/node-minify/branch/develop/graph/badge.svg"></a>
+  <a href="https://github.com/srod/node-minify/actions"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fsrod%2Fnode-minify%2Fbadge%3Fref%3Dmain&style=flat" /></a>
+  <a href="https://codecov.io/gh/srod/node-minify"><img src="https://codecov.io/gh/srod/node-minify/branch/main/graph/badge.svg"></a>
 </p>
 
 # Types for node-minify
@@ -22,4 +22,4 @@ npm install --save-dev @node-minify/types
 
 ## License
 
-[MIT](https://github.com/srod/node-minify/blob/develop/LICENSE)
+[MIT](https://github.com/srod/node-minify/blob/main/LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@node-minify/types",
-  "version": "10.0.0-next.0",
+  "version": "10.0.1",
   "description": "types for @node-minify",
   "keywords": [
     "compressor",
@@ -13,10 +13,10 @@
   "license": "MIT",
   "type": "module",
   "engines": {
-    "node": ">=22.0.0"
+    "node": ">=20.0.0"
   },
-  "main": "src/types.ts",
-  "types": "src/types.ts",
+  "main": "src/types.d.ts",
+  "types": "src/types.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -27,4 +27,4 @@
   "bugs": {
     "url": "https://github.com/srod/node-minify/issues"
   }
-}
+}

package/src/types.d.ts

@@ -0,0 +1,192 @@
+/*!
+ * node-minify
+ * Copyright(c) 2011-2025 Rodolphe Stoclin
+ * MIT Licensed
+ */
+
+/**
+ * The return type of a compressor function.
+ * @deprecated Use `CompressorResult` instead. Will be removed in v11.
+ */
+export type CompressorReturnType = string;
+
+/**
+ * Result returned by a compressor function.
+ */
+export type CompressorResult = {
+    code: string;
+    map?: string;
+};
+
+/**
+ * Base options that all compressors can accept.
+ * Specific compressors may extend this with their own options.
+ */
+export type CompressorOptions = Record<string, unknown>;
+
+/**
+ * A compressor function that minifies content.
+ * @param args - The minifier options including settings and content
+ * @returns A promise resolving to the compression result
+ */
+export type Compressor<TOptions extends CompressorOptions = CompressorOptions> =
+    (args: MinifierOptions<TOptions>) => Promise<CompressorResult>;
+
+/**
+ * File type for compressors that support multiple types (e.g., YUI).
+ */
+export type FileType = "js" | "css";
+
+/**
+ * User-facing settings for the minify function.
+ * This is what users pass when calling minify().
+ *
+ * @example
+ * ```ts
+ * import { minify } from '@node-minify/core';
+ * import { terser } from '@node-minify/terser';
+ *
+ * await minify({
+ *   compressor: terser,
+ *   input: 'src/*.js',
+ *   output: 'dist/bundle.min.js',
+ *   options: { mangle: true }
+ * });
+ * ```
+ */
+export type Settings<TOptions extends CompressorOptions = CompressorOptions> = {
+    /**
+     * The compressor function to use for minification.
+     */
+    compressor: Compressor<TOptions>;
+
+    /**
+     * Optional label for the compressor (used in logging).
+     */
+    compressorLabel?: string;
+
+    /**
+     * Content to minify (for in-memory minification).
+     * If provided, input/output are not required.
+     */
+    content?: string;
+
+    /**
+     * Input file path(s) or glob pattern.
+     * Can be a single file, array of files, or wildcard pattern.
+     *
+     * @example
+     * - 'src/app.js'
+     * - ['src/a.js', 'src/b.js']
+     * - 'src/**\/*.js'
+     */
+    input?: string | string[];
+
+    /**
+     * Output file path.
+     * Use $1 as placeholder for input filename in multi-file scenarios.
+     * Can be a single file, array of files, or pattern with $1.
+     *
+     * @example
+     * - 'dist/bundle.min.js'
+     * - ['file1.min.js', 'file2.min.js']
+     * - '$1.min.js' (creates app.min.js from app.js)
+     */
+    output?: string | string[];
+
+    /**
+     * Compressor-specific options.
+     * See individual compressor documentation for available options.
+     */
+    options?: TOptions;
+
+    /**
+     * CLI option string (used by CLI only).
+     * @internal
+     */
+    option?: string;
+
+    /**
+     * Buffer size for file operations (in bytes).
+     * @default 1024000 (1MB)
+     */
+    buffer?: number;
+
+    /**
+     * File type for compressors that support multiple types.
+     * Required for YUI compressor.
+     */
+    type?: FileType;
+
+    /**
+     * Suppress console output.
+     * @default false
+     */
+    silence?: boolean;
+
+    /**
+     * Public folder to prepend to input paths.
+     *
+     * @example
+     * With publicFolder: 'public/js/' and input: 'app.js',
+     * the actual path becomes 'public/js/app.js'
+     */
+    publicFolder?: string;
+
+    /**
+     * Replace files in place instead of creating new output files.
+     * @default false
+     */
+    replaceInPlace?: boolean;
+};
+
+/**
+ * Options passed to compressor functions internally.
+ * This is what compressors receive, not what users pass.
+ */
+export type MinifierOptions<
+    TOptions extends CompressorOptions = CompressorOptions,
+> = {
+    /**
+     * The full settings object.
+     */
+    settings: Settings<TOptions>;
+
+    /**
+     * The content to minify.
+     */
+    content?: string;
+
+    /**
+     * Index of current file when processing multiple files.
+     */
+    index?: number;
+};
+
+/**
+ * Result returned after compression (used by CLI).
+ */
+export type Result = {
+    /**
+     * Label of the compressor used.
+     */
+    compressorLabel: string;
+
+    /**
+     * Size of minified content (formatted string, e.g., "1.5 KB").
+     */
+    size: string;
+
+    /**
+     * Gzipped size of minified content (formatted string).
+     */
+    sizeGzip: string;
+};
+
+/**
+ * Type alias for user convenience.
+ * @deprecated Use `Settings` instead. Will be removed in v11.
+ */
+export type MinifyOptions<
+    TOptions extends CompressorOptions = CompressorOptions,
+> = Settings<TOptions>;

package/src/types.ts

@@ -1,62 +0,0 @@
-export type OptionsPossible =
-    | string
-    | boolean
-    | Record<string, string>
-    | object;
-
-export type Options = {
-    [Key: string]:
-        | string
-        | string[]
-        | boolean
-        | Record<string, OptionsPossible>;
-};
-
-export type OptionsTest = Options & {
-    minify: Settings;
-};
-
-type Compressor = (
-    args: MinifierOptions
-) => void | string | Promise<void | string | undefined>;
-
-export type Settings = {
-    compressorLabel?: string;
-    compressor?: string | Compressor;
-    sync?: boolean;
-    callback?: (err: unknown, minified?: string) => void;
-    content?: string;
-    input?: string | string[];
-    output?: string;
-    options?: Options;
-    option?: string;
-    buffer?: number;
-    type?: "js" | "css" | "uglifyjs";
-    silence?: boolean;
-    publicFolder?: string;
-    replaceInPlace?: boolean;
-};
-
-export type MinifierOptions = {
-    settings?: Settings;
-    content?: string;
-    callback?: null | ((err?: unknown | null, result?: string) => void);
-    compressor?: string | Compressor;
-    index?: number;
-    args?: string[];
-    data?: string;
-    sync?: boolean;
-    input?: string | string[];
-    output?: string;
-};
-
-export type Result = {
-    compressor?: string | Compressor;
-    compressorLabel: string | (() => void);
-    size: string;
-    sizeGzip: string;
-};
-
-export type Dictionary<T> = {
-    [Key: string]: T;
-};