npm-pkgbuild 17.2.5 → 17.3.0

package/README.md

@@ -99,25 +99,24 @@ 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)
     *   [name](#name)
 *   [NodeModulesContentProvider](#nodemodulescontentprovider)
-    *   [Parameters](#parameters-4)
+    *   [Parameters](#parameters-3)
     *   [Properties](#properties-2)
     *   [name](#name-1)
-*   [NPMPackContentProvider](#npmpackcontentprovider)
-    *   [Parameters](#parameters-5)
-    *   [Properties](#properties-3)
+*   [FileContentProvider](#filecontentprovider)
+    *   [Parameters](#parameters-4)
     *   [name](#name-2)
 *   [NFTContentProvider](#nftcontentprovider)
-    *   [Parameters](#parameters-6)
+    *   [Parameters](#parameters-5)
     *   [name](#name-3)
+*   [ContentProvider](#contentprovider)
+    *   [Parameters](#parameters-6)
+    *   [Properties](#properties-3)
+    *   [asyncIterator](#asynciterator)
 *   [hookMapping](#hookmapping)
 *   [hookMapping](#hookmapping-1)
 *   [DEBIAN](#debian)
@@ -127,16 +126,17 @@ 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,45 +244,20 @@ 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
 
 ### 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
 
@@ -308,20 +283,19 @@ Requires .npmrc or NPM\_TOKEN environment
 
 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
-
-### Properties
+*   `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;
 
-*   `dir` **[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
 
@@ -345,6 +319,26 @@ 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
@@ -377,17 +371,21 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ## fields
 
-*   **See**: <https://rpm-packaging-guide.github.io>
+well known package properties
+<https://www.archlinux.org/pacman/PKGBUILD.5.html>
 
 ## fields
 
-well known package properties
-<https://www.archlinux.org/pacman/PKGBUILD.5.html>
+*   **See**: <https://rpm-packaging-guide.github.io>
 
 ## 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
@@ -413,10 +411,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)
-
 ## OCI
 
 **Extends Packager**
@@ -442,6 +436,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": "17.2.5",
+  "version": "17.3.0",
   "publishConfig": {
     "access": "public",
     "provenance": false

package/src/output/arch.mjs

@@ -1,20 +1,20 @@
 import { join } from "node:path";
-import { createReadStream, createWriteStream } from "node:fs";
+import { createWriteStream } from "node:fs";
 import { readFile } from "node:fs/promises";
-import { pipeline } from "node:stream/promises";
 import { execa } from "execa";
 import { ContentEntry, ReadableStreamContentEntry } from "content-entry";
-import {
-  transform,
-  createPropertiesInterceptor
-} from "content-entry-transform";
-import { iterableStringInterceptor } from "iterable-string-interceptor";
+import { transform } from "content-entry-transform";
 import {
   keyValueTransformer,
   equalSeparatedKeyValuePairOptions
 } from "key-value-transformer";
 import { aggregateFifo } from "aggregate-async-iterator";
-import { Packager, VERSION_FIELD, DESCRIPTION_FIELD, NAME_FIELD } from "./packager.mjs";
+import {
+  Packager,
+  VERSION_FIELD,
+  DESCRIPTION_FIELD,
+  NAME_FIELD
+} from "./packager.mjs";
 import {
   copyEntries,
   fieldProvider,
@@ -125,6 +125,18 @@ export class ARCH extends Packager {
     }
     if (properties.hooks) {
       properties.install = `${properties.name}.install`;
+
+      const out = createWriteStream(
+        join(staging, properties.install),
+        utf8StreamOptions
+      );
+
+      for await (const hook of this.hookContent()) {
+        out.write(`${hook.name}() {\n`);
+        out.write(hook.string);
+        out.write(`}\n`);
+      }
+      out.end();
     }
 
     const self = this;
@@ -149,16 +161,6 @@ package() {
       properties.backup = properties.backup.replace(/\//, "");
     }
 
-    if (properties.hooks) {
-      await pipeline(
-        iterableStringInterceptor(
-          createReadStream(properties.hooks, utf8StreamOptions),
-          createPropertiesInterceptor(properties)
-        ),
-        createWriteStream(join(staging, properties.install), utf8StreamOptions)
-      );
-    }
-
     const fp = fieldProvider(properties, fields);
 
     transformer.push({

package/src/output/debian.mjs

@@ -1,12 +1,7 @@
 import { join } from "node:path";
-import { createReadStream } from "node:fs";
 import { readFile } from "node:fs/promises";
 import { execa } from "execa";
-import {
-  ContentEntry,
-  ReadableStreamContentEntry,
-  StringContentEntry
-} from "content-entry";
+import { ContentEntry, ReadableStreamContentEntry } from "content-entry";
 import {
   transform,
   createPropertiesTransformer
@@ -19,21 +14,7 @@ import {
   DESCRIPTION_FIELD,
   NAME_FIELD
 } from "./packager.mjs";
-import {
-  copyEntries,
-  fieldProvider,
-  extractFunctions,
-  utf8StreamOptions,
-  compileFields
-} from "../util.mjs";
-
-/**
- * map install hook named from arch to deb
- */
-const hookMapping = {
-  post_install: "DEBIAN/postinst",
-  post_remove: "DEBIAN/postrm"
-};
+import { copyEntries, fieldProvider, compileFields } from "../util.mjs";
 
 /**
  * Create .deb packages
@@ -84,24 +65,14 @@ export class DEBIAN extends Packager {
     return `${p.name}_${p.version}_${arch}${this.constructor.fileNameExtension}`;
   }
 
-  async *hookFiles(properties) {
-    if (properties.hooks) {
-      for await (const f of extractFunctions(
-        createReadStream(properties.hooks, utf8StreamOptions)
-      )) {
-        const name = hookMapping[f.name];
-        if (name) {
-          yield new StringContentEntry(
-            name,
-            f.body.replaceAll(
-              /\{\{(\w+)\}\}/gm,
-              (match, key, offset, string) =>
-                properties[key] || "{{" + key + "}}"
-            )
-          );
-        }
-      }
-    }
+  /**
+   * Map install hook named from default (arch) to deb.
+   */
+  get hookMapping() {
+    return {
+      post_install: "DEBIAN/postinst",
+      post_remove: "DEBIAN/postrm"
+    };
   }
 
   makeDepends(deps) {
@@ -145,7 +116,7 @@ export class DEBIAN extends Packager {
 
     for await (const file of copyEntries(
       transform(
-        aggregateFifo([...sources, this.hookFiles(properties)]),
+        aggregateFifo([...sources, this.hookContent()]),
         transformer
       ),
       staging,

package/src/output/packager.mjs

@@ -1,8 +1,14 @@
 import { join } from "node:path";
 import { tmpdir } from "node:os";
 import { mkdtemp, mkdir } from "node:fs/promises";
+import { createReadStream } from "node:fs";
+import { StringContentEntry } from "content-entry";
 import { publish } from "../publish.mjs";
-import { filterOutUnwantedDependencies } from "../util.mjs";
+import {
+  filterOutUnwantedDependencies,
+  extractFunctions,
+  utf8StreamOptions
+} from "../util.mjs";
 
 /**
  * @typedef {import('../publish.mjs').PublishingDetail} PublishingDetail
@@ -69,6 +75,46 @@ export class Packager {
     return mapping[name] || name;
   }
 
+  get hookMapping() {
+    return {};
+  }
+
+  async *hookContent() {
+    const properties = this.properties;
+
+    switch (properties.hooks) {
+      case "string":
+        for await (const f of extractFunctions(
+          createReadStream(properties.hooks, utf8StreamOptions)
+        )) {
+          const name = this.hookMapping[f.name] || f.name;
+          if (name) {
+            yield new StringContentEntry(
+              name,
+              f.body.replaceAll(
+                /\{\{(\w+)\}\}/gm,
+                (match, key, offset, string) =>
+                  properties[key] || "{{" + key + "}}"
+              )
+            );
+          }
+        }
+        break;
+
+      case "object":
+        for (const [name, content] of Object.entries(properties.hooks)) {
+          yield new StringContentEntry(
+            name,
+            content.replaceAll(
+              /\{\{(\w+)\}\}/gm,
+              (match, key, offset, string) =>
+                properties[key] || "{{" + key + "}}"
+            )
+          );
+        }
+    }
+  }
+
   makeDepends(
     dependencies,
     exp = (name, expression) => `${name}${expression}`

package/src/output/rpm.mjs

@@ -10,7 +10,12 @@ import {
   colonSeparatedKeyValuePairOptionsDoublingKeys
 } from "key-value-transformer";
 import { aggregateFifo } from "aggregate-async-iterator";
-import { Packager, VERSION_FIELD, DESCRIPTION_FIELD, NAME_FIELD } from "./packager.mjs";
+import {
+  Packager,
+  VERSION_FIELD,
+  DESCRIPTION_FIELD,
+  NAME_FIELD
+} from "./packager.mjs";
 import {
   copyEntries,
   fieldProvider,
@@ -27,19 +32,6 @@ function quoteFile(name) {
   return name.match(/\s/) ? '"' + name + '"' : name;
 }
 
-/**
- * map install hook named from arch to rpm
- */
-const hookMapping = {
-  pre_install: "pre",
-  post_install: "post",
-  pre_remove: "preun",
-  post_remove: "postun"
-  /* TODO with logic check $1
-  pre_upgrade:
-  post_upgrade:*/
-};
-
 /**
  * Produce rpm packages.
  */
@@ -108,6 +100,21 @@ export class RPM extends Packager {
     );
   }
 
+  /**
+   * Map install hook named from default (arch) to rpm.
+   */
+  get hookMapping() {
+    return {
+      pre_install: "pre",
+      post_install: "post",
+      pre_remove: "preun",
+      post_remove: "postun"
+      /* TODO with logic check $1
+  pre_upgrade:
+  post_upgrade:*/
+    };
+  }
+
   async create(sources, transformer, publishingDetails, options, expander) {
     const { properties, tmpdir, staging, destination } = await this.prepare(
       options
@@ -124,25 +131,14 @@ export class RPM extends Packager {
 
     const files = [];
 
+    const self = this;
     async function* trailingLines() {
       yield "%define _unpackaged_files_terminate_build 0\n";
       yield `%description\n\n`;
 
-      if (properties.hooks) {
-        for await (const f of extractFunctions(
-          createReadStream(properties.hooks, utf8StreamOptions)
-        )) {
-          const name = hookMapping[f.name];
-          if (name) {
-            yield `%${name}\n`;
-
-            yield f.body.replaceAll(
-              /\{\{(\w+)\}\}/gm,
-              (match, key, offset, string) =>
-                properties[key] || "{{" + key + "}}"
-            ) + "\n\n";
-          }
-        }
+      for await (const hook of self.hookContent()) {
+        yield `%${hook.name}\n`;
+        yield * hook.string.split("\n").map(l=>l+"\n");
       }
 
       yield `%files\n\n`;

package/types/output/debian.d.mts

@@ -15,9 +15,14 @@ export class DEBIAN extends Packager {
         arch: string;
     }): Promise<boolean>;
     get packageFileName(): string;
-    hookFiles(properties: any): AsyncGenerator<StringContentEntry, void, unknown>;
+    /**
+     * Map install hook named from default (arch) to deb.
+     */
+    get hookMapping(): {
+        post_install: string;
+        post_remove: string;
+    };
     makeDepends(deps: any): 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/packager.d.mts

@@ -38,6 +38,8 @@ export class Packager {
      * @return {string} package name in the target eco-system
      */
     packageName(name: string): string;
+    get hookMapping(): {};
+    hookContent(): AsyncGenerator<StringContentEntry, void, unknown>;
     makeDepends(dependencies: any, exp?: (name: any, expression: any) => string): string[];
     get fileNameExtension(): any;
     get fields(): any;
@@ -104,3 +106,4 @@ export type Field = {
     default: any;
     mandatory: boolean;
 };
+import { StringContentEntry } from "content-entry";

package/types/output/rpm.d.mts

@@ -23,6 +23,15 @@ export class RPM extends Packager {
     }): Promise<boolean>;
     get packageFileName(): string;
     makeDepends(deps: any): string[];
+    /**
+     * Map install hook named from default (arch) to rpm.
+     */
+    get hookMapping(): {
+        pre_install: string;
+        post_install: string;
+        pre_remove: string;
+        post_remove: string;
+    };
     create(sources: any, transformer: any, publishingDetails: any, options: any, expander: any): Promise<string>;
 }
 export type PublishingDetail = import("../publish.mjs").PublishingDetail;