@forge/bridge 5.10.3-next.1-experimental-919607a → 5.11.0-next.3

package/CHANGELOG.md

@@ -1,12 +1,24 @@
 # @forge/bridge
 
-## 5.10.3-next.1-experimental-919607a
+## 5.11.0-next.3
 
 ### Patch Changes
 
-- Updated dependencies [e21f32f]
-- Updated dependencies [545ecc1]
-  - @forge/manifest@11.4.0-next.1-experimental-919607a
+- Updated dependencies [6b7a4ef]
+- Updated dependencies [dfa2aa6]
+- Updated dependencies [8db2311]
+  - @forge/manifest@12.0.0-next.3
+
+## 5.11.0-next.2
+
+### Minor Changes
+
+- f058dd8: Expose Permissions API in @forge/bridge for Custom UI apps
+
+### Patch Changes
+
+- Updated dependencies [eadb4a6]
+  - @forge/manifest@11.4.0-next.2
 
 ## 5.10.3-next.1
 

package/out/permissions/index.d.ts

@@ -1,2 +1,3 @@
 export * from './permissions';
+export * from './permissionsUtil';
 //# sourceMappingURL=index.d.ts.map

package/out/permissions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/permissions/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/permissions/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,mBAAmB,CAAC"}

package/out/permissions/index.js

@@ -2,3 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./permissions"), exports);
+tslib_1.__exportStar(require("./permissionsUtil"), exports);

package/out/permissions/permissionsUtil.d.ts

@@ -0,0 +1,39 @@
+import type { External } from '@forge/manifest';
+import type { RuntimePermissions } from '../types';
+declare const RESOURCE_TYPES: readonly ["fonts", "styles", "frames", "images", "media", "scripts"];
+export declare type ResourceType = (typeof RESOURCE_TYPES)[number];
+declare const FETCH_TYPES: readonly ["backend", "client"];
+export declare type FetchType = (typeof FETCH_TYPES)[number];
+export interface PermissionRequirements {
+    scopes?: string[];
+    external?: {
+        fetch?: {
+            backend?: string[];
+            client?: string[];
+        };
+        fonts?: string[];
+        styles?: string[];
+        frames?: string[];
+        images?: string[];
+        media?: string[];
+        scripts?: string[];
+    };
+    content?: Record<string, unknown>;
+}
+export declare type MissingPermissions = PermissionRequirements;
+export interface PermissionCheckResult {
+    granted: boolean;
+    missing: MissingPermissions | null;
+}
+export interface PermissionUtils {
+    hasScope: (scope: string) => boolean;
+    canFetchFrom: (type: FetchType, url: string) => boolean;
+    canLoadResource: (type: ResourceType, url: string) => boolean;
+    getScopes: () => string[];
+    getExternalPermissions: () => External | undefined;
+    hasAnyPermissions: () => boolean;
+}
+export declare function createPermissionUtils(runtimePermissions: RuntimePermissions | undefined): PermissionUtils | null;
+export declare function checkPermissions(requiredPermissions: PermissionRequirements, runtimePermissions?: RuntimePermissions | undefined): Promise<PermissionCheckResult>;
+export {};
+//# sourceMappingURL=permissionsUtil.d.ts.map

package/out/permissions/permissionsUtil.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissionsUtil.d.ts","sourceRoot":"","sources":["../../src/permissions/permissionsUtil.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAEhD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAoBnD,QAAA,MAAM,cAAc,sEAAuE,CAAC;AAC5F,oBAAY,YAAY,GAAG,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC;AAK3D,QAAA,MAAM,WAAW,gCAAiC,CAAC;AACnD,oBAAY,SAAS,GAAG,CAAC,OAAO,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;AAKrD,MAAM,WAAW,sBAAsB;IACrC,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE;YACN,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;YACnB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;SACnB,CAAC;QACF,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;KACpB,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAKD,oBAAY,kBAAkB,GAAG,sBAAsB,CAAC;AAKxD,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpC;AAKD,MAAM,WAAW,eAAe;IAI9B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC;IAOrC,YAAY,EAAE,CAAC,IAAI,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAOxD,eAAe,EAAE,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAK9D,SAAS,EAAE,MAAM,MAAM,EAAE,CAAC;IAK1B,sBAAsB,EAAE,MAAM,QAAQ,GAAG,SAAS,CAAC;IAKnD,iBAAiB,EAAE,MAAM,OAAO,CAAC;CAClC;AAOD,wBAAgB,qBAAqB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG,SAAS,GAAG,eAAe,GAAG,IAAI,CAmDhH;AAiGD,wBAAsB,gBAAgB,CACpC,mBAAmB,EAAE,sBAAsB,EAC3C,kBAAkB,CAAC,EAAE,kBAAkB,GAAG,SAAS,GAClD,OAAO,CAAC,qBAAqB,CAAC,CA+ChC"}

package/out/permissions/permissionsUtil.js

@@ -0,0 +1,143 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkPermissions = exports.createPermissionUtils = void 0;
+const egress_1 = require("@forge/egress");
+const view_1 = require("../view");
+function extractUrlString(url) {
+    if (typeof url === 'string') {
+        return url;
+    }
+    if ('address' in url && url.address) {
+        return url.address;
+    }
+    return url.remote || '';
+}
+const RESOURCE_TYPES = ['fonts', 'styles', 'frames', 'images', 'media', 'scripts'];
+const FETCH_TYPES = ['backend', 'client'];
+function createPermissionUtils(runtimePermissions) {
+    if (!runtimePermissions) {
+        return null;
+    }
+    const { scopes, external = {} } = runtimePermissions;
+    const scopeArray = Array.isArray(scopes) ? scopes : Object.keys(scopes || {});
+    return {
+        hasScope: (scope) => scopeArray.includes(scope),
+        canFetchFrom: (type, url) => {
+            var _a;
+            const fetchUrls = (_a = external.fetch) === null || _a === void 0 ? void 0 : _a[type];
+            if (!(fetchUrls === null || fetchUrls === void 0 ? void 0 : fetchUrls.length))
+                return false;
+            const allowList = fetchUrls.map(extractUrlString).filter((u) => u.length > 0);
+            if (allowList.length === 0)
+                return false;
+            const egressFilter = new egress_1.EgressFilteringService(allowList);
+            const egressFilterWithCSP = egressFilter;
+            return type === 'client' ? egressFilterWithCSP.isValidUrlCSP(url) : egressFilter.isValidUrl(url);
+        },
+        canLoadResource: (type, url) => {
+            const resourceUrls = external[type];
+            if (!(resourceUrls === null || resourceUrls === void 0 ? void 0 : resourceUrls.length))
+                return false;
+            const allowList = resourceUrls.map(extractUrlString).filter((u) => u.length > 0);
+            if (allowList.length === 0)
+                return false;
+            const egressFilter = new egress_1.EgressFilteringService(allowList);
+            const egressFilterWithCSP = egressFilter;
+            return egressFilterWithCSP.isValidUrlCSP(url);
+        },
+        getScopes: () => scopeArray,
+        getExternalPermissions: () => external,
+        hasAnyPermissions: () => scopeArray.length > 0 || Object.keys(external).length > 0
+    };
+}
+exports.createPermissionUtils = createPermissionUtils;
+function checkScopes(requiredScopes, permissionUtils) {
+    if (!(requiredScopes === null || requiredScopes === void 0 ? void 0 : requiredScopes.length)) {
+        return undefined;
+    }
+    const missingScopes = requiredScopes.filter((scope) => !permissionUtils.hasScope(scope));
+    return missingScopes.length > 0 ? missingScopes : undefined;
+}
+function checkFetchPermissions(requiredFetch, permissionUtils) {
+    if (!(requiredFetch === null || requiredFetch === void 0 ? void 0 : requiredFetch.fetch)) {
+        return undefined;
+    }
+    const missingFetch = {};
+    FETCH_TYPES.forEach((type) => {
+        var _a;
+        const requiredUrls = (_a = requiredFetch.fetch) === null || _a === void 0 ? void 0 : _a[type];
+        if (requiredUrls === null || requiredUrls === void 0 ? void 0 : requiredUrls.length) {
+            const missingUrls = requiredUrls.filter((url) => !permissionUtils.canFetchFrom(type, url));
+            if (missingUrls.length > 0) {
+                missingFetch[type] = missingUrls;
+            }
+        }
+    });
+    return Object.keys(missingFetch).length > 0 ? missingFetch : undefined;
+}
+function checkResourcePermissions(requiredExternal, permissionUtils) {
+    const missingResources = {};
+    RESOURCE_TYPES.forEach((type) => {
+        const requiredUrls = requiredExternal === null || requiredExternal === void 0 ? void 0 : requiredExternal[type];
+        if (requiredUrls === null || requiredUrls === void 0 ? void 0 : requiredUrls.length) {
+            const missingUrls = requiredUrls.filter((url) => !permissionUtils.canLoadResource(type, url));
+            if (missingUrls.length > 0) {
+                missingResources[type] = missingUrls;
+            }
+        }
+    });
+    return Object.keys(missingResources).length > 0 ? missingResources : undefined;
+}
+function checkExternalPermissions(requiredExternal, permissionUtils) {
+    if (!requiredExternal) {
+        return undefined;
+    }
+    const missingFetch = checkFetchPermissions(requiredExternal, permissionUtils);
+    const missingResources = checkResourcePermissions(requiredExternal, permissionUtils);
+    if (!missingFetch && !missingResources) {
+        return undefined;
+    }
+    const missingExternal = {};
+    if (missingFetch) {
+        missingExternal.fetch = missingFetch;
+    }
+    if (missingResources) {
+        Object.assign(missingExternal, missingResources);
+    }
+    return missingExternal;
+}
+async function checkPermissions(requiredPermissions, runtimePermissions) {
+    var _a;
+    if (!requiredPermissions) {
+        return { granted: false, missing: null };
+    }
+    if (!((_a = requiredPermissions.scopes) === null || _a === void 0 ? void 0 : _a.length) && !requiredPermissions.external) {
+        return { granted: true, missing: null };
+    }
+    let permissionsToCheck = runtimePermissions;
+    if (!permissionsToCheck) {
+        const context = await view_1.view.getContext();
+        permissionsToCheck = context.permissions;
+    }
+    const permissionUtils = createPermissionUtils(permissionsToCheck);
+    if (!permissionUtils) {
+        return { granted: false, missing: null };
+    }
+    const missing = {};
+    let hasAllRequiredPermissions = true;
+    const missingScopes = checkScopes(requiredPermissions.scopes, permissionUtils);
+    if (missingScopes) {
+        missing.scopes = missingScopes;
+        hasAllRequiredPermissions = false;
+    }
+    const missingExternal = checkExternalPermissions(requiredPermissions.external, permissionUtils);
+    if (missingExternal) {
+        missing.external = missingExternal;
+        hasAllRequiredPermissions = false;
+    }
+    return {
+        granted: hasAllRequiredPermissions,
+        missing: hasAllRequiredPermissions ? null : missing
+    };
+}
+exports.checkPermissions = checkPermissions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/bridge",
-  "version": "5.10.3-next.1-experimental-919607a",
+  "version": "5.11.0-next.3",
   "description": "Forge bridge API for custom UI apps",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -20,7 +20,7 @@
     "@forge/resolver": "1.7.1",
     "@statsig/js-client": "3.18.2",
     "@types/history": "^4.7.11",
-    "@forge/manifest": "11.4.0-next.1-experimental-919607a",
+    "@forge/manifest": "12.0.0-next.3",
     "@types/iframe-resizer": "^3.5.8",
     "iframe-resizer": "^4.4.5",
     "uuid": "^9.0.1"