@patterkit/model 0.7.0 → 0.9.0

package/README.md

@@ -0,0 +1,35 @@
+# @patterkit/model
+
+The TypeScript types that describe Patter's data: the shape every other `@patterkit` package agrees on.
+Types only, with no behaviour.
+
+Most people won't need to install this directly. To play Patter dialogue in a game or web page, use
+[`@patterkit/runtime`](https://www.npmjs.com/package/@patterkit/runtime); to work with Patter projects from
+a terminal or a build script, use [`@patterkit/cli`](https://www.npmjs.com/package/@patterkit/cli).
+
+## What's in it
+
+- **The source format**: scenes and their flow tree (blocks, groups, snippets, beats, and jumps), the
+  project file, locale files, and the authoring file that holds comments, suggestions, and writing status.
+- **The compiled bundle**: the `.patterc` a game loads, as written by the compiler and read by every runtime.
+- **Shared helpers for addressing**: the game-facing ids (`gameIdify`, `isValidGameId`, `effectiveGameId`).
+
+Conditions and effects are kept as source strings here; the expression language itself is
+[`@wildwinter/expr`](https://www.npmjs.com/package/@wildwinter/expr). The format is described in
+[the specification](https://patterkit.dev/specification/).
+
+```sh
+npm install @patterkit/model
+```
+
+## Part of Patter
+
+[Patter](https://patterkit.dev/) is a branching dialogue format with its own editor (Patterpad), command line
+tool (`patter`), and runtimes for JavaScript, Unity, Unreal, and Godot. This package is one layer of the
+JavaScript tooling, and the other `@patterkit` packages build on it. [How it fits
+together](https://patterkit.dev/architecture/) shows where each piece sits, and the source is in the
+[patter repository](https://github.com/patterkit/patter).
+
+## Licence
+
+MIT

package/dist/index.cjs

@@ -26,6 +26,7 @@ __export(index_exports, {
   DEFAULT_DOCUMENTATION_CLASSES: () => DEFAULT_DOCUMENTATION_CLASSES,
   DEFAULT_RECORDING_STATUSES: () => DEFAULT_RECORDING_STATUSES,
   DEFAULT_WRITING_STATUSES: () => DEFAULT_WRITING_STATUSES,
+  HANDOFF_SCHEMA: () => HANDOFF_SCHEMA,
   PROJECT_LOCALE_SCENE: () => PROJECT_LOCALE_SCENE,
   RERECORD_STATUS: () => RERECORD_STATUS,
   RERECORD_STATUS_DECL: () => RERECORD_STATUS_DECL,
@@ -106,13 +107,16 @@ var DEFAULT_DOCUMENTATION_CLASSES = [
   // every export, and (like all) the editor
   { name: "vo", deliver: ["vo"] },
   // voice-recording scripts
-  { name: "loc", deliver: ["loc"] }
+  { name: "loc", deliver: ["loc"] },
   // localisation handoff
+  { name: "editor", deliver: ["editor"] }
+  // the editable script handed to an outside editor
 ];
 var PROJECT_LOCALE_SCENE = "@project";
 function castStringKey(name) {
   return `cast:${name}`;
 }
+var HANDOFF_SCHEMA = "patter/handoff@0";
 var DEFAULT_CAPTION_DELIMITERS = { open: "[", close: "]" };
 var DEFAULT_CAPTION_CHARACTER = "SFX";
 var SAVE_SCHEMA = "patter/save@0";
@@ -125,6 +129,7 @@ var SAVE_VERSION = 3;
   DEFAULT_DOCUMENTATION_CLASSES,
   DEFAULT_RECORDING_STATUSES,
   DEFAULT_WRITING_STATUSES,
+  HANDOFF_SCHEMA,
   PROJECT_LOCALE_SCENE,
   RERECORD_STATUS,
   RERECORD_STATUS_DECL,

package/dist/index.d.cts

@@ -417,8 +417,9 @@ interface DocumentationClass {
     /**
      * Export channels this class flows to: a list of channel names, or `"*"` for
      * all. Omitted/empty = editor-only (e.g. "writing"). Built-in channels: `vo`
-     * (voice-recording scripts), `loc` (localisation handoff); studios add their
-     * own (e.g. `sfx`, `art`), carried now and picked up when that export exists.
+     * (voice-recording scripts), `loc` (localisation handoff), `editor` (the editable
+     * script handed to an outside editor); studios add their own (e.g. `sfx`, `art`),
+     * carried now and picked up when that export exists.
      */
     deliver?: string[] | "*";
 }
@@ -656,12 +657,18 @@ interface Comment {
     resolved?: boolean;
     messages: CommentMessage[];
 }
-/** A "suggest a rewrite" proposal for a single say/prose beat (review flow, design/proposals/
- *  suggest-rewrite.md). Whole-beat anchored: `baseline` is the say text WHEN suggested (the "before" +
- *  the drift detector - if it no longer matches the live text, the line changed since and the suggestion
- *  is shown stale), `proposed` is the replacement. Accept overwrites the beat's say text; both accept and
- *  reject set `resolved` (archived) + `outcome` (a light audit trail). Stored in the authoring shard,
- *  never in the flow text, so downstream tools ignore it. */
+/** A "suggest a rewrite" proposal for a single say/prose beat or option prompt (review flow,
+ *  design/proposals/suggest-rewrite.md). Whole-beat anchored: `baseline` is the say text WHEN suggested
+ *  (the "before" + the drift detector - if it no longer matches the live text, the line changed since and
+ *  the suggestion is shown stale), `proposed` is the replacement. Accept overwrites the beat's say text;
+ *  both accept and reject set `resolved` (archived) + `outcome` (a light audit trail). Stored in the
+ *  authoring shard, never in the flow text, so downstream tools ignore it.
+ *
+ *  Beyond the text, a suggestion may also propose a new speaker, a new direction, or cutting the beat
+ *  (the editable-script handoff, design/proposals/editable-script-handoff.md). Each such part carries its
+ *  own baseline, so each is stale-checked on its own; accept applies whichever parts are present. A
+ *  suggestion that only changes the speaker or direction, or only cuts, keeps `proposed` equal to
+ *  `baseline`. */
 interface Suggestion {
     id: string;
     /** The say/prose beat's stable id. */
@@ -670,12 +677,36 @@ interface Suggestion {
     baseline: string;
     /** The proposed replacement say text. */
     proposed: string;
+    /** The primary author: with several (`authors`), the one with the most changes. */
     author: string;
+    /** Everyone whose changes this suggestion carries, when there is more than one (an editor's file with
+     *  several people's tracked changes on one line). `author` stays the primary, so a reader that only
+     *  knows `author` keeps working. */
+    authors?: string[];
     ts: string;
+    /** A proposed new speaker (a known cast member's name), and the speaker when suggested. */
+    proposedCharacter?: string;
+    baselineCharacter?: string;
+    /** A proposed new direction (the parenthetical), and the direction when suggested ("" for none). */
+    proposedDirection?: string;
+    baselineDirection?: string;
+    /** A proposal to cut the beat (an editor emptied its line). Accept marks it cut. */
+    proposedCut?: boolean;
+    /** Where the suggestion came from, when it arrived in an editable-script handoff: the handoff and the
+     *  line's marker in it. Drives the review's "from handoff" filter, and lets a re-import of the same
+     *  handoff replace its still-open suggestions instead of stacking duplicates. */
+    handoff?: SuggestionSource;
     /** Accepted or rejected -> archived (hidden unless "show resolved suggestions" is on). */
     resolved?: boolean;
     outcome?: "accepted" | "rejected";
 }
+/** The handoff a suggestion arrived in (see `Suggestion.handoff`). */
+interface SuggestionSource {
+    /** The handoff's id ("H-7Q2K"). */
+    id: string;
+    /** The line's marker code in that handoff ("K7Q2M"). */
+    marker: string;
+}
 interface EditRecord {
     modifiedAt?: string;
     by?: string;
@@ -725,6 +756,74 @@ interface AuthoringFile {
      */
     rerecord?: Record<string, boolean>;
 }
+declare const HANDOFF_SCHEMA = "patter/handoff@0";
+interface HandoffFile {
+    schema: typeof HANDOFF_SCHEMA;
+    /** "H-7Q2K": shown in the document's page header, so a returned file finds its record. */
+    id: string;
+    createdAt: string;
+    createdBy: string;
+    /** The file format sent. */
+    format: "docx";
+    /** Who it went to, as typed at export (optional). */
+    recipient?: string;
+    /** The scene ids exported, in document order. */
+    range: {
+        scenes: string[];
+    };
+    options: {
+        /** Which notes rode along: a documentation channel name ("editor"), or "all". */
+        notes: string;
+        /** Each line's writing status shown as a tag. */
+        status: boolean;
+        /** A cast page before the script. */
+        cast: boolean;
+    };
+    /** Every editable line, keyed by its marker code ("K7Q2M"). */
+    lines: Record<string, HandoffLine>;
+    /** The whole document in order: context rows tied to the node they describe, and each editable line
+     *  by marker. Lets the importer align what came back with what was sent, and anchor a comment made on
+     *  a context row to its node. */
+    skeleton: HandoffRow[];
+    /** One entry per reimport, appended. */
+    imports?: HandoffImport[];
+    /** Set when the handoff is finished with; a closed handoff no longer appears in review filters. */
+    closed?: boolean;
+}
+/** An editable line as sent. */
+interface HandoffLine {
+    /** The beat id (a line, a narration beat, or an option prompt). */
+    id: string;
+    kind: "line" | "narration" | "option";
+    /** The speaker and direction as sent (spoken lines only). */
+    character?: string;
+    direction?: string;
+    /** The text as sent: the baseline for every comparison on reimport. */
+    baseline: string;
+}
+/** One row of the sent document, in order. */
+type HandoffRow = {
+    kind: "box";
+    marker: string;
+} | {
+    kind: "scene" | "block" | "condition" | "group" | "else" | "jump" | "gameEvent" | "note";
+    node: string;
+    text: string;
+};
+/** A record of one reimport. */
+interface HandoffImport {
+    at: string;
+    by: string;
+    /** SHA-256 of the returned file, so a second import of the same file is recognisable. */
+    fileHash: string;
+    counts: {
+        changed: number;
+        unchanged: number;
+        stale: number;
+        comments: number;
+        problems: number;
+    };
+}
 /** A compiled expression envelope: canonical source + pre-derived tagged-tuple AST. */
 interface Expression {
     src: string;
@@ -918,6 +1017,12 @@ interface FlowCursor {
     /** The chosen option owning a prompt still to be replayed (a save taken between choose + advance).
      *  Optional / null in older saves -> no pending prompt. */
     pendingPromptOwnerId?: string | null;
+    /** The prompt still to be replayed, exactly as the choice SHOWED it (text and speaker fields, the same
+     *  shape as a saved option's `prompt`), so the replay after a load says what the player saw. Written only
+     *  alongside a `pendingPromptOwnerId` (the choose -> advance window, with `replayPromptOnChoose`), and
+     *  absent otherwise. A save without it (written before Patterplay 0.18.0) resolves the owner's prompt beat
+     *  when it is delivered, as before. */
+    pendingPrompt?: SavedChoicePrompt;
     /** This flow's (non-shared) selector cursors, keyed by group id. */
     selectors: Record<string, SelectorSnapshot>;
 }
@@ -963,4 +1068,4 @@ interface SaveGameV2 {
     flows: Record<string, FlowSnapshotV2>;
 }
 
-export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, 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_RECORDING_STATUSES, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowSnapshotV2, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, type LineBeat, type LocaleFile, PROJECT_LOCALE_SCENE, type ProjectDictionary, type ProjectFile, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, type SaveEnvelope, type SaveGame, type SaveGameV2, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type StackFrame, type Suggestion, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };
+export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, 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_RECORDING_STATUSES, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowSnapshotV2, 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, type LineBeat, type LocaleFile, PROJECT_LOCALE_SCENE, type ProjectDictionary, type ProjectFile, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, type SaveEnvelope, type SaveGame, type SaveGameV2, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type StackFrame, type Suggestion, type SuggestionSource, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };

package/dist/index.d.ts

@@ -417,8 +417,9 @@ interface DocumentationClass {
     /**
      * Export channels this class flows to: a list of channel names, or `"*"` for
      * all. Omitted/empty = editor-only (e.g. "writing"). Built-in channels: `vo`
-     * (voice-recording scripts), `loc` (localisation handoff); studios add their
-     * own (e.g. `sfx`, `art`), carried now and picked up when that export exists.
+     * (voice-recording scripts), `loc` (localisation handoff), `editor` (the editable
+     * script handed to an outside editor); studios add their own (e.g. `sfx`, `art`),
+     * carried now and picked up when that export exists.
      */
     deliver?: string[] | "*";
 }
@@ -656,12 +657,18 @@ interface Comment {
     resolved?: boolean;
     messages: CommentMessage[];
 }
-/** A "suggest a rewrite" proposal for a single say/prose beat (review flow, design/proposals/
- *  suggest-rewrite.md). Whole-beat anchored: `baseline` is the say text WHEN suggested (the "before" +
- *  the drift detector - if it no longer matches the live text, the line changed since and the suggestion
- *  is shown stale), `proposed` is the replacement. Accept overwrites the beat's say text; both accept and
- *  reject set `resolved` (archived) + `outcome` (a light audit trail). Stored in the authoring shard,
- *  never in the flow text, so downstream tools ignore it. */
+/** A "suggest a rewrite" proposal for a single say/prose beat or option prompt (review flow,
+ *  design/proposals/suggest-rewrite.md). Whole-beat anchored: `baseline` is the say text WHEN suggested
+ *  (the "before" + the drift detector - if it no longer matches the live text, the line changed since and
+ *  the suggestion is shown stale), `proposed` is the replacement. Accept overwrites the beat's say text;
+ *  both accept and reject set `resolved` (archived) + `outcome` (a light audit trail). Stored in the
+ *  authoring shard, never in the flow text, so downstream tools ignore it.
+ *
+ *  Beyond the text, a suggestion may also propose a new speaker, a new direction, or cutting the beat
+ *  (the editable-script handoff, design/proposals/editable-script-handoff.md). Each such part carries its
+ *  own baseline, so each is stale-checked on its own; accept applies whichever parts are present. A
+ *  suggestion that only changes the speaker or direction, or only cuts, keeps `proposed` equal to
+ *  `baseline`. */
 interface Suggestion {
     id: string;
     /** The say/prose beat's stable id. */
@@ -670,12 +677,36 @@ interface Suggestion {
     baseline: string;
     /** The proposed replacement say text. */
     proposed: string;
+    /** The primary author: with several (`authors`), the one with the most changes. */
     author: string;
+    /** Everyone whose changes this suggestion carries, when there is more than one (an editor's file with
+     *  several people's tracked changes on one line). `author` stays the primary, so a reader that only
+     *  knows `author` keeps working. */
+    authors?: string[];
     ts: string;
+    /** A proposed new speaker (a known cast member's name), and the speaker when suggested. */
+    proposedCharacter?: string;
+    baselineCharacter?: string;
+    /** A proposed new direction (the parenthetical), and the direction when suggested ("" for none). */
+    proposedDirection?: string;
+    baselineDirection?: string;
+    /** A proposal to cut the beat (an editor emptied its line). Accept marks it cut. */
+    proposedCut?: boolean;
+    /** Where the suggestion came from, when it arrived in an editable-script handoff: the handoff and the
+     *  line's marker in it. Drives the review's "from handoff" filter, and lets a re-import of the same
+     *  handoff replace its still-open suggestions instead of stacking duplicates. */
+    handoff?: SuggestionSource;
     /** Accepted or rejected -> archived (hidden unless "show resolved suggestions" is on). */
     resolved?: boolean;
     outcome?: "accepted" | "rejected";
 }
+/** The handoff a suggestion arrived in (see `Suggestion.handoff`). */
+interface SuggestionSource {
+    /** The handoff's id ("H-7Q2K"). */
+    id: string;
+    /** The line's marker code in that handoff ("K7Q2M"). */
+    marker: string;
+}
 interface EditRecord {
     modifiedAt?: string;
     by?: string;
@@ -725,6 +756,74 @@ interface AuthoringFile {
      */
     rerecord?: Record<string, boolean>;
 }
+declare const HANDOFF_SCHEMA = "patter/handoff@0";
+interface HandoffFile {
+    schema: typeof HANDOFF_SCHEMA;
+    /** "H-7Q2K": shown in the document's page header, so a returned file finds its record. */
+    id: string;
+    createdAt: string;
+    createdBy: string;
+    /** The file format sent. */
+    format: "docx";
+    /** Who it went to, as typed at export (optional). */
+    recipient?: string;
+    /** The scene ids exported, in document order. */
+    range: {
+        scenes: string[];
+    };
+    options: {
+        /** Which notes rode along: a documentation channel name ("editor"), or "all". */
+        notes: string;
+        /** Each line's writing status shown as a tag. */
+        status: boolean;
+        /** A cast page before the script. */
+        cast: boolean;
+    };
+    /** Every editable line, keyed by its marker code ("K7Q2M"). */
+    lines: Record<string, HandoffLine>;
+    /** The whole document in order: context rows tied to the node they describe, and each editable line
+     *  by marker. Lets the importer align what came back with what was sent, and anchor a comment made on
+     *  a context row to its node. */
+    skeleton: HandoffRow[];
+    /** One entry per reimport, appended. */
+    imports?: HandoffImport[];
+    /** Set when the handoff is finished with; a closed handoff no longer appears in review filters. */
+    closed?: boolean;
+}
+/** An editable line as sent. */
+interface HandoffLine {
+    /** The beat id (a line, a narration beat, or an option prompt). */
+    id: string;
+    kind: "line" | "narration" | "option";
+    /** The speaker and direction as sent (spoken lines only). */
+    character?: string;
+    direction?: string;
+    /** The text as sent: the baseline for every comparison on reimport. */
+    baseline: string;
+}
+/** One row of the sent document, in order. */
+type HandoffRow = {
+    kind: "box";
+    marker: string;
+} | {
+    kind: "scene" | "block" | "condition" | "group" | "else" | "jump" | "gameEvent" | "note";
+    node: string;
+    text: string;
+};
+/** A record of one reimport. */
+interface HandoffImport {
+    at: string;
+    by: string;
+    /** SHA-256 of the returned file, so a second import of the same file is recognisable. */
+    fileHash: string;
+    counts: {
+        changed: number;
+        unchanged: number;
+        stale: number;
+        comments: number;
+        problems: number;
+    };
+}
 /** A compiled expression envelope: canonical source + pre-derived tagged-tuple AST. */
 interface Expression {
     src: string;
@@ -918,6 +1017,12 @@ interface FlowCursor {
     /** The chosen option owning a prompt still to be replayed (a save taken between choose + advance).
      *  Optional / null in older saves -> no pending prompt. */
     pendingPromptOwnerId?: string | null;
+    /** The prompt still to be replayed, exactly as the choice SHOWED it (text and speaker fields, the same
+     *  shape as a saved option's `prompt`), so the replay after a load says what the player saw. Written only
+     *  alongside a `pendingPromptOwnerId` (the choose -> advance window, with `replayPromptOnChoose`), and
+     *  absent otherwise. A save without it (written before Patterplay 0.18.0) resolves the owner's prompt beat
+     *  when it is delivered, as before. */
+    pendingPrompt?: SavedChoicePrompt;
     /** This flow's (non-shared) selector cursors, keyed by group id. */
     selectors: Record<string, SelectorSnapshot>;
 }
@@ -963,4 +1068,4 @@ interface SaveGameV2 {
     flows: Record<string, FlowSnapshotV2>;
 }
 
-export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, 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_RECORDING_STATUSES, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowSnapshotV2, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, type LineBeat, type LocaleFile, PROJECT_LOCALE_SCENE, type ProjectDictionary, type ProjectFile, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, type SaveEnvelope, type SaveGame, type SaveGameV2, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type StackFrame, type Suggestion, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };
+export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, 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_RECORDING_STATUSES, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowSnapshotV2, 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, type LineBeat, type LocaleFile, PROJECT_LOCALE_SCENE, type ProjectDictionary, type ProjectFile, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, type SaveEnvelope, type SaveGame, type SaveGameV2, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type StackFrame, type Suggestion, type SuggestionSource, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };

package/dist/index.js

@@ -66,13 +66,16 @@ var DEFAULT_DOCUMENTATION_CLASSES = [
   // every export, and (like all) the editor
   { name: "vo", deliver: ["vo"] },
   // voice-recording scripts
-  { name: "loc", deliver: ["loc"] }
+  { name: "loc", deliver: ["loc"] },
   // localisation handoff
+  { name: "editor", deliver: ["editor"] }
+  // the editable script handed to an outside editor
 ];
 var PROJECT_LOCALE_SCENE = "@project";
 function castStringKey(name) {
   return `cast:${name}`;
 }
+var HANDOFF_SCHEMA = "patter/handoff@0";
 var DEFAULT_CAPTION_DELIMITERS = { open: "[", close: "]" };
 var DEFAULT_CAPTION_CHARACTER = "SFX";
 var SAVE_SCHEMA = "patter/save@0";
@@ -84,6 +87,7 @@ export {
   DEFAULT_DOCUMENTATION_CLASSES,
   DEFAULT_RECORDING_STATUSES,
   DEFAULT_WRITING_STATUSES,
+  HANDOFF_SCHEMA,
   PROJECT_LOCALE_SCENE,
   RERECORD_STATUS,
   RERECORD_STATUS_DECL,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patterkit/model",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Patter data-model types: source (scene/block/group/snippet/beat/jump), project, locale, authoring. The shape source-of-truth.",
   "type": "module",
   "license": "MIT",