@makefully/dutifully 1.23.0 → 1.23.1

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 1.23.1
+
+### Added
+
+- Shared `auth` on jobs and `env-cheerfully.json` `auth.<service>` map (job wins; env fills defaults). Legacy `elevenLabsApiKey` and top-level ElevenLabs `apiKey` still map into `auth.apiKey`.
+
 ## 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.

package/README.md

@@ -6,17 +6,28 @@ Client API for Cheerfully services. Cheerfully makes voice-over easy.
 npm install @makefully/dutifully
 ```
 
-To use the API, you will need to specify a root `./env-cheerfully.json` file with the following format:
+To use the API, you will need a root `./env-cheerfully.json` with Showfully Yap credentials and optional per-service auth defaults:
 
 ```javascript
 {
     "server": "http://server:port",
-    "accessToken": "BearerTokenForShowfullyYap"
+    "accessToken": "BearerTokenForShowfullyYap",
+    "auth": {
+        "elevenlabs": { "apiKey": "…" },
+        "deepl": { "apiKey": "…", "serverUrl": "https://api-free.deepl.com" },
+        "googletranslate": { "apiKey": "…" },
+        "microsofttranslate": { "key": "…", "region": "eastus" },
+        "amazontranslate": { "config": { } },
+        "polly": { "config": { }, "bucket": "…", "root": "…" },
+        "transcription": { "config": { }, "bucket": "…", "root": "…" }
+    }
 }
 ```
 
 `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`.
 
+Job listings may include their own `auth` object (same shapes). Dutifully merges `auth.<service>` from env into each job; **job `auth` wins**. Legacy `elevenLabsApiKey` still maps to `auth.elevenlabs.apiKey`.
+
 ## 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:
@@ -100,7 +111,7 @@ await cheerfully.say('The build is complete');
 ```
 
 
-Voice settings come from the first `elevenlabs` entry in `cheerfully.json` (same as other ElevenLabs chores). Server credentials and `elevenLabsApiKey` come from `env-cheerfully.json`. Cached files are keyed by voice + text, so repeats play immediately without regenerating.
+Voice settings come from the first `elevenlabs` entry in `cheerfully.json` (same as other ElevenLabs chores). Server credentials and optional `auth.elevenlabs` (or legacy `elevenLabsApiKey`) come from `env-cheerfully.json`. Cached files are keyed by voice + text, so repeats play immediately without regenerating.
 
 ### ElevenLabs
 
@@ -124,14 +135,20 @@ Specifying the `model` is optional: if unspecified, Cheerfully tries to look up
 
 Specifying `updateAllMetaData` is `false` by default. If it's set to `true`, album, title, and unsynchronized lyrics are appended to any MP3's in the source directory that were not generated.
 
-You may include your ElevenLabs API Key directly in the ElevenLabs spec above as `apiKey`, or set your API Key separately in `env-cheerfully.json`:
+You may include credentials on the job as `auth.apiKey`, or set defaults in `env-cheerfully.json`:
 
 ```javascript
 {
-    "elevenLabsApiKey": "elevenlabsapikeyforyouraccount"
+    "auth": {
+        "elevenlabs": {
+            "apiKey": "elevenlabsapikeyforyouraccount"
+        }
+    }
 }
 ```
 
+Legacy `elevenLabsApiKey` at the top level of `env-cheerfully.json` is still accepted.
+
 ### FFMPEG
 
 This audio file process accepts ffmpeg commandline arguments to perform operations on an audio file.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@makefully/dutifully",
-    "version": "1.23.0",
+    "version": "1.23.1",
     "description": "Client tools for Cheerfully service.",
     "main": "./src/index.js",
     "bin": {

package/src/classes/Cheer.js

@@ -6,6 +6,7 @@ const
     https = require('https'),
     {PassThrough} = require('stream'),
     unzipper = require('unzip-stream'),
+    {applyServiceAuth} = require('../helpers/applyServiceAuth'),
     cleanPath = (path) => path[path.length - 1] === '/' ? path.substring(0, path.length - 1) : path,
     isZipMagic = (buf) => buf && buf.length >= 4 && buf[0] === 0x50 && buf[1] === 0x4b &&
         ((buf[2] === 0x03 && buf[3] === 0x04) || (buf[2] === 0x05 && buf[3] === 0x06) || (buf[2] === 0x07 && buf[3] === 0x08)),
@@ -264,9 +265,9 @@ const
     },
     Cheer = class {
         constructor ({config, contents}) {
-            this.config = config;
             this.contents = contents;
             this.service = contents.service;
+            this.config = applyServiceAuth(config, contents, contents.service);
         }
 
         prepare ({difference = true, extract = true}) {

package/src/classes/ElevenLabs.js

@@ -4,14 +4,11 @@ const
 module.exports = class ElevenLabs extends TextToSpeech {
     constructor (data) {
         const
-            {id, elevenLabsApiKey} = data.contents;
+            {id} = data.contents;
 
         data.album = id;
         data.encodedBy = 'ElevenLabs';
-        if (elevenLabsApiKey) {
-            data.config.apiKey = elevenLabsApiKey;
-        }
-
+        // Auth (env auth.elevenlabs / elevenLabsApiKey / job.auth) is applied in Cheer.
         super(data);
     }
-};
+};

package/src/helpers/applyServiceAuth.js

@@ -0,0 +1,89 @@
+/**
+ * Merge Dutifully env-cheerfully.json `auth.<service>` into a job's `auth`.
+ * Job-level auth wins; env fills defaults. Legacy `elevenLabsApiKey` maps to elevenlabs.
+ */
+
+const isPlainObject = (value) => (
+    value != null && typeof value === 'object' && !Array.isArray(value)
+);
+
+/**
+ * Normalize legacy env aliases into `contents.auth`.
+ * @param {Record<string, unknown>} contents
+ * @returns {Record<string, unknown>}
+ */
+const normalizeContentsAuth = (contents = {}) => {
+    const
+        auth = isPlainObject(contents.auth) ? {...contents.auth} : {};
+
+    if (contents.elevenLabsApiKey) {
+        auth.elevenlabs = {
+            ...(isPlainObject(auth.elevenlabs) ? auth.elevenlabs : {}),
+            apiKey: contents.elevenLabsApiKey
+        };
+    }
+
+    return auth;
+};
+
+/**
+ * Apply service auth defaults onto a job config (mutates config).
+ * @param {Record<string, unknown>} config job listing from cheerfully.json
+ * @param {Record<string, unknown>} contents merged cheer + env + CLI
+ * @param {string} [service] Cheerfully service id (defaults to contents.service)
+ * @returns {Record<string, unknown>} config
+ */
+const applyServiceAuth = (config, contents = {}, service = contents.service) => {
+    if (!config || typeof config !== 'object') {
+        return config;
+    }
+
+    const
+        authMap = normalizeContentsAuth(contents),
+        fromEnv = service && isPlainObject(authMap[service]) ? {...authMap[service]} : {},
+        fromJob = isPlainObject(config.auth) ? {...config.auth} : {},
+        // Legacy ElevenLabs top-level apiKey on the job
+        legacyJobKey = service === 'elevenlabs'
+            && typeof config.apiKey === 'string'
+            && config.apiKey
+            && fromJob.apiKey == null
+            ? {apiKey: config.apiKey}
+            : {};
+
+    const
+        merged = {
+            ...fromEnv,
+            ...legacyJobKey,
+            ...fromJob
+        };
+
+    if (isPlainObject(fromEnv.config) || isPlainObject(fromJob.config) || isPlainObject(legacyJobKey.config)) {
+        merged.config = {
+            ...(isPlainObject(fromEnv.config) ? fromEnv.config : {}),
+            ...(isPlainObject(fromJob.config) ? fromJob.config : {})
+        };
+
+        if (isPlainObject(fromEnv.config?.credentials) || isPlainObject(fromJob.config?.credentials)) {
+            merged.config.credentials = {
+                ...(isPlainObject(fromEnv.config?.credentials) ? fromEnv.config.credentials : {}),
+                ...(isPlainObject(fromJob.config?.credentials) ? fromJob.config.credentials : {})
+            };
+        }
+    }
+
+    if (Object.keys(merged).length) {
+        config.auth = merged;
+    }
+
+    // Prefer auth container; drop legacy top-level apiKey once folded in.
+    if (service === 'elevenlabs' && config.apiKey != null && config.auth?.apiKey) {
+        delete config.apiKey;
+    }
+
+    return config;
+};
+
+module.exports = {
+    normalizeContentsAuth,
+    applyServiceAuth
+};