repository-provider 28.3.5 → 28.3.8

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
@@ -2,12 +2,12 @@
2
2
  [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
3
3
  [![minified size](https://badgen.net/bundlephobia/min/repository-provider)](https://bundlephobia.com/result?p=repository-provider)
4
4
  [![downloads](http://img.shields.io/npm/dm/repository-provider.svg?style=flat-square)](https://npmjs.org/package/repository-provider)
5
- [![GitHub Issues](https://img.shields.io/github/issues/arlac77/repository-provider.svg?style=flat-square)](https://github.com/arlac77/repository-provider/issues)
6
- [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Farlac77%2Frepository-provider%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/arlac77/repository-provider/goto)
5
+ [![GitHub Issues](https://img.shields.io/github/issues/repository-provider/repository-provider.svg?style=flat-square)](https://github.com/repository-provider/repository-provider/issues)
6
+ [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Frepository-provider%2Frepository-provider%2Fbadge\&style=flat)](https://actions-badge.atrox.dev/repository-provider/repository-provider/goto)
7
7
  [![Styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
8
8
  [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
9
- [![Known Vulnerabilities](https://snyk.io/test/github/arlac77/repository-provider/badge.svg)](https://snyk.io/test/github/arlac77/repository-provider)
10
- [![Coverage Status](https://coveralls.io/repos/arlac77/repository-provider/badge.svg)](https://coveralls.io/github/arlac77/repository-provider)
9
+ [![Known Vulnerabilities](https://snyk.io/test/github/repository-provider/repository-provider/badge.svg)](https://snyk.io/test/github/repository-provider/repository-provider)
10
+ [![Coverage Status](https://coveralls.io/repos/repository-provider/repository-provider/badge.svg)](https://coveralls.io/github/repository-provider/repository-provider)
11
11
 
12
12
  # repository-provider
13
13
 
@@ -65,6 +65,8 @@ console.log(await readme.getString());
65
65
  * [BaseObject](#baseobject)
66
66
  * [Parameters](#parameters-7)
67
67
  * [update](#update)
68
+ * [toString](#tostring)
69
+ * [isWritable](#iswritable)
68
70
  * [equals](#equals)
69
71
  * [Parameters](#parameters-8)
70
72
  * [provider](#provider)
@@ -152,6 +154,7 @@ console.log(await readme.getString());
152
154
  * [Properties](#properties-3)
153
155
  * [url](#url-1)
154
156
  * [refType](#reftype)
157
+ * [isWritable](#iswritable-1)
155
158
  * [isDefault](#isdefault)
156
159
  * [delete](#delete)
157
160
  * [commit](#commit)
@@ -171,51 +174,47 @@ console.log(await readme.getString());
171
174
  * [Properties](#properties-5)
172
175
  * [Hook](#hook)
173
176
  * [Parameters](#parameters-37)
174
- * [Properties](#properties-6)
175
- * [equals](#equals-2)
176
- * [Parameters](#parameters-38)
177
177
  * [toJSON](#tojson-1)
178
178
  * [Issue](#issue)
179
179
  * [Milestone](#milestone)
180
180
  * [MultiGroupProvider](#multigroupprovider)
181
- * [Parameters](#parameters-39)
181
+ * [Parameters](#parameters-38)
182
182
  * [repository](#repository)
183
- * [Parameters](#parameters-40)
183
+ * [Parameters](#parameters-39)
184
184
  * [branch](#branch-1)
185
- * [Parameters](#parameters-41)
185
+ * [Parameters](#parameters-40)
186
186
  * [repositoryGroup](#repositorygroup)
187
- * [Parameters](#parameters-42)
187
+ * [Parameters](#parameters-41)
188
188
  * [repositoryGroups](#repositorygroups)
189
- * [Parameters](#parameters-43)
189
+ * [Parameters](#parameters-42)
190
190
  * [createRepositoryGroup](#createrepositorygroup)
191
- * [Parameters](#parameters-44)
191
+ * [Parameters](#parameters-43)
192
192
  * [addRepositoryGroup](#addrepositorygroup)
193
- * [Parameters](#parameters-45)
193
+ * [Parameters](#parameters-44)
194
194
  * [NamedObject](#namedobject)
195
- * [Parameters](#parameters-46)
196
- * [Properties](#properties-7)
197
- * [equals](#equals-3)
198
- * [Parameters](#parameters-47)
195
+ * [Parameters](#parameters-45)
196
+ * [Properties](#properties-6)
197
+ * [equals](#equals-2)
198
+ * [Parameters](#parameters-46)
199
199
  * [displayName](#displayname)
200
200
  * [fullName](#fullname-1)
201
- * [toString](#tostring)
202
201
  * [toJSON](#tojson-2)
203
202
  * [OwnedObject](#ownedobject)
204
- * [Parameters](#parameters-48)
203
+ * [Parameters](#parameters-47)
205
204
  * [registerInstanceMethodName](#registerinstancemethodname)
206
205
  * [Project](#project)
207
206
  * [PullRequest](#pullrequest)
208
- * [Parameters](#parameters-49)
209
- * [Properties](#properties-8)
207
+ * [Parameters](#parameters-48)
208
+ * [Properties](#properties-7)
210
209
  * [fullName](#fullname-2)
211
210
  * [url](#url-2)
212
211
  * [repository](#repository-1)
213
212
  * [provider](#provider-2)
214
- * [equals](#equals-4)
215
- * [Parameters](#parameters-50)
213
+ * [equals](#equals-3)
214
+ * [Parameters](#parameters-49)
216
215
  * [delete](#delete-1)
217
216
  * [merge](#merge)
218
- * [Parameters](#parameters-51)
217
+ * [Parameters](#parameters-50)
219
218
  * [decline](#decline)
220
219
  * [reviews](#reviews)
221
220
  * [identifier](#identifier)
@@ -223,9 +222,9 @@ console.log(await readme.getString());
223
222
  * [defaultListStates](#defaultliststates)
224
223
  * [validMergeMethods](#validmergemethods)
225
224
  * [list](#list-1)
226
- * [Parameters](#parameters-52)
225
+ * [Parameters](#parameters-51)
227
226
  * [open](#open)
228
- * [Parameters](#parameters-53)
227
+ * [Parameters](#parameters-52)
229
228
  * [title](#title)
230
229
  * [body](#body)
231
230
  * [state](#state)
@@ -233,21 +232,21 @@ console.log(await readme.getString());
233
232
  * [merged](#merged)
234
233
  * [draft](#draft)
235
234
  * [ContentEntry](#contententry)
236
- * [Properties](#properties-9)
235
+ * [Properties](#properties-8)
237
236
  * [Ref](#ref)
238
- * [Parameters](#parameters-54)
239
- * [equals](#equals-5)
240
- * [Parameters](#parameters-55)
237
+ * [Parameters](#parameters-53)
238
+ * [equals](#equals-4)
239
+ * [Parameters](#parameters-54)
241
240
  * [ref](#ref-1)
242
241
  * [refId](#refid)
243
- * [Parameters](#parameters-56)
242
+ * [Parameters](#parameters-55)
244
243
  * [entries](#entries)
245
- * [Parameters](#parameters-57)
244
+ * [Parameters](#parameters-56)
246
245
  * [asyncIterator](#asynciterator)
247
246
  * [maybeEntry](#maybeentry)
248
- * [Parameters](#parameters-58)
247
+ * [Parameters](#parameters-57)
249
248
  * [entry](#entry)
250
- * [Parameters](#parameters-59)
249
+ * [Parameters](#parameters-58)
251
250
  * [owner](#owner)
252
251
  * [fullName](#fullname-3)
253
252
  * [fullCondensedName](#fullcondensedname)
@@ -259,31 +258,30 @@ console.log(await readme.getString());
259
258
  * [isArchived](#isarchived)
260
259
  * [isDisabled](#isdisabled)
261
260
  * [isProtected](#isprotected)
262
- * [isWritable](#iswritable)
263
261
  * [attributes](#attributes-1)
264
262
  * [isProtected](#isprotected-1)
265
263
  * [RepositoryGroup](#repositorygroup-1)
266
- * [Parameters](#parameters-60)
267
- * [Properties](#properties-10)
264
+ * [Parameters](#parameters-59)
265
+ * [Properties](#properties-9)
268
266
  * [attributeMapping](#attributemapping-1)
269
267
  * [type](#type)
270
268
  * [url](#url-3)
271
269
  * [RepositoryOwner](#repositoryowner)
272
- * [Parameters](#parameters-61)
270
+ * [Parameters](#parameters-60)
273
271
  * [Repository](#repository-2)
274
- * [Parameters](#parameters-62)
275
- * [Properties](#properties-11)
272
+ * [Parameters](#parameters-61)
273
+ * [Properties](#properties-10)
276
274
  * [fullName](#fullname-4)
277
275
  * [slug](#slug)
278
276
  * [identifier](#identifier-2)
279
277
  * [entry](#entry-1)
280
- * [Parameters](#parameters-63)
278
+ * [Parameters](#parameters-62)
281
279
  * [entries](#entries-1)
282
- * [Parameters](#parameters-64)
280
+ * [Parameters](#parameters-63)
283
281
  * [maybeEntry](#maybeentry-1)
284
- * [Parameters](#parameters-65)
282
+ * [Parameters](#parameters-64)
285
283
  * [commits](#commits)
286
- * [Parameters](#parameters-66)
284
+ * [Parameters](#parameters-65)
287
285
  * [urls](#urls)
288
286
  * [url](#url-4)
289
287
  * [cloneURL](#cloneurl)
@@ -297,40 +295,40 @@ console.log(await readme.getString());
297
295
  * [delete](#delete-2)
298
296
  * [defaultBranch](#defaultbranch)
299
297
  * [branch](#branch-2)
300
- * [Parameters](#parameters-67)
298
+ * [Parameters](#parameters-66)
301
299
  * [branches](#branches-1)
302
- * [Parameters](#parameters-68)
300
+ * [Parameters](#parameters-67)
303
301
  * [createBranch](#createbranch-1)
304
- * [Parameters](#parameters-69)
302
+ * [Parameters](#parameters-68)
305
303
  * [addBranch](#addbranch)
306
- * [Parameters](#parameters-70)
304
+ * [Parameters](#parameters-69)
307
305
  * [deleteBranch](#deletebranch)
308
- * [Parameters](#parameters-71)
306
+ * [Parameters](#parameters-70)
309
307
  * [tag](#tag)
310
- * [Parameters](#parameters-72)
308
+ * [Parameters](#parameters-71)
311
309
  * [tags](#tags-1)
312
- * [Parameters](#parameters-73)
310
+ * [Parameters](#parameters-72)
313
311
  * [addTag](#addtag)
314
- * [Parameters](#parameters-74)
312
+ * [Parameters](#parameters-73)
315
313
  * [createPullRequest](#createpullrequest-1)
316
- * [Parameters](#parameters-75)
314
+ * [Parameters](#parameters-74)
317
315
  * [addPullRequest](#addpullrequest)
318
- * [Parameters](#parameters-76)
316
+ * [Parameters](#parameters-75)
319
317
  * [pullRequests](#pullrequests-1)
320
318
  * [pullRequest](#pullrequest-1)
321
- * [Parameters](#parameters-77)
319
+ * [Parameters](#parameters-76)
322
320
  * [deletePullRequest](#deletepullrequest)
323
- * [Parameters](#parameters-78)
321
+ * [Parameters](#parameters-77)
324
322
  * [addHook](#addhook)
325
- * [Parameters](#parameters-79)
323
+ * [Parameters](#parameters-78)
326
324
  * [createHook](#createhook)
327
- * [Parameters](#parameters-80)
325
+ * [Parameters](#parameters-79)
328
326
  * [hooks](#hooks-1)
329
327
  * [hook](#hook-1)
330
- * [Parameters](#parameters-81)
328
+ * [Parameters](#parameters-80)
331
329
  * [type](#type-1)
332
330
  * [refId](#refid-1)
333
- * [Parameters](#parameters-82)
331
+ * [Parameters](#parameters-81)
334
332
  * [toString](#tostring-2)
335
333
  * [toJSON](#tojson-3)
336
334
  * [attributes](#attributes-2)
@@ -340,23 +338,22 @@ console.log(await readme.getString());
340
338
  * [Review](#review)
341
339
  * [SingleGroupProvider](#singlegroupprovider)
342
340
  * [repository](#repository-3)
343
- * [Parameters](#parameters-83)
341
+ * [Parameters](#parameters-82)
344
342
  * [repositoryGroup](#repositorygroup-2)
345
- * [Parameters](#parameters-84)
343
+ * [Parameters](#parameters-83)
346
344
  * [repositoryGroups](#repositorygroups-1)
347
- * [Parameters](#parameters-85)
345
+ * [Parameters](#parameters-84)
348
346
  * [Tag](#tag-1)
349
- * [Parameters](#parameters-86)
347
+ * [Parameters](#parameters-85)
350
348
  * [refType](#reftype-1)
351
- * [isWritable](#iswritable-1)
352
349
  * [asArray](#asarray)
353
- * [Parameters](#parameters-87)
350
+ * [Parameters](#parameters-86)
354
351
  * [stripBaseName](#stripbasename)
355
- * [Parameters](#parameters-88)
352
+ * [Parameters](#parameters-87)
356
353
  * [stripBaseNames](#stripbasenames)
357
- * [Parameters](#parameters-89)
354
+ * [Parameters](#parameters-88)
358
355
  * [generateBranchName](#generatebranchname)
359
- * [Parameters](#parameters-90)
356
+ * [Parameters](#parameters-89)
360
357
 
361
358
  ## Application
362
359
 
@@ -493,6 +490,16 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
493
490
 
494
491
  Save object attributes in the backing store.
495
492
 
493
+ ### toString
494
+
495
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name
496
+
497
+ ### isWritable
498
+
499
+ By default cannot be written to.
500
+
501
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
502
+
496
503
  ### equals
497
504
 
498
505
  Check for equality
@@ -947,6 +954,10 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
947
954
 
948
955
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** heades
949
956
 
957
+ ### isWritable
958
+
959
+ Returns **any** true if not [isArchived](isArchived) and [isDisabled](isDisabled) and [isLocked](isLocked)
960
+
950
961
  ### isDefault
951
962
 
952
963
  Are we the default branch.
@@ -1045,32 +1056,16 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
1045
1056
 
1046
1057
  ## Hook
1047
1058
 
1048
- **Extends BaseObject**
1059
+ **Extends OwnedObject**
1049
1060
 
1050
1061
  Repository hook.
1051
1062
 
1052
1063
  ### Parameters
1053
1064
 
1054
- * `repository` **[Repository](#repository)**
1055
- * `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
1056
- * `events` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** (optional, default `new Set(["*"])`)
1057
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
1058
-
1059
- ### Properties
1060
-
1061
- * `repository` **[Repository](#repository)**
1062
- * `url` **[URL](https://developer.mozilla.org/docs/Web/API/URL/URL)**
1063
- * `events` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>**
1064
-
1065
- ### equals
1066
-
1067
- Check for equality.
1068
-
1069
- #### Parameters
1070
-
1071
- * `other` **[Hook](#hook)**
1072
-
1073
- Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name and repository are equal
1065
+ * `owner`
1066
+ * `name`
1067
+ * `events` (optional, default `new Set(["*"])`)
1068
+ * `options`
1074
1069
 
1075
1070
  ### toJSON
1076
1071
 
@@ -1193,10 +1188,6 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
1193
1188
 
1194
1189
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name with owner name
1195
1190
 
1196
- ### toString
1197
-
1198
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name
1199
-
1200
1191
  ### toJSON
1201
1192
 
1202
1193
  Provide name and all defined attributes.
@@ -1212,6 +1203,7 @@ Named Object registering itself in the owner.
1212
1203
  * `owner`
1213
1204
  * `name`
1214
1205
  * `options`
1206
+ * `additionalProperties`
1215
1207
 
1216
1208
  ### registerInstanceMethodName
1217
1209
 
@@ -1546,10 +1538,6 @@ Forwarded from the repository
1546
1538
 
1547
1539
  Returns **any** false
1548
1540
 
1549
- ### isWritable
1550
-
1551
- Returns **any** true if not [isArchived](isArchived) and [isDisabled](isDisabled) and [isLocked](isLocked)
1552
-
1553
1541
  ### attributes
1554
1542
 
1555
1543
  options
@@ -2030,12 +2018,6 @@ Tag refs
2030
2018
 
2031
2019
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
2032
2020
 
2033
- ### isWritable
2034
-
2035
- Tags cannot be written to.
2036
-
2037
- Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
2038
-
2039
2021
  ## asArray
2040
2022
 
2041
2023
  Convert scalar into an array.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "28.3.5",
3
+ "version": "28.3.8",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -81,6 +81,21 @@ export class BaseObject {
81
81
  */
82
82
  async update() {}
83
83
 
84
+ /**
85
+ * @return {string} name
86
+ */
87
+ toString() {
88
+ return this.name;
89
+ }
90
+
91
+ /**
92
+ * By default cannot be written to.
93
+ * @return {boolean} false
94
+ */
95
+ get isWritable() {
96
+ return false;
97
+ }
98
+
84
99
  /**
85
100
  * Check for equality
86
101
  * @param {BaseObject} other
@@ -428,10 +428,6 @@ export class BaseProvider extends BaseObject {
428
428
  return "/";
429
429
  }
430
430
 
431
- toString() {
432
- return this.name;
433
- }
434
-
435
431
  /**
436
432
  * List all defined entries from attributes.
437
433
  * return {object}
package/src/branch.mjs CHANGED
@@ -16,9 +16,13 @@ import { Commit } from "./commit.mjs";
16
16
  * @property {string} name
17
17
  */
18
18
  export class Branch extends Ref {
19
+
20
+ static get registerInstanceMethodName() {
21
+ return "_addBranch";
22
+ }
23
+
19
24
  constructor(repository, name = repository.defaultBranchName, options) {
20
25
  super(repository, name, options);
21
- repository._addBranch(this);
22
26
  }
23
27
 
24
28
  /**
@@ -38,6 +42,19 @@ export class Branch extends Ref {
38
42
  return "heads";
39
43
  }
40
44
 
45
+ /**
46
+ *
47
+ * @return true if not {@link isArchived} and {@link isDisabled} and {@link isLocked}
48
+ */
49
+ get isWritable() {
50
+ return (
51
+ !this.isArchived &&
52
+ !this.isDisabled &&
53
+ !this.isLocked &&
54
+ !this.isProtected
55
+ );
56
+ }
57
+
41
58
  /**
42
59
  * Are we the default branch.
43
60
  * @return {boolean} true if name matches the repository default branch
@@ -44,14 +44,7 @@ export class NamedObject extends BaseObject {
44
44
  get fullName() {
45
45
  return this.owner.name + "/" + this.name;
46
46
  }
47
-
48
- /**
49
- * @return {string} name
50
- */
51
- toString() {
52
- return this.name;
53
- }
54
-
47
+
55
48
  /**
56
49
  * Provide name and all defined attributes.
57
50
  */
package/src/ref.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { NamedObject } from "./named-object.mjs";
1
+ import { OwnedObject } from "./owned-object.mjs";
2
2
 
3
3
  /**
4
4
  * @typedef {Object} ContentEntry
@@ -9,7 +9,7 @@ import { NamedObject } from "./named-object.mjs";
9
9
  /**
10
10
  * Base for Branch and Tag
11
11
  */
12
- export class Ref extends NamedObject {
12
+ export class Ref extends OwnedObject {
13
13
  /**
14
14
  * options
15
15
  */
@@ -25,10 +25,6 @@ export class Ref extends NamedObject {
25
25
  };
26
26
  }
27
27
 
28
- constructor(repository, name, options) {
29
- super(name, options, { repository: { value: repository } });
30
- }
31
-
32
28
  /**
33
29
  * Check for equality.
34
30
  * @param {Ref} other
@@ -102,8 +98,8 @@ export class Ref extends NamedObject {
102
98
  * @see {@link Repository#owner}
103
99
  * @return {string}
104
100
  */
105
- get owner() {
106
- return this.repository.owner;
101
+ get repository() {
102
+ return this.owner;
107
103
  }
108
104
 
109
105
  get slug() {
@@ -191,17 +187,4 @@ export class Ref extends NamedObject {
191
187
  get isProtected() {
192
188
  return false;
193
189
  }
194
-
195
- /**
196
- *
197
- * @return true if not {@link isArchived} and {@link isDisabled} and {@link isLocked}
198
- */
199
- get isWritable() {
200
- return (
201
- !this.isArchived &&
202
- !this.isDisabled &&
203
- !this.isLocked &&
204
- !this.isProtected
205
- );
206
- }
207
190
  }
package/src/tag.mjs CHANGED
@@ -4,9 +4,9 @@ import { Ref } from "./ref.mjs";
4
4
  * Tag refs
5
5
  */
6
6
  export class Tag extends Ref {
7
- constructor(repository, name, options) {
8
- super(repository, name, options);
9
- repository._addTag(this);
7
+
8
+ static get registerInstanceMethodName() {
9
+ return "_addTag";
10
10
  }
11
11
 
12
12
  /**
@@ -15,13 +15,4 @@ export class Tag extends Ref {
15
15
  get refType() {
16
16
  return "tags";
17
17
  }
18
-
19
- /**
20
- * Tags cannot be written to.
21
- * @return {boolean} false
22
- */
23
- get isWritable()
24
- {
25
- return false;
26
- }
27
18
  }