@atlassian/clientside-extensions 2.4.0-e0cce94-kuewz5ow

package/dist/esm/ModalExtension.js

@@ -0,0 +1,117 @@
+import { onDebug } from '@atlassian/clientside-extensions-debug';
+import { ExtensionType } from './extension-type';
+import { safeguard } from './AbstractExtension';
+export const factory = (provider) => {
+    return (...args) => {
+        const attributes = provider(...args);
+        return {
+            ...attributes,
+            type: ExtensionType.modal,
+        };
+    };
+};
+const noop = () => { };
+export var Appearance;
+(function (Appearance) {
+    Appearance["danger"] = "danger";
+    Appearance["warning"] = "warning";
+})(Appearance || (Appearance = {}));
+export var Width;
+(function (Width) {
+    Width["small"] = "small";
+    Width["medium"] = "medium";
+    Width["large"] = "large";
+    Width["x-large"] = "x-large";
+})(Width || (Width = {}));
+export 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)) {
+                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)) {
+                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 = safeguard('onMount', callback);
+            return this;
+        };
+        this.onUnmount = (callback) => {
+            this.cleanupCallback = safeguard('onUnmount', callback);
+            return this;
+        };
+        this.closeModal = () => {
+            this.closeModalFn();
+        };
+        this.closeModalFn = 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 = 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 };
+        });
+    }
+}
+//# sourceMappingURL=ModalExtension.js.map

package/dist/esm/ModalExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModalExtension.js","sourceRoot":"","sources":["../../lib/ModalExtension.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAC;AASjE,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AA2BhD,MAAM,CAAC,MAAM,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,aAAa,CAAC,KAAK;SAC5B,CAAC;IACN,CAAC,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;AAEtB,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IAClB,+BAAmB,CAAA;IACnB,iCAAqB,CAAA;AACzB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAED,MAAM,CAAN,IAAY,KAKX;AALD,WAAY,KAAK;IACb,wBAAiB,CAAA;IACjB,0BAAmB,CAAA;IACnB,wBAAiB,CAAA;IACjB,4BAAqB,CAAA;AACzB,CAAC,EALW,KAAK,KAAL,KAAK,QAKhB;AAED,MAAM,OAAO,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,OAAO,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,OAAO,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,SAAS,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,SAAS,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,SAAS,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,SAAS,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"}

package/dist/esm/ModalExtension.test.js

@@ -0,0 +1,118 @@
+import { onDebug } from '@atlassian/clientside-extensions-debug';
+import * as ModalExtension from './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(onDebug).toHaveBeenCalledTimes(1);
+        });
+        it('#onUnmount fails gracefully if callback throws error', () => {
+            api.onUnmount(() => {
+                throw Error('whoops');
+            });
+            expect(() => {
+                api.getCleanupCallback()(el);
+            }).not.toThrow();
+            expect(onDebug).toHaveBeenCalledTimes(1);
+        });
+    });
+});
+//# sourceMappingURL=ModalExtension.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ModalExtension.test.js","sourceRoot":"","sources":["../../lib/ModalExtension.test.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAC;AACjE,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC;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,OAAO,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,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/esm/PageExtension.js

@@ -0,0 +1,10 @@
+import { ExtensionType } from './extension-type';
+export const factory = (renderCallback) => {
+    return () => ({
+        type: ExtensionType.page,
+        onAction: (node, data) => {
+            renderCallback(node, data);
+        },
+    });
+};
+//# sourceMappingURL=PageExtension.js.map

package/dist/esm/PageExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageExtension.js","sourceRoot":"","sources":["../../lib/PageExtension.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAWjD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAgB,cAA6C,EAAyC,EAAE;IAC3H,OAAO,GAAG,EAAE,CAAC,CAAC;QACV,IAAI,EAAE,aAAa,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"}

package/dist/esm/PageExtension.test.js

@@ -0,0 +1,31 @@
+/**
+ * @jest-environment jsdom
+ */
+import * as PageExtension from './PageExtension';
+describe('PageExtension', () => {
+    it('should generate the extension shape', () => {
+        // given
+        const fakeRenderCallback = jest.fn();
+        // when
+        const extensionProvider = PageExtension.factory(fakeRenderCallback);
+        const extension = extensionProvider();
+        // then
+        expect(extension).toEqual({
+            type: 'page',
+            onAction: expect.any(Function),
+        });
+    });
+    it('should call the render callback', () => {
+        // given
+        const fakeRenderCallback = jest.fn();
+        const extensionProvider = PageExtension.factory(fakeRenderCallback);
+        const extension = extensionProvider();
+        const fakeNode = document.createElement('div');
+        const fakeDataProvider = { foo: 'bar' };
+        // when
+        extension.onAction(fakeNode, fakeDataProvider);
+        // then
+        expect(fakeRenderCallback).toHaveBeenCalledWith(fakeNode, fakeDataProvider);
+    });
+});
+//# sourceMappingURL=PageExtension.test.js.map

package/dist/esm/PageExtension.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageExtension.test.js","sourceRoot":"","sources":["../../lib/PageExtension.test.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AAEjD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC3C,QAAQ;QACR,MAAM,kBAAkB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QAErC,OAAO;QACP,MAAM,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,iBAAiB,EAAE,CAAC;QAEtC,OAAO;QACP,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,MAAM;YACZ,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SACjC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACvC,QAAQ;QACR,MAAM,kBAAkB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,iBAAiB,EAAE,CAAC;QAEtC,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,gBAAgB,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;QAExC,OAAO;QACP,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAE/C,OAAO;QACP,MAAM,CAAC,kBAAkB,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/esm/PanelExtension.js

@@ -0,0 +1,32 @@
+import { ExtensionType } from './extension-type';
+import { safeguard } from './AbstractExtension';
+export const factory = (provider) => {
+    return (...args) => {
+        return {
+            ...provider(...args),
+            type: ExtensionType.panel,
+        };
+    };
+};
+const noop = () => { };
+export class Api {
+    constructor() {
+        this.renderCallback = noop;
+        this.cleanupCallback = noop;
+    }
+    onMount(callback) {
+        this.renderCallback = safeguard('onMount', callback);
+        return this;
+    }
+    onUnmount(callback) {
+        this.cleanupCallback = safeguard('onUnmount', callback);
+        return this;
+    }
+    getRenderCallback() {
+        return this.renderCallback;
+    }
+    getCleanupCallback() {
+        return this.cleanupCallback;
+    }
+}
+//# sourceMappingURL=PanelExtension.js.map

package/dist/esm/PanelExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PanelExtension.js","sourceRoot":"","sources":["../../lib/PanelExtension.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAWhD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAW,QAA2C,EAAqC,EAAE;IAChH,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE;QACf,OAAO;YACH,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC;YACpB,IAAI,EAAE,aAAa,CAAC,KAAK;SAC5B,CAAC;IACN,CAAC,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,IAAI,GAAG,GAAG,EAAE,GAAE,CAAC,CAAC;AAEtB,MAAM,OAAO,GAAG;IAAhB;QACY,mBAAc,GAAsB,IAAI,CAAC;QAEzC,oBAAe,GAAsB,IAAI,CAAC;IAqBtD,CAAC;IAnBU,OAAO,CAAC,QAA2B;QACtC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAErD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,QAA2B;QACxC,IAAI,CAAC,eAAe,GAAG,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAExD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,iBAAiB;QACpB,OAAO,IAAI,CAAC,cAAc,CAAC;IAC/B,CAAC;IAEM,kBAAkB;QACrB,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;CACJ"}

package/dist/esm/PanelExtension.test.js

@@ -0,0 +1,109 @@
+import { onDebug } from '@atlassian/clientside-extensions-debug';
+import * as PanelExtension from './PanelExtension';
+jest.mock('@atlassian/clientside-extensions-debug');
+describe('PanelExtension', () => {
+    // @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 = PanelExtension.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: 'panel',
+            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 = PanelExtension.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 = PanelExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, { value: 42 });
+        // expect label to change because of context
+        expect(extension).toEqual({
+            type: 'panel',
+            label: 'The meaning of life',
+            onAction: expect.any(Function),
+        });
+    });
+    describe('API', () => {
+        let api;
+        const el = document.createElement('div');
+        beforeEach(() => {
+            api = new PanelExtension.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(onDebug).toHaveBeenCalledTimes(1);
+        });
+        it('#onUnmount fails gracefully if callback throws error', () => {
+            api.onUnmount(() => {
+                throw Error('whoops');
+            });
+            expect(() => {
+                api.getCleanupCallback()(el);
+            }).not.toThrow();
+            expect(onDebug).toHaveBeenCalledTimes(1);
+        });
+    });
+});
+//# sourceMappingURL=PanelExtension.test.js.map

package/dist/esm/PanelExtension.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PanelExtension.test.js","sourceRoot":"","sources":["../../lib/PanelExtension.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,wCAAwC,CAAC;AACjE,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC;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,QAAQ,CAAC,KAAK,EAAE,GAAG,EAAE;QACjB,IAAI,GAAuB,CAAC;QAC5B,MAAM,EAAE,GAAgB,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAEtD,UAAU,CAAC,GAAG,EAAE;YACZ,GAAG,GAAG,IAAI,cAAc,CAAC,GAAG,EAAE,CAAC;QACnC,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,OAAO,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,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/esm/SectionExtension.js

@@ -0,0 +1,10 @@
+import { ExtensionType } from './extension-type';
+export const factory = (provider) => {
+    return (...args) => {
+        return {
+            ...provider(...args),
+            type: ExtensionType.section,
+        };
+    };
+};
+//# sourceMappingURL=SectionExtension.js.map

package/dist/esm/SectionExtension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SectionExtension.js","sourceRoot":"","sources":["../../lib/SectionExtension.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAQjD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAW,QAA6C,EAAuC,EAAE;IACpH,OAAO,CAAC,GAAG,IAAI,EAAE,EAAE;QACf,OAAO;YACH,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC;YACpB,IAAI,EAAE,aAAa,CAAC,OAAO;SAC9B,CAAC;IACN,CAAC,CAAC;AACN,CAAC,CAAC"}

package/dist/esm/SectionExtension.test.js

@@ -0,0 +1,43 @@
+import * as SectionExtension from './SectionExtension';
+describe('SectionExtension', () => {
+    // @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',
+        };
+    };
+    const testAPI = {
+        onCleanup: jest.fn(),
+        updateAttributes: jest.fn(),
+    };
+    it('should generate the extension descriptor with the correct type', () => {
+        const extensionProvider = SectionExtension.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: 'section',
+            label: 'A label',
+        });
+    });
+    it('should provide a extensionAPI object to the extension provider', () => {
+        expect(testAPI.onCleanup).toHaveBeenCalledTimes(0);
+        expect(testAPI.updateAttributes).toHaveBeenCalledTimes(0);
+        const extensionProvider = SectionExtension.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 = SectionExtension.factory(testAttributesProvider);
+        const extension = extensionProvider(testAPI, { value: 42 });
+        // expect label to change because of context
+        expect(extension).toEqual({
+            type: 'section',
+            label: 'The meaning of life',
+        });
+    });
+});
+//# sourceMappingURL=SectionExtension.test.js.map

package/dist/esm/SectionExtension.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SectionExtension.test.js","sourceRoot":"","sources":["../../lib/SectionExtension.test.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,gBAAgB,MAAM,oBAAoB,CAAC;AAOvD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAC9B,2CAA2C;IAC3C,MAAM,sBAAsB,GAA8B,CAAC,GAAG,EAAE,OAAoB,EAAE,EAAE;QACpF,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;SAClE,CAAC;IACN,CAAC,CAAC;IACF,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,gBAAgB,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC3E,MAAM,SAAS,GAAG,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAEjD,yFAAyF;QACzF,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC;YACtB,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,SAAS;SACnB,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,gBAAgB,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC3E,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,gBAAgB,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC3E,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,SAAS;YACf,KAAK,EAAE,qBAAqB;SAC/B,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/esm/extension-type.js

@@ -0,0 +1,12 @@
+// eslint-disable-next-line import/prefer-default-export
+export var ExtensionType;
+(function (ExtensionType) {
+    ExtensionType["asyncPanel"] = "async-panel";
+    ExtensionType["button"] = "button";
+    ExtensionType["link"] = "link";
+    ExtensionType["modal"] = "modal";
+    ExtensionType["panel"] = "panel";
+    ExtensionType["page"] = "page";
+    ExtensionType["section"] = "section";
+})(ExtensionType || (ExtensionType = {}));
+//# sourceMappingURL=extension-type.js.map

package/dist/esm/extension-type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension-type.js","sourceRoot":"","sources":["../../lib/extension-type.ts"],"names":[],"mappings":"AAAA,wDAAwD;AACxD,MAAM,CAAN,IAAY,aAQX;AARD,WAAY,aAAa;IACrB,2CAA4B,CAAA;IAC5B,kCAAiB,CAAA;IACjB,8BAAa,CAAA;IACb,gCAAe,CAAA;IACf,gCAAe,CAAA;IACf,8BAAa,CAAA;IACb,oCAAmB,CAAA;AACvB,CAAC,EARW,aAAa,KAAb,aAAa,QAQxB"}

package/dist/esm/index.js

@@ -0,0 +1,10 @@
+import * as AsyncPanelExtension from './AsyncPanelExtension';
+import * as ButtonExtension from './ButtonExtension';
+import * as LinkExtension from './LinkExtension';
+import * as ModalExtension from './ModalExtension';
+import * as PanelExtension from './PanelExtension';
+import * as SectionExtension from './SectionExtension';
+import * as PageExtension from './PageExtension';
+import { ExtensionType } from './extension-type';
+export { AsyncPanelExtension, ButtonExtension, LinkExtension, ModalExtension, PanelExtension, SectionExtension, PageExtension, ExtensionType, };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,mBAAmB,MAAM,uBAAuB,CAAC;AAC7D,OAAO,KAAK,eAAe,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,gBAAgB,MAAM,oBAAoB,CAAC;AACvD,OAAO,KAAK,aAAa,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAIjD,OAAO,EACH,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,aAAa,GAChB,CAAC"}

package/dist/types/AbstractExtension.d.ts

@@ -0,0 +1,11 @@
+declare type Callable = (...args: any[]) => any;
+export interface LifecycleCallback {
+    (element: HTMLElement): void;
+}
+export interface MountableExtension {
+    onMount(mountCallback: LifecycleCallback): MountableExtension;
+    onUnmount(unmountCallback: LifecycleCallback): MountableExtension;
+}
+export declare function safeguard<T extends Callable>(callbackDebugName: string, callback: T): (...args: Parameters<T>) => ReturnType<T>;
+export {};
+//# sourceMappingURL=AbstractExtension.d.ts.map

package/dist/types/AbstractExtension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractExtension.d.ts","sourceRoot":"","sources":["../../lib/AbstractExtension.ts"],"names":[],"mappings":"AAIA,aAAK,QAAQ,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAC;AAExC,MAAM,WAAW,iBAAiB;IAC9B,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,kBAAkB;IAC/B,OAAO,CAAC,aAAa,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;IAE9D,SAAS,CAAC,eAAe,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;CACrE;AAED,wBAAgB,SAAS,CAAC,CAAC,SAAS,QAAQ,EAAE,iBAAiB,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAc/H"}

package/dist/types/AsyncPanelExtension.d.ts

@@ -0,0 +1,18 @@
+import type { ExtensionAttributes, ExtensionAttributesProvider, Context } from '@atlassian/clientside-extensions-registry';
+import type { PanelRenderExtension } from './PanelExtension';
+import { Api } from './PanelExtension';
+import { ExtensionType } from './extension-type';
+export interface AsyncPanelRenderExtension extends PanelRenderExtension {
+}
+export interface AsyncPanelAttributes extends ExtensionAttributes {
+    onAction: AsyncPanelRenderExtension;
+    type?: ExtensionType.asyncPanel;
+}
+export declare type AsyncPanelAttributesProvider<ContextT> = ExtensionAttributesProvider<AsyncPanelAttributes, ContextT>;
+export interface AsyncPanelAttributesWithContext extends AsyncPanelAttributes {
+    contextProvider: () => Context<{}>;
+}
+export declare type AsyncPanelAttributesProviderWithContext<ContextT> = ExtensionAttributesProvider<AsyncPanelAttributesWithContext, ContextT>;
+export declare const factory: <ContextT>(provider: ExtensionAttributesProvider<AsyncPanelAttributes, ContextT>) => ExtensionAttributesProvider<AsyncPanelAttributesWithContext, ContextT>;
+export { Api };
+//# sourceMappingURL=AsyncPanelExtension.d.ts.map

package/dist/types/AsyncPanelExtension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AsyncPanelExtension.d.ts","sourceRoot":"","sources":["../../lib/AsyncPanelExtension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,OAAO,EAAE,MAAM,2CAA2C,CAAC;AAC3H,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;CAAG;AAE1E,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAC7D,QAAQ,EAAE,yBAAyB,CAAC;IACpC,IAAI,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC;CACnC;AAED,oBAAY,4BAA4B,CAAC,QAAQ,IAAI,2BAA2B,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;AAEjH,MAAM,WAAW,+BAAgC,SAAQ,oBAAoB;IACzE,eAAe,EAAE,MAAM,OAAO,CAAC,EAAE,CAAC,CAAC;CACtC;AAED,oBAAY,uCAAuC,CAAC,QAAQ,IAAI,2BAA2B,CAAC,+BAA+B,EAAE,QAAQ,CAAC,CAAC;AAEvI,eAAO,MAAM,OAAO,6JAWnB,CAAC;AAEF,OAAO,EAAE,GAAG,EAAE,CAAC"}

package/dist/types/AsyncPanelExtension.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AsyncPanelExtension.test.d.ts.map

package/dist/types/AsyncPanelExtension.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AsyncPanelExtension.test.d.ts","sourceRoot":"","sources":["../../lib/AsyncPanelExtension.test.ts"],"names":[],"mappings":""}

package/dist/types/ButtonExtension.d.ts

@@ -0,0 +1,10 @@
+import type { ExtensionAttributes, ExtensionAttributesProvider, OnAction } from '@atlassian/clientside-extensions-registry';
+import { ExtensionType } from './extension-type';
+export interface ButtonAttributes extends ExtensionAttributes {
+    onAction?: OnAction;
+    label: string;
+    type?: ExtensionType.button;
+}
+export declare type ButtonAttributesProvider<ContextT> = ExtensionAttributesProvider<ButtonAttributes, ContextT>;
+export declare const factory: <ContextT>(provider: ExtensionAttributesProvider<ButtonAttributes, ContextT>) => ExtensionAttributesProvider<ButtonAttributes, ContextT>;
+//# sourceMappingURL=ButtonExtension.d.ts.map

package/dist/types/ButtonExtension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ButtonExtension.d.ts","sourceRoot":"","sources":["../../lib/ButtonExtension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,QAAQ,EAAE,MAAM,2CAA2C,CAAC;AAE5H,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,MAAM,WAAW,gBAAiB,SAAQ,mBAAmB;IACzD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC;CAC/B;AAED,oBAAY,wBAAwB,CAAC,QAAQ,IAAI,2BAA2B,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;AAEzG,eAAO,MAAM,OAAO,0IAOnB,CAAC"}

package/dist/types/ButtonExtension.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ButtonExtension.test.d.ts.map

package/dist/types/ButtonExtension.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ButtonExtension.test.d.ts","sourceRoot":"","sources":["../../lib/ButtonExtension.test.ts"],"names":[],"mappings":""}