@makefully/dutifully 1.22.0 → 1.23.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 1.23.0
+
+- Provider umbrellas: `translate` (`amazon` default → `amazontranslate`, or `deepl` / `google` / `microsoft`), `lipsync` (`rhubarb` default / `allosaurus`), and `voiceover` (`elevenlabs` default / `polly`) resolve to Cheerfully concrete services before Yap submit.
+- Concrete MT parsers: `amazontranslate`, `deepl`, `googletranslate`, `microsofttranslate`.
+
+## 1.22.1
+
+- Allow translate `format: "catalog"` (Cheerfully flat `{lang}.json` app catalogs) alongside existing loc formats.
+
 ## 1.22.0
 
 - Select a subset of service listings via optional job `id` and top-level `only` (`cheer -service packfully -only heroes,ui`).

package/README.md

@@ -432,13 +432,22 @@ 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
+### Provider umbrellas (`translate`, `lipsync`, `voiceover`)
 
-This text-to-text service translates Cheerfully scripts or language-matrix CSV/TSV via Amazon Translate. Set jobs in `cheerfully.json`:
+Dutifully logical services pick a Cheerfully processor via per-job `provider` (stripped before upload):
+
+| Dutifully `-service` | `provider` | Default | Cheerfully target |
+| --- | --- | --- | --- |
+| `translate` | `amazon`, `deepl`, `google`, `microsoft` | `amazon` | `amazontranslate`, `deepl`, `googletranslate`, `microsofttranslate` |
+| `lipsync` | `rhubarb`, `allosaurus` | `rhubarb` | same as provider |
+| `voiceover` | `polly`, `elevenlabs` | `elevenlabs` | same as provider |
+
+Concrete keys (`deepl`, `polly`, `rhubarb`, …) still work without `provider`.
 
 ```javascript
 {
     "translate": [{
+        "provider": "amazon",
         "script": "./example/script.json",
         "language": "en-US",
         "languages": ["es-ES", "fr-FR"],
@@ -449,19 +458,35 @@ This text-to-text service translates Cheerfully scripts or language-matrix CSV/T
         "language": "en-US",
         "languages": ["es-ES", "fr-FR"],
         "output": "./example/scripts/"
+    }],
+    "voiceover": [{
+        "provider": "elevenlabs",
+        "script": "./example/script.json",
+        "output": "./example/vo/en/",
+        "voice": "21m00Tcm4TlvDq8ikWAM"
+    }],
+    "lipsync": [{
+        "provider": "rhubarb",
+        "src": "./example/vo/en/",
+        "output": "./example/lipsync/en/"
     }]
 }
 ```
 
+Translate job fields:
+
 * `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.
+* `provider` — MT engine (see table); default `amazon`.
+
+JSON sources write `{lang}/{basename}.{ext}` under `output` (`catalog` → `{lang}.json`). CSV/TSV sources write an updated matrix file and leave existing non-empty cells unchanged.
 
-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`, `catalog`, `csv`, `tsv`, `po`, `xliff`, `properties`, `yml` / `yaml`, `strings`, `xml`.
 
-Supported formats: `json`, `i18n`, `csv`, `tsv`, `po`, `xliff`, `properties`, `yml` / `yaml`, `strings`, `xml`.
+`catalog` writes flat key → caption JSON as `{lang}.json` (app localization layout). `i18n` uses the same payload under `{lang}/{basename}.i18n.json`.
 
 ## Example
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/dutifully",
-    "version": "1.22.0",
+    "version": "1.23.0",
     "description": "Client tools for Cheerfully service.",
     "main": "./src/index.js",
     "bin": {
@@ -52,7 +52,10 @@
         "atlas",
         "spritesheet",
         "classfully",
-        "translate"
+        "translate",
+        "deepl",
+        "voiceover",
+        "lipsync"
     ],
     "author": "Derek Detweiler <derek@makefullystudios.com>",
     "contributors": [

package/src/helpers/jobExports.js

@@ -6,7 +6,7 @@
 const LYRIC_FORMATS = ['json', 'lrc', 'mp3', 'sami', 'smi', 'srt', 'vtt', 'tsv', 'xml', 'dat'];
 const TRANSCRIPTION_FORMATS = ['json', 'lrc', 'mp3', 'sami', 'smi', 'srt', 'vtt'];
 const PACKFULLY_FORMATS = ['texturepacker', 'json-array', 'createjs', 'spine', 'css', 'starling', 'unity', 'godot'];
-const TRANSLATE_FORMATS = ['json', 'i18n', 'po', 'xliff', 'properties', 'yml', 'yaml', 'strings', 'xml', 'csv', 'tsv'];
+const TRANSLATE_FORMATS = ['json', 'i18n', 'catalog', 'po', 'xliff', 'properties', 'yml', 'yaml', 'strings', 'xml', 'csv', 'tsv'];
 
 const EXPORT_CATALOG = {
     transcription: {
@@ -28,6 +28,22 @@ const EXPORT_CATALOG = {
         keys: ['format', 'exports'],
         formats: TRANSLATE_FORMATS
     },
+    amazontranslate: {
+        keys: ['format', 'exports'],
+        formats: TRANSLATE_FORMATS
+    },
+    deepl: {
+        keys: ['format', 'exports'],
+        formats: TRANSLATE_FORMATS
+    },
+    googletranslate: {
+        keys: ['format', 'exports'],
+        formats: TRANSLATE_FORMATS
+    },
+    microsofttranslate: {
+        keys: ['format', 'exports'],
+        formats: TRANSLATE_FORMATS
+    },
     packfully: {
         keys: ['format', 'exports', 'exportFormat'],
         formats: PACKFULLY_FORMATS

package/src/helpers/resolveProviderService.js

@@ -0,0 +1,86 @@
+/**
+ * Map Dutifully umbrella services + provider → Cheerfully concrete service ids.
+ */
+
+const
+    UMBRELLAS = {
+        translate: {
+            defaultProvider: 'amazon',
+            providers: {
+                amazon: 'amazontranslate',
+                amazontranslate: 'amazontranslate',
+                deepl: 'deepl',
+                google: 'googletranslate',
+                googletranslate: 'googletranslate',
+                microsoft: 'microsofttranslate',
+                microsofttranslate: 'microsofttranslate'
+            }
+        },
+        lipsync: {
+            defaultProvider: 'rhubarb',
+            providers: {
+                rhubarb: 'rhubarb',
+                allosaurus: 'allosaurus'
+            }
+        },
+        voiceover: {
+            defaultProvider: 'elevenlabs',
+            providers: {
+                polly: 'polly',
+                elevenlabs: 'elevenlabs'
+            }
+        }
+    },
+    isUmbrella = (service) => Boolean(UMBRELLAS[service]),
+    /**
+     * @returns {{ cheerfullyService: string, provider: string, job: object }}
+     */
+    resolveProviderService = (umbrella, job = {}) => {
+        const
+            table = UMBRELLAS[umbrella];
+
+        if (!table) {
+            const
+                cleaned = {...job};
+
+            delete cleaned.provider;
+
+            return {
+                cheerfullyService: umbrella,
+                provider: null,
+                job: cleaned
+            };
+        }
+
+        const
+            raw = job.provider == null || job.provider === ''
+                ? table.defaultProvider
+                : String(job.provider).toLowerCase().trim(),
+            cheerfullyService = table.providers[raw];
+
+        if (!cheerfullyService) {
+            const
+                allowed = [...new Set(Object.keys(table.providers))].sort().join(', ');
+
+            throw new Error(
+                `Unknown provider "${job.provider}" for "${umbrella}". Use one of: ${allowed}.`
+            );
+        }
+
+        const
+            cleaned = {...job};
+
+        delete cleaned.provider;
+
+        return {
+            cheerfullyService,
+            provider: raw,
+            job: cleaned
+        };
+    };
+
+module.exports = {
+    UMBRELLAS,
+    isUmbrella,
+    resolveProviderService
+};

package/src/index.js

@@ -2,11 +2,16 @@
 /* global console, process, require */
 const
     LipSync = require('./classes/LipSync'),
+    Translate = require('./classes/Translate'),
     parsers = {
         allosaurus: LipSync,
+        amazontranslate: Translate,
         classfully: require('./classes/Classfully'),
+        deepl: Translate,
         elevenlabs: require('./classes/ElevenLabs'),
         ffmpeg: require('./classes/FFMPEG'),
+        googletranslate: Translate,
+        microsofttranslate: Translate,
         packfully: require('./classes/Packfully'),
         polly: require('./classes/Polly'),
         rasterize: require('./classes/Rasterize'),
@@ -14,10 +19,12 @@ const
         sharp: require('./classes/Sharp'),
         stackfully: require('./classes/Stackfully'),
         transcription: require('./classes/Transcription'),
-        translate: require('./classes/Translate')
+        // Concrete only — umbrellas (translate / lipsync / voiceover) resolve first.
+        translate: Translate
     },
     getJSON = require('./helpers/getJSON'),
     {normalizeOnly, filterJobsById} = require('./helpers/filterJobs'),
+    {isUmbrella, resolveProviderService} = require('./helpers/resolveProviderService'),
     send = async function (contents) {
         const
             {id, service} = contents,
@@ -36,11 +43,40 @@ const
                 continue;
             }
 
+            let
+                cheerfullyService = service,
+                jobConfig = config;
+
+            if (isUmbrella(service)) {
+                try {
+                    const
+                        resolved = resolveProviderService(service, config);
+
+                    cheerfullyService = resolved.cheerfullyService;
+                    jobConfig = resolved.job;
+                } catch (e) {
+                    console.warn(e.message);
+                    continue;
+                }
+            }
+
+            const
+                Parser = parsers[cheerfullyService];
+
+            if (!Parser) {
+                console.warn(`No Dutifully parser for Cheerfully service "${cheerfullyService}".`);
+                continue;
+            }
+
             const
-                serviceHandler = new parsers[service]({config, contents});
+                contentsForJob = {
+                    ...contents,
+                    service: cheerfullyService
+                },
+                serviceHandler = new Parser({config: jobConfig, contents: contentsForJob});
 
             try {
-                await serviceHandler.prepare({...contents, ...config});
+                await serviceHandler.prepare({...contentsForJob, ...jobConfig});
             } catch (e) {
                 console.warn(e.message);
                 continue;
@@ -48,10 +84,10 @@ const
 
             try {
                 await serviceHandler.send({
-                    instanceId: `${id}-${service}${length > 1 ? `-${index}` : ''}`
+                    instanceId: `${id}-${cheerfullyService}${length > 1 ? `-${index}` : ''}`
                 });
             } catch (e) {
-                console.warn(`Error running "${service}" (${index}): ${e.message || e}`);
+                console.warn(`Error running "${cheerfullyService}" (${index}): ${e.message || e}`);
             }
         }
     };