@forge/react 10.10.2 → 10.10.3-next.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @forge/react
 
+## 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/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/package.json

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