@forge/api 0.0.0-experimental-d06c35b → 0.0.0-experimental-64caa5a
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/CHANGELOG.md +86 -1
- package/out/api/index.d.ts.map +1 -1
- package/out/api/index.js +13 -3
- package/out/index.d.ts +18 -4
- package/out/index.d.ts.map +1 -1
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,91 @@
|
|
|
1
1
|
# @forge/api
|
|
2
2
|
|
|
3
|
-
## 0.0.0-experimental-
|
|
3
|
+
## 0.0.0-experimental-64caa5a
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 8571c05: Add support for multiple accounts in external authentication
|
|
8
|
+
|
|
9
|
+
## 2.6.0-next.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- 8571c05: Add support for multiple accounts in external authentication
|
|
14
|
+
|
|
15
|
+
## 2.5.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- 70e9c8c: Enable auth providers api
|
|
20
|
+
|
|
21
|
+
### Patch Changes
|
|
22
|
+
|
|
23
|
+
- 32d11d1: Fix types on external auth APIs
|
|
24
|
+
|
|
25
|
+
## 2.5.0-next.1
|
|
26
|
+
|
|
27
|
+
### Patch Changes
|
|
28
|
+
|
|
29
|
+
- 32d11d1: Fix types on external auth APIs
|
|
30
|
+
|
|
31
|
+
## 2.5.0-next.0
|
|
32
|
+
|
|
33
|
+
### Minor Changes
|
|
34
|
+
|
|
35
|
+
- df2cd2f: Enable auth providers api
|
|
36
|
+
|
|
37
|
+
## 2.4.0
|
|
38
|
+
|
|
39
|
+
## 2.4.0-next.0
|
|
40
|
+
|
|
41
|
+
### Minor Changes
|
|
42
|
+
|
|
43
|
+
- de02d45: Enable auth providers api
|
|
44
|
+
|
|
45
|
+
## 2.3.0
|
|
46
|
+
|
|
47
|
+
### Minor Changes
|
|
48
|
+
|
|
49
|
+
- 0d7fe27: Support secret storage API
|
|
50
|
+
|
|
51
|
+
### Patch Changes
|
|
52
|
+
|
|
53
|
+
- df58629: Allow custom headers in requestGraph
|
|
54
|
+
- Updated dependencies [0d7fe27]
|
|
55
|
+
- @forge/storage@1.1.0
|
|
56
|
+
|
|
57
|
+
## 2.3.0-next.1
|
|
58
|
+
|
|
59
|
+
### Patch Changes
|
|
60
|
+
|
|
61
|
+
- df58629: Allow custom headers in requestGraph
|
|
62
|
+
|
|
63
|
+
## 2.3.0-next.0
|
|
64
|
+
|
|
65
|
+
### Minor Changes
|
|
66
|
+
|
|
67
|
+
- 0d7fe27: Support secret storage API
|
|
68
|
+
|
|
69
|
+
### Patch Changes
|
|
70
|
+
|
|
71
|
+
- Updated dependencies [0d7fe27]
|
|
72
|
+
- @forge/storage@1.1.0-next.0
|
|
73
|
+
|
|
74
|
+
## 2.2.1
|
|
75
|
+
|
|
76
|
+
### Patch Changes
|
|
77
|
+
|
|
78
|
+
- Updated dependencies [0700578]
|
|
79
|
+
- @forge/storage@1.0.5
|
|
80
|
+
|
|
81
|
+
## 2.2.1-next.0
|
|
82
|
+
|
|
83
|
+
### Patch Changes
|
|
84
|
+
|
|
85
|
+
- Updated dependencies [0700578]
|
|
86
|
+
- @forge/storage@1.0.5-next.0
|
|
87
|
+
|
|
88
|
+
## 2.2.0
|
|
4
89
|
|
|
5
90
|
### Minor Changes
|
|
6
91
|
|
package/out/api/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EACL,QAAQ,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EACL,QAAQ,EAQT,MAAM,IAAI,CAAC;AACZ,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAIxD,oBAAY,YAAY,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,GAAG,CAAC;AAsBjG,eAAO,MAAM,mBAAmB,QAAS,GAAG,aAAa,YAAY,KAAG,QA+BvE,CAAC"}
|
package/out/api/index.js
CHANGED
|
@@ -4,9 +4,9 @@ exports.wrapFetchApiMethods = void 0;
|
|
|
4
4
|
var polyfill_response_1 = require("./polyfill-response");
|
|
5
5
|
Object.defineProperty(exports, "transformResponse", { enumerable: true, get: function () { return polyfill_response_1.transformResponse; } });
|
|
6
6
|
const safeUrl_1 = require("../safeUrl");
|
|
7
|
-
const wrapRequestGraph = (requestGraphApi) => (query, variables) => requestGraphApi('/graphql', {
|
|
7
|
+
const wrapRequestGraph = (requestGraphApi) => (query, variables, headers = {}) => requestGraphApi('/graphql', {
|
|
8
8
|
method: 'POST',
|
|
9
|
-
headers: { 'Content-Type': 'application/json' },
|
|
9
|
+
headers: Object.assign(Object.assign({}, headers), { 'Content-Type': 'application/json' }),
|
|
10
10
|
body: JSON.stringify(Object.assign({ query }, (variables ? { variables } : {})))
|
|
11
11
|
});
|
|
12
12
|
const wrapRequestProduct = (requestProduct) => (path, init) => {
|
|
@@ -25,7 +25,17 @@ exports.wrapFetchApiMethods = (api, wrapFetch) => {
|
|
|
25
25
|
asUser: () => ({
|
|
26
26
|
requestJira: wrapRequestProduct(wrapFetch(api.asUser().requestJira)),
|
|
27
27
|
requestConfluence: wrapRequestProduct(wrapFetch(api.asUser().requestConfluence)),
|
|
28
|
-
requestGraph: wrapRequestGraph(wrapFetch(api.asUser().requestGraph))
|
|
28
|
+
requestGraph: wrapRequestGraph(wrapFetch(api.asUser().requestGraph)),
|
|
29
|
+
withProvider: (provider, remoteName, tokenId) => {
|
|
30
|
+
const { hasCredentials, requestCredentials, listCredentials, fetch: withProviderFetch } = api.asUser().withProvider(provider, remoteName, tokenId);
|
|
31
|
+
const wrappedRequestRemote = wrapWithRouteUnwrapper(wrapFetch(withProviderFetch));
|
|
32
|
+
return {
|
|
33
|
+
hasCredentials,
|
|
34
|
+
requestCredentials,
|
|
35
|
+
listCredentials,
|
|
36
|
+
fetch: wrappedRequestRemote
|
|
37
|
+
};
|
|
38
|
+
}
|
|
29
39
|
}),
|
|
30
40
|
asApp: () => ({
|
|
31
41
|
requestJira: wrapRequestProduct(wrapFetch(api.asApp().requestJira)),
|
package/out/index.d.ts
CHANGED
|
@@ -13,7 +13,16 @@ export interface RequestProductMethods {
|
|
|
13
13
|
requestConfluence: RequestProductMethod;
|
|
14
14
|
}
|
|
15
15
|
export interface GraphQLFetchMethods {
|
|
16
|
-
requestGraph: (query: string, variables?: any) => Promise<APIResponse>;
|
|
16
|
+
requestGraph: (query: string, variables?: any, headers?: Record<string, any>) => Promise<APIResponse>;
|
|
17
|
+
}
|
|
18
|
+
export interface ExternalAuthFetchMethods {
|
|
19
|
+
hasCredentials: () => Promise<boolean>;
|
|
20
|
+
requestCredentials: () => Promise<boolean>;
|
|
21
|
+
listCredentials: () => Promise<string[]>;
|
|
22
|
+
fetch: FetchMethodAllowingRoute;
|
|
23
|
+
}
|
|
24
|
+
export interface ExternalAuthFetchMethodsProvider {
|
|
25
|
+
withProvider: (provider: string, remoteName?: string, tokenId?: string) => ExternalAuthFetchMethods;
|
|
17
26
|
}
|
|
18
27
|
export interface StorageMethods {
|
|
19
28
|
get: (key: string) => Promise<any>;
|
|
@@ -28,6 +37,11 @@ export interface PropertiesAPI {
|
|
|
28
37
|
}
|
|
29
38
|
export interface StorageAPI extends StorageMethods, QueryApi {
|
|
30
39
|
}
|
|
40
|
+
export interface ForgeStorageAPI extends StorageAPI {
|
|
41
|
+
getSecret: (key: string) => Promise<any>;
|
|
42
|
+
setSecret: (key: string, value: any) => Promise<void>;
|
|
43
|
+
deleteSecret: (key: string) => Promise<void>;
|
|
44
|
+
}
|
|
31
45
|
export interface StoreAPI extends PropertiesAPI {
|
|
32
46
|
onJiraProject: (context: string) => StorageMethods;
|
|
33
47
|
onJiraIssue: (context: string) => StorageMethods;
|
|
@@ -35,20 +49,20 @@ export interface StoreAPI extends PropertiesAPI {
|
|
|
35
49
|
onConfluenceSpace: (context: string) => StorageMethods;
|
|
36
50
|
}
|
|
37
51
|
export interface FetchAPI extends RequestProductMethods {
|
|
38
|
-
asUser(): RequestProductMethods & GraphQLFetchMethods;
|
|
52
|
+
asUser(): RequestProductMethods & GraphQLFetchMethods & ExternalAuthFetchMethodsProvider;
|
|
39
53
|
asApp(): RequestProductMethods & GraphQLFetchMethods;
|
|
40
54
|
fetch: FetchMethodAllowingRoute;
|
|
41
55
|
}
|
|
42
56
|
export interface ForgeAPI extends FetchAPI {
|
|
43
57
|
store: StoreAPI;
|
|
44
58
|
}
|
|
45
|
-
declare const asUser: () => RequestProductMethods & GraphQLFetchMethods;
|
|
59
|
+
declare const asUser: () => RequestProductMethods & GraphQLFetchMethods & ExternalAuthFetchMethodsProvider;
|
|
46
60
|
declare const asApp: () => RequestProductMethods & GraphQLFetchMethods;
|
|
47
61
|
declare const fetch: FetchMethodAllowingRoute;
|
|
48
62
|
declare const requestJira: RequestProductMethod;
|
|
49
63
|
declare const requestConfluence: RequestProductMethod;
|
|
50
64
|
declare const store: PropertiesAPI;
|
|
51
|
-
declare const storage:
|
|
65
|
+
declare const storage: ForgeStorageAPI;
|
|
52
66
|
declare const properties: PropertiesAPI;
|
|
53
67
|
declare const API: ForgeAPI;
|
|
54
68
|
export declare const privacy: {
|
package/out/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAA8C,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAGtF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,oBAAY,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,GAAG,YAAY,GAAG,SAAS,CAAC,CAAC;AACvH,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AACpF,oBAAY,wBAAwB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AACzG,oBAAY,oBAAoB,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAC5F,oBAAY,YAAY,GAAG,WAAW,CAAC;AAEvC,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,oBAAoB,CAAC;IAClC,iBAAiB,EAAE,oBAAoB,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EAA8C,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAGtF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,oBAAY,WAAW,GAAG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,QAAQ,GAAG,YAAY,GAAG,SAAS,CAAC,CAAC;AACvH,oBAAY,WAAW,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AACpF,oBAAY,wBAAwB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AACzG,oBAAY,oBAAoB,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;AAC5F,oBAAY,YAAY,GAAG,WAAW,CAAC;AAEvC,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,oBAAoB,CAAC;IAClC,iBAAiB,EAAE,oBAAoB,CAAC;CACzC;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,WAAW,CAAC,CAAC;CACvG;AAED,MAAM,WAAW,wBAAwB;IACvC,cAAc,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACvC,kBAAkB,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3C,eAAe,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACzC,KAAK,EAAE,wBAAwB,CAAC;CACjC;AAED,MAAM,WAAW,gCAAgC;IAC/C,YAAY,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,wBAAwB,CAAC;CACrG;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACxC;AAED,MAAM,WAAW,aAAa;IAC5B,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,CAAC;IACnD,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,CAAC;IACjD,gBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,CAAC;IACtD,iBAAiB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,CAAC;CACxD;AAED,MAAM,WAAW,UAAW,SAAQ,cAAc,EAAE,QAAQ;CAAG;AAE/D,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9C;AAMD,MAAM,WAAW,QAAS,SAAQ,aAAa;IAK7C,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,CAAC;IAMnD,WAAW,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,CAAC;IAMjD,gBAAgB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,CAAC;IAMtD,iBAAiB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,cAAc,CAAC;CACxD;AAED,MAAM,WAAW,QAAS,SAAQ,qBAAqB;IACrD,MAAM,IAAI,qBAAqB,GAAG,mBAAmB,GAAG,gCAAgC,CAAC;IACzF,KAAK,IAAI,qBAAqB,GAAG,mBAAmB,CAAC;IACrD,KAAK,EAAE,wBAAwB,CAAC;CACjC;AAED,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC,KAAK,EAAE,QAAQ,CAAC;CACjB;AAaD,QAAA,MAAM,MAAM,QApBA,qBAAqB,GAAG,mBAAmB,GAAG,gCAoB5B,CAAC;AAC/B,QAAA,MAAM,KAAK,QApBA,qBAAqB,GAAG,mBAoBP,CAAC;AAC7B,QAAA,MAAM,KAAK,0BAAiB,CAAC;AAC7B,QAAA,MAAM,WAAW,sBAAuB,CAAC;AACzC,QAAA,MAAM,iBAAiB,sBAA6B,CAAC;AAerD,QAAA,MAAM,KAAK,eAA0B,CAAC;AACtC,QAAA,MAAM,OAAO,EAAE,eAEd,CAAC;AAEF,QAAA,MAAM,UAAU,EAAE,aAA6B,CAAC;AAEhD,QAAA,MAAM,GAAG,EAAE,QAGV,CAAC;AAEF,eAAO,MAAM,OAAO;;CAEnB,CAAC;AAEF,eAAe,GAAG,CAAC;AACnB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,CAAC;AACnH,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AACzG,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@forge/api",
|
|
3
|
-
"version": "0.0.0-experimental-
|
|
3
|
+
"version": "0.0.0-experimental-64caa5a",
|
|
4
4
|
"description": "Forge API methods",
|
|
5
5
|
"author": "Atlassian",
|
|
6
6
|
"license": "UNLICENSED",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
},
|
|
17
17
|
"dependencies": {
|
|
18
18
|
"@forge/auth": "^0.0.1",
|
|
19
|
-
"@forge/storage": "^1.0
|
|
19
|
+
"@forge/storage": "^1.1.0",
|
|
20
20
|
"@types/node-fetch": "^2.5.7",
|
|
21
21
|
"node-fetch": "^2.6.1"
|
|
22
22
|
}
|