npm-pkgbuild 21.0.0 → 21.0.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 (3) hide show
  1. package/README.md +162 -173
  2. package/package.json +4 -4
  3. package/src/output/alpm.mjs +4 -4
package/README.md CHANGED
@@ -88,124 +88,113 @@ See [mf-hosting](https://www.npmjs.com/package/mf-hosting) or [mf-hosting-fronte
88
88
 
89
89
  ### Table of Contents
90
90
 
91
- - [usage](#usage)
92
- - [upload package](#upload-package)
93
- - [content providers](#content-providers)
94
- - [files (default)](#files-default)
95
- - [npm-pack](#npm-pack)
96
- - [node-modules](#node-modules)
97
- - [shared configuration](#shared-configuration)
98
- - [API](#api)
99
- - [Table of Contents](#table-of-contents)
100
- - [allInputs](#allinputs)
101
- - [allOutputs](#alloutputs)
102
- - [npmArchMapping](#npmarchmapping)
103
- - [content2Sources](#content2sources)
104
- - [Parameters](#parameters)
105
- - [PackageDefinition](#packagedefinition)
106
- - [Properties](#properties)
107
- - [extractFromPackage](#extractfrompackage)
108
- - [Parameters](#parameters-1)
109
- - [NPMPackContentProvider](#npmpackcontentprovider)
110
- - [Parameters](#parameters-2)
111
- - [Properties](#properties-1)
112
- - [name](#name)
113
- - [NodeModulesContentProvider](#nodemodulescontentprovider)
114
- - [Parameters](#parameters-3)
115
- - [Properties](#properties-2)
116
- - [asyncIterator](#asynciterator)
117
- - [name](#name-1)
118
- - [FileContentProvider](#filecontentprovider)
119
- - [Parameters](#parameters-4)
120
- - [asyncIterator](#asynciterator-1)
121
- - [name](#name-2)
122
- - [NFTContentProvider](#nftcontentprovider)
123
- - [Parameters](#parameters-5)
124
- - [asyncIterator](#asynciterator-2)
125
- - [name](#name-3)
126
- - [ContentProvider](#contentprovider)
127
- - [Parameters](#parameters-6)
128
- - [Properties](#properties-3)
129
- - [propertiesFor](#propertiesfor)
130
- - [Parameters](#parameters-7)
131
- - [asyncIterator](#asynciterator-3)
132
- - [DEBIAN](#debian)
133
- - [hookMapping](#hookmapping)
134
- - [attributes](#attributes)
135
- - [prepare](#prepare)
136
- - [Parameters](#parameters-8)
137
- - [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
138
- - [attributes](#attributes-1)
139
- - [quoteFile](#quotefile)
140
- - [Parameters](#parameters-9)
141
- - [RPM](#rpm)
142
- - [hookMapping](#hookmapping-1)
143
- - [attributes](#attributes-2)
144
- - [prepare](#prepare-1)
145
- - [Parameters](#parameters-10)
146
- - [OCI](#oci)
147
- - [DOCKER](#docker)
148
- - [attributes](#attributes-3)
149
- - [prepare](#prepare-2)
150
- - [Parameters](#parameters-11)
151
- - [BUILDAH](#buildah)
152
- - [Packager](#packager)
153
- - [Parameters](#parameters-12)
154
- - [packageName](#packagename)
155
- - [Parameters](#parameters-13)
156
- - [hookContent](#hookcontent)
157
- - [dependencyExpression](#dependencyexpression)
158
- - [Parameters](#parameters-14)
159
- - [tmpdir](#tmpdir)
160
- - [prepare](#prepare-3)
161
- - [Parameters](#parameters-15)
162
- - [create](#create)
163
- - [Parameters](#parameters-16)
164
- - [workspaceLayout](#workspacelayout)
165
- - [prepare](#prepare-4)
166
- - [Parameters](#parameters-17)
167
- - [Packager](#packager-1)
168
- - [Parameters](#parameters-18)
169
- - [packageName](#packagename-1)
170
- - [Parameters](#parameters-19)
171
- - [hookContent](#hookcontent-1)
172
- - [dependencyExpression](#dependencyexpression-1)
173
- - [Parameters](#parameters-20)
174
- - [tmpdir](#tmpdir-1)
175
- - [prepare](#prepare-5)
176
- - [Parameters](#parameters-21)
177
- - [create](#create-1)
178
- - [Parameters](#parameters-22)
179
- - [workspaceLayout](#workspacelayout-1)
180
- - [prepare](#prepare-6)
181
- - [Parameters](#parameters-23)
182
- - [Field](#field)
183
- - [Properties](#properties-4)
184
- - [deleteKey](#deletekey)
185
- - [Parameters](#parameters-24)
186
- - [copyNodeModules](#copynodemodules)
187
- - [Parameters](#parameters-25)
188
- - [PublishingDetail](#publishingdetail)
189
- - [Properties](#properties-5)
190
- - [createPublishingDetails](#createpublishingdetails)
191
- - [Parameters](#parameters-26)
192
- - [publish](#publish)
193
- - [Parameters](#parameters-27)
194
- - [utf8StreamOptions](#utf8streamoptions)
195
- - [decodePassword](#decodepassword)
196
- - [Parameters](#parameters-28)
197
- - [FunctionDecl](#functiondecl)
198
- - [Properties](#properties-6)
199
- - [extractFunctions](#extractfunctions)
200
- - [Parameters](#parameters-29)
201
- - [fieldProvider](#fieldprovider)
202
- - [Parameters](#parameters-30)
203
- - [Expander](#expander)
204
- - [Parameters](#parameters-31)
205
- - [copyEntries](#copyentries)
206
- - [Parameters](#parameters-32)
207
- - [install](#install)
208
- - [license](#license)
91
+ * [allInputs](#allinputs)
92
+ * [allOutputs](#alloutputs)
93
+ * [npmArchMapping](#npmarchmapping)
94
+ * [content2Sources](#content2sources)
95
+ * [Parameters](#parameters)
96
+ * [PackageDefinition](#packagedefinition)
97
+ * [Properties](#properties)
98
+ * [extractFromPackage](#extractfrompackage)
99
+ * [Parameters](#parameters-1)
100
+ * [BUILDAH](#buildah)
101
+ * [ContentProvider](#contentprovider)
102
+ * [Parameters](#parameters-2)
103
+ * [Properties](#properties-1)
104
+ * [propertiesFor](#propertiesfor)
105
+ * [Parameters](#parameters-3)
106
+ * [asyncIterator](#asynciterator)
107
+ * [FileContentProvider](#filecontentprovider)
108
+ * [Parameters](#parameters-4)
109
+ * [asyncIterator](#asynciterator-1)
110
+ * [name](#name)
111
+ * [NodeModulesContentProvider](#nodemodulescontentprovider)
112
+ * [Parameters](#parameters-5)
113
+ * [Properties](#properties-2)
114
+ * [asyncIterator](#asynciterator-2)
115
+ * [name](#name-1)
116
+ * [NPMPackContentProvider](#npmpackcontentprovider)
117
+ * [Parameters](#parameters-6)
118
+ * [Properties](#properties-3)
119
+ * [name](#name-2)
120
+ * [NFTContentProvider](#nftcontentprovider)
121
+ * [Parameters](#parameters-7)
122
+ * [asyncIterator](#asynciterator-3)
123
+ * [name](#name-3)
124
+ * [DEBIAN](#debian)
125
+ * [hookMapping](#hookmapping)
126
+ * [attributes](#attributes)
127
+ * [prepare](#prepare)
128
+ * [Parameters](#parameters-8)
129
+ * [quoteFile](#quotefile)
130
+ * [Parameters](#parameters-9)
131
+ * [RPM](#rpm)
132
+ * [hookMapping](#hookmapping-1)
133
+ * [attributes](#attributes-1)
134
+ * [prepare](#prepare-1)
135
+ * [Parameters](#parameters-10)
136
+ * [pkgKeyValuePairOptions](#pkgkeyvaluepairoptions)
137
+ * [attributes](#attributes-2)
138
+ * [OCI](#oci)
139
+ * [DOCKER](#docker)
140
+ * [attributes](#attributes-3)
141
+ * [prepare](#prepare-2)
142
+ * [Parameters](#parameters-11)
143
+ * [Packager](#packager)
144
+ * [Parameters](#parameters-12)
145
+ * [packageName](#packagename)
146
+ * [Parameters](#parameters-13)
147
+ * [hookContent](#hookcontent)
148
+ * [dependencyExpression](#dependencyexpression)
149
+ * [Parameters](#parameters-14)
150
+ * [tmpdir](#tmpdir)
151
+ * [prepare](#prepare-3)
152
+ * [Parameters](#parameters-15)
153
+ * [create](#create)
154
+ * [Parameters](#parameters-16)
155
+ * [workspaceLayout](#workspacelayout)
156
+ * [prepare](#prepare-4)
157
+ * [Parameters](#parameters-17)
158
+ * [Packager](#packager-1)
159
+ * [Parameters](#parameters-18)
160
+ * [packageName](#packagename-1)
161
+ * [Parameters](#parameters-19)
162
+ * [hookContent](#hookcontent-1)
163
+ * [dependencyExpression](#dependencyexpression-1)
164
+ * [Parameters](#parameters-20)
165
+ * [tmpdir](#tmpdir-1)
166
+ * [prepare](#prepare-5)
167
+ * [Parameters](#parameters-21)
168
+ * [create](#create-1)
169
+ * [Parameters](#parameters-22)
170
+ * [workspaceLayout](#workspacelayout-1)
171
+ * [prepare](#prepare-6)
172
+ * [Parameters](#parameters-23)
173
+ * [Field](#field)
174
+ * [Properties](#properties-4)
175
+ * [deleteKey](#deletekey)
176
+ * [Parameters](#parameters-24)
177
+ * [copyNodeModules](#copynodemodules)
178
+ * [Parameters](#parameters-25)
179
+ * [PublishingDetail](#publishingdetail)
180
+ * [Properties](#properties-5)
181
+ * [createPublishingDetails](#createpublishingdetails)
182
+ * [Parameters](#parameters-26)
183
+ * [publish](#publish)
184
+ * [Parameters](#parameters-27)
185
+ * [utf8StreamOptions](#utf8streamoptions)
186
+ * [decodePassword](#decodepassword)
187
+ * [Parameters](#parameters-28)
188
+ * [FunctionDecl](#functiondecl)
189
+ * [Properties](#properties-6)
190
+ * [extractFunctions](#extractfunctions)
191
+ * [Parameters](#parameters-29)
192
+ * [fieldProvider](#fieldprovider)
193
+ * [Parameters](#parameters-30)
194
+ * [Expander](#expander)
195
+ * [Parameters](#parameters-31)
196
+ * [copyEntries](#copyentries)
197
+ * [Parameters](#parameters-32)
209
198
 
210
199
  ## allInputs
211
200
 
@@ -268,22 +257,57 @@ Extract package definition from package.json.
268
257
 
269
258
  Returns **AsyncIterable<[PackageDefinition](#packagedefinition)>**&#x20;
270
259
 
271
- ## NPMPackContentProvider
260
+ ## BUILDAH
272
261
 
273
- **Extends ContentProvider**
262
+ **Extends DOCKER**
274
263
 
275
- Content from npm pack.
264
+ Use buildah @see <https://buildah.io>
265
+
266
+ ## ContentProvider
267
+
268
+ Source of package content.
276
269
 
277
270
  ### Parameters
278
271
 
279
272
  * `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
280
- * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to be set for each entry
281
- * `directoryProperties` &#x20;
273
+ * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
274
+ * `directoryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
282
275
 
283
276
  ### Properties
284
277
 
285
278
  * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
286
279
 
280
+ ### propertiesFor
281
+
282
+ #### Parameters
283
+
284
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
285
+ * `isCollection` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
286
+
287
+ Returns **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))**&#x20;
288
+
289
+ ### asyncIterator
290
+
291
+ List all entries.
292
+
293
+ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
294
+
295
+ ## FileContentProvider
296
+
297
+ **Extends ContentProvider**
298
+
299
+ Content provided form the file system.
300
+
301
+ ### Parameters
302
+
303
+ * `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;
304
+ * `entryProperties` &#x20;
305
+ * `directoryProperties` &#x20;
306
+
307
+ ### asyncIterator
308
+
309
+ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
310
+
287
311
  ### name
288
312
 
289
313
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
@@ -315,21 +339,21 @@ Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
315
339
 
316
340
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
317
341
 
318
- ## FileContentProvider
342
+ ## NPMPackContentProvider
319
343
 
320
344
  **Extends ContentProvider**
321
345
 
322
- Content provided form the file system.
346
+ Content from npm pack.
323
347
 
324
348
  ### Parameters
325
349
 
326
- * `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;
327
- * `entryProperties` &#x20;
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)** to be set for each entry
328
352
  * `directoryProperties` &#x20;
329
353
 
330
- ### asyncIterator
354
+ ### Properties
331
355
 
332
- Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
356
+ * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
333
357
 
334
358
  ### name
335
359
 
@@ -355,35 +379,6 @@ Returns **AsyncIterable\<ContentEntry>** all entries
355
379
 
356
380
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name of the content provider
357
381
 
358
- ## ContentProvider
359
-
360
- Source of package content.
361
-
362
- ### Parameters
363
-
364
- * `definitions` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
365
- * `entryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
366
- * `directoryProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
367
-
368
- ### Properties
369
-
370
- * `dir` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
371
-
372
- ### propertiesFor
373
-
374
- #### Parameters
375
-
376
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
377
- * `isCollection` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
378
-
379
- Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
380
-
381
- ### asyncIterator
382
-
383
- List all entries.
384
-
385
- Returns **AsyncIterable<(ContentEntry | CollectionEntry)>** all entries
386
-
387
382
  ## DEBIAN
388
383
 
389
384
  **Extends Packager**
@@ -410,15 +405,6 @@ Map install hook named from default (arch) to deb.
410
405
 
411
406
  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;
412
407
 
413
- ## pkgKeyValuePairOptions
414
-
415
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
416
-
417
- ## attributes
418
-
419
- well known package properties
420
- <https://www.archlinux.org/pacman/PKGBUILD.5.html>
421
-
422
408
  ## quoteFile
423
409
 
424
410
  ### Parameters
@@ -452,6 +438,15 @@ Check for rpmbuild presence.
452
438
 
453
439
  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
454
440
 
441
+ ## pkgKeyValuePairOptions
442
+
443
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
444
+
445
+ ## attributes
446
+
447
+ well known package properties
448
+ <https://www.archlinux.org/pacman/PKGBUILD.5.html>
449
+
455
450
  ## OCI
456
451
 
457
452
  **Extends Packager**
@@ -481,12 +476,6 @@ Check for docker presence.
481
476
 
482
477
  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
483
478
 
484
- ## BUILDAH
485
-
486
- **Extends DOCKER**
487
-
488
- Use buildah @see <https://buildah.io>
489
-
490
479
  ## Packager
491
480
 
492
481
  ### Parameters
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-pkgbuild",
3
- "version": "21.0.0",
3
+ "version": "21.0.2",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "provenance": false
@@ -52,9 +52,9 @@
52
52
  "aggregate-async-iterator": "^1.2.5",
53
53
  "commander": "^15.0.0",
54
54
  "compare-versions": "^6.1.1",
55
- "content-entry": "^15.0.0",
56
- "content-entry-filesystem": "^9.1.0",
57
- "content-entry-transform": "^1.7.2",
55
+ "content-entry": "^15.0.2",
56
+ "content-entry-filesystem": "^9.1.1",
57
+ "content-entry-transform": "^1.7.3",
58
58
  "execa": "^10.0.1",
59
59
  "ini": "^7.0.0",
60
60
  "iterable-string-interceptor": "^3.0.8",
package/src/output/alpm.mjs CHANGED
@@ -68,11 +68,11 @@ let _architecture = "aarch64";
68
68
 
69
69
  export class ALPM extends Packager {
70
70
  static get alias() {
71
- return "alpm";
71
+ return "arch";
72
72
  }
73
73
 
74
74
  static get name() {
75
- return "arch";
75
+ return "alpm";
76
76
  }
77
77
 
78
78
  static get description() {
@@ -295,13 +295,13 @@ package() {
295
295
  const flags = {
296
296
  user: ["-u", f => f.user],
297
297
  group: ["-g", f => f.group],
298
- mode: ["-m", f => Number(f.mode).toString(8)]
298
+ mode: ["-m", f => Number(f.mode && 0o7777).toString(8)] // TODO why only 12 bits
299
299
  };
300
300
 
301
301
  content =
302
302
  content.substring(0, markerPos) +
303
303
  permissions
304
- .filter(f=>f.isBlob)
304
+ .filter(f => f.isBlob)
305
305
  .map(f => {
306
306
  const options = Object.keys(flags)
307
307
  .filter(name => f[name])