npm-pkgbuild 20.2.1 → 20.2.2

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 +61 -61
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -98,47 +98,47 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
98
98
  * [Properties](#properties)
99
99
  * [extractFromPackage](#extractfrompackage)
100
100
  * [Parameters](#parameters-1)
101
- * [NPMPackContentProvider](#npmpackcontentprovider)
101
+ * [BUILDAH](#buildah)
102
+ * [ContentProvider](#contentprovider)
102
103
  * [Parameters](#parameters-2)
103
104
  * [Properties](#properties-1)
105
+ * [asyncIterator](#asynciterator)
106
+ * [FileContentProvider](#filecontentprovider)
107
+ * [Parameters](#parameters-3)
108
+ * [asyncIterator](#asynciterator-1)
104
109
  * [name](#name)
105
110
  * [NodeModulesContentProvider](#nodemodulescontentprovider)
106
- * [Parameters](#parameters-3)
111
+ * [Parameters](#parameters-4)
107
112
  * [Properties](#properties-2)
108
- * [asyncIterator](#asynciterator)
113
+ * [asyncIterator](#asynciterator-2)
109
114
  * [name](#name-1)
110
- * [FileContentProvider](#filecontentprovider)
111
- * [Parameters](#parameters-4)
112
- * [asyncIterator](#asynciterator-1)
115
+ * [NPMPackContentProvider](#npmpackcontentprovider)
116
+ * [Parameters](#parameters-5)
117
+ * [Properties](#properties-3)
113
118
  * [name](#name-2)
114
119
  * [NFTContentProvider](#nftcontentprovider)
115
- * [Parameters](#parameters-5)
116
- * [asyncIterator](#asynciterator-2)
117
- * [name](#name-3)
118
- * [ContentProvider](#contentprovider)
119
120
  * [Parameters](#parameters-6)
120
- * [Properties](#properties-3)
121
121
  * [asyncIterator](#asynciterator-3)
122
+ * [name](#name-3)
122
123
  * [DEBIAN](#debian)
123
124
  * [hookMapping](#hookmapping)
124
125
  * [attributes](#attributes)
125
126
  * [prepare](#prepare)
126
127
  * [Parameters](#parameters-7)
127
- * [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
128
- * [attributes](#attributes-1)
129
128
  * [quoteFile](#quotefile)
130
129
  * [Parameters](#parameters-8)
131
130
  * [RPM](#rpm)
132
131
  * [hookMapping](#hookmapping-1)
133
- * [attributes](#attributes-2)
132
+ * [attributes](#attributes-1)
134
133
  * [prepare](#prepare-1)
135
134
  * [Parameters](#parameters-9)
135
+ * [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
136
+ * [attributes](#attributes-2)
136
137
  * [OCI](#oci)
137
138
  * [DOCKER](#docker)
138
139
  * [attributes](#attributes-3)
139
140
  * [prepare](#prepare-2)
140
141
  * [Parameters](#parameters-10)
141
- * [BUILDAH](#buildah)
142
142
  * [Packager](#packager)
143
143
  * [Parameters](#parameters-11)
144
144
  * [packageName](#packagename)
@@ -254,22 +254,48 @@ Extract package definition from package.json.
254
254
 
255
255
  Returns **AsyncIterable<[PackageDefinition](#packagedefinition)>**&#x20;
256
256
 
257
- ## NPMPackContentProvider
257
+ ## BUILDAH
258
258
 
259
- **Extends ContentProvider**
259
+ **Extends DOCKER**
260
260
 
261
- Content from npm pack.
261
+ Use buildah @see <https://buildah.io>
262
+
263
+ ## ContentProvider
264
+
265
+ Source of package content.
262
266
 
263
267
  ### Parameters
264
268
 
265
269
  * `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
266
- * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
267
- * `directoryProperties` &#x20;
270
+ * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
271
+ * `directoryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
268
272
 
269
273
  ### Properties
270
274
 
271
275
  * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
272
276
 
277
+ ### asyncIterator
278
+
279
+ List all entries.
280
+
281
+ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
282
+
283
+ ## FileContentProvider
284
+
285
+ **Extends ContentProvider**
286
+
287
+ Content provided form the file system.
288
+
289
+ ### Parameters
290
+
291
+ * `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;
292
+ * `entryProperties` &#x20;
293
+ * `directoryProperties` &#x20;
294
+
295
+ ### asyncIterator
296
+
297
+ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
298
+
273
299
  ### name
274
300
 
275
301
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
@@ -301,21 +327,21 @@ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
301
327
 
302
328
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
303
329
 
304
- ## FileContentProvider
330
+ ## NPMPackContentProvider
305
331
 
306
332
  **Extends ContentProvider**
307
333
 
308
- Content provided form the file system.
334
+ Content from npm pack.
309
335
 
310
336
  ### Parameters
311
337
 
312
- * `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;
313
- * `entryProperties` &#x20;
338
+ * `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
339
+ * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
314
340
  * `directoryProperties` &#x20;
315
341
 
316
- ### asyncIterator
342
+ ### Properties
317
343
 
318
- Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
344
+ * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
319
345
 
320
346
  ### name
321
347
 
@@ -341,26 +367,6 @@ Returns **AsyncIterable\<ContentEntry>** all entries
341
367
 
342
368
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
343
369
 
344
- ## ContentProvider
345
-
346
- Source of package content.
347
-
348
- ### Parameters
349
-
350
- * `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
351
- * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
352
- * `directoryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
353
-
354
- ### Properties
355
-
356
- * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
357
-
358
- ### asyncIterator
359
-
360
- List all entries.
361
-
362
- Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
363
-
364
370
  ## DEBIAN
365
371
 
366
372
  **Extends Packager**
@@ -387,15 +393,6 @@ Map install hook named from default (arch) to deb.
387
393
 
388
394
  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;
389
395
 
390
- ## pkgKeyValuePairOptions
391
-
392
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
393
-
394
- ## attributes
395
-
396
- well known package properties
397
- <https://www.archlinux.org/pacman/PKGBUILD.5.html>
398
-
399
396
  ## quoteFile
400
397
 
401
398
  ### Parameters
@@ -429,6 +426,15 @@ Check for rpmbuild presence.
429
426
 
430
427
  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
431
428
 
429
+ ## pkgKeyValuePairOptions
430
+
431
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
432
+
433
+ ## attributes
434
+
435
+ well known package properties
436
+ <https://www.archlinux.org/pacman/PKGBUILD.5.html>
437
+
432
438
  ## OCI
433
439
 
434
440
  **Extends Packager**
@@ -458,12 +464,6 @@ Check for docker presence.
458
464
 
459
465
  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
460
466
 
461
- ## BUILDAH
462
-
463
- **Extends DOCKER**
464
-
465
- Use buildah @see <https://buildah.io>
466
-
467
467
  ## Packager
468
468
 
469
469
  ### Parameters
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-pkgbuild",
3
- "version": "20.2.1",
3
+ "version": "20.2.2",
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.9",
56
- "@vercel/nft": "^1.2.0",
55
+ "@npmcli/arborist": "^9.1.10",
56
+ "@vercel/nft": "^1.3.0",
57
57
  "aggregate-async-iterator": "^1.2.3",
58
58
  "commander": "^14.0.2",
59
59
  "compare-versions": "^6.1.1",
@@ -67,14 +67,14 @@
67
67
  "key-value-transformer": "^3.3.1",
68
68
  "npm-package-walker": "^8.0.11",
69
69
  "npm-packlist": "^10.0.3",
70
- "pacc": "^8.0.4",
70
+ "pacc": "^8.0.5",
71
71
  "package-directory": "^8.1.0",
72
72
  "pacote": "^21.0.4",
73
73
  "tar-stream": "^3.1.7",
74
74
  "uti": "^8.10.5"
75
75
  },
76
76
  "devDependencies": {
77
- "@types/node": "^25.0.9",
77
+ "@types/node": "^25.0.10",
78
78
  "ava": "^6.4.1",
79
79
  "c8": "^10.1.3",
80
80
  "documentation": "^14.0.3",