repository-provider 35.2.9 → 35.2.11

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 (8) hide show
  1. package/README.md +107 -91
  2. package/package.json +2 -2
  3. package/src/base-object.mjs +3 -1
  4. package/src/base-provider.mjs +4 -0
  5. package/src/named-object.mjs +3 -0
  6. package/types/base-object.d.mts +3 -1
  7. package/types/base-provider.d.mts +4 -0
  8. package/types/named-object.d.mts +3 -0
package/README.md CHANGED
@@ -136,54 +136,55 @@ console.log(await readme.string);
136
136
  * [initialize](#initialize)
137
137
  * [Parameters](#parameters-24)
138
138
  * [BaseProvider](#baseprovider-1)
139
+ * [Parameters](#parameters-25)
139
140
  * [Properties](#properties-1)
140
141
  * [equals](#equals-2)
141
- * [Parameters](#parameters-25)
142
+ * [Parameters](#parameters-26)
142
143
  * [repositoryBases](#repositorybases-1)
143
144
  * [supportsBase](#supportsbase-1)
144
- * [Parameters](#parameters-26)
145
- * [normalizeRepositoryName](#normalizerepositoryname-1)
146
145
  * [Parameters](#parameters-27)
147
- * [normalizeGroupName](#normalizegroupname-1)
146
+ * [normalizeRepositoryName](#normalizerepositoryname-1)
148
147
  * [Parameters](#parameters-28)
148
+ * [normalizeGroupName](#normalizegroupname-1)
149
+ * [Parameters](#parameters-29)
149
150
  * [areRepositoryNamesCaseSensitive](#arerepositorynamescasesensitive-1)
150
151
  * [areGroupNamesCaseSensitive](#aregroupnamescasesensitive-1)
151
152
  * [parseName](#parsename-1)
152
- * [Parameters](#parameters-29)
153
- * [createRepository](#createrepository-1)
154
153
  * [Parameters](#parameters-30)
155
- * [list](#list-1)
154
+ * [createRepository](#createrepository-1)
156
155
  * [Parameters](#parameters-31)
157
- * [projects](#projects-1)
156
+ * [list](#list-1)
158
157
  * [Parameters](#parameters-32)
159
- * [milestones](#milestones-1)
158
+ * [projects](#projects-1)
160
159
  * [Parameters](#parameters-33)
161
- * [repositories](#repositories-1)
160
+ * [milestones](#milestones-1)
162
161
  * [Parameters](#parameters-34)
163
- * [branches](#branches-1)
162
+ * [repositories](#repositories-1)
164
163
  * [Parameters](#parameters-35)
165
- * [tags](#tags-1)
164
+ * [branches](#branches-1)
166
165
  * [Parameters](#parameters-36)
167
- * [hooks](#hooks-1)
166
+ * [tags](#tags-1)
168
167
  * [Parameters](#parameters-37)
169
- * [pullRequests](#pullrequests-1)
168
+ * [hooks](#hooks-1)
170
169
  * [Parameters](#parameters-38)
170
+ * [pullRequests](#pullrequests-1)
171
+ * [Parameters](#parameters-39)
171
172
  * [name](#name-1)
172
173
  * [provider](#provider-1)
173
174
  * [toJSON](#tojson-1)
174
175
  * [instanceIdentifier](#instanceidentifier-1)
175
176
  * [optionsFromEnvironment](#optionsfromenvironment-1)
176
- * [Parameters](#parameters-39)
177
- * [areOptionsSufficcient](#areoptionssufficcient-1)
178
177
  * [Parameters](#parameters-40)
179
- * [initialize](#initialize-1)
178
+ * [areOptionsSufficcient](#areoptionssufficcient-1)
180
179
  * [Parameters](#parameters-41)
180
+ * [initialize](#initialize-1)
181
+ * [Parameters](#parameters-42)
181
182
  * [MessageDestination](#messagedestination)
182
183
  * [Properties](#properties-2)
183
184
  * [name](#name-2)
184
185
  * [messageDestination](#messagedestination-1)
185
186
  * [Branch](#branch)
186
- * [Parameters](#parameters-42)
187
+ * [Parameters](#parameters-43)
187
188
  * [Properties](#properties-3)
188
189
  * [url](#url)
189
190
  * [refType](#reftype)
@@ -191,51 +192,51 @@ console.log(await readme.string);
191
192
  * [isDefault](#isdefault)
192
193
  * [delete](#delete)
193
194
  * [commit](#commit)
194
- * [Parameters](#parameters-43)
195
- * [commitIntoPullRequest](#commitintopullrequest)
196
195
  * [Parameters](#parameters-44)
197
- * [removeEntries](#removeentries)
196
+ * [commitIntoPullRequest](#commitintopullrequest)
198
197
  * [Parameters](#parameters-45)
199
- * [createPullRequest](#createpullrequest)
198
+ * [removeEntries](#removeentries)
200
199
  * [Parameters](#parameters-46)
201
- * [createBranch](#createbranch)
200
+ * [createPullRequest](#createpullrequest)
202
201
  * [Parameters](#parameters-47)
202
+ * [createBranch](#createbranch)
203
+ * [Parameters](#parameters-48)
203
204
  * [CommitResult](#commitresult)
204
- * [Parameters](#parameters-48)
205
+ * [Parameters](#parameters-49)
205
206
  * [Properties](#properties-4)
206
207
  * [Commit](#commit-1)
207
- * [Parameters](#parameters-49)
208
+ * [Parameters](#parameters-50)
208
209
  * [Properties](#properties-5)
209
210
  * [Hook](#hook)
210
211
  * [Issue](#issue)
211
212
  * [Milestone](#milestone)
212
213
  * [MultiGroupProvider](#multigroupprovider)
213
214
  * [repository](#repository)
214
- * [Parameters](#parameters-50)
215
- * [branch](#branch-1)
216
215
  * [Parameters](#parameters-51)
217
- * [repositoryGroup](#repositorygroup)
216
+ * [branch](#branch-1)
218
217
  * [Parameters](#parameters-52)
219
- * [repositoryGroups](#repositorygroups)
218
+ * [repositoryGroup](#repositorygroup)
220
219
  * [Parameters](#parameters-53)
221
- * [createRepositoryGroup](#createrepositorygroup)
220
+ * [repositoryGroups](#repositorygroups)
222
221
  * [Parameters](#parameters-54)
223
- * [addRepositoryGroup](#addrepositorygroup)
222
+ * [createRepositoryGroup](#createrepositorygroup)
224
223
  * [Parameters](#parameters-55)
224
+ * [addRepositoryGroup](#addrepositorygroup)
225
+ * [Parameters](#parameters-56)
225
226
  * [NamedObject](#namedobject)
226
- * [Parameters](#parameters-56)
227
+ * [Parameters](#parameters-57)
227
228
  * [Properties](#properties-6)
228
229
  * [displayName](#displayname)
229
230
  * [condensedName](#condensedname)
230
231
  * [fullCondensedName](#fullcondensedname)
231
232
  * [equals](#equals-3)
232
- * [Parameters](#parameters-57)
233
+ * [Parameters](#parameters-58)
233
234
  * [toJSON](#tojson-2)
234
235
  * [OwnedObject](#ownedobject)
235
- * [Parameters](#parameters-58)
236
+ * [Parameters](#parameters-59)
236
237
  * [delete](#delete-1)
237
238
  * [equals](#equals-4)
238
- * [Parameters](#parameters-59)
239
+ * [Parameters](#parameters-60)
239
240
  * [homePageURL](#homepageurl)
240
241
  * [issuesURL](#issuesurl)
241
242
  * [isLocked](#islocked)
@@ -248,22 +249,22 @@ console.log(await readme.string);
248
249
  * [identifier](#identifier)
249
250
  * [fullName](#fullname-1)
250
251
  * [trace](#trace)
251
- * [Parameters](#parameters-60)
252
- * [info](#info)
253
252
  * [Parameters](#parameters-61)
254
- * [warn](#warn)
253
+ * [info](#info)
255
254
  * [Parameters](#parameters-62)
256
- * [error](#error)
255
+ * [warn](#warn)
257
256
  * [Parameters](#parameters-63)
258
- * [debug](#debug)
257
+ * [error](#error)
259
258
  * [Parameters](#parameters-64)
259
+ * [debug](#debug)
260
+ * [Parameters](#parameters-65)
260
261
  * [addMethodName](#addmethodname)
261
262
  * [deleteMethodName](#deletemethodname)
262
263
  * [OwnedObject](#ownedobject-1)
263
- * [Parameters](#parameters-65)
264
+ * [Parameters](#parameters-66)
264
265
  * [delete](#delete-2)
265
266
  * [equals](#equals-5)
266
- * [Parameters](#parameters-66)
267
+ * [Parameters](#parameters-67)
267
268
  * [homePageURL](#homepageurl-1)
268
269
  * [issuesURL](#issuesurl-1)
269
270
  * [isLocked](#islocked-1)
@@ -276,27 +277,27 @@ console.log(await readme.string);
276
277
  * [identifier](#identifier-1)
277
278
  * [fullName](#fullname-2)
278
279
  * [trace](#trace-1)
279
- * [Parameters](#parameters-67)
280
- * [info](#info-1)
281
280
  * [Parameters](#parameters-68)
282
- * [warn](#warn-1)
281
+ * [info](#info-1)
283
282
  * [Parameters](#parameters-69)
284
- * [error](#error-1)
283
+ * [warn](#warn-1)
285
284
  * [Parameters](#parameters-70)
286
- * [debug](#debug-1)
285
+ * [error](#error-1)
287
286
  * [Parameters](#parameters-71)
287
+ * [debug](#debug-1)
288
+ * [Parameters](#parameters-72)
288
289
  * [addMethodName](#addmethodname-1)
289
290
  * [deleteMethodName](#deletemethodname-1)
290
291
  * [Project](#project)
291
292
  * [PullRequest](#pullrequest)
292
- * [Parameters](#parameters-72)
293
+ * [Parameters](#parameters-73)
293
294
  * [Properties](#properties-7)
294
295
  * [fullName](#fullname-3)
295
296
  * [url](#url-3)
296
297
  * [repository](#repository-1)
297
298
  * [delete](#delete-3)
298
299
  * [merge](#merge)
299
- * [Parameters](#parameters-73)
300
+ * [Parameters](#parameters-74)
300
301
  * [decline](#decline)
301
302
  * [reviews](#reviews)
302
303
  * [identifier](#identifier-2)
@@ -304,9 +305,9 @@ console.log(await readme.string);
304
305
  * [states](#states)
305
306
  * [validMergeMethods](#validmergemethods)
306
307
  * [list](#list-2)
307
- * [Parameters](#parameters-74)
308
- * [open](#open)
309
308
  * [Parameters](#parameters-75)
309
+ * [open](#open)
310
+ * [Parameters](#parameters-76)
310
311
  * [state](#state)
311
312
  * [locked](#locked)
312
313
  * [merged](#merged)
@@ -315,12 +316,12 @@ console.log(await readme.string);
315
316
  * [ref](#ref-1)
316
317
  * [refId](#refid)
317
318
  * [entries](#entries)
318
- * [Parameters](#parameters-76)
319
+ * [Parameters](#parameters-77)
319
320
  * [asyncIterator](#asynciterator)
320
321
  * [maybeEntry](#maybeentry)
321
- * [Parameters](#parameters-77)
322
- * [entry](#entry)
323
322
  * [Parameters](#parameters-78)
323
+ * [entry](#entry)
324
+ * [Parameters](#parameters-79)
324
325
  * [repository](#repository-2)
325
326
  * [fullName](#fullname-4)
326
327
  * [fullCondensedName](#fullcondensedname-1)
@@ -331,12 +332,12 @@ console.log(await readme.string);
331
332
  * [ref](#ref-3)
332
333
  * [refId](#refid-1)
333
334
  * [entries](#entries-1)
334
- * [Parameters](#parameters-79)
335
+ * [Parameters](#parameters-80)
335
336
  * [asyncIterator](#asynciterator-1)
336
337
  * [maybeEntry](#maybeentry-1)
337
- * [Parameters](#parameters-80)
338
- * [entry](#entry-1)
339
338
  * [Parameters](#parameters-81)
339
+ * [entry](#entry-1)
340
+ * [Parameters](#parameters-82)
340
341
  * [repository](#repository-3)
341
342
  * [fullName](#fullname-5)
342
343
  * [fullCondensedName](#fullcondensedname-2)
@@ -345,25 +346,25 @@ console.log(await readme.string);
345
346
  * [attributes](#attributes-2)
346
347
  * [isProtected](#isprotected-2)
347
348
  * [RepositoryGroup](#repositorygroup-1)
348
- * [Parameters](#parameters-82)
349
+ * [Parameters](#parameters-83)
349
350
  * [Properties](#properties-8)
350
351
  * [attributeMapping](#attributemapping-1)
351
352
  * [type](#type-1)
352
353
  * [homePageURL](#homepageurl-2)
353
354
  * [RepositoryOwner](#repositoryowner)
354
- * [Parameters](#parameters-83)
355
- * [Repository](#repository-4)
356
355
  * [Parameters](#parameters-84)
356
+ * [Repository](#repository-4)
357
+ * [Parameters](#parameters-85)
357
358
  * [Properties](#properties-9)
358
359
  * [slug](#slug-2)
359
360
  * [entry](#entry-2)
360
- * [Parameters](#parameters-85)
361
- * [entries](#entries-2)
362
361
  * [Parameters](#parameters-86)
363
- * [maybeEntry](#maybeentry-2)
362
+ * [entries](#entries-2)
364
363
  * [Parameters](#parameters-87)
365
- * [commits](#commits)
364
+ * [maybeEntry](#maybeentry-2)
366
365
  * [Parameters](#parameters-88)
366
+ * [commits](#commits)
367
+ * [Parameters](#parameters-89)
367
368
  * [cloneURL](#cloneurl)
368
369
  * [issuesURL](#issuesurl-2)
369
370
  * [homePageURL](#homepageurl-3)
@@ -374,47 +375,47 @@ console.log(await readme.string);
374
375
  * [delete](#delete-4)
375
376
  * [defaultBranch](#defaultbranch)
376
377
  * [branch](#branch-2)
377
- * [Parameters](#parameters-89)
378
+ * [Parameters](#parameters-90)
378
379
  * [hasBranches](#hasbranches)
379
380
  * [branches](#branches-2)
380
- * [Parameters](#parameters-90)
381
- * [createBranch](#createbranch-1)
382
381
  * [Parameters](#parameters-91)
383
- * [addBranch](#addbranch)
382
+ * [createBranch](#createbranch-1)
384
383
  * [Parameters](#parameters-92)
385
- * [deleteBranch](#deletebranch)
384
+ * [addBranch](#addbranch)
386
385
  * [Parameters](#parameters-93)
387
- * [tag](#tag)
386
+ * [deleteBranch](#deletebranch)
388
387
  * [Parameters](#parameters-94)
389
- * [tags](#tags-2)
388
+ * [tag](#tag)
390
389
  * [Parameters](#parameters-95)
391
- * [addTag](#addtag)
390
+ * [tags](#tags-2)
392
391
  * [Parameters](#parameters-96)
393
- * [createPullRequest](#createpullrequest-1)
392
+ * [addTag](#addtag)
394
393
  * [Parameters](#parameters-97)
395
- * [addPullRequest](#addpullrequest)
394
+ * [createPullRequest](#createpullrequest-1)
396
395
  * [Parameters](#parameters-98)
396
+ * [addPullRequest](#addpullrequest)
397
+ * [Parameters](#parameters-99)
397
398
  * [pullRequests](#pullrequests-2)
398
399
  * [pullRequest](#pullrequest-1)
399
- * [Parameters](#parameters-99)
400
- * [deletePullRequest](#deletepullrequest)
401
400
  * [Parameters](#parameters-100)
402
- * [addHook](#addhook)
401
+ * [deletePullRequest](#deletepullrequest)
403
402
  * [Parameters](#parameters-101)
404
- * [createHook](#createhook)
403
+ * [addHook](#addhook)
405
404
  * [Parameters](#parameters-102)
405
+ * [createHook](#createhook)
406
+ * [Parameters](#parameters-103)
406
407
  * [hooks](#hooks-2)
407
408
  * [hook](#hook-1)
408
- * [Parameters](#parameters-103)
409
- * [milestone](#milestone-1)
410
409
  * [Parameters](#parameters-104)
411
- * [project](#project-1)
410
+ * [milestone](#milestone-1)
412
411
  * [Parameters](#parameters-105)
413
- * [application](#application-1)
412
+ * [project](#project-1)
414
413
  * [Parameters](#parameters-106)
414
+ * [application](#application-1)
415
+ * [Parameters](#parameters-107)
415
416
  * [type](#type-2)
416
417
  * [refId](#refid-2)
417
- * [Parameters](#parameters-107)
418
+ * [Parameters](#parameters-108)
418
419
  * [attributes](#attributes-3)
419
420
  * [defaultBranchName](#defaultbranchname)
420
421
  * [branches](#branches-3)
@@ -426,21 +427,21 @@ console.log(await readme.string);
426
427
  * [Review](#review)
427
428
  * [SingleGroupProvider](#singlegroupprovider)
428
429
  * [repository](#repository-5)
429
- * [Parameters](#parameters-108)
430
- * [repositoryGroup](#repositorygroup-2)
431
430
  * [Parameters](#parameters-109)
432
- * [repositoryGroups](#repositorygroups-1)
431
+ * [repositoryGroup](#repositorygroup-2)
433
432
  * [Parameters](#parameters-110)
433
+ * [repositoryGroups](#repositorygroups-1)
434
+ * [Parameters](#parameters-111)
434
435
  * [Tag](#tag-1)
435
436
  * [refType](#reftype-1)
436
437
  * [asArray](#asarray)
437
- * [Parameters](#parameters-111)
438
- * [stripBaseName](#stripbasename)
439
438
  * [Parameters](#parameters-112)
440
- * [stripBaseNames](#stripbasenames)
439
+ * [stripBaseName](#stripbasename)
441
440
  * [Parameters](#parameters-113)
442
- * [generateBranchName](#generatebranchname)
441
+ * [stripBaseNames](#stripbasenames)
443
442
  * [Parameters](#parameters-114)
443
+ * [generateBranchName](#generatebranchname)
444
+ * [Parameters](#parameters-115)
444
445
 
445
446
  ## Application
446
447
 
@@ -624,7 +625,10 @@ Creates an instance of BaseObject.
624
625
 
625
626
  ### Parameters
626
627
 
627
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
628
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
629
+
630
+ * `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
631
+ * `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
628
632
  * `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
629
633
 
630
634
  ### Properties
@@ -940,9 +944,17 @@ Returns **([BaseProvider](#baseprovider) | [undefined](https://developer.mozilla
940
944
 
941
945
  **Extends BaseObject**
942
946
 
947
+ ### Parameters
948
+
949
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
950
+
951
+ * `options.url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
952
+ * `options.messageDestination` **[MessageDestination](#messagedestination)?** 
953
+
943
954
  ### Properties
944
955
 
945
956
  * `messageDestination` **[MessageDestination](#messagedestination)** 
957
+ * `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
946
958
 
947
959
  ### equals
948
960
 
@@ -1419,6 +1431,10 @@ Object with a name.
1419
1431
 
1420
1432
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
1421
1433
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
1434
+
1435
+ * `options.id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
1436
+ * `options.name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
1437
+ * `options.description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
1422
1438
  * `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
1423
1439
 
1424
1440
  ### Properties
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "35.2.9",
3
+ "version": "35.2.11",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "provenance": true
@@ -45,7 +45,7 @@
45
45
  "browser-ava": "^2.2.0",
46
46
  "c8": "^9.1.0",
47
47
  "documentation": "^14.0.3",
48
- "repository-provider-test-support": "^3.0.6",
48
+ "repository-provider-test-support": "^3.1.2",
49
49
  "semantic-release": "^23.0.2",
50
50
  "typescript": "^5.3.3"
51
51
  },
package/src/base-object.mjs CHANGED
@@ -6,7 +6,9 @@ import { description_attribute, id_attribute } from "./attributes.mjs";
6
6
 
7
7
  /**
8
8
  * Creates an instance of BaseObject.
9
- * @param {Object} options
9
+ * @param {Object} [options]
10
+ * @param {string} [options.id]
11
+ * @param {string} [options.description]
10
12
  * @param {Object} [additionalProperties]
11
13
  *
12
14
  * @property {string?} id
package/src/base-provider.mjs CHANGED
@@ -31,7 +31,11 @@ import {
31
31
  */
32
32
 
33
33
  /**
34
+ * @param {Object} [options]
35
+ * @param {string} [options.url]
36
+ * @param {MessageDestination} [options.messageDestination]
34
37
  * @property {MessageDestination} messageDestination
38
+ * @property {string} url
35
39
  */
36
40
  export class BaseProvider extends BaseObject {
37
41
  static get type() {
package/src/named-object.mjs CHANGED
@@ -10,6 +10,9 @@ import {
10
10
  * Object with a name.
11
11
  * @param {string} name
12
12
  * @param {Object} [options]
13
+ * @param {string} [options.id]
14
+ * @param {string} [options.name]
15
+ * @param {string} [options.description]
13
16
  * @param {Object} [additionalProperties]
14
17
  *
15
18
  * @property {string} name
package/types/base-object.d.mts CHANGED
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Creates an instance of BaseObject.
3
- * @param {Object} options
3
+ * @param {Object} [options]
4
+ * @param {string} [options.id]
5
+ * @param {string} [options.description]
4
6
  * @param {Object} [additionalProperties]
5
7
  *
6
8
  * @property {string?} id
package/types/base-provider.d.mts CHANGED
@@ -12,7 +12,11 @@
12
12
  * @property {Function} trace
13
13
  */
14
14
  /**
15
+ * @param {Object} [options]
16
+ * @param {string} [options.url]
17
+ * @param {MessageDestination} [options.messageDestination]
15
18
  * @property {MessageDestination} messageDestination
19
+ * @property {string} url
16
20
  */
17
21
  export class BaseProvider extends BaseObject {
18
22
  /**
package/types/named-object.d.mts CHANGED
@@ -2,6 +2,9 @@
2
2
  * Object with a name.
3
3
  * @param {string} name
4
4
  * @param {Object} [options]
5
+ * @param {string} [options.id]
6
+ * @param {string} [options.name]
7
+ * @param {string} [options.description]
5
8
  * @param {Object} [additionalProperties]
6
9
  *
7
10
  * @property {string} name