@forge/storage 1.3.1 → 1.3.2-experimental-2a9dda4

package/CHANGELOG.md

@@ -0,0 +1,328 @@
+# @forge/storage
+
+## 1.3.2-experimental-2a9dda4
+
+### Patch Changes
+
+- eb084dba: Added capabilities for enabling Custom entities
+
+## 1.3.2
+
+### Patch Changes
+
+- 61d41c6: Bumping dependencies via Renovate:
+
+  - @types/react-reconciler
+
+- ba6d381: Bumping dependencies via Renovate:
+
+  - @types/cross-spawn
+
+- 4a070c4: Bumping dependencies via Renovate:
+
+  - command-exists
+
+- 37eee39: Bumping dependencies via Renovate:
+
+  - ajv
+
+- 444ada4: Bumping dependencies via Renovate:
+
+  - @changesets/types
+
+- 66da5d9: Bumping dependencies via Renovate:
+
+  - conf
+
+- decbf80: Bumping dependencies via Renovate:
+
+  - @types/react
+
+- 2b1589f: Bumping dependencies via Renovate:
+
+  - @types/minimatch
+
+- 6386221: Bumping dependencies via Renovate:
+
+  - @types/lodash
+
+- 203f465: Bumping dependencies via Renovate:
+
+  - @types/inquirer
+
+- 51d8225: Bumping dependencies via Renovate:
+
+  - @types/xml
+
+- c810119: Bumping dependencies via Renovate:
+
+  - @atlassian/logger-interface
+
+- d6d7226: Bumping dependencies via Renovate:
+
+  - @types/history
+
+- 5d6f948: Bumping dependencies via Renovate:
+
+  - @changesets/apply-release-plan
+
+- 0d52cdb: Bumping dependencies via Renovate:
+
+  - @types/uuid
+
+- 1508104: Bumping dependencies via Renovate:
+
+  - @types/cheerio
+
+- ff5d0f8: Bumping dependencies via Renovate:
+
+  - @types/supertest
+
+- 8970da8: Bumping dependencies via Renovate:
+
+  - @types/concat-stream
+
+## 1.3.2-next.8
+
+### Patch Changes
+
+- 4a070c4: Bumping dependencies via Renovate:
+
+  - command-exists
+
+- 66da5d9: Bumping dependencies via Renovate:
+
+  - conf
+
+- decbf80: Bumping dependencies via Renovate:
+
+  - @types/react
+
+## 1.3.2-next.7
+
+### Patch Changes
+
+- 37eee39: Bumping dependencies via Renovate:
+
+  - ajv
+
+## 1.3.2-next.6
+
+### Patch Changes
+
+- 61d41c6: Bumping dependencies via Renovate:
+
+  - @types/react-reconciler
+
+- ba6d381: Bumping dependencies via Renovate:
+
+  - @types/cross-spawn
+
+- 203f465: Bumping dependencies via Renovate:
+
+  - @types/inquirer
+
+- ff5d0f8: Bumping dependencies via Renovate:
+
+  - @types/supertest
+
+## 1.3.2-next.5
+
+### Patch Changes
+
+- 0d52cdb: Bumping dependencies via Renovate:
+
+  - @types/uuid
+
+## 1.3.2-next.4
+
+### Patch Changes
+
+- 51d8225: Bumping dependencies via Renovate:
+
+  - @types/xml
+
+## 1.3.2-next.3
+
+### Patch Changes
+
+- 2b1589f: Bumping dependencies via Renovate:
+
+  - @types/minimatch
+
+- 5d6f948: Bumping dependencies via Renovate:
+
+  - @changesets/apply-release-plan
+
+## 1.3.2-next.2
+
+### Patch Changes
+
+- 6386221: Bumping dependencies via Renovate:
+
+  - @types/lodash
+
+## 1.3.2-next.1
+
+### Patch Changes
+
+- 444ada4: Bumping dependencies via Renovate:
+
+  - @changesets/types
+
+- d6d7226: Bumping dependencies via Renovate:
+
+  - @types/history
+
+- 8970da8: Bumping dependencies via Renovate:
+
+  - @types/concat-stream
+
+## 1.3.2-next.0
+
+### Patch Changes
+
+- c810119: Bumping dependencies via Renovate:
+
+  - @atlassian/logger-interface
+
+- 1508104: Bumping dependencies via Renovate:
+
+  - @types/cheerio
+
+## 1.3.1
+
+### Patch Changes
+
+- 8e2a5a6: Update node-fetch version
+
+## 1.3.1-next.0
+
+### Patch Changes
+
+- 8e2a5a6: Update node-fetch version
+
+## 1.3.0
+
+### Minor Changes
+
+- 3c3c42b: Updated EAP filter names to be more readable
+
+## 1.3.0-next.0
+
+### Minor Changes
+
+- 3c3c42b9: Updated EAP filter names to be more readable
+
+## 1.2.0
+
+### Minor Changes
+
+- 21e392d: Added new filters for Early Access Program
+
+## 1.2.0-next.0
+
+### Minor Changes
+
+- 21e392d: Added new filters for Early Access Program
+
+## 1.1.0
+
+### Minor Changes
+
+- 0d7fe27: Support secret storage API
+
+## 1.1.0-next.0
+
+### Minor Changes
+
+- 0d7fe27: Support secret storage API
+
+## 1.0.5
+
+### Patch Changes
+
+- 0700578: Fix GraphQL query naming convention
+
+## 1.0.5-next.0
+
+### Patch Changes
+
+- 0700578: Fix GraphQL query naming convention
+
+## 1.0.4
+
+### Patch Changes
+
+- 5ff60ec: FRGE-273 Remove engines for storage and resolver
+
+## 1.0.4-next.0
+
+### Patch Changes
+
+- 5ff60ec: FRGE-273 Remove engines for storage and resolver
+
+## 1.0.3
+
+### Patch Changes
+
+- 9b496aa: Fixed parsing of response for cleanup functions
+
+## 1.0.3-next.0
+
+### Patch Changes
+
+- 9b496aa: Fixed parsing of response for cleanup functions
+
+## 1.0.2
+
+### Patch Changes
+
+- c7c6de2: Support larger list queries for GDPR purposes
+
+## 1.0.2-next.0
+
+### Patch Changes
+
+- c7c6de2: Support larger list queries for GDPR purposes
+
+## 1.0.1
+
+### Patch Changes
+
+- c0e9085: Improve README
+
+## 1.0.1-next.0
+
+### Patch Changes
+
+- c0e9085: Improve README
+
+## 1.0.0
+
+### Major Changes
+
+- 1daf2c5: Forge packages to 1.0.0 for upcoming platform GA 🎉
+
+## 1.0.0-next.0
+
+### Major Changes
+
+- 1daf2c5: Forge is now generally available 🎉
+
+## 0.0.2
+
+### Patch Changes
+
+- 843a703: Add forge-storage library
+
+## 0.0.2-next.0
+
+### Patch Changes
+
+- 843a703: Add forge-storage library
+
+## 0.0.1
+
+- First release
+- Refactored from `forge-api` package

package/out/__test__/global-storage.test.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const errors_1 = require("../errors");
 const global_storage_1 = require("../global-storage");
-const queries_1 = require("../queries");
+const gql_queries_1 = require("../gql-queries");
 const contextAri = 'app-ari';
 const getStorage = (apiClientMock) => new global_storage_1.GlobalStorage(() => contextAri, apiClientMock);
 const getApiClientMock = (response, statusCode = 200) => {
@@ -128,13 +128,6 @@ describe('GlobalStorage', () => {
             expect(apiClientMock).toHaveBeenCalled();
             await expect(response).rejects.toThrow(errors_1.APIError.forErrorCode('CURSOR_INVALID', 'error message'));
         });
-        it('should throw an error if the storage API returns a non 200 status code', async () => {
-            const apiClientMock = getApiClientMock(undefined, 400);
-            const globalStorage = getStorage(apiClientMock);
-            const response = globalStorage.get('testKey');
-            expect(apiClientMock).toHaveBeenCalled();
-            await expect(response).rejects.toThrow(errors_1.APIError.forStatus(400));
-        });
         it('should throw an error if the response is not a valid JSON', async () => {
             const apiClientMock = getApiClientMockInvalidJson('test', 200);
             const globalStorage = getStorage(apiClientMock);
@@ -319,6 +312,211 @@ describe('GlobalStorage', () => {
             });
         });
     });
+    describe('getEntity', () => {
+        it('should call the storage API, passing the provided entity name and entity key and returning the stored value', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStoredCustomEntity: {
+                        value: 'testValue'
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            const returnedValue = await globalStorage.getEntity('testEntityName', 'testEntityKey');
+            verifyApiClientCalledWith(apiClientMock, {
+                contextAri,
+                entityName: 'testEntityName',
+                key: 'testEntityKey'
+            });
+            expect(returnedValue).toEqual('testValue');
+        });
+        it('should call the storage API, passing the provided entity key and returning undefined if the key doesnt exist', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStoredCustomEntity: {
+                        value: null
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            const returnedValue = await globalStorage.getEntity('testEntityName', 'testEntityKey');
+            verifyApiClientCalledWith(apiClientMock, {
+                contextAri,
+                entityName: 'testEntityName',
+                key: 'testEntityKey'
+            });
+            expect(returnedValue).toEqual(undefined);
+        });
+        it('should call the storage API, passing the provided key and returning the stored falsey value 0', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStoredCustomEntity: {
+                        value: 0
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            const returnedValue = await globalStorage.getEntity('testEntityName', 'testEntityKey');
+            verifyApiClientCalledWith(apiClientMock, {
+                contextAri,
+                entityName: 'testEntityName',
+                key: 'testEntityKey'
+            });
+            expect(returnedValue).toEqual(0);
+        });
+        it('should call the storage API, passing the provided key and returning the stored empty string', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStoredCustomEntity: {
+                        value: ''
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            const returnedValue = await globalStorage.getEntity('testEntityName', 'testEntityKey');
+            verifyApiClientCalledWith(apiClientMock, {
+                contextAri,
+                entityName: 'testEntityName',
+                key: 'testEntityKey'
+            });
+            expect(returnedValue).toEqual('');
+        });
+        it('should throw an error with the returned status for non-200 status codes', async () => {
+            const apiClientMock = getApiClientMock(undefined, 400);
+            const globalStorage = getStorage(apiClientMock);
+            const response = globalStorage.getEntity('testEntityName', 'testEntityKey');
+            expect(apiClientMock).toHaveBeenCalled();
+            await expect(response).rejects.toThrow(errors_1.APIError.forStatus(400));
+        });
+        it('should throw an error with the returned error message for failed responses', async () => {
+            const apiClientMock = getApiClientMock({
+                errors: [INVALID_CURSOR_ERROR]
+            }, 200);
+            const globalStorage = getStorage(apiClientMock);
+            const response = globalStorage.getEntity('testEntityName', 'testEntityKey');
+            expect(apiClientMock).toHaveBeenCalled();
+            await expect(response).rejects.toThrow(errors_1.APIError.forErrorCode('CURSOR_INVALID', 'error message'));
+        });
+        it('should throw an error if the response is not a valid JSON', async () => {
+            const apiClientMock = getApiClientMockInvalidJson('test', 200);
+            const globalStorage = getStorage(apiClientMock);
+            const response = globalStorage.getEntity('testEntityName', 'testEntityKey');
+            expect(apiClientMock).toHaveBeenCalled();
+            await expect(response).rejects.toThrow(errors_1.APIError.forUnexpected('Response text was not a valid JSON: test'));
+        });
+    });
+    describe('setEntity', () => {
+        it('should call the storage API, passing the provided entity name, entity key and value', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStorageCustomEntity: {
+                        setAppStoredCustomEntity: {
+                            success: true
+                        }
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            await globalStorage.setEntity('testEntityName', 'testEntityKey', 'testValue');
+            verifyApiClientCalledWith(apiClientMock, {
+                input: {
+                    contextAri,
+                    entityName: 'testEntityName',
+                    key: 'testEntityKey',
+                    value: 'testValue'
+                }
+            });
+        });
+        it('should throw an error if the storage API returns successful = false', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStorageCustomEntity: {
+                        setAppStoredCustomEntity: {
+                            success: false,
+                            errors: [INVALID_CURSOR_ERROR]
+                        }
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            const response = globalStorage.setEntity('testEntityName', 'testEntityKey', 'testValue');
+            expect(apiClientMock).toHaveBeenCalled();
+            await expect(response).rejects.toThrow(errors_1.APIError.forErrorCode('INVALID_CURSOR', 'error message'));
+        });
+        it('should throw an error if the storage API returns a non 200 status code', async () => {
+            const apiClientMock = getApiClientMockInvalidJson('', 400);
+            const globalStorage = getStorage(apiClientMock);
+            const response = globalStorage.setEntity('testEntityName', 'testEntityKey', 'testValue');
+            expect(apiClientMock).toHaveBeenCalled();
+            await expect(response).rejects.toThrow(errors_1.APIError.forStatus(400));
+        });
+        it('should throw a 500 error if success=false but no errors were returned', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStorageCustomEntity: {
+                        setAppStoredCustomEntity: {
+                            success: false
+                        }
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            await expect(globalStorage.setEntity('testEntityName', 'testEntityKey', 'testValue')).rejects.toThrow(errors_1.APIError.forStatus(500));
+            verifyApiClientCalledWith(apiClientMock, {
+                input: {
+                    contextAri,
+                    entityName: 'testEntityName',
+                    key: 'testEntityKey',
+                    value: 'testValue'
+                }
+            });
+        });
+    });
+    describe('deleteEntity', () => {
+        it('should call the storage API, passing the provided entity name and key', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStorageCustomEntity: {
+                        deleteAppStoredCustomEntity: {
+                            success: true
+                        }
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            await globalStorage.deleteEntity('testEntityName', 'testEntityKey');
+            verifyApiClientCalledWith(apiClientMock, {
+                input: {
+                    contextAri,
+                    entityName: 'testEntityName',
+                    key: 'testEntityKey'
+                }
+            });
+        });
+        it('should throw an error if the storage API returns successful = false', async () => {
+            const apiClientMock = getApiClientMock({
+                data: {
+                    appStorageCustomEntity: {
+                        deleteAppStoredCustomEntity: {
+                            success: false,
+                            errors: [INVALID_CURSOR_ERROR]
+                        }
+                    }
+                }
+            });
+            const globalStorage = getStorage(apiClientMock);
+            const response = globalStorage.deleteEntity('testEntityKey', 'testEntityKey');
+            expect(apiClientMock).toHaveBeenCalled();
+            await expect(response).rejects.toThrow(errors_1.APIError.forErrorCode('CURSOR_INVALID', 'error message'));
+        });
+        it('should throw an error if the storage API returns a non 200 status code and has no body', async () => {
+            const apiClientMock = getApiClientMockInvalidJson('', 400);
+            const globalStorage = getStorage(apiClientMock);
+            const response = globalStorage.deleteEntity('testEntityKey', 'testEntityKey');
+            expect(apiClientMock).toHaveBeenCalled();
+            await expect(response).rejects.toThrow(errors_1.APIError.forStatus(400));
+        });
+    });
     describe('list', () => {
         it('should call the storage API with the provided parameters', async () => {
             const apiClientMock = getApiClientMock({
@@ -347,7 +545,7 @@ describe('GlobalStorage', () => {
                 where,
                 cursor,
                 limit
-            }, (0, queries_1.listQuery)(contextAri, {}).query);
+            }, gql_queries_1.UntypedQueries.listQuery(contextAri, {}).query);
             expect(response).toEqual(expect.objectContaining({
                 results: [
                     { key: 'key1', value: 'testValue' },
@@ -384,7 +582,7 @@ describe('GlobalStorage', () => {
                 where,
                 cursor,
                 limit
-            }, (0, queries_1.listQueryForCleanup)(contextAri, {}).query);
+            }, gql_queries_1.UntypedQueries.listQueryForCleanup(contextAri, {}).query);
             expect(response).toEqual(expect.objectContaining({
                 results: [
                     { key: 'key1', value: 'testValue' },
@@ -409,7 +607,7 @@ describe('GlobalStorage', () => {
                 where: null,
                 cursor: null,
                 limit: null
-            }, (0, queries_1.listQuery)(contextAri, {}).query);
+            }, gql_queries_1.UntypedQueries.listQuery(contextAri, {}).query);
         });
         it('should handle an empty result set', async () => {
             const apiClientMock = getApiClientMock({