@smartcat/sanity-plugin 1.0.1 → 1.1.0

package/dist/index.js

@@ -1,13 +1,13 @@
-import { defineType, defineField, defineArrayMember, useClient, prepareForPreview, useSchema, useRelativeTime, useValuePreview, useWorkspace, useFormValue, definePlugin } from "sanity";
+import { defineType, defineField, defineArrayMember, useClient, prepareForPreview, useSchema, usePerspective, useRelativeTime, useValuePreview, useWorkspace, useFormValue, definePlugin } from "sanity";
 import { TranslateIcon, CogIcon, AddIcon, LaunchIcon, CheckmarkIcon, CopyIcon, SyncIcon, ArrowLeftIcon, TrashIcon, PublishIcon, DownloadIcon, CloseIcon, RemoveCircleIcon, JsonIcon } from "@sanity/icons";
 import { TRANSLATION_PROJECT_TYPE, SETTINGS_TYPE, API_VERSION, SETTINGS_DOC_ID, requireSourceLanguage } from "./_chunks-es/constants.js";
 import { jsxs, jsx, Fragment } from "react/jsx-runtime";
 import { useState, useRef, useEffect, useCallback, useMemo, useLayoutEffect, Fragment as Fragment$1 } from "react";
-import { Select, useToast, Flex, Spinner, Stack, Label, TextInput, Card, Text, Switch, Button, Badge, Heading, Dialog, Box, Inline, useTheme_v2, useTheme, Checkbox, Container } from "@sanity/ui";
+import { Select, useToast, Flex, Spinner, Stack, Label, TextInput, Card, Text, Badge, Switch, Button, Heading, Dialog, Box, Inline, useTheme_v2, useTheme, Checkbox, Container } from "@sanity/ui";
 import { uuid } from "@sanity/uuid";
 import { TEMPLATE_PREFIX, STANDARD_WORKFLOW_OPTIONS, isWorkflowValid } from "./_chunks-es/workflow.js";
-import { ITEM_ID, ITEM_ID_FROM_SUBQUERY, itemDocDeref, summarizeCompletion, buildLanguageMappings, findDuplicateSmartcatLanguages, targetPercent } from "./_chunks-es/index.js";
-import { getTranslatableFields, deserializeFromLocjson, serializeToLocjson, buildLocjsonFilename, localizationMode, getAtPath, enumerateLeaves, setAtPath, isInternationalizedArrayType, innerValueType } from "./_chunks-es/index2.js";
+import { ITEM_ID, ITEM_ID_FROM_SUBQUERY, itemDocDeref, summarizeCompletion, buildLanguageMappings, findDuplicateSmartcatLanguages, itemDocDerefRespectingDraft, targetPercent } from "./_chunks-es/index.js";
+import { getTranslatableFields, deserializeFromLocjson, serializeToLocjson, getAtPath, buildLocjsonFilename, localizationMode, enumerateLeaves, setAtPath, isInternationalizedArrayType, innerValueType } from "./_chunks-es/index2.js";
 import { useIntentLink, useRouter, useRouterState, route } from "sanity/router";
 import styled, { keyframes, css } from "styled-components";
 const STATUS_OPTIONS = [
@@ -89,7 +89,11 @@ function createTranslationProjectType() {
             title: "Project item",
             fields: [
               defineField({ name: "docId", title: "Document ID", type: "string" }),
-              defineField({ name: "docType", title: "Document type", type: "string" })
+              defineField({ name: "docType", title: "Document type", type: "string" }),
+              // Set when the item was added from the published perspective, so the
+              // export translates the published document. Absent/false (incl. all
+              // legacy items) prefers the draft — see itemDocDerefRespectingDraft.
+              defineField({ name: "sourceIsPublished", title: "Source is published", type: "boolean" })
             ],
             preview: { select: { title: "docId", subtitle: "docType" } }
           })
@@ -435,7 +439,7 @@ const PROJECTS_QUERY$1 = `*[_type == $type] | order(name asc){
 function createAddToProjectAction(config) {
   const sourceLanguage = config.sourceLanguage;
   return (props) => {
-    const { id, draft, published, onComplete } = props, client = useClient({ apiVersion: API_VERSION }), schema = useSchema(), toast = useToast(), [open, setOpen] = useState(!1), [projects, setProjects] = useState(null), [selection, setSelection] = useState(CREATE_NEW), [newName, setNewName] = useState(""), [busy, setBusy] = useState(!1), [includeLinked, setIncludeLinked] = useState(!0), { templates, loaded, requestRefresh } = useTemplates(), [workflow, setWorkflow] = useWorkflowSelection(open, templates, loaded), publishedId2 = id.replace(/^drafts\./, ""), doc = draft ?? published, docTitle = doc && resolveDocumentTitle(schema, doc) || UNTITLED;
+    const { id, draft, published, onComplete } = props, client = useClient({ apiVersion: API_VERSION }), schema = useSchema(), toast = useToast(), { selectedPerspectiveName } = usePerspective(), sourceIsPublished = selectedPerspectiveName === "published" || !draft, [open, setOpen] = useState(!1), [projects, setProjects] = useState(null), [selection, setSelection] = useState(CREATE_NEW), [newName, setNewName] = useState(""), [busy, setBusy] = useState(!1), [includeLinked, setIncludeLinked] = useState(!0), { templates, loaded, requestRefresh } = useTemplates(), [workflow, setWorkflow] = useWorkflowSelection(open, templates, loaded), publishedId2 = id.replace(/^drafts\./, ""), doc = draft ?? published, docTitle = doc && resolveDocumentTitle(schema, doc) || UNTITLED;
     useEffect(() => {
       if (!open) return;
       requestRefresh();
@@ -457,7 +461,8 @@ function createAddToProjectAction(config) {
           _type: "smartcat.projectItem",
           _key: uuid(),
           docId,
-          docType
+          docType,
+          sourceIsPublished
         }), collected = /* @__PURE__ */ new Map([[publishedId2, doc?._type]]);
         if (includeLinked) {
           const linked = await gatherLinkedDocuments({ client, rootId: publishedId2, isRoot: (type) => config.rootTypes.includes(type), isTranslatable: (type) => getTranslatableFields(schema.get(type), { exclude: [config.documentI18nLanguageField] }).length > 0 });
@@ -499,7 +504,7 @@ function createAddToProjectAction(config) {
       } finally {
         setBusy(!1);
       }
-    }, [selection, newName, workflow, publishedId2, doc, includeLinked, schema, client, projects, close]), content = useMemo(() => projects === null ? /* @__PURE__ */ jsx(Flex, { align: "center", justify: "center", padding: 4, children: /* @__PURE__ */ jsx(Spinner, { muted: !0 }) }) : /* @__PURE__ */ jsxs(Stack, { space: 4, children: [
+    }, [selection, newName, workflow, publishedId2, doc, includeLinked, sourceIsPublished, schema, client, projects, close]), content = useMemo(() => projects === null ? /* @__PURE__ */ jsx(Flex, { align: "center", justify: "center", padding: 4, children: /* @__PURE__ */ jsx(Spinner, { muted: !0 }) }) : /* @__PURE__ */ jsxs(Stack, { space: 4, children: [
       /* @__PURE__ */ jsxs(Stack, { space: 3, children: [
         /* @__PURE__ */ jsx(Label, { size: 1, children: "Project" }),
         /* @__PURE__ */ jsxs(
@@ -550,7 +555,20 @@ function createAddToProjectAction(config) {
       ] }),
       /* @__PURE__ */ jsx(Card, { padding: 3, radius: 2, tone: "transparent", border: !0, children: /* @__PURE__ */ jsxs(Stack, { space: 4, children: [
         /* @__PURE__ */ jsxs(Text, { size: 1, muted: !0, children: [
-          "Adding ",
+          "Adding",
+          " ",
+          /* @__PURE__ */ jsx(
+            Badge,
+            {
+              tone: sourceIsPublished ? "positive" : "caution",
+              fontSize: 1,
+              paddingX: 2,
+              style: { verticalAlign: "middle" },
+              children: sourceIsPublished ? "Published" : "Draft"
+            }
+          ),
+          " ",
+          "version of ",
           /* @__PURE__ */ jsx("strong", { children: docTitle }),
           " to the selected project."
         ] }),
@@ -583,7 +601,7 @@ function createAddToProjectAction(config) {
           }
         )
       ] })
-    ] }), [projects, selection, newName, workflow, templates, busy, includeLinked, docTitle, close, handleConfirm]);
+    ] }), [projects, selection, newName, workflow, templates, busy, includeLinked, docTitle, sourceIsPublished, close, handleConfirm]);
     return {
       label: "Add to translation project",
       icon: TranslateIcon,
@@ -619,6 +637,7 @@ const PROJECTS_QUERY = `*[_type == "${TRANSLATION_PROJECT_TYPE}"] | order(_creat
   items[]{
     _key,
     "docId": ${ITEM_ID},
+    sourceIsPublished,
     "doc": ${itemDocDeref("{_id, _type}")},
     "translations": *[_type == "translation.metadata" && references(${ITEM_ID_FROM_SUBQUERY})][0]
       .translations[]{language, "id": value._ref}
@@ -794,6 +813,16 @@ function valuePreview(value) {
 function errorMessage(err) {
   return err instanceof Error ? err.message : String(err);
 }
+function memberLocalesWithContent(members, languageKey) {
+  if (!Array.isArray(members)) return [];
+  const locales = [];
+  for (const member of members) {
+    if (!member || typeof member != "object") continue;
+    const locale = member[languageKey], value = member.value, hasContent = typeof value == "string" ? value.trim().length > 0 : Array.isArray(value) ? value.length > 0 : value != null;
+    typeof locale == "string" && hasContent && locales.push(locale);
+  }
+  return locales;
+}
 function schemaFieldNames(schema, type) {
   return (schema.get(type)?.fields ?? []).map((f) => f?.name).filter((n) => typeof n == "string" && !n.startsWith("_"));
 }
@@ -801,7 +830,14 @@ function blockContentTypeFor(schema, type, fieldPath) {
   const fieldType = schema.get(type)?.fields?.find((f) => f.name === fieldPath)?.type;
   return isInternationalizedArrayType(fieldType) ? innerValueType(fieldType) : fieldType;
 }
-const ITEMS_QUERY = `*[_id == $id][0]{ sourceLanguage, items[]{ "doc": ${itemDocDeref()} } }`;
+const ITEMS_QUERY = `*[_id == $id][0]{
+  sourceLanguage,
+  items[]{
+    "docId": ${ITEM_ID},
+    "docType": docType,
+    "doc": ${itemDocDerefRespectingDraft()}
+  }
+}`;
 async function prepareExport({
   client,
   schema,
@@ -809,6 +845,7 @@ async function prepareExport({
   targetLanguages,
   sourceLanguage,
   languages,
+  translatableTypes,
   exclude,
   fieldLanguageKey,
   deletions = [],
@@ -822,15 +859,22 @@ async function prepareExport({
     const detail = dups.map((d) => `${d.sanityIds.join(", ")} \u2192 ${d.smartcatLanguage}`).join("; ");
     throw new Error(`Multiple target languages map to the same Smartcat language: ${detail}`);
   }
-  const deletedDocIds = new Set(deletions.map((d) => d.sourceDocId)), docs = (project?.items ?? []).map((i) => i?.doc).filter((d) => !!d).filter((d) => !deletedDocIds.has(d._id)), fieldsByType = /* @__PURE__ */ new Map(), fieldsFor = (type) => {
+  const deletedDocIds = new Set(deletions.map((d) => d.sourceDocId)), items = (project?.items ?? []).filter(
+    (item) => !(item.docId && deletedDocIds.has(item.docId))
+  ), unresolved = items.filter((item) => !item.doc), docs = items.map((item) => item.doc).filter((d) => !!d), fieldsByType = /* @__PURE__ */ new Map(), fieldsFor = (type) => {
     let fields = fieldsByType.get(type);
     return fields || (fields = getTranslatableFields(schema.get(type), { exclude }), fieldsByType.set(type, fields)), fields;
-  };
-  log({ level: "info", message: `Export \u2014 ${docs.length} document(s) \u2192 ${targetLanguages.join(", ") || "(no targets)"}` });
+  }, configuredLanguages = languages.map((l) => l.id).join(", ") || "(none)", configuredTypes = translatableTypes === void 0 ? "all types" : translatableTypes.join(", ") || "(none)";
+  log({ level: "info", message: `Config \u2014 source language: ${sourceLanguage}` }), log({ level: "info", indent: !0, message: `languages: ${configuredLanguages}` }), log({ level: "info", indent: !0, message: `translatable types: ${configuredTypes}` }), log({ level: "info", message: `Project \u2014 source: ${source} \u2192 targets: ${targetLanguages.join(", ") || "(no targets)"}` }), log({ level: "info", message: `Export \u2014 ${docs.length} document(s)` });
+  for (const item of unresolved)
+    log({
+      level: "error",
+      message: `${item.docId ?? "unknown document"} (${item.docType ?? "unknown type"}): no document found \u2014 it may be unpublished or deleted; skipped`
+    });
   const outbox = [];
-  for (const doc of docs) {
-    const name = resolveDocumentTitle(schema, doc);
-    log({ level: "info", message: `${name || doc._id}  \xB7  ${doc._type}` });
+  for (const rawDoc of docs) {
+    const isDraft = rawDoc._id.startsWith("drafts."), doc = isDraft ? { ...rawDoc, _id: publishedId(rawDoc._id) } : rawDoc, name = resolveDocumentTitle(schema, doc);
+    log({ level: "info", message: `${name || doc._id}  \xB7  ${doc._type}${isDraft ? " (draft)" : ""}` });
     try {
       const fields = fieldsFor(doc._type), skippedBlockTypes = /* @__PURE__ */ new Map(), locjson = serializeToLocjson(doc, fields, {
         sourceLanguage: source,
@@ -839,11 +883,18 @@ async function prepareExport({
       }), unitByKey = new Map(locjson.units.map((u) => [u.key, u]));
       for (const field of fields) {
         const unit = unitByKey.get(field.path), skippedTypes = skippedBlockTypes.get(field.path);
-        log(unit ? { level: "success", indent: !0, message: `${field.title || field.path}: serialized (${field.kind})`, value: unit.source.join("") } : skippedTypes ? {
-          level: "error",
-          indent: !0,
-          message: `${field.title || field.path}: not translated \u2014 contains block type(s) that can't be translated: ${skippedTypes.join(", ")}. The whole field was left untranslated to avoid losing this content.`
-        } : { level: "skip", indent: !0, message: `${field.title || field.path}: skipped \u2014 no source content` });
+        if (unit)
+          log({ level: "success", indent: !0, message: `${field.title || field.path}: serialized (${field.kind})`, value: unit.source.join("") });
+        else if (skippedTypes)
+          log({
+            level: "error",
+            indent: !0,
+            message: `${field.title || field.path}: not translated \u2014 contains block type(s) that can't be translated: ${skippedTypes.join(", ")}. The whole field was left untranslated to avoid losing this content.`
+          });
+        else {
+          const otherLocales = field.localization === "field" ? memberLocalesWithContent(getAtPath(doc, field.path), fieldLanguageKey).filter((l) => l !== source) : [], reason = otherLocales.length ? `no '${source}' content (I see only: ${otherLocales.join(", ")})` : "no source content";
+          log({ level: "skip", indent: !0, message: `${field.title || field.path}: skipped \u2014 ${reason}` });
+        }
       }
       const selected = new Set(fields.map((f) => f.path)), excluded = new Set(exclude ?? []);
       for (const fieldName of schemaFieldNames(schema, doc._type))
@@ -860,7 +911,7 @@ async function prepareExport({
         _key: uuid(),
         sourceDocId: doc._id,
         title: name,
-        filename: buildLocjsonFilename(doc._type, doc._id, name),
+        filename: buildLocjsonFilename(doc._type, doc._id, name, { draft: isDraft }),
         locjson: JSON.stringify(locjson)
       });
     } catch (err) {
@@ -1418,20 +1469,23 @@ const CodeArea = styled.textarea`
   tab-size: 2;
 `;
 function ViewLocjsonButton(props) {
-  const { docId, type, client, schema, sourceLanguage, documentI18nLanguageField, fieldI18nLanguageField } = props, [open, setOpen] = useState(!1), [content, setContent] = useState(null), [filename, setFilename] = useState(null), [error, setError] = useState(null), build = useCallback(async () => {
+  const { docId, type, sourceIsPublished, client, schema, sourceLanguage, documentI18nLanguageField, fieldI18nLanguageField } = props, [open, setOpen] = useState(!1), [content, setContent] = useState(null), [filename, setFilename] = useState(null), [error, setError] = useState(null), build = useCallback(async () => {
     setOpen(!0), setContent(null), setFilename(null), setError(null);
     try {
-      const doc = await client.fetch("*[_id == $id][0]", { id: docId });
-      if (!doc) throw new Error(`Document not found: ${docId}`);
-      const fields = getTranslatableFields(schema.get(type), { exclude: [documentI18nLanguageField] }), locjson = serializeToLocjson(doc, fields, {
+      const raw = await client.fetch(
+        sourceIsPublished ? "*[_id == $id][0]" : 'coalesce(*[_id == "drafts." + $id][0], *[_id == $id][0])',
+        { id: docId }
+      );
+      if (!raw) throw new Error(`Document not found: ${docId}`);
+      const isDraft = typeof raw._id == "string" && raw._id.startsWith("drafts."), doc = isDraft ? { ...raw, _id: docId } : raw, fields = getTranslatableFields(schema.get(type), { exclude: [documentI18nLanguageField] }), locjson = serializeToLocjson(doc, fields, {
         sourceLanguage,
         fieldLanguageKey: fieldI18nLanguageField
-      }), smartcatName = buildLocjsonFilename(type, docId, resolveDocumentTitle(schema, doc));
+      }), smartcatName = buildLocjsonFilename(type, docId, resolveDocumentTitle(schema, doc), { draft: isDraft });
       setFilename(smartcatName.split("/").pop() || smartcatName), setContent(JSON.stringify(locjson, null, 2));
     } catch (err) {
       setError(err instanceof Error ? err.message : String(err));
     }
-  }, [client, schema, docId, type, sourceLanguage, documentI18nLanguageField, fieldI18nLanguageField]), download = useCallback(() => {
+  }, [client, schema, docId, type, sourceIsPublished, sourceLanguage, documentI18nLanguageField, fieldI18nLanguageField]), download = useCallback(() => {
     if (content == null || !filename) return;
     const url = URL.createObjectURL(new Blob([content], { type: "application/json" })), anchor = document.createElement("a");
     anchor.href = url, anchor.download = filename, anchor.click(), URL.revokeObjectURL(url);
@@ -1490,6 +1544,7 @@ function ProjectView({
   onBack,
   languages,
   sourceLanguage,
+  translatableTypes,
   documentI18nLanguageField,
   fieldI18nLanguageField
 }) {
@@ -1635,6 +1690,7 @@ function ProjectView({
         targetLanguages: targets,
         sourceLanguage,
         languages,
+        translatableTypes,
         exclude: [documentI18nLanguageField],
         fieldLanguageKey: fieldI18nLanguageField,
         deletions,
@@ -1846,13 +1902,23 @@ Smartcat language code: '${l.smartcatLanguage || l.id}'`,
             children: /* @__PURE__ */ jsxs(Stack, { space: 3, children: [
               /* @__PURE__ */ jsxs(Flex, { align: "center", gap: 3, children: [
                 /* @__PURE__ */ jsxs(Flex, { align: "center", gap: 2, children: [
+                  /* @__PURE__ */ jsx(
+                    Badge,
+                    {
+                      tone: item.sourceIsPublished ? "positive" : "caution",
+                      paddingX: 2,
+                      title: item.sourceIsPublished ? "The published version is the translation source" : "The draft version is the translation source",
+                      children: item.sourceIsPublished ? "Published" : "Draft"
+                    }
+                  ),
                   /* @__PURE__ */ jsx(Text, { weight: "medium", children: /* @__PURE__ */ jsx("span", { style: isMarked ? { textDecoration: "line-through" } : void 0, children: /* @__PURE__ */ jsx(DocTitle, { doc: item.doc }) }) }),
-                  item.doc?._type && /* @__PURE__ */ jsx(Badge, { tone: "primary", children: item.doc._type }),
+                  item.doc?._type && /* @__PURE__ */ jsx(Badge, { tone: "primary", paddingX: 2, children: item.doc._type }),
                   item.doc?._type && modeByType.has(item.doc._type) && /* @__PURE__ */ jsx(
                     Badge,
                     {
                       tone: "default",
                       fontSize: 0,
+                      paddingX: 2,
                       title: modeByType.get(item.doc._type) === "field" ? "This item is translated in field mode; translations will be stored as language variants of each field" : "This item is translated in document mode; translations will be stored as linked documents",
                       children: modeByType.get(item.doc._type) === "field" ? "fields" : "document"
                     }
@@ -1863,6 +1929,7 @@ Smartcat language code: '${l.smartcatLanguage || l.id}'`,
                     {
                       docId: item.doc._id,
                       type: item.doc._type,
+                      sourceIsPublished: item.sourceIsPublished,
                       client,
                       schema,
                       sourceLanguage,
@@ -1938,7 +2005,7 @@ Smartcat language code: '${l.smartcatLanguage || l.id}'`,
   ] });
 }
 function createDashboardComponent(config) {
-  const { sourceLanguage, languages, documentI18nLanguageField, fieldI18nLanguageField } = config;
+  const { sourceLanguage, languages, translatableTypes, documentI18nLanguageField, fieldI18nLanguageField } = config;
   return function() {
     const router = useRouter(), projectId = useRouterState(
       useCallback((state) => state.projectId ?? null, [])
@@ -1950,6 +2017,7 @@ function createDashboardComponent(config) {
         onBack: goBack,
         languages,
         sourceLanguage,
+        translatableTypes,
         documentI18nLanguageField,
         fieldI18nLanguageField
       }
@@ -2069,6 +2137,7 @@ function resolveConfig(config) {
   const translatableTypes = config.translatableTypes;
   return {
     isTranslatableType: translatableTypes ? (type) => translatableTypes.includes(type) : (type) => !PLUGIN_TYPES.has(type),
+    translatableTypes,
     // `rootTypes` inherits the *explicitly-configured* translatableTypes (not the
     // resolved "everything") so an unconfigured Studio gets no crawl boundary
     // rather than every type being a root (which would stop the crawl at once).