@happyvertical/smrt-voice 0.57.35 → 0.57.37

package/dist/manifest.json

@@ -2,7 +2,7 @@
   "version": "1.0.0",
   "timestamp": 0,
   "packageName": "@happyvertical/smrt-voice",
-  "packageVersion": "0.57.35",
+  "packageVersion": "0.57.37",
   "objects": {
     "@happyvertical/smrt-voice:VoiceOutput": {
       "name": "voiceoutput",
@@ -40,7 +40,11 @@
         },
         "type": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "What kind of piece this is, such as an article or a document.",
+          "_meta": {
+            "description": "What kind of piece this is, such as an article or a document."
+          }
         },
         "variant": {
           "type": "text",
@@ -52,27 +56,45 @@
         },
         "author": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "Who wrote this piece.",
+          "_meta": {
+            "description": "Who wrote this piece."
+          }
         },
         "name": {
           "type": "text",
           "required": true,
           "default": "",
+          "description": "A short name used to find this piece in lists.",
           "_meta": {
-            "required": true
+            "required": true,
+            "description": "A short name used to find this piece in lists."
           }
         },
         "title": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The headline readers see.",
+          "_meta": {
+            "description": "The headline readers see."
+          }
         },
         "description": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "A one or two sentence summary of the piece.",
+          "_meta": {
+            "description": "A one or two sentence summary of the piece."
+          }
         },
         "body": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The full text of the piece.",
+          "_meta": {
+            "description": "The full text of the piece."
+          }
         },
         "bodyFormat": {
           "type": "text",
@@ -84,7 +106,11 @@
         },
         "publish_date": {
           "type": "datetime",
-          "required": false
+          "required": false,
+          "description": "The date the piece went out, or is due to go out.",
+          "_meta": {
+            "description": "The date the piece went out, or is due to go out."
+          }
         },
         "url": {
           "type": "text",
@@ -105,16 +131,28 @@
         "tags": {
           "type": "json",
           "required": false,
-          "default": []
+          "default": [],
+          "description": "Words that group pieces by subject.",
+          "_meta": {
+            "description": "Words that group pieces by subject."
+          }
         },
         "category": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The one section the piece belongs to, such as news or local.",
+          "_meta": {
+            "description": "The one section the piece belongs to, such as news or local."
+          }
         },
         "status": {
           "type": "text",
           "required": false,
           "default": "draft",
+          "description": "Where the piece stands: draft, in review, published or archived.",
+          "_meta": {
+            "description": "Where the piece stands: draft, in review, published or archived."
+          },
           "enum": [
             "published",
             "draft",
@@ -146,22 +184,38 @@
         "voiceProfileId": {
           "type": "foreignKey",
           "required": false,
-          "related": "VoiceProfile"
+          "related": "VoiceProfile",
+          "description": "The voice that read the text.",
+          "_meta": {
+            "description": "The voice that read the text."
+          }
         },
         "sourceText": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "The text that was read aloud.",
+          "_meta": {
+            "description": "The text that was read aloud."
+          }
         },
         "audioAssetId": {
           "type": "crossPackageRef",
           "required": false,
-          "related": "@happyvertical/smrt-assets:Asset"
+          "related": "@happyvertical/smrt-assets:Asset",
+          "description": "The audio file of the recording.",
+          "_meta": {
+            "description": "The audio file of the recording."
+          }
         },
         "duration": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "How long the recording runs, in seconds.",
+          "_meta": {
+            "description": "How long the recording runs, in seconds."
+          }
         },
         "wordTimings": {
           "type": "json",
@@ -1464,21 +1518,37 @@
         "name": {
           "type": "text",
           "required": false,
-          "default": ""
+          "default": "",
+          "description": "What you call this voice, such as \"Warm narrator\".",
+          "_meta": {
+            "description": "What you call this voice, such as \"Warm narrator\"."
+          }
         },
         "description": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "A note on how the voice sounds and what you use it for.",
+          "_meta": {
+            "description": "A note on how the voice sounds and what you use it for."
+          }
         },
         "language": {
           "type": "text",
           "required": false,
-          "default": "en-US"
+          "default": "en-US",
+          "description": "The language the voice speaks.",
+          "_meta": {
+            "description": "The language the voice speaks."
+          }
         },
         "gender": {
           "type": "text",
           "required": false,
           "default": "neutral",
+          "description": "Whether the voice sounds male, female or neutral.",
+          "_meta": {
+            "description": "Whether the voice sounds male, female or neutral."
+          },
           "enum": [
             "male",
             "female",
@@ -1487,12 +1557,20 @@
         },
         "designPrompt": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "Describe the voice you want in your own words, when there is no clip to copy.",
+          "_meta": {
+            "description": "Describe the voice you want in your own words, when there is no clip to copy."
+          }
         },
         "sampleAssetId": {
           "type": "crossPackageRef",
           "required": false,
-          "related": "@happyvertical/smrt-assets:Asset"
+          "related": "@happyvertical/smrt-assets:Asset",
+          "description": "The recorded clip the voice is copied from, when there is one. Leave it empty for a described voice.",
+          "_meta": {
+            "description": "The recorded clip the voice is copied from, when there is one. Leave it empty for a described voice."
+          }
         },
         "voiceData": {
           "type": "json",
@@ -1513,6 +1591,10 @@
           "type": "text",
           "required": false,
           "default": "pending",
+          "description": "Where the voice stands: waiting, being prepared, ready to use, or failed. The speech service updates it.",
+          "_meta": {
+            "description": "Where the voice stands: waiting, being prepared, ready to use, or failed. The speech service updates it."
+          },
           "enum": [
             "pending",
             "processing",
@@ -1748,26 +1830,46 @@
         "voiceProfileId": {
           "type": "foreignKey",
           "required": false,
-          "related": "VoiceProfile"
+          "related": "VoiceProfile",
+          "description": "The voice this clip belongs to.",
+          "_meta": {
+            "description": "The voice this clip belongs to."
+          }
         },
         "assetId": {
           "type": "crossPackageRef",
           "required": false,
-          "related": "@happyvertical/smrt-assets:Asset"
+          "related": "@happyvertical/smrt-assets:Asset",
+          "description": "The audio file of the recording.",
+          "_meta": {
+            "description": "The audio file of the recording."
+          }
         },
         "duration": {
           "type": "integer",
           "required": false,
-          "default": 0
+          "default": 0,
+          "description": "How long the clip runs, in seconds. At least three is needed.",
+          "_meta": {
+            "description": "How long the clip runs, in seconds. At least three is needed."
+          }
         },
         "transcription": {
           "type": "text",
-          "required": false
+          "required": false,
+          "description": "The words spoken in the clip, written out.",
+          "_meta": {
+            "description": "The words spoken in the clip, written out."
+          }
         },
         "quality": {
           "type": "text",
           "required": false,
           "default": "medium",
+          "description": "How clean the recording is: low, medium or high. A low one cannot be used to copy a voice.",
+          "_meta": {
+            "description": "How clean the recording is: low, medium or high. A low one cannot be used to copy a voice."
+          },
           "enum": [
             "low",
             "medium",
@@ -1789,7 +1891,11 @@
         "isPrimary": {
           "type": "boolean",
           "required": false,
-          "default": false
+          "default": false,
+          "description": "Tick the one clip that best represents the voice.",
+          "_meta": {
+            "description": "Tick the one clip that best represents the voice."
+          }
         }
       },
       "methods": {},
@@ -1957,6 +2063,263 @@
     }
   },
   "moduleType": "smrt",
+  "recipes": [
+    {
+      "id": "voice.profiles",
+      "className": "VoiceProfilesRecipe",
+      "label": "Voice",
+      "summary": "Set up the voices your app can speak in, from a description or a recorded clip, and keep the speech it generates.",
+      "synonyms": [
+        "voices",
+        "text to speech",
+        "read aloud",
+        "voice cloning",
+        "narration",
+        "speech"
+      ],
+      "models": [
+        "@happyvertical/smrt-voice:VoiceProfile",
+        "@happyvertical/smrt-voice:VoiceSample",
+        "@happyvertical/smrt-voice:VoiceOutput"
+      ],
+      "nav": [
+        {
+          "label": "Voices",
+          "model": "@happyvertical/smrt-voice:VoiceProfile",
+          "icon": "users",
+          "description": "The voices your app can speak in, described in words or copied from a clip.",
+          "noun": "voice"
+        },
+        {
+          "label": "Samples",
+          "model": "@happyvertical/smrt-voice:VoiceSample",
+          "icon": "folder",
+          "description": "The recorded clips a voice is copied from.",
+          "noun": "sample"
+        },
+        {
+          "label": "Generated speech",
+          "model": "@happyvertical/smrt-voice:VoiceOutput",
+          "icon": "fileText",
+          "description": "Every recording the app has read aloud, with its text.",
+          "noun": "recording"
+        }
+      ],
+      "requires": [],
+      "section": {
+        "id": "publish",
+        "label": "Publish",
+        "icon": "fileText",
+        "description": "What you write, record and put out."
+      },
+      "options": {
+        "@happyvertical/smrt-voice:VoiceProfile": {
+          "fields": {
+            "name": {
+              "order": 1
+            },
+            "description": {
+              "order": 2
+            },
+            "language": {
+              "order": 3
+            },
+            "gender": {
+              "order": 4
+            },
+            "designPrompt": {
+              "label": "Describe the voice",
+              "order": 5
+            },
+            "sampleAssetId": {
+              "label": "Sample clip",
+              "order": 6
+            },
+            "status": {
+              "order": 7
+            },
+            "defaultSpeed": {
+              "label": "Speed",
+              "visibility": "advanced"
+            },
+            "defaultPitch": {
+              "label": "Pitch",
+              "visibility": "advanced"
+            },
+            "provider": {
+              "label": "Speech service",
+              "visibility": "advanced"
+            },
+            "errorMessage": {
+              "label": "What went wrong",
+              "visibility": "advanced"
+            },
+            "voiceData": {
+              "visibility": "hidden"
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-voice:VoiceSample": {
+          "fields": {
+            "voiceProfileId": {
+              "label": "Voice",
+              "order": 1
+            },
+            "assetId": {
+              "label": "Audio file",
+              "order": 2
+            },
+            "duration": {
+              "label": "Length in seconds",
+              "order": 3
+            },
+            "transcription": {
+              "label": "What is said",
+              "order": 4
+            },
+            "quality": {
+              "order": 5
+            },
+            "isPrimary": {
+              "label": "Main clip",
+              "order": 6
+            },
+            "sampleRate": {
+              "visibility": "advanced"
+            },
+            "channels": {
+              "visibility": "advanced"
+            },
+            "format": {
+              "visibility": "advanced"
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            }
+          }
+        },
+        "@happyvertical/smrt-voice:VoiceOutput": {
+          "fields": {
+            "name": {
+              "label": "Title",
+              "order": 1
+            },
+            "sourceText": {
+              "label": "Text",
+              "order": 2
+            },
+            "voiceProfileId": {
+              "label": "Voice",
+              "order": 3
+            },
+            "audioAssetId": {
+              "label": "Audio file",
+              "order": 4
+            },
+            "duration": {
+              "label": "Length in seconds",
+              "order": 5
+            },
+            "description": {
+              "visibility": "advanced"
+            },
+            "author": {
+              "visibility": "advanced"
+            },
+            "publish_date": {
+              "label": "Date",
+              "visibility": "advanced"
+            },
+            "language": {
+              "visibility": "advanced"
+            },
+            "wordTimings": {
+              "visibility": "hidden"
+            },
+            "audioMetadata": {
+              "visibility": "hidden"
+            },
+            "type": {
+              "visibility": "hidden"
+            },
+            "variant": {
+              "visibility": "hidden"
+            },
+            "fileKey": {
+              "visibility": "hidden"
+            },
+            "body": {
+              "visibility": "hidden"
+            },
+            "bodyFormat": {
+              "visibility": "hidden"
+            },
+            "url": {
+              "visibility": "hidden"
+            },
+            "source": {
+              "visibility": "hidden"
+            },
+            "original_url": {
+              "visibility": "hidden"
+            },
+            "tags": {
+              "visibility": "hidden"
+            },
+            "category": {
+              "visibility": "hidden"
+            },
+            "status": {
+              "visibility": "hidden"
+            },
+            "state": {
+              "visibility": "hidden"
+            },
+            "metadata": {
+              "visibility": "hidden"
+            },
+            "thumbnailAssetId": {
+              "visibility": "hidden"
+            },
+            "tenantId": {
+              "visibility": "hidden"
+            }
+          }
+        }
+      },
+      "help": {
+        "markdown": "## Overview\n\nVoice is where you set up the voices your app can speak in and keep the speech\nit has read aloud. A voice is either described in your own words, such as \"a\nwarm, unhurried narrator\", or copied from a recorded clip of a real person. The\nspeech service prepares the voice and shows where it stands, from waiting to\nready. Once a voice is ready, the app can read any text aloud in it, and each\nrecording it makes is kept here with the text it came from.\n\n## Tasks\n\n### Create a voice\n\n1. Open the list of voices and choose **New**.\n2. Give the voice a **{field:VoiceProfile.name}** your team will recognise.\n3. Pick the **{field:VoiceProfile.language}** it speaks and, if you like, the **{field:VoiceProfile.gender}** it should sound like.\n4. Do one of the following, not both: write what you want to hear in **{field:VoiceProfile.designPrompt}**, or pick a recorded clip in **{field:VoiceProfile.sampleAssetId}** to copy a real voice.\n5. Save. The **{field:VoiceProfile.status}** shows whether the speech service is still preparing the voice, has it ready, or could not make it. You do not set it yourself.\n\n### Add a sample clip\n\nA clip can only be used to copy a voice when it runs at least three seconds and\nits quality is not low. One clear speaker with no background noise works best.\n\n1. Open the list of samples and choose **New**.\n2. Pick the **{field:VoiceSample.voiceProfileId}** the clip is for and the **{field:VoiceSample.assetId}** holding the recording.\n3. Enter the **{field:VoiceSample.duration}** and, if you know it, the **{field:VoiceSample.quality}** of the recording.\n4. Write out **{field:VoiceSample.transcription}** so the words can be matched to the sound.\n5. Tick **{field:VoiceSample.isPrimary}** on the clip that best represents the voice.\n6. Save. To take a clip out, open it and remove it.\n\n### Find a recording the app has made\n\nRecordings are made by the speech service whenever the app reads text aloud in\none of your voices. The sound itself always comes from the service; here you\nfind, listen to and tidy up what it has made.\n\n1. Open the list of generated speech.\n2. Look at the **{field:VoiceOutput.name}** and the **{field:VoiceOutput.voiceProfileId}** to find the one you want.\n3. Open it to read the **{field:VoiceOutput.sourceText}** and play the **{field:VoiceOutput.audioAssetId}**; the **{field:VoiceOutput.duration}** tells you how long it runs.\n4. To clear out a recording you no longer need, open it and remove it.\n",
+        "fieldRefs": [
+          "VoiceOutput.audioAssetId",
+          "VoiceOutput.duration",
+          "VoiceOutput.name",
+          "VoiceOutput.sourceText",
+          "VoiceOutput.voiceProfileId",
+          "VoiceProfile.designPrompt",
+          "VoiceProfile.gender",
+          "VoiceProfile.language",
+          "VoiceProfile.name",
+          "VoiceProfile.sampleAssetId",
+          "VoiceProfile.status",
+          "VoiceSample.assetId",
+          "VoiceSample.duration",
+          "VoiceSample.isPrimary",
+          "VoiceSample.quality",
+          "VoiceSample.transcription",
+          "VoiceSample.voiceProfileId"
+        ]
+      },
+      "demo": {
+        "mode": "server",
+        "reasons": [
+          "Needs a server because its package does not build for a browser: documents/spider SDK graph; CJS parse error; and its package depends on @happyvertical/smrt-agents, @happyvertical/smrt-chat, @happyvertical/smrt-content, @happyvertical/smrt-images, @happyvertical/smrt-jobs, @happyvertical/smrt-profiles, @happyvertical/smrt-reports, @happyvertical/smrt-secrets, @happyvertical/smrt-tenancy, @happyvertical/smrt-users, which do not build for a browser (#3615, #3617, #3624, #3625, #3626, #3627, #3628)."
+        ]
+      }
+    }
+  ],
   "smrtDependencies": [
     "@happyvertical/smrt-assets",
     "@happyvertical/smrt-content",