repository-provider 26.5.0 → 26.7.0

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 (5) hide show
  1. package/README.md +86 -88
  2. package/package.json +3 -3
  3. package/src/attribute.mjs +1 -0
  4. package/src/base-provider.mjs +6 -2
  5. package/src/repository-group.mjs +8 -0
package/README.md CHANGED
@@ -92,39 +92,38 @@ 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)
129
128
  * [provider](#provider-1)
130
129
  * [url](#url)
@@ -138,81 +137,81 @@ console.log(await readme.getString());
138
137
  * [pullRequestClass](#pullrequestclass-1)
139
138
  * [instanceIdentifier](#instanceidentifier)
140
139
  * [optionsFromEnvironment](#optionsfromenvironment)
141
- * [Parameters](#parameters-29)
140
+ * [Parameters](#parameters-28)
142
141
  * [areOptionsSufficcient](#areoptionssufficcient)
143
- * [Parameters](#parameters-30)
142
+ * [Parameters](#parameters-29)
144
143
  * [initialize](#initialize)
145
- * [Parameters](#parameters-31)
144
+ * [Parameters](#parameters-30)
146
145
  * [priority](#priority)
147
146
  * [name](#name-1)
148
147
  * [messageDestination](#messagedestination-1)
149
148
  * [Branch](#branch)
150
- * [Parameters](#parameters-32)
149
+ * [Parameters](#parameters-31)
151
150
  * [Properties](#properties-2)
152
151
  * [url](#url-1)
153
152
  * [refType](#reftype)
154
153
  * [isDefault](#isdefault)
155
154
  * [delete](#delete)
156
155
  * [commit](#commit)
157
- * [Parameters](#parameters-33)
156
+ * [Parameters](#parameters-32)
158
157
  * [commitIntoPullRequest](#commitintopullrequest)
159
- * [Parameters](#parameters-34)
158
+ * [Parameters](#parameters-33)
160
159
  * [removeEntries](#removeentries)
161
- * [Parameters](#parameters-35)
160
+ * [Parameters](#parameters-34)
162
161
  * [createPullRequest](#createpullrequest)
163
- * [Parameters](#parameters-36)
162
+ * [Parameters](#parameters-35)
164
163
  * [createBranch](#createbranch)
165
- * [Parameters](#parameters-37)
164
+ * [Parameters](#parameters-36)
166
165
  * [CommitResult](#commitresult)
167
166
  * [Properties](#properties-3)
168
167
  * [Commit](#commit-1)
169
- * [Parameters](#parameters-38)
168
+ * [Parameters](#parameters-37)
170
169
  * [Properties](#properties-4)
171
170
  * [Hook](#hook)
172
- * [Parameters](#parameters-39)
171
+ * [Parameters](#parameters-38)
173
172
  * [Properties](#properties-5)
174
173
  * [equals](#equals-2)
175
- * [Parameters](#parameters-40)
174
+ * [Parameters](#parameters-39)
176
175
  * [toJSON](#tojson-1)
177
176
  * [Issue](#issue)
178
- * [Parameters](#parameters-41)
177
+ * [Parameters](#parameters-40)
179
178
  * [Milestone](#milestone)
180
- * [Parameters](#parameters-42)
179
+ * [Parameters](#parameters-41)
181
180
  * [MultiGroupProvider](#multigroupprovider)
182
- * [Parameters](#parameters-43)
181
+ * [Parameters](#parameters-42)
183
182
  * [repository](#repository)
184
- * [Parameters](#parameters-44)
183
+ * [Parameters](#parameters-43)
185
184
  * [branch](#branch-1)
186
- * [Parameters](#parameters-45)
185
+ * [Parameters](#parameters-44)
187
186
  * [repositoryGroup](#repositorygroup)
188
- * [Parameters](#parameters-46)
187
+ * [Parameters](#parameters-45)
189
188
  * [repositoryGroups](#repositorygroups)
190
- * [Parameters](#parameters-47)
189
+ * [Parameters](#parameters-46)
191
190
  * [createRepositoryGroup](#createrepositorygroup)
192
- * [Parameters](#parameters-48)
191
+ * [Parameters](#parameters-47)
193
192
  * [addRepositoryGroup](#addrepositorygroup)
194
- * [Parameters](#parameters-49)
193
+ * [Parameters](#parameters-48)
195
194
  * [NamedObject](#namedobject)
196
- * [Parameters](#parameters-50)
195
+ * [Parameters](#parameters-49)
197
196
  * [Properties](#properties-6)
198
197
  * [equals](#equals-3)
199
- * [Parameters](#parameters-51)
198
+ * [Parameters](#parameters-50)
200
199
  * [displayName](#displayname)
201
200
  * [toJSON](#tojson-2)
202
201
  * [Project](#project)
203
- * [Parameters](#parameters-52)
202
+ * [Parameters](#parameters-51)
204
203
  * [PullRequest](#pullrequest)
205
- * [Parameters](#parameters-53)
204
+ * [Parameters](#parameters-52)
206
205
  * [Properties](#properties-7)
207
206
  * [fullName](#fullname)
208
207
  * [url](#url-2)
209
208
  * [repository](#repository-1)
210
209
  * [provider](#provider-2)
211
210
  * [equals](#equals-4)
212
- * [Parameters](#parameters-54)
211
+ * [Parameters](#parameters-53)
213
212
  * [delete](#delete-1)
214
213
  * [merge](#merge)
215
- * [Parameters](#parameters-55)
214
+ * [Parameters](#parameters-54)
216
215
  * [decline](#decline)
217
216
  * [reviews](#reviews)
218
217
  * [identifier](#identifier)
@@ -220,9 +219,9 @@ console.log(await readme.getString());
220
219
  * [defaultListStates](#defaultliststates)
221
220
  * [validMergeMethods](#validmergemethods)
222
221
  * [list](#list-1)
223
- * [Parameters](#parameters-56)
222
+ * [Parameters](#parameters-55)
224
223
  * [open](#open)
225
- * [Parameters](#parameters-57)
224
+ * [Parameters](#parameters-56)
226
225
  * [title](#title)
227
226
  * [body](#body)
228
227
  * [state](#state)
@@ -232,19 +231,19 @@ console.log(await readme.getString());
232
231
  * [ContentEntry](#contententry)
233
232
  * [Properties](#properties-8)
234
233
  * [Ref](#ref)
235
- * [Parameters](#parameters-58)
234
+ * [Parameters](#parameters-57)
236
235
  * [equals](#equals-5)
237
- * [Parameters](#parameters-59)
236
+ * [Parameters](#parameters-58)
238
237
  * [ref](#ref-1)
239
238
  * [refId](#refid)
240
- * [Parameters](#parameters-60)
239
+ * [Parameters](#parameters-59)
241
240
  * [entries](#entries)
242
- * [Parameters](#parameters-61)
241
+ * [Parameters](#parameters-60)
243
242
  * [asyncIterator](#asynciterator)
244
243
  * [maybeEntry](#maybeentry)
245
- * [Parameters](#parameters-62)
244
+ * [Parameters](#parameters-61)
246
245
  * [entry](#entry)
247
- * [Parameters](#parameters-63)
246
+ * [Parameters](#parameters-62)
248
247
  * [owner](#owner)
249
248
  * [fullName](#fullname-1)
250
249
  * [fullCondensedName](#fullcondensedname)
@@ -259,28 +258,28 @@ console.log(await readme.getString());
259
258
  * [attributes](#attributes-1)
260
259
  * [isProtected](#isprotected-1)
261
260
  * [RepositoryGroup](#repositorygroup-1)
262
- * [Parameters](#parameters-64)
261
+ * [Parameters](#parameters-63)
263
262
  * [Properties](#properties-9)
264
263
  * [attributeMapping](#attributemapping-1)
265
264
  * [type](#type)
266
265
  * [url](#url-3)
267
266
  * [RepositoryOwner](#repositoryowner)
268
- * [Parameters](#parameters-65)
267
+ * [Parameters](#parameters-64)
269
268
  * [Repository](#repository-2)
270
- * [Parameters](#parameters-66)
269
+ * [Parameters](#parameters-65)
271
270
  * [Properties](#properties-10)
272
271
  * [fullName](#fullname-2)
273
272
  * [slug](#slug)
274
273
  * [provider](#provider-3)
275
274
  * [identifier](#identifier-2)
276
275
  * [equals](#equals-6)
277
- * [Parameters](#parameters-67)
276
+ * [Parameters](#parameters-66)
278
277
  * [entry](#entry-1)
279
- * [Parameters](#parameters-68)
278
+ * [Parameters](#parameters-67)
280
279
  * [entries](#entries-1)
281
- * [Parameters](#parameters-69)
280
+ * [Parameters](#parameters-68)
282
281
  * [maybeEntry](#maybeentry-1)
283
- * [Parameters](#parameters-70)
282
+ * [Parameters](#parameters-69)
284
283
  * [urls](#urls)
285
284
  * [url](#url-4)
286
285
  * [cloneURL](#cloneurl)
@@ -293,41 +292,41 @@ console.log(await readme.getString());
293
292
  * [isTemplate](#istemplate)
294
293
  * [defaultBranch](#defaultbranch)
295
294
  * [branch](#branch-2)
296
- * [Parameters](#parameters-71)
295
+ * [Parameters](#parameters-70)
297
296
  * [branches](#branches-1)
298
- * [Parameters](#parameters-72)
297
+ * [Parameters](#parameters-71)
299
298
  * [createBranch](#createbranch-1)
300
- * [Parameters](#parameters-73)
299
+ * [Parameters](#parameters-72)
301
300
  * [addBranch](#addbranch)
302
- * [Parameters](#parameters-74)
301
+ * [Parameters](#parameters-73)
303
302
  * [deleteBranch](#deletebranch)
304
- * [Parameters](#parameters-75)
303
+ * [Parameters](#parameters-74)
305
304
  * [tag](#tag)
306
- * [Parameters](#parameters-76)
305
+ * [Parameters](#parameters-75)
307
306
  * [tags](#tags-1)
308
- * [Parameters](#parameters-77)
307
+ * [Parameters](#parameters-76)
309
308
  * [addTag](#addtag)
310
- * [Parameters](#parameters-78)
309
+ * [Parameters](#parameters-77)
311
310
  * [delete](#delete-2)
312
311
  * [createPullRequest](#createpullrequest-1)
313
- * [Parameters](#parameters-79)
312
+ * [Parameters](#parameters-78)
314
313
  * [addPullRequest](#addpullrequest)
315
- * [Parameters](#parameters-80)
314
+ * [Parameters](#parameters-79)
316
315
  * [pullRequests](#pullrequests-1)
317
316
  * [pullRequest](#pullrequest-1)
318
- * [Parameters](#parameters-81)
317
+ * [Parameters](#parameters-80)
319
318
  * [deletePullRequest](#deletepullrequest)
320
- * [Parameters](#parameters-82)
319
+ * [Parameters](#parameters-81)
321
320
  * [addHook](#addhook)
322
- * [Parameters](#parameters-83)
321
+ * [Parameters](#parameters-82)
323
322
  * [createHook](#createhook)
324
- * [Parameters](#parameters-84)
323
+ * [Parameters](#parameters-83)
325
324
  * [hooks](#hooks-1)
326
325
  * [hook](#hook-1)
327
- * [Parameters](#parameters-85)
326
+ * [Parameters](#parameters-84)
328
327
  * [type](#type-1)
329
328
  * [refId](#refid-1)
330
- * [Parameters](#parameters-86)
329
+ * [Parameters](#parameters-85)
331
330
  * [toJSON](#tojson-3)
332
331
  * [attributes](#attributes-2)
333
332
  * [defaultBranchName](#defaultbranchname)
@@ -336,23 +335,23 @@ console.log(await readme.getString());
336
335
  * [Review](#review)
337
336
  * [SingleGroupProvider](#singlegroupprovider)
338
337
  * [repository](#repository-3)
339
- * [Parameters](#parameters-87)
338
+ * [Parameters](#parameters-86)
340
339
  * [repositoryGroup](#repositorygroup-2)
341
- * [Parameters](#parameters-88)
340
+ * [Parameters](#parameters-87)
342
341
  * [repositoryGroups](#repositorygroups-1)
343
- * [Parameters](#parameters-89)
342
+ * [Parameters](#parameters-88)
344
343
  * [Tag](#tag-1)
345
- * [Parameters](#parameters-90)
344
+ * [Parameters](#parameters-89)
346
345
  * [refType](#reftype-1)
347
346
  * [isWritable](#iswritable-1)
348
347
  * [asArray](#asarray)
349
- * [Parameters](#parameters-91)
348
+ * [Parameters](#parameters-90)
350
349
  * [stripBaseName](#stripbasename)
351
- * [Parameters](#parameters-92)
350
+ * [Parameters](#parameters-91)
352
351
  * [stripBaseNames](#stripbasenames)
353
- * [Parameters](#parameters-93)
352
+ * [Parameters](#parameters-92)
354
353
  * [generateBranchName](#generatebranchname)
355
- * [Parameters](#parameters-94)
354
+ * [Parameters](#parameters-93)
356
355
 
357
356
  ## Application
358
357
 
@@ -372,8 +371,10 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
372
371
 
373
372
  * `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
374
373
  * `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
375
- * `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**
374
+ * `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
376
375
  * `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
376
+ * `default` **any?** the default value
377
+ * `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
377
378
 
378
379
  ## definePropertiesFromOptions
379
380
 
@@ -483,8 +484,8 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
483
484
 
484
485
  ### Parameters
485
486
 
486
- * `options` **any**
487
- * `additionalProperties` **any**
487
+ * `options` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
488
+ * `additionalProperties` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
488
489
 
489
490
  ### update
490
491
 
@@ -622,10 +623,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
622
623
 
623
624
  ## BaseProvider
624
625
 
625
- ### Parameters
626
-
627
- * `options`
628
- * `properties`
626
+ **Extends BaseObject**
629
627
 
630
628
  ### Properties
631
629
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "26.5.0",
3
+ "version": "26.7.0",
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.11.1",
39
+ "repository-provider-test-support": "^1.12.1",
40
40
  "semantic-release": "^19.0.2",
41
- "typescript": "^4.6.0-dev.20220203"
41
+ "typescript": "^4.6.0-dev.20220207"
42
42
  },
43
43
  "engines": {
44
44
  "node": ">=14.18.3"
package/src/attribute.mjs CHANGED
@@ -6,6 +6,7 @@
6
6
  * @property {boolean} [private] should the value be shown
7
7
  * @property {string} description
8
8
  * @property {any} [default] the default value
9
+ * @property {string|string[]} [env] environment variable use to provide the value
9
10
  */
10
11
 
11
12
  /**
package/src/base-provider.mjs CHANGED
@@ -1,5 +1,4 @@
1
1
  import { asArray, stripBaseName } from "./util.mjs";
2
- import { definePropertiesFromOptions } from "./attribute.mjs";
3
2
  import { PullRequest } from "./pull-request.mjs";
4
3
  import { RepositoryGroup } from "./repository-group.mjs";
5
4
  import { Repository } from "./repository.mjs";
@@ -102,10 +101,12 @@ export class BaseProvider extends BaseObject {
102
101
  * Name of the provider
103
102
  */
104
103
  name: {
105
- type: "string"
104
+ type: "string",
105
+ env: ["{{instanceIdentifier}}NAME"]
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;