@forge/react 10.10.2 → 10.10.3-experimental-147ff14

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @forge/react
 
+## 10.10.3-experimental-147ff14
+
+### Major Changes
+
+- f9073fe: Improve useConfig hook so it reflects value properly on macro config updates
+
+## 10.10.3
+
+### Patch Changes
+
+- ea9fa2a: Fix update method in useSpaceProperty to ensure it works as expect when value does not exist
+
+## 10.10.3-next.0
+
+### Patch Changes
+
+- ea9fa2a: Fix update method in useSpaceProperty to ensure it works as expect when value does not exist
+
 ## 10.10.2
 
 ### Patch Changes

package/out/hooks/__test__/confluenceEntity.test.js

@@ -126,6 +126,36 @@ describe('confluenceEntity', () => {
             mockRequestConf.mockResolvedValueOnce(mockPropertyHook_1.mockConfGetExistingRes).mockResolvedValueOnce(mockPropertyHook_1.mockFailedRes);
             await expect(() => contentEntity.update(mockPropertyHook_1.UPDATED_PROP_VALUE)).rejects.toThrow(`The request to update the content property (forge-MOCK_LOCAL_ID-MOCK_PROP_KEY) failed with status (400).`);
         });
+        describe('if the property does not exist, it should create it', () => {
+            beforeEach(() => {
+                mockRequestConf.mockReset();
+                mockRequestConf
+                    .mockResolvedValueOnce(mockPropertyHook_1.mockConfGetNonExistentRes)
+                    .mockResolvedValueOnce(mockPropertyHook_1.mockConfCreateRes)
+                    .mockResolvedValueOnce(mockPropertyHook_1.mockConfUpdateValueRes);
+            });
+            it('should make a POST request to the API with the right URL and body', async () => {
+                const contentGetUrl = contentEndpoints.fetch('forge-MOCK_LOCAL_ID-MOCK_PROP_KEY');
+                const contentGetBody = expect.objectContaining({ method: 'GET' });
+                const contentPutUrl = contentEndpoints.update('MOCK_PROP_ID');
+                const contentPostUrl = contentEndpoints.create();
+                const contentPostBody = expect.objectContaining({
+                    method: 'POST',
+                    body: JSON.stringify({ key: 'forge-MOCK_LOCAL_ID-MOCK_PROP_KEY', value: mockPropertyHook_1.DEFAULT_PROP_VALUE })
+                });
+                // both value & version props need to be present in body string
+                const valueUpdateStr = `"value":${mockPropertyHook_1.UPDATED_PROP_VALUE}`;
+                const contentPutBody = (updateStr) => expect.objectContaining({
+                    body: expect.stringContaining(updateStr)
+                });
+                const valUpdate = await contentEntity.update(mockPropertyHook_1.UPDATED_PROP_VALUE);
+                expect(valUpdate).toEqual(mockPropertyHook_1.UPDATED_PROP_VALUE);
+                expect(mockRequestConf).toHaveBeenCalledTimes(3);
+                expect(mockRequestConf).toHaveBeenNthCalledWith(1, contentGetUrl, contentGetBody);
+                expect(mockRequestConf).toHaveBeenNthCalledWith(2, contentPostUrl, contentPostBody);
+                expect(mockRequestConf).toHaveBeenNthCalledWith(3, contentPutUrl, contentPutBody(valueUpdateStr));
+            });
+        });
     });
     describe('when running its delete() output function', () => {
         beforeEach(() => {

package/out/hooks/__test__/useConfig.test.js

@@ -2,6 +2,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const jsx_runtime_1 = require("react/jsx-runtime");
+const listeners = new Map();
+const simpleBridgeEvents = {
+    on: (event, callback) => {
+        if (!listeners.has(event)) {
+            listeners.set(event, []);
+        }
+        listeners.get(event)?.push(callback);
+    },
+    emit: (event, data) => {
+        if (listeners.has(event)) {
+            listeners.get(event)?.forEach((callback) => callback(data));
+        }
+    },
+    clearListeners: (event) => {
+        listeners.delete(event);
+    }
+};
 // defining mock function above import so it is initialised before jest.mock runs
 const mockGetContext = jest.fn(async () => null);
 const react_1 = tslib_1.__importStar(require("react"));
@@ -11,7 +28,8 @@ const testUtils_1 = require("../../__test__/testUtils");
 jest.mock('@forge/bridge', () => ({
     view: {
         getContext: mockGetContext
-    }
+    },
+    events: simpleBridgeEvents
 }));
 const MOCK_CONFIG = {
     value: 1
@@ -32,10 +50,16 @@ const renderTest = async () => {
         (0, react_1.useEffect)(() => configListener(config), [config]);
         return (0, jsx_runtime_1.jsx)(react_1.default.Fragment, {});
     };
-    await reconcilerTestRenderer_1.default.create((0, jsx_runtime_1.jsx)(Test, {}));
+    const { update } = await reconcilerTestRenderer_1.default.create((0, jsx_runtime_1.jsx)(Test, {}));
+    return {
+        update: async () => {
+            await update((0, jsx_runtime_1.jsx)(Test, {}));
+        }
+    };
 };
 describe('useConfig', () => {
     beforeAll(() => (0, testUtils_1.setupBridge)());
+    beforeEach(() => simpleBridgeEvents.clearListeners('FORGE_CORE_MACRO_CONFIG_CHANGED'));
     afterEach(() => jest.clearAllMocks());
     it('correctly outputs a given config', async () => {
         mockGetContext.mockResolvedValue(MOCK_CONTEXT_WITH_CONFIG);
@@ -49,4 +73,12 @@ describe('useConfig', () => {
         // no change to undef value after productContext call, do not re-render
         expect(configListener).not.toHaveBeenNthCalledWith(2, expect.anything);
     });
+    it('when config is updated, outputs new config', async () => {
+        mockGetContext.mockResolvedValue(MOCK_CONTEXT_WITH_CONFIG);
+        await renderTest();
+        expect(mockGetContext).toHaveBeenCalledTimes(1);
+        const newConfig = { value: 2 };
+        simpleBridgeEvents.emit('FORGE_CORE_MACRO_CONFIG_CHANGED', newConfig);
+        expect(mockGetContext).toHaveBeenCalledTimes(2);
+    });
 });

package/out/hooks/confluenceEntity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"confluenceEntity.d.ts","sourceRoot":"","sources":["../../src/hooks/confluenceEntity.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,uBAAuB,EAEvB,eAAe,EACf,oBAAoB,EACpB,aAAa,EAEd,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,eAAO,MAAM,gBAAgB,4BAA6B,uBAAuB;;yBAqBxD,MAAM;yBACN,MAAM;yBACN,MAAM;CAE9B,CAAC;AAEF,eAAO,MAAM,gBAAgB;gBAIiB,oBAAoB;8BAqGjE,CAAC"}
+{"version":3,"file":"confluenceEntity.d.ts","sourceRoot":"","sources":["../../src/hooks/confluenceEntity.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,uBAAuB,EAEvB,eAAe,EACf,oBAAoB,EACpB,aAAa,EAEd,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,eAAO,MAAM,gBAAgB,4BAA6B,uBAAuB;;yBAqBxD,MAAM;yBACN,MAAM;yBACN,MAAM;CAE9B,CAAC;AAEF,eAAO,MAAM,gBAAgB;gBAIiB,oBAAoB;8BAkGjE,CAAC"}

package/out/hooks/confluenceEntity.js

@@ -69,10 +69,10 @@ const confluenceEntity = ({ entityType, origPropertyKey, initValue }) => {
         const response = await (0, apiRequestUtils_1.makeRequest)({ url, apiMethod, method: 'DELETE' });
         (0, apiRequestUtils_1.assertSuccessfulResponse)({ entityType, propertyKey, operation: 'delete', response });
     };
-    const get = async ({ endpointFactory, propertyKey }) => {
+    const getProp = async ({ endpointFactory, propertyKey }) => {
         const existingProp = await fetchOriginal({ endpointFactory, propertyKey });
         if (existingProp) {
-            return existingProp.value;
+            return existingProp;
         }
         // if property doesn't exist, create it
         const resolvedInitVal = await (0, valueUtils_1.resolveValue)(initValue);
@@ -80,19 +80,15 @@ const confluenceEntity = ({ entityType, origPropertyKey, initValue }) => {
         const body = JSON.stringify({ key: propertyKey, value: resolvedInitVal });
         const response = await (0, apiRequestUtils_1.makeRequest)({ url, apiMethod, method: 'POST', body });
         (0, apiRequestUtils_1.assertSuccessfulResponse)({ entityType, propertyKey, operation: 'create', response });
-        return (await (0, apiRequestUtils_1.getJSONData)(response)).value;
+        return await (0, apiRequestUtils_1.getJSONData)(response);
+    };
+    const get = async ({ endpointFactory, propertyKey }) => {
+        const propData = await getProp({ endpointFactory, propertyKey });
+        return propData.value;
     };
     const update = async ({ endpointFactory, propertyKey }, valueUpdate) => {
         // fetch original prop first to update based on its value + version + id
-        const originalProp = await fetchOriginal({ endpointFactory, propertyKey });
-        if (!originalProp) {
-            throw new types_1.EntityPropertyRequestFailedError({
-                entityType,
-                propertyKey,
-                operation: 'update',
-                status: 404
-            });
-        }
+        const originalProp = await getProp({ endpointFactory, propertyKey });
         const newValue = valueUpdate instanceof Function ? valueUpdate(originalProp.value) : valueUpdate;
         const propertyId = originalProp.id;
         const origVersion = originalProp?.version?.number;

package/out/hooks/useConfig.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useConfig.d.ts","sourceRoot":"","sources":["../../src/hooks/useConfig.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,WAGrB,CAAC"}
+{"version":3,"file":"useConfig.d.ts","sourceRoot":"","sources":["../../src/hooks/useConfig.ts"],"names":[],"mappings":"AAeA,eAAO,MAAM,SAAS,WAiBrB,CAAC"}

package/out/hooks/useConfig.js

@@ -1,9 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useConfig = void 0;
-const useProductContext_1 = require("./useProductContext");
+const react_1 = require("react");
+const bridge_1 = require("@forge/bridge");
+const updateConfig = (setConfig) => {
+    bridge_1.view
+        .getContext()
+        .then((context) => {
+        setConfig(context?.extension.config);
+    })
+        .catch((err) => {
+        throw err;
+    });
+};
 const useConfig = () => {
-    const context = (0, useProductContext_1.useProductContext)();
-    return context?.extension.config;
+    const [config, setConfig] = (0, react_1.useState)(undefined);
+    (0, react_1.useEffect)(() => {
+        updateConfig(setConfig);
+    }, []);
+    (0, react_1.useEffect)(() => {
+        const sub = bridge_1.events.on('FORGE_CORE_MACRO_CONFIG_CHANGED', () => {
+            updateConfig(setConfig);
+        });
+        return () => {
+            void sub.then((subscription) => subscription.unsubscribe());
+        };
+    }, []);
+    return config;
 };
 exports.useConfig = useConfig;

package/out/reconciler.js

@@ -218,7 +218,7 @@ exports.hostConfig = {
 const reconciler = (0, react_reconciler_1.default)(exports.hostConfig);
 exports.ForgeReconciler = {
     render: (element) => {
-        const rootElement = (0, exports.createElement)({ type: 'Root', props: {}, forgeReactMajorVersion: 10 });
+        const rootElement = (0, exports.createElement)({ type: 'Root', props: {}, forgeReactMajorVersion: 11 });
         const container = reconciler.createContainer(rootElement, 0, null, false, null, 'root', (err) => {
             // eslint-disable-next-line no-console
             console.log(err);
@@ -233,7 +233,7 @@ exports.ForgeReconciler = {
         }
     },
     addConfig: (element) => {
-        const macroConfigElement = (0, exports.createElement)({ type: 'MacroConfig', props: {}, forgeReactMajorVersion: 10 });
+        const macroConfigElement = (0, exports.createElement)({ type: 'MacroConfig', props: {}, forgeReactMajorVersion: 11 });
         const container = reconciler.createContainer(macroConfigElement, 0, null, false, null, 'macroConfig', (err) => {
             // eslint-disable-next-line no-console
             console.log(err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forge/react",
-  "version": "10.10.2",
+  "version": "10.10.3-experimental-147ff14",
   "description": "Forge React reconciler",
   "author": "Atlassian",
   "license": "UNLICENSED",