npm-pkgbuild 14.0.1 → 14.0.3

package/README.md

@@ -97,28 +97,28 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
 *   [FileContentProvider](#filecontentprovider)
     *   [Parameters](#parameters-1)
     *   [name](#name)
-*   [utf8StreamOptions](#utf8streamoptions)
+*   [NFTContentProvider](#nftcontentprovider)
+    *   [Parameters](#parameters-2)
+    *   [name](#name-1)
+*   [NodeModulesContentProvider](#nodemodulescontentprovider)
+    *   [Parameters](#parameters-3)
     *   [Properties](#properties-1)
+    *   [name](#name-2)
+*   [utf8StreamOptions](#utf8streamoptions)
+    *   [Properties](#properties-2)
 *   [packageNameMapping](#packagenamemapping)
 *   [decodePassword](#decodepassword)
-    *   [Parameters](#parameters-2)
+    *   [Parameters](#parameters-4)
 *   [FunctionDecl](#functiondecl)
-    *   [Properties](#properties-2)
+    *   [Properties](#properties-3)
 *   [extractFunctions](#extractfunctions)
-    *   [Parameters](#parameters-3)
-*   [fieldProvider](#fieldprovider)
-    *   [Parameters](#parameters-4)
-*   [Expander](#expander)
     *   [Parameters](#parameters-5)
-*   [copyEntries](#copyentries)
+*   [fieldProvider](#fieldprovider)
     *   [Parameters](#parameters-6)
-*   [NFTContentProvider](#nftcontentprovider)
+*   [Expander](#expander)
     *   [Parameters](#parameters-7)
-    *   [name](#name-1)
-*   [NodeModulesContentProvider](#nodemodulescontentprovider)
+*   [copyEntries](#copyentries)
     *   [Parameters](#parameters-8)
-    *   [Properties](#properties-3)
-    *   [name](#name-2)
 *   [NPMPackContentProvider](#npmpackcontentprovider)
     *   [Parameters](#parameters-9)
     *   [Properties](#properties-4)
@@ -134,22 +134,25 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
 *   [DEBIAN](#debian)
     *   [prepare](#prepare)
         *   [Parameters](#parameters-10)
-*   [prepare](#prepare-1)
-    *   [Parameters](#parameters-11)
+*   [DOCKER](#docker)
+    *   [prepare](#prepare-1)
+        *   [Parameters](#parameters-11)
+*   [publish](#publish)
+    *   [Parameters](#parameters-12)
 *   [OCI](#oci)
 *   [Field](#field)
     *   [Properties](#properties-5)
 *   [Packager](#packager)
-    *   [Parameters](#parameters-12)
+    *   [Parameters](#parameters-13)
     *   [tmpdir](#tmpdir)
     *   [execute](#execute)
-        *   [Parameters](#parameters-13)
+        *   [Parameters](#parameters-14)
     *   [workspaceLayout](#workspacelayout)
     *   [prepare](#prepare-2)
-        *   [Parameters](#parameters-14)
+        *   [Parameters](#parameters-15)
 *   [RPM](#rpm)
     *   [prepare](#prepare-3)
-        *   [Parameters](#parameters-15)
+        *   [Parameters](#parameters-16)
 
 ## ContentProvider
 
@@ -189,6 +192,44 @@ Content provided form the file system.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
 
+## NFTContentProvider
+
+**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))** 
+
+    *   `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
+
+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
+
 ## utf8StreamOptions
 
 Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -218,7 +259,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 ### Properties
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-*   `body` **[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;
+*   `body` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
 ## extractFunctions
 
@@ -260,44 +301,6 @@ Destination paths a generated without leading '/' (as for entry names too).
 *   `destinationDirectory` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 *   `expander` **[Expander](#expander)**  (optional, default `v=>v`)
 
-## NFTContentProvider
-
-**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
-
-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
-
 ## NPMPackContentProvider
 
 **Extends ContentProvider**
@@ -370,11 +373,17 @@ Create .deb packages
 
 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;
 
-## prepare
+## DOCKER
+
+**Extends Packager**
+
+docker image build
+
+### prepare
 
 Check for docker presence.
 
-### Parameters
+#### Parameters
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 *   `variant` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
@@ -383,6 +392,15 @@ 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
 
+## publish
+
+### Parameters
+
+*   `fileName` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+*   `destination` **any**&#x20;
+*   `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
+*   `logger` **function (any): void**  (optional, default `console.log`)
+
 ## OCI
 
 **Extends Packager**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-pkgbuild",
-  "version": "14.0.1",
+  "version": "14.0.3",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -40,14 +40,14 @@
   },
   "scripts": {
     "prepare": "npm run prepare:typescript",
-    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
+    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types --resolveJsonModule -t esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "test": "npm run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src/**/*.mjs",
     "lint": "npm run lint:docs && npm run lint:typescript",
     "lint:docs": "documentation lint ./src/**/*.mjs",
-    "lint:typescript": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs",
+    "lint:typescript": "tsc --allowJs --checkJs --noEmit --resolveJsonModule -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs",
     "tsc:types": "tsc -d --allowJs --declarationDir dist --emitDeclarationOnly ./src/extract-from-package.mjs"
   },
   "dependencies": {
@@ -56,7 +56,7 @@
     "aggregate-async-iterator": "^1.2.0",
     "commander": "^12.0.0",
     "compare-versions": "^6.1.0",
-    "content-entry": "^9.0.1",
+    "content-entry": "^9.0.2",
     "content-entry-filesystem": "^6.0.0",
     "content-entry-transform": "^1.4.29",
     "execa": "^8.0.1",
@@ -70,7 +70,7 @@
     "pacote": "^17.0.6",
     "pkg-dir": "^8.0.0",
     "tar-stream": "^3.1.7",
-    "uti": "^8.4.0"
+    "uti": "^8.4.1"
   },
   "devDependencies": {
     "@types/node": "^20.11.25",

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

@@ -2,6 +2,7 @@ import { tmpdir, homedir } from "node:os";
 import { join } from "node:path";
 import { mkdtemp, readFile, writeFile } from "node:fs/promises";
 import { globby } from "globby";
+import { execa } from "execa";
 import Arborist from "@npmcli/arborist";
 import { parse } from "ini";
 import { StringContentEntry } from "content-entry";
@@ -71,7 +72,9 @@ export class NodeModulesContentProvider extends ContentProvider {
           if (process.env.NPM_TOKEN) {
             npmrc["_authToken"] = process.env.NPM_TOKEN;
           } else {
-            throw new Error(`.npmrc not found in ${searchDirs} (neither NPM_TOKEN in envinronment)`);
+            throw new Error(
+              `.npmrc not found in ${searchDirs} (neither NPM_TOKEN in envinronment)`
+            );
           }
         }
 
@@ -110,6 +113,13 @@ export class NodeModulesContentProvider extends ContentProvider {
               console.error(e, name);
             }
           }
+          if (name.endsWith(".node")) {
+            const proc = await execa("file", ["-b", name], {
+              cwd: pkgSourceDir
+            });
+            const arch = proc.stdout.split(/\s*,\s*/)[1];
+            console.log(name, arch);
+          }
 
           yield Object.assign(
             new FileSystemEntry(name, pkgSourceDir),

package/src/output/docker.mjs

@@ -35,6 +35,9 @@ const dependenciesToFrom = {
   nginx: "nginx"
 };
 
+/**
+ * docker image build
+ */
 export class DOCKER extends Packager {
   static get name() {
     return "docker";
@@ -170,16 +173,15 @@ export class DOCKER extends Packager {
     const publish = analysePublish(destination, properties);
 
     try {
-    const url = new URL(publish.url);
-    const repoLocation = `${url.host}/${url.pathname}`;
-    const name = `${properties.name}:${properties.version}`;
+      const url = new URL(publish.url);
+      const repoLocation = `${url.host}/${publish.username}`;
+      const name = `${properties.name}:${properties.version}`;
 
-    logger(`Publishing to ${repoLocation}`);
+      logger(`Publishing to ${repoLocation}`);
 
-    console.log(`docker tag ${artifact} ${repoLocation}/${name}`);
-    console.log(`docker push ${name}`);
-    }
-    catch(e) {
+      console.log(`docker tag ${artifact} ${repoLocation}/${name}`);
+      console.log(`docker push ${repoLocation}/${name}`);
+    } catch (e) {
       console.log(e, publish.url);
     }
   }

package/src/package.mjs

@@ -179,6 +179,12 @@ const skipPattern = [
 
 const defaultOptions = { dry: false };
 
+/**
+ * 
+ * @param {string} source 
+ * @param {string} dest 
+ * @param {Object} options 
+ */
 export async function* copyNodeModules(source, dest, options = defaultOptions) {
   for await (const name of globbyStream(["node_modules/**/package.json"], {
     cwd: source

package/src/publish.mjs

@@ -3,21 +3,33 @@ import { createReadStream } from "node:fs";
 import { mkdir, copyFile } from "node:fs/promises";
 import { decodePassword } from "./util.mjs";
 
+/**
+ * @param {Object} publish
+ * @param {Object} properties
+ * @return {{scheme: string, url: string }}
+ */
 export function analysePublish(publish, properties) {
-  publish = { ...publish };
+  const result = { ...publish };
 
-  publish.url = publish.url.replace(
+  result.url = result.url.replace(
     /\{\{(\w+)\}\}/gm,
     (match, key, offset, string) => properties[key] || "{{" + key + "}}"
   );
 
-  const m = publish.url.match(/^([^:]+:)\/\/(.*)/);
+  const m = result.url.match(/^([^:]+:)\/\/(.*)/);
 
-  publish.scheme = m ? m[1] : "file:";
+  result.scheme = m ? m[1] : "file:";
 
-  return publish;
+  return result;
 }
 
+/**
+ * 
+ * @param {string} fileName 
+ * @param {*} destination 
+ * @param {Object} properties 
+ * @param {function(any):void} logger 
+ */
 export async function publish(
   fileName,
   destination,
@@ -70,6 +82,12 @@ export async function publish(
   }
 }
 
+/**
+ * 
+ * @param {*} publish 
+ * @param {*} env 
+ * @returns {{url:string, password:string|undefined, username:string|undefined}}
+ */
 export function preparePublish(publish = [], env = {}) {
   const e = env["PKGBUILD_PUBLISH"];
   if (e) {

package/src/util.mjs

@@ -63,7 +63,7 @@ export function decodePassword(password) {
 /**
  * @typedef {Object} FunctionDecl
  * @property {string} name
- * @property {string[]} body
+ * @property {string} body
  */
 
 /**

package/types/output/docker.d.mts

@@ -1,3 +1,6 @@
+/**
+ * docker image build
+ */
 export class DOCKER extends Packager {
     static get description(): string;
     static get fields(): {

package/types/package.d.mts

@@ -1,6 +1,10 @@
-export function copyNodeModules(source: any, dest: any, options?: {
-    dry: boolean;
-}): AsyncGenerator<never, void, unknown>;
+/**
+ *
+ * @param {string} source
+ * @param {string} dest
+ * @param {Object} options
+ */
+export function copyNodeModules(source: string, dest: string, options?: any): AsyncGenerator<never, void, unknown>;
 export function copyNodeModule(source: any, dest: any, options?: {
     dry: boolean;
 }): AsyncGenerator<string, void, unknown>;

package/types/publish.d.mts

@@ -1,19 +1,28 @@
-export function analysePublish(publish: any, properties: any): any;
-export function publish(fileName: any, destination: any, properties: any, logger?: {
-    (...data: any[]): void;
-    (message?: any, ...optionalParams: any[]): void;
-}): Promise<void>;
-export function preparePublish(publish?: any[], env?: {}): ({
-    url: any;
-    user: any;
-    password: string;
-} | {
-    username?: any;
-    password?: string;
+/**
+ * @param {Object} publish
+ * @param {Object} properties
+ * @return {{scheme: string, url: string }}
+ */
+export function analysePublish(publish: any, properties: any): {
+    scheme: string;
     url: string;
-    user?: undefined;
-} | {
-    url: any;
-    user?: undefined;
-    password?: undefined;
-})[];
+};
+/**
+ *
+ * @param {string} fileName
+ * @param {*} destination
+ * @param {Object} properties
+ * @param {function(any):void} logger
+ */
+export function publish(fileName: string, destination: any, properties: any, logger?: (arg0: any) => void): Promise<void>;
+/**
+ *
+ * @param {*} publish
+ * @param {*} env
+ * @returns {{url:string, password:string|undefined, username:string|undefined}}
+ */
+export function preparePublish(publish?: any, env?: any): {
+    url: string;
+    password: string | undefined;
+    username: string | undefined;
+};

package/types/util.d.mts

@@ -9,7 +9,7 @@ export function decodePassword(password: string): string;
 /**
  * @typedef {Object} FunctionDecl
  * @property {string} name
- * @property {string[]} body
+ * @property {string} body
  */
 /**
  * Extract shell functions from a given text.
@@ -49,7 +49,7 @@ export namespace packageNameMapping {
 }
 export type FunctionDecl = {
     name: string;
-    body: string[];
+    body: string;
 };
 export type Expander = Function;
 import { ContentEntry } from "content-entry";