@vonaffenfels/contentful-slate-editor 1.1.28 → 1.1.30

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vonaffenfels/contentful-slate-editor",
-    "version": "1.1.28",
+    "version": "1.1.30",
     "scripts": {
         "prepublish": "yarn run build",
         "dev": "yarn run start",
@@ -93,10 +93,10 @@
         "webpack-watch-files-plugin": "^1.2.1"
     },
     "dependencies": {
-        "@vonaffenfels/slate-editor": "^1.1.28",
+        "@vonaffenfels/slate-editor": "^1.1.29",
         "webpack": "5.88.2"
     },
-    "gitHead": "a600552bfcbd6e605f8ababe0f4ef6f3222ac58a",
+    "gitHead": "d4bee0dde0eb4aeaaa5881fd11823ccd9258695e",
     "publishConfig": {
         "access": "public"
     }

package/src/components/Dialog.js

@@ -7,6 +7,7 @@ import componentLoader from "@vonaffenfels/slate-editor/componentLoader";
 import BlockEditor from "@vonaffenfels/slate-editor/dist/BlockEditor";
 // eslint-disable-next-line import/no-unresolved
 import storybookStories from "storybookStories";
+import {DialogTranslation} from "./DialogTranslation";
 
 const Dialog = ({
     sdk,
@@ -30,6 +31,8 @@ const Dialog = ({
     switch (sdk.parameters.invocation.type) {
         case "cloudinary":
             return <DialogCloudinary sdk={sdk} config={sdk.parameters.invocation} activeConfig={activeConfig} />;
+        case "translation":
+            return <DialogTranslation sdk={sdk} config={sdk.parameters.invocation} activeConfig={activeConfig} />;
         default:
             return <div className="relative flex h-full max-h-full justify-between">
                 <BlockEditor

package/src/components/DialogTranslation.js

@@ -0,0 +1,298 @@
+import {
+    useEffect, useState,
+} from "react";
+import {
+    Button, Table,
+} from "@contentful/f36-components";
+import getSlug from "speakingurl";
+
+export const DialogTranslation = ({
+    sdk,
+    activeConfig,
+    translateFromLocale = "de",
+}) => {
+    const {entryId} = sdk.parameters.invocation;
+    const [entry, setEntry] = useState(null);
+    const [loading, setLoading] = useState({});
+    const [usage, setUsage] = useState({});
+    const [contentType, setContentType] = useState(null);
+    const localizedFields = contentType?.fields?.filter(field => field.localized);
+
+    const getTranslationUsage = async (content) => {
+        if (!sdk?.parameters?.installation?.translationService) {
+            console.error(`no translation service configured!`);
+            return;
+        }
+
+        try {
+            const response = await fetch(sdk?.parameters?.installation?.translationService + "/usage", {
+                method: "POST",
+                body: JSON.stringify({
+                    editorContent: typeof content === "object" ? content : undefined,
+                    text: typeof content === "string" ? content : undefined,
+                }),
+            });
+
+            const translatedValue = await response.json();
+            return translatedValue?.usage || 0;
+        } catch (e) {
+            console.error(e);
+        }
+    };
+
+    const updateUsage = async (entry, contentType) => {
+        const localizedFields = contentType?.fields?.filter(field => field.localized);
+        const newUsage = {};
+        for (let i = 0; i < localizedFields.length; i++) {
+            const localizedField = localizedFields[i];
+            newUsage[localizedField.id] = await getTranslationUsage(entry?.fields[localizedField.id]?.[translateFromLocale]);
+        }
+
+        return newUsage;
+    };
+
+    useEffect(() => {
+        sdk.space.getEntry(entryId).then(entry => {
+            sdk.space.getContentType(entry.sys.contentType.sys.id).then(contentType => {
+                updateUsage(entry, contentType).then((usage) => {
+                    setUsage(usage);
+                    setEntry(entry);
+                    setContentType(contentType);
+                });
+            });
+        });
+    }, []);
+
+    if (!contentType) {
+        return null;
+    }
+
+    const translateValue = async (content, targetLanguage) => {
+        if (!sdk?.parameters?.installation?.translationService) {
+            console.error(`no translation service configured!`);
+            return;
+        }
+
+        try {
+            const response = await fetch(sdk?.parameters?.installation?.translationService, {
+                method: "POST",
+                body: JSON.stringify({
+                    editorContent: typeof content === "object" ? content : undefined,
+                    text: typeof content === "string" ? content : undefined,
+                    targetLanguage,
+                    translateFromLocale: translateFromLocale,
+                }),
+            });
+
+            const translatedValue = await response.json();
+            return translatedValue?.translation || "";
+        } catch (e) {
+            console.error(e);
+        }
+    };
+
+    const onTranslateClick = async (targetLanguageOrLanguages, refreshAll = false, onlyFields = []) => {
+        if (!Array.isArray(targetLanguageOrLanguages)) {
+            targetLanguageOrLanguages = [targetLanguageOrLanguages];
+        }
+
+        let newEntry = entry;
+        for (let i = 0; i < targetLanguageOrLanguages.length; i++) {
+            if (targetLanguageOrLanguages[i] === translateFromLocale) {
+                continue;
+            }
+
+            newEntry = await translateForLocale(
+                targetLanguageOrLanguages[i], newEntry, refreshAll, onlyFields,
+            );
+        }
+
+        await sdk.space.updateEntry(newEntry);
+        setEntry(await sdk.space.getEntry(entryId));
+    };
+
+    const translateForLocale = async (
+        targetLanguage, entry = {}, refreshAll = false, onlyFields = [],
+    ) => {
+        setLoading({
+            ...loading,
+            [targetLanguage]: true,
+        });
+        const newEntry = {...entry};
+        for (let i = 0; i < localizedFields.length; i++) {
+            const localizedField = localizedFields[i];
+            const currentValue = entry?.fields[localizedField.id]?.[targetLanguage];
+            if (
+                (!refreshAll && !isEmptyValue(currentValue) && !onlyFields.length) ||
+                (onlyFields.length && !onlyFields.includes(localizedField.id))
+            ) {
+                continue;
+            }
+
+            setLoading({
+                ...loading,
+                [targetLanguage + localizedField.id]: true,
+            });
+
+            let newValue = await translateValue(entry?.fields[localizedField.id]?.[sdk.locales.default], targetLanguage);
+
+            setLoading({
+                ...loading,
+                [targetLanguage + localizedField.id]: false,
+            });
+
+            if (!newValue) {
+                continue;
+            }
+
+            if (localizedField.id === "slug" && newValue) {
+                newValue = getSlug(newValue);
+            }
+
+            newEntry.fields[localizedField.id][targetLanguage] = newValue;
+        }
+        setLoading({
+            ...loading,
+            [targetLanguage]: false,
+        });
+
+        return newEntry;
+    };
+
+    const isEmptyValue = (value) => {
+        if (!value) {
+            return true;
+        }
+
+        // editor value
+        if (Array.isArray(value)) {
+            if (value.length === 1 && value[0].type === "paragraph" && value[0].children.length === 1 && value[0].children[0].text === "") {
+                return true;
+            }
+        }
+
+        return false;
+    };
+
+    const isComplete = (locale) => {
+        for (let i = 0; i < localizedFields.length; i++) {
+            const localizedField = localizedFields[i];
+            const value = entry?.fields[localizedField.id]?.[locale];
+
+            if (isEmptyValue(value)) {
+                return false;
+            }
+        }
+
+        return true;
+    };
+
+    const fullUsage = Object.keys(usage || {}).reduce((acc, key) => acc + usage[key], 0);
+
+    return <div className="flex flex-col gap-2 p-4">
+        <Table>
+            <Table.Head>
+                <Table.Row>
+                    <Table.Cell style={{width: 250}}>Feld</Table.Cell>
+                    <Table.Cell style={{width: 100}}>Zeichen</Table.Cell>
+                    {sdk.locales.available.map(locale => {
+                        const languageComplete = isComplete(locale);
+                        const isTranslateFromLocale = locale === translateFromLocale;
+
+                        if (isTranslateFromLocale) {
+                            return <Table.Cell key={locale}/>;
+                        }
+
+                        if (loading[locale]) {
+                            return <Table.Cell key={locale}><Button size="small" variant="transparent">Wird übersetzt</Button></Table.Cell>;
+                        }
+
+                        const buttonLabel = languageComplete ? "Erneut Übersetzen" : "Vervollständigen";
+
+                        return <Table.Cell key={locale}>
+                            <Button
+                                size="small"
+                                className="group"
+                                variant={languageComplete ? "secondary" : "primary"}
+                                title={buttonLabel}
+                                onClick={e => onTranslateClick(locale, languageComplete)}>
+                                {!languageComplete && <span className="text-orange-500">Fehlende Übersetzen</span>}
+                                {languageComplete && <span className="text-green-500">Vollständig Übersetzt</span>}
+                            </Button>
+                        </Table.Cell>;
+                    })}
+                </Table.Row>
+            </Table.Head>
+            <Table.Body>
+                <Table.Row>
+                    <Table.Cell/>
+                    <Table.Cell>∑ {fullUsage}</Table.Cell>
+                    {sdk.locales.available.map(locale => {
+                        const name = sdk.locales.names[locale];
+
+                        return <Table.Cell key={locale}>
+                            {name}
+                        </Table.Cell>;
+                    })}
+                </Table.Row>
+                {localizedFields.map(field => {
+                    return <Table.Row key={field.id}>
+                        <Table.Cell>
+                            <Button
+                                className="max-w-full truncate"
+                                style={{maxWidth: 250}}
+                                size="small"
+                                variant={"transparent"}
+                                title={"Alle Übersetzungen Aktualisieren"}
+                                onClick={e => {
+                                    onTranslateClick(sdk.locales.available, false, [field.id]);
+                                }}>
+                                {field.name}
+                            </Button>
+                        </Table.Cell>
+                        <Table.Cell>
+                            {usage?.[field.id]}
+                        </Table.Cell>
+                        {sdk.locales.available.map(locale => {
+                            let preview = entry?.fields[field.id]?.[locale];
+
+                            if (!preview) {
+                                preview = "";
+                            }
+
+                            if (typeof preview === "object") {
+                                preview = "Keine Vorschau Verfügbar";
+                            }
+
+                            if (locale === translateFromLocale) {
+                                return <Table.Cell key={locale}>
+                                    <div
+                                        className="max-w-full truncate"
+                                        style={{maxWidth: 250}}>
+                                        {preview}
+                                    </div>
+                                </Table.Cell>;
+                            }
+
+                            if (loading[locale + field.id]) {
+                                return <Table.Cell key={locale}><Button size="small" variant="transparent">Wird übersetzt</Button></Table.Cell>;
+                            }
+
+                            return <Table.Cell key={locale}>
+                                <Button
+                                    className="max-w-full truncate"
+                                    style={{maxWidth: 250}}
+                                    size="small"
+                                    variant={"transparent"}
+                                    title={"Übersetzung Aktualisieren"}
+                                    onClick={e => onTranslateClick(locale, false, [field.id])}>
+                                    {preview}
+                                </Button>
+                            </Table.Cell>;
+                        })}
+                    </Table.Row>;
+                })}
+            </Table.Body>
+        </Table>
+    </div>;
+};

package/src/components/Sidebar.js

@@ -0,0 +1,71 @@
+import {Button} from "@contentful/f36-components";
+import React, {
+    useEffect, useState,
+} from "react";
+
+export const Sidebar = ({
+    sdk,
+    activeConfig,
+}) => {
+    return <div className="flex w-full flex-col gap-2">
+        <div className="w-full">
+            <OpenProdPageLink sdk={sdk} activeConfig={activeConfig}/>
+        </div>
+        <div className="w-full">
+            <SidebarTranslations sdk={sdk}/>
+        </div>
+    </div>;
+};
+
+const OpenProdPageLink = ({
+    activeConfig,
+    sdk,
+}) => {
+    const [slug, setSlug] = useState(sdk?.entry?.fields?.slug?.getValue());
+
+    useEffect(() => {
+        if (sdk?.entry?.fields?.slug) {
+            return sdk.entry.fields.slug.onValueChanged(setSlug);
+        }
+    }, [sdk]);
+
+    const disabled = !activeConfig?.domain || !slug;
+    const link = `${activeConfig.domain}/${slug}`;
+
+    const onClick = () => {
+        if (disabled) {
+            return;
+        }
+        window.open(link, "_blank");
+    };
+
+    return <Button isDisabled={disabled} isFullWidth={true} variant="secondary" onClick={onClick}>Live-Seite öffnen</Button>;
+};
+
+const SidebarTranslations = ({sdk}) => {
+    const enabled = sdk?.parameters?.installation?.usersWithTranslation?.includes(sdk?.user?.email) && sdk?.parameters?.installation?.translationService;
+
+    if (!enabled) {
+        return null;
+    }
+
+    const onClick = () => {
+        sdk.dialogs.openCurrentApp({
+            title: 'Übersetzen',
+            width: 'fullWidth',
+            position: "center",
+            allowHeightOverflow: true,
+            shouldCloseOnOverlayClick: false,
+            shouldCloseOnEscapePress: false,
+            minHeight: 500,
+            parameters: {
+                type: "translation",
+                entryId: sdk.entry.getSys().id,
+            },
+        });
+    };
+
+    return <>
+        <Button isFullWidth={true} onClick={onClick}>Übersetzen</Button>
+    </>;
+};

package/src/index.js

@@ -14,6 +14,7 @@ import EntryEditor from './components/EntryEditor';
 import Config from './components/ConfigScreen';
 import Field from './components/Field';
 import Dialog from "./components/Dialog";
+import {Sidebar} from "./components/Sidebar";
 
 export const BaseContentfulApp = (props) => {
     init(async (sdk) => {
@@ -69,6 +70,10 @@ export const BaseContentfulApp = (props) => {
                 location: locations.LOCATION_DIALOG,
                 component: <Dialog sdk={sdk} elementPropsMap={elementPropsMap} activeConfig={config}/>,
             },
+            {
+                location: locations.LOCATION_ENTRY_SIDEBAR,
+                component: <Sidebar sdk={sdk} activeConfig={config}/>,
+            },
         ];
 
         ComponentLocationSettings.forEach((componentLocationSetting) => {