@patterkit/model 1.0.1 → 1.1.0

package/dist/index.cjs

@@ -46,6 +46,7 @@ __export(index_exports, {
   MANIFEST_EXTENSION: () => MANIFEST_EXTENSION,
   PAD_AFTER_MAX: () => PAD_AFTER_MAX,
   PAD_AFTER_MIN: () => PAD_AFTER_MIN,
+  PLACEHOLDER_STATUS: () => PLACEHOLDER_STATUS,
   PROJECT_EXTENSION_STEM: () => PROJECT_EXTENSION_STEM,
   PROJECT_LOCALE_SCENE: () => PROJECT_LOCALE_SCENE,
   PROJECT_SCHEMA: () => PROJECT_SCHEMA,
@@ -250,6 +251,7 @@ var DEFAULT_RECORDING_STATUSES = [
   { name: "final", colour: 9 }
   // purple
 ];
+var PLACEHOLDER_STATUS = "placeholder";
 var RERECORD_STATUS = "rerecord";
 var RERECORD_STATUS_DECL = { name: RERECORD_STATUS, colour: 1 };
 function deriveRecordingFolders(audioRoot, statuses) {
@@ -385,6 +387,7 @@ var UNRESOLVED_KEY = "unresolved";
   MANIFEST_EXTENSION,
   PAD_AFTER_MAX,
   PAD_AFTER_MIN,
+  PLACEHOLDER_STATUS,
   PROJECT_EXTENSION_STEM,
   PROJECT_LOCALE_SCENE,
   PROJECT_SCHEMA,

package/dist/index.d.cts

@@ -393,6 +393,10 @@ interface CastMember {
      *  setup; renaming a character stamps the old name's slot here, so they keep their colour. Authoring only
      *  (not shipped in the runtime bundle). */
     colour?: number;
+    /** The voice Placeholder Speech gives this character (a Google voice name such as `en-GB-Standard-B`).
+     *  Absent, the default comes from a hash of the name (narrowed by `gender` when it's male or female);
+     *  renaming a character stamps the old default here, so they keep their voice. Authoring only. */
+    placeholderVoice?: string;
     gameData?: GameData;
 }
 /** A speaker qualifier (a screenplay's character extension): `V.O.`, `O.S.`, `RADIO`, or the project's own.
@@ -539,6 +543,21 @@ interface RecordingStatusDecl {
 /** The default recording-status ladder (used when a project declares none). The FIRST rung is the
  *  level-0 / absence status: a beat with no recorded status counts as `missing`. */
 declare const DEFAULT_RECORDING_STATUSES: RecordingStatusDecl[];
+/** Placeholder Speech settings (`ProjectFile.placeholderSpeech`). */
+interface PlaceholderSpeechConfig {
+    /** The recording status whose folder holds the speech. It's the one status that isn't a recording: reports
+     *  count its lines as still to record, and the scratch recorder treats them as missing. */
+    status: string;
+    /** The Google service-account key file, relative to the `.patter` folder (forward slashes) or `~/...`. Absent,
+     *  the `GOOGLE_APPLICATION_CREDENTIALS` environment variable is used. A path, never the key itself. */
+    keyFile?: string;
+    /** The voices' language and accent, as a Google language code (`en-GB`). Absent, from the main language. */
+    accent?: string;
+    /** Keep the speech out of version control: an ignore rule for its folder, and no adds. Default off. */
+    keepOutOfVersionControl?: boolean;
+}
+/** The status Placeholder Speech adds when it's turned on and the ladder has none of that name. */
+declare const PLACEHOLDER_STATUS = "placeholder";
 /** The reserved recording status a line takes when it is flagged **needs re-record** (#227): a recorded
  *  take exists but is unusable (bad quality, wrong take), so it must be redone. It is NOT a ladder rung -
  *  it is a regression flag that MASKS the derived / manual rung for the recording script, the production
@@ -810,6 +829,10 @@ interface ProjectFile {
      *  scratch take into this rung's folder for any line at or below this rung. Authoring metadata, editor-
      *  only; never reaches the bundle. Unset = scratch recording off. */
     scratchStatus?: string;
+    /** Placeholder Speech: stand-in speech made from each spoken line's text, into one recording status's folder,
+     *  so a scene can be heard before anyone records it. Present means on; absent means off. Authoring metadata,
+     *  editor and CLI only; never reaches the bundle. See `PlaceholderSpeechConfig`. */
+    placeholderSpeech?: PlaceholderSpeechConfig;
     /** Spell-check setup (Patterpad #177): the active dictionary language + the project's custom word list +
      *  an on/off flag. Source-language-only, authoring metadata - it never reaches the runtime bundle. */
     dictionary?: ProjectDictionary;
@@ -1491,4 +1514,4 @@ interface ExtensionFieldDecl {
 /** A node's extension values in a bundle: extension id -> field -> value, raw. */
 type NodeExtensions = Record<string, Record<string, unknown>>;
 
-export { AUTHORING_SCHEMA, type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, type BundleExtension, type BundleQualifier, COMMON_GENDERS, type CaptionDelimiters, type CastMember, type Comment, type CommentMessage, type CommentRange, type CompiledBlock, type CompiledEffect, type CompiledGroup, type CompiledScene, type CompiledSnippet, type CoverageDriver, DEFAULT_CAPTION_CHARACTER, DEFAULT_CAPTION_DELIMITERS, DEFAULT_DOCUMENTATION_CLASSES, DEFAULT_ESTIMATE_SPEED, DEFAULT_LAYOUT, DEFAULT_PAD_AFTER, DEFAULT_QUALIFIERS, DEFAULT_RECORDING_STATUSES, DEFAULT_SPEAKER_PATTERN, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, ESTIMATE_SPEED_MAX, ESTIMATE_SPEED_MIN, EXTENSIONS_DIR, EXTENSION_SCHEMA, EXTENSION_SHARD, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type ExtensionFieldDecl, type ExtensionShard, FLOW_SCHEMA, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowState, type FlowValues, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, HANDOFF_SCHEMA, type HandoffFile, type HandoffImport, type HandoffLine, type HandoffRow, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, LINE_CHARS_PER_SECOND, LINE_CHAR_WEIGHTS, LINE_DURATION_MAX, LINE_DURATION_MIN, type LineBeat, type LocaleFile, MANIFEST_EXTENSION, type NodeExtensions, PAD_AFTER_MAX, PAD_AFTER_MIN, PROJECT_EXTENSION_STEM, PROJECT_LOCALE_SCENE, PROJECT_SCHEMA, type ProjectDictionary, type ProjectExtension, type ProjectFile, type ProjectLayout, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, SPEAKER_PATTERN_KEY, STRINGS_SCHEMA, SUBTITLE_READING_MIN, type SaveEnvelope, type SaveGame, type SaveGameV3, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type SceneFolder, type SceneFolderLayout, type SceneNavRow, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type SpeakerQualifier, type StackFrame, type Suggestion, type SuggestionSource, type TextBeat, UNRESOLVED_KEY, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, estimateLineDuration, formatSpeakerLabel, isContentlessBeat, isDialogueScene, normaliseEstimateSpeed, projectLayout, projectQualifiers, qualifierStringKey, resolveSceneRef, sceneAddressIndex, sceneFolderLayout, sceneFolderPath, speakerLabelKey, textIsAction, usedQualifiers, usedSpeakerPairs, walkNodes };
+export { AUTHORING_SCHEMA, type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, type BundleExtension, type BundleQualifier, COMMON_GENDERS, type CaptionDelimiters, type CastMember, type Comment, type CommentMessage, type CommentRange, type CompiledBlock, type CompiledEffect, type CompiledGroup, type CompiledScene, type CompiledSnippet, type CoverageDriver, DEFAULT_CAPTION_CHARACTER, DEFAULT_CAPTION_DELIMITERS, DEFAULT_DOCUMENTATION_CLASSES, DEFAULT_ESTIMATE_SPEED, DEFAULT_LAYOUT, DEFAULT_PAD_AFTER, DEFAULT_QUALIFIERS, DEFAULT_RECORDING_STATUSES, DEFAULT_SPEAKER_PATTERN, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, ESTIMATE_SPEED_MAX, ESTIMATE_SPEED_MIN, EXTENSIONS_DIR, EXTENSION_SCHEMA, EXTENSION_SHARD, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type ExtensionFieldDecl, type ExtensionShard, FLOW_SCHEMA, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowState, type FlowValues, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, HANDOFF_SCHEMA, type HandoffFile, type HandoffImport, type HandoffLine, type HandoffRow, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, LINE_CHARS_PER_SECOND, LINE_CHAR_WEIGHTS, LINE_DURATION_MAX, LINE_DURATION_MIN, type LineBeat, type LocaleFile, MANIFEST_EXTENSION, type NodeExtensions, PAD_AFTER_MAX, PAD_AFTER_MIN, PLACEHOLDER_STATUS, PROJECT_EXTENSION_STEM, PROJECT_LOCALE_SCENE, PROJECT_SCHEMA, type PlaceholderSpeechConfig, type ProjectDictionary, type ProjectExtension, type ProjectFile, type ProjectLayout, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, SPEAKER_PATTERN_KEY, STRINGS_SCHEMA, SUBTITLE_READING_MIN, type SaveEnvelope, type SaveGame, type SaveGameV3, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type SceneFolder, type SceneFolderLayout, type SceneNavRow, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type SpeakerQualifier, type StackFrame, type Suggestion, type SuggestionSource, type TextBeat, UNRESOLVED_KEY, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, estimateLineDuration, formatSpeakerLabel, isContentlessBeat, isDialogueScene, normaliseEstimateSpeed, projectLayout, projectQualifiers, qualifierStringKey, resolveSceneRef, sceneAddressIndex, sceneFolderLayout, sceneFolderPath, speakerLabelKey, textIsAction, usedQualifiers, usedSpeakerPairs, walkNodes };

package/dist/index.d.ts

@@ -393,6 +393,10 @@ interface CastMember {
      *  setup; renaming a character stamps the old name's slot here, so they keep their colour. Authoring only
      *  (not shipped in the runtime bundle). */
     colour?: number;
+    /** The voice Placeholder Speech gives this character (a Google voice name such as `en-GB-Standard-B`).
+     *  Absent, the default comes from a hash of the name (narrowed by `gender` when it's male or female);
+     *  renaming a character stamps the old default here, so they keep their voice. Authoring only. */
+    placeholderVoice?: string;
     gameData?: GameData;
 }
 /** A speaker qualifier (a screenplay's character extension): `V.O.`, `O.S.`, `RADIO`, or the project's own.
@@ -539,6 +543,21 @@ interface RecordingStatusDecl {
 /** The default recording-status ladder (used when a project declares none). The FIRST rung is the
  *  level-0 / absence status: a beat with no recorded status counts as `missing`. */
 declare const DEFAULT_RECORDING_STATUSES: RecordingStatusDecl[];
+/** Placeholder Speech settings (`ProjectFile.placeholderSpeech`). */
+interface PlaceholderSpeechConfig {
+    /** The recording status whose folder holds the speech. It's the one status that isn't a recording: reports
+     *  count its lines as still to record, and the scratch recorder treats them as missing. */
+    status: string;
+    /** The Google service-account key file, relative to the `.patter` folder (forward slashes) or `~/...`. Absent,
+     *  the `GOOGLE_APPLICATION_CREDENTIALS` environment variable is used. A path, never the key itself. */
+    keyFile?: string;
+    /** The voices' language and accent, as a Google language code (`en-GB`). Absent, from the main language. */
+    accent?: string;
+    /** Keep the speech out of version control: an ignore rule for its folder, and no adds. Default off. */
+    keepOutOfVersionControl?: boolean;
+}
+/** The status Placeholder Speech adds when it's turned on and the ladder has none of that name. */
+declare const PLACEHOLDER_STATUS = "placeholder";
 /** The reserved recording status a line takes when it is flagged **needs re-record** (#227): a recorded
  *  take exists but is unusable (bad quality, wrong take), so it must be redone. It is NOT a ladder rung -
  *  it is a regression flag that MASKS the derived / manual rung for the recording script, the production
@@ -810,6 +829,10 @@ interface ProjectFile {
      *  scratch take into this rung's folder for any line at or below this rung. Authoring metadata, editor-
      *  only; never reaches the bundle. Unset = scratch recording off. */
     scratchStatus?: string;
+    /** Placeholder Speech: stand-in speech made from each spoken line's text, into one recording status's folder,
+     *  so a scene can be heard before anyone records it. Present means on; absent means off. Authoring metadata,
+     *  editor and CLI only; never reaches the bundle. See `PlaceholderSpeechConfig`. */
+    placeholderSpeech?: PlaceholderSpeechConfig;
     /** Spell-check setup (Patterpad #177): the active dictionary language + the project's custom word list +
      *  an on/off flag. Source-language-only, authoring metadata - it never reaches the runtime bundle. */
     dictionary?: ProjectDictionary;
@@ -1491,4 +1514,4 @@ interface ExtensionFieldDecl {
 /** A node's extension values in a bundle: extension id -> field -> value, raw. */
 type NodeExtensions = Record<string, Record<string, unknown>>;
 
-export { AUTHORING_SCHEMA, type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, type BundleExtension, type BundleQualifier, COMMON_GENDERS, type CaptionDelimiters, type CastMember, type Comment, type CommentMessage, type CommentRange, type CompiledBlock, type CompiledEffect, type CompiledGroup, type CompiledScene, type CompiledSnippet, type CoverageDriver, DEFAULT_CAPTION_CHARACTER, DEFAULT_CAPTION_DELIMITERS, DEFAULT_DOCUMENTATION_CLASSES, DEFAULT_ESTIMATE_SPEED, DEFAULT_LAYOUT, DEFAULT_PAD_AFTER, DEFAULT_QUALIFIERS, DEFAULT_RECORDING_STATUSES, DEFAULT_SPEAKER_PATTERN, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, ESTIMATE_SPEED_MAX, ESTIMATE_SPEED_MIN, EXTENSIONS_DIR, EXTENSION_SCHEMA, EXTENSION_SHARD, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type ExtensionFieldDecl, type ExtensionShard, FLOW_SCHEMA, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowState, type FlowValues, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, HANDOFF_SCHEMA, type HandoffFile, type HandoffImport, type HandoffLine, type HandoffRow, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, LINE_CHARS_PER_SECOND, LINE_CHAR_WEIGHTS, LINE_DURATION_MAX, LINE_DURATION_MIN, type LineBeat, type LocaleFile, MANIFEST_EXTENSION, type NodeExtensions, PAD_AFTER_MAX, PAD_AFTER_MIN, PROJECT_EXTENSION_STEM, PROJECT_LOCALE_SCENE, PROJECT_SCHEMA, type ProjectDictionary, type ProjectExtension, type ProjectFile, type ProjectLayout, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, SPEAKER_PATTERN_KEY, STRINGS_SCHEMA, SUBTITLE_READING_MIN, type SaveEnvelope, type SaveGame, type SaveGameV3, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type SceneFolder, type SceneFolderLayout, type SceneNavRow, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type SpeakerQualifier, type StackFrame, type Suggestion, type SuggestionSource, type TextBeat, UNRESOLVED_KEY, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, estimateLineDuration, formatSpeakerLabel, isContentlessBeat, isDialogueScene, normaliseEstimateSpeed, projectLayout, projectQualifiers, qualifierStringKey, resolveSceneRef, sceneAddressIndex, sceneFolderLayout, sceneFolderPath, speakerLabelKey, textIsAction, usedQualifiers, usedSpeakerPairs, walkNodes };
+export { AUTHORING_SCHEMA, type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, type BundleExtension, type BundleQualifier, COMMON_GENDERS, type CaptionDelimiters, type CastMember, type Comment, type CommentMessage, type CommentRange, type CompiledBlock, type CompiledEffect, type CompiledGroup, type CompiledScene, type CompiledSnippet, type CoverageDriver, DEFAULT_CAPTION_CHARACTER, DEFAULT_CAPTION_DELIMITERS, DEFAULT_DOCUMENTATION_CLASSES, DEFAULT_ESTIMATE_SPEED, DEFAULT_LAYOUT, DEFAULT_PAD_AFTER, DEFAULT_QUALIFIERS, DEFAULT_RECORDING_STATUSES, DEFAULT_SPEAKER_PATTERN, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, ESTIMATE_SPEED_MAX, ESTIMATE_SPEED_MIN, EXTENSIONS_DIR, EXTENSION_SCHEMA, EXTENSION_SHARD, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type ExtensionFieldDecl, type ExtensionShard, FLOW_SCHEMA, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowState, type FlowValues, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, HANDOFF_SCHEMA, type HandoffFile, type HandoffImport, type HandoffLine, type HandoffRow, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, LINE_CHARS_PER_SECOND, LINE_CHAR_WEIGHTS, LINE_DURATION_MAX, LINE_DURATION_MIN, type LineBeat, type LocaleFile, MANIFEST_EXTENSION, type NodeExtensions, PAD_AFTER_MAX, PAD_AFTER_MIN, PLACEHOLDER_STATUS, PROJECT_EXTENSION_STEM, PROJECT_LOCALE_SCENE, PROJECT_SCHEMA, type PlaceholderSpeechConfig, type ProjectDictionary, type ProjectExtension, type ProjectFile, type ProjectLayout, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, SPEAKER_PATTERN_KEY, STRINGS_SCHEMA, SUBTITLE_READING_MIN, type SaveEnvelope, type SaveGame, type SaveGameV3, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type SceneFolder, type SceneFolderLayout, type SceneNavRow, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type SpeakerQualifier, type StackFrame, type Suggestion, type SuggestionSource, type TextBeat, UNRESOLVED_KEY, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, estimateLineDuration, formatSpeakerLabel, isContentlessBeat, isDialogueScene, normaliseEstimateSpeed, projectLayout, projectQualifiers, qualifierStringKey, resolveSceneRef, sceneAddressIndex, sceneFolderLayout, sceneFolderPath, speakerLabelKey, textIsAction, usedQualifiers, usedSpeakerPairs, walkNodes };

package/dist/index.js

@@ -169,6 +169,7 @@ var DEFAULT_RECORDING_STATUSES = [
   { name: "final", colour: 9 }
   // purple
 ];
+var PLACEHOLDER_STATUS = "placeholder";
 var RERECORD_STATUS = "rerecord";
 var RERECORD_STATUS_DECL = { name: RERECORD_STATUS, colour: 1 };
 function deriveRecordingFolders(audioRoot, statuses) {
@@ -303,6 +304,7 @@ export {
   MANIFEST_EXTENSION,
   PAD_AFTER_MAX,
   PAD_AFTER_MIN,
+  PLACEHOLDER_STATUS,
   PROJECT_EXTENSION_STEM,
   PROJECT_LOCALE_SCENE,
   PROJECT_SCHEMA,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patterkit/model",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Patter data-model types: source (scene/block/group/snippet/beat/jump), project, locale, authoring. The shape source-of-truth.",
   "keywords": [
     "patter",
@@ -46,6 +46,6 @@
   },
   "dependencies": {
     "@wildwinter/expr": "^1.0.1",
-    "@wildwinter/toolkit": "^1.1.0"
+    "@wildwinter/toolkit": "^1.2.0"
   }
 }