repository-provider 28.3.11 → 28.3.12

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 (3) hide show
  1. package/README.md +75 -87
  2. package/package.json +2 -2
  3. package/src/ref.mjs +10 -10
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/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)
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)
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/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)
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)
11
11
 
12
12
  # repository-provider
13
13
 
@@ -66,6 +66,8 @@ console.log(await readme.getString());
66
66
  * [Parameters](#parameters-7)
67
67
  * [update](#update)
68
68
  * [toString](#tostring)
69
+ * [displayName](#displayname)
70
+ * [fullName](#fullname)
69
71
  * [isWritable](#iswritable)
70
72
  * [equals](#equals)
71
73
  * [Parameters](#parameters-8)
@@ -128,7 +130,6 @@ console.log(await readme.getString());
128
130
  * [pullRequests](#pullrequests)
129
131
  * [Parameters](#parameters-26)
130
132
  * [name](#name)
131
- * [fullName](#fullname)
132
133
  * [provider](#provider-1)
133
134
  * [url](#url)
134
135
  * [toJSON](#tojson)
@@ -196,25 +197,26 @@ console.log(await readme.getString());
196
197
  * [Properties](#properties-6)
197
198
  * [equals](#equals-2)
198
199
  * [Parameters](#parameters-46)
199
- * [displayName](#displayname)
200
200
  * [fullName](#fullname-1)
201
201
  * [toJSON](#tojson-2)
202
202
  * [OwnedObject](#ownedobject)
203
203
  * [Parameters](#parameters-47)
204
+ * [equals](#equals-3)
205
+ * [Parameters](#parameters-48)
204
206
  * [registerInstanceMethodName](#registerinstancemethodname)
205
207
  * [Project](#project)
206
208
  * [PullRequest](#pullrequest)
207
- * [Parameters](#parameters-48)
209
+ * [Parameters](#parameters-49)
208
210
  * [Properties](#properties-7)
209
211
  * [fullName](#fullname-2)
210
212
  * [url](#url-2)
211
213
  * [repository](#repository-1)
212
214
  * [provider](#provider-2)
213
- * [equals](#equals-3)
214
- * [Parameters](#parameters-49)
215
+ * [equals](#equals-4)
216
+ * [Parameters](#parameters-50)
215
217
  * [delete](#delete-1)
216
218
  * [merge](#merge)
217
- * [Parameters](#parameters-50)
219
+ * [Parameters](#parameters-51)
218
220
  * [decline](#decline)
219
221
  * [reviews](#reviews)
220
222
  * [identifier](#identifier)
@@ -222,9 +224,9 @@ console.log(await readme.getString());
222
224
  * [defaultListStates](#defaultliststates)
223
225
  * [validMergeMethods](#validmergemethods)
224
226
  * [list](#list-1)
225
- * [Parameters](#parameters-51)
226
- * [open](#open)
227
227
  * [Parameters](#parameters-52)
228
+ * [open](#open)
229
+ * [Parameters](#parameters-53)
228
230
  * [title](#title)
229
231
  * [body](#body)
230
232
  * [state](#state)
@@ -234,20 +236,17 @@ console.log(await readme.getString());
234
236
  * [ContentEntry](#contententry)
235
237
  * [Properties](#properties-8)
236
238
  * [Ref](#ref)
237
- * [Parameters](#parameters-53)
238
- * [equals](#equals-4)
239
- * [Parameters](#parameters-54)
240
239
  * [ref](#ref-1)
241
240
  * [refId](#refid)
242
- * [Parameters](#parameters-55)
241
+ * [Parameters](#parameters-54)
243
242
  * [entries](#entries)
244
- * [Parameters](#parameters-56)
243
+ * [Parameters](#parameters-55)
245
244
  * [asyncIterator](#asynciterator)
246
245
  * [maybeEntry](#maybeentry)
247
- * [Parameters](#parameters-57)
246
+ * [Parameters](#parameters-56)
248
247
  * [entry](#entry)
249
- * [Parameters](#parameters-58)
250
- * [owner](#owner)
248
+ * [Parameters](#parameters-57)
249
+ * [repository](#repository-2)
251
250
  * [fullName](#fullname-3)
252
251
  * [fullCondensedName](#fullcondensedname)
253
252
  * [identifier](#identifier-1)
@@ -261,27 +260,27 @@ console.log(await readme.getString());
261
260
  * [attributes](#attributes-1)
262
261
  * [isProtected](#isprotected-1)
263
262
  * [RepositoryGroup](#repositorygroup-1)
264
- * [Parameters](#parameters-59)
263
+ * [Parameters](#parameters-58)
265
264
  * [Properties](#properties-9)
266
265
  * [attributeMapping](#attributemapping-1)
267
266
  * [type](#type)
268
267
  * [url](#url-3)
269
268
  * [RepositoryOwner](#repositoryowner)
269
+ * [Parameters](#parameters-59)
270
+ * [Repository](#repository-3)
270
271
  * [Parameters](#parameters-60)
271
- * [Repository](#repository-2)
272
- * [Parameters](#parameters-61)
273
272
  * [Properties](#properties-10)
274
273
  * [fullName](#fullname-4)
275
274
  * [slug](#slug)
276
275
  * [identifier](#identifier-2)
277
276
  * [entry](#entry-1)
278
- * [Parameters](#parameters-62)
277
+ * [Parameters](#parameters-61)
279
278
  * [entries](#entries-1)
280
- * [Parameters](#parameters-63)
279
+ * [Parameters](#parameters-62)
281
280
  * [maybeEntry](#maybeentry-1)
282
- * [Parameters](#parameters-64)
281
+ * [Parameters](#parameters-63)
283
282
  * [commits](#commits)
284
- * [Parameters](#parameters-65)
283
+ * [Parameters](#parameters-64)
285
284
  * [urls](#urls)
286
285
  * [url](#url-4)
287
286
  * [cloneURL](#cloneurl)
@@ -295,40 +294,40 @@ console.log(await readme.getString());
295
294
  * [delete](#delete-2)
296
295
  * [defaultBranch](#defaultbranch)
297
296
  * [branch](#branch-2)
298
- * [Parameters](#parameters-66)
297
+ * [Parameters](#parameters-65)
299
298
  * [branches](#branches-1)
300
- * [Parameters](#parameters-67)
299
+ * [Parameters](#parameters-66)
301
300
  * [createBranch](#createbranch-1)
302
- * [Parameters](#parameters-68)
301
+ * [Parameters](#parameters-67)
303
302
  * [addBranch](#addbranch)
304
- * [Parameters](#parameters-69)
303
+ * [Parameters](#parameters-68)
305
304
  * [deleteBranch](#deletebranch)
306
- * [Parameters](#parameters-70)
305
+ * [Parameters](#parameters-69)
307
306
  * [tag](#tag)
308
- * [Parameters](#parameters-71)
307
+ * [Parameters](#parameters-70)
309
308
  * [tags](#tags-1)
310
- * [Parameters](#parameters-72)
309
+ * [Parameters](#parameters-71)
311
310
  * [addTag](#addtag)
312
- * [Parameters](#parameters-73)
311
+ * [Parameters](#parameters-72)
313
312
  * [createPullRequest](#createpullrequest-1)
314
- * [Parameters](#parameters-74)
313
+ * [Parameters](#parameters-73)
315
314
  * [addPullRequest](#addpullrequest)
316
- * [Parameters](#parameters-75)
315
+ * [Parameters](#parameters-74)
317
316
  * [pullRequests](#pullrequests-1)
318
317
  * [pullRequest](#pullrequest-1)
319
- * [Parameters](#parameters-76)
318
+ * [Parameters](#parameters-75)
320
319
  * [deletePullRequest](#deletepullrequest)
321
- * [Parameters](#parameters-77)
320
+ * [Parameters](#parameters-76)
322
321
  * [addHook](#addhook)
323
- * [Parameters](#parameters-78)
322
+ * [Parameters](#parameters-77)
324
323
  * [createHook](#createhook)
325
- * [Parameters](#parameters-79)
324
+ * [Parameters](#parameters-78)
326
325
  * [hooks](#hooks-1)
327
326
  * [hook](#hook-1)
328
- * [Parameters](#parameters-80)
327
+ * [Parameters](#parameters-79)
329
328
  * [type](#type-1)
330
329
  * [refId](#refid-1)
331
- * [Parameters](#parameters-81)
330
+ * [Parameters](#parameters-80)
332
331
  * [toString](#tostring-2)
333
332
  * [toJSON](#tojson-3)
334
333
  * [attributes](#attributes-2)
@@ -337,23 +336,22 @@ console.log(await readme.getString());
337
336
  * [issuesURL](#issuesurl-2)
338
337
  * [Review](#review)
339
338
  * [SingleGroupProvider](#singlegroupprovider)
340
- * [repository](#repository-3)
341
- * [Parameters](#parameters-82)
339
+ * [repository](#repository-4)
340
+ * [Parameters](#parameters-81)
342
341
  * [repositoryGroup](#repositorygroup-2)
343
- * [Parameters](#parameters-83)
342
+ * [Parameters](#parameters-82)
344
343
  * [repositoryGroups](#repositorygroups-1)
345
- * [Parameters](#parameters-84)
344
+ * [Parameters](#parameters-83)
346
345
  * [Tag](#tag-1)
347
- * [Parameters](#parameters-85)
348
346
  * [refType](#reftype-1)
349
347
  * [asArray](#asarray)
350
- * [Parameters](#parameters-86)
348
+ * [Parameters](#parameters-84)
351
349
  * [stripBaseName](#stripbasename)
352
- * [Parameters](#parameters-87)
350
+ * [Parameters](#parameters-85)
353
351
  * [stripBaseNames](#stripbasenames)
354
- * [Parameters](#parameters-88)
352
+ * [Parameters](#parameters-86)
355
353
  * [generateBranchName](#generatebranchname)
356
- * [Parameters](#parameters-89)
354
+ * [Parameters](#parameters-87)
357
355
 
358
356
  ## Application
359
357
 
@@ -494,6 +492,18 @@ Save object attributes in the backing store.
494
492
 
495
493
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name
496
494
 
495
+ ### displayName
496
+
497
+ Beautified name use for human displaying only.
498
+
499
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
500
+
501
+ ### fullName
502
+
503
+ Complete name in the hierachy.
504
+
505
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
506
+
497
507
  ### isWritable
498
508
 
499
509
  By default cannot be written to.
@@ -824,10 +834,6 @@ Deliver the provider name.
824
834
 
825
835
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** class name by default
826
836
 
827
- ### fullName
828
-
829
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name
830
-
831
837
  ### provider
832
838
 
833
839
  We are our own provider.
@@ -1178,12 +1184,6 @@ Check for equality.
1178
1184
 
1179
1185
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if names are equal and have the same owner
1180
1186
 
1181
- ### displayName
1182
-
1183
- Beautified name use for human displaying only.
1184
-
1185
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
1186
-
1187
1187
  ### fullName
1188
1188
 
1189
1189
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name with owner name
@@ -1205,6 +1205,16 @@ Named Object registering itself in the owner.
1205
1205
  * `options`
1206
1206
  * `additionalProperties`
1207
1207
 
1208
+ ### equals
1209
+
1210
+ Check for equality.
1211
+
1212
+ #### Parameters
1213
+
1214
+ * `other` **[OwnedObject](#ownedobject)**
1215
+
1216
+ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if receiver and owner are equal
1217
+
1208
1218
  ### registerInstanceMethodName
1209
1219
 
1210
1220
  Method name to be called to register one instance in the owner.
@@ -1400,26 +1410,10 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
1400
1410
 
1401
1411
  ## Ref
1402
1412
 
1403
- **Extends NamedObject**
1413
+ **Extends OwnedObject**
1404
1414
 
1405
1415
  Base for Branch and Tag
1406
1416
 
1407
- ### Parameters
1408
-
1409
- * `repository`
1410
- * `name`
1411
- * `options`
1412
-
1413
- ### equals
1414
-
1415
- Check for equality.
1416
-
1417
- #### Parameters
1418
-
1419
- * `other` **[Ref](#ref)**
1420
-
1421
- Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name and repository are equal
1422
-
1423
1417
  ### ref
1424
1418
 
1425
1419
  Full ref path.
@@ -1472,7 +1466,7 @@ Get exactly one matching entry by name (throws if entry is not found).
1472
1466
 
1473
1467
  Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>**
1474
1468
 
1475
- ### owner
1469
+ ### repository
1476
1470
 
1477
1471
  * **See**: [Repository#owner](Repository#owner)
1478
1472
 
@@ -1594,7 +1588,7 @@ Mixin to define a class able to handle a collection of repositories.
1594
1588
 
1595
1589
  ## Repository
1596
1590
 
1597
- **Extends NamedObject**
1591
+ **Extends OwnedObject**
1598
1592
 
1599
1593
  Abstract repository
1600
1594
 
@@ -2008,12 +2002,6 @@ Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** always deliver th
2008
2002
 
2009
2003
  Tag refs
2010
2004
 
2011
- ### Parameters
2012
-
2013
- * `repository`
2014
- * `name`
2015
- * `options`
2016
-
2017
2005
  ### refType
2018
2006
 
2019
2007
  Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "repository-provider",
3
- "version": "28.3.11",
3
+ "version": "28.3.12",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -36,7 +36,7 @@
36
36
  "ava": "^4.2.0",
37
37
  "c8": "^7.11.2",
38
38
  "documentation": "^13.2.5",
39
- "repository-provider-test-support": "^2.1.8",
39
+ "repository-provider-test-support": "^2.1.9",
40
40
  "semantic-release": "^19.0.2",
41
41
  "typescript": "^4.6.3"
42
42
  },
package/src/ref.mjs CHANGED
@@ -43,7 +43,7 @@ export class Ref extends OwnedObject {
43
43
  * @return {Promise<string>} sha of the ref
44
44
  */
45
45
  async refId(ref = this.ref) {
46
- return this.repository.refId(ref);
46
+ return this.owner.refId(ref);
47
47
  }
48
48
 
49
49
  /**
@@ -94,7 +94,7 @@ export class Ref extends OwnedObject {
94
94
  }
95
95
 
96
96
  get slug() {
97
- return this.repository.slug;
97
+ return this.owner.slug;
98
98
  }
99
99
 
100
100
  /**
@@ -102,7 +102,7 @@ export class Ref extends OwnedObject {
102
102
  * @return {string} 'repo#branch'
103
103
  */
104
104
  get fullName() {
105
- return `${this.repository.fullName}#${this.name}`;
105
+ return `${this.owner.fullName}#${this.name}`;
106
106
  }
107
107
 
108
108
  /**
@@ -112,8 +112,8 @@ export class Ref extends OwnedObject {
112
112
  */
113
113
  get fullCondensedName() {
114
114
  return this.isDefault
115
- ? this.repository.fullName
116
- : `${this.repository.fullName}#${this.name}`;
115
+ ? this.owner.fullName
116
+ : `${this.owner.fullName}#${this.name}`;
117
117
  }
118
118
 
119
119
  /**
@@ -138,7 +138,7 @@ export class Ref extends OwnedObject {
138
138
  * @return {string} as provided from the repository
139
139
  */
140
140
  get issuesURL() {
141
- return this.repository.issuesURL;
141
+ return this.owner.issuesURL;
142
142
  }
143
143
 
144
144
  /**
@@ -147,28 +147,28 @@ export class Ref extends OwnedObject {
147
147
  * @return {string} as provided from the repository
148
148
  */
149
149
  get homePageURL() {
150
- return this.repository.homePageURL;
150
+ return this.owner.homePageURL;
151
151
  }
152
152
 
153
153
  /**
154
154
  * Forwarded from the repository
155
155
  */
156
156
  get isLocked() {
157
- return this.repository.isLocked;
157
+ return this.owner.isLocked;
158
158
  }
159
159
 
160
160
  /**
161
161
  * Forwarded from the repository
162
162
  */
163
163
  get isArchived() {
164
- return this.repository.isArchived;
164
+ return this.owner.isArchived;
165
165
  }
166
166
 
167
167
  /**
168
168
  * Forwarded from the repository
169
169
  */
170
170
  get isDisabled() {
171
- return this.repository.isDisabled;
171
+ return this.owner.isDisabled;
172
172
  }
173
173
 
174
174
  /**