repository-provider 26.0.3 → 26.1.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 (7) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +214 -166
  3. package/package.json +6 -6
  4. package/src/attribute.mjs +44 -17
  5. package/src/base-provider.mjs +40 -34
  6. package/src/branch.mjs +3 -0
  7. package/src/tag.mjs +3 -1
package/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2017-2021 by arlac77
1
+ Copyright (c) 2017-2022 by arlac77
2
2
  All rights reserved.
3
3
 
4
4
  Redistribution and use in source and binary forms, with or without
package/README.md CHANGED
@@ -51,20 +51,22 @@ console.log(await readme.getString());
51
51
  * [Properties](#properties)
52
52
  * [definePropertiesFromOptions](#definepropertiesfromoptions)
53
53
  * [Parameters](#parameters-1)
54
- * [setAttribute](#setattribute)
54
+ * [defaultValues](#defaultvalues)
55
55
  * [Parameters](#parameters-2)
56
- * [getAttribute](#getattribute)
56
+ * [setAttribute](#setattribute)
57
57
  * [Parameters](#parameters-3)
58
- * [optionJSON](#optionjson)
58
+ * [getAttribute](#getattribute)
59
59
  * [Parameters](#parameters-4)
60
- * [mapAttributes](#mapattributes)
60
+ * [optionJSON](#optionjson)
61
61
  * [Parameters](#parameters-5)
62
- * [mapAttributesInverse](#mapattributesinverse)
62
+ * [mapAttributes](#mapattributes)
63
63
  * [Parameters](#parameters-6)
64
- * [BaseObject](#baseobject)
64
+ * [mapAttributesInverse](#mapattributesinverse)
65
65
  * [Parameters](#parameters-7)
66
+ * [BaseObject](#baseobject)
67
+ * [Parameters](#parameters-8)
66
68
  * [equals](#equals)
67
- * [Parameters](#parameters-8)
69
+ * [Parameters](#parameters-9)
68
70
  * [attributes](#attributes)
69
71
  * [writableAttributes](#writableattributes)
70
72
  * [attributeMapping](#attributemapping)
@@ -72,129 +74,133 @@ console.log(await readme.getString());
72
74
  * [id](#id)
73
75
  * [uuid](#uuid)
74
76
  * [avatarURL](#avatarurl)
77
+ * [homePageURL](#homepageurl)
75
78
  * [MessageDestination](#messagedestination)
76
- * [Parameters](#parameters-9)
77
- * [BaseProvider](#baseprovider)
78
79
  * [Parameters](#parameters-10)
80
+ * [BaseProvider](#baseprovider)
81
+ * [Parameters](#parameters-11)
79
82
  * [Properties](#properties-1)
80
83
  * [equals](#equals-1)
81
- * [Parameters](#parameters-11)
84
+ * [Parameters](#parameters-12)
82
85
  * [repositoryBases](#repositorybases)
83
86
  * [normalizeRepositoryName](#normalizerepositoryname)
84
- * [Parameters](#parameters-12)
85
- * [normalizeGroupName](#normalizegroupname)
86
87
  * [Parameters](#parameters-13)
88
+ * [normalizeGroupName](#normalizegroupname)
89
+ * [Parameters](#parameters-14)
87
90
  * [areRepositoryNamesCaseSensitive](#arerepositorynamescasesensitive)
88
91
  * [areGroupNamesCaseSensitive](#aregroupnamescasesensitive)
89
92
  * [supportsBase](#supportsbase)
90
- * [Parameters](#parameters-14)
91
- * [parseName](#parsename)
92
93
  * [Parameters](#parameters-15)
93
- * [list](#list)
94
+ * [parseName](#parsename)
94
95
  * [Parameters](#parameters-16)
95
- * [projects](#projects)
96
+ * [createRepository](#createrepository)
96
97
  * [Parameters](#parameters-17)
97
- * [projects](#projects-1)
98
+ * [list](#list)
98
99
  * [Parameters](#parameters-18)
99
- * [repositories](#repositories)
100
+ * [projects](#projects)
100
101
  * [Parameters](#parameters-19)
101
- * [branches](#branches)
102
+ * [milestones](#milestones)
102
103
  * [Parameters](#parameters-20)
103
- * [tags](#tags)
104
+ * [repositories](#repositories)
104
105
  * [Parameters](#parameters-21)
105
- * [hooks](#hooks)
106
+ * [branches](#branches)
106
107
  * [Parameters](#parameters-22)
107
- * [pullRequests](#pullrequests)
108
+ * [tags](#tags)
108
109
  * [Parameters](#parameters-23)
109
- * [repositoryGroupClass](#repositorygroupclass)
110
- * [hookClass](#hookclass)
110
+ * [hooks](#hooks)
111
+ * [Parameters](#parameters-24)
112
+ * [pullRequests](#pullrequests)
113
+ * [Parameters](#parameters-25)
111
114
  * [name](#name)
112
115
  * [provider](#provider)
113
116
  * [url](#url)
114
117
  * [toJSON](#tojson)
118
+ * [repositoryGroupClass](#repositorygroupclass)
119
+ * [hookClass](#hookclass)
115
120
  * [repositoryClass](#repositoryclass)
116
121
  * [branchClass](#branchclass)
117
122
  * [entryClass](#entryclass)
118
123
  * [pullRequestClass](#pullrequestclass)
119
124
  * [instanceIdentifier](#instanceidentifier)
120
125
  * [optionsFromEnvironment](#optionsfromenvironment)
121
- * [Parameters](#parameters-24)
126
+ * [Parameters](#parameters-26)
122
127
  * [areOptionsSufficcient](#areoptionssufficcient)
123
- * [Parameters](#parameters-25)
128
+ * [Parameters](#parameters-27)
124
129
  * [initialize](#initialize)
125
- * [Parameters](#parameters-26)
130
+ * [Parameters](#parameters-28)
126
131
  * [priority](#priority)
127
132
  * [name](#name-1)
128
133
  * [messageDestination](#messagedestination-1)
129
134
  * [Commit](#commit)
130
135
  * [Properties](#properties-2)
131
136
  * [Commit](#commit-1)
132
- * [Parameters](#parameters-27)
137
+ * [Parameters](#parameters-29)
133
138
  * [Properties](#properties-3)
134
139
  * [CommitResult](#commitresult)
135
140
  * [Properties](#properties-4)
136
141
  * [Branch](#branch)
137
- * [Parameters](#parameters-28)
142
+ * [Parameters](#parameters-30)
138
143
  * [Properties](#properties-5)
139
144
  * [url](#url-1)
145
+ * [refType](#reftype)
140
146
  * [isDefault](#isdefault)
141
147
  * [delete](#delete)
142
148
  * [commit](#commit-2)
143
- * [Parameters](#parameters-29)
149
+ * [Parameters](#parameters-31)
144
150
  * [commitIntoPullRequest](#commitintopullrequest)
145
- * [Parameters](#parameters-30)
151
+ * [Parameters](#parameters-32)
146
152
  * [removeEntries](#removeentries)
147
- * [Parameters](#parameters-31)
153
+ * [Parameters](#parameters-33)
148
154
  * [entryClass](#entryclass-1)
149
155
  * [createPullRequest](#createpullrequest)
150
- * [Parameters](#parameters-32)
156
+ * [Parameters](#parameters-34)
151
157
  * [pullRequestClass](#pullrequestclass-1)
152
158
  * [createBranch](#createbranch)
153
- * [Parameters](#parameters-33)
159
+ * [Parameters](#parameters-35)
154
160
  * [Hook](#hook)
155
- * [Parameters](#parameters-34)
161
+ * [Parameters](#parameters-36)
156
162
  * [Properties](#properties-6)
157
163
  * [equals](#equals-2)
158
- * [Parameters](#parameters-35)
164
+ * [Parameters](#parameters-37)
159
165
  * [toJSON](#tojson-1)
160
166
  * [Issue](#issue)
161
- * [Parameters](#parameters-36)
167
+ * [Parameters](#parameters-38)
162
168
  * [Milestone](#milestone)
163
- * [Parameters](#parameters-37)
169
+ * [Parameters](#parameters-39)
164
170
  * [MultiGroupProvider](#multigroupprovider)
165
- * [Parameters](#parameters-38)
171
+ * [Parameters](#parameters-40)
166
172
  * [repository](#repository)
167
- * [Parameters](#parameters-39)
173
+ * [Parameters](#parameters-41)
168
174
  * [repositoryGroup](#repositorygroup)
169
- * [Parameters](#parameters-40)
175
+ * [Parameters](#parameters-42)
170
176
  * [repositoryGroups](#repositorygroups)
171
- * [Parameters](#parameters-41)
177
+ * [Parameters](#parameters-43)
172
178
  * [createRepositoryGroup](#createrepositorygroup)
173
- * [Parameters](#parameters-42)
179
+ * [Parameters](#parameters-44)
174
180
  * [addRepositoryGroup](#addrepositorygroup)
175
- * [Parameters](#parameters-43)
181
+ * [Parameters](#parameters-45)
176
182
  * [NamedObject](#namedobject)
177
- * [Parameters](#parameters-44)
183
+ * [Parameters](#parameters-46)
178
184
  * [Properties](#properties-7)
179
185
  * [equals](#equals-3)
180
- * [Parameters](#parameters-45)
186
+ * [Parameters](#parameters-47)
181
187
  * [displayName](#displayname)
182
188
  * [update](#update)
183
189
  * [toJSON](#tojson-2)
184
190
  * [Project](#project)
185
- * [Parameters](#parameters-46)
191
+ * [Parameters](#parameters-48)
186
192
  * [PullRequest](#pullrequest)
187
- * [Parameters](#parameters-47)
193
+ * [Parameters](#parameters-49)
188
194
  * [Properties](#properties-8)
189
195
  * [fullName](#fullname)
190
196
  * [url](#url-2)
191
197
  * [repository](#repository-1)
192
198
  * [provider](#provider-1)
193
199
  * [equals](#equals-4)
194
- * [Parameters](#parameters-48)
200
+ * [Parameters](#parameters-50)
195
201
  * [delete](#delete-1)
196
202
  * [merge](#merge)
197
- * [Parameters](#parameters-49)
203
+ * [Parameters](#parameters-51)
198
204
  * [decline](#decline)
199
205
  * [reviews](#reviews)
200
206
  * [identifier](#identifier)
@@ -202,36 +208,38 @@ console.log(await readme.getString());
202
208
  * [defaultListStates](#defaultliststates)
203
209
  * [validMergeMethods](#validmergemethods)
204
210
  * [list](#list-1)
205
- * [Parameters](#parameters-50)
211
+ * [Parameters](#parameters-52)
206
212
  * [open](#open)
207
- * [Parameters](#parameters-51)
213
+ * [Parameters](#parameters-53)
208
214
  * [title](#title)
209
215
  * [body](#body)
210
216
  * [state](#state)
211
217
  * [locked](#locked)
212
218
  * [merged](#merged)
213
219
  * [draft](#draft)
220
+ * [ContentEntry](#contententry)
221
+ * [Properties](#properties-9)
214
222
  * [Ref](#ref)
215
- * [Parameters](#parameters-52)
223
+ * [Parameters](#parameters-54)
216
224
  * [equals](#equals-5)
217
- * [Parameters](#parameters-53)
225
+ * [Parameters](#parameters-55)
218
226
  * [ref](#ref-1)
219
227
  * [refId](#refid)
220
- * [Parameters](#parameters-54)
228
+ * [Parameters](#parameters-56)
221
229
  * [entries](#entries)
222
- * [Parameters](#parameters-55)
230
+ * [Parameters](#parameters-57)
223
231
  * [asyncIterator](#asynciterator)
224
232
  * [maybeEntry](#maybeentry)
225
- * [Parameters](#parameters-56)
233
+ * [Parameters](#parameters-58)
226
234
  * [entry](#entry)
227
- * [Parameters](#parameters-57)
235
+ * [Parameters](#parameters-59)
228
236
  * [provider](#provider-2)
229
237
  * [owner](#owner)
230
238
  * [fullName](#fullname-1)
231
239
  * [fullCondensedName](#fullcondensedname)
232
240
  * [identifier](#identifier-1)
233
241
  * [issuesURL](#issuesurl)
234
- * [homePageURL](#homepageurl)
242
+ * [homePageURL](#homepageurl-1)
235
243
  * [isLocked](#islocked)
236
244
  * [isArchived](#isarchived)
237
245
  * [isDisabled](#isdisabled)
@@ -240,8 +248,8 @@ console.log(await readme.getString());
240
248
  * [attributes](#attributes-1)
241
249
  * [isProtected](#isprotected-1)
242
250
  * [RepositoryGroup](#repositorygroup-1)
243
- * [Parameters](#parameters-58)
244
- * [Properties](#properties-9)
251
+ * [Parameters](#parameters-60)
252
+ * [Properties](#properties-10)
245
253
  * [repositoryClass](#repositoryclass-1)
246
254
  * [branchClass](#branchclass-1)
247
255
  * [contentClass](#contentclass)
@@ -251,67 +259,67 @@ console.log(await readme.getString());
251
259
  * [type](#type)
252
260
  * [url](#url-3)
253
261
  * [RepositoryOwner](#repositoryowner)
254
- * [Parameters](#parameters-59)
262
+ * [Parameters](#parameters-61)
255
263
  * [Repository](#repository-2)
256
- * [Parameters](#parameters-60)
257
- * [Properties](#properties-10)
264
+ * [Parameters](#parameters-62)
265
+ * [Properties](#properties-11)
258
266
  * [fullName](#fullname-2)
259
267
  * [slug](#slug)
260
268
  * [provider](#provider-3)
261
269
  * [identifier](#identifier-2)
262
270
  * [equals](#equals-6)
263
- * [Parameters](#parameters-61)
271
+ * [Parameters](#parameters-63)
264
272
  * [entry](#entry-1)
265
- * [Parameters](#parameters-62)
273
+ * [Parameters](#parameters-64)
266
274
  * [entries](#entries-1)
267
- * [Parameters](#parameters-63)
275
+ * [Parameters](#parameters-65)
268
276
  * [maybeEntry](#maybeentry-1)
269
- * [Parameters](#parameters-64)
277
+ * [Parameters](#parameters-66)
270
278
  * [urls](#urls)
271
279
  * [url](#url-4)
272
280
  * [cloneURL](#cloneurl)
273
281
  * [issuesURL](#issuesurl-1)
274
- * [homePageURL](#homepageurl-1)
282
+ * [homePageURL](#homepageurl-2)
275
283
  * [condensedName](#condensedname)
276
284
  * [isArchived](#isarchived-1)
277
285
  * [isLocked](#islocked-1)
278
286
  * [isDisabled](#isdisabled-1)
279
287
  * [isTemplate](#istemplate)
280
288
  * [branch](#branch-1)
281
- * [Parameters](#parameters-65)
289
+ * [Parameters](#parameters-67)
282
290
  * [defaultBranch](#defaultbranch)
283
291
  * [branches](#branches-1)
284
- * [Parameters](#parameters-66)
292
+ * [Parameters](#parameters-68)
285
293
  * [createBranch](#createbranch-1)
286
- * [Parameters](#parameters-67)
294
+ * [Parameters](#parameters-69)
287
295
  * [addBranch](#addbranch)
288
- * [Parameters](#parameters-68)
296
+ * [Parameters](#parameters-70)
289
297
  * [deleteBranch](#deletebranch)
290
- * [Parameters](#parameters-69)
298
+ * [Parameters](#parameters-71)
291
299
  * [tags](#tags-1)
292
- * [Parameters](#parameters-70)
300
+ * [Parameters](#parameters-72)
293
301
  * [tag](#tag)
294
- * [Parameters](#parameters-71)
302
+ * [Parameters](#parameters-73)
295
303
  * [delete](#delete-2)
296
304
  * [createPullRequest](#createpullrequest-1)
297
- * [Parameters](#parameters-72)
305
+ * [Parameters](#parameters-74)
298
306
  * [addPullRequest](#addpullrequest)
299
- * [Parameters](#parameters-73)
307
+ * [Parameters](#parameters-75)
300
308
  * [pullRequests](#pullrequests-1)
301
309
  * [pullRequest](#pullrequest-1)
302
- * [Parameters](#parameters-74)
310
+ * [Parameters](#parameters-76)
303
311
  * [deletePullRequest](#deletepullrequest)
304
- * [Parameters](#parameters-75)
312
+ * [Parameters](#parameters-77)
305
313
  * [addHook](#addhook)
306
- * [Parameters](#parameters-76)
314
+ * [Parameters](#parameters-78)
307
315
  * [createHook](#createhook)
308
- * [Parameters](#parameters-77)
316
+ * [Parameters](#parameters-79)
309
317
  * [hooks](#hooks-1)
310
318
  * [hook](#hook-1)
311
- * [Parameters](#parameters-78)
319
+ * [Parameters](#parameters-80)
312
320
  * [type](#type-1)
313
321
  * [refId](#refid-1)
314
- * [Parameters](#parameters-79)
322
+ * [Parameters](#parameters-81)
315
323
  * [repositoryClass](#repositoryclass-2)
316
324
  * [pullRequestClass](#pullrequestclass-3)
317
325
  * [branchClass](#branchclass-2)
@@ -321,27 +329,27 @@ console.log(await readme.getString());
321
329
  * [attributes](#attributes-2)
322
330
  * [defaultBranchName](#defaultbranchname)
323
331
  * [urls](#urls-1)
324
- * [homePageURL](#homepageurl-2)
325
332
  * [issuesURL](#issuesurl-2)
326
333
  * [Review](#review)
327
334
  * [SingleGroupProvider](#singlegroupprovider)
328
335
  * [repository](#repository-3)
329
- * [Parameters](#parameters-80)
336
+ * [Parameters](#parameters-82)
330
337
  * [repositoryGroup](#repositorygroup-2)
331
- * [Parameters](#parameters-81)
338
+ * [Parameters](#parameters-83)
332
339
  * [repositoryGroups](#repositorygroups-1)
333
- * [Parameters](#parameters-82)
340
+ * [Parameters](#parameters-84)
334
341
  * [Tag](#tag-1)
335
- * [Parameters](#parameters-83)
342
+ * [Parameters](#parameters-85)
343
+ * [refType](#reftype-1)
336
344
  * [isWritable](#iswritable-1)
337
345
  * [asArray](#asarray)
338
- * [Parameters](#parameters-84)
346
+ * [Parameters](#parameters-86)
339
347
  * [stripBaseName](#stripbasename)
340
- * [Parameters](#parameters-85)
348
+ * [Parameters](#parameters-87)
341
349
  * [stripBaseNames](#stripbasenames)
342
- * [Parameters](#parameters-86)
350
+ * [Parameters](#parameters-88)
343
351
  * [generateBranchName](#generatebranchname)
344
- * [Parameters](#parameters-87)
352
+ * [Parameters](#parameters-89)
345
353
 
346
354
  ## Application
347
355
 
@@ -393,6 +401,17 @@ Object.definedProperties(new aClass(),{ with_default: { value: 77 }})
393
401
  * `properties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object properties (optional, default `{}`)
394
402
  * `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `object.constructor.attributes`)
395
403
 
404
+ ## defaultValues
405
+
406
+ Get default values.
407
+
408
+ ### Parameters
409
+
410
+ * `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
411
+ * `object`
412
+
413
+ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** filled with default values
414
+
396
415
  ## setAttribute
397
416
 
398
417
  Set Object attribute.
@@ -512,6 +531,12 @@ Avatar.
512
531
 
513
532
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
514
533
 
534
+ ## homePageURL
535
+
536
+ The url of home page.
537
+
538
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
539
+
515
540
  ## MessageDestination
516
541
 
517
542
  Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -543,7 +568,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
543
568
 
544
569
  ### repositoryBases
545
570
 
546
- All possible base urls.
571
+ All supported base urls.
547
572
  For github something like:
548
573
 
549
574
  * <git@github.com>
@@ -556,7 +581,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
556
581
 
557
582
  ### normalizeRepositoryName
558
583
 
559
- Bring a repository name into its normal form by removing any clutter
584
+ Bring a repository name into its normal form by removing any clutter.
560
585
  like .git suffix or #branch names.
561
586
 
562
587
  #### Parameters
@@ -568,7 +593,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
568
593
 
569
594
  ### normalizeGroupName
570
595
 
571
- Bring a group name into its normal form by removing any clutter
596
+ Bring a group name into its normal form by removing any clutter.
572
597
  like .git suffix or #branch names.
573
598
 
574
599
  #### Parameters
@@ -580,7 +605,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
580
605
 
581
606
  ### areRepositoryNamesCaseSensitive
582
607
 
583
- Are repositroy names case sensitive.
608
+ Are repository names case sensitive.
584
609
  Overwrite and return false if you want to have case insensitive repository lookup
585
610
 
586
611
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
@@ -614,6 +639,17 @@ base, group, repository and branch.
614
639
 
615
640
  Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** with separated attributes
616
641
 
642
+ ### createRepository
643
+
644
+ Create a repository.
645
+
646
+ #### Parameters
647
+
648
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of group and repository
649
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
650
+
651
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**
652
+
617
653
  ### list
618
654
 
619
655
  List provider objects of a given type.
@@ -631,9 +667,9 @@ List projects.
631
667
 
632
668
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
633
669
 
634
- Returns **Iterator\<Projects>** all matching projects of the provider
670
+ Returns **AsyncIterator<[Project](#project)>** all matching projects of the provider
635
671
 
636
- ### projects
672
+ ### milestones
637
673
 
638
674
  List milestones.
639
675
 
@@ -641,7 +677,7 @@ List milestones.
641
677
 
642
678
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
643
679
 
644
- Returns **Iterator<[Milestone](#milestone)>** all matching milestones of the provider
680
+ Returns **AsyncIterator<[Milestone](#milestone)>** all matching milestones of the provider
645
681
 
646
682
  ### repositories
647
683
 
@@ -651,7 +687,7 @@ List repositories.
651
687
 
652
688
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
653
689
 
654
- Returns **Iterator<[Repository](#repository)>** all matching repos of the provider
690
+ Returns **AsyncIterator<[Repository](#repository)>** all matching repos of the provider
655
691
 
656
692
  ### branches
657
693
 
@@ -661,7 +697,7 @@ List branches.
661
697
 
662
698
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
663
699
 
664
- Returns **Iterator<[Branch](#branch)>** all matching branches of the provider
700
+ Returns **AsyncIterator<[Branch](#branch)>** all matching branches of the provider
665
701
 
666
702
  ### tags
667
703
 
@@ -671,7 +707,7 @@ List tags.
671
707
 
672
708
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
673
709
 
674
- Returns **Iterator<[Tag](#tag)>** all matching tags of the provider
710
+ Returns **AsyncIterator<[Tag](#tag)>** all matching tags of the provider
675
711
 
676
712
  ### hooks
677
713
 
@@ -681,7 +717,7 @@ List hooks.
681
717
 
682
718
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
683
719
 
684
- Returns **Iterator<[Hook](#hook)>** all matching hooks of the provider
720
+ Returns **AsyncIterator<[Hook](#hook)>** all matching hooks of the provider
685
721
 
686
722
  ### pullRequests
687
723
 
@@ -691,15 +727,7 @@ List pull requests.
691
727
 
692
728
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
693
729
 
694
- Returns **Iterator<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
695
-
696
- ### repositoryGroupClass
697
-
698
- Returns **Class** repository group class used by the Provider
699
-
700
- ### hookClass
701
-
702
- Returns **Class** hook class used by the Provider
730
+ Returns **AsyncIterator<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
703
731
 
704
732
  ### name
705
733
 
@@ -711,7 +739,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
711
739
 
712
740
  We are our own provider.
713
741
 
714
- Returns **Provider** this
742
+ Returns **[BaseProvider](#baseprovider)** this
715
743
 
716
744
  ### url
717
745
 
@@ -722,6 +750,14 @@ Returns **any** url otf the provider.
722
750
  List all defined entries from attributes.
723
751
  return {object}
724
752
 
753
+ ### repositoryGroupClass
754
+
755
+ Returns **Class** repository group class used by the Provider
756
+
757
+ ### hookClass
758
+
759
+ Returns **Class** hook class used by the Provider
760
+
725
761
  ### repositoryClass
726
762
 
727
763
  Returns **Class** repository class used by the Provider
@@ -772,7 +808,7 @@ Creates a new provider for a given set of options.
772
808
 
773
809
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** additional options (optional, default `{}`)
774
810
 
775
- * `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**
811
+ * `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of the provider instance
776
812
  * `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
777
813
 
778
814
  Returns **[BaseProvider](#baseprovider)** newly created provider or undefined if options are not sufficient to construct a provider
@@ -797,7 +833,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
797
833
  ### Properties
798
834
 
799
835
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
800
- * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>**
836
+ * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>**
801
837
 
802
838
  ## Commit
803
839
 
@@ -845,6 +881,10 @@ Deliver repository and branch url combined.
845
881
 
846
882
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'repoUrl#branch'
847
883
 
884
+ ### refType
885
+
886
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
887
+
848
888
  ### isDefault
849
889
 
850
890
  Are we the default branch.
@@ -857,7 +897,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
857
897
 
858
898
  Delete the branch from the [Repository](#repository).
859
899
 
860
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>**
900
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
861
901
 
862
902
  ### commit
863
903
 
@@ -866,10 +906,10 @@ Commit entries.
866
906
  #### Parameters
867
907
 
868
908
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
869
- * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>** content to be commited
909
+ * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>** content to be commited
870
910
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
871
911
 
872
- Returns **[CommitResult](#commitresult)**
912
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[CommitResult](#commitresult)>**
873
913
 
874
914
  ### commitIntoPullRequest
875
915
 
@@ -885,7 +925,7 @@ Add commits into a pull request.
885
925
  * `options.skipWithoutCommits` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** do not create a PR if no commits are given
886
926
  * `options.bodyFromCommitMessages` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** generate body from commit messages
887
927
 
888
- Returns **[PullRequest](#pullrequest)**
928
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**
889
929
 
890
930
  ### removeEntries
891
931
 
@@ -893,7 +933,7 @@ Remove entries form the branch.
893
933
 
894
934
  #### Parameters
895
935
 
896
- * `entries` **Iterator\<ContentEntry>**
936
+ * `entries` **AsyncIterator<[ContentEntry](#contententry)>**
897
937
 
898
938
  ### entryClass
899
939
 
@@ -1001,7 +1041,7 @@ Lookup a repository in the provider and all of its repository groups.
1001
1041
 
1002
1042
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
1003
1043
 
1004
- Returns **[Repository](#repository)**
1044
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**
1005
1045
 
1006
1046
  ### repositoryGroup
1007
1047
 
@@ -1011,7 +1051,7 @@ Lookup a repository group.
1011
1051
 
1012
1052
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1013
1053
 
1014
- Returns **[RepositoryGroup](#repositorygroup)**
1054
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>**
1015
1055
 
1016
1056
  ### repositoryGroups
1017
1057
 
@@ -1021,7 +1061,7 @@ List groups.
1021
1061
 
1022
1062
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
1023
1063
 
1024
- Returns **Iterator<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
1064
+ Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
1025
1065
 
1026
1066
  ### createRepositoryGroup
1027
1067
 
@@ -1033,7 +1073,7 @@ If there is already a group for the given name it will be returend instead
1033
1073
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1034
1074
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1035
1075
 
1036
- Returns **[RepositoryGroup](#repositorygroup)**
1076
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>**
1037
1077
 
1038
1078
  ### addRepositoryGroup
1039
1079
 
@@ -1080,7 +1120,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
1080
1120
 
1081
1121
  ### update
1082
1122
 
1083
- Preserve object attributes in the backing store.
1123
+ Save object attributes in the backing store.
1084
1124
 
1085
1125
  ### toJSON
1086
1126
 
@@ -1144,7 +1184,7 @@ Returns **[Repository](#repository)** destination repository
1144
1184
 
1145
1185
  ### provider
1146
1186
 
1147
- Returns **Provider**
1187
+ Returns **[BaseProvider](#baseprovider)**
1148
1188
 
1149
1189
  ### equals
1150
1190
 
@@ -1178,7 +1218,7 @@ Decline the pull request.
1178
1218
 
1179
1219
  ### reviews
1180
1220
 
1181
- Returns **Interaor<[Review](#review)>**
1221
+ Returns **AsyncIterator<[Review](#review)>**
1182
1222
 
1183
1223
  ### identifier
1184
1224
 
@@ -1218,7 +1258,7 @@ result will be filtered by source branch, destination branch and states
1218
1258
  * `filter.destination` **[Branch](#branch)?**
1219
1259
  * `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**
1220
1260
 
1221
- Returns **Iterator<[PullRequest](#pullrequest)>**
1261
+ Returns **AsyncIterator<[PullRequest](#pullrequest)>**
1222
1262
 
1223
1263
  ### open
1224
1264
 
@@ -1270,6 +1310,14 @@ Draft state of the pull request.
1270
1310
 
1271
1311
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
1272
1312
 
1313
+ ## ContentEntry
1314
+
1315
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
1316
+
1317
+ ### Properties
1318
+
1319
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1320
+
1273
1321
  ## Ref
1274
1322
 
1275
1323
  **Extends NamedObject**
@@ -1288,13 +1336,13 @@ Check for equality.
1288
1336
 
1289
1337
  #### Parameters
1290
1338
 
1291
- * `other` **[Branch](#branch)**
1339
+ * `other` **[Ref](#ref)**
1292
1340
 
1293
1341
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name and repository are equal
1294
1342
 
1295
1343
  ### ref
1296
1344
 
1297
- ref name
1345
+ ref name.
1298
1346
 
1299
1347
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** git ref of the Ref
1300
1348
 
@@ -1306,7 +1354,7 @@ Get sha of a ref.
1306
1354
 
1307
1355
  * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `this.ref`)
1308
1356
 
1309
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** sha of the ref
1357
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref
1310
1358
 
1311
1359
  ### entries
1312
1360
 
@@ -1316,13 +1364,13 @@ List entries of the branch.
1316
1364
 
1317
1365
  * `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
1318
1366
 
1319
- Returns **ContentEntry** all matching entries in the branch
1367
+ Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
1320
1368
 
1321
1369
  ### asyncIterator
1322
1370
 
1323
1371
  List all entries of the branch.
1324
1372
 
1325
- Returns **asyncIterator\<ContentEntry>** all entries in the branch
1373
+ Returns **AsyncIterator<[ContentEntry](#contententry)>** all entries in the branch
1326
1374
 
1327
1375
  ### maybeEntry
1328
1376
 
@@ -1332,7 +1380,7 @@ Get exactly one matching entry by name or undefine if no such entry is found.
1332
1380
 
1333
1381
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1334
1382
 
1335
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>**
1383
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1336
1384
 
1337
1385
  ### entry
1338
1386
 
@@ -1342,13 +1390,13 @@ Get exactly one matching entry by name (throws if entry is not found).
1342
1390
 
1343
1391
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1344
1392
 
1345
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>**
1393
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1346
1394
 
1347
1395
  ### provider
1348
1396
 
1349
1397
  The provider we live in.
1350
1398
 
1351
- Returns **Provider**
1399
+ Returns **[BaseProvider](#baseprovider)**
1352
1400
 
1353
1401
  ### owner
1354
1402
 
@@ -1432,7 +1480,7 @@ Abstract repository collection.
1432
1480
 
1433
1481
  ### Parameters
1434
1482
 
1435
- * `provider` **Provider**
1483
+ * `provider` **[BaseProvider](#baseprovider)**
1436
1484
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
1437
1485
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1438
1486
 
@@ -1443,7 +1491,7 @@ Abstract repository collection.
1443
1491
 
1444
1492
  ### Properties
1445
1493
 
1446
- * `provider` **Provider**
1494
+ * `provider` **[BaseProvider](#baseprovider)**
1447
1495
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1448
1496
 
1449
1497
  ### repositoryClass
@@ -1540,7 +1588,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
1540
1588
 
1541
1589
  The owners provider.
1542
1590
 
1543
- Returns **Provider**
1591
+ Returns **[BaseProvider](#baseprovider)**
1544
1592
 
1545
1593
  ### identifier
1546
1594
 
@@ -1567,7 +1615,7 @@ Lookup entries form the head of the default branch.
1567
1615
 
1568
1616
  * `name`
1569
1617
 
1570
- Returns **Entry**
1618
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1571
1619
 
1572
1620
  ### entries
1573
1621
 
@@ -1577,7 +1625,7 @@ List entries of the default branch.
1577
1625
 
1578
1626
  * `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
1579
1627
 
1580
- Returns **Entry** all matching entries in the branch
1628
+ Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
1581
1629
 
1582
1630
  ### maybeEntry
1583
1631
 
@@ -1587,7 +1635,7 @@ Get exactly one matching entry by name or undefined if no such entry is found.
1587
1635
 
1588
1636
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1589
1637
 
1590
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Entry>**
1638
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1591
1639
 
1592
1640
  ### urls
1593
1641
 
@@ -1671,7 +1719,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
1671
1719
 
1672
1720
  * `patterns`
1673
1721
 
1674
- Returns **Iterator<[Branch](#branch)>** of all branches
1722
+ Returns **AsyncIterator<[Branch](#branch)>** of all branches
1675
1723
 
1676
1724
  ### createBranch
1677
1725
 
@@ -1705,7 +1753,7 @@ Delete a [Branch](#branch).
1705
1753
 
1706
1754
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
1707
1755
 
1708
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>**
1756
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
1709
1757
 
1710
1758
  ### tags
1711
1759
 
@@ -1713,7 +1761,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
1713
1761
 
1714
1762
  * `patterns` **([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)>)**
1715
1763
 
1716
- Returns **Iterator<[Tag](#tag)>** of all tags
1764
+ Returns **AsyncIterator<[Tag](#tag)>** of all tags
1717
1765
 
1718
1766
  ### tag
1719
1767
 
@@ -1723,14 +1771,14 @@ Get a Tag.
1723
1771
 
1724
1772
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1725
1773
 
1726
- Returns **[Tag](#tag)**
1774
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Tag](#tag)>**
1727
1775
 
1728
1776
  ### delete
1729
1777
 
1730
1778
  Delete the repository from the [Provider](Provider).
1731
1779
  [Provider#deleteRepository](Provider#deleteRepository)
1732
1780
 
1733
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>**
1781
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
1734
1782
 
1735
1783
  ### createPullRequest
1736
1784
 
@@ -1742,7 +1790,7 @@ Create a pull request (or deliver an already present for thefiven name).
1742
1790
  * `source` **[Branch](#branch)** branch
1743
1791
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1744
1792
 
1745
- Returns **[PullRequest](#pullrequest)**
1793
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>**
1746
1794
 
1747
1795
  ### addPullRequest
1748
1796
 
@@ -1760,7 +1808,7 @@ Returns **[PullRequest](#pullrequest)**
1760
1808
 
1761
1809
  Deliver all [PullRequest](#pullrequest)s.
1762
1810
 
1763
- Returns **Iterator<[PullRequest](#pullrequest)>** of all pull requests
1811
+ Returns **AsyncIterator<[PullRequest](#pullrequest)>** of all pull requests
1764
1812
 
1765
1813
  ### pullRequest
1766
1814
 
@@ -1780,7 +1828,7 @@ Delete a [PullRequest](#pullrequest).
1780
1828
 
1781
1829
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1782
1830
 
1783
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
1831
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>**
1784
1832
 
1785
1833
  ### addHook
1786
1834
 
@@ -1802,7 +1850,7 @@ Add a new Hook.
1802
1850
 
1803
1851
  List hooks.
1804
1852
 
1805
- Returns **[Hook](#hook)** all hooks of the repository
1853
+ Returns **AsyncIterator<[Hook](#hook)>** all hooks of the repository
1806
1854
 
1807
1855
  ### hook
1808
1856
 
@@ -1812,7 +1860,7 @@ Get a Hook.
1812
1860
 
1813
1861
  * `id` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))**
1814
1862
 
1815
- Returns **[Hook](#hook)** for the given id
1863
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Hook](#hook)>** for the given id
1816
1864
 
1817
1865
  ### type
1818
1866
 
@@ -1828,7 +1876,7 @@ Get sha of a ref.
1828
1876
 
1829
1877
  * `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1830
1878
 
1831
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** sha of the ref
1879
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref
1832
1880
 
1833
1881
  ### repositoryClass
1834
1882
 
@@ -1880,12 +1928,6 @@ URLs of the repository
1880
1928
 
1881
1929
  Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
1882
1930
 
1883
- ## homePageURL
1884
-
1885
- The url of home page.
1886
-
1887
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1888
-
1889
1931
  ## issuesURL
1890
1932
 
1891
1933
  The url of issue tracking system.
@@ -1910,7 +1952,7 @@ Lookup a repository in the provider and all of its repository groups.
1910
1952
 
1911
1953
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
1912
1954
 
1913
- Returns **[Repository](#repository)**
1955
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>**
1914
1956
 
1915
1957
  ### repositoryGroup
1916
1958
 
@@ -1920,7 +1962,7 @@ Get a single group.
1920
1962
 
1921
1963
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1922
1964
 
1923
- Returns **[RepositoryGroup](#repositorygroup)** deliver the one and only present group
1965
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** deliver the one and only present group
1924
1966
 
1925
1967
  ### repositoryGroups
1926
1968
 
@@ -1930,7 +1972,7 @@ List groups.
1930
1972
 
1931
1973
  * `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**
1932
1974
 
1933
- Returns **Iterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
1975
+ Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
1934
1976
 
1935
1977
  ## Tag
1936
1978
 
@@ -1944,6 +1986,10 @@ Tag refs
1944
1986
  * `name`
1945
1987
  * `options`
1946
1988
 
1989
+ ### refType
1990
+
1991
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
1992
+
1947
1993
  ### isWritable
1948
1994
 
1949
1995
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
@@ -1968,7 +2014,7 @@ A URL auth component will be removed to.
1968
2014
 
1969
2015
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1970
2016
  * `repositoryBases` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all possible bases
1971
- * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** to be called with the found base name
2017
+ * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
1972
2018
 
1973
2019
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name without base
1974
2020
 
@@ -1978,9 +2024,9 @@ Loops over names and executes stripBaseName.
1978
2024
 
1979
2025
  ### Parameters
1980
2026
 
1981
- * `names` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
2027
+ * `names` **([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)>)**
1982
2028
  * `repositoryBases` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all possible bases
1983
- * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** to be called with the found base name
2029
+ * `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
1984
2030
 
1985
2031
  Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** names without base
1986
2032
 
@@ -1995,6 +2041,8 @@ Find a new branch name for a given pattern.
1995
2041
  * `repository` **[Repository](#repository)**
1996
2042
  * `pattern` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1997
2043
 
2044
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
2045
+
1998
2046
  # install
1999
2047
 
2000
2048
  With [npm](http://npmjs.org) do:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "26.0.3",
3
+ "version": "26.1.3",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -33,15 +33,15 @@
33
33
  "matching-iterator": "^2.0.0"
34
34
  },
35
35
  "devDependencies": {
36
- "ava": "^3.15.0",
37
- "c8": "^7.10.0",
36
+ "ava": "^4.0.1",
37
+ "c8": "^7.11.0",
38
38
  "documentation": "^13.2.5",
39
- "repository-provider-test-support": "^1.8.14",
39
+ "repository-provider-test-support": "^1.9.6",
40
40
  "semantic-release": "^18.0.1",
41
- "typescript": "^4.6.0-dev.20211228"
41
+ "typescript": "^4.6.0-dev.20220115"
42
42
  },
43
43
  "engines": {
44
- "node": ">=14.18.1"
44
+ "node": ">=14.18.3"
45
45
  },
46
46
  "repository": {
47
47
  "type": "git",
package/src/attribute.mjs CHANGED
@@ -1,4 +1,3 @@
1
-
2
1
  /**
3
2
  * @typedef {Object} Attribute
4
3
  *
@@ -46,12 +45,15 @@ export function definePropertiesFromOptions(
46
45
  const property = properties[first];
47
46
 
48
47
  let value = options[name];
49
- if (
50
- value === undefined &&
51
- attribute.default !== undefined &&
52
- attribute.default !== getAttribute(object, name)
53
- ) {
54
- value = attribute.default;
48
+ if (value === undefined) {
49
+ if (attribute.getDefault) {
50
+ value = attribute.getDefault(attribute, object);
51
+ } else if (
52
+ attribute.default !== undefined &&
53
+ attribute.default !== getAttribute(object, name)
54
+ ) {
55
+ value = attribute.default;
56
+ }
55
57
  }
56
58
 
57
59
  if (attribute.set) {
@@ -100,6 +102,28 @@ export function definePropertiesFromOptions(
100
102
  Object.assign(object, applyLater);
101
103
  }
102
104
 
105
+ /**
106
+ * Get default values.
107
+ * @param {Object} attributes
108
+ * @return {Object} filled with default values
109
+ */
110
+ export function defaultValues(attributes, object) {
111
+ return Object.fromEntries(
112
+ Object.entries(attributes).reduce((a, c) => {
113
+ const [name, attribute] = c;
114
+
115
+ if (attribute.default !== undefined) {
116
+ a.push([name, attribute.default]);
117
+ }
118
+ else if (attribute.getDefault !== undefined) {
119
+ a.push([name, attribute.getDefault(attribute, object)]);
120
+ }
121
+
122
+ return a;
123
+ }, [])
124
+ );
125
+ }
126
+
103
127
  /**
104
128
  * Set Object attribute.
105
129
  * The name may be a property path like 'a.b.c'.
@@ -112,7 +136,7 @@ export function setAttribute(object, name, value) {
112
136
  const last = parts.pop();
113
137
 
114
138
  for (const p of parts) {
115
- if (object[p] === undefined || typeof object[p] !== 'object') {
139
+ if (object[p] === undefined || typeof object[p] !== "object") {
116
140
  object[p] = {};
117
141
  }
118
142
  object = object[p];
@@ -149,15 +173,18 @@ export function getAttribute(object, name) {
149
173
  * @param {Object} attributes to operator on
150
174
  * @return {Object} initial + defined values
151
175
  */
152
- export function optionJSON(object, initial = {}, attributes=object.constructor.attributes) {
153
- return Object.keys(attributes || {})
154
- .reduce((a, c) => {
155
- const value = object[c];
156
- if (value !== undefined && !(value instanceof Function)) {
157
- a[c] = value;
158
- }
159
- return a;
160
- }, initial);
176
+ export function optionJSON(
177
+ object,
178
+ initial = {},
179
+ attributes = object.constructor.attributes
180
+ ) {
181
+ return Object.keys(attributes || {}).reduce((a, c) => {
182
+ const value = object[c];
183
+ if (value !== undefined && !(value instanceof Function)) {
184
+ a[c] = value;
185
+ }
186
+ return a;
187
+ }, initial);
161
188
  }
162
189
 
163
190
  /**
package/src/base-provider.mjs CHANGED
@@ -126,7 +126,7 @@ export class BaseProvider {
126
126
  /**
127
127
  * Creates a new provider for a given set of options.
128
128
  * @param {Object} options additional options
129
- * @param {string?} options.instanceIdentifier
129
+ * @param {string} [options.instanceIdentifier] name of the provider instance
130
130
  * @param {Object} env taken from process.env
131
131
  * @return {BaseProvider} newly created provider or undefined if options are not sufficient to construct a provider
132
132
  */
@@ -153,7 +153,7 @@ export class BaseProvider {
153
153
  }
154
154
 
155
155
  /**
156
- * All possible base urls.
156
+ * All supported base urls.
157
157
  * For github something like:
158
158
  * - git@github.com
159
159
  * - git://github.com
@@ -167,7 +167,7 @@ export class BaseProvider {
167
167
  }
168
168
 
169
169
  /**
170
- * Bring a repository name into its normal form by removing any clutter
170
+ * Bring a repository name into its normal form by removing any clutter.
171
171
  * like .git suffix or #branch names.
172
172
  * @param {string} name
173
173
  * @param {boolean} forLookup
@@ -181,7 +181,7 @@ export class BaseProvider {
181
181
  }
182
182
 
183
183
  /**
184
- * Bring a group name into its normal form by removing any clutter
184
+ * Bring a group name into its normal form by removing any clutter.
185
185
  * like .git suffix or #branch names.
186
186
  * @param {string} name
187
187
  * @param {boolean} forLookup
@@ -195,7 +195,7 @@ export class BaseProvider {
195
195
  }
196
196
 
197
197
  /**
198
- * Are repositroy names case sensitive.
198
+ * Are repository names case sensitive.
199
199
  * Overwrite and return false if you want to have case insensitive repository lookup
200
200
  * @return {boolean} true
201
201
  */
@@ -293,6 +293,12 @@ export class BaseProvider {
293
293
  return result;
294
294
  }
295
295
 
296
+ /**
297
+ * Create a repository.
298
+ * @param {string} name of group and repository
299
+ * @param {Object} options
300
+ * @returns {Promise<Repository>}
301
+ */
296
302
  async createRepository(name, options) {
297
303
  const { group, repository } = this.parseName(name);
298
304
  const rg = await this.repositoryGroup(group);
@@ -311,7 +317,7 @@ export class BaseProvider {
311
317
  yield* group[type]();
312
318
  }
313
319
  } else {
314
- for (let pattern of asArray(patterns)) {
320
+ for (const pattern of asArray(patterns)) {
315
321
  const [groupPattern, repoPattern] = stripBaseName(
316
322
  pattern,
317
323
  this.repositoryBases
@@ -387,20 +393,6 @@ export class BaseProvider {
387
393
  yield* this.list("pullRequests", patterns);
388
394
  }
389
395
 
390
- /**
391
- * @return {Class} repository group class used by the Provider
392
- */
393
- get repositoryGroupClass() {
394
- return RepositoryGroup;
395
- }
396
-
397
- /**
398
- * @return {Class} hook class used by the Provider
399
- */
400
- get hookClass() {
401
- return Hook;
402
- }
403
-
404
396
  /**
405
397
  * Deliver the provider name.
406
398
  * @return {string} class name by default
@@ -448,6 +440,34 @@ export class BaseProvider {
448
440
  return json;
449
441
  }
450
442
 
443
+ initializeRepositories() {}
444
+
445
+ info(...args) {
446
+ return this.messageDestination.info(...args);
447
+ }
448
+
449
+ warn(...args) {
450
+ return this.messageDestination.warn(...args);
451
+ }
452
+
453
+ error(...args) {
454
+ return this.messageDestination.error(...args);
455
+ }
456
+
457
+ /**
458
+ * @return {Class} repository group class used by the Provider
459
+ */
460
+ get repositoryGroupClass() {
461
+ return RepositoryGroup;
462
+ }
463
+
464
+ /**
465
+ * @return {Class} hook class used by the Provider
466
+ */
467
+ get hookClass() {
468
+ return Hook;
469
+ }
470
+
451
471
  /**
452
472
  * @return {Class} repository class used by the Provider
453
473
  */
@@ -475,18 +495,4 @@ export class BaseProvider {
475
495
  get pullRequestClass() {
476
496
  return PullRequest;
477
497
  }
478
-
479
- initializeRepositories() {}
480
-
481
- info(...args) {
482
- return this.messageDestination.info(...args);
483
- }
484
-
485
- warn(...args) {
486
- return this.messageDestination.warn(...args);
487
- }
488
-
489
- error(...args) {
490
- return this.messageDestination.error(...args);
491
- }
492
498
  }
package/src/branch.mjs CHANGED
@@ -40,6 +40,9 @@ export class Branch extends Ref {
40
40
  : `${this.repository.url}#${this.name}`;
41
41
  }
42
42
 
43
+ /**
44
+ * @return {string} tags
45
+ */
43
46
  get refType() {
44
47
  return "heads";
45
48
  }
package/src/tag.mjs CHANGED
@@ -9,6 +9,9 @@ export class Tag extends Ref {
9
9
  repository._addTag(this);
10
10
  }
11
11
 
12
+ /**
13
+ * @return {string} tags
14
+ */
12
15
  get refType() {
13
16
  return "tags";
14
17
  }
@@ -21,5 +24,4 @@ export class Tag extends Ref {
21
24
  {
22
25
  return false;
23
26
  }
24
-
25
27
  }