scratch-l10n 5.0.308 → 6.0.0

package/.github/workflows/daily-tx-pull.yml

@@ -1,54 +0,0 @@
-name: Daily TX Pull
-
-on:
-  workflow_dispatch: # Allows you to run this workflow manually from the Actions tab
-  schedule:
-    # daily-tx-pull (e.g., daily at 3 AM UTC)
-    - cron: '0 3 * * *'
-
-concurrency:
-  group: '${{ github.workflow }}'
-  cancel-in-progress: true
-
-permissions:
-  contents: write # publish a GitHub release
-  pages: write # deploy to GitHub Pages
-  issues: write # comment on released issues
-  pull-requests: write # comment on released pull requests
-
-jobs:
-  daily-tx-pull:
-    runs-on: ubuntu-latest
-
-    env:
-      # Organization-wide secrets
-      TX_TOKEN: ${{ secrets.TX_TOKEN }}
-
-    steps:
-      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
-      - uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3
-        with:
-          cache: 'npm'
-          node-version-file: '.nvmrc'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Pull editor and www translations
-        run: |
-          npm run pull:editor
-          npm run pull:www
-          npm run test
-
-      - name: Commit translation updates
-        id: commit
-        run: |
-          git config --global user.email $(git log --pretty=format:"%ae" -n1)
-          git config --global user.name $(git log --pretty=format:"%an" -n1)
-          git add .
-          if git diff --cached --exit-code --quiet; then
-            echo "Nothing to commit."
-          else
-            git commit -m "fix: pull new editor translations from Transifex"
-            git push
-          fi

package/.github/workflows/signature-assistant.yml

@@ -1,31 +0,0 @@
-name: 'Signature Assistant'
-on:
-  issue_comment:
-    types: [created]
-  pull_request_target:
-    types: [opened, closed, synchronize]
-
-permissions:
-  actions: write
-  contents: read
-  pull-requests: write
-  statuses: write
-
-jobs:
-  CLA-Assistant:
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'CLA Assistant'
-        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
-        uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08 # v2.6.1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # the below token should have repo scope and must be manually added by you in the repository's secrets
-          PERSONAL_ACCESS_TOKEN: ${{ secrets.GHA_AGREEMENTS_PAT }}
-        with:
-          remote-organization-name: 'scratchfoundation'
-          remote-repository-name: 'scratch-agreements'
-          path-to-signatures: 'signatures/version1/cla.json'
-          path-to-document: 'https://github.com/scratchfoundation/scratch-agreements/blob/main/CLA.md'
-          branch: 'main'
-          allowlist: semantic-release-bot,*[bot]

package/lib/batch.js

@@ -1,15 +0,0 @@
-/**
- * Maps each value of an array into an async function, and returns an array of the results
- * @param {Array} arr - array of values
- * @param {number} batchSize - number of calls to `func` to do at one time
- * @param {Function} func - async function to apply to all items in `arr`. Function should take one argument.
- * @returns {Promise<Array>} - results of `func` applied to each item in `arr`
- */
-exports.batchMap = async (arr, batchSize, func) => {
-  const results = []
-  for (let i = 0; i < arr.length; i += batchSize) {
-    const result = await Promise.all(arr.slice(i, i + batchSize).map(func))
-    results.push(...result)
-  }
-  return results
-}

package/lib/transifex.js

@@ -1,242 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * @file
- * Utilities for interfacing with Transifex API 3.
- */
-
-const transifexApi = require('@transifex/api').transifexApi
-const download = require('download')
-
-/**
- * @import {Collection, JsonApiResource} from '@transifex/api';
- */
-
-const ORG_NAME = 'llk'
-const SOURCE_LOCALE = 'en'
-
-try {
-  transifexApi.setup({
-    auth: process.env.TX_TOKEN,
-  })
-} catch (err) {
-  if (!process.env.TX_TOKEN) {
-    throw new Error('TX_TOKEN is not defined.')
-  }
-  throw err
-}
-
-/*
- * The Transifex JS API wraps the Transifex JSON API, and is built around the concept of a `Collection`.
- * A `Collection` begins as a URL builder: methods like `filter` and `sort` add query parameters to the URL.
- * The `download` method doesn't actually download anything: it returns the built URL. It seems to be intended
- * primarily for internal use, but shows up in the documentation despite not being advertised in the .d.ts file.
- * The `download` method is mainly used to skip the `fetch` method in favor of downloading the resource yourself.
- * The `fetch` method sends a request to the URL and returns a promise that resolves to the first page of results.
- * If there's only one page of results, the `data` property of the collection object will be an array of all results.
- * However, if there are multiple pages of results, the `data` property will only contain the first page of results.
- * Previous versions of this code would unsafely assume that the `data` property contained all results.
- * The `all` method returns an async iterator that yields all results, fetching additional pages as needed.
- */
-
-/**
- * Collects all resources from all pages of a potentially-paginated Transifex collection.
- * It's not necessary, but also not harmful, to call `fetch()` on the collection before calling this function.
- * @param {Collection} collection A collection of Transifex resources.
- * @returns {Promise<JsonApiResource[]>} An array of all resources in the collection.
- */
-const collectAll = async function (collection) {
-  await collection.fetch() // fetch the first page if it hasn't already been fetched
-  const collected = []
-  for await (const item of collection.all()) {
-    collected.push(item)
-  }
-  return collected
-}
-
-/**
- * Creates a download event for a specific project, resource, and locale.
- * Returns the URL to download the resource.
- * @param {string} projectSlug - project slug (for example,  "scratch-editor")
- * @param {string} resourceSlug - resource slug (for example,  "blocks")
- * @param {string} localeCode - language code (for example,  "ko")
- * @param {string} mode - translation status of strings to include
- * @returns {Promise<string>} - URL to download the resource
- */
-const getResourceLocation = async function (projectSlug, resourceSlug, localeCode, mode = 'default') {
-  const resource = {
-    data: {
-      id: `o:${ORG_NAME}:p:${projectSlug}:r:${resourceSlug}`,
-      type: 'resources',
-    },
-  }
-
-  // if locale is English, create a download event of the source file
-  if (localeCode === SOURCE_LOCALE) {
-    return await transifexApi.ResourceStringsAsyncDownload.download({
-      resource,
-    })
-  }
-
-  const language = {
-    data: {
-      id: `l:${localeCode}`,
-      type: 'languages',
-    },
-  }
-
-  // if locale is not English, create a download event of the translation file
-  return await transifexApi.ResourceTranslationsAsyncDownload.download({
-    mode,
-    resource,
-    language,
-  })
-}
-
-/**
- * Pulls a translation json from transifex, for a specific project, resource, and locale.
- * @param {string} project - project slug (for example,  "scratch-editor")
- * @param {string} resource - resource slug (for example,  "blocks")
- * @param {string} locale - language code (for example,  "ko")
- * @param {string} mode - translation status of strings to include
- * @returns {Promise<object>} - JSON object of translated resource strings (or, of the original resource
- * strings, if the local is the source language)
- */
-const txPull = async function (project, resource, locale, mode = 'default') {
-  let buffer
-  try {
-    const url = await getResourceLocation(project, resource, locale, mode)
-    for (let i = 0; i < 5; i++) {
-      if (i > 0) {
-        console.log(`Retrying txPull download after ${i} failed attempt(s)`)
-      }
-      try {
-        buffer = await download(url) // might throw(?)
-        break
-      } catch (e) {
-        console.error(e, { project, resource, locale, buffer })
-      }
-    }
-    if (!buffer) {
-      throw Error(`txPull download failed after 5 retries: ${url}`)
-    }
-    buffer = buffer.toString()
-    return JSON.parse(buffer)
-  } catch (e) {
-    e.cause = {
-      project,
-      resource,
-      locale,
-      buffer,
-    }
-    throw e
-  }
-}
-
-/**
- * Given a project, returns a list of the slugs of all resources in the project
- * @param {string} project - project slug (for example,  "scratch-website")
- * @returns {Promise<Array>} - array of strings, slugs identifying each resource in the project
- */
-const txResources = async function (project) {
-  const resources = transifexApi.Resource.filter({
-    project: `o:${ORG_NAME}:p:${project}`,
-  })
-
-  const resourcesData = await collectAll(resources)
-
-  const slugs = resourcesData.map(
-    r =>
-      // r.id is a longer id string, like "o:llk:p:scratch-website:r:about-l10njson"
-      // We just want the slug that comes after ":r:" ("about-l10njson")
-      r.id.split(':r:')[1],
-  )
-  return slugs
-}
-
-/**
- * @param {string} project - project slug (for example)
- * @returns {Promise<JsonApiResource[]>} - array of resource objects
- */
-const txResourcesObjects = async function (project) {
-  const resources = transifexApi.Resource.filter({
-    project: `o:${ORG_NAME}:p:${project}`,
-  })
-
-  return collectAll(resources)
-}
-
-/**
- * Gets available languages for a project
- * @param {string} slug - project slug (for example, "scratch-editor")
- * @returns {Promise<string[]>} - list of language codes
- */
-const txAvailableLanguages = async function (slug) {
-  const project = await transifexApi.Project.get({
-    organization: `o:${ORG_NAME}`,
-    slug: slug,
-  })
-
-  const languages = await project.fetch('languages')
-  const languagesData = await collectAll(languages)
-  return languagesData.map(l => l.attributes.code)
-}
-
-/**
- * Uploads English source strings to a resource in transifex
- * @param {string} project - project slug (for example,  "scratch-editor")
- * @param {string} resource - resource slug (for example,  "blocks")
- * @param {object} sourceStrings - json of source strings
- */
-const txPush = async function (project, resource, sourceStrings) {
-  const resourceObj = {
-    data: {
-      id: `o:${ORG_NAME}:p:${project}:r:${resource}`,
-      type: 'resources',
-    },
-  }
-
-  await transifexApi.ResourceStringsAsyncUpload.upload({
-    resource: resourceObj,
-    content: JSON.stringify(sourceStrings),
-  })
-}
-
-/**
- * Creates a new resource, and then uploads source strings to it if they are provided
- * @param {string} project - project slug (for example,  "scratch-editor")
- * @param {object} resource - object of resource information
- * @param {string} resource.slug - resource slug (for example,  "blocks")
- * @param {string} resource.name - human-readable name for the resource
- * @param {string} resource.i18nType - i18n format id
- * @param {object} resource.sourceStrings - json object of source strings
- */
-const txCreateResource = async function (project, { slug, name, i18nType, sourceStrings }) {
-  const i18nFormat = {
-    data: {
-      id: i18nType || 'KEYVALUEJSON',
-      type: 'i18n_formats',
-    },
-  }
-
-  const projectObj = {
-    data: {
-      id: `o:${ORG_NAME}:p:${project}`,
-      type: 'projects',
-    },
-  }
-
-  await transifexApi.Resource.create({
-    attributes: { slug: slug, name: name },
-    relationships: {
-      i18n_format: i18nFormat,
-      project: projectObj,
-    },
-  })
-
-  if (sourceStrings) {
-    await txPush(project, slug, sourceStrings)
-  }
-}
-
-module.exports = { txPull, txPush, txResources, txResourcesObjects, txCreateResource, txAvailableLanguages }

package/lib/validate.mjs

@@ -1,48 +0,0 @@
-import assert from 'assert'
-import parse from 'format-message-parse'
-
-// filter placeholders out of a message
-// parse('a message with a {value} and {count, plural, one {one} other {more}}.')
-// returns an array:
-// [ 'a message with a ',
-//   [ 'value' ],
-//   ' and ',
-//   [ 'count', 'plural', 0, { one: [Array], other: [Array] } ],
-//   '.'
-// ]
-// placeholders are always an array, so filter for array elements to find the placeholders
-const placeholders = message =>
-  // this will throw an error if the message is not valid ICU
-  // single quote (as in French l'année) messes up the parse and is not
-  // relevant for this check, so strip them out
-  parse(message.replace(/'/g, '')).filter(item => Array.isArray(item))
-
-const validMessage = (message, source) => {
-  const transPlaceholders = placeholders(message.toString())
-  const srcPlaceholders = placeholders(source.toString())
-  // different number of placeholders
-  if (transPlaceholders.length !== srcPlaceholders.length) {
-    return false
-  }
-  // TODO: Add checking to make sure placeholders in source have not been translated
-  // TODO: Add validation of scratch-blocks placeholders
-  return true
-}
-
-const validateTranslations = (translation, source) => {
-  const locale = translation.locale
-  const translations = translation.translations
-  const transKeys = Object.keys(translations)
-  const sourceKeys = Object.keys(source)
-  assert.strictEqual(transKeys.length, sourceKeys.length, `locale ${locale} has a different number of message keys`)
-  transKeys.map(item => assert(sourceKeys.includes(item), `locale ${locale} has key ${item} not in the source`))
-  sourceKeys.map(item => assert(transKeys.includes(item), `locale ${locale} is missing key ${item}`))
-  sourceKeys.map(item =>
-    assert(
-      validMessage(translations[item], source[item]),
-      `locale ${locale}: "${translations[item]}" is not a valid translation for "${source[item]}"`,
-    ),
-  )
-}
-
-export { validateTranslations, validMessage }

package/scripts/freshdesk-api.js

@@ -1,149 +0,0 @@
-// interface to FreshDesk Solutions (knowledge base) api
-
-const fetch = require('node-fetch')
-class FreshdeskApi {
-  constructor(baseUrl, apiKey) {
-    this.baseUrl = baseUrl
-    this._auth = 'Basic ' + new Buffer(`${apiKey}:X`).toString('base64')
-    this.defaultHeaders = {
-      'Content-Type': 'application/json',
-      Authorization: this._auth,
-    }
-    this.rateLimited = false
-  }
-
-  /**
-   * Checks the status of a response. If status is not ok, or the body is not json raise exception
-   * @param {object} res The response object
-   * @returns {object} the response if it is ok
-   */
-  checkStatus(res) {
-    if (res.ok) {
-      if (res.headers.get('content-type').indexOf('application/json') !== -1) {
-        return res
-      }
-      throw new Error(`response not json: ${res.headers.get('content-type')}`)
-    }
-    const err = new Error(`response ${res.statusText}`)
-    err.code = res.status
-    if (res.status === 429) {
-      err.retryAfter = res.headers.get('Retry-After')
-    }
-    throw err
-  }
-
-  listCategories() {
-    return fetch(`${this.baseUrl}/api/v2/solutions/categories`, { headers: this.defaultHeaders })
-      .then(this.checkStatus)
-      .then(res => res.json())
-  }
-
-  listFolders(category) {
-    return fetch(`${this.baseUrl}/api/v2/solutions/categories/${category.id}/folders`, {
-      headers: this.defaultHeaders,
-    })
-      .then(this.checkStatus)
-      .then(res => res.json())
-  }
-
-  listArticles(folder) {
-    return fetch(`${this.baseUrl}/api/v2/solutions/folders/${folder.id}/articles`, { headers: this.defaultHeaders })
-      .then(this.checkStatus)
-      .then(res => res.json())
-  }
-
-  updateCategoryTranslation(id, locale, body) {
-    if (this.rateLimited) {
-      process.stdout.write(`Rate limited, skipping id: ${id} for ${locale}\n`)
-      return -1
-    }
-    return fetch(`${this.baseUrl}/api/v2/solutions/categories/${id}/${locale}`, {
-      method: 'put',
-      body: JSON.stringify(body),
-      headers: this.defaultHeaders,
-    })
-      .then(this.checkStatus)
-      .then(res => res.json())
-      .catch(err => {
-        if (err.code === 404) {
-          // not found, try create instead
-          return fetch(`${this.baseUrl}/api/v2/solutions/categories/${id}/${locale}`, {
-            method: 'post',
-            body: JSON.stringify(body),
-            headers: this.defaultHeaders,
-          })
-            .then(this.checkStatus)
-            .then(res => res.json())
-        }
-        if (err.code === 429) {
-          this.rateLimited = true
-        }
-        process.stdout.write(`Error processing id ${id} for locale ${locale}: ${err.message}\n`)
-        throw err
-      })
-  }
-
-  updateFolderTranslation(id, locale, body) {
-    if (this.rateLimited) {
-      process.stdout.write(`Rate limited, skipping id: ${id} for ${locale}\n`)
-      return -1
-    }
-    return fetch(`${this.baseUrl}/api/v2/solutions/folders/${id}/${locale}`, {
-      method: 'put',
-      body: JSON.stringify(body),
-      headers: this.defaultHeaders,
-    })
-      .then(this.checkStatus)
-      .then(res => res.json())
-      .catch(err => {
-        if (err.code === 404) {
-          // not found, try create instead
-          return fetch(`${this.baseUrl}/api/v2/solutions/folders/${id}/${locale}`, {
-            method: 'post',
-            body: JSON.stringify(body),
-            headers: this.defaultHeaders,
-          })
-            .then(this.checkStatus)
-            .then(res => res.json())
-        }
-        if (err.code === 429) {
-          this.rateLimited = true
-        }
-        process.stdout.write(`Error processing id ${id} for locale ${locale}: ${err.message}\n`)
-        throw err
-      })
-  }
-
-  updateArticleTranslation(id, locale, body) {
-    if (this.rateLimited) {
-      process.stdout.write(`Rate limited, skipping id: ${id} for ${locale}\n`)
-      return -1
-    }
-    return fetch(`${this.baseUrl}/api/v2/solutions/articles/${id}/${locale}`, {
-      method: 'put',
-      body: JSON.stringify(body),
-      headers: this.defaultHeaders,
-    })
-      .then(this.checkStatus)
-      .then(res => res.json())
-      .catch(err => {
-        if (err.code === 404) {
-          // not found, try create instead
-          return fetch(`${this.baseUrl}/api/v2/solutions/articles/${id}/${locale}`, {
-            method: 'post',
-            body: JSON.stringify(body),
-            headers: this.defaultHeaders,
-          })
-            .then(this.checkStatus)
-            .then(res => res.json())
-        }
-        if (err.code === 429) {
-          this.rateLimited = true
-        }
-        process.stdout.write(`Error processing id ${id} for locale ${locale}: ${err.message}\n`)
-        throw err
-      })
-  }
-}
-
-module.exports = FreshdeskApi