sanity-plugin-transifex 2.0.5 → 3.0.0

package/src/transifexAdapter/getTranslation.ts

@@ -1,11 +1,53 @@
-import { Secrets } from 'sanity-translations-tab'
-import { baseTransifexUrl, getHeaders } from './helpers'
+import {Adapter, Secrets} from 'sanity-translations-tab'
+import {baseTransifexUrl, getHeaders} from './helpers'
 
-export default async function getTranslation(
+const pollForFileDownloadLocation = async (
+  resourceDownloadUrl: string,
+  translationDownloadId: string,
+  headers: Record<string, any>
+): Promise<string> => {
+  const response = await fetch(`${resourceDownloadUrl}/${translationDownloadId}`, {
+    headers: headers,
+  })
+
+  if (response.status === 500) {
+    //eslint-disable-next-line no-console -- this is for developer feedback/debugging
+    console.info(
+      `Transifex plugin message: Received 500 for translation download ID ${translationDownloadId}. Trying to reconnect...`
+    )
+    await new Promise((resolve) => setTimeout(resolve, 3000))
+    return pollForFileDownloadLocation(resourceDownloadUrl, translationDownloadId, headers)
+  } else if (response.redirected) {
+    //eslint-disable-next-line no-console -- this is for developer feedback/debugging
+    console.info(
+      `Transifex plugin message: Received redirect for translation download ID ${translationDownloadId}. Following redirect now for file download.`
+    )
+    return response.url
+  } else if (response.status === 200) {
+    //eslint-disable-next-line no-console -- this is for developer feedback/debugging
+    console.info(
+      `Transifex plugin message: Requested download location for translation download ID ${translationDownloadId}. Location is still pending, trying again.`
+    )
+    await new Promise((resolve) => setTimeout(resolve, 3000))
+    return pollForFileDownloadLocation(resourceDownloadUrl, translationDownloadId, headers)
+  }
+  //eslint-disable-next-line no-console -- this is for developer feedback/debugging
+  console.error(
+    `Transifex plugin message: Requested download location for translation download ID ${translationDownloadId} but received error code ${response.status}. Waiting and trying again.`
+  )
+  await new Promise((resolve) => setTimeout(resolve, 3000))
+  return pollForFileDownloadLocation(resourceDownloadUrl, translationDownloadId, headers)
+}
+
+const handleFileDownload = (url: string) => {
+  return fetch(url).then((res) => res.text())
+}
+
+export const getTranslation: Adapter['getTranslation'] = async (
   taskId: string,
   localeId: string,
   secrets: Secrets | null
-) {
+) => {
   const resourceDownloadBody = {
     data: {
       attributes: {
@@ -35,8 +77,8 @@ export default async function getTranslation(
     method: 'POST',
     body: JSON.stringify(resourceDownloadBody),
   })
-    .then(res => res.json())
-    .then(res => res.data.id)
+    .then((res) => res.json())
+    .then((res) => res.data.id)
 
   const headers = getHeaders(secrets)
   const location = await pollForFileDownloadLocation(
@@ -46,57 +88,3 @@ export default async function getTranslation(
   )
   return handleFileDownload(location)
 }
-
-const pollForFileDownloadLocation = async (
-  resourceDownloadUrl: string,
-  translationDownloadId: string,
-  headers: Record<string, any>
-): Promise<string> => {
-  const response = await fetch(
-    `${resourceDownloadUrl}/${translationDownloadId}`,
-    {
-      headers: headers,
-    }
-  )
-
-  if (response.status === 500) {
-    console.info(
-      `Transifex plugin message: Received 500 for translation download ID ${translationDownloadId}. Trying to reconnect...`
-    )
-    await new Promise(resolve => setTimeout(resolve, 3000))
-    return pollForFileDownloadLocation(
-      resourceDownloadUrl,
-      translationDownloadId,
-      headers
-    )
-  } else if (response.redirected) {
-    console.info(
-      `Transifex plugin message: Received redirect for translation download ID ${translationDownloadId}. Following redirect now for file download.`
-    )
-    return response.url
-  } else if (response.status === 200) {
-    console.info(
-      `Transifex plugin message: Requested download location for translation download ID ${translationDownloadId}. Location is still pending, trying again.`
-    )
-    await new Promise(resolve => setTimeout(resolve, 3000))
-    return pollForFileDownloadLocation(
-      resourceDownloadUrl,
-      translationDownloadId,
-      headers
-    )
-  } else {
-    console.info(
-      `Transifex plugin message: Requested download location for translation download ID ${translationDownloadId} but received error code ${response.status}. Waiting and trying again.`
-    )
-    await new Promise(resolve => setTimeout(resolve, 3000))
-    return pollForFileDownloadLocation(
-      resourceDownloadUrl,
-      translationDownloadId,
-      headers
-    )
-  }
-}
-
-const handleFileDownload = async (url: string) => {
-  return fetch(url).then(res => res.text())
-}

package/src/transifexAdapter/getTranslationTask.ts

@@ -1,11 +1,11 @@
-import { Secrets } from 'sanity-translations-tab'
-import { baseTransifexUrl, projOrgSlug, getHeaders } from './helpers'
-import getLocales from './getLocales'
+import {Adapter, Secrets} from 'sanity-translations-tab'
+import {baseTransifexUrl, projOrgSlug, getHeaders} from './helpers'
+import {getLocales} from './getLocales'
 
-export default async function getTranslationTask(
+export const getTranslationTask: Adapter['getTranslationTask'] = async (
   documentId: string,
   secrets: Secrets | null
-) {
+) => {
   if (!documentId || !secrets) {
     return {
       taskId: documentId,
@@ -14,35 +14,28 @@ export default async function getTranslationTask(
     }
   }
   const projectFilter = `filter[project]=${projOrgSlug(secrets)}`
-  const resourceFilter = `filter[resource]=${projOrgSlug(
-    secrets
-  )}:r:${documentId}`
+  const resourceFilter = `filter[resource]=${projOrgSlug(secrets)}:r:${documentId}`
   const task = await fetch(
     `${baseTransifexUrl}/resource_language_stats?${projectFilter}&${resourceFilter}`,
-    { headers: getHeaders(secrets) }
+    {headers: getHeaders(secrets)}
   )
-    .then(res => {
+    .then((res) => {
       if (res.ok) {
         return res.json()
       }
       //normal -- just means that this task doesn't exist yet.
       else if (res.status === 404) {
-        return { data: [] }
-      } else {
-        throw Error(
-          `Failed to retrieve tasks from Transifex. Status: ${res.status}`
-        )
+        return {data: []}
       }
+      throw Error(`Failed to retrieve tasks from Transifex. Status: ${res.status}`)
     })
-    .then(res => ({
+    .then((res) => ({
       taskId: `${projOrgSlug(secrets)}:r:${documentId}`,
       documentId: documentId,
       locales: res.data.map((locale: Record<string, any>) => ({
         localeId: locale.relationships.language.data.id.split(':')[1],
         progress: Math.floor(
-          100 *
-            (locale.attributes.reviewed_strings /
-              parseFloat(locale.attributes.total_strings))
+          100 * (locale.attributes.reviewed_strings / parseFloat(locale.attributes.total_strings))
         ),
       })),
     }))

package/src/transifexAdapter/helpers.ts

@@ -1,11 +1,11 @@
-import { Secrets } from 'sanity-translations-tab'
+import {Secrets} from 'sanity-translations-tab'
 
 export const baseTransifexUrl = 'https://rest.api.transifex.com'
 
-export const getHeaders = (secrets: Secrets | null) => ({
+export const getHeaders = (secrets: Secrets | null): Record<string, string> => ({
   Authorization: `Bearer ${secrets?.token}`,
   'Content-Type': 'application/vnd.api+json',
 })
 
-export const projOrgSlug = (secrets: Secrets | null) =>
+export const projOrgSlug = (secrets: Secrets | null): string =>
   `o:${secrets?.organization}:p:${secrets?.project}`

package/src/transifexAdapter/index.ts

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

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/.github/workflows/main.yml

@@ -1,29 +0,0 @@
-name: CI
-on: [push]
-jobs:
-  build:
-    name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
-
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        node: ['12.x', '14.x', '16.x']
-        os: [ubuntu-latest, windows-latest, macOS-latest]
-
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v2
-
-      - name: Use Node ${{ matrix.node }}
-        uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node }}
-
-      - name: Install deps and build (with cache)
-        uses: bahmutov/npm-install@v1
-
-      - name: Lint
-        run: yarn lint
-
-      - name: Build
-        run: yarn build

package/.github/workflows/npm-publish.yml

@@ -1,19 +0,0 @@
-name: Node.js Package
-
-on:
-  release:
-    types: [created]
-
-jobs:
-  publish-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 15
-          registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}