repository-provider 32.6.12 → 32.7.1

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.
package/README.md CHANGED
@@ -46,8 +46,6 @@ console.log(await readme.getString());
46
46
  ### Table of Contents
47
47
 
48
48
  * [Application](#application)
49
- * [AttributeDefinition](#attributedefinition)
50
- * [Properties](#properties)
51
49
  * [definePropertiesFromOptions](#definepropertiesfromoptions)
52
50
  * [Parameters](#parameters)
53
51
  * [defaultValues](#defaultvalues)
@@ -58,12 +56,15 @@ console.log(await readme.getString());
58
56
  * [Parameters](#parameters-3)
59
57
  * [mapAttributesInverse](#mapattributesinverse)
60
58
  * [Parameters](#parameters-4)
59
+ * [AttributeDefinition](#attributedefinition)
60
+ * [Properties](#properties)
61
61
  * [tokens](#tokens)
62
62
  * [Parameters](#parameters-5)
63
63
  * [setAttribute](#setattribute)
64
64
  * [Parameters](#parameters-6)
65
65
  * [getAttribute](#getattribute)
66
66
  * [Parameters](#parameters-7)
67
+ * [default\_attribute](#default_attribute)
67
68
  * [description\_attribute](#description_attribute)
68
69
  * [id\_attribute](#id_attribute)
69
70
  * [body\_attribute](#body_attribute)
@@ -142,7 +143,6 @@ console.log(await readme.getString());
142
143
  * [messageDestination](#messagedestination-1)
143
144
  * [Branch](#branch)
144
145
  * [Parameters](#parameters-28)
145
- * [Properties](#properties-3)
146
146
  * [url](#url)
147
147
  * [refType](#reftype)
148
148
  * [isWritable](#iswritable-1)
@@ -158,53 +158,61 @@ console.log(await readme.getString());
158
158
  * [Parameters](#parameters-32)
159
159
  * [createBranch](#createbranch)
160
160
  * [Parameters](#parameters-33)
161
- * [CommitResult](#commitresult)
162
- * [Properties](#properties-4)
163
- * [Commit](#commit-1)
161
+ * [ContentEntry](#contententry)
164
162
  * [Parameters](#parameters-34)
163
+ * [Properties](#properties-3)
164
+ * [ContentEntry](#contententry-1)
165
+ * [Properties](#properties-4)
166
+ * [ContentEntry](#contententry-2)
167
+ * [Parameters](#parameters-35)
165
168
  * [Properties](#properties-5)
169
+ * [CommitResult](#commitresult)
170
+ * [Properties](#properties-6)
171
+ * [Commit](#commit-1)
172
+ * [Parameters](#parameters-36)
173
+ * [Properties](#properties-7)
166
174
  * [Hook](#hook)
167
175
  * [Issue](#issue)
168
176
  * [Milestone](#milestone)
169
177
  * [MultiGroupProvider](#multigroupprovider)
170
178
  * [repository](#repository)
171
- * [Parameters](#parameters-35)
179
+ * [Parameters](#parameters-37)
172
180
  * [branch](#branch-1)
173
- * [Parameters](#parameters-36)
181
+ * [Parameters](#parameters-38)
174
182
  * [repositoryGroup](#repositorygroup)
175
- * [Parameters](#parameters-37)
183
+ * [Parameters](#parameters-39)
176
184
  * [repositoryGroups](#repositorygroups)
177
- * [Parameters](#parameters-38)
185
+ * [Parameters](#parameters-40)
178
186
  * [createRepositoryGroup](#createrepositorygroup)
179
- * [Parameters](#parameters-39)
187
+ * [Parameters](#parameters-41)
180
188
  * [addRepositoryGroup](#addrepositorygroup)
181
- * [Parameters](#parameters-40)
189
+ * [Parameters](#parameters-42)
182
190
  * [NamedObject](#namedobject)
183
- * [Parameters](#parameters-41)
184
- * [Properties](#properties-6)
191
+ * [Parameters](#parameters-43)
192
+ * [Properties](#properties-8)
185
193
  * [equals](#equals-2)
186
- * [Parameters](#parameters-42)
194
+ * [Parameters](#parameters-44)
187
195
  * [toJSON](#tojson-1)
188
196
  * [OwnedObject](#ownedobject)
189
- * [Parameters](#parameters-43)
197
+ * [Parameters](#parameters-45)
190
198
  * [delete](#delete-1)
191
199
  * [equals](#equals-3)
192
- * [Parameters](#parameters-44)
200
+ * [Parameters](#parameters-46)
193
201
  * [api](#api)
194
202
  * [url](#url-1)
195
203
  * [provider](#provider-1)
196
204
  * [identifier](#identifier)
197
205
  * [fullName](#fullname-1)
198
206
  * [trace](#trace)
199
- * [Parameters](#parameters-45)
207
+ * [Parameters](#parameters-47)
200
208
  * [info](#info)
201
- * [Parameters](#parameters-46)
209
+ * [Parameters](#parameters-48)
202
210
  * [warn](#warn)
203
- * [Parameters](#parameters-47)
211
+ * [Parameters](#parameters-49)
204
212
  * [error](#error)
205
- * [Parameters](#parameters-48)
213
+ * [Parameters](#parameters-50)
206
214
  * [debug](#debug)
207
- * [Parameters](#parameters-49)
215
+ * [Parameters](#parameters-51)
208
216
  * [repositoryClass](#repositoryclass-1)
209
217
  * [pullRequestClass](#pullrequestclass-1)
210
218
  * [branchClass](#branchclass-1)
@@ -215,39 +223,37 @@ console.log(await readme.getString());
215
223
  * [deleteMethodName](#deletemethodname)
216
224
  * [Project](#project)
217
225
  * [PullRequest](#pullrequest)
218
- * [Parameters](#parameters-50)
219
- * [Properties](#properties-7)
226
+ * [Parameters](#parameters-52)
227
+ * [Properties](#properties-9)
220
228
  * [fullName](#fullname-2)
221
229
  * [url](#url-2)
222
230
  * [repository](#repository-1)
223
231
  * [delete](#delete-2)
224
232
  * [merge](#merge)
225
- * [Parameters](#parameters-51)
233
+ * [Parameters](#parameters-53)
226
234
  * [decline](#decline)
227
235
  * [reviews](#reviews)
228
236
  * [identifier](#identifier-1)
229
237
  * [defaultListStates](#defaultliststates)
230
238
  * [validMergeMethods](#validmergemethods)
231
239
  * [list](#list-1)
232
- * [Parameters](#parameters-52)
240
+ * [Parameters](#parameters-54)
233
241
  * [open](#open)
234
- * [Parameters](#parameters-53)
242
+ * [Parameters](#parameters-55)
235
243
  * [state](#state)
236
244
  * [locked](#locked)
237
245
  * [merged](#merged)
238
246
  * [draft](#draft)
239
- * [ContentEntry](#contententry)
240
- * [Properties](#properties-8)
241
247
  * [Ref](#ref)
242
248
  * [ref](#ref-1)
243
249
  * [refId](#refid)
244
250
  * [entries](#entries)
245
- * [Parameters](#parameters-54)
251
+ * [Parameters](#parameters-56)
246
252
  * [asyncIterator](#asynciterator)
247
253
  * [maybeEntry](#maybeentry)
248
- * [Parameters](#parameters-55)
254
+ * [Parameters](#parameters-57)
249
255
  * [entry](#entry)
250
- * [Parameters](#parameters-56)
256
+ * [Parameters](#parameters-58)
251
257
  * [repository](#repository-2)
252
258
  * [fullName](#fullname-3)
253
259
  * [fullCondensedName](#fullcondensedname-1)
@@ -261,26 +267,25 @@ console.log(await readme.getString());
261
267
  * [attributes](#attributes-1)
262
268
  * [isProtected](#isprotected-1)
263
269
  * [RepositoryGroup](#repositorygroup-1)
264
- * [Parameters](#parameters-57)
265
- * [Properties](#properties-9)
270
+ * [Parameters](#parameters-59)
271
+ * [Properties](#properties-10)
266
272
  * [attributeMapping](#attributemapping-1)
267
273
  * [type](#type-1)
268
274
  * [homePageURL](#homepageurl-1)
269
275
  * [RepositoryOwner](#repositoryowner)
270
- * [Parameters](#parameters-58)
276
+ * [Parameters](#parameters-60)
271
277
  * [Repository](#repository-3)
272
- * [Parameters](#parameters-59)
273
- * [Properties](#properties-10)
278
+ * [Parameters](#parameters-61)
274
279
  * [fullName](#fullname-4)
275
280
  * [slug](#slug)
276
281
  * [entry](#entry-1)
277
- * [Parameters](#parameters-60)
282
+ * [Parameters](#parameters-62)
278
283
  * [entries](#entries-1)
279
- * [Parameters](#parameters-61)
284
+ * [Parameters](#parameters-63)
280
285
  * [maybeEntry](#maybeentry-1)
281
- * [Parameters](#parameters-62)
286
+ * [Parameters](#parameters-64)
282
287
  * [commits](#commits)
283
- * [Parameters](#parameters-63)
288
+ * [Parameters](#parameters-65)
284
289
  * [cloneURL](#cloneurl)
285
290
  * [issuesURL](#issuesurl-1)
286
291
  * [homePageURL](#homepageurl-2)
@@ -291,83 +296,66 @@ console.log(await readme.getString());
291
296
  * [delete](#delete-3)
292
297
  * [defaultBranch](#defaultbranch)
293
298
  * [branch](#branch-2)
294
- * [Parameters](#parameters-64)
299
+ * [Parameters](#parameters-66)
295
300
  * [hasBranches](#hasbranches)
296
301
  * [branches](#branches-1)
297
- * [Parameters](#parameters-65)
302
+ * [Parameters](#parameters-67)
298
303
  * [createBranch](#createbranch-1)
299
- * [Parameters](#parameters-66)
304
+ * [Parameters](#parameters-68)
300
305
  * [addBranch](#addbranch)
301
- * [Parameters](#parameters-67)
306
+ * [Parameters](#parameters-69)
302
307
  * [deleteBranch](#deletebranch)
303
- * [Parameters](#parameters-68)
308
+ * [Parameters](#parameters-70)
304
309
  * [tag](#tag)
305
- * [Parameters](#parameters-69)
310
+ * [Parameters](#parameters-71)
306
311
  * [tags](#tags-1)
307
- * [Parameters](#parameters-70)
312
+ * [Parameters](#parameters-72)
308
313
  * [addTag](#addtag)
309
- * [Parameters](#parameters-71)
314
+ * [Parameters](#parameters-73)
310
315
  * [createPullRequest](#createpullrequest-1)
311
- * [Parameters](#parameters-72)
316
+ * [Parameters](#parameters-74)
312
317
  * [addPullRequest](#addpullrequest)
313
- * [Parameters](#parameters-73)
318
+ * [Parameters](#parameters-75)
314
319
  * [pullRequests](#pullrequests-1)
315
320
  * [pullRequest](#pullrequest-1)
316
- * [Parameters](#parameters-74)
321
+ * [Parameters](#parameters-76)
317
322
  * [deletePullRequest](#deletepullrequest)
318
- * [Parameters](#parameters-75)
323
+ * [Parameters](#parameters-77)
319
324
  * [addHook](#addhook)
320
- * [Parameters](#parameters-76)
325
+ * [Parameters](#parameters-78)
321
326
  * [createHook](#createhook)
322
- * [Parameters](#parameters-77)
327
+ * [Parameters](#parameters-79)
323
328
  * [hooks](#hooks-1)
324
329
  * [hook](#hook-1)
325
- * [Parameters](#parameters-78)
330
+ * [Parameters](#parameters-80)
326
331
  * [type](#type-2)
327
332
  * [refId](#refid-1)
328
- * [Parameters](#parameters-79)
333
+ * [Parameters](#parameters-81)
329
334
  * [attributes](#attributes-2)
330
335
  * [defaultBranchName](#defaultbranchname)
331
336
  * [Review](#review)
332
337
  * [SingleGroupProvider](#singlegroupprovider)
333
338
  * [repository](#repository-4)
334
- * [Parameters](#parameters-80)
339
+ * [Parameters](#parameters-82)
335
340
  * [repositoryGroup](#repositorygroup-2)
336
- * [Parameters](#parameters-81)
341
+ * [Parameters](#parameters-83)
337
342
  * [repositoryGroups](#repositorygroups-1)
338
- * [Parameters](#parameters-82)
343
+ * [Parameters](#parameters-84)
339
344
  * [Tag](#tag-1)
340
345
  * [refType](#reftype-1)
341
346
  * [asArray](#asarray)
342
- * [Parameters](#parameters-83)
347
+ * [Parameters](#parameters-85)
343
348
  * [stripBaseName](#stripbasename)
344
- * [Parameters](#parameters-84)
349
+ * [Parameters](#parameters-86)
345
350
  * [stripBaseNames](#stripbasenames)
346
- * [Parameters](#parameters-85)
351
+ * [Parameters](#parameters-87)
347
352
  * [generateBranchName](#generatebranchname)
348
- * [Parameters](#parameters-86)
353
+ * [Parameters](#parameters-88)
349
354
 
350
355
  ## Application
351
356
 
352
357
  **Extends OwnedObject**
353
358
 
354
- ## AttributeDefinition
355
-
356
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
357
-
358
- ### Properties
359
-
360
- * `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
361
- * `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
362
- * `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
363
- * `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
364
- * `additionalAttributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra attributes that are present in cas our attribute is set
365
- * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
366
- * `default` **any?** the default value
367
- * `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
368
- * `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
369
- * `env` **([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)>)?** environment variable use to provide the value
370
-
371
359
  ## definePropertiesFromOptions
372
360
 
373
361
  * **See**: Object.definedProperties()
@@ -449,6 +437,23 @@ Filters out null, undefined and empty strings
449
437
 
450
438
  Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** keys renamed after mapping
451
439
 
440
+ ## AttributeDefinition
441
+
442
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
443
+
444
+ ### Properties
445
+
446
+ * `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
447
+ * `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
448
+ * `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
449
+ * `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
450
+ * `additionalAttributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra attributes that are present in case our attribute is set
451
+ * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
452
+ * `default` **any?** the default value
453
+ * `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
454
+ * `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
455
+ * `env` **([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)>)?** environment variable use to provide the value
456
+
452
457
  ## tokens
453
458
 
454
459
  Split property path into tokens
@@ -482,6 +487,10 @@ The name may be a property path like 'a.b.c'.
482
487
 
483
488
  Returns **any** value associated with the given property name
484
489
 
490
+ ## default\_attribute
491
+
492
+ common attributes
493
+
485
494
  ## description\_attribute
486
495
 
487
496
  The description of the object content.
@@ -507,8 +516,8 @@ this defines the order
507
516
 
508
517
  ### Parameters
509
518
 
510
- * `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
511
- * `additionalProperties` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
519
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
520
+ * `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
512
521
 
513
522
  ### updateAttributes
514
523
 
@@ -516,7 +525,7 @@ Takes values from options.
516
525
 
517
526
  #### Parameters
518
527
 
519
- * `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
528
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
520
529
  * `additionalProperties` &#x20;
521
530
 
522
531
  ### update
@@ -878,21 +887,11 @@ To forward info/warn and error messages to
878
887
 
879
888
  **Extends Ref**
880
889
 
881
- * **See**: [Repository#\_addBranch](Repository#_addBranch)
882
-
883
- Abstract branch.
884
-
885
890
  ### Parameters
886
891
 
887
- * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
888
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `owner.defaultBranchName`)
889
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
890
-
891
- ### Properties
892
-
893
- * `repository` **[Repository](#repository)**&#x20;
894
- * `provider` **Provider**&#x20;
895
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
892
+ * `owner` &#x20;
893
+ * `name` (optional, default `owner.defaultBranchName`)
894
+ * `options` &#x20;
896
895
 
897
896
  ### url
898
897
 
@@ -982,6 +981,60 @@ Simply calls Repository.createBranch() with the receiver as source branch
982
981
 
983
982
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Branch](#branch)>** newly created branch (or already present old one with the same name)
984
983
 
984
+ ## ContentEntry
985
+
986
+ * **See**: [Repository#\_addBranch](Repository#_addBranch)
987
+
988
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
989
+
990
+ ### Parameters
991
+
992
+ * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
993
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
994
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
995
+
996
+ ### Properties
997
+
998
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** /\*\*
999
+ Abstract branch.
1000
+ * `repository` **[Repository](#repository)**&#x20;
1001
+ * `provider` **Provider**&#x20;
1002
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1003
+
1004
+ ## ContentEntry
1005
+
1006
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
1007
+
1008
+ ### Properties
1009
+
1010
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1011
+
1012
+ ## ContentEntry
1013
+
1014
+ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
1015
+
1016
+ ### Parameters
1017
+
1018
+ * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
1019
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (#branch) will be removed
1020
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1021
+
1022
+ * `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable description
1023
+ * `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** internal id
1024
+
1025
+ ### Properties
1026
+
1027
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** /\*\*
1028
+ Abstract repository
1029
+ * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
1030
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** without (#branch)
1031
+ * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.description
1032
+ * `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.id
1033
+ * `branches` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Branch](#branch)>**&#x20;
1034
+ * `tags` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Tag](#tag)>**&#x20;
1035
+ * `pullRequests` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [PullRequest](#pullrequest)>**&#x20;
1036
+ * `milestones` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Milestone](#milestone)>**&#x20;
1037
+
985
1038
  ## CommitResult
986
1039
 
987
1040
  Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -1408,14 +1461,6 @@ Draft state of the pull request.
1408
1461
 
1409
1462
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
1410
1463
 
1411
- ## ContentEntry
1412
-
1413
- Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
1414
-
1415
- ### Properties
1416
-
1417
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
1418
-
1419
1464
  ## Ref
1420
1465
 
1421
1466
  **Extends OwnedObject**
@@ -1588,27 +1633,11 @@ Mixin to define a class able to handle a collection of repositories.
1588
1633
 
1589
1634
  **Extends OwnedObject**
1590
1635
 
1591
- Abstract repository
1592
-
1593
1636
  ### Parameters
1594
1637
 
1595
- * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
1596
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (#branch) will be removed
1597
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
1598
-
1599
- * `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable description
1600
- * `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** internal id
1601
-
1602
- ### Properties
1603
-
1604
- * `owner` **[RepositoryOwner](#repositoryowner)**&#x20;
1605
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** without (#branch)
1606
- * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.description
1607
- * `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** from options.id
1608
- * `branches` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Branch](#branch)>**&#x20;
1609
- * `tags` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Tag](#tag)>**&#x20;
1610
- * `pullRequests` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [PullRequest](#pullrequest)>**&#x20;
1611
- * `milestones` **[Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), [Milestone](#milestone)>**&#x20;
1638
+ * `owner` &#x20;
1639
+ * `name` &#x20;
1640
+ * `options` &#x20;
1612
1641
 
1613
1642
  ### fullName
1614
1643
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "32.6.12",
3
+ "version": "32.7.1",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -34,12 +34,12 @@
34
34
  },
35
35
  "devDependencies": {
36
36
  "ava": "^5.2.0",
37
- "browser-ava": "^1.3.32",
37
+ "browser-ava": "^1.3.33",
38
38
  "c8": "^7.13.0",
39
39
  "documentation": "^14.0.1",
40
40
  "repository-provider-test-support": "^2.3.1",
41
- "semantic-release": "^21.0.0",
42
- "typescript": "^5.0.3"
41
+ "semantic-release": "^21.0.1",
42
+ "typescript": "^5.0.4"
43
43
  },
44
44
  "engines": {
45
45
  "node": ">=16.20.0"
package/src/attribute.mjs CHANGED
@@ -5,7 +5,7 @@
5
5
  * @property {boolean} writable
6
6
  * @property {boolean} [private] should the value be shown
7
7
  * @property {string} [depends] name of an attribute we depend on
8
- * @property {string[]} additionalAttributes extra attributes that are present in cas our attribute is set
8
+ * @property {string[]} additionalAttributes extra attributes that are present in case our attribute is set
9
9
  * @property {string} description
10
10
  * @property {any} [default] the default value
11
11
  * @property {Function} [set] set the value
@@ -1,5 +1,5 @@
1
1
  /**
2
- * @type AttributeDefinition
2
+ * common attributes
3
3
  */
4
4
  export const default_attribute = {
5
5
  type: "string",
@@ -1,6 +1,9 @@
1
- import { definePropertiesFromOptions, mapAttributes } from "./attribute-extras.mjs";
1
+ import {
2
+ definePropertiesFromOptions,
3
+ mapAttributes
4
+ } from "./attribute-extras.mjs";
2
5
  import { description_attribute, id_attribute } from "./attributes.mjs";
3
-
6
+
4
7
  /**
5
8
  * @param {Object} options
6
9
  * @param {Object} additionalProperties
@@ -55,8 +58,8 @@ export class BaseObject {
55
58
 
56
59
  /**
57
60
  * Creates an instance of BaseObject.
58
- * @param {object} options
59
- * @param {object} additionalProperties
61
+ * @param {Object} options
62
+ * @param {Object} additionalProperties
60
63
  */
61
64
  constructor(options, additionalProperties) {
62
65
  this.updateAttributes(options, additionalProperties);
@@ -64,7 +67,7 @@ export class BaseObject {
64
67
 
65
68
  /**
66
69
  * Takes values from options.
67
- * @param {object} options
70
+ * @param {Object} options
68
71
  */
69
72
  updateAttributes(options, additionalProperties) {
70
73
  definePropertiesFromOptions(
@@ -83,7 +86,7 @@ export class BaseObject {
83
86
  * @return {string} fullName
84
87
  */
85
88
  toString() {
86
- return this.fullName;
89
+ return this.identifier;
87
90
  }
88
91
 
89
92
  /**
@@ -102,6 +105,10 @@ export class BaseObject {
102
105
  return this.name;
103
106
  }
104
107
 
108
+ get identifier() {
109
+ return this.fullName;
110
+ }
111
+
105
112
  /**
106
113
  * Complete name in the hierachy.
107
114
  * @return {string}
package/src/branch.mjs CHANGED
@@ -3,6 +3,15 @@ import { PullRequest } from "./pull-request.mjs";
3
3
  import { Repository } from "./repository.mjs";
4
4
  import { Commit } from "./commit.mjs";
5
5
 
6
+ /**
7
+ * @typedef {import('./repository-owner.mjs').RepositoryOwner} RepositoryOwner
8
+ */
9
+
10
+ /**
11
+ * @typedef {Object} ContentEntry
12
+ * @property {string} name
13
+ *
14
+
6
15
  /**
7
16
  * Abstract branch.
8
17
  * @see {@link Repository#_addBranch}
@@ -1,6 +1,10 @@
1
1
  import { optionJSON } from "./attribute-extras.mjs";
2
2
  import { BaseObject } from "./base-object.mjs";
3
- import { name_attribute, url_attribute, description_attribute, id_attribute } from "./attributes.mjs";
3
+ import {
4
+ name_attribute,
5
+ description_attribute,
6
+ id_attribute
7
+ } from "./attributes.mjs";
4
8
 
5
9
  /**
6
10
  * Object with a name.
@@ -11,7 +15,6 @@ import { name_attribute, url_attribute, description_attribute, id_attribute } fr
11
15
  * @property {string} name
12
16
  */
13
17
  export class NamedObject extends BaseObject {
14
-
15
18
  static get attributes() {
16
19
  return {
17
20
  id: id_attribute,
@@ -39,7 +42,7 @@ export class NamedObject extends BaseObject {
39
42
  this.provider.equals(other.provider)
40
43
  );
41
44
  }
42
-
45
+
43
46
  /**
44
47
  * Provided name and all defined attributes.
45
48
  */
package/src/ref.mjs CHANGED
@@ -122,12 +122,10 @@ export class Ref extends OwnedObject {
122
122
  : `${this.owner.fullName}#${this.name}`;
123
123
  }
124
124
 
125
- /**
126
- * Same as identifier.
127
- * @return {string}
128
- */
129
- toString() {
130
- return this.identifier;
125
+ get identifier() {
126
+ return this.isDefault
127
+ ? this.owner.identifier
128
+ : `${this.owner.identifier}#${this.name}`;
131
129
  }
132
130
 
133
131
  /**
@@ -11,6 +11,15 @@ import {
11
11
  default_attribute
12
12
  } from "./attributes.mjs";
13
13
 
14
+ /**
15
+ * @typedef {import('./repository-owner.mjs').RepositoryOwner} RepositoryOwner
16
+ */
17
+
18
+ /**
19
+ * @typedef {Object} ContentEntry
20
+ * @property {string} name
21
+ *
22
+
14
23
  /**
15
24
  * Abstract repository
16
25
  * @param {RepositoryOwner} owner