repository-provider 36.0.3 → 36.0.5

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
@@ -57,6 +57,8 @@ console.log(await readme.string);
57
57
  * [toString](#tostring)
58
58
  * [fullName](#fullname)
59
59
  * [isWritable](#iswritable)
60
+ * [isDisabled](#isdisabled)
61
+ * [isTemplate](#istemplate)
60
62
  * [equals](#equals)
61
63
  * [Parameters](#parameters-2)
62
64
  * [type](#type)
@@ -211,7 +213,7 @@ console.log(await readme.string);
211
213
  * [issuesURL](#issuesurl)
212
214
  * [isLocked](#islocked)
213
215
  * [isArchived](#isarchived)
214
- * [isDisabled](#isdisabled)
216
+ * [isDisabled](#isdisabled-1)
215
217
  * [api](#api)
216
218
  * [slug](#slug)
217
219
  * [url](#url-1)
@@ -239,7 +241,7 @@ console.log(await readme.string);
239
241
  * [issuesURL](#issuesurl-1)
240
242
  * [isLocked](#islocked-1)
241
243
  * [isArchived](#isarchived-1)
242
- * [isDisabled](#isdisabled-1)
244
+ * [isDisabled](#isdisabled-2)
243
245
  * [api](#api-1)
244
246
  * [slug](#slug-1)
245
247
  * [url](#url-2)
@@ -341,8 +343,6 @@ console.log(await readme.string);
341
343
  * [homePageURL](#homepageurl-3)
342
344
  * [isArchived](#isarchived-2)
343
345
  * [isLocked](#islocked-2)
344
- * [isDisabled](#isdisabled-2)
345
- * [isTemplate](#istemplate)
346
346
  * [delete](#delete-4)
347
347
  * [defaultBranch](#defaultbranch)
348
348
  * [branch](#branch-2)
@@ -362,31 +362,43 @@ console.log(await readme.string);
362
362
  * [Parameters](#parameters-90)
363
363
  * [addTag](#addtag)
364
364
  * [Parameters](#parameters-91)
365
- * [createPullRequest](#createpullrequest-1)
365
+ * [\_addTag](#_addtag)
366
366
  * [Parameters](#parameters-92)
367
- * [addPullRequest](#addpullrequest)
367
+ * [createPullRequest](#createpullrequest-1)
368
368
  * [Parameters](#parameters-93)
369
+ * [addPullRequest](#addpullrequest)
370
+ * [Parameters](#parameters-94)
371
+ * [\_addPullRequest](#_addpullrequest)
372
+ * [Parameters](#parameters-95)
369
373
  * [pullRequests](#pullrequests-2)
370
374
  * [pullRequest](#pullrequest-1)
371
- * [Parameters](#parameters-94)
375
+ * [Parameters](#parameters-96)
372
376
  * [deletePullRequest](#deletepullrequest)
373
- * [Parameters](#parameters-95)
377
+ * [Parameters](#parameters-97)
374
378
  * [addHook](#addhook)
375
- * [Parameters](#parameters-96)
379
+ * [Parameters](#parameters-98)
380
+ * [\_addHook](#_addhook)
381
+ * [Parameters](#parameters-99)
376
382
  * [createHook](#createhook)
377
- * [Parameters](#parameters-97)
383
+ * [Parameters](#parameters-100)
378
384
  * [hooks](#hooks-2)
379
385
  * [hook](#hook-1)
380
- * [Parameters](#parameters-98)
386
+ * [Parameters](#parameters-101)
387
+ * [\_addMilestone](#_addmilestone)
388
+ * [Parameters](#parameters-102)
381
389
  * [milestone](#milestone-1)
382
- * [Parameters](#parameters-99)
390
+ * [Parameters](#parameters-103)
391
+ * [\_addProject](#_addproject)
392
+ * [Parameters](#parameters-104)
383
393
  * [project](#project-1)
384
- * [Parameters](#parameters-100)
394
+ * [Parameters](#parameters-105)
395
+ * [\_addApplication](#_addapplication)
396
+ * [Parameters](#parameters-106)
385
397
  * [application](#application-1)
386
- * [Parameters](#parameters-101)
398
+ * [Parameters](#parameters-107)
387
399
  * [type](#type-2)
388
400
  * [refId](#refid-2)
389
- * [Parameters](#parameters-102)
401
+ * [Parameters](#parameters-108)
390
402
  * [attributes](#attributes-3)
391
403
  * [defaultBranchName](#defaultbranchname)
392
404
  * [branches](#branches-3)
@@ -395,24 +407,25 @@ console.log(await readme.string);
395
407
  * [applications](#applications)
396
408
  * [milestones](#milestones-2)
397
409
  * [pullRequests](#pullrequests-3)
410
+ * [hooks](#hooks-3)
398
411
  * [Review](#review)
399
412
  * [SingleGroupProvider](#singlegroupprovider)
400
413
  * [repository](#repository-5)
401
- * [Parameters](#parameters-103)
414
+ * [Parameters](#parameters-109)
402
415
  * [repositoryGroup](#repositorygroup-2)
403
- * [Parameters](#parameters-104)
416
+ * [Parameters](#parameters-110)
404
417
  * [repositoryGroups](#repositorygroups-1)
405
- * [Parameters](#parameters-105)
418
+ * [Parameters](#parameters-111)
406
419
  * [Tag](#tag-1)
407
420
  * [refType](#reftype-1)
408
421
  * [asArray](#asarray)
409
- * [Parameters](#parameters-106)
422
+ * [Parameters](#parameters-112)
410
423
  * [stripBaseName](#stripbasename)
411
- * [Parameters](#parameters-107)
424
+ * [Parameters](#parameters-113)
412
425
  * [stripBaseNames](#stripbasenames)
413
- * [Parameters](#parameters-108)
426
+ * [Parameters](#parameters-114)
414
427
  * [generateBranchName](#generatebranchname)
415
- * [Parameters](#parameters-109)
428
+ * [Parameters](#parameters-115)
416
429
 
417
430
  ## Application
418
431
 
@@ -447,7 +460,6 @@ Takes values from options.
447
460
  #### Parameters
448
461
 
449
462
  * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
450
- * `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** 
451
463
 
452
464
  ### update
453
465
 
@@ -469,6 +481,18 @@ By default cannot be written to.
469
481
 
470
482
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
471
483
 
484
+ ### isDisabled
485
+
486
+ By default we are not disabled.
487
+
488
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
489
+
490
+ ### isTemplate
491
+
492
+ By default we are not a template.
493
+
494
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
495
+
472
496
  ### equals
473
497
 
474
498
  Check for equality
@@ -1430,9 +1454,9 @@ Named Object registering itself in the owner.
1430
1454
 
1431
1455
  ### Parameters
1432
1456
 
1433
- * `owner`  
1434
- * `name`  
1435
- * `options`  
1457
+ * `owner` **[BaseObject](#baseobject)** 
1458
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
1459
+ * `options` **([Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))** 
1436
1460
 
1437
1461
  ### delete
1438
1462
 
@@ -2059,18 +2083,6 @@ By default we are not locked.
2059
2083
 
2060
2084
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
2061
2085
 
2062
- ### isDisabled
2063
-
2064
- By default we are not disabled.
2065
-
2066
- Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
2067
-
2068
- ### isTemplate
2069
-
2070
- By default we are not a template.
2071
-
2072
- Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
2073
-
2074
2086
  ### delete
2075
2087
 
2076
2088
  Delete the repository from the [Provider](Provider).
@@ -2148,7 +2160,7 @@ Get a Tag.
2148
2160
 
2149
2161
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
2150
2162
 
2151
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Tag](#tag)>**&#x20;
2163
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Tag](#tag) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>**&#x20;
2152
2164
 
2153
2165
  ### tags
2154
2166
 
@@ -2170,6 +2182,12 @@ Internal tag creation does not call repository.initialize()
2170
2182
 
2171
2183
  Returns **[Tag](#tag)** newly created tag
2172
2184
 
2185
+ ### \_addTag
2186
+
2187
+ #### Parameters
2188
+
2189
+ * `tag` **[Tag](#tag)**&#x20;
2190
+
2173
2191
  ### createPullRequest
2174
2192
 
2175
2193
  Create a pull request (or deliver an already present for the given name).
@@ -2194,6 +2212,12 @@ Add a pull request.
2194
2212
 
2195
2213
  Returns **[PullRequest](#pullrequest)**&#x20;
2196
2214
 
2215
+ ### \_addPullRequest
2216
+
2217
+ #### Parameters
2218
+
2219
+ * `pr` **[PullRequest](#pullrequest)**&#x20;
2220
+
2197
2221
  ### pullRequests
2198
2222
 
2199
2223
  Deliver all [PullRequest](#pullrequest)s.
@@ -2231,6 +2255,12 @@ Add a new [Hook](#hook).
2231
2255
 
2232
2256
  Returns **[Hook](#hook)** newly created hook
2233
2257
 
2258
+ ### \_addHook
2259
+
2260
+ #### Parameters
2261
+
2262
+ * `hook` **[Hook](#hook)**&#x20;
2263
+
2234
2264
  ### createHook
2235
2265
 
2236
2266
  Add a new Hook.
@@ -2255,6 +2285,12 @@ Get a Hook.
2255
2285
 
2256
2286
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Hook](#hook) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** for the given id
2257
2287
 
2288
+ ### \_addMilestone
2289
+
2290
+ #### Parameters
2291
+
2292
+ * `milestone` **[Milestone](#milestone)**&#x20;
2293
+
2258
2294
  ### milestone
2259
2295
 
2260
2296
  Get a Milestone.
@@ -2265,6 +2301,12 @@ Get a Milestone.
2265
2301
 
2266
2302
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Milestone](#milestone) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** for the given name
2267
2303
 
2304
+ ### \_addProject
2305
+
2306
+ #### Parameters
2307
+
2308
+ * `project` **[Project](#project)**&#x20;
2309
+
2268
2310
  ### project
2269
2311
 
2270
2312
  Get a Project.
@@ -2275,6 +2317,12 @@ Get a Project.
2275
2317
 
2276
2318
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<([Project](#project) | [undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined))>** for the given name
2277
2319
 
2320
+ ### \_addApplication
2321
+
2322
+ #### Parameters
2323
+
2324
+ * `application` **[Application](#application)**&#x20;
2325
+
2278
2326
  ### application
2279
2327
 
2280
2328
  Get an Application.
@@ -2335,6 +2383,10 @@ Type: [Map](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_O
2335
2383
 
2336
2384
  Type: [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)>
2337
2385
 
2386
+ ## hooks
2387
+
2388
+ Type: [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Hook](#hook)>
2389
+
2338
2390
  ## Review
2339
2391
 
2340
2392
  **Extends OwnedObject**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "36.0.3",
3
+ "version": "36.0.5",
4
4
  "publishConfig": {
5
5
  "access": "public",
6
6
  "provenance": true
@@ -35,7 +35,7 @@
35
35
  "dependencies": {
36
36
  "content-entry": "^14.2.7",
37
37
  "matching-iterator": "^2.1.5",
38
- "pacc": "^4.42.0"
38
+ "pacc": "^5.0.0"
39
39
  },
40
40
  "devDependencies": {
41
41
  "ava": "^6.4.1",
@@ -68,7 +68,6 @@ export class BaseObject {
68
68
  /**
69
69
  * Takes values from options.
70
70
  * @param {Object} [options]
71
- * @param {Object} [additionalProperties]
72
71
  */
73
72
  updateAttributes(options) {
74
73
  definePropertiesFromAttributes(this, this.constructor.attributes, options);
@@ -107,6 +106,22 @@ export class BaseObject {
107
106
  return false;
108
107
  }
109
108
 
109
+ /**
110
+ * By default we are not disabled.
111
+ * @return {boolean} false
112
+ */
113
+ get isDisabled() {
114
+ return false;
115
+ }
116
+
117
+ /**
118
+ * By default we are not a template.
119
+ * @return {boolean} false
120
+ */
121
+ get isTemplate() {
122
+ return false;
123
+ }
124
+
110
125
  /**
111
126
  * Check for equality
112
127
  * @param {BaseObject|undefined} other
@@ -1,5 +1,5 @@
1
1
  import {
2
- manadatoryAttributesPresent,
2
+ mandatoryAttributesPresent,
3
3
  environmentValues,
4
4
  url_attribute,
5
5
  name_attribute_writable,
@@ -112,7 +112,7 @@ export class BaseProvider extends BaseObject {
112
112
  )
113
113
  };
114
114
 
115
- if (manadatoryAttributesPresent(options, this.attributes)) {
115
+ if (mandatoryAttributesPresent(options, this.attributes)) {
116
116
  return new this(options);
117
117
  }
118
118
  }
@@ -3,6 +3,7 @@ import { NamedObject } from "./named-object.mjs";
3
3
  /**
4
4
  * @typedef {import('./base-provider.mjs').BaseProvider} BaseProvider
5
5
  * @typedef {import('./repository.mjs').Repository} Repository
6
+ * @typedef {import('./base-object.mjs').BaseObject} BaseObject
6
7
  */
7
8
 
8
9
  /**
@@ -29,6 +30,12 @@ export class OwnedObject extends NamedObject {
29
30
 
30
31
  owner;
31
32
 
33
+ /**
34
+ *
35
+ * @param {BaseObject} owner
36
+ * @param {string} name
37
+ * @param {Object|undefined} options
38
+ */
32
39
  constructor(owner, name, options) {
33
40
  super(name, options);
34
41
  this.owner = owner;
@@ -87,7 +87,7 @@ export class Repository extends OwnedObject {
87
87
  /** @type {Map<string,Application>} */ #applications = new Map();
88
88
  /** @type {Map<string,Milestone>} */ #milestones = new Map();
89
89
  /** @type {Map<string,PullRequest>} */ #pullRequests = new Map();
90
- #hooks = [];
90
+ /** @type {Array<Hook>} */ #hooks = [];
91
91
 
92
92
  /**
93
93
  * @param {RepositoryOwner} owner
@@ -197,22 +197,6 @@ export class Repository extends OwnedObject {
197
197
  return false;
198
198
  }
199
199
 
200
- /**
201
- * By default we are not disabled.
202
- * @return {boolean} false
203
- */
204
- get isDisabled() {
205
- return false;
206
- }
207
-
208
- /**
209
- * By default we are not a template.
210
- * @return {boolean} false
211
- */
212
- get isTemplate() {
213
- return false;
214
- }
215
-
216
200
  /**
217
201
  * Delete the repository from the {@link Provider}.
218
202
  * {@link Provider#deleteRepository}
@@ -308,7 +292,7 @@ export class Repository extends OwnedObject {
308
292
  /**
309
293
  * Get a Tag.
310
294
  * @param {string} name
311
- * @return {Promise<Tag>}
295
+ * @return {Promise<Tag|undefined>}
312
296
  */
313
297
  async tag(name) {
314
298
  await this.initializeTags();
@@ -339,6 +323,10 @@ export class Repository extends OwnedObject {
339
323
  return this.#tags.get(name) || new this.tagClass(this, name, options);
340
324
  }
341
325
 
326
+ /**
327
+ *
328
+ * @param {Tag} tag
329
+ */
342
330
  _addTag(tag) {
343
331
  this.#tags.set(tag.name, tag);
344
332
  }
@@ -372,6 +360,10 @@ export class Repository extends OwnedObject {
372
360
  return pr;
373
361
  }
374
362
 
363
+ /**
364
+ *
365
+ * @param {PullRequest} pr
366
+ */
375
367
  _addPullRequest(pr) {
376
368
  this.#pullRequests.set(pr.name, pr);
377
369
  }
@@ -421,6 +413,10 @@ export class Repository extends OwnedObject {
421
413
  );
422
414
  }
423
415
 
416
+ /**
417
+ *
418
+ * @param {Hook} hook
419
+ */
424
420
  _addHook(hook) {
425
421
  this.#hooks.push(hook);
426
422
  }
@@ -459,6 +455,10 @@ export class Repository extends OwnedObject {
459
455
  }
460
456
  }
461
457
 
458
+ /**
459
+ *
460
+ * @param {Milestone} milestone
461
+ */
462
462
  _addMilestone(milestone) {
463
463
  this.#milestones.set(milestone.name, milestone);
464
464
  }
@@ -472,6 +472,10 @@ export class Repository extends OwnedObject {
472
472
  return this.#milestones.get(name);
473
473
  }
474
474
 
475
+ /**
476
+ *
477
+ * @param {Project} project
478
+ */
475
479
  _addProject(project) {
476
480
  this.#projects.set(project.name, project);
477
481
  }
@@ -485,6 +489,10 @@ export class Repository extends OwnedObject {
485
489
  return this.#projects.get(name);
486
490
  }
487
491
 
492
+ /**
493
+ *
494
+ * @param {Application} application
495
+ */
488
496
  _addApplication(application) {
489
497
  this.#applications.set(application.name, application);
490
498
  }