npm-pkgbuild 19.1.5 → 19.2.1

package/README.md

@@ -98,47 +98,47 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
     *   [Properties](#properties)
 *   [extractFromPackage](#extractfrompackage)
     *   [Parameters](#parameters-1)
-*   [NPMPackContentProvider](#npmpackcontentprovider)
+*   [BUILDAH](#buildah)
+*   [ContentProvider](#contentprovider)
     *   [Parameters](#parameters-2)
     *   [Properties](#properties-1)
+    *   [asyncIterator](#asynciterator)
+*   [FileContentProvider](#filecontentprovider)
+    *   [Parameters](#parameters-3)
+    *   [asyncIterator](#asynciterator-1)
     *   [name](#name)
 *   [NodeModulesContentProvider](#nodemodulescontentprovider)
-    *   [Parameters](#parameters-3)
+    *   [Parameters](#parameters-4)
     *   [Properties](#properties-2)
-    *   [asyncIterator](#asynciterator)
+    *   [asyncIterator](#asynciterator-2)
     *   [name](#name-1)
-*   [FileContentProvider](#filecontentprovider)
-    *   [Parameters](#parameters-4)
-    *   [asyncIterator](#asynciterator-1)
+*   [NPMPackContentProvider](#npmpackcontentprovider)
+    *   [Parameters](#parameters-5)
+    *   [Properties](#properties-3)
     *   [name](#name-2)
 *   [NFTContentProvider](#nftcontentprovider)
-    *   [Parameters](#parameters-5)
-    *   [asyncIterator](#asynciterator-2)
-    *   [name](#name-3)
-*   [ContentProvider](#contentprovider)
     *   [Parameters](#parameters-6)
-    *   [Properties](#properties-3)
     *   [asyncIterator](#asynciterator-3)
+    *   [name](#name-3)
 *   [DEBIAN](#debian)
     *   [hookMapping](#hookmapping)
     *   [attributes](#attributes)
     *   [prepare](#prepare)
         *   [Parameters](#parameters-7)
-*   [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
-*   [attributes](#attributes-1)
 *   [quoteFile](#quotefile)
     *   [Parameters](#parameters-8)
 *   [RPM](#rpm)
     *   [hookMapping](#hookmapping-1)
-    *   [attributes](#attributes-2)
+    *   [attributes](#attributes-1)
     *   [prepare](#prepare-1)
         *   [Parameters](#parameters-9)
+*   [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
+*   [attributes](#attributes-2)
 *   [OCI](#oci)
 *   [DOCKER](#docker)
     *   [attributes](#attributes-3)
     *   [prepare](#prepare-2)
         *   [Parameters](#parameters-10)
-*   [BUILDAH](#buildah)
 *   [Packager](#packager)
     *   [Parameters](#parameters-11)
     *   [packageName](#packagename)
@@ -248,21 +248,51 @@ Extract package definition from package.json.
 
 Returns **AsyncIterable<[PackageDefinition](#packagedefinition)>**&#x20;
 
-## NPMPackContentProvider
+## BUILDAH
 
-**Extends ContentProvider**
+**Extends DOCKER**
 
-Content from npm pack.
+Use buildah @see <https://buildah.io>
+
+## ContentProvider
+
+Source of package content.
 
 ### Parameters
 
-*   `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
-*   `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
+*   `definitions` &#x20;
+*   `entryProperties` &#x20;
 *   `directoryProperties` &#x20;
 
 ### Properties
 
 *   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>**&#x20;
+
+### asyncIterator
+
+List all entries.
+
+Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
+
+## FileContentProvider
+
+**Extends ContentProvider**
+
+Content provided form the file system.
+
+### Parameters
+
+*   `definitions` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;
+
+    *   `definitions.pattern` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**&#x20;
+    *   `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
+*   `entryProperties` &#x20;
+*   `directoryProperties` &#x20;
+
+### asyncIterator
+
+Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
 
 ### name
 
@@ -295,24 +325,21 @@ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
 
-## FileContentProvider
+## NPMPackContentProvider
 
 **Extends ContentProvider**
 
-Content provided form the file system.
+Content from npm pack.
 
 ### Parameters
 
-*   `definitions` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;
-
-    *   `definitions.pattern` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)**&#x20;
-    *   `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
-*   `entryProperties` &#x20;
+*   `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
 *   `directoryProperties` &#x20;
 
-### asyncIterator
+### Properties
 
-Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
+*   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
 ### name
 
@@ -341,27 +368,6 @@ Returns **AsyncIterable\<ContentEntry>** all entries
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
 
-## ContentProvider
-
-Source of package content.
-
-### Parameters
-
-*   `definitions` &#x20;
-*   `entryProperties` &#x20;
-*   `directoryProperties` &#x20;
-
-### Properties
-
-*   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-*   `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>**&#x20;
-
-### asyncIterator
-
-List all entries.
-
-Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
-
 ## DEBIAN
 
 **Extends Packager**
@@ -388,15 +394,6 @@ Map install hook named from default (arch) to deb.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>**&#x20;
 
-## pkgKeyValuePairOptions
-
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
-
-## attributes
-
-well known package properties
-<https://www.archlinux.org/pacman/PKGBUILD.5.html>
-
 ## quoteFile
 
 ### Parameters
@@ -430,6 +427,15 @@ Check for rpmbuild presence.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>** true when rpmbuild executable is present
 
+## pkgKeyValuePairOptions
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+## attributes
+
+well known package properties
+<https://www.archlinux.org/pacman/PKGBUILD.5.html>
+
 ## OCI
 
 **Extends Packager**
@@ -459,12 +465,6 @@ Check for docker presence.
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)>** true when docker executable is present
 
-## BUILDAH
-
-**Extends DOCKER**
-
-Use buildah @see <https://buildah.io>
-
 ## Packager
 
 ### Parameters

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-pkgbuild",
-  "version": "19.1.5",
+  "version": "19.2.1",
   "publishConfig": {
     "access": "public",
     "provenance": false
@@ -59,11 +59,11 @@
     "compare-versions": "^6.1.1",
     "content-entry": "^14.2.7",
     "content-entry-filesystem": "^9.0.14",
-    "content-entry-transform": "^1.5.15",
+    "content-entry-transform": "^1.5.17",
     "execa": "^9.6.0",
     "expression-expander": "^7.2.8",
     "ini": "^6.0.0",
-    "iterable-string-interceptor": "^3.0.3",
+    "iterable-string-interceptor": "^3.0.5",
     "key-value-transformer": "^3.3.1",
     "npm-package-walker": "^8.0.11",
     "npm-packlist": "^10.0.3",
@@ -74,7 +74,7 @@
     "uti": "^8.10.3"
   },
   "devDependencies": {
-    "@types/node": "^25.0.6",
+    "@types/node": "^25.0.8",
     "ava": "^6.4.1",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",

package/src/content/content-provider.mjs

@@ -3,15 +3,26 @@ import { ContentEntry, CollectionEntry } from "content-entry";
 /**
  * Source of package content.
  * @property {string} dir
- * @property {Transformer[]} transformer
+ * @property {Transformer[]} transformers
  */
 export class ContentProvider {
-  transformers = [];
+  transformers;
   entryProperties;
   directoryProperties;
   dir;
 
+  /**
+   * 
+   * @param {Object} definitions 
+   * @param {Array<Transformer>} [definitions.transformers]
+   * @param {string} [definitions.dir]
+   * @param {Object} [entryProperties]
+   * @param {string} [entryProperties.destination]
+   * @param {Object} [directoryProperties]
+   */
   constructor(definitions, entryProperties, directoryProperties) {
+    this.transformers = definitions.transformers || [];
+    this.dir = definitions.dir;
     this.entryProperties = entryProperties;
     this.directoryProperties = directoryProperties;
     if (this.entryProperties?.destination) {

package/src/content/file-content-provider.mjs

@@ -10,9 +10,6 @@ const DEFAULT_PATTERN = ["**/*", "!.*"];
 
 /**
  * Content provided form the file system.
- * @param {Object|string} definitions
- * @param {string|string[]} definitions.pattern
- * @param {string} definitions.base base directory where to find the files
  */
 export class FileContentProvider extends ContentProvider {
   /**
@@ -26,48 +23,54 @@ export class FileContentProvider extends ContentProvider {
     return "use plain files source";
   }
 
+  base;
+  pattern = DEFAULT_PATTERN;
+
+  /**
+   * Content provided form the file system.
+   * @param {Object|string} definitions
+   * @param {string|string[]} [definitions.pattern]
+   * @param {string} [definitions.base] base directory where to find the files
+   */
   constructor(definitions, entryProperties, directoryProperties) {
     super(definitions, entryProperties, directoryProperties);
 
     if (typeof definitions === "string") {
       if (definitions.endsWith("/")) {
-        this.definitions = {
-          base: definitions.substring(0, definitions.length - 1),
-          pattern: DEFAULT_PATTERN
-        };
+        this.base = definitions.substring(0, definitions.length - 1);
+        this.pattern = DEFAULT_PATTERN;
       } else {
         const base = dirname(definitions);
-        this.definitions = {
-          base,
-          pattern: [definitions.substring(base.length + 1)]
-        };
+        this.base = base;
+        this.pattern = [definitions.substring(base.length + 1)];
       }
     } else {
-      this.definitions = { pattern: DEFAULT_PATTERN, ...definitions };
-      this.definitions.pattern = asArray(this.definitions.pattern);
+      this.base = definitions.base;
+      if(definitions.pattern) {
+        this.pattern = asArray(definitions.pattern);
+      }
     }
 
-    this.definitions.base = resolve(cwd(), this.definitions.base);
+    this.base = resolve(cwd(), this.base);
   }
 
   get isPatternMatch() {
-    return this.definitions.pattern.find(p => p.match(/[\*\?]/));
+    return this.pattern.find(p => p.match(/[\*\?]/));
   }
 
   toString() {
-    return `${this.constructor.name}: ${this.definitions.base}, ${this.definitions.pattern} -> ${this.entryProperties?.destination}`;
+    return `${this.constructor.name}: ${this.base}, ${this.pattern} -> ${this.entryProperties?.destination}`;
   }
 
   /**
    * @return {AsyncIterable<ContentEntry|CollectionEntry>} all entries
    */
   async *[Symbol.asyncIterator]() {
-    const definitions = this.definitions;
-    const baseDir = definitions.base;
+    const baseDir = this.base;
     const startPos = baseDir.length + 1;
 
     let count = 0;
-    for await (const entry of glob(definitions.pattern, {
+    for await (const entry of glob(this.pattern, {
       cwd: baseDir,
       withFileTypes: true
     })) {
@@ -86,7 +89,7 @@ export class FileContentProvider extends ContentProvider {
     }
 
     if (!this.isPatternMatch && count < 1) {
-      const file = join(baseDir, this.definitions.pattern[0]);
+      const file = join(baseDir, this.pattern[0]);
       const error = new Error(`File not found ${file}`);
       error.file = file;
       throw error;

package/src/content/nft-content-provider.mjs

@@ -6,9 +6,6 @@ import { ContentProvider } from "./content-provider.mjs";
 
 /**
  * Content provided form the file system.
- * @param {Object|string} definitions
- * @param {string|string[]} definitions.pattern
- * @param {string} definitions.base base directory where to find the files
  */
 export class NFTContentProvider extends ContentProvider {
   /**
@@ -22,29 +19,36 @@ export class NFTContentProvider extends ContentProvider {
     return "user vercels NFT as source";
   }
 
+  /**
+   * Content provided form the file system.
+   * @param {Object|string} definitions
+   * @param {string} definitions.start base directory where to find the files
+   * @param {Array<Transformer>} [definitions.transformers]
+   * @param {string} [definitions.dir]
+   * @param {Object} [entryProperties]
+   * @param {string} [entryProperties.destination]
+   * @param {Object} [directoryProperties]
+ */
   constructor(definitions, entryProperties, directoryProperties) {
     super(definitions, entryProperties, directoryProperties);
 
     if (typeof definitions === "string") {
-      this.definitions = { start: [definitions] };
+      this.start = [definitions];
     } else {
-      this.definitions = definitions;
-      this.definitions.start = asArray(this.definitions.start);
+      this.start = asArray(definitions.start);
     }
   }
 
   toString() {
-    return `${this.constructor.name}: ${this.definitions.start} -> ${this.entryProperties.destination}`;
+    return `${this.constructor.name}: ${this.start} -> ${this.entryProperties.destination}`;
   }
 
   /**
    * @return {AsyncIterable<ContentEntry>} all entries
    */
   async *[Symbol.asyncIterator]() {
-    const definitions = this.definitions;
-    const baseDir = definitions.base || process.cwd();
-
-    const { fileList } = await nodeFileTrace(definitions.start);
+    const baseDir = this.base || process.cwd();
+    const { fileList } = await nodeFileTrace(this.start);
 
     for (const name of fileList) {
       yield new FileSystemEntry(

package/src/npm-pkgbuild-cli.mjs

@@ -17,8 +17,12 @@ import pkg from "../package.json" with { type: "json" };
 program.description(pkg.description).version(pkg.version);
 
 allOutputs.forEach(o => {
-  program.option(`--${o.name}`, o.description);
-  program.option(`--no-${o.name}`, `do not ${o.description} output`);
+  for(const name of [o.name,o.alias]) {
+    if(name) {
+      program.option(`--${name}`, o.description);
+      program.option(`--no-${name}`, `do not ${o.description} output`);
+    }
+  }
 });
 
 allInputs.forEach(i => {

package/src/output/arch.mjs

@@ -61,12 +61,17 @@ let _prepared;
 let _architecture = "aarch64";
 
 export class ARCH extends Packager {
+
+  static get alias() {
+    return "alpm";
+  }
+
   static get name() {
     return "arch";
   }
 
   static get description() {
-    return "generate Arch-Linux package";
+    return "generate Arch-Linux package (ALPM)";
   }
 
   static get fileNameExtension() {

package/types/content/content-provider.d.mts

@@ -1,14 +1,30 @@
 /**
  * Source of package content.
  * @property {string} dir
- * @property {Transformer[]} transformer
+ * @property {Transformer[]} transformers
  */
 export class ContentProvider {
-    constructor(definitions: any, entryProperties: any, directoryProperties: any);
-    transformers: any[];
-    entryProperties: any;
+    /**
+     *
+     * @param {Object} definitions
+     * @param {Array<Transformer>} [definitions.transformers]
+     * @param {string} [definitions.dir]
+     * @param {Object} [entryProperties]
+     * @param {string} [entryProperties.destination]
+     * @param {Object} [directoryProperties]
+     */
+    constructor(definitions: {
+        transformers?: Array<Transformer>;
+        dir?: string;
+    }, entryProperties?: {
+        destination?: string;
+    }, directoryProperties?: any);
+    transformers: Transformer<any, any>[];
+    entryProperties: {
+        destination?: string;
+    };
     directoryProperties: any;
-    dir: any;
+    dir: string;
     /**
      * List all entries.
      * @return {AsyncIterable<ContentEntry|CollectionEntry>} all entries

package/types/content/file-content-provider.d.mts

@@ -1,12 +1,17 @@
 /**
  * Content provided form the file system.
- * @param {Object|string} definitions
- * @param {string|string[]} definitions.pattern
- * @param {string} definitions.base base directory where to find the files
  */
 export class FileContentProvider extends ContentProvider {
     static get description(): string;
-    definitions: any;
-    get isPatternMatch(): any;
+    /**
+     * Content provided form the file system.
+     * @param {Object|string} definitions
+     * @param {string|string[]} [definitions.pattern]
+     * @param {string} [definitions.base] base directory where to find the files
+     */
+    constructor(definitions: any | string, entryProperties: any, directoryProperties: any);
+    base: string;
+    pattern: string[];
+    get isPatternMatch(): string;
 }
 import { ContentProvider } from "./content-provider.mjs";

package/types/content/nft-content-provider.d.mts

@@ -1,12 +1,22 @@
 /**
  * Content provided form the file system.
- * @param {Object|string} definitions
- * @param {string|string[]} definitions.pattern
- * @param {string} definitions.base base directory where to find the files
  */
 export class NFTContentProvider extends ContentProvider {
     static get description(): string;
-    definitions: any;
+    /**
+     * Content provided form the file system.
+     * @param {Object|string} definitions
+     * @param {string} definitions.start base directory where to find the files
+     * @param {Array<Transformer>} [definitions.transformers]
+     * @param {string} [definitions.dir]
+     * @param {Object} [entryProperties]
+     * @param {string} [entryProperties.destination]
+     * @param {Object} [directoryProperties]
+   */
+    constructor(definitions: any | string, entryProperties?: {
+        destination?: string;
+    }, directoryProperties?: any);
+    start: any[];
     /**
      * @return {AsyncIterable<ContentEntry>} all entries
      */

package/types/content/node-modules-content-provider.d.mts

@@ -5,6 +5,7 @@
  */
 export class NodeModulesContentProvider extends ContentProvider {
     static get description(): string;
+    constructor(definitions: any, entryProperties: any, directoryProperties: any);
     withoutDevelpmentDependencies: boolean;
 }
 import { ContentProvider } from "./content-provider.mjs";

package/types/content/npm-pack-content-provider.d.mts

@@ -7,6 +7,7 @@
  */
 export class NPMPackContentProvider extends ContentProvider {
     static get description(): string;
+    constructor(definitions: any, entryProperties: any, directoryProperties: any);
     [Symbol.asyncIterator](): AsyncGenerator<any, void, unknown>;
 }
 import { ContentProvider } from "./content-provider.mjs";

package/types/output/arch.d.mts

@@ -4,6 +4,7 @@
  */
 export const pkgKeyValuePairOptions: any;
 export class ARCH extends Packager {
+    static get alias(): string;
     static get description(): string;
     static get fileNameExtension(): string;
     /**