npm-pkgbuild 20.0.0 → 20.1.0

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)
-*   [BUILDAH](#buildah)
-*   [ContentProvider](#contentprovider)
+*   [NPMPackContentProvider](#npmpackcontentprovider)
     *   [Parameters](#parameters-2)
     *   [Properties](#properties-1)
-    *   [asyncIterator](#asynciterator)
-*   [FileContentProvider](#filecontentprovider)
-    *   [Parameters](#parameters-3)
-    *   [asyncIterator](#asynciterator-1)
     *   [name](#name)
 *   [NodeModulesContentProvider](#nodemodulescontentprovider)
-    *   [Parameters](#parameters-4)
+    *   [Parameters](#parameters-3)
     *   [Properties](#properties-2)
-    *   [asyncIterator](#asynciterator-2)
+    *   [asyncIterator](#asynciterator)
     *   [name](#name-1)
-*   [NPMPackContentProvider](#npmpackcontentprovider)
-    *   [Parameters](#parameters-5)
-    *   [Properties](#properties-3)
+*   [FileContentProvider](#filecontentprovider)
+    *   [Parameters](#parameters-4)
+    *   [asyncIterator](#asynciterator-1)
     *   [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-1)
+    *   [attributes](#attributes-2)
     *   [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,51 +248,21 @@ Extract package definition from package.json.
 
 Returns **AsyncIterable<[PackageDefinition](#packagedefinition)>**&#x20;
 
-## BUILDAH
-
-**Extends DOCKER**
-
-Use buildah @see <https://buildah.io>
+## NPMPackContentProvider
 
-## ContentProvider
+**Extends ContentProvider**
 
-Source of package content.
+Content from npm pack.
 
 ### Parameters
 
-*   `definitions` &#x20;
-*   `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;
 
 ### 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
 
@@ -325,21 +295,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
 
-## NPMPackContentProvider
+## FileContentProvider
 
 **Extends ContentProvider**
 
-Content from npm pack.
+Content provided form the file system.
 
 ### 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` **([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;
+*   `entryProperties` &#x20;
 *   `directoryProperties` &#x20;
 
-### Properties
+### asyncIterator
 
-*   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
 
 ### name
 
@@ -354,11 +324,8 @@ 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;
+*   `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
+*   `directoryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
 
 ### asyncIterator
 
@@ -368,6 +335,26 @@ 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` **[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)?**&#x20;
+*   `directoryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
+
+### Properties
+
+*   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+### asyncIterator
+
+List all entries.
+
+Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
+
 ## DEBIAN
 
 **Extends Packager**
@@ -394,6 +381,15 @@ 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
@@ -427,15 +423,6 @@ 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**
@@ -465,6 +452,12 @@ 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": "20.0.0",
+  "version": "20.1.0",
   "publishConfig": {
     "access": "public",
     "provenance": false
@@ -59,7 +59,7 @@
     "compare-versions": "^6.1.1",
     "content-entry": "^14.2.7",
     "content-entry-filesystem": "^9.0.14",
-    "content-entry-transform": "^1.5.17",
+    "content-entry-transform": "^1.6.0",
     "execa": "^9.6.0",
     "expression-expander": "^7.2.8",
     "ini": "^6.0.0",
@@ -67,14 +67,14 @@
     "key-value-transformer": "^3.3.1",
     "npm-package-walker": "^8.0.11",
     "npm-packlist": "^10.0.3",
-    "pacc": "^8.0.2",
+    "pacc": "^8.0.3",
     "package-directory": "^8.1.0",
     "pacote": "^21.0.4",
     "tar-stream": "^3.1.7",
     "uti": "^8.10.3"
   },
   "devDependencies": {
-    "@types/node": "^25.0.8",
+    "@types/node": "^25.0.9",
     "ava": "^6.4.1",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",

package/src/extract-from-package.mjs

@@ -90,9 +90,7 @@ function* content2Sources(content, dir) {
       } else {
         switch (typeof definition) {
           case "object":
-            definition.dir = definition.dir
-              ? join(dir, definition.dir)
-              : dir;
+            definition.dir = definition.dir ? join(dir, definition.dir) : dir;
             break;
           case "string":
             definition = join(dir, definition);
@@ -110,6 +108,7 @@ function* content2Sources(content, dir) {
  * @typedef {Object} PackageDefinition
  * @property {Object} properties values describing the package attributes
  * @property {Object} properties.dependencies
+ * @property {Object} properties.replaces
  * @property {ContentProvider[]} sources content providers
  * @property {Object} output package type
  * @property {Object} variant identifier of the variant
@@ -136,159 +135,166 @@ export async function* extractFromPackage(options = {}, env = {}) {
 
   const packages = new Map();
 
-  await packageWalker(async (packageContent, dir, modulePath) => {
-    let i = 0;
+  await packageWalker(
+    async (packageContent, dir, modulePath) => {
+      let i = 0;
 
-    packages.set(packageContent.name, packageContent.version);
+      packages.set(packageContent.name, packageContent.version);
 
-    for (const pkgbuild of asArray(packageContent.pkgbuild)) {
-      if (modulePath.length > 0 && !pkgbuild.variant) {
-        continue;
-      }
+      for (const pkgbuild of asArray(packageContent.pkgbuild)) {
+        if (modulePath.length > 0 && !pkgbuild.variant) {
+          continue;
+        }
 
-      let name = `${packageContent.name}[${i++}]`;
+        let name = `${packageContent.name}[${i++}]`;
 
-      const fragment = {
-        dir,
-        name,
-        priority: 1,
-        dependencies: packageContent.engines || {},
-        arch: new Set(),
-        restrictArch: new Set()
-      };
+        const fragment = {
+          dir,
+          name,
+          priority: 1,
+          dependencies: packageContent.engines || {},
+          replaces: {},
+          arch: new Set(),
+          restrictArch: new Set()
+        };
 
-      const requires = pkgbuild.requires;
+        const requires = pkgbuild.requires;
 
-      if (requires) {
-        fragment.requires = requires;
-        delete pkgbuild.requires;
+        if (requires) {
+          fragment.requires = requires;
+          delete pkgbuild.requires;
 
-        let fullfilled = true;
+          let fullfilled = true;
 
-        if (requires.properties) {
-          for (const [k, v] of Object.entries(requires.properties)) {
-            if (root?.properties[k] !== v && options[k] !== v) {
-              fullfilled = false;
-              break;
-            }
+          if (requires.properties) {
+            for (const [k, v] of Object.entries(requires.properties)) {
+              if (root?.properties[k] !== v && options[k] !== v) {
+                fullfilled = false;
+                break;
+              }
 
-            fragment.priority += 1;
+              fragment.priority += 1;
+            }
           }
-        }
 
-        if (requires.environment) {
-          if (env[requires.environment.has] === undefined) {
-            fullfilled = false;
+          if (requires.environment) {
+            if (env[requires.environment.has] === undefined) {
+              fullfilled = false;
+            }
+            fragment.priority += 10;
           }
-          fragment.priority += 10;
-        }
 
-        if (fullfilled) {
-          if (options.verbose) {
-            console.log(`${name}: requirement fullfilled`, requires);
+          if (fullfilled) {
+            if (options.verbose) {
+              console.log(`${name}: requirement fullfilled`, requires);
+            }
+          } else {
+            if (options.verbose) {
+              console.log(`${name}: requirement not fullfilled`, requires);
+            }
+            continue;
           }
         } else {
           if (options.verbose) {
-            console.log(`${name}: requirement not fullfilled`, requires);
+            console.log(`${name}: load`);
           }
-          continue;
-        }
-      } else {
-        if (options.verbose) {
-          console.log(`${name}: load`);
         }
-      }
 
-      if (packageContent.cpu) {
-        for (const a of asArray(packageContent.cpu)) {
-          fragment.arch.add(npmArchMapping[a]);
+        if (packageContent.cpu) {
+          for (const a of asArray(packageContent.cpu)) {
+            fragment.arch.add(npmArchMapping[a]);
+          }
         }
-      }
 
-      if (pkgbuild.arch) {
-        for (const a of asArray(pkgbuild.arch)) {
-          if (modulePath.length === 0) {
-            fragment.arch.add(a);
-          } else {
-            fragment.restrictArch.add(a);
+        if (pkgbuild.arch) {
+          for (const a of asArray(pkgbuild.arch)) {
+            if (modulePath.length === 0) {
+              fragment.arch.add(a);
+            } else {
+              fragment.restrictArch.add(a);
+            }
           }
+          delete pkgbuild.arch;
         }
-        delete pkgbuild.arch;
-      }
 
-      for (const k of ["hooks"]) {
-        if (pkgbuild[k]) {
-          pkgbuild[k] = resolve(dir, pkgbuild[k]);
+        for (const k of ["hooks"]) {
+          if (pkgbuild[k]) {
+            pkgbuild[k] = resolve(dir, pkgbuild[k]);
+          }
         }
-      }
 
-      for (const k of ["output", "content", "dependencies"]) {
-        if (pkgbuild[k]) {
-          fragment[k] = pkgbuild[k];
-          delete pkgbuild[k];
+        for (const k of ["output", "content", "dependencies", "replaces"]) {
+          if (pkgbuild[k]) {
+            fragment[k] = pkgbuild[k];
+            delete pkgbuild[k];
+          }
         }
-      }
 
-      const properties = {};
+        const properties = {};
 
-      if (modulePath.length >= 1) {
-        fragment.parent =
-          modulePath.length === 1 ? parent : modulePath[modulePath.length - 2];
-      } else {
-        properties.access = packageContent?.publishConfig?.access || "private";
-
-        Object.assign(
-          properties,
-          packageContent.config,
-          Object.fromEntries(
-            ["name", "version", "description", "homepage", "license"]
-              .map(key => [key, packageContent[key]])
-              .filter(([k, v]) => v !== undefined)
-          )
-        );
+        if (modulePath.length >= 1) {
+          fragment.parent =
+            modulePath.length === 1
+              ? parent
+              : modulePath[modulePath.length - 2];
+        } else {
+          properties.access =
+            packageContent?.publishConfig?.access || "private";
+
+          Object.assign(
+            properties,
+            packageContent.config,
+            Object.fromEntries(
+              ["name", "version", "description", "homepage", "license"]
+                .map(key => [key, packageContent[key]])
+                .filter(([k, v]) => v !== undefined)
+            )
+          );
 
-        if (properties.name) {
-          properties.name = properties.name.replace(/^\@[^\/]+\//, "");
-        }
+          if (properties.name) {
+            properties.name = properties.name.replace(/^\@[^\/]+\//, "");
+          }
 
-        if (packageContent.bugs?.url) {
-          properties.bugs = packageContent.bugs.url;
-        }
+          if (packageContent.bugs?.url) {
+            properties.bugs = packageContent.bugs.url;
+          }
 
-        if (packageContent.bin) {
-          properties.entrypoints = packageContent.bin;
-        }
+          if (packageContent.bin) {
+            properties.entrypoints = packageContent.bin;
+          }
 
-        if (packageContent.contributors) {
-          properties.maintainer = packageContent.contributors.map(
-            c => c.name + (c.email ? ` <${c.email}>` : "")
-          );
-        }
+          if (packageContent.contributors) {
+            properties.maintainer = packageContent.contributors.map(
+              c => c.name + (c.email ? ` <${c.email}>` : "")
+            );
+          }
 
-        if (typeof packageContent.repository === "string") {
-          properties.source = packageContent.repository;
-        } else {
-          if (packageContent.repository?.url) {
-            properties.source = packageContent.repository.url;
+          if (typeof packageContent.repository === "string") {
+            properties.source = packageContent.repository;
+          } else {
+            if (packageContent.repository?.url) {
+              properties.source = packageContent.repository.url;
+            }
           }
         }
-      }
 
-      fragment.properties = Object.assign(properties, pkgbuild);
-      fragments[fragment.name] = fragment;
+        fragment.properties = Object.assign(properties, pkgbuild);
+        fragments[fragment.name] = fragment;
 
-      if (pkgbuild.variant) {
-        variants[pkgbuild.variant] = fragment;
-      }
+        if (pkgbuild.variant) {
+          variants[pkgbuild.variant] = fragment;
+        }
 
-      if (modulePath.length === 0) {
-        root = fragment;
+        if (modulePath.length === 0) {
+          root = fragment;
+        }
+        parent = fragment.name;
       }
-      parent = fragment.name;
-    }
 
-    return true;
-  }, await packageDirectory({ cwd: options.dir }));
+      return true;
+    },
+    await packageDirectory({ cwd: options.dir })
+  );
 
   if (root && Object.keys(variants).length === 0) {
     // @ts-ignore
@@ -301,6 +307,7 @@ export async function* extractFromPackage(options = {}, env = {}) {
     let arch = variant.arch;
     let properties = {};
     let dependencies = {};
+    let replaces = {};
     const output = {};
     const content = [];
 
@@ -332,6 +339,7 @@ export async function* extractFromPackage(options = {}, env = {}) {
         arch = new Set([...arch, ...fragment.arch]);
         properties = { ...fragment.properties, ...properties };
         dependencies = mergeDependencies(dependencies, fragment.dependencies);
+        replaces = mergeDependencies(replaces, fragment.replaces);
         Object.assign(output, fragment.output);
         for (const def of Object.values(output)) {
           if (def.content && !def.dir) {
@@ -349,6 +357,7 @@ export async function* extractFromPackage(options = {}, env = {}) {
     // @ts-ignore
     Object.assign(properties, root.properties);
     delete properties.dependencies;
+    delete properties.replaces;
 
     properties.variant = name;
 
@@ -357,6 +366,7 @@ export async function* extractFromPackage(options = {}, env = {}) {
       content,
       output,
       dependencies,
+      replaces,
       properties
     };
 
@@ -388,7 +398,8 @@ export async function* extractFromPackage(options = {}, env = {}) {
           dependencies: mergeDependencies(
             result.dependencies,
             output.dependencies
-          )
+          ),
+          replaces: mergeDependencies(result.replaces, output.replaces)
         };
 
         const context = createContext({ properties });

package/src/output/arch.mjs

@@ -15,7 +15,8 @@ import {
   Packager,
   pkgbuild_version_attribute,
   pkgbuild_description_attribute,
-  pkgbuild_name_attribute
+  pkgbuild_name_attribute,
+  dependency_attribute_collection_writable
 } from "./packager.mjs";
 import {
   copyEntries,
@@ -111,13 +112,13 @@ export class ARCH extends Packager {
     groups: string_collection_attribute_writable,
     arch: { ...string_collection_attribute_writable, default: ["any"], mandatory: true },
     backup: string_collection_attribute_writable,
-    depends: string_collection_attribute_writable,
-    makedepends: default_attribute,
-    checkdepends: default_attribute,
-    optdepends: default_attribute,
-    conflicts: default_attribute,
-    provides: default_attribute,
-    replaces: default_attribute,
+    depends: { ...dependency_attribute_collection_writable /*, alias: "dependencies" */ },
+    makedepends: dependency_attribute_collection_writable,
+    checkdepends: dependency_attribute_collection_writable,
+    optdepends: dependency_attribute_collection_writable,
+    conflicts: dependency_attribute_collection_writable,
+    provides: dependency_attribute_collection_writable,
+    replaces: dependency_attribute_collection_writable,
     options: default_attribute
   };
 
@@ -211,6 +212,7 @@ package() {
       properties.backup = properties.backup.replace(/\//, "");
     }
 
+    console.log(properties);
     const fp = fieldProvider(properties, this.attributes);
 
     transformer.push({