@contentful/app-sdk 5.0.0-alpha.1 → 5.0.0-alpha.2

package/dist/initialize.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createInitializer = void 0;
+const channel_1 = require("./channel");
+const deferred_1 = require("./utils/deferred");
+function createInitializer(currentGlobal, apiCreator) {
+    if (typeof currentGlobal.window === 'undefined' ||
+        typeof currentGlobal.document === 'undefined') {
+        // make `init` a noop if window or document is not available
+        return () => { };
+    }
+    const connectDeferred = (0, deferred_1.createDeferred)();
+    connectDeferred.promise.then(([channel]) => {
+        const { document } = currentGlobal;
+        document.addEventListener('focus', () => channel.send('setActive', true), true);
+        document.addEventListener('blur', () => channel.send('setActive', false), true);
+    });
+    // We need to connect right away so we can record incoming
+    // messages before `init` is called.
+    (0, channel_1.connect)(currentGlobal, (...args) => connectDeferred.resolve(args));
+    let initializedSdks;
+    return function init(initCb, { makeCustomApi, supressIframeWarning, } = {
+        supressIframeWarning: false,
+    }) {
+        if (!supressIframeWarning) {
+            warnIfOutsideOfContentful(currentGlobal);
+        }
+        if (!initializedSdks) {
+            initializedSdks = connectDeferred.promise.then(([channel, params, messageQueue]) => {
+                const api = apiCreator(channel, params, currentGlobal);
+                let customApi;
+                if (typeof makeCustomApi === 'function') {
+                    customApi = makeCustomApi(channel, params);
+                }
+                // Handle pending incoming messages.
+                // APIs are created before so handlers are already
+                // registered on the channel.
+                messageQueue.forEach((m) => {
+                    // TODO Expose private handleMessage method
+                    ;
+                    channel._handleMessage(m);
+                });
+                return [api, customApi];
+            });
+            if (!connectDeferred.isFulfilled) {
+                (0, channel_1.sendInitMessage)(currentGlobal);
+            }
+        }
+        initializedSdks.then(([sdk, customSdk]) => 
+        // Hand over control to the developer.
+        initCb(sdk, customSdk));
+    };
+}
+exports.createInitializer = createInitializer;
+function warnIfOutsideOfContentful(currentGlobal) {
+    if (currentGlobal.self === currentGlobal.top) {
+        console.error(`Cannot use App SDK outside of Contenful:
+
+In order for the App SDK to function correctly, your app needs to be run in an iframe in the Contentful Web App, Compose or Launch.
+
+Learn more about local development with the App SDK here:
+https://www.contentful.com/developers/docs/extensibility/ui-extensions/faq/#how-can-i-develop-with-the-ui-extension-sdk-locally`);
+    }
+}

package/dist/locations.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const locations = {
+    LOCATION_ENTRY_FIELD: 'entry-field',
+    LOCATION_ENTRY_FIELD_SIDEBAR: 'entry-field-sidebar',
+    LOCATION_ENTRY_SIDEBAR: 'entry-sidebar',
+    LOCATION_DIALOG: 'dialog',
+    LOCATION_ENTRY_EDITOR: 'entry-editor',
+    LOCATION_PAGE: 'page',
+    LOCATION_APP_CONFIG: 'app-config',
+    LOCATION_HOME: 'home',
+};
+exports.default = locations;

package/dist/navigator.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const signal_1 = require("./signal");
+function createNavigator(channel, ids) {
+    const _onSlideInSignal = new signal_1.Signal();
+    channel.addHandler('navigateSlideIn', (data) => {
+        _onSlideInSignal.dispatch(data);
+    });
+    return {
+        openEntry: (id, opts) => {
+            return channel.call('navigateToContentEntity', {
+                ...opts,
+                entityType: 'Entry',
+                id,
+            });
+        },
+        openNewEntry: (contentTypeId, opts) => {
+            return channel.call('navigateToContentEntity', {
+                ...opts,
+                entityType: 'Entry',
+                id: null,
+                contentTypeId,
+            });
+        },
+        openBulkEditor: (entryId, opts) => {
+            return channel.call('navigateToBulkEditor', {
+                entryId,
+                ...opts,
+            });
+        },
+        openAsset: (id, opts) => {
+            return channel.call('navigateToContentEntity', {
+                ...opts,
+                entityType: 'Asset',
+                id,
+            });
+        },
+        openNewAsset: (opts) => {
+            return channel.call('navigateToContentEntity', {
+                ...opts,
+                entityType: 'Asset',
+                id: null,
+            });
+        },
+        openPage: (opts) => {
+            return channel.call('navigateToPage', { type: 'app', id: ids.app, ...opts });
+        },
+        openAppConfig: () => {
+            return channel.call('navigateToAppConfig');
+        },
+        openEntriesList: (options = {}) => {
+            return channel.call('navigateToSpaceEnvRoute', { route: 'entries', options });
+        },
+        openAssetsList: (options = {}) => {
+            return channel.call('navigateToSpaceEnvRoute', { route: 'assets', options });
+        },
+        onSlideInNavigation: (handler) => {
+            return _onSlideInSignal.attach(handler);
+        },
+    };
+}
+exports.default = createNavigator;

package/dist/signal.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MemoizedSignal = exports.Signal = void 0;
+class Signal {
+    constructor() {
+        this._id = 0;
+        this._listeners = {};
+    }
+    dispatch(...args) {
+        for (const key in this._listeners) {
+            this._listeners[key](...args);
+        }
+    }
+    attach(listener) {
+        if (typeof listener !== 'function') {
+            throw new Error('listener function expected');
+        }
+        const id = this._id++;
+        this._listeners[id] = listener;
+        // return function that'll detach the listener
+        return () => delete this._listeners[id];
+    }
+}
+exports.Signal = Signal;
+class MemoizedSignal extends Signal {
+    constructor(...memoizedArgs) {
+        super();
+        if (!memoizedArgs.length) {
+            throw new Error('Initial value to be memoized expected');
+        }
+        this._memoizedArgs = memoizedArgs;
+    }
+    dispatch(...args) {
+        this._memoizedArgs = args;
+        super.dispatch(...args);
+    }
+    attach(listener) {
+        /*
+         * attaching first so that we throw a sensible
+         * error if listener is not a function without
+         * duplication of is function check
+         */
+        const detachListener = super.attach(listener);
+        listener(...this._memoizedArgs);
+        return detachListener;
+    }
+    getMemoizedArgs() {
+        return this._memoizedArgs;
+    }
+}
+exports.MemoizedSignal = MemoizedSignal;

package/dist/types/api.types.d.ts

@@ -122,14 +122,6 @@ export interface SharedEditorSDK {
          * @returns Function to unsubscribe. `callback` won't be called anymore.
          */
         onLocaleSettingsChanged: (callback: (localeSettings: EditorLocaleSettings) => void) => () => void;
-        /**
-         * Subscribes to changes of whether or not disabled fields are displayed
-         *
-         * @param callback Function that is called every time the setting whether or not disabled fields are displayed changes. Called immediately with the current state.
-         * @returns Function to unsubscribe. `callback` won't be called anymore.
-         * @deprecated Use {@link onShowHiddenFieldsChanged} instead
-         */
-        onShowDisabledFieldsChanged: (callback: (showDisabledFields: boolean) => void) => () => void;
         /**
          * Returns whether or not hidden fields are displayed
          *

package/dist/types/api.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/app.types.d.ts

@@ -12,10 +12,6 @@ interface AppStateEditorInterfaceItem {
         position: number;
         settings?: Record<string, any>;
     };
-    /**
-     * @deprecated use `editors` instead
-     */
-    editor?: boolean;
 }
 export interface AppState {
     EditorInterface: Record<ContentType['sys']['id'], AppStateEditorInterfaceItem>;

package/dist/types/app.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/cmaClient.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/dialogs.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/entities.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/entry.types.d.ts

@@ -34,11 +34,6 @@ export interface EntryAPI extends TaskAPI {
     fields: {
         [key: string]: EntryFieldAPI;
     };
-    /**
-     * Optional metadata on an entry
-     * @deprecated
-     */
-    metadata?: Metadata;
     getMetadata: () => Metadata | undefined;
     onMetadataChanged: (callback: (metadata?: Metadata) => void) => VoidFunction;
 }

package/dist/types/entry.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/field-locale.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/field.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/navigator.types.d.ts

@@ -9,6 +9,16 @@ export interface AppPageLocationOptions {
     /** A path to navigate to within your app's page location. */
     path?: string;
 }
+export interface OpenEntriesListOptions {
+    filters?: {
+        contentType?: string;
+    };
+}
+export interface OpenAssetsListOptions {
+    filters?: {
+        type?: 'attachment' | 'plaintext' | 'image' | 'audio' | 'video' | 'richtext' | 'presentation' | 'spreadsheet' | 'pdfdocument' | 'archive' | 'code' | 'markup';
+    };
+}
 /** Information about current value of the navigation status. */
 export interface NavigatorPageResponse {
     /** Will be true if navigation was successfully executed by the web app. */
@@ -49,7 +59,7 @@ export interface NavigatorAPI {
         slide?: NavigatorSlideInfo;
     }>;
     openAppConfig: () => Promise<void>;
-    openEntriesList: () => Promise<void>;
-    openAssetsList: () => Promise<void>;
+    openEntriesList: (options?: OpenEntriesListOptions) => Promise<void>;
+    openAssetsList: (options?: OpenAssetsListOptions) => Promise<void>;
     onSlideInNavigation: (fn: (slide: NavigatorSlideInfo) => void) => () => void;
 }

package/dist/types/navigator.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/utils.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/validation-error.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/window.types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/deferred.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDeferred = void 0;
+function createDeferred() {
+    const deferred = {
+        // @ts-expect-error Immediately set below
+        promise: null,
+        // @ts-expect-error Promise executor is immdiately executed and sets `resolve`
+        resolve: null,
+        isFulfilled: false,
+    };
+    deferred.promise = new Promise((resolve) => {
+        deferred.resolve = (...args) => {
+            deferred.isFulfilled = true;
+            resolve(...args);
+        };
+    });
+    return deferred;
+}
+exports.createDeferred = createDeferred;

package/dist/window.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function createWindow(currentGlobal, channel) {
+    const { document, MutationObserver, ResizeObserver } = currentGlobal;
+    let oldHeight;
+    let isAutoResizing = false;
+    let checkAbsoluteElements = false;
+    const absolutePositionedElems = new Set();
+    const mutationObserver = new MutationObserver((mutations) => {
+        checkAbsolutePositionedElems(mutations);
+        if (isAutoResizing) {
+            self.updateHeight();
+        }
+    });
+    const resizeObserver = new ResizeObserver(() => {
+        self.updateHeight();
+    });
+    mutationObserver.observe(document.body, {
+        attributes: true,
+        childList: true,
+        subtree: true,
+        characterData: true,
+    });
+    const self = { startAutoResizer, stopAutoResizer, updateHeight };
+    return self;
+    function checkAbsoluteElementStyle(type, element) {
+        const computedStyle = getComputedStyle(element);
+        if (computedStyle.position !== 'absolute') {
+            return false;
+        }
+        switch (type) {
+            case 'attributes':
+                return computedStyle.display !== 'none';
+            default:
+                return true;
+        }
+    }
+    function checkAbsolutePositionedElems(mutations) {
+        mutations.forEach((mutation) => {
+            switch (mutation.type) {
+                case 'attributes':
+                    if (mutation.target.nodeType === Node.ELEMENT_NODE) {
+                        const element = mutation.target;
+                        if (checkAbsoluteElementStyle(mutation.type, element)) {
+                            absolutePositionedElems.add(element);
+                        }
+                        else {
+                            absolutePositionedElems.delete(element);
+                        }
+                    }
+                    break;
+                case 'childList':
+                    mutation.addedNodes.forEach((node) => {
+                        if (node.nodeType === Node.ELEMENT_NODE) {
+                            const element = node;
+                            if (checkAbsoluteElementStyle(mutation.type, element)) {
+                                absolutePositionedElems.add(element);
+                            }
+                        }
+                    });
+                    mutation.removedNodes.forEach((node) => {
+                        const element = node;
+                        absolutePositionedElems.delete(element);
+                    });
+                    break;
+            }
+        });
+    }
+    function startAutoResizer({ absoluteElements = false } = {}) {
+        checkAbsoluteElements = Boolean(absoluteElements);
+        self.updateHeight();
+        if (isAutoResizing) {
+            return;
+        }
+        isAutoResizing = true;
+        resizeObserver.observe(document.body);
+    }
+    function stopAutoResizer() {
+        if (!isAutoResizing) {
+            return;
+        }
+        isAutoResizing = false;
+        resizeObserver.disconnect();
+    }
+    function updateHeight(height = null) {
+        if (height === null) {
+            const documentHeight = Math.ceil(document.documentElement.getBoundingClientRect().height);
+            // Only check for absolute elements if option is provided to startAutoResizer
+            if (checkAbsoluteElements && absolutePositionedElems.size) {
+                let maxHeight = documentHeight;
+                absolutePositionedElems.forEach((element) => {
+                    maxHeight = Math.max(element.getBoundingClientRect().bottom, maxHeight);
+                });
+                height = maxHeight;
+            }
+            else {
+                height = documentHeight;
+            }
+        }
+        if (height !== oldHeight) {
+            channel.send('setHeight', height);
+            oldHeight = height;
+        }
+    }
+}
+exports.default = createWindow;

package/package.json

@@ -1 +1,118 @@
-{"name":"@contentful/app-sdk","description":"A JavaScript library to develop custom apps for Contentful","version":"5.0.0-alpha.1","author":"Contentful GmbH","license":"MIT","sideEffects":true,"repository":{"url":"https://github.com/contentful/ui-extensions-sdk.git","type":"git"},"homepage":"https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/","main":"dist/cf-extension-api.js","unpkg":"dist/cf-extension-api.bundled.js","jsdelivr":"dist/cf-extension-api.bundled.js","types":"dist/index.d.ts","files":["dist/cf-extension-api.js","dist/cf-extension-api.js.map","dist/cf-extension-api.bundled.js","dist/cf-extension.css","dist/**/*.d.ts"],"scripts":{"test":"ts-mocha -p tsconfig.test.json 'test/unit/*.[jt]s' --reporter mocha-multi-reporters --reporter-options configFile=mocha.unit-reporters.json","lint":"eslint '{lib,test}/**/*.{t,j}s'","lint:fix":"npm run lint -- --fix","build":"npm run check-types && rollup -c --compact","build:debug":"npm run build -- --sourcemap","prepublishOnly":"npm run build","size":"echo \"Gzipped, estimate: $(gzip -9 -c dist/cf-extension-api.js | wc -c) bytes\"","semantic-release":"semantic-release","publish-all":"node ./scripts/publish.js","verify":"node ./scripts/verify.js","check-types":"tsc --noEmit -m commonjs","prepare":"husky install","lint-staged":"lint-staged"},"dependencies":{"contentful-management":">=7.30.0"},"devDependencies":{"@rollup/plugin-commonjs":"^25.0.2","@rollup/plugin-node-resolve":"^15.1.0","@semantic-release/changelog":"6.0.3","@semantic-release/exec":"6.0.3","@semantic-release/git":"10.0.1","@testing-library/dom":"9.3.1","@types/chai-as-promised":"7.1.5","@types/cross-spawn":"6.0.2","@types/fs-extra":"11.0.1","@types/jsdom":"21.1.1","@types/mocha":"10.0.1","@types/nanoid":"3.0.0","@types/sinon":"^10.0.0","@types/sinon-chai":"^3.2.5","@typescript-eslint/eslint-plugin":"5.61.0","@typescript-eslint/parser":"5.62.0","babel-eslint":"10.1.0","chai":"4.3.7","chai-as-promised":"7.1.1","cross-spawn":"7.0.3","eslint":"8.45.0","eslint-config-prettier":"8.8.0","eslint-config-standard":"17.1.0","eslint-plugin-import":"2.27.5","eslint-plugin-node":"11.1.0","eslint-plugin-prettier":"4.2.1","eslint-plugin-promise":"6.1.1","eslint-plugin-react":"7.32.2","eslint-plugin-standard":"5.0.0","fs-extra":"11.1.1","husky":"8.0.3","jsdom":"22.1.0","lint-staged":"13.2.3","mocha":"10.2.0","mocha-junit-reporter":"2.2.1","mocha-multi-reporters":"1.5.1","mochawesome":"7.1.3","mochawesome-merge":"4.3.0","mochawesome-report-generator":"6.2.0","prettier":"2.8.8","rollup":"2.79.1","rollup-plugin-terser":"7.0.2","rollup-plugin-typescript2":"0.35.0","semantic-release":"21.0.7","sinon":"15.2.0","sinon-chai":"3.7.0","ts-mocha":"10.0.0","tslib":"2.6.0","typescript":"5.1.6"},"lint-staged":{"*.ts":["prettier --write","eslint --fix","git add"],"*.md":["prettier --write","git add"]},"release":{"branches":["master",{"name":"canary","channel":"canary","prerelease":"alpha"}],"plugins":["@semantic-release/commit-analyzer","@semantic-release/release-notes-generator","@semantic-release/changelog",["@semantic-release/npm",{"npmPublish":false}],["@semantic-release/exec",{"verifyConditionsCmd":"node ./scripts/verify.js","publishCmd":"npm run publish-all"}],["@semantic-release/git",{"message":"chore: ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}","assets":["CHANGELOG.md","package.json","package-lock.json"]}],"@semantic-release/github"]}}
+{
+  "name": "@contentful/app-sdk",
+  "description": "A JavaScript library to develop custom apps for Contentful",
+  "version": "5.0.0-alpha.2",
+  "author": "Contentful GmbH",
+  "license": "MIT",
+  "sideEffects": true,
+  "repository": {
+    "url": "https://github.com/contentful/ui-extensions-sdk.git",
+    "type": "git"
+  },
+  "homepage": "https://www.contentful.com/developers/docs/extensibility/app-framework/sdk/",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "test": "ts-mocha -p tsconfig.test.json 'test/unit/*.[jt]s' --reporter mocha-multi-reporters --reporter-options configFile=mocha.unit-reporters.json",
+    "lint": "eslint '{lib,test}/**/*.{t,j}s'",
+    "lint:fix": "npm run lint -- --fix",
+    "build": "npm run clean && npm run build:types && npm run build:cjs",
+    "build:types": "tsc --emitDeclarationOnly",
+    "build:cjs": "tsc",
+    "prepublishOnly": "npm run build",
+    "semantic-release": "semantic-release",
+    "prepare": "husky install",
+    "lint-staged": "lint-staged"
+  },
+  "dependencies": {
+    "contentful-management": ">=7.30.0"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "6.0.3",
+    "@semantic-release/git": "10.0.1",
+    "@testing-library/dom": "9.3.1",
+    "@types/chai-as-promised": "7.1.5",
+    "@types/cross-spawn": "6.0.2",
+    "@types/fs-extra": "11.0.1",
+    "@types/jsdom": "21.1.1",
+    "@types/mocha": "10.0.1",
+    "@types/nanoid": "3.0.0",
+    "@types/sinon": "^10.0.0",
+    "@types/sinon-chai": "^3.2.5",
+    "@typescript-eslint/eslint-plugin": "5.61.0",
+    "@typescript-eslint/parser": "5.62.0",
+    "babel-eslint": "10.1.0",
+    "chai": "4.3.7",
+    "chai-as-promised": "7.1.1",
+    "cross-spawn": "7.0.3",
+    "eslint": "8.45.0",
+    "eslint-config-prettier": "8.8.0",
+    "eslint-config-standard": "17.1.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-prettier": "4.2.1",
+    "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-react": "7.32.2",
+    "eslint-plugin-standard": "5.0.0",
+    "fs-extra": "11.1.1",
+    "husky": "8.0.3",
+    "jsdom": "22.1.0",
+    "lint-staged": "13.2.3",
+    "mocha": "10.2.0",
+    "mocha-junit-reporter": "2.2.1",
+    "mocha-multi-reporters": "1.5.1",
+    "mochawesome": "7.1.3",
+    "mochawesome-merge": "4.3.0",
+    "mochawesome-report-generator": "6.2.0",
+    "prettier": "2.8.8",
+    "rimraf": "^5.0.1",
+    "semantic-release": "21.0.7",
+    "sinon": "15.2.0",
+    "sinon-chai": "3.7.0",
+    "ts-mocha": "10.0.0",
+    "typescript": "5.1.6"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "prettier --write",
+      "eslint --fix",
+      "git add"
+    ],
+    "*.md": [
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "release": {
+    "branches": [
+      "master",
+      {
+        "name": "canary",
+        "channel": "canary",
+        "prerelease": "alpha"
+      }
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      [
+        "@semantic-release/git",
+        {
+          "message": "chore: ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}",
+          "assets": [
+            "CHANGELOG.md",
+            "package.json",
+            "package-lock.json"
+          ]
+        }
+      ],
+      "@semantic-release/github"
+    ]
+  }
+}

package/dist/README.md

@@ -1,9 +0,0 @@
-# !! WARNING !!
-
-`cf-extension.css` file in this directory is a prebuilt committed version of legacy
-Contentful UI Extension styles.
-
-It is here for backwards compatibility only: it will be packaged and published on npm
-so it's available under its legacy URL:
-
-https://unpkg.com/contentful-ui-extensions-sdk/dist/cf-extension.css