repository-provider 26.6.0 → 26.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.
Files changed (4) hide show
  1. package/README.md +97 -90
  2. package/package.json +3 -3
  3. package/src/base-provider.mjs +4 -0
  4. package/src/repository-group.mjs +8 -0
package/README.md CHANGED
@@ -92,40 +92,40 @@ console.log(await readme.getString());
92
92
  * [MessageDestination](#messagedestination)
93
93
  * [Parameters](#parameters-13)
94
94
  * [BaseProvider](#baseprovider)
95
- * [Parameters](#parameters-14)
96
95
  * [Properties](#properties-1)
97
96
  * [equals](#equals-1)
98
- * [Parameters](#parameters-15)
97
+ * [Parameters](#parameters-14)
99
98
  * [repositoryBases](#repositorybases)
100
99
  * [normalizeRepositoryName](#normalizerepositoryname)
101
- * [Parameters](#parameters-16)
100
+ * [Parameters](#parameters-15)
102
101
  * [normalizeGroupName](#normalizegroupname)
103
- * [Parameters](#parameters-17)
102
+ * [Parameters](#parameters-16)
104
103
  * [areRepositoryNamesCaseSensitive](#arerepositorynamescasesensitive)
105
104
  * [areGroupNamesCaseSensitive](#aregroupnamescasesensitive)
106
105
  * [supportsBase](#supportsbase)
107
- * [Parameters](#parameters-18)
106
+ * [Parameters](#parameters-17)
108
107
  * [parseName](#parsename)
109
- * [Parameters](#parameters-19)
108
+ * [Parameters](#parameters-18)
110
109
  * [createRepository](#createrepository)
111
- * [Parameters](#parameters-20)
110
+ * [Parameters](#parameters-19)
112
111
  * [list](#list)
113
- * [Parameters](#parameters-21)
112
+ * [Parameters](#parameters-20)
114
113
  * [projects](#projects)
115
- * [Parameters](#parameters-22)
114
+ * [Parameters](#parameters-21)
116
115
  * [milestones](#milestones)
117
- * [Parameters](#parameters-23)
116
+ * [Parameters](#parameters-22)
118
117
  * [repositories](#repositories)
119
- * [Parameters](#parameters-24)
118
+ * [Parameters](#parameters-23)
120
119
  * [branches](#branches)
121
- * [Parameters](#parameters-25)
120
+ * [Parameters](#parameters-24)
122
121
  * [tags](#tags)
123
- * [Parameters](#parameters-26)
122
+ * [Parameters](#parameters-25)
124
123
  * [hooks](#hooks)
125
- * [Parameters](#parameters-27)
124
+ * [Parameters](#parameters-26)
126
125
  * [pullRequests](#pullrequests)
127
- * [Parameters](#parameters-28)
126
+ * [Parameters](#parameters-27)
128
127
  * [name](#name)
128
+ * [fullName](#fullname)
129
129
  * [provider](#provider-1)
130
130
  * [url](#url)
131
131
  * [toJSON](#tojson)
@@ -138,81 +138,81 @@ console.log(await readme.getString());
138
138
  * [pullRequestClass](#pullrequestclass-1)
139
139
  * [instanceIdentifier](#instanceidentifier)
140
140
  * [optionsFromEnvironment](#optionsfromenvironment)
141
- * [Parameters](#parameters-29)
141
+ * [Parameters](#parameters-28)
142
142
  * [areOptionsSufficcient](#areoptionssufficcient)
143
- * [Parameters](#parameters-30)
143
+ * [Parameters](#parameters-29)
144
144
  * [initialize](#initialize)
145
- * [Parameters](#parameters-31)
145
+ * [Parameters](#parameters-30)
146
146
  * [priority](#priority)
147
147
  * [name](#name-1)
148
148
  * [messageDestination](#messagedestination-1)
149
149
  * [Branch](#branch)
150
- * [Parameters](#parameters-32)
150
+ * [Parameters](#parameters-31)
151
151
  * [Properties](#properties-2)
152
152
  * [url](#url-1)
153
153
  * [refType](#reftype)
154
154
  * [isDefault](#isdefault)
155
155
  * [delete](#delete)
156
156
  * [commit](#commit)
157
- * [Parameters](#parameters-33)
157
+ * [Parameters](#parameters-32)
158
158
  * [commitIntoPullRequest](#commitintopullrequest)
159
- * [Parameters](#parameters-34)
159
+ * [Parameters](#parameters-33)
160
160
  * [removeEntries](#removeentries)
161
- * [Parameters](#parameters-35)
161
+ * [Parameters](#parameters-34)
162
162
  * [createPullRequest](#createpullrequest)
163
- * [Parameters](#parameters-36)
163
+ * [Parameters](#parameters-35)
164
164
  * [createBranch](#createbranch)
165
- * [Parameters](#parameters-37)
165
+ * [Parameters](#parameters-36)
166
166
  * [CommitResult](#commitresult)
167
167
  * [Properties](#properties-3)
168
168
  * [Commit](#commit-1)
169
- * [Parameters](#parameters-38)
169
+ * [Parameters](#parameters-37)
170
170
  * [Properties](#properties-4)
171
171
  * [Hook](#hook)
172
- * [Parameters](#parameters-39)
172
+ * [Parameters](#parameters-38)
173
173
  * [Properties](#properties-5)
174
174
  * [equals](#equals-2)
175
- * [Parameters](#parameters-40)
175
+ * [Parameters](#parameters-39)
176
176
  * [toJSON](#tojson-1)
177
177
  * [Issue](#issue)
178
- * [Parameters](#parameters-41)
178
+ * [Parameters](#parameters-40)
179
179
  * [Milestone](#milestone)
180
- * [Parameters](#parameters-42)
180
+ * [Parameters](#parameters-41)
181
181
  * [MultiGroupProvider](#multigroupprovider)
182
- * [Parameters](#parameters-43)
182
+ * [Parameters](#parameters-42)
183
183
  * [repository](#repository)
184
- * [Parameters](#parameters-44)
184
+ * [Parameters](#parameters-43)
185
185
  * [branch](#branch-1)
186
- * [Parameters](#parameters-45)
186
+ * [Parameters](#parameters-44)
187
187
  * [repositoryGroup](#repositorygroup)
188
- * [Parameters](#parameters-46)
188
+ * [Parameters](#parameters-45)
189
189
  * [repositoryGroups](#repositorygroups)
190
- * [Parameters](#parameters-47)
190
+ * [Parameters](#parameters-46)
191
191
  * [createRepositoryGroup](#createrepositorygroup)
192
- * [Parameters](#parameters-48)
192
+ * [Parameters](#parameters-47)
193
193
  * [addRepositoryGroup](#addrepositorygroup)
194
- * [Parameters](#parameters-49)
194
+ * [Parameters](#parameters-48)
195
195
  * [NamedObject](#namedobject)
196
- * [Parameters](#parameters-50)
196
+ * [Parameters](#parameters-49)
197
197
  * [Properties](#properties-6)
198
198
  * [equals](#equals-3)
199
- * [Parameters](#parameters-51)
199
+ * [Parameters](#parameters-50)
200
200
  * [displayName](#displayname)
201
201
  * [toJSON](#tojson-2)
202
202
  * [Project](#project)
203
- * [Parameters](#parameters-52)
203
+ * [Parameters](#parameters-51)
204
204
  * [PullRequest](#pullrequest)
205
- * [Parameters](#parameters-53)
205
+ * [Parameters](#parameters-52)
206
206
  * [Properties](#properties-7)
207
- * [fullName](#fullname)
207
+ * [fullName](#fullname-1)
208
208
  * [url](#url-2)
209
209
  * [repository](#repository-1)
210
210
  * [provider](#provider-2)
211
211
  * [equals](#equals-4)
212
- * [Parameters](#parameters-54)
212
+ * [Parameters](#parameters-53)
213
213
  * [delete](#delete-1)
214
214
  * [merge](#merge)
215
- * [Parameters](#parameters-55)
215
+ * [Parameters](#parameters-54)
216
216
  * [decline](#decline)
217
217
  * [reviews](#reviews)
218
218
  * [identifier](#identifier)
@@ -220,9 +220,9 @@ console.log(await readme.getString());
220
220
  * [defaultListStates](#defaultliststates)
221
221
  * [validMergeMethods](#validmergemethods)
222
222
  * [list](#list-1)
223
- * [Parameters](#parameters-56)
223
+ * [Parameters](#parameters-55)
224
224
  * [open](#open)
225
- * [Parameters](#parameters-57)
225
+ * [Parameters](#parameters-56)
226
226
  * [title](#title)
227
227
  * [body](#body)
228
228
  * [state](#state)
@@ -232,21 +232,21 @@ console.log(await readme.getString());
232
232
  * [ContentEntry](#contententry)
233
233
  * [Properties](#properties-8)
234
234
  * [Ref](#ref)
235
- * [Parameters](#parameters-58)
235
+ * [Parameters](#parameters-57)
236
236
  * [equals](#equals-5)
237
- * [Parameters](#parameters-59)
237
+ * [Parameters](#parameters-58)
238
238
  * [ref](#ref-1)
239
239
  * [refId](#refid)
240
- * [Parameters](#parameters-60)
240
+ * [Parameters](#parameters-59)
241
241
  * [entries](#entries)
242
- * [Parameters](#parameters-61)
242
+ * [Parameters](#parameters-60)
243
243
  * [asyncIterator](#asynciterator)
244
244
  * [maybeEntry](#maybeentry)
245
- * [Parameters](#parameters-62)
245
+ * [Parameters](#parameters-61)
246
246
  * [entry](#entry)
247
- * [Parameters](#parameters-63)
247
+ * [Parameters](#parameters-62)
248
248
  * [owner](#owner)
249
- * [fullName](#fullname-1)
249
+ * [fullName](#fullname-2)
250
250
  * [fullCondensedName](#fullcondensedname)
251
251
  * [identifier](#identifier-1)
252
252
  * [issuesURL](#issuesurl)
@@ -259,28 +259,29 @@ console.log(await readme.getString());
259
259
  * [attributes](#attributes-1)
260
260
  * [isProtected](#isprotected-1)
261
261
  * [RepositoryGroup](#repositorygroup-1)
262
- * [Parameters](#parameters-64)
262
+ * [Parameters](#parameters-63)
263
263
  * [Properties](#properties-9)
264
+ * [fullName](#fullname-3)
264
265
  * [attributeMapping](#attributemapping-1)
265
266
  * [type](#type)
266
267
  * [url](#url-3)
267
268
  * [RepositoryOwner](#repositoryowner)
268
- * [Parameters](#parameters-65)
269
+ * [Parameters](#parameters-64)
269
270
  * [Repository](#repository-2)
270
- * [Parameters](#parameters-66)
271
+ * [Parameters](#parameters-65)
271
272
  * [Properties](#properties-10)
272
- * [fullName](#fullname-2)
273
+ * [fullName](#fullname-4)
273
274
  * [slug](#slug)
274
275
  * [provider](#provider-3)
275
276
  * [identifier](#identifier-2)
276
277
  * [equals](#equals-6)
277
- * [Parameters](#parameters-67)
278
+ * [Parameters](#parameters-66)
278
279
  * [entry](#entry-1)
279
- * [Parameters](#parameters-68)
280
+ * [Parameters](#parameters-67)
280
281
  * [entries](#entries-1)
281
- * [Parameters](#parameters-69)
282
+ * [Parameters](#parameters-68)
282
283
  * [maybeEntry](#maybeentry-1)
283
- * [Parameters](#parameters-70)
284
+ * [Parameters](#parameters-69)
284
285
  * [urls](#urls)
285
286
  * [url](#url-4)
286
287
  * [cloneURL](#cloneurl)
@@ -293,41 +294,41 @@ console.log(await readme.getString());
293
294
  * [isTemplate](#istemplate)
294
295
  * [defaultBranch](#defaultbranch)
295
296
  * [branch](#branch-2)
296
- * [Parameters](#parameters-71)
297
+ * [Parameters](#parameters-70)
297
298
  * [branches](#branches-1)
298
- * [Parameters](#parameters-72)
299
+ * [Parameters](#parameters-71)
299
300
  * [createBranch](#createbranch-1)
300
- * [Parameters](#parameters-73)
301
+ * [Parameters](#parameters-72)
301
302
  * [addBranch](#addbranch)
302
- * [Parameters](#parameters-74)
303
+ * [Parameters](#parameters-73)
303
304
  * [deleteBranch](#deletebranch)
304
- * [Parameters](#parameters-75)
305
+ * [Parameters](#parameters-74)
305
306
  * [tag](#tag)
306
- * [Parameters](#parameters-76)
307
+ * [Parameters](#parameters-75)
307
308
  * [tags](#tags-1)
308
- * [Parameters](#parameters-77)
309
+ * [Parameters](#parameters-76)
309
310
  * [addTag](#addtag)
310
- * [Parameters](#parameters-78)
311
+ * [Parameters](#parameters-77)
311
312
  * [delete](#delete-2)
312
313
  * [createPullRequest](#createpullrequest-1)
313
- * [Parameters](#parameters-79)
314
+ * [Parameters](#parameters-78)
314
315
  * [addPullRequest](#addpullrequest)
315
- * [Parameters](#parameters-80)
316
+ * [Parameters](#parameters-79)
316
317
  * [pullRequests](#pullrequests-1)
317
318
  * [pullRequest](#pullrequest-1)
318
- * [Parameters](#parameters-81)
319
+ * [Parameters](#parameters-80)
319
320
  * [deletePullRequest](#deletepullrequest)
320
- * [Parameters](#parameters-82)
321
+ * [Parameters](#parameters-81)
321
322
  * [addHook](#addhook)
322
- * [Parameters](#parameters-83)
323
+ * [Parameters](#parameters-82)
323
324
  * [createHook](#createhook)
324
- * [Parameters](#parameters-84)
325
+ * [Parameters](#parameters-83)
325
326
  * [hooks](#hooks-1)
326
327
  * [hook](#hook-1)
327
- * [Parameters](#parameters-85)
328
+ * [Parameters](#parameters-84)
328
329
  * [type](#type-1)
329
330
  * [refId](#refid-1)
330
- * [Parameters](#parameters-86)
331
+ * [Parameters](#parameters-85)
331
332
  * [toJSON](#tojson-3)
332
333
  * [attributes](#attributes-2)
333
334
  * [defaultBranchName](#defaultbranchname)
@@ -336,23 +337,23 @@ console.log(await readme.getString());
336
337
  * [Review](#review)
337
338
  * [SingleGroupProvider](#singlegroupprovider)
338
339
  * [repository](#repository-3)
339
- * [Parameters](#parameters-87)
340
+ * [Parameters](#parameters-86)
340
341
  * [repositoryGroup](#repositorygroup-2)
341
- * [Parameters](#parameters-88)
342
+ * [Parameters](#parameters-87)
342
343
  * [repositoryGroups](#repositorygroups-1)
343
- * [Parameters](#parameters-89)
344
+ * [Parameters](#parameters-88)
344
345
  * [Tag](#tag-1)
345
- * [Parameters](#parameters-90)
346
+ * [Parameters](#parameters-89)
346
347
  * [refType](#reftype-1)
347
348
  * [isWritable](#iswritable-1)
348
349
  * [asArray](#asarray)
349
- * [Parameters](#parameters-91)
350
+ * [Parameters](#parameters-90)
350
351
  * [stripBaseName](#stripbasename)
351
- * [Parameters](#parameters-92)
352
+ * [Parameters](#parameters-91)
352
353
  * [stripBaseNames](#stripbasenames)
353
- * [Parameters](#parameters-93)
354
+ * [Parameters](#parameters-92)
354
355
  * [generateBranchName](#generatebranchname)
355
- * [Parameters](#parameters-94)
356
+ * [Parameters](#parameters-93)
356
357
 
357
358
  ## Application
358
359
 
@@ -375,6 +376,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
375
376
  * `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
376
377
  * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
377
378
  * `default` **any?** the default value
379
+ * `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
378
380
 
379
381
  ## definePropertiesFromOptions
380
382
 
@@ -484,8 +486,8 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
484
486
 
485
487
  ### Parameters
486
488
 
487
- * `options` **any**
488
- * `additionalProperties` **any**
489
+ * `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
490
+ * `additionalProperties` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
489
491
 
490
492
  ### update
491
493
 
@@ -623,10 +625,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
623
625
 
624
626
  ## BaseProvider
625
627
 
626
- ### Parameters
627
-
628
- * `options`
629
- * `properties`
628
+ **Extends BaseObject**
630
629
 
631
630
  ### Properties
632
631
 
@@ -809,6 +808,10 @@ Deliver the provider name.
809
808
 
810
809
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** class name by default
811
810
 
811
+ ### fullName
812
+
813
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name
814
+
812
815
  ### provider
813
816
 
814
817
  We are our own provider.
@@ -1552,6 +1555,10 @@ Abstract repository collection.
1552
1555
  * `provider` **[BaseProvider](#baseprovider)**
1553
1556
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1554
1557
 
1558
+ ### fullName
1559
+
1560
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name with owner name
1561
+
1555
1562
  ### attributeMapping
1556
1563
 
1557
1564
  Map attributes between external and internal representation.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "26.6.0",
3
+ "version": "26.7.1",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -36,9 +36,9 @@
36
36
  "ava": "^4.0.1",
37
37
  "c8": "^7.11.0",
38
38
  "documentation": "^13.2.5",
39
- "repository-provider-test-support": "^1.12.0",
39
+ "repository-provider-test-support": "^1.12.2",
40
40
  "semantic-release": "^19.0.2",
41
- "typescript": "^4.6.0-dev.20220204"
41
+ "typescript": "^4.6.0-dev.20220207"
42
42
  },
43
43
  "engines": {
44
44
  "node": ">=14.18.3"
package/src/base-provider.mjs CHANGED
@@ -106,6 +106,7 @@ export class BaseProvider extends BaseObject {
106
106
  },
107
107
 
108
108
  url: {
109
+ description: "home of the provider",
109
110
  type: "string"
110
111
  },
111
112
 
@@ -399,6 +400,9 @@ export class BaseProvider extends BaseObject {
399
400
  return this.constructor.name;
400
401
  }
401
402
 
403
+ /**
404
+ * @return {string} name
405
+ */
402
406
  get fullName()
403
407
  {
404
408
  return this.name;
package/src/repository-group.mjs CHANGED
@@ -49,6 +49,14 @@ export class RepositoryGroup extends RepositoryOwner(NamedObject) {
49
49
  });
50
50
  }
51
51
 
52
+ /**
53
+ * @return {string} name with owner name
54
+ */
55
+ get fullName()
56
+ {
57
+ return this.owner.name + "/" + this.name;
58
+ }
59
+
52
60
  get owner()
53
61
  {
54
62
  return this.provider;