bitbucket-repository-provider 4.3.0 → 4.3.2

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 (2) hide show
  1. package/README.md +40 -42
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -44,7 +44,7 @@ repository provider for bitbucket
44
44
  * [areOptionsSufficcient](#areoptionssufficcient)
45
45
  * [Parameters](#parameters-4)
46
46
  * [BitbucketPullRequest](#bitbucketpullrequest)
47
- * [\_merge](#\_merge)
47
+ * [\_merge](#_merge)
48
48
  * [Parameters](#parameters-5)
49
49
  * [list](#list)
50
50
  * [Parameters](#parameters-6)
@@ -79,15 +79,15 @@ Branch of a bitbucket repository.
79
79
 
80
80
  #### Parameters
81
81
 
82
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
82
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
83
83
 
84
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>**
84
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>**&#x20;
85
85
 
86
86
  ### entries
87
87
 
88
88
  #### Parameters
89
89
 
90
- * `patterns`
90
+ * `patterns` &#x20;
91
91
 
92
92
  ### commit
93
93
 
@@ -97,9 +97,9 @@ Commit entries
97
97
 
98
98
  * `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
99
99
  * `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>** content to be commited
100
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
100
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
101
101
 
102
- Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
102
+ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**&#x20;
103
103
 
104
104
  ### attributes
105
105
 
@@ -107,7 +107,7 @@ options
107
107
 
108
108
  ## hash
109
109
 
110
- Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
110
+ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
111
111
 
112
112
  ## BitbucketHook
113
113
 
@@ -125,26 +125,24 @@ Supported name schemes are
125
125
  * git+<https://user:aSecret@bitbucket.org/owner/repo-name.git>
126
126
  * <git@bitbucket.org>:owner/repo-name.git
127
127
  * owner/repo-name
128
-
129
- Known environment variables
130
-
131
- * BITBUCKET_API api
132
- * BITBUCKET_TOKEN api token
133
- * BITBUCKET_USERNAME username
134
- * BITBUCKET_APP_PASSWORD password
135
- * BITBUCKET_PASSWORD password
128
+ Known environment variables
129
+ * BITBUCKET\_API api
130
+ * BITBUCKET\_TOKEN api token
131
+ * BITBUCKET\_USERNAME username
132
+ * BITBUCKET\_APP\_PASSWORD password
133
+ * BITBUCKET\_PASSWORD password
136
134
 
137
135
  ### Parameters
138
136
 
139
- * `config` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
137
+ * `config` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
140
138
 
141
139
  * `config.url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** provider scm base
142
140
  * `config.api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** provider api base
143
141
  * `config.authentication` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** authentication
144
142
 
145
- * `config.authentication.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
146
- * `config.authentication.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
147
- * `config.authentication.password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
143
+ * `config.authentication.type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
144
+ * `config.authentication.username` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
145
+ * `config.authentication.password` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
148
146
 
149
147
  ### repositoryGroupClass
150
148
 
@@ -190,13 +188,13 @@ Default instance env name prefix.
190
188
 
191
189
  Default configuration as given for the cloud privider.
192
190
 
193
- Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
191
+ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
194
192
 
195
193
  ### areOptionsSufficcient
196
194
 
197
195
  #### Parameters
198
196
 
199
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
197
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
200
198
 
201
199
  Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if authentication is present
202
200
 
@@ -221,14 +219,14 @@ Result will be filtered by source branch, destination branch and states
221
219
 
222
220
  #### Parameters
223
221
 
224
- * `repository` **Repository**
222
+ * `repository` **Repository**&#x20;
225
223
  * `filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)
226
224
 
227
- * `filter.source` **Branch?**
228
- * `filter.destination` **Branch?**
229
- * `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**
225
+ * `filter.source` **Branch?**&#x20;
226
+ * `filter.destination` **Branch?**&#x20;
227
+ * `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**&#x20;
230
228
 
231
- Returns **Iterator\<PullRequest>**
229
+ Returns **Iterator\<PullRequest>**&#x20;
232
230
 
233
231
  ### open
234
232
 
@@ -236,9 +234,9 @@ Returns **Iterator\<PullRequest>**
236
234
 
237
235
  #### Parameters
238
236
 
239
- * `source`
240
- * `destination`
241
- * `options`
237
+ * `source` &#x20;
238
+ * `destination` &#x20;
239
+ * `options` &#x20;
242
240
 
243
241
  ## BitbucketRepositoryGroup
244
242
 
@@ -250,8 +248,8 @@ Returns **Iterator\<PullRequest>**
250
248
 
251
249
  #### Parameters
252
250
 
253
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
254
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
251
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
252
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
255
253
 
256
254
  Returns **Repository** newly created repository
257
255
 
@@ -263,18 +261,18 @@ a repository hosted on bitbucket
263
261
 
264
262
  ### Parameters
265
263
 
266
- * `owner` **Owner**
267
- * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
268
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
264
+ * `owner` **Owner**&#x20;
265
+ * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
266
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
269
267
 
270
- * `options.api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**
271
- * `options.group` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**
268
+ * `options.api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
269
+ * `options.group` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?**&#x20;
272
270
 
273
271
  ### Properties
274
272
 
275
- * `api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
276
- * `group` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
277
- * `user` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
273
+ * `api` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
274
+ * `group` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
275
+ * `user` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
278
276
 
279
277
  ### urls
280
278
 
@@ -311,9 +309,9 @@ Create a new branch
311
309
 
312
310
  * `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the new branch to create
313
311
  * `from` **[BitbucketBranch](#bitbucketbranch)** (optional, default `this.defaultBranch`)
314
- * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
312
+ * `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
315
313
 
316
- * `options.message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
314
+ * `options.message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
317
315
 
318
316
  ### deleteBranch
319
317
 
@@ -322,7 +320,7 @@ Create a new branch
322
320
 
323
321
  #### Parameters
324
322
 
325
- * `name`
323
+ * `name` &#x20;
326
324
 
327
325
  # install
328
326
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bitbucket-repository-provider",
3
- "version": "4.3.0",
3
+ "version": "4.3.2",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -30,22 +30,22 @@
30
30
  "lint:docs": "documentation lint ./src/**/*.mjs"
31
31
  },
32
32
  "dependencies": {
33
- "content-entry": "^5.2.3",
33
+ "content-entry": "^5.2.5",
34
34
  "fetch-rate-limit-util": "^3.0.16",
35
- "matching-iterator": "^2.0.7",
35
+ "matching-iterator": "^2.0.8",
36
36
  "node-fetch": "^3.2.10",
37
37
  "one-time-execution-method": "^3.0.4",
38
38
  "repository-provider": "^32.0.6"
39
39
  },
40
40
  "devDependencies": {
41
- "ava": "^4.3.1",
41
+ "ava": "^4.3.3",
42
42
  "c8": "^7.12.0",
43
43
  "documentation": "^14.0.0",
44
44
  "repository-provider-test-support": "^2.2.13",
45
- "semantic-release": "^19.0.3"
45
+ "semantic-release": "^19.0.5"
46
46
  },
47
47
  "engines": {
48
- "node": ">=16.17.0"
48
+ "node": ">=16.17.1"
49
49
  },
50
50
  "repository": {
51
51
  "type": "git",