@smartcat/sanity-plugin 1.0.0 → 1.1.0

package/dist/templates.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Fetches templates from Smartcat and writes them (sorted by name) to the
+ * settings singleton, stamping `templatesSyncedAt`. Always writes the timestamp —
+ * even for an empty list — so the cache reads as initialized.
+ */
+export declare function runTemplatesSync(
+  options: RunTemplatesSyncOptions,
+): Promise<{
+  count: number;
+}>;
+
+export declare interface RunTemplatesSyncOptions {
+  sanity: SanityLikeClient;
+  smartcat: SmartcatTemplatesClient;
+  /** `_id` of the settings singleton (defaults to the fixed id). */
+  settingsId?: string;
+  now?: () => string;
+}
+
+/**
+ * Refreshes the cached Smartcat project-template list onto the `smartcat.settings`
+ * singleton. Run by the thin `smartcat-templates` Function when the browser bumps
+ * `templatesRequestedAt` (on Studio init or when a create dialog opens).
+ *
+ * Dependency-free (no DOM, no @sanity/* runtime) so it bundles into the Function.
+ */
+/** Minimal structural subset of @sanity/client used by the templates refresh. */
+export declare interface SanityLikeClient {
+  patch(id: string): {
+    set(attrs: Record<string, unknown>): {
+      commit(): Promise<unknown>;
+    };
+  };
+}
+
+/** A Smartcat project template (from `GET /template`). */
+declare interface SmartcatTemplate {
+  id: string;
+  name: string;
+}
+
+/** Structural subset of SmartcatClient the templates refresh needs. */
+export declare interface SmartcatTemplatesClient {
+  getTemplates(): Promise<SmartcatTemplatesResponse>;
+}
+
+/** Response shape of `GET /template`. */
+declare interface SmartcatTemplatesResponse {
+  templates: SmartcatTemplate[];
+}
+
+export {};

package/dist/templates.js

@@ -0,0 +1,12 @@
+import { SETTINGS_DOC_ID } from "./_chunks-es/constants.js";
+function keyify(value) {
+  return value.replace(/[^a-zA-Z0-9_-]/g, "-") || "x";
+}
+async function runTemplatesSync(options) {
+  const { sanity, smartcat, settingsId = SETTINGS_DOC_ID, now = () => (/* @__PURE__ */ new Date()).toISOString() } = options, { templates } = await smartcat.getTemplates(), value = [...templates ?? []].sort((a, b) => a.name.localeCompare(b.name)).map((t) => ({ _key: keyify(t.id), id: t.id, name: t.name }));
+  return await sanity.patch(settingsId).set({ templates: value, templatesSyncedAt: now() }).commit(), { count: value.length };
+}
+export {
+  runTemplatesSync
+};
+//# sourceMappingURL=templates.js.map

package/dist/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sources":["../src/templates/core.ts"],"sourcesContent":["import type {SmartcatTemplatesResponse} from '../smartcat/types'\nimport {SETTINGS_DOC_ID} from '../lib/constants'\n\n/**\n * Refreshes the cached Smartcat project-template list onto the `smartcat.settings`\n * singleton. Run by the thin `smartcat-templates` Function when the browser bumps\n * `templatesRequestedAt` (on Studio init or when a create dialog opens).\n *\n * Dependency-free (no DOM, no @sanity/* runtime) so it bundles into the Function.\n */\n\n/** Minimal structural subset of @sanity/client used by the templates refresh. */\nexport interface SanityLikeClient {\n  patch(id: string): {\n    set(attrs: Record<string, unknown>): {commit(): Promise<unknown>}\n  }\n}\n\n/** Structural subset of SmartcatClient the templates refresh needs. */\nexport interface SmartcatTemplatesClient {\n  getTemplates(): Promise<SmartcatTemplatesResponse>\n}\n\nexport interface RunTemplatesSyncOptions {\n  sanity: SanityLikeClient\n  smartcat: SmartcatTemplatesClient\n  /** `_id` of the settings singleton (defaults to the fixed id). */\n  settingsId?: string\n  now?: () => string\n}\n\n/** Sanitizes a template id into a stable, Sanity-safe array `_key`. */\nfunction keyify(value: string): string {\n  return value.replace(/[^a-zA-Z0-9_-]/g, '-') || 'x'\n}\n\n/**\n * Fetches templates from Smartcat and writes them (sorted by name) to the\n * settings singleton, stamping `templatesSyncedAt`. Always writes the timestamp —\n * even for an empty list — so the cache reads as initialized.\n */\nexport async function runTemplatesSync(\n  options: RunTemplatesSyncOptions,\n): Promise<{count: number}> {\n  const {sanity, smartcat, settingsId = SETTINGS_DOC_ID, now = () => new Date().toISOString()} = options\n\n  const {templates} = await smartcat.getTemplates()\n  const value = [...(templates ?? [])]\n    .sort((a, b) => a.name.localeCompare(b.name))\n    .map((t) => ({_key: keyify(t.id), id: t.id, name: t.name}))\n\n  await sanity.patch(settingsId).set({templates: value, templatesSyncedAt: now()}).commit()\n\n  return {count: value.length}\n}\n"],"names":[],"mappings":";AAgCA,SAAS,OAAO,OAAuB;AACrC,SAAO,MAAM,QAAQ,mBAAmB,GAAG,KAAK;AAClD;AAOA,eAAsB,iBACpB,SAC0B;AAC1B,QAAM,EAAC,QAAQ,UAAU,aAAa,iBAAiB,MAAM,OAAM,oBAAI,KAAA,GAAO,YAAA,EAAY,IAAK,SAEzF,EAAC,UAAA,IAAa,MAAM,SAAS,aAAA,GAC7B,QAAQ,CAAC,GAAI,aAAa,CAAA,CAAG,EAChC,KAAK,CAAC,GAAG,MAAM,EAAE,KAAK,cAAc,EAAE,IAAI,CAAC,EAC3C,IAAI,CAAC,OAAO,EAAC,MAAM,OAAO,EAAE,EAAE,GAAG,IAAI,EAAE,IAAI,MAAM,EAAE,KAAA,EAAM;AAE5D,SAAA,MAAM,OAAO,MAAM,UAAU,EAAE,IAAI,EAAC,WAAW,OAAO,mBAAmB,IAAA,EAAI,CAAE,EAAE,OAAA,GAE1E,EAAC,OAAO,MAAM,OAAA;AACvB;"}

package/package.json

@@ -1,23 +1,109 @@
 {
   "name": "@smartcat/sanity-plugin",
-  "version": "1.0.0",
-  "description": "",
-  "homepage": "https://github.com/smartcatai/sanity-plugin#readme",
-  "bugs": {
-    "url": "https://github.com/smartcatai/sanity-plugin/issues"
-  },
+  "version": "1.1.0",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/smartcatai/sanity-plugin.git"
+  "description": "Group Sanity content into translation projects, send them to Smartcat, and import localized variants.",
+  "keywords": [
+    "sanity",
+    "sanity-plugin",
+    "smartcat",
+    "translation",
+    "localization",
+    "i18n"
+  ],
+  "license": "MIT",
+  "author": "Smartcat",
+  "type": "module",
+  "browserslist": "extends @sanity/browserslist-config",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "default": "./dist/index.js"
+    },
+    "./locjson": {
+      "source": "./src/lib/locjson/index.ts",
+      "import": "./dist/locjson.js",
+      "require": "./dist/locjson.cjs",
+      "default": "./dist/locjson.js"
+    },
+    "./smartcat": {
+      "source": "./src/smartcat/index.ts",
+      "import": "./dist/smartcat.js",
+      "require": "./dist/smartcat.cjs",
+      "default": "./dist/smartcat.js"
+    },
+    "./export": {
+      "source": "./src/export/index.ts",
+      "import": "./dist/export.js",
+      "require": "./dist/export.cjs",
+      "default": "./dist/export.js"
+    },
+    "./import": {
+      "source": "./src/import/index.ts",
+      "import": "./dist/import.js",
+      "require": "./dist/import.cjs",
+      "default": "./dist/import.js"
+    },
+    "./progress": {
+      "source": "./src/progress/index.ts",
+      "import": "./dist/progress.js",
+      "require": "./dist/progress.cjs",
+      "default": "./dist/progress.js"
+    },
+    "./templates": {
+      "source": "./src/templates/index.ts",
+      "import": "./dist/templates.js",
+      "require": "./dist/templates.cjs",
+      "default": "./dist/templates.js"
+    },
+    "./package.json": "./package.json"
   },
-  "license": "ISC",
-  "author": "",
-  "type": "commonjs",
-  "main": "index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "README.md"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "pkg-utils build --check --clean",
+    "watch": "pkg-utils watch",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@portabletext/to-html": "^5.0.2",
+    "@sanity/block-tools": "^3.70.0",
+    "@sanity/icons": "^3.7.0",
+    "@sanity/uuid": "^3.0.2"
+  },
+  "peerDependencies": {
+    "@sanity/ui": "^2 || ^3",
+    "react": "^18 || ^19",
+    "sanity": "^3 || ^4 || ^5 || ^6",
+    "styled-components": "^6"
+  },
+  "devDependencies": {
+    "@sanity/pkg-utils": "^7.2.2",
+    "@sanity/schema": "^6.2.0",
+    "@sanity/ui": "^3.0.0",
+    "@types/jsdom": "^28.0.3",
+    "@types/node": "^25.9.3",
+    "jsdom": "^29.1.1",
+    "react": "^19.2.4",
+    "sanity": "^6.2.0",
+    "styled-components": "^6.1.18",
+    "typescript": "^5.8.0",
+    "vitest": "^4.1.8"
+  },
+  "engines": {
+    "node": ">=18"
   }
 }

package/src/actions/AddToProjectAction.tsx

@@ -0,0 +1,274 @@
+import {useCallback, useEffect, useMemo, useState} from 'react'
+import {useClient, usePerspective, useSchema, type DocumentActionComponent, type DocumentActionProps} from 'sanity'
+import {Badge, Box, Button, Card, Flex, Inline, Label, Select, Spinner, Stack, Switch, Text, TextInput, useToast} from '@sanity/ui'
+import {AddIcon, TranslateIcon} from '@sanity/icons'
+import {uuid} from '@sanity/uuid'
+import {API_VERSION, TRANSLATION_PROJECT_TYPE} from '../lib/constants'
+import {WorkflowSelect} from '../tool/WorkflowSelect'
+import {useTemplates} from '../tool/useTemplates'
+import {useWorkflowSelection} from '../tool/useWorkflowSelection'
+import {resolveDocumentTitle, UNTITLED} from '../lib/documentTitle'
+import {gatherLinkedDocuments} from '../lib/linkedDocuments'
+import {ITEM_ID} from '../lib/projectItems'
+import {getTranslatableFields} from '../lib/locjson/fields'
+import type {ResolvedSmartcatConfig} from '../lib/resolveConfig'
+
+interface ProjectOption {
+  _id: string
+  name: string
+  count: number
+  status: string
+}
+
+const PROJECTS_QUERY = `*[_type == $type] | order(name asc){
+  _id,
+  name,
+  status,
+  "count": count(items)
+}`
+
+const CREATE_NEW = '__create_new__'
+
+/**
+ * Builds the "Add to translation project" document action, shown on the
+ * configured translatable types. Lets the editor add the current document to an
+ * existing project or create a new one — appending a weak reference to the
+ * project's `items`.
+ */
+export function createAddToProjectAction(config: ResolvedSmartcatConfig): DocumentActionComponent {
+  const sourceLanguage = config.sourceLanguage
+
+  const AddToProjectAction: DocumentActionComponent = (props: DocumentActionProps) => {
+    const {id, draft, published, onComplete} = props
+    const client = useClient({apiVersion: API_VERSION})
+    const schema = useSchema()
+    const toast = useToast()
+    // Which version is the translation source, decided here and stored on the
+    // item (the pill and the export both read it — no re-resolving later): the
+    // published document when the published perspective is selected or there is
+    // no draft; otherwise the draft, which is what the editor sees and edits.
+    const {selectedPerspectiveName} = usePerspective()
+    const sourceIsPublished = selectedPerspectiveName === 'published' || !draft
+
+    const [open, setOpen] = useState(false)
+    const [projects, setProjects] = useState<ProjectOption[] | null>(null)
+    const [selection, setSelection] = useState<string>(CREATE_NEW)
+    const [newName, setNewName] = useState('')
+    const [busy, setBusy] = useState(false)
+    const [includeLinked, setIncludeLinked] = useState(true)
+    const {templates, loaded, requestRefresh} = useTemplates()
+    const [workflow, setWorkflow] = useWorkflowSelection(open, templates, loaded)
+
+    const publishedId = id.replace(/^drafts\./, '')
+    const doc = draft ?? published
+    // Resolve the title natively (preview.prepare) so field-level i18n types yield
+    // a string, never the raw internationalized-array object (renders as React #31).
+    const docTitle = (doc && resolveDocumentTitle(schema, doc)) || UNTITLED
+
+    // Load existing projects when the dialog opens.
+    useEffect(() => {
+      if (!open) return
+      // Refresh the template list each time the dialog opens.
+      requestRefresh()
+      let cancelled = false
+      setProjects(null)
+      client
+        .fetch<ProjectOption[]>(PROJECTS_QUERY, {type: TRANSLATION_PROJECT_TYPE})
+        .then((res) => {
+          if (cancelled) return
+          setProjects(res)
+          // Default to the first existing project if there is one.
+          setSelection(res.length > 0 ? res[0]._id : CREATE_NEW)
+        })
+        .catch((err) => {
+          if (!cancelled) toast.push({status: 'error', title: 'Failed to load projects', description: String(err)})
+        })
+      return () => {
+        cancelled = true
+      }
+    }, [open, client, toast, requestRefresh])
+
+    const close = useCallback(() => {
+      setOpen(false)
+      setNewName('')
+      onComplete()
+    }, [onComplete])
+
+    const handleConfirm = useCallback(async () => {
+      setBusy(true)
+      try {
+        const makeItem = (docId: string, docType?: string) => ({
+          _type: 'smartcat.projectItem',
+          _key: uuid(),
+          docId,
+          docType,
+          sourceIsPublished,
+        })
+
+        // The root document plus, optionally, everything it links to — de-duped by id.
+        const collected = new Map<string, string | undefined>([[publishedId, doc?._type]])
+        if (includeLinked) {
+          const isRoot = (type: string) => config.rootTypes.includes(type)
+          const isTranslatable = (type: string) =>
+            getTranslatableFields(schema.get(type), {exclude: [config.documentI18nLanguageField]}).length > 0
+          const linked = await gatherLinkedDocuments({client, rootId: publishedId, isRoot, isTranslatable})
+          for (const {docId, docType} of linked) if (!collected.has(docId)) collected.set(docId, docType)
+        }
+
+        if (selection === CREATE_NEW) {
+          const name = newName.trim() || `Translation project ${new Date().toISOString().slice(0, 10)}`
+          const items = [...collected].map(([docId, docType]) => makeItem(docId, docType))
+          await client.create({
+            _type: TRANSLATION_PROJECT_TYPE,
+            name,
+            status: 'draft',
+            sourceLanguage,
+            workflow,
+            items,
+          })
+          toast.push({
+            status: 'success',
+            title: `Created “${name}” with ${items.length} document${items.length === 1 ? '' : 's'}`,
+          })
+        } else {
+          // Skip ids already in the project (normalized across old/new item shapes).
+          const existing = await client.fetch<{id: string}[]>(
+            `*[_id == $pid][0].items[]{"id": ${ITEM_ID}}`,
+            {pid: selection},
+          )
+          const existingIds = new Set((existing ?? []).map((e) => e.id))
+          const newItems = [...collected]
+            .filter(([docId]) => !existingIds.has(docId))
+            .map(([docId, docType]) => makeItem(docId, docType))
+          const projName = projects?.find((p) => p._id === selection)?.name ?? 'project'
+          if (newItems.length === 0) {
+            toast.push({status: 'info', title: `Already in “${projName}”`})
+          } else {
+            await client.patch(selection).setIfMissing({items: []}).insert('after', 'items[-1]', newItems).commit()
+            const skipped = collected.size - newItems.length
+            toast.push({
+              status: 'success',
+              title: `Added ${newItems.length} document${newItems.length === 1 ? '' : 's'} to “${projName}”`,
+              description: skipped > 0 ? `${skipped} already in the project` : undefined,
+            })
+          }
+        }
+        close()
+      } catch (err) {
+        toast.push({status: 'error', title: 'Failed to add to project', description: String(err)})
+      } finally {
+        setBusy(false)
+      }
+    }, [selection, newName, workflow, publishedId, doc, includeLinked, sourceIsPublished, schema, client, projects, close])
+
+    const content = useMemo(() => {
+      if (projects === null) {
+        return (
+          <Flex align="center" justify="center" padding={4}>
+            <Spinner muted />
+          </Flex>
+        )
+      }
+      return (
+        <Stack space={4}>
+          <Stack space={3}>
+            <Label size={1}>Project</Label>
+            <Select
+              value={selection}
+              onChange={(e) => setSelection(e.currentTarget.value)}
+              disabled={busy}
+            >
+              {projects.map((p) => (
+                <option key={p._id} value={p._id}>
+                  {p.name} ({p.count} item{p.count === 1 ? '' : 's'})
+                </option>
+              ))}
+              <option value={CREATE_NEW}>➕ Create new project…</option>
+            </Select>
+          </Stack>
+
+          {selection === CREATE_NEW && (
+            <>
+              <Stack space={3}>
+                <Label size={1}>New project name</Label>
+                <TextInput
+                  value={newName}
+                  placeholder="e.g. Spring campaign"
+                  onChange={(e) => setNewName(e.currentTarget.value)}
+                  disabled={busy}
+                />
+              </Stack>
+              <Stack space={3}>
+                <Label size={1}>Workflow</Label>
+                <WorkflowSelect
+                  value={workflow}
+                  onChange={setWorkflow}
+                  templates={templates}
+                  disabled={busy}
+                />
+              </Stack>
+            </>
+          )}
+
+          <Card padding={3} radius={2} tone="transparent" border>
+            <Stack space={4}>
+              <Text size={1} muted>
+                Adding{' '}
+                <Badge
+                  tone={sourceIsPublished ? 'positive' : 'caution'}
+                  fontSize={1}
+                  paddingX={2}
+                  style={{verticalAlign: 'middle'}}
+                >
+                  {sourceIsPublished ? 'Published' : 'Draft'}
+                </Badge>{' '}
+                version of <strong>{docTitle}</strong> to the selected project.
+              </Text>
+              <Flex align="flex-start" gap={3}>
+                <Switch
+                  checked={includeLinked}
+                  onChange={(e) => setIncludeLinked(e.currentTarget.checked)}
+                  disabled={busy}
+                />
+                <Stack space={2}>
+                  <Text size={1} weight="medium">
+                    Include linked content
+                  </Text>
+                  <Text size={1} muted>
+                    Also add documents this one references, recursively — skipping any already in the project.
+                  </Text>
+                </Stack>
+              </Flex>
+            </Stack>
+          </Card>
+
+          <Flex justify="flex-end" gap={2}>
+            <Button mode="bleed" text="Cancel" onClick={close} disabled={busy} />
+            <Button
+              tone="primary"
+              text="Add to project"
+              icon={AddIcon}
+              onClick={handleConfirm}
+              loading={busy}
+              disabled={selection === CREATE_NEW && !workflow}
+            />
+          </Flex>
+        </Stack>
+      )
+    }, [projects, selection, newName, workflow, templates, busy, includeLinked, docTitle, sourceIsPublished, close, handleConfirm])
+
+    return {
+      label: 'Add to translation project',
+      icon: TranslateIcon,
+      onHandle: () => setOpen(true),
+      dialog: open && {
+        type: 'dialog',
+        header: 'Add to translation project',
+        onClose: close,
+        content,
+      },
+    }
+  }
+
+  return AddToProjectAction
+}