@forge/react 11.4.1-next.0 → 11.5.0-next.1-experimental-75d036a

package/out/hooks/usePermissions.js

@@ -0,0 +1,198 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePermissions = void 0;
+const react_1 = require("react");
+const bridge_1 = require("@forge/bridge");
+const minimatch_1 = require("minimatch");
+/**
+ * https://ecosystem-platform.atlassian.net/browse/DEPLOY-1411
+ * reuse logic from @forge/api
+ */
+/**
+ * Resource types that can be loaded externally
+ */
+const RESOURCE_TYPES = ['fonts', 'styles', 'frames', 'images', 'media', 'scripts'];
+/**
+ * Fetch types for external requests
+ */
+const FETCH_TYPES = ['backend', 'client'];
+/**
+ * Helper function to check if a URL matches any of the allowed patterns
+ * Uses minimatch for robust pattern matching with wildcards
+ */
+const matchesAllowedUrl = (url, allowedUrls) => {
+    return allowedUrls.some((allowedUrl) => {
+        // Use minimatch for pattern matching
+        return (0, minimatch_1.minimatch)(url, allowedUrl);
+    });
+};
+/**
+ * Hook for checking permissions in Forge apps
+ *
+ * @param requiredPermissions - The permissions required for the component
+ * @returns Object containing permission state, loading status, and error information
+ * @returns hasPermission - Whether all required permissions are granted
+ * @returns isLoading - Whether the permission check is still in progress
+ * @returns missingPermissions - Details about which permissions are missing (null if all granted)
+ * @returns error - Any error that occurred during permission checking (null if no error)
+ *
+ * @example
+ * ```tsx
+ * const MyComponent: React.FC = () => {
+ *   const { hasPermission, isLoading, missingPermissions, error } = usePermissions({
+ *     scopes: ['write:confluence-content'],
+ *     external: {
+ *       fetch: {
+ *         backend: ['https://api.example.com']
+ *       }
+ *     }
+ *   });
+ *
+ *   if (isLoading) return <LoadingSpinner />;
+ *
+ *   if (error) {
+ *     return <ErrorMessage error={error} />;
+ *   }
+ *
+ *   if (!hasPermission) {
+ *     return <PermissionDenied missingPermissions={missingPermissions} />;
+ *   }
+ *
+ *   return <ProtectedFeature />;
+ * };
+ * ```
+ */
+const usePermissions = (requiredPermissions) => {
+    const [context, setContext] = (0, react_1.useState)();
+    const [isLoading, setIsLoading] = (0, react_1.useState)(true);
+    const [error, setError] = (0, react_1.useState)(null);
+    // Load context on mount
+    (0, react_1.useEffect)(() => {
+        const loadContext = async () => {
+            try {
+                setIsLoading(true);
+                setError(null);
+                const contextData = await bridge_1.view.getContext();
+                setContext(contextData);
+            }
+            catch (err) {
+                setError(err instanceof Error ? err : new Error('Failed to load context'));
+            }
+            finally {
+                setIsLoading(false);
+            }
+        };
+        void loadContext();
+    }, []);
+    // Permission checking utilities
+    const permissionUtils = (0, react_1.useMemo)(() => {
+        if (!context?.permissions)
+            return null;
+        const { scopes, external = {} } = context.permissions;
+        const scopeArray = Array.isArray(scopes) ? scopes : Object.keys(scopes || {});
+        return {
+            hasScope: (scope) => scopeArray.includes(scope),
+            canFetchFrom: (type, url) => {
+                const fetchUrls = external.fetch?.[type];
+                if (!fetchUrls?.length)
+                    return false;
+                // Extract string URLs from fetch URLs array
+                const allowedUrls = fetchUrls
+                    .map((item) => {
+                    // If item is already a string, use it directly
+                    if (typeof item === 'string') {
+                        return item;
+                    }
+                    // If item has an address property, use that
+                    if ('address' in item && item.address) {
+                        return item.address;
+                    }
+                    // Otherwise, use the remote property (if it exists)
+                    return item.remote;
+                })
+                    .filter((url) => typeof url === 'string');
+                return matchesAllowedUrl(url, allowedUrls);
+            },
+            canLoadResource: (type, url) => {
+                const resourceUrls = external[type];
+                if (!resourceUrls?.length)
+                    return false;
+                const stringUrls = resourceUrls.filter((item) => typeof item === 'string');
+                return matchesAllowedUrl(url, stringUrls);
+            },
+            getScopes: () => scopeArray,
+            getExternalPermissions: () => external,
+            hasAnyPermissions: () => scopeArray.length > 0 || Object.keys(external).length > 0
+        };
+    }, [context?.permissions]);
+    // Check permissions
+    const permissionResult = (0, react_1.useMemo)(() => {
+        if (!requiredPermissions) {
+            return { granted: false, missing: null };
+        }
+        if (!permissionUtils) {
+            // If still loading or there's an error, return null for missing permissions
+            if (isLoading || error) {
+                return { granted: false, missing: null };
+            }
+            throw new Error('This feature is not available yet');
+        }
+        const missing = {};
+        let hasAllRequiredPermissions = true;
+        // Check scopes
+        if (requiredPermissions.scopes?.length) {
+            const missingScopes = requiredPermissions.scopes.filter((scope) => !permissionUtils.hasScope(scope));
+            if (missingScopes.length > 0) {
+                missing.scopes = missingScopes;
+                hasAllRequiredPermissions = false;
+            }
+        }
+        // Check external permissions
+        if (requiredPermissions.external) {
+            const missingExternal = {};
+            // Check fetch permissions
+            if (requiredPermissions.external.fetch) {
+                const missingFetch = {};
+                FETCH_TYPES.forEach((type) => {
+                    const requiredUrls = requiredPermissions.external?.fetch?.[type];
+                    if (requiredUrls?.length) {
+                        const missingUrls = requiredUrls.filter((url) => !permissionUtils.canFetchFrom(type, url));
+                        if (missingUrls.length > 0) {
+                            missingFetch[type] = missingUrls;
+                            hasAllRequiredPermissions = false;
+                        }
+                    }
+                });
+                if (Object.keys(missingFetch).length > 0) {
+                    missingExternal.fetch = missingFetch;
+                }
+            }
+            // Check resource permissions
+            RESOURCE_TYPES.forEach((type) => {
+                const requiredUrls = requiredPermissions.external?.[type];
+                if (requiredUrls?.length) {
+                    const missingUrls = requiredUrls.filter((url) => !permissionUtils.canLoadResource(type, url));
+                    if (missingUrls.length > 0) {
+                        missingExternal[type] = missingUrls;
+                        hasAllRequiredPermissions = false;
+                    }
+                }
+            });
+            if (Object.keys(missingExternal).length > 0) {
+                missing.external = missingExternal;
+            }
+        }
+        // Note: Content permissions are not supported in the current RuntimePermissions type
+        return {
+            granted: hasAllRequiredPermissions,
+            missing: hasAllRequiredPermissions ? null : missing
+        };
+    }, [permissionUtils, requiredPermissions]);
+    return {
+        hasPermission: permissionResult.granted,
+        isLoading,
+        missingPermissions: permissionResult.missing,
+        error
+    };
+};
+exports.usePermissions = usePermissions;

package/out/index.d.ts

@@ -1,5 +1,6 @@
 export { useProductContext } from './hooks/useProductContext';
 export { useConfig } from './hooks/useConfig';
+export { usePermissions, type Permissions, type PermissionRequirements, type MissingPermissions, type PermissionCheckResult } from './hooks/usePermissions';
 export { ForgeReconciler as default } from './reconciler';
 export * from './components';
 export { useContentProperty } from './hooks/useContentProperty';

package/out/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,OAAO,EAAE,eAAe,IAAI,OAAO,EAAE,MAAM,cAAc,CAAC;AAE1D,cAAc,cAAc,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,+BAA+B,EAAE,MAAM,oDAAoD,CAAC;AACrG,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAC9C,OAAO,EACL,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EACvB,KAAK,qBAAqB,EAC3B,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EAAE,eAAe,IAAI,OAAO,EAAE,MAAM,cAAc,CAAC;AAE1D,cAAc,cAAc,CAAC;AAE7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,+BAA+B,EAAE,MAAM,oDAAoD,CAAC;AACrG,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,cAAc,iBAAiB,CAAC"}

package/out/index.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.useForm = exports.replaceUnsupportedDocumentNodes = exports.I18nProvider = exports.useTranslation = exports.useIssueProperty = exports.useSpaceProperty = exports.useContentProperty = exports.default = exports.useConfig = exports.useProductContext = void 0;
+exports.useForm = exports.replaceUnsupportedDocumentNodes = exports.I18nProvider = exports.useTranslation = exports.useIssueProperty = exports.useSpaceProperty = exports.useContentProperty = exports.default = exports.usePermissions = exports.useConfig = exports.useProductContext = void 0;
 const tslib_1 = require("tslib");
 var useProductContext_1 = require("./hooks/useProductContext");
 Object.defineProperty(exports, "useProductContext", { enumerable: true, get: function () { return useProductContext_1.useProductContext; } });
 var useConfig_1 = require("./hooks/useConfig");
 Object.defineProperty(exports, "useConfig", { enumerable: true, get: function () { return useConfig_1.useConfig; } });
+var usePermissions_1 = require("./hooks/usePermissions");
+Object.defineProperty(exports, "usePermissions", { enumerable: true, get: function () { return usePermissions_1.usePermissions; } });
 var reconciler_1 = require("./reconciler");
 Object.defineProperty(exports, "default", { enumerable: true, get: function () { return reconciler_1.ForgeReconciler; } });
 tslib_1.__exportStar(require("./components"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/react",
-  "version": "11.4.1-next.0",
+  "version": "11.5.0-next.1-experimental-75d036a",
   "description": "Forge React reconciler",
   "author": "Atlassian",
   "license": "SEE LICENSE IN LICENSE.txt",
@@ -28,11 +28,12 @@
     "@atlaskit/adf-schema": "^48.0.0",
     "@atlaskit/adf-utils": "^19.19.0",
     "@atlaskit/forge-react-types": "^0.42.10",
-    "@forge/bridge": "^5.6.0-next.0",
+    "@forge/bridge": "^5.6.0-next.4-experimental-75d036a",
     "@forge/i18n": "0.0.7",
     "@types/react": "^18.2.64",
     "@types/react-reconciler": "^0.28.8",
     "lodash": "^4.17.21",
+    "minimatch": "^9.0.5",
     "react": "^18.2.0",
     "react-hook-form": "^7.50.1",
     "react-reconciler": "^0.29.0",