sanity-plugin-studio-smartling 2.0.6 → 3.0.0-beta

package/package.json

@@ -1,59 +1,88 @@
 {
-  "version": "2.0.6",
+  "name": "sanity-plugin-studio-smartling",
+  "version": "3.0.0-beta",
+  "description": "!smartling gif",
+  "keywords": [
+    "sanity",
+    "sanity-plugin"
+  ],
+  "homepage": "https://github.com/sanity-io/sanity-plugin-studio-smartling#readme",
+  "bugs": {
+    "url": "https://github.com/sanity-io/sanity-plugin-studio-smartling/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:sanity-io/sanity-plugin-studio-smartling.git"
+  },
   "license": "MIT",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "author": "Sanity.io",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "source": "./src/index.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.esm.js",
+      "default": "./dist/index.esm.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.esm.js",
+  "source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist",
-    "src"
+    "sanity.json",
+    "src",
+    "v2-incompatible.js"
   ],
-  "engines": {
-    "node": ">=10"
-  },
   "scripts": {
-    "start": "tsdx watch",
-    "build": "tsdx build",
-    "test": "tsdx test",
-    "lint": "tsdx lint src",
-    "prepare": "tsdx build",
-    "size": "size-limit",
-    "analyze": "size-limit --why"
+    "build": "run-s clean && plugin-kit verify-package --silent && pkg-utils build --strict && pkg-utils --strict",
+    "lint": "eslint . --fix",
+    "clean": "rimraf dist",
+    "format": "prettier --write --cache --ignore-unknown .",
+    "link-watch": "plugin-kit link-watch",
+    "prepublishOnly": "run-s build",
+    "watch": "pkg-utils watch --strict",
+    "prepare": "husky install"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "tsdx lint src"
-    }
-  },
-  "prettier": {
-    "printWidth": 80,
-    "semi": false,
-    "singleQuote": true,
-    "trailingComma": "es5"
+  "dependencies": {
+    "@sanity/incompatible-plugin": "^1.0.4",
+    "sanity-translations-tab": "^3.0.1"
   },
-  "name": "sanity-plugin-studio-smartling",
-  "author": "Sanity.io",
-  "module": "dist/sanity-plugin-studio-smartling.esm.js",
-  "homepage": "https://github.com/sanity-io/sanity-plugin-studio-smartling#readme",
-  "size-limit": [
-    {
-      "path": "dist/sanity-plugin-studio-smartling.cjs.production.min.js",
-      "limit": "10 KB"
-    },
-    {
-      "path": "dist/sanity-plugin-studio-smartling.esm.js",
-      "limit": "10 KB"
-    }
-  ],
   "devDependencies": {
-    "@sanity/types": "^2.22.3",
-    "@size-limit/preset-small-lib": "^4.7.0",
-    "husky": "^4.3.0",
-    "size-limit": "^4.7.0",
-    "tsdx": "^0.14.1",
-    "tslib": "^2.0.3",
-    "typescript": "^4.0.5"
+    "@commitlint/cli": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@sanity/pkg-utils": "^2.2.5",
+    "@sanity/plugin-kit": "^3.1.7",
+    "@sanity/semantic-release-preset": "^4.0.0",
+    "@types/react": "^18.0.28",
+    "@typescript-eslint/eslint-plugin": "^5.53.0",
+    "@typescript-eslint/parser": "^5.53.0",
+    "eslint": "^8.34.0",
+    "eslint-config-prettier": "^8.6.0",
+    "eslint-config-sanity": "^6.0.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.32.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.1.2",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.8.4",
+    "prettier-plugin-packagejson": "^2.4.3",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-is": "^18.2.0",
+    "rimraf": "^4.1.2",
+    "sanity": "^3.0.0",
+    "styled-components": "^5.3.6",
+    "typescript": "^4.9.5"
   },
-  "dependencies": {
-    "sanity-translations-tab": "^2.0.8"
+  "peerDependencies": {
+    "react": "^18",
+    "sanity": "^3"
+  },
+  "engines": {
+    "node": ">=14"
   }
 }

package/sanity.json

@@ -0,0 +1,8 @@
+{
+  "parts": [
+    {
+      "implements": "part:@sanity/base/sanity-root",
+      "path": "./v2-incompatible.js"
+    }
+  ]
+}

package/src/adapter/createTask.ts

@@ -1,20 +1,18 @@
-import {
-  smartlingProxy,
-  authenticate,
-  getHeaders,
-  findExistingJob,
-} from './helpers'
-import { Secrets } from 'sanity-translations-tab'
-import { getTranslationTask } from './getTranslationTask'
+import {authenticate, getHeaders, findExistingJob} from './helpers'
+import {Adapter, Secrets} from 'sanity-translations-tab'
+import {getTranslationTask} from './getTranslationTask'
+import {Buffer} from 'buffer'
 
-const createJob = async (
-  jobName: string,
-  projectId: string,
-  localeIds: string[],
-  accessToken: string
-) => {
-  const url = `https://api.smartling.com/jobs-api/v3/projects/${projectId}/jobs`
-  return fetch(smartlingProxy, {
+const createJob = (jobName: string, secrets: Secrets, localeIds: string[], accessToken: string) => {
+  const {project, proxy} = secrets
+  if (!project || !proxy) {
+    throw new Error(
+      'The Smartling adapter requires a Smartling project identifier and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
+
+  const url = `https://api.smartling.com/jobs-api/v3/projects/${project}/jobs`
+  return fetch(proxy, {
     method: 'POST',
     headers: {
       ...getHeaders(url, accessToken),
@@ -25,8 +23,8 @@ const createJob = async (
       targetLocaleIds: localeIds,
     }),
   })
-    .then(res => res.json())
-    .then(res => res.response.data.translationJobUid)
+    .then((res) => res.json())
+    .then((res) => res.response.data.translationJobUid)
 }
 
 /* we're using batches here because it eliminates some
@@ -34,20 +32,28 @@ const createJob = async (
  * and is able to be used for new bulk
  * job functionality.
  */
-const createJobBatch = async (
+
+const createJobBatch = (
   jobId: string,
-  projectId: string,
+  secrets: Secrets,
   documentName: string,
   accessToken: string,
   localeIds: string[],
   workflowUid?: string
+  //eslint-disable-next-line max-params
 ) => {
-  const url = `https://api.smartling.com/job-batches-api/v2/projects/${projectId}/batches`
+  const {project, proxy} = secrets
+  if (!project || !proxy) {
+    throw new Error(
+      'The Smartling adapter requires a Smartling project identifier and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
+  const url = `https://api.smartling.com/job-batches-api/v2/projects/${project}/batches`
   const reqBody: {
     authorize: boolean
     translationJobUid: string
     fileUris: string[]
-    localeWorkflows?: { targetLocaleId: string; workflowUid: string }[]
+    localeWorkflows?: {targetLocaleId: string; workflowUid: string}[]
   } = {
     authorize: true,
     translationJobUid: jobId,
@@ -55,13 +61,13 @@ const createJobBatch = async (
   }
 
   if (workflowUid) {
-    reqBody.localeWorkflows = localeIds.map(l => ({
+    reqBody.localeWorkflows = localeIds.map((l) => ({
       targetLocaleId: l,
       workflowUid,
     }))
   }
 
-  return fetch(smartlingProxy, {
+  return fetch(proxy, {
     method: 'POST',
     headers: {
       ...getHeaders(url, accessToken),
@@ -69,75 +75,70 @@ const createJobBatch = async (
     },
     body: JSON.stringify(reqBody),
   })
-    .then(res => res.json())
-    .then(res => res.response.data.batchUid)
+    .then((res) => res.json())
+    .then((res) => res.response.data.batchUid)
 }
 
-const uploadFileToBatch = async (
+const uploadFileToBatch = (
   batchUid: string,
   document: Record<string, any>,
-  projectId: string,
+  secrets: Secrets,
   localeIds: string[],
   accessToken: string
 ) => {
-  const url = `https://api.smartling.com/job-batches-api/v2/projects/${projectId}/batches/${batchUid}/file`
+  const {project, proxy} = secrets
+  if (!project || !proxy) {
+    throw new Error(
+      'The Smartling adapter requires a Smartling project identifier and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
+  const url = `https://api.smartling.com/job-batches-api/v2/projects/${project}/batches/${batchUid}/file`
   const formData = new FormData()
   formData.append('fileUri', document.name)
   formData.append('fileType', 'html')
   const htmlBuffer = Buffer.from(document.content, 'utf-8')
   formData.append('file', new Blob([htmlBuffer]), `${document.name}.html`)
-  localeIds.forEach(localeId =>
-    formData.append('localeIdsToAuthorize[]', localeId)
-  )
+  localeIds.forEach((localeId) => formData.append('localeIdsToAuthorize[]', localeId))
 
-  return fetch(smartlingProxy, {
+  return fetch(proxy, {
     method: 'POST',
     headers: getHeaders(url, accessToken),
     body: formData,
-  }).then(res => res.json())
+  }).then((res) => res.json())
 }
 
-export const createTask = async (
+//@ts-ignore until return TranslationTask type is added to sanity-translations-tab
+export const createTask: Adapter['createTask'] = async (
   documentId: string,
   document: Record<string, any>,
   localeIds: string[],
-  secrets: Secrets,
+  secrets: Secrets | null,
   workflowUid?: string
 ) => {
-  const accessToken = await authenticate(secrets.secret)
+  if (!secrets?.project || !secrets?.secret || !secrets?.proxy) {
+    throw new Error(
+      'The Smartling adapter requires a project ID, a secret key, and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
 
-  //TODO: announce errors here
-  let taskId = await findExistingJob(
-    document.name,
-    secrets.project,
-    accessToken
-  )
+  const accessToken = await authenticate(secrets)
+
+  let taskId = await findExistingJob(document.name, secrets, accessToken)
   if (!taskId) {
-    taskId = await createJob(
-      document.name,
-      secrets.project,
-      localeIds,
-      accessToken
-    )
+    taskId = await createJob(document.name, secrets, localeIds, accessToken)
   }
 
-  //TODO: log errors here if needed
   const batchUid = await createJobBatch(
     taskId,
-    secrets.project,
+    secrets,
     document.name,
     accessToken,
     localeIds,
     workflowUid
   )
-  const uploadFileRes = await uploadFileToBatch(
-    batchUid,
-    document,
-    secrets.project,
-    localeIds,
-    accessToken
-  )
-  console.log('upload status', uploadFileRes)
+  const uploadFileRes = await uploadFileToBatch(batchUid, document, secrets, localeIds, accessToken)
+  //eslint-disable-next-line no-console -- for developer debugging
+  console.info('Upload status from Smartling: ', uploadFileRes)
 
   return getTranslationTask(documentId, secrets)
 }

package/src/adapter/getLocales.ts

@@ -1,13 +1,20 @@
-import { smartlingProxy, authenticate, getHeaders } from './helpers'
-import { Secrets } from 'sanity-translations-tab'
+import {authenticate, getHeaders} from './helpers'
+import {Secrets} from 'sanity-translations-tab'
+import {Adapter} from 'sanity-translations-tab'
 
-export const getLocales = async (secrets: Secrets) => {
-  const url = `https://api.smartling.com/projects-api/v2/projects/${secrets.project}`
-  const accessToken = await authenticate(secrets.secret)
-  return fetch(smartlingProxy, {
-    method: 'POST',
+export const getLocales: Adapter['getLocales'] = async (secrets: Secrets | null) => {
+  if (!secrets?.project || !secrets?.secret || !secrets?.proxy) {
+    throw new Error(
+      'The Smartling adapter requires a project ID, a secret key, and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
+  const {project, proxy} = secrets
+  const url = `https://api.smartling.com/projects-api/v2/projects/${project}`
+  const accessToken = await authenticate(secrets)
+  return fetch(proxy, {
+    method: 'GET',
     headers: getHeaders(url, accessToken),
   })
-    .then(res => res.json())
-    .then(res => res.response.data.targetLocales)
+    .then((res) => res.json())
+    .then((res) => res.response.data.targetLocales)
 }

package/src/adapter/getTranslation.ts

@@ -1,27 +1,35 @@
-import { smartlingProxy, authenticate, getHeaders } from './helpers'
-import { Secrets } from 'sanity-translations-tab'
+import {authenticate, getHeaders} from './helpers'
+import {Adapter, Secrets} from 'sanity-translations-tab'
 
-export const getTranslation = async (
+export const getTranslation: Adapter['getTranslation'] = async (
   taskId: string,
   localeId: string,
-  secrets: Secrets
+  secrets: Secrets | null
 ) => {
-  const url = `https://api.smartling.com/files-api/v2/projects/${secrets.project}/locales/${localeId}/file?fileUri=${taskId}&retrievalType=pending`
-  const accessToken = await authenticate(secrets.secret)
-  const translatedHTML = await fetch(smartlingProxy, {
-    method: 'POST',
+  if (!secrets?.project || !secrets?.secret || !secrets?.proxy) {
+    throw new Error(
+      'The Smartling adapter requires a project ID, a secret key, and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
+
+  const {project, proxy} = secrets
+
+  const url = `https://api.smartling.com/files-api/v2/projects/${project}/locales/${localeId}/file?fileUri=${taskId}&retrievalType=pending`
+  const accessToken = await authenticate(secrets)
+  const translatedHTML = await fetch(proxy, {
+    method: 'GET',
     headers: getHeaders(url, accessToken),
   })
-    .then(res => res.json())
-    .then(res => {
+    .then((res) => res.json())
+    .then((res) => {
       if (res.body) {
         return res.body
       } else if (res.response.errors) {
         const errMsg =
-          res.response.errors[0]?.message ||
-          'Error retrieving translation from Smartling'
+          res.response.errors[0]?.message || 'Error retrieving translation from Smartling'
         throw new Error(errMsg)
       }
+      return ''
     })
 
   return translatedHTML

package/src/adapter/getTranslationTask.ts

@@ -1,17 +1,27 @@
-import {
-  smartlingProxy,
-  authenticate,
-  getHeaders,
-  findExistingJob,
-} from './helpers'
-import { Secrets } from 'sanity-translations-tab'
+import {authenticate, getHeaders, findExistingJob} from './helpers'
+import {Adapter, Secrets} from 'sanity-translations-tab'
 
-export const getTranslationTask = async (
+interface SmartlingProgressItem {
+  targetLocaleId: string
+  progress: {
+    percentComplete: number
+  }
+}
+
+export const getTranslationTask: Adapter['getTranslationTask'] = async (
   documentId: string,
-  secrets: Secrets
+  secrets: Secrets | null
 ) => {
-  const accessToken = await authenticate(secrets.secret)
-  const taskId = await findExistingJob(documentId, secrets.project, accessToken)
+  if (!secrets?.project || !secrets?.secret || !secrets?.proxy) {
+    throw new Error(
+      'The Smartling adapter requires a project ID, a secret key, and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
+
+  const {project, proxy} = secrets
+
+  const accessToken = await authenticate(secrets)
+  const taskId = await findExistingJob(documentId, secrets, accessToken)
   if (!taskId) {
     return {
       documentId,
@@ -20,18 +30,17 @@ export const getTranslationTask = async (
     }
   }
 
-  const projectId = secrets.project
-  const progressUrl = `https://api.smartling.com/jobs-api/v3/projects/${projectId}/jobs/${taskId}/progress`
-  const smartlingTask = await fetch(smartlingProxy, {
-    method: 'POST',
+  const progressUrl = `https://api.smartling.com/jobs-api/v3/projects/${project}/jobs/${taskId}/progress`
+  const smartlingTask = await fetch(proxy, {
+    method: 'GET',
     headers: getHeaders(progressUrl, accessToken),
   })
-    .then(res => res.json())
-    .then(res => res.response.data)
+    .then((res) => res.json())
+    .then((res) => res.response.data)
 
   let locales = []
   if (smartlingTask && smartlingTask.contentProgressReport) {
-    locales = smartlingTask.contentProgressReport.map(item => ({
+    locales = smartlingTask.contentProgressReport.map((item: SmartlingProgressItem) => ({
       localeId: item.targetLocaleId,
       progress: item.progress ? item.progress.percentComplete : 0,
     }))
@@ -42,6 +51,6 @@ export const getTranslationTask = async (
     locales,
     //since our download is tied to document id for smartling, keep track of it as a task
     taskId: documentId,
-    linkToVendorTask: `https://dashboard.smartling.com/app/projects/${projectId}/account-jobs/${projectId}:${taskId}`,
+    linkToVendorTask: `https://dashboard.smartling.com/app/projects/${project}/account-jobs/${project}:${taskId}`,
   }
 }

package/src/adapter/helpers.ts

@@ -1,49 +1,63 @@
-export const smartlingProxy = process.env.SANITY_STUDIO_SMARTLING_PROXY
+import {Secrets} from 'sanity-translations-tab'
 
-export const authenticate = async (secret: string) => {
+interface Headers {
+  [key: string]: string
+}
+
+export const authenticate = (secrets: Secrets): Promise<string> => {
   const url = 'https://api.smartling.com/auth-api/v2/authenticate'
   const headers = {
     'content-type': 'application/json',
     'X-URL': url,
   }
-  return fetch(smartlingProxy, {
+  const {secret, proxy} = secrets
+  if (!secret || !proxy) {
+    throw new Error(
+      'The Smartling adapter requires a secret key and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
+  return fetch(proxy, {
     headers,
     method: 'POST',
     body: JSON.stringify(secret),
   })
-    .then(res => res.json())
-    .then(res => res.response.data.accessToken)
+    .then((res) => res.json())
+    .then((res) => res.response.data.accessToken)
 }
 
-export const getHeaders = (url: string, accessToken: string) => ({
+export const getHeaders = (url: string, accessToken: string): Headers => ({
   Authorization: `Bearer ${accessToken}`,
   'X-URL': url,
 })
 
-export const findExistingJob = async (
+export const findExistingJob = (
   documentId: string,
-  projectId: string,
+  secrets: Secrets,
   accessToken: string
 ): Promise<string> => {
-  const url = `https://api.smartling.com/jobs-api/v3/projects/${projectId}/jobs?jobName=${documentId}`
-  return fetch(smartlingProxy, {
+  const {project, proxy} = secrets
+  if (!project || !proxy) {
+    throw new Error(
+      'The Smartling adapter requires a Smartling project identifier and a proxy URL. Please check your secrets document in this dataset, per the plugin documentation.'
+    )
+  }
+  const url = `https://api.smartling.com/jobs-api/v3/projects/${project}/jobs?jobName=${documentId}`
+  return fetch(proxy, {
     method: 'POST',
     headers: getHeaders(url, accessToken),
   })
-    .then(res => res.json())
-    .then(res => {
+    .then((res) => res.json())
+    .then((res) => {
       if (res.response.data.items.length) {
         //smartling will fuzzy match job names. We need to be precise.
         const correctJob = res.response.data.items.find(
-          item => item.jobName && item.jobName === documentId
+          (item: {jobName: string}) => item.jobName && item.jobName === documentId
         )
         if (correctJob) {
           return correctJob.translationJobUid
-        } else {
-          return ''
         }
-      } else {
         return ''
       }
+      return ''
     })
 }

package/src/adapter/index.ts

@@ -1,8 +1,8 @@
-import { Adapter } from 'sanity-translations-tab'
-import { getLocales } from './getLocales'
-import { getTranslationTask } from './getTranslationTask'
-import { createTask } from './createTask'
-import { getTranslation } from './getTranslation'
+import {Adapter} from 'sanity-translations-tab'
+import {getLocales} from './getLocales'
+import {getTranslationTask} from './getTranslationTask'
+import {createTask} from './createTask'
+import {getTranslation} from './getTranslation'
 
 export const SmartlingAdapter: Adapter = {
   getLocales,

package/src/index.ts

@@ -1,3 +1,4 @@
+import {SerializedDocument} from 'sanity-naive-html-serializer'
 import {
   TranslationsTab,
   baseDocumentLevelConfig,
@@ -11,17 +12,22 @@ import {
   Adapter,
   documentLevelPatch,
   fieldLevelPatch,
+  TranslationFunctionContext,
 } from 'sanity-translations-tab'
-import { SmartlingAdapter } from './adapter'
+import {SmartlingAdapter} from './adapter'
 
 interface ConfigOptions {
   adapter: Adapter
   secretsNamespace: string | null
-  exportForTranslation: (id: string) => Promise<Record<string, any>>
+  exportForTranslation: (
+    id: string,
+    context: TranslationFunctionContext
+  ) => Promise<SerializedDocument>
   importTranslation: (
     id: string,
     localeId: string,
-    doc: string
+    doc: string,
+    context: TranslationFunctionContext
   ) => Promise<void>
 }
 const defaultDocumentLevelConfig: ConfigOptions = {

package/v2-incompatible.js

@@ -0,0 +1,11 @@
+const {showIncompatiblePluginDialog} = require('@sanity/incompatible-plugin')
+const {name, version, sanityExchangeUrl} = require('./package.json')
+
+export default showIncompatiblePluginDialog({
+  name: name,
+  versions: {
+    v3: version,
+    v2: undefined,
+  },
+  sanityExchangeUrl,
+})

package/dist/adapter/createTask.d.ts

@@ -1,12 +0,0 @@
-import { Secrets } from 'sanity-translations-tab';
-export declare const createTask: (documentId: string, document: Record<string, any>, localeIds: string[], secrets: Secrets, workflowUid?: string) => Promise<{
-    documentId: string;
-    taskId: string;
-    locales: any[];
-    linkToVendorTask?: undefined;
-} | {
-    documentId: string;
-    locales: any[];
-    taskId: string;
-    linkToVendorTask: string;
-}>;

package/dist/adapter/getLocales.d.ts

@@ -1,2 +0,0 @@
-import { Secrets } from 'sanity-translations-tab';
-export declare const getLocales: (secrets: Secrets) => Promise<any>;

package/dist/adapter/getTranslation.d.ts

@@ -1,2 +0,0 @@
-import { Secrets } from 'sanity-translations-tab';
-export declare const getTranslation: (taskId: string, localeId: string, secrets: Secrets) => Promise<any>;