@patterkit/model 0.25.0 → 0.27.0

package/dist/index.d.cts

@@ -2,33 +2,6 @@ import { AstNode } from '@wildwinter/expr';
 export { RESERVED_PROPERTY_NAMES, isCaseOnlyPropertyName, isValidPropertyName, propertyNameify } from '@wildwinter/expr';
 export { gameIdify, isValidGameId } from '@wildwinter/toolkit';
 
-/** What a speech unit is: a syllable (the mouth opens), a beat with the mouth shut (っ), or a pause. */
-type SpeechUnitKind = "syllable" | "closed" | "pause";
-/** One unit of a line as it would be spoken. `start` and `end` are code-point offsets into the text, end exclusive. */
-interface SpeechUnit {
-    kind: SpeechUnitKind;
-    weight: number;
-    start: number;
-    end: number;
-}
-/** A digit's weight: most read as one or two syllables. */
-declare const SPEECH_DIGIT_WEIGHT = 1.5;
-/** A Han character's weight in Japanese text. */
-declare const SPEECH_KANJI_WEIGHT = 2;
-/** A short pause's weight (`,` `;` `、`), and a long one's (`.` `?` `。`). */
-declare const SPEECH_PAUSE_SHORT_WEIGHT = 1;
-declare const SPEECH_PAUSE_LONG_WEIGHT = 2;
-/**
- * A line broken into the units it would be spoken in: its syllables, its beats with the mouth shut, and its pauses,
- * in order, each with a weight. `locale` is the language the line is spoken in (the project's main language, not the
- * one being shown); it decides English's and French's silent e, and Japanese kanji, which also apply when the line
- * has any kana in it.
- */
-declare function speechUnits(text: string, locale?: string): SpeechUnit[];
-/** How many syllables a line would be spoken in: its syllables' and shut beats' weights, pauses aside. `locale` is
- *  the language it's spoken in, as for `speechUnits`. */
-declare function countSyllables(text: string, locale?: string): number;
-
 type ScalarValue = boolean | number | string | string[];
 /** Developer-defined host metadata (spec §17). Opaque to Patter. */
 type GameData = Record<string, unknown>;
@@ -458,11 +431,13 @@ declare const DEFAULT_PAD_AFTER = 0.6;
 /** The range validation keeps a `padAfter` or `padAfterDefault` within, in seconds. */
 declare const PAD_AFTER_MIN = -10;
 declare const PAD_AFTER_MAX = 60;
-/** How many syllables a second a line with no recording is timed at, unless the project sets its own
- *  (`estimateSyllablesPerSecond`), and the range validation keeps a project's within. */
-declare const DEFAULT_ESTIMATE_SYLLABLES_PER_SECOND = 4;
-declare const ESTIMATE_SYLLABLES_PER_SECOND_MIN = 2;
-declare const ESTIMATE_SYLLABLES_PER_SECOND_MAX = 10;
+/** How fast a line with no recording is timed against the default, unless the project sets its own
+ *  (`estimateSpeed`), and the range validation keeps a project's within: higher is faster. */
+declare const DEFAULT_ESTIMATE_SPEED = 1;
+declare const ESTIMATE_SPEED_MIN = 0.5;
+declare const ESTIMATE_SPEED_MAX = 2.5;
+/** How many weighted characters a second a line with no recording is timed at, at speed 1 (`estimateLineDuration`). */
+declare const LINE_CHARS_PER_SECOND = 14;
 /** The shortest and longest a line with no recording lasts, in seconds (`estimateLineDuration`). The shortest is a
  *  speaking time, the least a spoken word plausibly takes, not a reading time: see SUBTITLE_READING_MIN. */
 declare const LINE_DURATION_MIN = 0.5;
@@ -471,14 +446,26 @@ declare const LINE_DURATION_MAX = 18;
  *  for a tool that shows a line as a subtitle or overhead text, which keeps it up at least this long after a shorter
  *  line ends, overlapping the next if it must. The line itself still ends when it's said (`estimateLineDuration`). */
 declare const SUBTITLE_READING_MIN = 1.5;
-/** How long a line with no recording lasts, in seconds: the total weight of its speech units (its syllables and its
- *  pauses, `speechUnits`) at `syllablesPerSecond` (default 4, the project's `estimateSyllablesPerSecond` when it
- *  sets one), clamped to 0.5 to 18 seconds. `text` and `locale` are the line as it's spoken, in the project's main
- *  language (a line result's `spokenText` and `spokenLocale`), never a translation being shown. This is the one
- *  rule every Patter tool and runtime times a line by: Patterpad's Play window, the playable HTML page, and the
- *  Unity, Unreal, and Godot runtimes, which the conformance corpus holds to the same numbers. A rate that isn't a
- *  positive number is the default. A line with a recording lasts as long as the recording, whatever this says. */
-declare function estimateLineDuration(text: string, locale?: string, syllablesPerSecond?: number): number;
+/** Reads a project file's timing for lines without audio from before `estimateSpeed`: a project carrying the old
+ *  `estimateSyllablesPerSecond` (syllables a second, 4 the default) and no `estimateSpeed` gets `estimateSpeed` =
+ *  the old value / 4, and the old key goes either way, so the next save writes only the new one. A value that isn't
+ *  a number is carried across as it is, for validation to report. Changes `project` in place and returns it. Every
+ *  reader of a project file calls this once, where it parses the file. */
+declare function normaliseEstimateSpeed<T extends object>(project: T): T;
+/** The characters `estimateLineDuration` weighs other than 1, as inclusive code point ranges with their weight: Han
+ *  3 (CJK Unified Ideographs, Extension A, the Compatibility Ideographs, and Extensions B onwards), kana 2
+ *  (hiragana, katakana, the katakana phonetic extensions, and halfwidth katakana), a Hangul syllable block 2.5, and
+ *  the soft hyphen 0. Plain ranges rather than Unicode properties, so every runtime holds the same list. */
+declare const LINE_CHAR_WEIGHTS: readonly (readonly [number, number, number])[];
+/** How long a line with no recording lasts, in seconds: its weighted characters (`LINE_CHAR_WEIGHTS`, a character
+ *  being a code point, 1 unless listed there) at `LINE_CHARS_PER_SECOND` times `speed` (default 1, the project's
+ *  `estimateSpeed` when it sets one), clamped to 0.5 to 18 seconds. `text` is the line as it's spoken, in the
+ *  project's main language (a line result's `spokenText`), never a translation being shown. `locale` is reserved:
+ *  nothing reads it yet. This is the one rule every Patter tool and runtime times a line by: Patterpad's Play
+ *  window, the playable HTML page, and the Unity, Unreal, and Godot runtimes, which the conformance corpus holds to
+ *  the same numbers. A speed that isn't a finite positive number is 1. A line with a recording lasts as long as the
+ *  recording, whatever this says. */
+declare function estimateLineDuration(text: string, locale?: string, speed?: number): number;
 /** A qualifier as it reaches a compiled bundle: its `gameId` and authored name (the unlocalised fallback). */
 interface BundleQualifier {
     gameId: string;
@@ -787,10 +774,11 @@ interface ProjectFile {
     /** The project's default `padAfter` for every line and text beat that sets none and has no default above it.
      *  Absent = `DEFAULT_PAD_AFTER`. */
     padAfterDefault?: number;
-    /** How many syllables a second a line with no recording is timed at (`estimateLineDuration`), from 2 to 10.
-     *  Only estimates use it: a line with a recording lasts as long as the recording. Absent =
-     *  `DEFAULT_ESTIMATE_SYLLABLES_PER_SECOND`. */
-    estimateSyllablesPerSecond?: number;
+    /** How fast a line with no recording is timed against the default (`estimateLineDuration`), from 0.5 to 2.5:
+     *  higher is faster. Only estimates use it: a line with a recording lasts as long as the recording. Absent =
+     *  `DEFAULT_ESTIMATE_SPEED`. A project file from before 0.45 may carry `estimateSyllablesPerSecond` instead:
+     *  `normaliseEstimateSpeed` reads it as this. */
+    estimateSpeed?: number;
     /** Localise text lines in dialogue scenes (design/proposals/action-text.md). Off (absent) by default: a
      *  dialogue scene's text beats (`isDialogueScene`) are then ACTION, left out of the loc files and the
      *  written word counts, and compiled with `action: true`. On: they're localised and shown as a text
@@ -1207,9 +1195,8 @@ interface Bundle {
     speakerPattern?: string;
     /** The project's own `padAfterDefault`, when it sets one; absent = `DEFAULT_PAD_AFTER`. */
     padAfterDefault?: number;
-    /** The project's own `estimateSyllablesPerSecond`, when it sets one; absent =
-     *  `DEFAULT_ESTIMATE_SYLLABLES_PER_SECOND`. */
-    estimateSyllablesPerSecond?: number;
+    /** The project's own `estimateSpeed`, when it sets one; absent = `DEFAULT_ESTIMATE_SPEED`. */
+    estimateSpeed?: number;
     properties?: PropertyDecl[];
     /** Host / world scope declarations, baked from the project so the runtime can self-back a declared
      *  scope (`@world`, ...) when no host resolver claims its token. Absent = no host scopes. */
@@ -1504,4 +1491,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_SYLLABLES_PER_SECOND, DEFAULT_LAYOUT, DEFAULT_PAD_AFTER, DEFAULT_QUALIFIERS, DEFAULT_RECORDING_STATUSES, DEFAULT_SPEAKER_PATTERN, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, ESTIMATE_SYLLABLES_PER_SECOND_MAX, ESTIMATE_SYLLABLES_PER_SECOND_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_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, SPEECH_DIGIT_WEIGHT, SPEECH_KANJI_WEIGHT, SPEECH_PAUSE_LONG_WEIGHT, SPEECH_PAUSE_SHORT_WEIGHT, 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 SpeechUnit, type SpeechUnitKind, type StackFrame, type Suggestion, type SuggestionSource, type TextBeat, UNRESOLVED_KEY, type VcsKind, type WritingStatusDecl, castStringKey, countSyllables, deriveRecordingFolders, effectiveGameId, estimateLineDuration, formatSpeakerLabel, isContentlessBeat, isDialogueScene, projectLayout, projectQualifiers, qualifierStringKey, resolveSceneRef, sceneAddressIndex, sceneFolderLayout, sceneFolderPath, speakerLabelKey, speechUnits, 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, 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 };

package/dist/index.d.ts

@@ -2,33 +2,6 @@ import { AstNode } from '@wildwinter/expr';
 export { RESERVED_PROPERTY_NAMES, isCaseOnlyPropertyName, isValidPropertyName, propertyNameify } from '@wildwinter/expr';
 export { gameIdify, isValidGameId } from '@wildwinter/toolkit';
 
-/** What a speech unit is: a syllable (the mouth opens), a beat with the mouth shut (っ), or a pause. */
-type SpeechUnitKind = "syllable" | "closed" | "pause";
-/** One unit of a line as it would be spoken. `start` and `end` are code-point offsets into the text, end exclusive. */
-interface SpeechUnit {
-    kind: SpeechUnitKind;
-    weight: number;
-    start: number;
-    end: number;
-}
-/** A digit's weight: most read as one or two syllables. */
-declare const SPEECH_DIGIT_WEIGHT = 1.5;
-/** A Han character's weight in Japanese text. */
-declare const SPEECH_KANJI_WEIGHT = 2;
-/** A short pause's weight (`,` `;` `、`), and a long one's (`.` `?` `。`). */
-declare const SPEECH_PAUSE_SHORT_WEIGHT = 1;
-declare const SPEECH_PAUSE_LONG_WEIGHT = 2;
-/**
- * A line broken into the units it would be spoken in: its syllables, its beats with the mouth shut, and its pauses,
- * in order, each with a weight. `locale` is the language the line is spoken in (the project's main language, not the
- * one being shown); it decides English's and French's silent e, and Japanese kanji, which also apply when the line
- * has any kana in it.
- */
-declare function speechUnits(text: string, locale?: string): SpeechUnit[];
-/** How many syllables a line would be spoken in: its syllables' and shut beats' weights, pauses aside. `locale` is
- *  the language it's spoken in, as for `speechUnits`. */
-declare function countSyllables(text: string, locale?: string): number;
-
 type ScalarValue = boolean | number | string | string[];
 /** Developer-defined host metadata (spec §17). Opaque to Patter. */
 type GameData = Record<string, unknown>;
@@ -458,11 +431,13 @@ declare const DEFAULT_PAD_AFTER = 0.6;
 /** The range validation keeps a `padAfter` or `padAfterDefault` within, in seconds. */
 declare const PAD_AFTER_MIN = -10;
 declare const PAD_AFTER_MAX = 60;
-/** How many syllables a second a line with no recording is timed at, unless the project sets its own
- *  (`estimateSyllablesPerSecond`), and the range validation keeps a project's within. */
-declare const DEFAULT_ESTIMATE_SYLLABLES_PER_SECOND = 4;
-declare const ESTIMATE_SYLLABLES_PER_SECOND_MIN = 2;
-declare const ESTIMATE_SYLLABLES_PER_SECOND_MAX = 10;
+/** How fast a line with no recording is timed against the default, unless the project sets its own
+ *  (`estimateSpeed`), and the range validation keeps a project's within: higher is faster. */
+declare const DEFAULT_ESTIMATE_SPEED = 1;
+declare const ESTIMATE_SPEED_MIN = 0.5;
+declare const ESTIMATE_SPEED_MAX = 2.5;
+/** How many weighted characters a second a line with no recording is timed at, at speed 1 (`estimateLineDuration`). */
+declare const LINE_CHARS_PER_SECOND = 14;
 /** The shortest and longest a line with no recording lasts, in seconds (`estimateLineDuration`). The shortest is a
  *  speaking time, the least a spoken word plausibly takes, not a reading time: see SUBTITLE_READING_MIN. */
 declare const LINE_DURATION_MIN = 0.5;
@@ -471,14 +446,26 @@ declare const LINE_DURATION_MAX = 18;
  *  for a tool that shows a line as a subtitle or overhead text, which keeps it up at least this long after a shorter
  *  line ends, overlapping the next if it must. The line itself still ends when it's said (`estimateLineDuration`). */
 declare const SUBTITLE_READING_MIN = 1.5;
-/** How long a line with no recording lasts, in seconds: the total weight of its speech units (its syllables and its
- *  pauses, `speechUnits`) at `syllablesPerSecond` (default 4, the project's `estimateSyllablesPerSecond` when it
- *  sets one), clamped to 0.5 to 18 seconds. `text` and `locale` are the line as it's spoken, in the project's main
- *  language (a line result's `spokenText` and `spokenLocale`), never a translation being shown. This is the one
- *  rule every Patter tool and runtime times a line by: Patterpad's Play window, the playable HTML page, and the
- *  Unity, Unreal, and Godot runtimes, which the conformance corpus holds to the same numbers. A rate that isn't a
- *  positive number is the default. A line with a recording lasts as long as the recording, whatever this says. */
-declare function estimateLineDuration(text: string, locale?: string, syllablesPerSecond?: number): number;
+/** Reads a project file's timing for lines without audio from before `estimateSpeed`: a project carrying the old
+ *  `estimateSyllablesPerSecond` (syllables a second, 4 the default) and no `estimateSpeed` gets `estimateSpeed` =
+ *  the old value / 4, and the old key goes either way, so the next save writes only the new one. A value that isn't
+ *  a number is carried across as it is, for validation to report. Changes `project` in place and returns it. Every
+ *  reader of a project file calls this once, where it parses the file. */
+declare function normaliseEstimateSpeed<T extends object>(project: T): T;
+/** The characters `estimateLineDuration` weighs other than 1, as inclusive code point ranges with their weight: Han
+ *  3 (CJK Unified Ideographs, Extension A, the Compatibility Ideographs, and Extensions B onwards), kana 2
+ *  (hiragana, katakana, the katakana phonetic extensions, and halfwidth katakana), a Hangul syllable block 2.5, and
+ *  the soft hyphen 0. Plain ranges rather than Unicode properties, so every runtime holds the same list. */
+declare const LINE_CHAR_WEIGHTS: readonly (readonly [number, number, number])[];
+/** How long a line with no recording lasts, in seconds: its weighted characters (`LINE_CHAR_WEIGHTS`, a character
+ *  being a code point, 1 unless listed there) at `LINE_CHARS_PER_SECOND` times `speed` (default 1, the project's
+ *  `estimateSpeed` when it sets one), clamped to 0.5 to 18 seconds. `text` is the line as it's spoken, in the
+ *  project's main language (a line result's `spokenText`), never a translation being shown. `locale` is reserved:
+ *  nothing reads it yet. This is the one rule every Patter tool and runtime times a line by: Patterpad's Play
+ *  window, the playable HTML page, and the Unity, Unreal, and Godot runtimes, which the conformance corpus holds to
+ *  the same numbers. A speed that isn't a finite positive number is 1. A line with a recording lasts as long as the
+ *  recording, whatever this says. */
+declare function estimateLineDuration(text: string, locale?: string, speed?: number): number;
 /** A qualifier as it reaches a compiled bundle: its `gameId` and authored name (the unlocalised fallback). */
 interface BundleQualifier {
     gameId: string;
@@ -787,10 +774,11 @@ interface ProjectFile {
     /** The project's default `padAfter` for every line and text beat that sets none and has no default above it.
      *  Absent = `DEFAULT_PAD_AFTER`. */
     padAfterDefault?: number;
-    /** How many syllables a second a line with no recording is timed at (`estimateLineDuration`), from 2 to 10.
-     *  Only estimates use it: a line with a recording lasts as long as the recording. Absent =
-     *  `DEFAULT_ESTIMATE_SYLLABLES_PER_SECOND`. */
-    estimateSyllablesPerSecond?: number;
+    /** How fast a line with no recording is timed against the default (`estimateLineDuration`), from 0.5 to 2.5:
+     *  higher is faster. Only estimates use it: a line with a recording lasts as long as the recording. Absent =
+     *  `DEFAULT_ESTIMATE_SPEED`. A project file from before 0.45 may carry `estimateSyllablesPerSecond` instead:
+     *  `normaliseEstimateSpeed` reads it as this. */
+    estimateSpeed?: number;
     /** Localise text lines in dialogue scenes (design/proposals/action-text.md). Off (absent) by default: a
      *  dialogue scene's text beats (`isDialogueScene`) are then ACTION, left out of the loc files and the
      *  written word counts, and compiled with `action: true`. On: they're localised and shown as a text
@@ -1207,9 +1195,8 @@ interface Bundle {
     speakerPattern?: string;
     /** The project's own `padAfterDefault`, when it sets one; absent = `DEFAULT_PAD_AFTER`. */
     padAfterDefault?: number;
-    /** The project's own `estimateSyllablesPerSecond`, when it sets one; absent =
-     *  `DEFAULT_ESTIMATE_SYLLABLES_PER_SECOND`. */
-    estimateSyllablesPerSecond?: number;
+    /** The project's own `estimateSpeed`, when it sets one; absent = `DEFAULT_ESTIMATE_SPEED`. */
+    estimateSpeed?: number;
     properties?: PropertyDecl[];
     /** Host / world scope declarations, baked from the project so the runtime can self-back a declared
      *  scope (`@world`, ...) when no host resolver claims its token. Absent = no host scopes. */
@@ -1504,4 +1491,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_SYLLABLES_PER_SECOND, DEFAULT_LAYOUT, DEFAULT_PAD_AFTER, DEFAULT_QUALIFIERS, DEFAULT_RECORDING_STATUSES, DEFAULT_SPEAKER_PATTERN, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, ESTIMATE_SYLLABLES_PER_SECOND_MAX, ESTIMATE_SYLLABLES_PER_SECOND_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_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, SPEECH_DIGIT_WEIGHT, SPEECH_KANJI_WEIGHT, SPEECH_PAUSE_LONG_WEIGHT, SPEECH_PAUSE_SHORT_WEIGHT, 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 SpeechUnit, type SpeechUnitKind, type StackFrame, type Suggestion, type SuggestionSource, type TextBeat, UNRESOLVED_KEY, type VcsKind, type WritingStatusDecl, castStringKey, countSyllables, deriveRecordingFolders, effectiveGameId, estimateLineDuration, formatSpeakerLabel, isContentlessBeat, isDialogueScene, projectLayout, projectQualifiers, qualifierStringKey, resolveSceneRef, sceneAddressIndex, sceneFolderLayout, sceneFolderPath, speakerLabelKey, speechUnits, 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, 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 };