npm-pkgbuild 17.0.0 → 17.0.2

package/README.md

@@ -99,24 +99,25 @@ 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)
     *   [name](#name)
 *   [NodeModulesContentProvider](#nodemodulescontentprovider)
-    *   [Parameters](#parameters-3)
+    *   [Parameters](#parameters-4)
     *   [Properties](#properties-2)
     *   [name](#name-1)
-*   [FileContentProvider](#filecontentprovider)
-    *   [Parameters](#parameters-4)
+*   [NPMPackContentProvider](#npmpackcontentprovider)
+    *   [Parameters](#parameters-5)
+    *   [Properties](#properties-3)
     *   [name](#name-2)
 *   [NFTContentProvider](#nftcontentprovider)
-    *   [Parameters](#parameters-5)
-    *   [name](#name-3)
-*   [ContentProvider](#contentprovider)
     *   [Parameters](#parameters-6)
-    *   [Properties](#properties-3)
-    *   [asyncIterator](#asynciterator)
+    *   [name](#name-3)
 *   [hookMapping](#hookmapping)
 *   [hookMapping](#hookmapping-1)
 *   [DEBIAN](#debian)
@@ -126,17 +127,16 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
 *   [fields](#fields-1)
 *   [fields](#fields-2)
 *   [fields](#fields-3)
-*   [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
 *   [quoteFile](#quotefile)
     *   [Parameters](#parameters-8)
 *   [RPM](#rpm)
     *   [prepare](#prepare-1)
         *   [Parameters](#parameters-9)
+*   [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
 *   [OCI](#oci)
 *   [DOCKER](#docker)
     *   [prepare](#prepare-2)
         *   [Parameters](#parameters-10)
-*   [BUILDAH](#buildah)
 *   [Packager](#packager)
     *   [Parameters](#parameters-11)
     *   [packageName](#packagename)
@@ -244,20 +244,45 @@ 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;
 
 ### 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>** 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;
 
 ### name
 
@@ -283,19 +308,20 @@ Requires .npmrc or NPM\_TOKEN environment
 
 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` **[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.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;
+### Properties
+
+*   `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
 ### name
 
@@ -319,26 +345,6 @@ Content provided form the file system.
 
 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;
-
-### 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>** all entries
-
 ## hookMapping
 
 map install hook named from arch to deb
@@ -371,21 +377,17 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ## fields
 
-well known package properties
-<https://www.archlinux.org/pacman/PKGBUILD.5.html>
+*   **See**: <https://rpm-packaging-guide.github.io>
 
 ## fields
 
-*   **See**: <https://rpm-packaging-guide.github.io>
+well known package properties
+<https://www.archlinux.org/pacman/PKGBUILD.5.html>
 
 ## fields
 
 *   **See**: <https://docs.docker.com/engine/reference/builder/>
 
-## pkgKeyValuePairOptions
-
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
-
 ## quoteFile
 
 ### Parameters
@@ -411,6 +413,10 @@ 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)
+
 ## OCI
 
 **Extends Packager**
@@ -436,12 +442,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": "17.0.0",
+  "version": "17.0.2",
   "publishConfig": {
     "access": "public",
     "provenance": false
@@ -73,7 +73,7 @@
     "uti": "^8.7.1"
   },
   "devDependencies": {
-    "@types/node": "^22.13.8",
+    "@types/node": "^22.13.9",
     "ava": "^6.2.0",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",

package/src/npm-pkgbuild-cli.mjs

@@ -153,7 +153,7 @@ program
             if (!options.dry) {
               await Promise.all(
                 publishingDetails.map(publishDetail =>
-                  o.publish(artifact, publishDetail, o.properties)
+                  o.publish(artifact, publishDetail)
                 )
               );
             }

package/src/output/arch.mjs

@@ -152,7 +152,7 @@ export class ARCH extends Packager {
       yield `
 package() {
   depends=(${self
-    .makeDepends(properties.depends)
+    .makeDepends(properties.dependencies)
     .map(v => quote(v))
     .join(" ")})
 
@@ -273,7 +273,7 @@ const fields = {
   groups: default_array_attribute,
   arch: { ...default_array_attribute, default: ["any"], mandatory: true },
   backup: default_array_attribute,
-  //depends: default_array_attribute,
+  depends: default_array_attribute,
   makedepends: default_attribute,
   checkdepends: default_attribute,
   optdepends: default_attribute,

package/src/output/docker.mjs

@@ -176,11 +176,11 @@ export class DOCKER extends Packager {
     return image;
   }
 
-  async publish(artifact, publishingDetails, properties, logger = console.log) {
+  async publish(artifact, publishingDetails, logger = console.log) {
     try {
       const url = new URL(publishingDetails.url);
       const repoLocation = `${url.host}/${publishingDetails.username}`;
-      const name = `${properties.name}:${properties.version}`;
+      const name = `${this.properties.name}:${this.properties.version}`;
 
       logger(`Publishing to ${repoLocation}`);
 

package/src/output/packager.mjs

@@ -172,7 +172,7 @@ export class Packager {
     throw new Error("not implemented");
   }
 
-  async publish(artifact, publishingDetails, properties, logger) {
-    return publish(artifact, publishingDetails, properties, logger);
+  async publish(artifact, publishingDetails, logger) {
+    return publish(artifact, publishingDetails, this.properties, logger);
   }
 }

package/types/output/arch.d.mts

@@ -94,6 +94,9 @@ export class ARCH extends Packager {
         backup: {
             type: string;
         };
+        depends: {
+            type: string;
+        };
         makedepends: {
             type: string;
         };

package/types/output/docker.d.mts

@@ -37,6 +37,6 @@ export class DOCKER extends Packager {
         arch: string;
     }): Promise<boolean>;
     create(sources: any, transformer: any, options: any, publishingDetails: any, expander: any): Promise<string>;
-    publish(artifact: any, publishingDetails: any, properties: any, logger?: (message?: any, ...optionalParams: any[]) => void): Promise<void>;
+    publish(artifact: any, publishingDetails: any, logger?: (message?: any, ...optionalParams: any[]) => void): Promise<void>;
 }
 import { Packager } from "./packager.mjs";

package/types/output/packager.d.mts

@@ -68,7 +68,7 @@ export class Packager {
      * @return {Promise<string>} identifier of the resulting package
      */
     create(sources: any, transformer: any[], publishingDetails: PublishingDetail[], options: any, expander: (arg0: string) => string | null): Promise<string>;
-    publish(artifact: any, publishingDetails: any, properties: any, logger: any): Promise<void>;
+    publish(artifact: any, publishingDetails: any, logger: any): Promise<void>;
     #private;
 }
 export type PublishingDetail = import("../publish.mjs").PublishingDetail;