npm-pkgbuild 16.0.1 → 17.0.0

package/README.md

@@ -103,41 +103,40 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
     *   [Parameters](#parameters-2)
     *   [Properties](#properties-1)
     *   [name](#name)
-*   [FileContentProvider](#filecontentprovider)
+*   [NodeModulesContentProvider](#nodemodulescontentprovider)
     *   [Parameters](#parameters-3)
+    *   [Properties](#properties-2)
     *   [name](#name-1)
-*   [NFTContentProvider](#nftcontentprovider)
+*   [FileContentProvider](#filecontentprovider)
     *   [Parameters](#parameters-4)
     *   [name](#name-2)
-*   [ContentProvider](#contentprovider)
+*   [NFTContentProvider](#nftcontentprovider)
     *   [Parameters](#parameters-5)
-    *   [Properties](#properties-2)
-    *   [destinationPrefix](#destinationprefix)
+    *   [name](#name-3)
+*   [ContentProvider](#contentprovider)
+    *   [Parameters](#parameters-6)
+    *   [Properties](#properties-3)
     *   [asyncIterator](#asynciterator)
 *   [hookMapping](#hookmapping)
 *   [hookMapping](#hookmapping-1)
 *   [DEBIAN](#debian)
     *   [prepare](#prepare)
-        *   [Parameters](#parameters-6)
+        *   [Parameters](#parameters-7)
 *   [fields](#fields)
 *   [fields](#fields-1)
 *   [fields](#fields-2)
 *   [fields](#fields-3)
 *   [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
 *   [quoteFile](#quotefile)
-    *   [Parameters](#parameters-7)
+    *   [Parameters](#parameters-8)
 *   [RPM](#rpm)
     *   [prepare](#prepare-1)
-        *   [Parameters](#parameters-8)
+        *   [Parameters](#parameters-9)
 *   [OCI](#oci)
 *   [DOCKER](#docker)
     *   [prepare](#prepare-2)
-        *   [Parameters](#parameters-9)
+        *   [Parameters](#parameters-10)
 *   [BUILDAH](#buildah)
-*   [NodeModulesContentProvider](#nodemodulescontentprovider)
-    *   [Parameters](#parameters-10)
-    *   [Properties](#properties-3)
-    *   [name](#name-3)
 *   [Packager](#packager)
     *   [Parameters](#parameters-11)
     *   [packageName](#packagename)
@@ -173,11 +172,10 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
 *   [publish](#publish)
     *   [Parameters](#parameters-23)
 *   [utf8StreamOptions](#utf8streamoptions)
-    *   [Properties](#properties-6)
 *   [decodePassword](#decodepassword)
     *   [Parameters](#parameters-24)
 *   [FunctionDecl](#functiondecl)
-    *   [Properties](#properties-7)
+    *   [Properties](#properties-6)
 *   [extractFunctions](#extractfunctions)
     *   [Parameters](#parameters-25)
 *   [fieldProvider](#fieldprovider)
@@ -218,8 +216,9 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 ### Properties
 
 *   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** values describing the package attributes
+
+    *   `properties.dependencies` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 *   `sources` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentProvider](#contentprovider)>** content providers
-*   `dependencies` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 *   `output` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** package type
 *   `variant` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** identifier of the variant
 
@@ -264,6 +263,26 @@ Content from npm pack.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
 
+## NodeModulesContentProvider
+
+**Extends ContentProvider**
+
+Content from node\_modules.
+Requires .npmrc or NPM\_TOKEN environment
+
+### Parameters
+
+*   `definitions` &#x20;
+*   `entryProperties` &#x20;
+
+### Properties
+
+*   `withoutDevelpmentDependencies` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
+
+### name
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
+
 ## FileContentProvider
 
 **Extends ContentProvider**
@@ -314,10 +333,6 @@ Source of package content.
 *   `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;
 
-### destinationPrefix
-
-Returns **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))**&#x20;
-
 ### asyncIterator
 
 List all entries.
@@ -427,27 +442,6 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 Use buildah @see <https://buildah.io>
 
-## NodeModulesContentProvider
-
-**Extends ContentProvider**
-
-Content from node\_modules.
-Requires .npmrc or NPM\_TOKEN environment
-
-### Parameters
-
-*   `definitions` &#x20;
-*   `entryProperties` &#x20;
-
-### Properties
-
-*   `withoutDevelpmentDependencies` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
-*   `destinationPrefix` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base name out output
-
-### name
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
-
 ## Packager
 
 ### Parameters
@@ -489,10 +483,9 @@ Execute package generation.
 
 *   `sources` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 *   `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**&#x20;
-*   `dependencies` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 *   `publishingDetails` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[PublishingDetail](#publishingdetail)>**&#x20;
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
-*   `expander` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `expander` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** identifier of the resulting package
 
@@ -552,10 +545,9 @@ Execute package generation.
 
 *   `sources` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 *   `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>**&#x20;
-*   `dependencies` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 *   `publishingDetails` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[PublishingDetail](#publishingdetail)>**&#x20;
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
-*   `expander` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `expander` **function ([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)): [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
 
 Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** identifier of the resulting package
 
@@ -629,11 +621,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
 
 ## utf8StreamOptions
 
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
-
-### Properties
-
-*   `encoding` **BufferEncoding**&#x20;
+Type: BufferEncoding
 
 ## decodePassword
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-pkgbuild",
-  "version": "16.0.1",
+  "version": "17.0.0",
   "publishConfig": {
     "access": "public",
     "provenance": false
@@ -65,7 +65,7 @@
     "ini": "^5.0.0",
     "iterable-string-interceptor": "^3.0.0",
     "key-value-transformer": "^3.2.3",
-    "npm-package-walker": "^7.0.7",
+    "npm-package-walker": "^8.0.0",
     "npm-packlist": "^10.0.0",
     "pacote": "^21.0.0",
     "pkg-dir": "^8.0.0",
@@ -73,13 +73,13 @@
     "uti": "^8.7.1"
   },
   "devDependencies": {
-    "@types/node": "^22.13.4",
+    "@types/node": "^22.13.8",
     "ava": "^6.2.0",
     "c8": "^10.1.3",
     "documentation": "^14.0.3",
     "semantic-release": "^24.2.3",
     "stream-buffers": "^3.0.3",
-    "typescript": "^5.7.3"
+    "typescript": "^5.8.2"
   },
   "engines": {
     "node": ">=22.13.0",

package/src/extract-from-package.mjs

@@ -109,8 +109,8 @@ function* content2Sources(content, dir) {
 /**
  * @typedef {Object} PackageDefinition
  * @property {Object} properties values describing the package attributes
+ * @property {Object} properties.dependencies
  * @property {ContentProvider[]} sources content providers
- * @property {Object} dependencies
  * @property {Object} output package type
  * @property {Object} variant identifier of the variant
  * @property {string} variant.name name of the variant
@@ -261,7 +261,7 @@ export async function* extractFromPackage(options = {}, env = {}) {
 
         if (packageContent.contributors) {
           properties.maintainer = packageContent.contributors.map(
-            c => c.name + (c.email ? ` <${c.email}>` : '')
+            c => c.name + (c.email ? ` <${c.email}>` : "")
           );
         }
 
@@ -360,7 +360,7 @@ export async function* extractFromPackage(options = {}, env = {}) {
       properties
     };
 
-    function* forEachOutput(result) {      
+    function* forEachOutput(result) {
       if (Object.entries(result.output).length === 0) {
         result.context = createContext({ properties: result.properties });
         result.sources = [];
@@ -384,7 +384,11 @@ export async function* extractFromPackage(options = {}, env = {}) {
         const properties = {
           type: name,
           ...result.properties,
-          ...output.properties
+          ...output.properties,
+          dependencies: mergeDependencies(
+            result.dependencies,
+            output.dependencies
+          )
         };
 
         const context = createContext({ properties });
@@ -399,11 +403,7 @@ export async function* extractFromPackage(options = {}, env = {}) {
           variant: { ...result.variant, output: name },
           output: { [name]: output },
           sources,
-          dependencies: mergeDependencies(
-            result.dependencies,
-            output.dependencies
-          ),
-          properties : context.expand(properties)
+          properties: context.expand(properties)
         };
       }
     }

package/src/npm-pkgbuild-cli.mjs

@@ -56,7 +56,6 @@ program
         sources,
         output,
         variant,
-        dependencies,
         context
       } of extractFromPackage(options, process.env)) {
         for (const inputFactory of allInputs.filter(
@@ -139,14 +138,13 @@ program
               console.log("sources:");
               console.log("  " + sources.join("\n  "));
               console.log("dependencies:");
-              console.log(kv(dependencies, "  "));
+              console.log(kv(properties.dependencies, "  "));
               console.log("publish:", publishingDetails.map(pd=>pd.url));
             }
 
             const artifact = await o.create(
               sources.map(c => c[Symbol.asyncIterator]()),
               transformer,
-              dependencies,
               publishingDetails,
               options,
               context.expand

package/src/output/arch.mjs

@@ -116,7 +116,13 @@ export class ARCH extends Packager {
     return `${p.name}-${p.version}-${p.release}-${p.arch}${this.fileNameExtension}`;
   }
 
-  makeDepends(dependencies) {
+  makeDepends(dependencies={}) {
+    if(Array.isArray(dependencies)) {
+      dependencies = Object.fromEntries(dependencies.map(d => {
+        const m = d.match(/^([^=<>]+)(.*)/)
+        return [m[1],m[2]];
+      }));
+    }
     return Object.entries(dependencies)
       .filter(filterOutUnwantedDependencies())
       .map(
@@ -128,7 +134,6 @@ export class ARCH extends Packager {
   async create(
     sources,
     transformer,
-    dependencies,
     publishingDetails,
     options,
     expander
@@ -147,7 +152,7 @@ export class ARCH extends Packager {
       yield `
 package() {
   depends=(${self
-    .makeDepends(dependencies)
+    .makeDepends(properties.depends)
     .map(v => quote(v))
     .join(" ")})
 
@@ -268,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/debian.mjs

@@ -102,7 +102,6 @@ export class DEBIAN extends Packager {
   async create(
     sources,
     transformer,
-    dependencies,
     publishingDetails,
     options,
     expander
@@ -117,8 +116,8 @@ export class DEBIAN extends Packager {
       )
     );
 
-    if (Object.keys(dependencies).length > 0) {
-      properties.Depends = Object.entries(dependencies)
+    if (properties.dependencies && Object.keys(properties.dependencies).length > 0) {
+      properties.Depends = Object.entries(properties.dependencies)
         .filter(filterOutUnwantedDependencies())
         .map(([name, e]) => `${this.packageName(name)} (${e})`);
     }

package/src/output/docker.mjs

@@ -72,7 +72,6 @@ export class DOCKER extends Packager {
   async create(
     sources,
     transformer,
-    dependencies,
     options,
     publishingDetails,
     expander
@@ -87,7 +86,7 @@ export class DOCKER extends Packager {
       for (const [k, v] of Object.entries({
         ...properties.from,
         ...Object.fromEntries(
-          Object.entries(dependencies)
+          Object.entries(properties.dependencies)
             .filter(filterOutUnwantedDependencies())
             .filter(([k, v]) => dependenciesToFrom[k])
             .map(([k, v]) => [dependenciesToFrom[k], v.replace(/[>=]*/, "")])

package/src/output/oci.mjs

@@ -79,7 +79,6 @@ export class OCI extends Packager {
   async create(
     sources,
     transformer,
-    dependencies,
     publishingDetails,
     options,
     expander = v => v

package/src/output/packager.mjs

@@ -157,16 +157,14 @@ export class Packager {
    * Execute package generation.
    * @param {Object} sources
    * @param {Object[]} transformer
-   * @param {Object} dependencies
    * @param {PublishingDetail[]} publishingDetails
    * @param {Object} options
-   * @param {function(string):string} expander
+   * @param {function(string):string?} expander
    * @return {Promise<string>} identifier of the resulting package
    */
   async create(
     sources,
     transformer,
-    dependencies,
     publishingDetails,
     options,
     expander

package/src/output/rpm.mjs

@@ -94,7 +94,7 @@ export class RPM extends Packager {
     return false;
   }
 
-  requiresFromDependencies(dependencies) {
+  requiresFromDependencies(dependencies={}) {
     return Object.entries(dependencies)
       .filter(filterOutUnwantedDependencies())
       .map(
@@ -112,7 +112,6 @@ export class RPM extends Packager {
   async create(
     sources,
     transformer,
-    dependencies,
     publishingDetails,
     options,
     expander
@@ -121,7 +120,7 @@ export class RPM extends Packager {
       options
     );
 
-    properties.Requires = this.requiresFromDependencies(dependencies);
+    properties.Requires = this.requiresFromDependencies(properties.dependencies);
 
     if (properties.Packager?.length > 1) {
       // TODO how to write several Packages ?

package/src/util.mjs

@@ -5,10 +5,9 @@ import { createWriteStream } from "node:fs";
 import { ContentEntry } from "content-entry";
 
 /**
- * @type {Object}
- * @property {BufferEncoding} encoding
+ * @type {BufferEncoding}
  */
-export const utf8StreamOptions = { encoding: "utf8" };
+export const utf8StreamOptions = "utf8";
 
 export function filterOutUnwantedDependencies() {
   return ([name, version]) => version !== "-";

package/types/extract-from-package.d.mts

@@ -1,8 +1,8 @@
 /**
  * @typedef {Object} PackageDefinition
  * @property {Object} properties values describing the package attributes
+ * @property {Object} properties.dependencies
  * @property {ContentProvider[]} sources content providers
- * @property {Object} dependencies
  * @property {Object} output package type
  * @property {Object} variant identifier of the variant
  * @property {string} variant.name name of the variant
@@ -48,12 +48,13 @@ export type PackageDefinition = {
     /**
      * values describing the package attributes
      */
-    properties: any;
+    properties: {
+        dependencies: any;
+    };
     /**
      * content providers
      */
     sources: ContentProvider[];
-    dependencies: any;
     /**
      * package type
      */

package/types/output/arch.d.mts

@@ -94,9 +94,6 @@ export class ARCH extends Packager {
         backup: {
             type: string;
         };
-        depends: {
-            type: string;
-        };
         makedepends: {
             type: string;
         };
@@ -121,7 +118,7 @@ export class ARCH extends Packager {
     };
     static prepare(options?: {}, variant?: {}): Promise<boolean>;
     get packageFileName(): string;
-    makeDepends(dependencies: any): string[];
-    create(sources: any, transformer: any, dependencies: any, publishingDetails: any, options: any, expander: any): Promise<string>;
+    makeDepends(dependencies?: {}): string[];
+    create(sources: any, transformer: any, publishingDetails: any, options: any, expander: any): Promise<string>;
 }
 import { Packager } from "./packager.mjs";

package/types/output/debian.d.mts

@@ -105,7 +105,7 @@ export class DEBIAN extends Packager {
     }): Promise<boolean>;
     get packageFileName(): string;
     hookFiles(properties: any): AsyncGenerator<StringContentEntry, void, unknown>;
-    create(sources: any, transformer: any, dependencies: any, publishingDetails: any, options: any, expander: any): Promise<string>;
+    create(sources: any, transformer: any, publishingDetails: any, options: any, expander: any): Promise<string>;
 }
 import { Packager } from "./packager.mjs";
 import { StringContentEntry } from "content-entry";

package/types/output/docker.d.mts

@@ -36,7 +36,7 @@ export class DOCKER extends Packager {
     static prepare(options: any, variant: {
         arch: string;
     }): Promise<boolean>;
-    create(sources: any, transformer: any, dependencies: any, options: any, publishingDetails: any, expander: any): Promise<string>;
+    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>;
 }
 import { Packager } from "./packager.mjs";

package/types/output/oci.d.mts

@@ -6,6 +6,6 @@ export class OCI extends Packager {
     static get fileNameExtension(): string;
     static prepare(options: any, variant: any): Promise<boolean>;
     get packageFileName(): string;
-    create(sources: any, transformer: any, dependencies: any, publishingDetails: any, options: any, expander?: (v: any) => any): Promise<string>;
+    create(sources: any, transformer: any, publishingDetails: any, options: any, expander?: (v: any) => any): Promise<string>;
 }
 import { Packager } from "./packager.mjs";

package/types/output/packager.d.mts

@@ -62,13 +62,12 @@ export class Packager {
      * Execute package generation.
      * @param {Object} sources
      * @param {Object[]} transformer
-     * @param {Object} dependencies
      * @param {PublishingDetail[]} publishingDetails
      * @param {Object} options
-     * @param {function(string):string} expander
+     * @param {function(string):string?} expander
      * @return {Promise<string>} identifier of the resulting package
      */
-    create(sources: any, transformer: any[], dependencies: any, publishingDetails: PublishingDetail[], options: any, expander: (arg0: string) => string): Promise<string>;
+    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>;
     #private;
 }

package/types/output/rpm.d.mts

@@ -84,8 +84,8 @@ export class RPM extends Packager {
         arch: string;
     }): Promise<boolean>;
     get packageFileName(): string;
-    requiresFromDependencies(dependencies: any): string[];
-    create(sources: any, transformer: any, dependencies: any, publishingDetails: any, options: any, expander: any): Promise<string>;
+    requiresFromDependencies(dependencies?: {}): string[];
+    create(sources: any, transformer: any, publishingDetails: any, options: any, expander: any): Promise<string>;
 }
 export type PublishingDetail = import("../publish.mjs").PublishingDetail;
 import { Packager } from "./packager.mjs";

package/types/util.d.mts

@@ -40,10 +40,9 @@ export function fieldProvider(properties: any, fields: any): Function;
  */
 export function copyEntries(source: AsyncIterable<ContentEntry>, destinationDirectory: string, expander?: Expander): AsyncGenerator<ContentEntry, void, unknown>;
 /**
- * @type {Object}
- * @property {BufferEncoding} encoding
+ * @type {BufferEncoding}
  */
-export const utf8StreamOptions: any;
+export const utf8StreamOptions: BufferEncoding;
 export type FunctionDecl = {
     name: string;
     body: string;