@makefully/dutifully 1.18.0 → 1.20.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 1.20.0
+
+- Add `translate` client for Amazon Translate (Cheerfully script JSON or language-matrix CSV/TSV).
+- Support `ignore` for phrases left untranslated.
+
+## 1.19.0
+
+- Authenticate Showfully yap chores with `Authorization: Bearer` and `POST /yap/:service` (token no longer in the URL path).
+
 ## 1.18.0
 
 - Store GIF content hashes in a Comment Extension (`CheerfullyHashes:{...}`), lossless.

package/README.md

@@ -11,10 +11,12 @@ To use the API, you will need to specify a root `./env-cheerfully.json` file wit
 ```javascript
 {
     "server": "http://server:port",
-    "accessToken": "accessTokenToUseCheerfullyService"
+    "accessToken": "BearerTokenForShowfullyYap"
 }
 ```
 
+`accessToken` is sent as `Authorization: Bearer …` on yap submit/status/download (Showfully 1.4+). For local Showfully, use the same value as `SHOWFULLY_DEBUG_TOKEN` with `SHOWFULLY_ALLOW_DEBUG_TOKEN=1`.
+
 ## Services
 
 All services can be specified in `cheerfully.json` as described in the following sections. Services can be run as scripts specified in `package.json` as:
@@ -353,9 +355,40 @@ Script lines may also include an optional `events` array for one-shot timed mark
 
 Cheerfully resolves these against caption timings and exports them in parallel using the same caption `format` (`events.json`, `{id}.events.vtt` / `.srt` / `.sami` / `.smi` / `.lrc`, or a separate MP3 SYLT frame with content type `EVENTS` labeled `"events"`).
 
+### Translate
+
+This text-to-text service translates Cheerfully scripts or language-matrix CSV/TSV via Amazon Translate. Set jobs in `cheerfully.json`:
+
+```javascript
+{
+    "translate": [{
+        "script": "./example/script.json",
+        "language": "en-US",
+        "languages": ["es-ES", "fr-FR"],
+        "output": "./example/scripts/",
+        "ignore": ["Makefully Studios"]
+    }, {
+        "script": "./example/strings.csv",
+        "language": "en-US",
+        "languages": ["es-ES", "fr-FR"],
+        "output": "./example/scripts/"
+    }]
+}
+```
+
+* `script` — path to a Cheerfully `.json` script or a language-matrix `.csv` / `.tsv` (first column = ids, first row = language tags).
+* `language` — source locale (CSV: source column). Matrix jobs require this; JSON may use `auto`.
+* `languages` — target locales to produce or fill.
+* `format` / `exports` — optional. Defaults to the source extension (`json`, `csv`, or `tsv`).
+* `ignore` — phrases left untranslated.
+
+JSON sources write `{lang}/{basename}.{ext}` under `output`. CSV/TSV sources write an updated matrix file and leave existing non-empty cells unchanged.
+
+Supported formats: `json`, `i18n`, `csv`, `tsv`, `po`, `xliff`, `properties`, `yml` / `yaml`, `strings`, `xml`.
+
 ## Example
 
-Find an example script in the `./examples/` folder. You can run either `npm run test-elevenlabs` or `npm run test-polly` to create VO tracks in the examples folder that you can then use to try out `npm run test-rhubarb` and `npm run test-transcription`. Sample sprites for atlas packing are under `./example/sprites/`; run `npm run test-packfully` to pack them into `./example/atlases/`.
+Find an example script in the `./examples/` folder. You can run either `npm run test-elevenlabs` or `npm run test-polly` to create VO tracks in the examples folder that you can then use to try out `npm run test-rhubarb` and `npm run test-transcription`. Sample sprites for atlas packing are under `./example/sprites/`; run `npm run test-packfully` to pack them into `./example/atlases/`. Run `npm run test-translate` to translate `./example/script.json` and `./example/strings.csv` into `./example/scripts/`.
 
 These examples are specified using a JSON definition in `./cheerfully.json` which you can copy or modify to set different generation parameters as supported by Cheerfully.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/dutifully",
-    "version": "1.18.0",
+    "version": "1.20.0",
     "description": "Client tools for Cheerfully service.",
     "main": "./src/index.js",
     "bin": {
@@ -28,6 +28,7 @@
         "test-sharp": "node ./cheer.js -service sharp",
         "test-stackfully": "node ./cheer.js -service stackfully",
         "test-transcription": "node ./cheer.js -service transcription",
+        "test-translate": "node ./cheer.js -service translate",
         "say": "node ./say.js"
     },
     "repository": {
@@ -50,7 +51,8 @@
         "packfully",
         "atlas",
         "spritesheet",
-        "classfully"
+        "classfully",
+        "translate"
     ],
     "author": "Derek Detweiler <derek@makefullystudios.com>",
     "contributors": [

package/src/classes/Cheer.js

@@ -15,13 +15,17 @@ const
         }
         return buf.subarray(0, max).toString('utf8').replace(/\s+/g, ' ').trim();
     },
-    postStream = (url, stream) => new Promise ((resolve, reject) => {
+    authHeaders = (accessToken) => (accessToken
+        ? {Authorization: `Bearer ${accessToken}`}
+        : {}),
+    postStream = (url, stream, headers = {}) => new Promise ((resolve, reject) => {
         const
             protocol = url.startsWith('https') ? https : http;
             req = protocol.request(url, {
                 method: 'post',
                 headers: {
-                    'Content-Type': 'application/zip'
+                    'Content-Type': 'application/zip',
+                    ...headers
                 }
             }, async (res) => {
                 let data = '';
@@ -61,7 +65,7 @@ const
                                 let response = null;
 
                                 try {
-                                    response = await fetchStream(`${url}/${choreId}`);
+                                    response = await fetchStream(`${url}/${choreId}`, headers);
                                 } catch (e) {
                                     console.warn(e);
 
@@ -101,11 +105,11 @@ const
 
         stream.pipe(req);
     }),
-    fetchStream = (url) => new Promise((resolve, reject) => {
+    fetchStream = (url, headers = {}) => new Promise((resolve, reject) => {
         const
             protocol = url.startsWith('https') ? https : http;
 
-        protocol.get(url, (res) => {
+        protocol.get(url, {headers}, (res) => {
             const
                 contentType = res.headers['content-type'] || '',
                 statusCode = res.statusCode || 0;
@@ -285,7 +289,11 @@ const
                 try {
                     const
                         archiveStream = await archive((archive) => this.beforeSend(archive)),
-                        data = await postStream(`${cleanPath(server)}/yap/${service}/${accessToken}`, archiveStream);
+                        data = await postStream(
+                            `${cleanPath(server)}/yap/${service}`,
+                            archiveStream,
+                            authHeaders(accessToken)
+                        );
 
                     // listen for all archive data to be written
                     archiveStream.on('close', function () {

package/src/classes/Translate.js

@@ -0,0 +1,47 @@
+const
+    path = require('path'),
+    Cheer = require('./Cheer'),
+    MATRIX_EXTS = new Set(['csv', 'tsv']),
+    Translate = class Translate extends Cheer {
+        async prepare (data) {
+            const
+                {config} = this,
+                scriptPath = config.script;
+
+            this.matrixMode = false;
+            this.scriptPath = null;
+
+            if (scriptPath) {
+                const
+                    ext = path.extname(scriptPath).slice(1).toLowerCase(),
+                    basename = path.basename(scriptPath, path.extname(scriptPath));
+
+                this.scriptPath = scriptPath;
+                config.basename = config.basename ?? basename;
+
+                if (!config.format && !config.exports) {
+                    config.format = MATRIX_EXTS.has(ext) ? ext : 'json';
+                }
+
+                if (MATRIX_EXTS.has(ext)) {
+                    this.matrixMode = true;
+                    config.matrixFile = path.basename(scriptPath);
+                    delete config.script;
+                } else {
+                    await this.replaceConfigPathWithJSON('script', 'files');
+                }
+            }
+
+            return super.prepare(data);
+        }
+
+        beforeSend (archive) {
+            if (this.matrixMode && this.scriptPath) {
+                archive.file(this.scriptPath, {name: this.config.matrixFile});
+            }
+
+            return super.beforeSend(archive);
+        }
+    };
+
+module.exports = Translate;

package/src/index.js

@@ -13,7 +13,8 @@ const
         rhubarb: LipSync,
         sharp: require('./classes/Sharp'),
         stackfully: require('./classes/Stackfully'),
-        transcription: require('./classes/Transcription')
+        transcription: require('./classes/Transcription'),
+        translate: require('./classes/Translate')
     },
     getJSON = require('./helpers/getJSON'),
     send = async function (contents) {