sanity-plugin-studio-smartling 4.3.2 → 5.0.0

package/src/adapter/createTask.ts

@@ -1,166 +0,0 @@
-import {authenticate, getHeaders, findExistingJob} from './helpers'
-import {Adapter, Secrets, SerializedDocument} from 'sanity-translations-tab'
-import {getTranslationTask} from './getTranslationTask'
-import {Buffer} from 'buffer'
-
-const createJob = (
-  jobName: string,
-  secrets: Secrets,
-  localeIds: string[],
-  accessToken: string,
-  documentId: 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),
-      'content-type': 'application/json',
-    },
-    body: JSON.stringify({
-      jobName,
-      targetLocaleIds: localeIds,
-      referenceNumber: documentId,
-    }),
-  })
-    .then((res) => res.json())
-    .then((res) => res.response.data.translationJobUid)
-}
-
-/* we're using batches here because it eliminates some
- * new string authorization issues for updating existing jobs,
- * and is able to be used for new bulk
- * job functionality.
- */
-
-const createJobBatch = (
-  jobId: string,
-  secrets: Secrets,
-  documentId: string,
-  accessToken: string,
-  localeIds: string[],
-  workflowUid?: string,
-  //eslint-disable-next-line max-params
-) => {
-  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}[]
-  } = {
-    authorize: true,
-    translationJobUid: jobId,
-    fileUris: [documentId],
-  }
-
-  if (workflowUid) {
-    reqBody.localeWorkflows = localeIds.map((l) => ({
-      targetLocaleId: l,
-      workflowUid,
-    }))
-  }
-
-  return fetch(proxy, {
-    method: 'POST',
-    headers: {
-      ...getHeaders(url, accessToken),
-      'content-type': 'application/json',
-    },
-    body: JSON.stringify(reqBody),
-  })
-    .then((res) => res.json())
-    .then((res) => res.response.data.batchUid)
-}
-
-const uploadFileToBatch = (
-  batchUid: string,
-  documentId: string,
-  document: SerializedDocument,
-  secrets: Secrets,
-  localeIds: string[],
-  accessToken: string,
-  callbackUrl?: string,
-  //eslint-disable-next-line max-params
-) => {
-  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', documentId)
-  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))
-  if (callbackUrl) {
-    formData.append('callbackUrl', callbackUrl)
-  }
-
-  return fetch(proxy, {
-    method: 'POST',
-    headers: getHeaders(url, accessToken),
-    body: formData,
-  }).then((res) => res.json())
-}
-
-export const createTask: Adapter['createTask'] = async (
-  documentId: string,
-  document: SerializedDocument,
-  localeIds: string[],
-  secrets: Secrets | null,
-  workflowUid?: string,
-  callbackUrl?: string,
-  // eslint-disable-next-line max-params
-) => {
-  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 accessToken = await authenticate(secrets)
-
-  let taskId = await findExistingJob(document.name, secrets, accessToken)
-  if (!taskId) {
-    taskId = await createJob(document.name, secrets, localeIds, accessToken, documentId)
-  }
-
-  const batchUid = await createJobBatch(
-    taskId,
-    secrets,
-    documentId,
-    accessToken,
-    localeIds,
-    workflowUid,
-  )
-  const uploadFileRes = await uploadFileToBatch(
-    batchUid,
-    documentId,
-    document,
-    secrets,
-    localeIds,
-    accessToken,
-    callbackUrl,
-  )
-  //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,18 +0,0 @@
-import {authenticate, getHeaders} from './helpers'
-import {Secrets} from 'sanity-translations-tab'
-import {Adapter} from 'sanity-translations-tab'
-
-export const getLocales: Adapter['getLocales'] = async (secrets: Secrets | null) => {
-  if (!secrets?.project || !secrets?.secret || !secrets?.proxy) {
-    return []
-  }
-  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)
-}

package/src/adapter/getTranslation.ts

@@ -1,36 +0,0 @@
-import {authenticate, getHeaders} from './helpers'
-import {Adapter, Secrets} from 'sanity-translations-tab'
-
-export const getTranslation: Adapter['getTranslation'] = async (
-  taskId: string,
-  localeId: string,
-  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/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) => {
-      if (res.body) {
-        return res.body
-      } else if (res.response.errors) {
-        const errMsg =
-          res.response.errors[0]?.message || 'Error retrieving translation from Smartling'
-        throw new Error(errMsg)
-      }
-      return ''
-    })
-
-  return translatedHTML
-}

package/src/adapter/getTranslationTask.ts

@@ -1,89 +0,0 @@
-import {authenticate, getHeaders, findExistingJob} from './helpers'
-import {Adapter, Secrets} from 'sanity-translations-tab'
-
-interface WorkflowProgressItem {
-  workflowStepSummaryReportItemList: {
-    wordCount: number
-  }[]
-}
-
-interface SmartlingProgressItem {
-  targetLocaleId: string
-  progress: {
-    percentComplete: number
-    totalWordCount: number
-  }
-  workflowProgressReportList: WorkflowProgressItem[]
-}
-
-export const getTranslationTask: Adapter['getTranslationTask'] = async (
-  documentId: string,
-  secrets: Secrets | null,
-) => {
-  if (!secrets?.project || !secrets?.secret || !secrets?.proxy) {
-    return {
-      documentId,
-      taskId: documentId,
-      locales: [],
-    }
-  }
-
-  const {project, proxy} = secrets
-
-  const accessToken = await authenticate(secrets)
-  const taskId = await findExistingJob(documentId, secrets, accessToken)
-  if (!taskId) {
-    return {
-      documentId,
-      taskId: documentId,
-      locales: [],
-    }
-  }
-
-  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)
-
-  let locales = []
-  if (smartlingTask && smartlingTask.contentProgressReport) {
-    locales = smartlingTask.contentProgressReport.map((item: SmartlingProgressItem) => {
-      let progress = item.progress ? item.progress.percentComplete : 0
-      if (
-        item.workflowProgressReportList &&
-        item.workflowProgressReportList.length > 0 &&
-        item.progress
-      ) {
-        //default to the first workflow -- it's likely what is being used
-        const progressItem = item.workflowProgressReportList[0]
-        //this is a list of the various steps in the workflow
-        if (
-          progressItem.workflowStepSummaryReportItemList &&
-          progressItem.workflowStepSummaryReportItemList.length > 1
-        ) {
-          //get the last step in the workflow -- usually "published"
-          const lastStep = progressItem.workflowStepSummaryReportItemList.at(-1)
-          //get the percentage of how many words have reached the last step
-          if (lastStep && lastStep.wordCount >= 0) {
-            progress = Math.floor((lastStep.wordCount / item.progress.totalWordCount) * 100) ?? 0
-          }
-        }
-      }
-      return {
-        localeId: item.targetLocaleId,
-        progress,
-      }
-    })
-  }
-
-  return {
-    documentId,
-    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/${project}/account-jobs/${project}:${taskId}`,
-  }
-}

package/src/adapter/helpers.ts

@@ -1,84 +0,0 @@
-import {Secrets} from 'sanity-translations-tab'
-
-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,
-  }
-  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)
-}
-
-export const getHeaders = (url: string, accessToken: string): Headers => ({
-  Authorization: `Bearer ${accessToken}`,
-  'X-URL': url,
-})
-
-export const findExistingJob = async (
-  documentId: string,
-  secrets: Secrets,
-  accessToken: string,
-): Promise<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?jobName=${documentId}`
-  //first, try fetching from name resolution
-  let items = await fetch(proxy, {
-    headers: getHeaders(url, accessToken),
-  })
-    .then((res) => res.json())
-    .then((res) => res?.response?.data?.items)
-
-  if (!items || !items.length) {
-    //if that fails, try fetching by fileUri and check the referenceNumber
-    const refUrl = `https://api.smartling.com/jobs-api/v3/projects/${project}/jobs/search`
-    items = await fetch(proxy, {
-      headers: {
-        ...getHeaders(refUrl, accessToken),
-        'content-type': 'application/json',
-      },
-      method: 'POST',
-      body: JSON.stringify({
-        fileUris: [documentId],
-      }),
-    })
-      .then((res) => res.json())
-      .then((res) => res?.response?.data?.items)
-  }
-
-  if (items.length) {
-    //smartling will fuzzy match job names. We need to be precise.
-    const correctJob = items
-      .filter((item: {jobStatus: string}) => item.jobStatus !== 'DELETED')
-      .find(
-        (item: {jobName: string; referenceNumber: string}) =>
-          (item.jobName && item.jobName === documentId) ||
-          (item.referenceNumber && item.referenceNumber === documentId),
-      )
-
-    if (correctJob) {
-      return correctJob.translationJobUid
-    }
-  }
-  return ''
-}

package/src/adapter/index.ts

@@ -1,12 +0,0 @@
-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,
-  getTranslationTask,
-  createTask,
-  getTranslation,
-}

package/src/index.ts

@@ -1,52 +0,0 @@
-import {
-  TranslationsTab,
-  baseDocumentLevelConfig,
-  legacyDocumentLevelConfig as baseLegacyDocumentLevelConfig,
-  baseFieldLevelConfig,
-  findLatestDraft,
-  BaseDocumentDeserializer,
-  BaseDocumentSerializer,
-  BaseDocumentMerger,
-  defaultStopTypes,
-  customSerializers,
-  legacyDocumentLevelPatch,
-  documentLevelPatch,
-  fieldLevelPatch,
-  TranslationFunctionContext,
-  TranslationsTabConfigOptions,
-} from 'sanity-translations-tab'
-import {SmartlingAdapter} from './adapter'
-
-const defaultDocumentLevelConfig: TranslationsTabConfigOptions = {
-  ...baseDocumentLevelConfig,
-  adapter: SmartlingAdapter,
-}
-
-const legacyDocumentLevelConfig: TranslationsTabConfigOptions = {
-  ...baseLegacyDocumentLevelConfig,
-  adapter: SmartlingAdapter,
-}
-
-const defaultFieldLevelConfig: TranslationsTabConfigOptions = {
-  ...baseFieldLevelConfig,
-  adapter: SmartlingAdapter,
-}
-
-export {
-  TranslationsTab,
-  findLatestDraft,
-  legacyDocumentLevelPatch,
-  documentLevelPatch,
-  fieldLevelPatch,
-  BaseDocumentDeserializer,
-  BaseDocumentSerializer,
-  BaseDocumentMerger,
-  defaultStopTypes,
-  customSerializers,
-  SmartlingAdapter,
-  legacyDocumentLevelConfig,
-  defaultDocumentLevelConfig,
-  defaultFieldLevelConfig,
-}
-
-export type {TranslationFunctionContext, TranslationsTabConfigOptions}

package/v2-incompatible.js

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