npm-pkgbuild 20.2.2 → 20.2.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 +61 -61
  2. package/package.json +4 -4
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
- * [BUILDAH](#buildah)
102
- * [ContentProvider](#contentprovider)
101
+ * [NPMPackContentProvider](#npmpackcontentprovider)
103
102
  * [Parameters](#parameters-2)
104
103
  * [Properties](#properties-1)
105
- * [asyncIterator](#asynciterator)
106
- * [FileContentProvider](#filecontentprovider)
107
- * [Parameters](#parameters-3)
108
- * [asyncIterator](#asynciterator-1)
109
104
  * [name](#name)
110
105
  * [NodeModulesContentProvider](#nodemodulescontentprovider)
111
- * [Parameters](#parameters-4)
106
+ * [Parameters](#parameters-3)
112
107
  * [Properties](#properties-2)
113
- * [asyncIterator](#asynciterator-2)
108
+ * [asyncIterator](#asynciterator)
114
109
  * [name](#name-1)
115
- * [NPMPackContentProvider](#npmpackcontentprovider)
116
- * [Parameters](#parameters-5)
117
- * [Properties](#properties-3)
110
+ * [FileContentProvider](#filecontentprovider)
111
+ * [Parameters](#parameters-4)
112
+ * [asyncIterator](#asynciterator-1)
118
113
  * [name](#name-2)
119
114
  * [NFTContentProvider](#nftcontentprovider)
115
+ * [Parameters](#parameters-5)
116
+ * [asyncIterator](#asynciterator-2)
117
+ * [name](#name-3)
118
+ * [ContentProvider](#contentprovider)
120
119
  * [Parameters](#parameters-6)
120
+ * [Properties](#properties-3)
121
121
  * [asyncIterator](#asynciterator-3)
122
- * [name](#name-3)
123
122
  * [DEBIAN](#debian)
124
123
  * [hookMapping](#hookmapping)
125
124
  * [attributes](#attributes)
126
125
  * [prepare](#prepare)
127
126
  * [Parameters](#parameters-7)
127
+ * [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
128
+ * [attributes](#attributes-1)
128
129
  * [quoteFile](#quotefile)
129
130
  * [Parameters](#parameters-8)
130
131
  * [RPM](#rpm)
131
132
  * [hookMapping](#hookmapping-1)
132
- * [attributes](#attributes-1)
133
+ * [attributes](#attributes-2)
133
134
  * [prepare](#prepare-1)
134
135
  * [Parameters](#parameters-9)
135
- * [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
136
- * [attributes](#attributes-2)
137
136
  * [OCI](#oci)
138
137
  * [DOCKER](#docker)
139
138
  * [attributes](#attributes-3)
140
139
  * [prepare](#prepare-2)
141
140
  * [Parameters](#parameters-10)
141
+ * [BUILDAH](#buildah)
142
142
  * [Packager](#packager)
143
143
  * [Parameters](#parameters-11)
144
144
  * [packageName](#packagename)
@@ -254,48 +254,22 @@ Extract package definition from package.json.
254
254
 
255
255
  Returns **AsyncIterable<[PackageDefinition](#packagedefinition)>**&#x20;
256
256
 
257
- ## BUILDAH
258
-
259
- **Extends DOCKER**
260
-
261
- Use buildah @see <https://buildah.io>
257
+ ## NPMPackContentProvider
262
258
 
263
- ## ContentProvider
259
+ **Extends ContentProvider**
264
260
 
265
- Source of package content.
261
+ Content from npm pack.
266
262
 
267
263
  ### Parameters
268
264
 
269
265
  * `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#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;
266
+ * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
267
+ * `directoryProperties` &#x20;
272
268
 
273
269
  ### Properties
274
270
 
275
271
  * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
276
272
 
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
-
299
273
  ### name
300
274
 
301
275
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
@@ -327,21 +301,21 @@ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
327
301
 
328
302
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
329
303
 
330
- ## NPMPackContentProvider
304
+ ## FileContentProvider
331
305
 
332
306
  **Extends ContentProvider**
333
307
 
334
- Content from npm pack.
308
+ Content provided form the file system.
335
309
 
336
310
  ### Parameters
337
311
 
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
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;
340
314
  * `directoryProperties` &#x20;
341
315
 
342
- ### Properties
316
+ ### asyncIterator
343
317
 
344
- * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
318
+ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
345
319
 
346
320
  ### name
347
321
 
@@ -367,6 +341,26 @@ Returns **AsyncIterable\<ContentEntry>** all entries
367
341
 
368
342
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
369
343
 
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
+
370
364
  ## DEBIAN
371
365
 
372
366
  **Extends Packager**
@@ -393,6 +387,15 @@ Map install hook named from default (arch) to deb.
393
387
 
394
388
  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;
395
389
 
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
+
396
399
  ## quoteFile
397
400
 
398
401
  ### Parameters
@@ -426,15 +429,6 @@ Check for rpmbuild presence.
426
429
 
427
430
  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
428
431
 
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
-
438
432
  ## OCI
439
433
 
440
434
  **Extends Packager**
@@ -464,6 +458,12 @@ Check for docker presence.
464
458
 
465
459
  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
466
460
 
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.2",
3
+ "version": "20.2.3",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "provenance": false
@@ -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.5",
70
+ "pacc": "^8.1.5",
71
71
  "package-directory": "^8.1.0",
72
- "pacote": "^21.0.4",
72
+ "pacote": "^21.1.0",
73
73
  "tar-stream": "^3.1.7",
74
74
  "uti": "^8.10.5"
75
75
  },
76
76
  "devDependencies": {
77
- "@types/node": "^25.0.10",
77
+ "@types/node": "^25.1.0",
78
78
  "ava": "^6.4.1",
79
79
  "c8": "^10.1.3",
80
80
  "documentation": "^14.0.3",