npm-pkgbuild 19.0.1 → 19.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +65 -65
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -99,47 +99,47 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
99
99
  * [Properties](#properties)
100
100
  * [extractFromPackage](#extractfrompackage)
101
101
  * [Parameters](#parameters-1)
102
- * [BUILDAH](#buildah)
103
- * [ContentProvider](#contentprovider)
102
+ * [NPMPackContentProvider](#npmpackcontentprovider)
104
103
  * [Parameters](#parameters-2)
105
104
  * [Properties](#properties-1)
106
- * [asyncIterator](#asynciterator)
107
- * [FileContentProvider](#filecontentprovider)
108
- * [Parameters](#parameters-3)
109
- * [asyncIterator](#asynciterator-1)
110
105
  * [name](#name)
111
106
  * [NodeModulesContentProvider](#nodemodulescontentprovider)
112
- * [Parameters](#parameters-4)
107
+ * [Parameters](#parameters-3)
113
108
  * [Properties](#properties-2)
114
- * [asyncIterator](#asynciterator-2)
109
+ * [asyncIterator](#asynciterator)
115
110
  * [name](#name-1)
116
- * [NPMPackContentProvider](#npmpackcontentprovider)
117
- * [Parameters](#parameters-5)
118
- * [Properties](#properties-3)
111
+ * [FileContentProvider](#filecontentprovider)
112
+ * [Parameters](#parameters-4)
113
+ * [asyncIterator](#asynciterator-1)
119
114
  * [name](#name-2)
120
115
  * [NFTContentProvider](#nftcontentprovider)
116
+ * [Parameters](#parameters-5)
117
+ * [asyncIterator](#asynciterator-2)
118
+ * [name](#name-3)
119
+ * [ContentProvider](#contentprovider)
121
120
  * [Parameters](#parameters-6)
121
+ * [Properties](#properties-3)
122
122
  * [asyncIterator](#asynciterator-3)
123
- * [name](#name-3)
124
123
  * [DEBIAN](#debian)
125
124
  * [hookMapping](#hookmapping)
126
125
  * [attributes](#attributes)
127
126
  * [prepare](#prepare)
128
127
  * [Parameters](#parameters-7)
128
+ * [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
129
+ * [attributes](#attributes-1)
129
130
  * [quoteFile](#quotefile)
130
131
  * [Parameters](#parameters-8)
131
132
  * [RPM](#rpm)
132
133
  * [hookMapping](#hookmapping-1)
133
- * [attributes](#attributes-1)
134
+ * [attributes](#attributes-2)
134
135
  * [prepare](#prepare-1)
135
136
  * [Parameters](#parameters-9)
136
- * [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
137
- * [attributes](#attributes-2)
138
137
  * [OCI](#oci)
139
138
  * [DOCKER](#docker)
140
139
  * [attributes](#attributes-3)
141
140
  * [prepare](#prepare-2)
142
141
  * [Parameters](#parameters-10)
142
+ * [BUILDAH](#buildah)
143
143
  * [Packager](#packager)
144
144
  * [Parameters](#parameters-11)
145
145
  * [packageName](#packagename)
@@ -249,51 +249,21 @@ Extract package definition from package.json.
249
249
 
250
250
  Returns **AsyncIterable<[PackageDefinition](#packagedefinition)>**&#x20;
251
251
 
252
- ## BUILDAH
253
-
254
- **Extends DOCKER**
255
-
256
- Use buildah @see <https://buildah.io>
252
+ ## NPMPackContentProvider
257
253
 
258
- ## ContentProvider
254
+ **Extends ContentProvider**
259
255
 
260
- Source of package content.
256
+ Content from npm pack.
261
257
 
262
258
  ### Parameters
263
259
 
264
- * `definitions` &#x20;
265
- * `entryProperties` &#x20;
260
+ * `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
261
+ * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
266
262
  * `directoryProperties` &#x20;
267
263
 
268
264
  ### Properties
269
265
 
270
266
  * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
271
- * `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>**&#x20;
272
-
273
- ### asyncIterator
274
-
275
- List all entries.
276
-
277
- Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
278
-
279
- ## FileContentProvider
280
-
281
- **Extends ContentProvider**
282
-
283
- Content provided form the file system.
284
-
285
- ### Parameters
286
-
287
- * `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;
288
-
289
- * `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;
290
- * `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
291
- * `entryProperties` &#x20;
292
- * `directoryProperties` &#x20;
293
-
294
- ### asyncIterator
295
-
296
- Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
297
267
 
298
268
  ### name
299
269
 
@@ -326,21 +296,24 @@ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
326
296
 
327
297
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
328
298
 
329
- ## NPMPackContentProvider
299
+ ## FileContentProvider
330
300
 
331
301
  **Extends ContentProvider**
332
302
 
333
- Content from npm pack.
303
+ Content provided form the file system.
334
304
 
335
305
  ### Parameters
336
306
 
337
- * `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
338
- * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
307
+ * `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;
308
+
309
+ * `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;
310
+ * `definitions.base` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** base directory where to find the files
311
+ * `entryProperties` &#x20;
339
312
  * `directoryProperties` &#x20;
340
313
 
341
- ### Properties
314
+ ### asyncIterator
342
315
 
343
- * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
316
+ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
344
317
 
345
318
  ### name
346
319
 
@@ -369,6 +342,27 @@ Returns **AsyncIterable\<ContentEntry>** all entries
369
342
 
370
343
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
371
344
 
345
+ ## ContentProvider
346
+
347
+ Source of package content.
348
+
349
+ ### Parameters
350
+
351
+ * `definitions` &#x20;
352
+ * `entryProperties` &#x20;
353
+ * `directoryProperties` &#x20;
354
+
355
+ ### Properties
356
+
357
+ * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
358
+ * `transformer` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<Transformer>**&#x20;
359
+
360
+ ### asyncIterator
361
+
362
+ List all entries.
363
+
364
+ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
365
+
372
366
  ## DEBIAN
373
367
 
374
368
  **Extends Packager**
@@ -395,6 +389,15 @@ Map install hook named from default (arch) to deb.
395
389
 
396
390
  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;
397
391
 
392
+ ## pkgKeyValuePairOptions
393
+
394
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
395
+
396
+ ## attributes
397
+
398
+ well known package properties
399
+ <https://www.archlinux.org/pacman/PKGBUILD.5.html>
400
+
398
401
  ## quoteFile
399
402
 
400
403
  ### Parameters
@@ -428,15 +431,6 @@ Check for rpmbuild presence.
428
431
 
429
432
  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
430
433
 
431
- ## pkgKeyValuePairOptions
432
-
433
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
434
-
435
- ## attributes
436
-
437
- well known package properties
438
- <https://www.archlinux.org/pacman/PKGBUILD.5.html>
439
-
440
434
  ## OCI
441
435
 
442
436
  **Extends Packager**
@@ -466,6 +460,12 @@ Check for docker presence.
466
460
 
467
461
  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
468
462
 
463
+ ## BUILDAH
464
+
465
+ **Extends DOCKER**
466
+
467
+ Use buildah @see <https://buildah.io>
468
+
469
469
  ## Packager
470
470
 
471
471
  ### Parameters
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-pkgbuild",
3
- "version": "19.0.1",
3
+ "version": "19.0.3",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "provenance": false
@@ -52,8 +52,8 @@
52
52
  "tsc:types": "tsc -d --allowJs --declarationDir dist --emitDeclarationOnly ./src/extract-from-package.mjs"
53
53
  },
54
54
  "dependencies": {
55
- "@npmcli/arborist": "^9.1.6",
56
- "@vercel/nft": "^0.30.3",
55
+ "@npmcli/arborist": "^9.1.7",
56
+ "@vercel/nft": "^1.0.0",
57
57
  "aggregate-async-iterator": "^1.2.2",
58
58
  "commander": "^14.0.2",
59
59
  "compare-versions": "^6.1.1",
@@ -67,18 +67,18 @@
67
67
  "key-value-transformer": "^3.3.0",
68
68
  "npm-package-walker": "^8.0.10",
69
69
  "npm-packlist": "^10.0.3",
70
- "pacc": "^4.41.0",
70
+ "pacc": "^4.41.1",
71
71
  "package-directory": "^8.1.0",
72
- "pacote": "^21.0.3",
72
+ "pacote": "^21.0.4",
73
73
  "tar-stream": "^3.1.7",
74
74
  "uti": "^8.10.2"
75
75
  },
76
76
  "devDependencies": {
77
- "@types/node": "^24.9.2",
77
+ "@types/node": "^24.10.1",
78
78
  "ava": "^6.4.1",
79
79
  "c8": "^10.1.3",
80
80
  "documentation": "^14.0.3",
81
- "semantic-release": "^25.0.1",
81
+ "semantic-release": "^25.0.2",
82
82
  "stream-buffers": "^3.0.3",
83
83
  "typescript": "^5.9.3"
84
84
  },