npm-pkgbuild 17.3.4 → 17.5.0

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)
 *   [DEBIAN](#debian)
     *   [hookMapping](#hookmapping)
     *   [prepare](#prepare)
@@ -125,18 +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)
     *   [hookMapping](#hookmapping-1)
     *   [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
-
 ## DEBIAN
 
 **Extends Packager**
@@ -367,21 +373,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.3.4",
+  "version": "17.5.0",
   "publishConfig": {
     "access": "public",
     "provenance": false

package/src/content/content-provider.mjs

@@ -8,22 +8,12 @@ import { ContentEntry } from "content-entry";
 export class ContentProvider {
   transformers = [];
   entryProperties;
+  directoryProperties;
   dir;
 
-  constructor(definitions, entryProperties) {
-    if (entryProperties) {
-      this.entryProperties = entryProperties;
-
-      for (const a of ["mode"]) {
-        if (this.entryProperties[a] !== undefined) {
-          if (!this.baseProperties) {
-            this.baseProperties = {};
-          }
-          this.baseProperties[a] = { value: this.entryProperties[a] };
-          delete this.entryProperties[a];
-        }
-      }
-    }
+  constructor(definitions, entryProperties, directoryProperties) {
+    this.entryProperties = entryProperties;
+    this.directoryProperties = directoryProperties;
   }
 
   /**

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

@@ -1,6 +1,6 @@
 import { dirname, join } from "node:path";
 import { globby } from "globby";
-import { FileSystemEntry } from "content-entry-filesystem";
+import { FileSystemEntryWithPermissions } from "./file-system-entry-with-permissions.mjs";
 import { asArray } from "../util.mjs";
 import { ContentProvider } from "./content-provider.mjs";
 
@@ -24,8 +24,8 @@ export class FileContentProvider extends ContentProvider {
     return "use plain files source";
   }
 
-  constructor(definitions, entryProperties) {
-    super(definitions, entryProperties);
+  constructor(definitions, entryProperties, directoryProperties) {
+    super(definitions, entryProperties, directoryProperties);
 
     if (typeof definitions === "string") {
       if (definitions.endsWith("/")) {
@@ -62,15 +62,11 @@ export class FileContentProvider extends ContentProvider {
     for (const name of await globby(definitions.pattern, {
       cwd: base
     })) {
-      const entry = Object.assign(
-        new FileSystemEntry(name, base),
+      yield new FileSystemEntryWithPermissions(
+        name,
+        base,
         this.entryProperties
       );
-
-      yield this.baseProperties
-        ? Object.create(entry, this.baseProperties)
-        : entry;
-
       count++;
     }
 

package/src/content/file-system-entry-with-permissions.mjs

@@ -0,0 +1,18 @@
+import { FileSystemEntry } from "content-entry-filesystem";
+
+export class FileSystemEntryWithPermissions extends FileSystemEntry {
+  constructor(name, baseDir, properties) {
+    super(name, baseDir);
+    Object.assign(this, properties);
+  }
+
+  #mode;
+
+  set mode(value) {
+    this.#mode = value;
+  }
+
+  get mode() {
+    return this.#mode || super.mode;
+  }
+}

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

@@ -1,5 +1,5 @@
 import { nodeFileTrace } from "@vercel/nft";
-import { FileSystemEntry } from "content-entry-filesystem";
+import { FileSystemEntryWithPermissions } from "./file-system-entry-with-permissions.mjs";
 import { asArray } from "../util.mjs";
 import { ContentProvider } from "./content-provider.mjs";
 
@@ -17,13 +17,12 @@ export class NFTContentProvider extends ContentProvider {
     return "nft";
   }
 
-  static get description()
-  {
-  	return "user vercels NFT as source"
+  static get description() {
+    return "user vercels NFT as source";
   }
-  
-  constructor(definitions, entryProperties) {
-    super(definitions, entryProperties);
+
+  constructor(definitions, entryProperties, directoryProperties) {
+    super(definitions, entryProperties, directoryProperties);
 
     if (typeof definitions === "string") {
       this.definitions = { start: [definitions] };
@@ -44,14 +43,11 @@ export class NFTContentProvider extends ContentProvider {
     const { fileList } = await nodeFileTrace(definitions.start);
 
     for (const name of fileList) {
-      const entry = Object.assign(
-        new FileSystemEntry(name, base),
+      yield new FileSystemEntryWithPermissions(
+        name,
+        base,
         this.entryProperties
       );
-
-      yield this.baseProperties
-        ? Object.create(entry, this.baseProperties)
-        : entry;
     }
   }
 }

package/src/content/node-modules-content-provider.mjs

@@ -5,7 +5,7 @@ import { globby } from "globby";
 import Arborist from "@npmcli/arborist";
 import { parse } from "ini";
 import { StringContentEntry } from "content-entry";
-import { FileSystemEntry } from "content-entry-filesystem";
+import { FileSystemEntryWithPermissions } from "./file-system-entry-with-permissions.mjs";
 import { ContentProvider } from "./content-provider.mjs";
 import { utf8StreamOptions } from "../util.mjs";
 import { shrinkNPM } from "../npm-shrink.mjs";
@@ -29,11 +29,14 @@ export class NodeModulesContentProvider extends ContentProvider {
 
   withoutDevelpmentDependencies = true;
 
-  constructor(definitions, entryProperties) {
-    if (entryProperties?.destination && !entryProperties.destination.endsWith("/")) {
+  constructor(definitions, entryProperties, directoryProperties) {
+    if (
+      entryProperties?.destination &&
+      !entryProperties.destination.endsWith("/")
+    ) {
       entryProperties.destination += "/";
     }
-    super(definitions, entryProperties);
+    super(definitions, entryProperties, directoryProperties);
     Object.assign(this, definitions);
   }
 
@@ -120,8 +123,9 @@ export class NodeModulesContentProvider extends ContentProvider {
               console.error(e, name);
             }
           }
-          yield Object.assign(
-            new FileSystemEntry(name, nodeModulesDir),
+          yield new FileSystemEntryWithPermissions(
+            name,
+            nodeModulesDir,
             this.entryProperties
           );
         }

package/src/content/npm-pack-content-provider.mjs

@@ -25,11 +25,14 @@ export class NPMPackContentProvider extends ContentProvider {
     return "use npm pack as source";
   }
 
-  constructor(definitions, entryProperties) {
-    if (entryProperties?.destination && !entryProperties.destination.endsWith("/")) {
+  constructor(definitions, entryProperties, directoryProperties) {
+    if (
+      entryProperties?.destination &&
+      !entryProperties.destination.endsWith("/")
+    ) {
       entryProperties.destination += "/";
     }
-    super(definitions, entryProperties);
+    super(definitions, entryProperties, directoryProperties);
     Object.assign(this, definitions);
   }
 
@@ -40,38 +43,42 @@ export class NPMPackContentProvider extends ContentProvider {
   async *[Symbol.asyncIterator]() {
     const entries = [];
 
-    await pacote.tarball.stream(this.dir, async stream => {
-      const ex = extract();
+    await pacote.tarball.stream(
+      this.dir,
+      async stream => {
+        const ex = extract();
 
-      ex.on("entry", async (header, stream, next) => {
-        stream.on("end", () => next());
+        ex.on("entry", async (header, stream, next) => {
+          stream.on("end", () => next());
 
-        const chunks = [];
-        for await (const chunk of await stream) {
-          chunks.push(chunk);
-        }
+          const chunks = [];
+          for await (const chunk of await stream) {
+            chunks.push(chunk);
+          }
 
-        entries.push(
-          Object.assign(
-            Object.create(
-              new BufferContentEntry(
-                header.name.substring(8),
-                Buffer.concat(chunks)
+          entries.push(
+            Object.assign(
+              Object.create(
+                new BufferContentEntry(
+                  header.name.substring(8),
+                  Buffer.concat(chunks)
+                ),
+                {
+                  mtime: { value: header.mtime },
+                  mode: { value: header.mode }
+                }
               ),
-              {
-                mtime: { value: header.mtime },
-                mode: { value: header.mode }
-              }
-            ),
-            this.entryProperties
-          )
-        );
+              this.entryProperties
+            )
+          );
 
-        stream.resume();
-      });
+          stream.resume();
+        });
 
-      await pipeline(stream, createGunzip(), ex);
-    },{ Arborist });
+        await pipeline(stream, createGunzip(), ex);
+      },
+      { Arborist }
+    );
 
     for (const entry of entries) {
       yield entry;

package/src/output/arch.mjs

@@ -1,6 +1,6 @@
 import { join } from "node:path";
 import { createWriteStream } from "node:fs";
-import { readFile } from "node:fs/promises";
+import { readFile, writeFile } from "node:fs/promises";
 import { execa } from "execa";
 import { ContentEntry, ReadableStreamContentEntry } from "content-entry";
 import { transform } from "content-entry-transform";
@@ -145,6 +145,7 @@ export class ARCH extends Packager {
 
     const self = this;
     async function* trailingLines() {
+      console.log();
       yield `
 package() {
   depends=(${self.makeDepends(properties.dependencies).join(" ")})
@@ -152,6 +153,8 @@ package() {
   if [ "$(ls -A $srcdir)" ]
   then
     cp -rp $srcdir/* "$pkgdir"
+### CHOWN ###
+
   fi
 }
 `;
@@ -177,22 +180,48 @@ package() {
       createEntryWhenMissing: () => new ContentEntry(PKGBUILD)
     });
 
+    const ownership = [];
+
     for await (const file of copyEntries(
       transform(aggregateFifo(sources), transformer),
       join(staging, "src"),
       expander
     )) {
+      if (file.owner || file.group) {
+        ownership.push(file);
+      }
+
       if (options.verbose) {
         console.log(file.destination);
       }
     }
 
+    if (ownership.length) {
+      const pkgbuild = join(staging, PKGBUILD);
+      let content = await readFile(pkgbuild, utf8StreamOptions);
+      const markerPos = content.indexOf("### CHOWN ###");
+
+      content =
+        content.substring(0, markerPos) +
+        ownership
+          .map(
+            f =>
+              `    chown ${[f.owner || "", f.group || ""].join(":")} \"$pkgdir/${
+                f.destination
+              }\"`
+          )
+          .join("\n") +
+        content.substring(markerPos + 14);
+
+      await writeFile(pkgbuild, content, utf8StreamOptions);
+    }
+
     if (options.verbose) {
       console.log(await readFile(join(staging, PKGBUILD), utf8StreamOptions));
-      console.log("***", staging, "***");
+      /*console.log("***", staging, "***");
       const ls = await execa("ls", ["-lR"], { cwd: staging });
       console.log(ls.stdout);
-      console.log("*** end ***");
+      console.log("*** end ***");*/
     }
 
     if (!options.dry) {
@@ -202,7 +231,7 @@ package() {
         PACKAGER = person(properties.contributors);
       }
 
-      const makepkg = await execa("makepkg", ["-c", "-f", "-e"], {
+      const makepkg = await execa("makepkg", ["--noprogressbar", "-c", "-f", "-e"], {
         cwd: staging,
         env: { PKGDEST: destination, PACKAGER }
       });

package/src/util.mjs

@@ -5,7 +5,7 @@ import { createWriteStream } from "node:fs";
 import { ContentEntry } from "content-entry";
 
 export function compileFields(fields) {
-  for(const [k,v] of Object.entries(fields)) {
+  for (const [k, v] of Object.entries(fields)) {
     v.name = k;
   }
 
@@ -171,9 +171,9 @@ export function fieldProvider(properties, fields) {
               yield [name, field.default];
             }
           } else {
-            if(field.mapping) {
+            if (field.mapping) {
               const mappedValue = field.mapping[value];
-              if(mappedValue) {
+              if (mappedValue) {
                 value = mappedValue;
               }
             }
@@ -219,11 +219,9 @@ export async function* copyEntries(
     const destination = join(destinationDirectory, name);
     await mkdir(dirname(destination), { recursive: true });
 
-    const options = { mode: entry.mode };
-
     await pipeline(
       await entry.readStream,
-      createWriteStream(destination, options)
+      createWriteStream(destination, entry.mode ? { mode: entry.mode } : undefined)
     );
 
     yield entry;

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

@@ -4,11 +4,11 @@
  * @property {Transformer[]} transformer
  */
 export class ContentProvider {
-    constructor(definitions: any, entryProperties: any);
+    constructor(definitions: any, entryProperties: any, directoryProperties: any);
     transformers: any[];
     entryProperties: any;
+    directoryProperties: any;
     dir: any;
-    baseProperties: {};
     /**
      * List all entries.
      * @return {AsyncIterable<ContentEntry>} all entries

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

@@ -8,6 +8,7 @@ export class FileContentProvider extends ContentProvider {
     static get description(): string;
     definitions: any;
     get isPatternMatch(): any;
-    [Symbol.asyncIterator](): AsyncGenerator<any, void, unknown>;
+    [Symbol.asyncIterator](): AsyncGenerator<FileSystemEntryWithPermissions, void, unknown>;
 }
 import { ContentProvider } from "./content-provider.mjs";
+import { FileSystemEntryWithPermissions } from "./file-system-entry-with-permissions.mjs";

package/types/content/file-system-entry-with-permissions.d.mts

@@ -0,0 +1,7 @@
+export class FileSystemEntryWithPermissions extends FileSystemEntry {
+    constructor(name: any, baseDir: any, properties: any);
+    set mode(value: any);
+    get mode(): any;
+    #private;
+}
+import { FileSystemEntry } from "content-entry-filesystem";

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

@@ -7,6 +7,7 @@
 export class NFTContentProvider extends ContentProvider {
     static get description(): string;
     definitions: any;
-    [Symbol.asyncIterator](): AsyncGenerator<any, void, unknown>;
+    [Symbol.asyncIterator](): AsyncGenerator<FileSystemEntryWithPermissions, void, unknown>;
 }
 import { ContentProvider } from "./content-provider.mjs";
+import { FileSystemEntryWithPermissions } from "./file-system-entry-with-permissions.mjs";