@atlassian/clientside-extensions 2.4.0-e0cce94-kuewz5ow

package/LICENSE.txt

@@ -0,0 +1,30 @@
+Copyright (c) 2019 - Atlassian Software Systems Pty Ltd
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    * Neither the name of Atlassian Software Systems Pty Ltd nor the names of
+      its contributors may be used to endorse or promote products derived from
+      this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,7 @@
+# Client-side Extensions
+
+## Extension Factories
+
+Collection of function factories to simplify the consumption of extension points.
+
+Refer to the [official documentation](https://developer.atlassian.com/server/framework/clientside-extensions) for more information.

package/dist/cjs/AbstractExtension.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safeguard = void 0;
+const clientside_extensions_debug_1 = require("@atlassian/clientside-extensions-debug");
+function safeguard(callbackDebugName, callback) {
+    return (...args) => {
+        let result;
+        try {
+            result = callback(...args);
+        }
+        catch (e) {
+            clientside_extensions_debug_1.onDebug(({ error }) => ({
+                level: error,
+                message: `Failed to execute ${callbackDebugName} callback.
+    Error: ${e}`,
+            }));
+        }
+        return result;
+    };
+}
+exports.safeguard = safeguard;
+//# sourceMappingURL=AbstractExtension.js.map

package/dist/cjs/AbstractExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractExtension.js","sourceRoot":"","sources":["../../lib/AbstractExtension.ts"],"names":[],"mappings":";;;AAAA,wFAAiE;AAgBjE,SAAgB,SAAS,CAAqB,iBAAyB,EAAE,QAAW;IAChF,OAAO,CAAC,GAAG,IAAmB,EAAE,EAAE;QAC9B,IAAI,MAAM,CAAC;QACX,IAAI;YACA,MAAM,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;SAC9B;QAAC,OAAO,CAAC,EAAE;YACR,qCAAO,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;gBACpB,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,qBAAqB,iBAAiB;aAClD,CAAC,EAAE;aACH,CAAC,CAAC,CAAC;SACP;QACD,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC;AACN,CAAC;AAdD,8BAcC"}

package/dist/cjs/AsyncPanelExtension.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Api = exports.factory = void 0;
+const PanelExtension_1 = require("./PanelExtension");
+Object.defineProperty(exports, "Api", { enumerable: true, get: function () { return PanelExtension_1.Api; } });
+const extension_type_1 = require("./extension-type");
+exports.factory = (provider) => {
+    return (extensionApi, context) => {
+        return {
+            ...provider(extensionApi, context),
+            // We are passing the context provider function reference into the <AsyncPanelHandler.AsyncPanelRenderer> component
+            contextProvider() {
+                return context;
+            },
+            type: extension_type_1.ExtensionType.asyncPanel,
+        };
+    };
+};
+//# sourceMappingURL=AsyncPanelExtension.js.map

package/dist/cjs/AsyncPanelExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AsyncPanelExtension.js","sourceRoot":"","sources":["../../lib/AsyncPanelExtension.ts"],"names":[],"mappings":";;;AAEA,qDAAuC;AA+B9B,oFA/BA,oBAAG,OA+BA;AA9BZ,qDAAiD;AAiBpC,QAAA,OAAO,GAAG,CAAW,QAAgD,EAAqD,EAAE;IACrI,OAAO,CAAC,YAAY,EAAE,OAAO,EAAmC,EAAE;QAC9D,OAAO;YACH,GAAG,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;YAClC,mHAAmH;YACnH,eAAe;gBACX,OAAO,OAAO,CAAC;YACnB,CAAC;YACD,IAAI,EAAE,8BAAa,CAAC,UAAU;SACjC,CAAC;IACN,CAAC,CAAC;AACN,CAAC,CAAC"}

package/dist/cjs/AsyncPanelExtension.test.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const clientside_extensions_debug_1 = require("@atlassian/clientside-extensions-debug");
+const AsyncPanelExtension = tslib_1.__importStar(require("./AsyncPanelExtension"));
+jest.mock('@atlassian/clientside-extensions-debug');
+describe('AsyncPanelExtension', () => {
+    // @ts-expect-error - invalid values for contextProvider and type. Factory should overwrite them.
+    const testAttributesProvider = (api, context) => {
+        api.onCleanup(jest.fn());
+        api.updateAttributes({});
+        return {
+            type: 'not-valid',
+            contextProvider: 'not-valid-context-provider',
+            label: context.value === 42 ? 'The meaning of life' : 'A label',
+            onAction: jest.fn(),
+        };
+    };
+    const testAPI = {
+        onCleanup: jest.fn(),
+        updateAttributes: jest.fn(),
+    };
+    it('should generate the extension descriptor with the correct type and contextProvider', () => {
+        const extensionProvider = AsyncPanelExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, {});
+        // expect all attributes to be merged, type and contextProvider to be overwritten with the correct values.
+        expect(extension).toEqual({
+            type: 'async-panel',
+            label: 'A label',
+            onAction: expect.any(Function),
+            contextProvider: expect.any(Function),
+        });
+    });
+    it('should provide a extensionAPI object to the extension provider', () => {
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(0);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(0);
+        const extensionProvider = AsyncPanelExtension.factory(testAttributesProvider);
+        extensionProvider(testAPI, {});
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(1);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(1);
+    });
+    it('should share any provided context with the attributes provider', () => {
+        const extensionProvider = AsyncPanelExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, { value: 42 });
+        // expect label to change because of context
+        expect(extension).toEqual({
+            type: 'async-panel',
+            label: 'The meaning of life',
+            onAction: expect.any(Function),
+            contextProvider: expect.any(Function),
+        });
+    });
+    it('should add a contextProvider method to retreive the shared context', () => {
+        const extensionProvider = AsyncPanelExtension.factory(testAttributesProvider);
+        const testContext = { value: 42 };
+        const extension = extensionProvider(testAPI, testContext);
+        expect(extension.contextProvider()).toBe(testContext);
+    });
+    describe('API', () => {
+        let api;
+        const el = document.createElement('div');
+        beforeEach(() => {
+            api = new AsyncPanelExtension.Api();
+        });
+        it('#onMount callback used in getRenderCallback', () => {
+            const cb = jest.fn();
+            api.onMount(cb);
+            api.getRenderCallback()(el);
+            expect(cb).toHaveBeenCalledTimes(1);
+        });
+        it('#onMount does nothing if not set', () => {
+            expect(() => {
+                api.getRenderCallback()(el);
+            }).not.toThrow();
+        });
+        it('#onMount does nothing if callback is not function', () => {
+            // @ts-expect-error checking that non-TS consumers don't shoot themselves (or others) in the foot
+            api.onMount(null);
+            expect(() => {
+                api.getRenderCallback()(el);
+            }).not.toThrow();
+        });
+        it('#onMount fails gracefully if callback throws error', () => {
+            api.onMount(() => {
+                throw Error('whoops');
+            });
+            expect(() => {
+                api.getRenderCallback()(el);
+            }).not.toThrow();
+        });
+        it('#onUnmount callback used in getCleanupCallback', () => {
+            const cb = jest.fn();
+            api.onUnmount(cb);
+            api.getCleanupCallback()(el);
+            expect(cb).toHaveBeenCalledTimes(1);
+        });
+        it('#onUnmount does nothing if not set', () => {
+            expect(() => {
+                api.getCleanupCallback()(el);
+            }).not.toThrow();
+        });
+        it('#onUnmount does nothing if callback is not function', () => {
+            // @ts-expect-error checking that non-TS consumers don't shoot themselves (or others) in the foot
+            api.onUnmount(null);
+            expect(() => {
+                api.getCleanupCallback()(el);
+            }).not.toThrow();
+            expect(clientside_extensions_debug_1.onDebug).toHaveBeenCalledTimes(1);
+        });
+        it('#onUnmount fails gracefully if callback throws error', () => {
+            api.onUnmount(() => {
+                throw Error('whoops');
+            });
+            expect(() => {
+                api.getCleanupCallback()(el);
+            }).not.toThrow();
+            expect(clientside_extensions_debug_1.onDebug).toHaveBeenCalledTimes(1);
+        });
+    });
+});
+//# sourceMappingURL=AsyncPanelExtension.test.js.map

package/dist/cjs/AsyncPanelExtension.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AsyncPanelExtension.test.js","sourceRoot":"","sources":["../../lib/AsyncPanelExtension.test.ts"],"names":[],"mappings":";;;AACA,wFAAiE;AACjE,mFAA6D;AAE7D,IAAI,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;AAMpD,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACjC,iGAAiG;IACjG,MAAM,sBAAsB,GAAqD,CAAC,GAAG,EAAE,OAAoB,EAAE,EAAE;QAC3G,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACzB,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAEzB,OAAO;YACH,IAAI,EAAE,WAAW;YACjB,eAAe,EAAE,4BAA4B;YAC7C,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS;YAC/D,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;SACtB,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,OAAO,GAAgD;QACzD,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;QACpB,gBAAgB,EAAE,IAAI,CAAC,EAAE,EAAE;KAC9B,CAAC;IAEF,EAAE,CAAC,oFAAoF,EAAE,GAAG,EAAE;QAC1F,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC9E,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAEjD,0GAA0G;QAC1G,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,SAAS;YAChB,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC9B,eAAe,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SACxC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAE1D,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC9E,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAE/B,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC9E,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAE5D,4CAA4C;QAC5C,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,aAAa;YACnB,KAAK,EAAE,qBAAqB;YAC5B,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC9B,eAAe,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SACxC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC1E,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC9E,MAAM,WAAW,GAAgB,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;QAC/C,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QAE1D,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;QACjB,IAAI,GAA4B,CAAC;QACjC,MAAM,EAAE,GAAgB,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAEtD,UAAU,CAAC,GAAG,EAAE;YACZ,GAAG,GAAG,IAAI,mBAAmB,CAAC,GAAG,EAAE,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACnD,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;YACrB,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAChB,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;YAC5B,MAAM,CAAC,EAAE,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YACxC,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YACzD,iGAAiG;YACjG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC1D,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE;gBACb,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACtD,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;YACrB,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAClB,GAAG,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;YAC7B,MAAM,CAAC,EAAE,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC1C,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC3D,iGAAiG;YACjG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACpB,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,qCAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC5D,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE;gBACf,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,qCAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/cjs/ButtonExtension.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.factory = void 0;
+const extension_type_1 = require("./extension-type");
+exports.factory = (provider) => {
+    return (...args) => {
+        return {
+            ...provider(...args),
+            type: extension_type_1.ExtensionType.button,
+        };
+    };
+};
+//# sourceMappingURL=ButtonExtension.js.map

package/dist/cjs/ButtonExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ButtonExtension.js","sourceRoot":"","sources":["../../lib/ButtonExtension.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAUpC,QAAA,OAAO,GAAG,CAAW,QAA4C,EAAsC,EAAE;IAClH,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE;QACf,OAAO;YACH,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC;YACpB,IAAI,EAAE,8BAAa,CAAC,MAAM;SAC7B,CAAC;IACN,CAAC,CAAC;AACN,CAAC,CAAC"}

package/dist/cjs/ButtonExtension.test.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const ButtonExtension = tslib_1.__importStar(require("./ButtonExtension"));
+describe('ButtonExtension', () => {
+    // @ts-expect-error We set the invalid type
+    const testAttributesProvider = (api, context) => {
+        api.onCleanup(jest.fn());
+        api.updateAttributes({});
+        return {
+            type: 'not-valid',
+            label: context.value === 42 ? 'The meaning of life' : 'A label',
+            onAction: jest.fn(),
+        };
+    };
+    const testAPI = {
+        onCleanup: jest.fn(),
+        updateAttributes: jest.fn(),
+    };
+    it('should generate the extension descriptor with the correct type', () => {
+        const extensionProvider = ButtonExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, {});
+        // expect all atributes to be merged, and type to be overwritten with the correct value.
+        expect(extension).toEqual({
+            type: 'button',
+            label: 'A label',
+            onAction: expect.any(Function),
+        });
+    });
+    it('should provide a extensionAPI object to the extension provider', () => {
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(0);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(0);
+        const extensionProvider = ButtonExtension.factory(testAttributesProvider);
+        extensionProvider(testAPI, {});
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(1);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(1);
+    });
+    it('should share any provided context with the attributes provider', () => {
+        const extensionProvider = ButtonExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, { value: 42 });
+        // expect label to change because of context
+        expect(extension).toEqual({
+            type: 'button',
+            label: 'The meaning of life',
+            onAction: expect.any(Function),
+        });
+    });
+});
+//# sourceMappingURL=ButtonExtension.test.js.map

package/dist/cjs/ButtonExtension.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ButtonExtension.test.js","sourceRoot":"","sources":["../../lib/ButtonExtension.test.ts"],"names":[],"mappings":";;;AACA,2EAAqD;AAOrD,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC7B,2CAA2C;IAC3C,MAAM,sBAAsB,GAA6B,CAAC,GAAG,EAAE,OAAoB,EAAE,EAAE;QACnF,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACzB,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAEzB,OAAO;YACH,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS;YAC/D,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;SACtB,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,OAAO,GAAgD;QACzD,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;QACpB,gBAAgB,EAAE,IAAI,CAAC,EAAE,EAAE;KAC9B,CAAC;IAEF,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,iBAAiB,GAAG,eAAe,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAEjD,wFAAwF;QACxF,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,SAAS;YAChB,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SACjC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAE1D,MAAM,iBAAiB,GAAG,eAAe,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC1E,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAE/B,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,iBAAiB,GAAG,eAAe,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC1E,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAE5D,4CAA4C;QAC5C,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,qBAAqB;YAC5B,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SACjC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/cjs/LinkExtension.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.factory = void 0;
+const extension_type_1 = require("./extension-type");
+// eslint-disable-next-line import/prefer-default-export
+exports.factory = (provider) => {
+    return (...args) => {
+        return {
+            ...provider(...args),
+            type: extension_type_1.ExtensionType.link,
+        };
+    };
+};
+//# sourceMappingURL=LinkExtension.js.map

package/dist/cjs/LinkExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkExtension.js","sourceRoot":"","sources":["../../lib/LinkExtension.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAWjD,wDAAwD;AAC3C,QAAA,OAAO,GAAG,CAAW,QAA0C,EAAoC,EAAE;IAC9G,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE;QACf,OAAO;YACH,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC;YACpB,IAAI,EAAE,8BAAa,CAAC,IAAI;SAC3B,CAAC;IACN,CAAC,CAAC;AACN,CAAC,CAAC"}

package/dist/cjs/LinkExtension.test.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const LinkExtension = tslib_1.__importStar(require("./LinkExtension"));
+describe('LinkExtension', () => {
+    // @ts-expect-error we set the invalid type
+    const testAttributesProvider = (api, context) => {
+        api.onCleanup(jest.fn());
+        api.updateAttributes({});
+        return {
+            type: 'not-valid',
+            label: context.value === 42 ? 'The meaning of life' : 'A label',
+            link: 'https://go.atlassian.com/clientside-extensions',
+        };
+    };
+    const testAPI = {
+        onCleanup: jest.fn(),
+        updateAttributes: jest.fn(),
+    };
+    it('should generate the extension descriptor with the correct type', () => {
+        const extensionProvider = LinkExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, {});
+        // expect all attributes to be merged, and type to be overwritten with the correct value.
+        expect(extension).toEqual({
+            type: 'link',
+            label: 'A label',
+            link: 'https://go.atlassian.com/clientside-extensions',
+        });
+    });
+    it('should provide a extensionAPI object to the extension provider', () => {
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(0);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(0);
+        const extensionProvider = LinkExtension.factory(testAttributesProvider);
+        extensionProvider(testAPI, {});
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(1);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(1);
+    });
+    it('should share any provided context with the attributes provider', () => {
+        const extensionProvider = LinkExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, { value: 42 });
+        // expect label to change because of context
+        expect(extension).toEqual({
+            type: 'link',
+            label: 'The meaning of life',
+            link: 'https://go.atlassian.com/clientside-extensions',
+        });
+    });
+});
+//# sourceMappingURL=LinkExtension.test.js.map

package/dist/cjs/LinkExtension.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LinkExtension.test.js","sourceRoot":"","sources":["../../lib/LinkExtension.test.ts"],"names":[],"mappings":";;;AACA,uEAAiD;AAOjD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,2CAA2C;IAC3C,MAAM,sBAAsB,GAA2B,CAAC,GAAG,EAAE,OAAoB,EAAE,EAAE;QACjF,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACzB,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAEzB,OAAO;YACH,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS;YAC/D,IAAI,EAAE,gDAAgD;SACzD,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,OAAO,GAAgD;QACzD,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;QACpB,gBAAgB,EAAE,IAAI,CAAC,EAAE,EAAE;KAC9B,CAAC;IAEF,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAEjD,yFAAyF;QACzF,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,gDAAgD;SACzD,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAE1D,MAAM,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACxE,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAE/B,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACxE,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAE5D,4CAA4C;QAC5C,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,qBAAqB;YAC5B,IAAI,EAAE,gDAAgD;SACzD,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/cjs/ModalExtension.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Api = exports.Width = exports.Appearance = exports.factory = void 0;
+const clientside_extensions_debug_1 = require("@atlassian/clientside-extensions-debug");
+const extension_type_1 = require("./extension-type");
+const AbstractExtension_1 = require("./AbstractExtension");
+exports.factory = (provider) => {
+    return (...args) => {
+        const attributes = provider(...args);
+        return {
+            ...attributes,
+            type: extension_type_1.ExtensionType.modal,
+        };
+    };
+};
+const noop = () => { };
+var Appearance;
+(function (Appearance) {
+    Appearance["danger"] = "danger";
+    Appearance["warning"] = "warning";
+})(Appearance = exports.Appearance || (exports.Appearance = {}));
+var Width;
+(function (Width) {
+    Width["small"] = "small";
+    Width["medium"] = "medium";
+    Width["large"] = "large";
+    Width["x-large"] = "x-large";
+})(Width = exports.Width || (exports.Width = {}));
+class Api {
+    constructor(closeModalFn, setActions) {
+        this.title = '';
+        this.renderCallback = noop;
+        this.cleanupCallback = noop;
+        this.closeModalFn = noop;
+        this.onCloseCallback = () => true;
+        this.setTitle = (title) => {
+            this.title = title;
+            return this;
+        };
+        this.setWidth = (width) => {
+            // Runtime checking for 'non-ts' usage
+            if (!(width in Width)) {
+                clientside_extensions_debug_1.onDebug(({ error }) => ({
+                    level: error,
+                    message: `Invalid value specified as "width" of modal. Please make sure to use one of the supported values.`,
+                    meta: {
+                        value: width,
+                        supported: Object.keys(Width).concat(),
+                    },
+                }));
+                return this;
+            }
+            this.width = width;
+            return this;
+        };
+        this.setAppearance = (appearance) => {
+            // Runtime checking for 'non-ts' usage
+            if (!(appearance in Appearance)) {
+                clientside_extensions_debug_1.onDebug(({ error }) => ({
+                    level: error,
+                    message: `Invalid value specified as "appearance" of modal. Please make sure to use one of the supported values.`,
+                    meta: {
+                        value: appearance,
+                        supported: Object.keys(Appearance).concat(),
+                    },
+                }));
+                return this;
+            }
+            this.appearance = appearance;
+            return this;
+        };
+        this.onMount = (callback) => {
+            this.renderCallback = AbstractExtension_1.safeguard('onMount', callback);
+            return this;
+        };
+        this.onUnmount = (callback) => {
+            this.cleanupCallback = AbstractExtension_1.safeguard('onUnmount', callback);
+            return this;
+        };
+        this.closeModal = () => {
+            this.closeModalFn();
+        };
+        this.closeModalFn = AbstractExtension_1.safeguard('onClose', closeModalFn);
+        this.setActions = (actions) => {
+            setActions(Api.filterActionProps(actions));
+            return this;
+        };
+    }
+    getTitle() {
+        return this.title;
+    }
+    getWidth() {
+        return this.width;
+    }
+    getAppearance() {
+        return this.appearance;
+    }
+    getRenderCallback() {
+        return this.renderCallback;
+    }
+    getCleanupCallback() {
+        return this.cleanupCallback;
+    }
+    onClose(callback) {
+        this.onCloseCallback = AbstractExtension_1.safeguard('onClose', callback);
+        return this;
+    }
+    getOnCloseCallback() {
+        return this.onCloseCallback;
+    }
+    static filterActionProps(actions) {
+        if (!Array.isArray(actions)) {
+            return [];
+        }
+        return actions.map(({ text, onClick, isDisabled, isLoading, testId }) => {
+            return { text, onClick, isDisabled, isLoading, testId };
+        });
+    }
+}
+exports.Api = Api;
+//# sourceMappingURL=ModalExtension.js.map

package/dist/cjs/ModalExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModalExtension.js","sourceRoot":"","sources":["../../lib/ModalExtension.ts"],"names":[],"mappings":";;;AACA,wFAAiE;AASjE,qDAAiD;AAEjD,2DAAgD;AA2BnC,QAAA,OAAO,GAAG,CAAW,QAA2C,EAAqC,EAAE;IAChH,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE;QACf,MAAM,UAAU,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QACrC,OAAO;YACH,GAAG,UAAU;YACb,IAAI,EAAE,8BAAa,CAAC,KAAK;SAC5B,CAAC;IACN,CAAC,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;AAEtB,IAAY,UAGX;AAHD,WAAY,UAAU;IAClB,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACzB,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB;AAED,IAAY,KAKX;AALD,WAAY,KAAK;IACb,wBAAiB,CAAA;IACjB,0BAAmB,CAAA;IACnB,wBAAiB,CAAA;IACjB,4BAAqB,CAAA;AACzB,CAAC,EALW,KAAK,GAAL,aAAK,KAAL,aAAK,QAKhB;AAED,MAAa,GAAG;IAeZ,YAAY,YAAwB,EAAE,UAA6D;QAd3F,UAAK,GAAG,EAAE,CAAC;QAMX,mBAAc,GAAsB,IAAI,CAAC;QAEzC,oBAAe,GAAsB,IAAI,CAAC;QAEjC,iBAAY,GAAe,IAAI,CAAC;QAEzC,oBAAe,GAAuB,GAAG,EAAE,CAAC,IAAI,CAAC;QAYlD,aAAQ,GAAG,CAAC,KAAa,EAAE,EAAE;YAChC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YAEnB,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;QAEK,aAAQ,GAAG,CAAC,KAAY,EAAE,EAAE;YAC/B,sCAAsC;YACtC,IAAI,CAAC,CAAC,KAAK,IAAI,KAAK,CAAC,EAAE;gBACnB,qCAAO,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;oBACpB,KAAK,EAAE,KAAK;oBACZ,OAAO,EAAE,mGAAmG;oBAC5G,IAAI,EAAE;wBACF,KAAK,EAAE,KAAK;wBACZ,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE;qBACzC;iBACJ,CAAC,CAAC,CAAC;gBACJ,OAAO,IAAI,CAAC;aACf;YAED,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;YACnB,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;QAEK,kBAAa,GAAG,CAAC,UAAsB,EAAE,EAAE;YAC9C,sCAAsC;YACtC,IAAI,CAAC,CAAC,UAAU,IAAI,UAAU,CAAC,EAAE;gBAC7B,qCAAO,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;oBACpB,KAAK,EAAE,KAAK;oBACZ,OAAO,EAAE,wGAAwG;oBACjH,IAAI,EAAE;wBACF,KAAK,EAAE,UAAU;wBACjB,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,EAAE;qBAC9C;iBACJ,CAAC,CAAC,CAAC;gBACJ,OAAO,IAAI,CAAC;aACf;YAED,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;QAEK,YAAO,GAAG,CAAC,QAA2B,EAAE,EAAE;YAC7C,IAAI,CAAC,cAAc,GAAG,6BAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;YAErD,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;QAEK,cAAS,GAAG,CAAC,QAA2B,EAAE,EAAE;YAC/C,IAAI,CAAC,eAAe,GAAG,6BAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAExD,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;QAEK,eAAU,GAAG,GAAG,EAAE;YACrB,IAAI,CAAC,YAAY,EAAE,CAAC;QACxB,CAAC,CAAC;QAjEE,IAAI,CAAC,YAAY,GAAG,6BAAS,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAEvD,IAAI,CAAC,UAAU,GAAG,CAAC,OAAO,EAAE,EAAE;YAC1B,UAAU,CAAC,GAAG,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;YAE3C,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC;IACN,CAAC;IA4DM,QAAQ;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAEM,QAAQ;QACX,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAEM,aAAa;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAEM,iBAAiB;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAIM,OAAO,CAAC,QAA4B;QACvC,IAAI,CAAC,eAAe,GAAG,6BAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAEtD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,kBAAkB;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED,MAAM,CAAC,iBAAiB,CAAC,OAAkB;QACvC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACzB,OAAO,EAAE,CAAC;SACb;QAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE;YACpE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;QAC5D,CAAC,CAAC,CAAC;IACP,CAAC;CACJ;AA5HD,kBA4HC"}

package/dist/cjs/ModalExtension.test.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const clientside_extensions_debug_1 = require("@atlassian/clientside-extensions-debug");
+const ModalExtension = tslib_1.__importStar(require("./ModalExtension"));
+jest.mock('@atlassian/clientside-extensions-debug');
+describe('ModalExtension', () => {
+    // @ts-expect-error - invalid values for type. Factory should overwrite it.
+    const testAttributesProvider = (api, context) => {
+        api.onCleanup(jest.fn());
+        api.updateAttributes({});
+        return {
+            type: 'not-valid',
+            label: context.value === 42 ? 'The meaning of life' : 'A label',
+            onAction: jest.fn(),
+        };
+    };
+    const testAPI = {
+        onCleanup: jest.fn(),
+        updateAttributes: jest.fn(),
+    };
+    it('should generate the extension descriptor with the correct type', () => {
+        const extensionProvider = ModalExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, {});
+        // expect all attributes to be merged, and type to be overwritten with the correct value.
+        expect(extension).toEqual({
+            type: 'modal',
+            label: 'A label',
+            onAction: expect.any(Function),
+        });
+    });
+    it('should provide a extensionAPI object to the extension provider', () => {
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(0);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(0);
+        const extensionProvider = ModalExtension.factory(testAttributesProvider);
+        extensionProvider(testAPI, {});
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(1);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(1);
+    });
+    it('should share any provided context with the attributes provider', () => {
+        const extensionProvider = ModalExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, { value: 42 });
+        // expect label to change because of context
+        expect(extension).toEqual({
+            type: 'modal',
+            label: 'The meaning of life',
+            onAction: expect.any(Function),
+        });
+    });
+    it('should export all the supported appreanace for modals', () => {
+        expect(ModalExtension.Appearance).toBeTruthy();
+    });
+    it('should export all the supported sizes for modals', () => {
+        expect(ModalExtension.Width).toBeTruthy();
+    });
+    describe('API', () => {
+        let closeFn;
+        let api;
+        const el = document.createElement('div');
+        const setStateFn = () => { };
+        beforeEach(() => {
+            closeFn = jest.fn();
+            api = new ModalExtension.Api(closeFn, setStateFn);
+        });
+        it('#onMount callback used in getRenderCallback', () => {
+            const cb = jest.fn();
+            api.onMount(cb);
+            api.getRenderCallback()(el);
+            expect(cb).toHaveBeenCalledTimes(1);
+        });
+        it('#onMount does nothing if not set', () => {
+            expect(() => {
+                api.getRenderCallback()(el);
+            }).not.toThrow();
+        });
+        it('#onMount does nothing if callback is not function', () => {
+            // @ts-expect-error checking that non-TS consumers don't shoot themselves (or others) in the foot
+            api.onMount(null);
+            expect(() => {
+                api.getRenderCallback()(el);
+            }).not.toThrow();
+        });
+        it('#onMount fails gracefully if callback throws error', () => {
+            api.onMount(() => {
+                throw Error('whoops');
+            });
+            expect(() => {
+                api.getRenderCallback()(el);
+            }).not.toThrow();
+        });
+        it('#onUnmount callback used in getCleanupCallback', () => {
+            const cb = jest.fn();
+            api.onUnmount(cb);
+            api.getCleanupCallback()(el);
+            expect(cb).toHaveBeenCalledTimes(1);
+        });
+        it('#onUnmount does nothing if not set', () => {
+            expect(() => {
+                api.getCleanupCallback()(el);
+            }).not.toThrow();
+        });
+        it('#onUnmount does nothing if callback is not function', () => {
+            // @ts-expect-error checking that non-TS consumers don't shoot themselves (or others) in the foot
+            api.onUnmount(null);
+            expect(() => {
+                api.getCleanupCallback()(el);
+            }).not.toThrow();
+            expect(clientside_extensions_debug_1.onDebug).toHaveBeenCalledTimes(1);
+        });
+        it('#onUnmount fails gracefully if callback throws error', () => {
+            api.onUnmount(() => {
+                throw Error('whoops');
+            });
+            expect(() => {
+                api.getCleanupCallback()(el);
+            }).not.toThrow();
+            expect(clientside_extensions_debug_1.onDebug).toHaveBeenCalledTimes(1);
+        });
+    });
+});
+//# sourceMappingURL=ModalExtension.test.js.map

package/dist/cjs/ModalExtension.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModalExtension.test.js","sourceRoot":"","sources":["../../lib/ModalExtension.test.ts"],"names":[],"mappings":";;;AAGA,wFAAiE;AACjE,yEAAmD;AAEnD,IAAI,CAAC,IAAI,CAAC,wCAAwC,CAAC,CAAC;AAMpD,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC5B,2EAA2E;IAC3E,MAAM,sBAAsB,GAA2C,CAAC,GAAG,EAAE,OAAoB,EAAE,EAAE;QACjG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACzB,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAEzB,OAAO;YACH,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS;YAC/D,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE;SACtB,CAAC;IACN,CAAC,CAAC;IAEF,MAAM,OAAO,GAAgD;QACzD,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;QACpB,gBAAgB,EAAE,IAAI,CAAC,EAAE,EAAE;KAC9B,CAAC;IAEF,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,iBAAiB,GAAG,cAAc,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACzE,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAEjD,yFAAyF;QACzF,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,SAAS;YAChB,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SACjC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAE1D,MAAM,iBAAiB,GAAG,cAAc,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACzE,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAE/B,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACtE,MAAM,iBAAiB,GAAG,cAAc,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QACzE,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;QAE5D,4CAA4C;QAC5C,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,qBAAqB;YAC5B,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SACjC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC7D,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,UAAU,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QACxD,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;QACjB,IAAI,OAAO,CAAC;QACZ,IAAI,GAAuB,CAAC;QAC5B,MAAM,EAAE,GAAgB,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACtD,MAAM,UAAU,GAA2D,GAAG,EAAE,GAAE,CAAC,CAAC;QAEpF,UAAU,CAAC,GAAG,EAAE;YACZ,OAAO,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;YACpB,GAAG,GAAG,IAAI,cAAc,CAAC,GAAG,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACnD,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;YACrB,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAChB,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;YAC5B,MAAM,CAAC,EAAE,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YACxC,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YACzD,iGAAiG;YACjG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC1D,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE;gBACb,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YACtD,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;YACrB,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;YAClB,GAAG,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;YAC7B,MAAM,CAAC,EAAE,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC1C,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC3D,iGAAiG;YACjG,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACpB,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,qCAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC5D,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE;gBACf,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC;YACH,MAAM,CAAC,GAAG,EAAE;gBACR,GAAG,CAAC,kBAAkB,EAAE,CAAC,EAAE,CAAC,CAAC;YACjC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,CAAC,qCAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/cjs/PageExtension.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.factory = void 0;
+const extension_type_1 = require("./extension-type");
+exports.factory = (renderCallback) => {
+    return () => ({
+        type: extension_type_1.ExtensionType.page,
+        onAction: (node, data) => {
+            renderCallback(node, data);
+        },
+    });
+};
+//# sourceMappingURL=PageExtension.js.map

package/dist/cjs/PageExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageExtension.js","sourceRoot":"","sources":["../../lib/PageExtension.ts"],"names":[],"mappings":";;;AAEA,qDAAiD;AAWpC,QAAA,OAAO,GAAG,CAAgB,cAA6C,EAAyC,EAAE;IAC3H,OAAO,GAAG,EAAE,CAAC,CAAC;QACV,IAAI,EAAE,8BAAa,CAAC,IAAI;QACxB,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;YACrB,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/B,CAAC;KACJ,CAAC,CAAC;AACP,CAAC,CAAC"}