@forge/api 3.2.0-next.4-experimental-cf84ac7 → 3.2.0

package/CHANGELOG.md

@@ -1,12 +1,13 @@
 # @forge/api
 
-## 3.2.0-next.4-experimental-cf84ac7
+## 3.2.0
 
 ### Minor Changes
 
 - e343baf: Add external auth info to metadata for invocations
 - d36502b: This change extends existing methods on external auth providers. We are now providing account details including: externalAccountId, displayName, avatarUrl, granted scopes.
   Moreover, if end user authenticates multiple accounts, it is possible to select what account to use.
+- ea39472: Implement External auth APIs for Node runtime
 
 ### Patch Changes
 
@@ -17,9 +18,15 @@
 - Updated dependencies [5b82e7f]
 - Updated dependencies [882be11]
 - Updated dependencies [32fa518]
-  - @forge/util@1.4.1-next.0-experimental-cf84ac7
-  - @forge/egress@1.2.13-next.0-experimental-cf84ac7
-  - @forge/storage@1.5.15-next.0-experimental-cf84ac7
+  - @forge/util@1.4.1
+  - @forge/egress@1.2.13
+  - @forge/storage@1.5.15
+
+## 3.2.0-next.5
+
+### Minor Changes
+
+- ea39472: Implement External auth APIs for Node runtime
 
 ## 3.2.0-next.4
 

package/out/api/fetch.d.ts

@@ -2,12 +2,19 @@ import { RequestInit } from 'node-fetch';
 import { FetchAPI, FetchMethod } from '..';
 declare type AuthProvider = 'app' | 'user' | 'none';
 declare type RemoteAPI = 'jira' | 'confluence' | 'stargate' | 'bitbucket';
+declare type ExternalAuthProvider = string;
+declare type ExternalAuthRemote = string;
 declare type FetchArgs = {
     provider: AuthProvider;
     remote: RemoteAPI;
 };
+declare type ExternalAuthFetchArgs = {
+    provider: ExternalAuthProvider;
+    remote: ExternalAuthRemote;
+};
 export declare function fetchProduct(args: FetchArgs): FetchMethod;
-export declare const addMagicAgent: (init?: RequestInit) => RequestInit;
+export declare function fetchRemote(args: ExternalAuthFetchArgs): FetchMethod;
+export declare const addMagicAgent: (init?: RequestInit, agentOverride?: string) => RequestInit;
 export declare function getNodeRuntimeAPI(): FetchAPI;
 export declare function getSandboxRuntimeAPI(api: any): FetchAPI;
 export {};

package/out/api/fetch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/api/fetch.ts"],"names":[],"mappings":"AAEA,OAAc,EAAE,WAAW,EAAY,MAAM,YAAY,CAAC;AAS1D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAI3C,aAAK,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAC5C,aAAK,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAElE,aAAK,SAAS,GAAG;IAAE,QAAQ,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC;AAS/D,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW,CAkBzD;AAgCD,eAAO,MAAM,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,KAAK,WAGlD,CAAC;AAOH,wBAAgB,iBAAiB,IAAI,QAAQ,CAsB5C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAEvD"}
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../../src/api/fetch.ts"],"names":[],"mappings":"AAEA,OAAc,EAAE,WAAW,EAAY,MAAM,YAAY,CAAC;AAS1D,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,IAAI,CAAC;AAK3C,aAAK,YAAY,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;AAC5C,aAAK,SAAS,GAAG,MAAM,GAAG,YAAY,GAAG,UAAU,GAAG,WAAW,CAAC;AAElE,aAAK,oBAAoB,GAAG,MAAM,CAAC;AACnC,aAAK,kBAAkB,GAAG,MAAM,CAAC;AAEjC,aAAK,SAAS,GAAG;IAAE,QAAQ,EAAE,YAAY,CAAC;IAAC,MAAM,EAAE,SAAS,CAAA;CAAE,CAAC;AAC/D,aAAK,qBAAqB,GAAG;IAAE,QAAQ,EAAE,oBAAoB,CAAC;IAAC,MAAM,EAAE,kBAAkB,CAAA;CAAE,CAAC;AAS5F,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,WAAW,CAkBzD;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,qBAAqB,GAAG,WAAW,CAWpE;AAqDD,eAAO,MAAM,aAAa,EAAE,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,MAAM,KAAK,WAG1E,CAAC;AA0BH,wBAAgB,iBAAiB,IAAI,QAAQ,CAsB5C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,GAAG,GAAG,QAAQ,CAEvD"}

package/out/api/fetch.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSandboxRuntimeAPI = exports.getNodeRuntimeAPI = exports.addMagicAgent = exports.fetchProduct = void 0;
+exports.getSandboxRuntimeAPI = exports.getNodeRuntimeAPI = exports.addMagicAgent = exports.fetchRemote = exports.fetchProduct = void 0;
 const tslib_1 = require("tslib");
 const node_fetch_1 = tslib_1.__importDefault(require("node-fetch"));
 const _1 = require(".");
+const runtime_1 = require("./runtime");
 const polyfill_response_1 = require("./polyfill-response");
 const errors_1 = require("./errors");
 function fetchProduct(args) {
@@ -17,6 +18,34 @@ function fetchProduct(args) {
     };
 }
 exports.fetchProduct = fetchProduct;
+function fetchRemote(args) {
+    return async (path, init) => {
+        const url = `https://${args.remote}${path}`;
+        init = (0, exports.addMagicAgent)(init, 'EXTERNAL_AUTH_REQUEST');
+        init.headers = Object.assign(Object.assign({}, init.headers), { authorization: `Forge user ${args.provider}` });
+        const response = await (0, node_fetch_1.default)(url, init);
+        handleProxyResponseErrors(response);
+        return response;
+    };
+}
+exports.fetchRemote = fetchRemote;
+function getDefaultRemote(provider) {
+    const externalAuthProvider = findExternalAuthProviderConfigOrThrow(provider);
+    if (!externalAuthProvider.remotes.length) {
+        throw new Error(`Missing remote config for provider ${provider}`);
+    }
+    return externalAuthProvider.remotes[0].key;
+}
+function findExternalAuthProviderConfigOrThrow(provider) {
+    const { externalAuth } = (0, runtime_1.__getRuntime)();
+    const externalAuthProvider = externalAuth === null || externalAuth === void 0 ? void 0 : externalAuth.find((externalAuthMetaData) => {
+        return externalAuthMetaData.service === provider;
+    });
+    if (!externalAuthProvider) {
+        throw new Error(`Bad provider or missing config for provider ${provider}`);
+    }
+    return externalAuthProvider;
+}
 const ATLASSIAN_TOKEN_SERVICE_KEY = 'atlassian-token-service-key';
 const handleProxyResponseErrors = (response) => {
     if (response.headers.has('forge-proxy-error')) {
@@ -33,11 +62,26 @@ function productURL(remote, path) {
     }
     return `https://${remote}${path}`;
 }
-const addMagicAgent = (init) => (Object.assign(Object.assign({}, init), { agent: 'FORGE_PRODUCT_REQUEST' }));
+const addMagicAgent = (init, agentOverride) => (Object.assign(Object.assign({}, init), { agent: (agentOverride !== null && agentOverride !== void 0 ? agentOverride : 'FORGE_PRODUCT_REQUEST') }));
 exports.addMagicAgent = addMagicAgent;
 const throwNotImplementedError = () => {
     throw new Error('not implemented');
 };
+const withProvider = (provider, remote) => ({
+    hasCredentials: async () => {
+        const { tokenAvailable } = findExternalAuthProviderConfigOrThrow(provider);
+        return tokenAvailable;
+    },
+    getAccount: throwNotImplementedError,
+    requestCredentials: async () => {
+        findExternalAuthProviderConfigOrThrow(provider);
+        throw new errors_1.NeedsAuthenticationError('Authentication Required', provider);
+    },
+    listCredentials: throwNotImplementedError,
+    listAccounts: throwNotImplementedError,
+    asAccount: throwNotImplementedError,
+    fetch: (0, _1.wrapWithRouteUnwrapper)(fetchRemote({ provider, remote: remote !== null && remote !== void 0 ? remote : getDefaultRemote(provider) }))
+});
 function getNodeRuntimeAPI() {
     return {
         fetch: (0, _1.wrapWithRouteUnwrapper)(node_fetch_1.default),
@@ -50,7 +94,7 @@ function getNodeRuntimeAPI() {
             requestBitbucket: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'user', remote: 'bitbucket' })),
             requestGraph: (0, _1.wrapRequestGraph)(fetchProduct({ provider: 'user', remote: 'stargate' })),
             requestConnectedData: (0, _1.wrapRequestConnectedData)(fetchProduct({ provider: 'user', remote: 'stargate' })),
-            withProvider: throwNotImplementedError
+            withProvider
         }),
         asApp: () => ({
             requestJira: (0, _1.wrapRequestProduct)(fetchProduct({ provider: 'app', remote: 'jira' })),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/api",
-  "version": "3.2.0-next.4-experimental-cf84ac7",
+  "version": "3.2.0",
   "description": "Forge API methods",
   "author": "Atlassian",
   "license": "UNLICENSED",
@@ -12,7 +12,7 @@
     "compile": "tsc -b -v"
   },
   "devDependencies": {
-    "@forge/runtime": "5.4.0-next.4-experimental-cf84ac7",
+    "@forge/runtime": "5.4.0",
     "@types/node": "14.18.63",
     "expect-type": "^0.17.3",
     "jest-matcher-specific-error": "^1.0.0",
@@ -20,9 +20,9 @@
   },
   "dependencies": {
     "@forge/auth": "0.0.5",
-    "@forge/egress": "1.2.13-next.0-experimental-cf84ac7",
-    "@forge/storage": "1.5.15-next.0-experimental-cf84ac7",
-    "@forge/util": "1.4.1-next.0-experimental-cf84ac7",
+    "@forge/egress": "1.2.13",
+    "@forge/storage": "1.5.15",
+    "@forge/util": "1.4.1",
     "@types/node-fetch": "^2.6.11",
     "node-fetch": "2.7.0"
   }