@patterkit/model 0.2.0 → 0.2.1

package/dist/index.cjs

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  COMMON_GENDERS: () => COMMON_GENDERS,
   DEFAULT_CAPTION_CHARACTER: () => DEFAULT_CAPTION_CHARACTER,
   DEFAULT_CAPTION_DELIMITERS: () => DEFAULT_CAPTION_DELIMITERS,
   DEFAULT_DOCUMENTATION_CLASSES: () => DEFAULT_DOCUMENTATION_CLASSES,
@@ -61,6 +62,7 @@ function effectiveGameId(entity) {
   const g = entity.gameId?.trim();
   return g ? g : gameIdify(entity.name);
 }
+var COMMON_GENDERS = ["male", "female", "neuter"];
 var DEFAULT_WRITING_STATUSES = [
   { name: "stub", colour: 0 },
   // red
@@ -108,6 +110,7 @@ var DEFAULT_CAPTION_DELIMITERS = { open: "[", close: "]" };
 var DEFAULT_CAPTION_CHARACTER = "SFX";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  COMMON_GENDERS,
   DEFAULT_CAPTION_CHARACTER,
   DEFAULT_CAPTION_DELIMITERS,
   DEFAULT_DOCUMENTATION_CLASSES,

package/dist/index.d.cts

@@ -296,8 +296,15 @@ interface CoverageDriver {
 /** A character's grammatical gender, for localisation. Translators need it to inflect the speaker's own
  *  lines in gendered languages (adjectives, participles, pronouns), which the source text alone often
  *  cannot tell them. Absent means "not specified". Authoring-only: it never reaches the runtime bundle,
- *  but it IS carried into the localisation handoff formats as translator context (spec §14). */
-type GrammaticalGender = "male" | "female" | "neuter";
+ *  but it IS carried into the localisation handoff formats as translator context (spec §14).
+ *
+ *  Free text, not a closed set: real languages need more than three genders (common/utrum, animate/
+ *  inanimate, and so on) and translators name them differently. `COMMON_GENDERS` seeds the editor's
+ *  auto-suggest so the everyday values stay spelled consistently; anything else is still valid. */
+type GrammaticalGender = string;
+/** The everyday grammatical genders the Cast editor offers as auto-suggest defaults. Not exhaustive and
+ *  not enforced - a project may use any string (see `GrammaticalGender`). */
+declare const COMMON_GENDERS: readonly ["male", "female", "neuter"];
 interface CastMember {
     /** Canonical speaker name (matched by a beat's `character`); language-neutral key. */
     name: string;
@@ -819,4 +826,4 @@ declare const DEFAULT_CAPTION_DELIMITERS: CaptionDelimiters;
  *  captions are off). Applies even to a project that pins no `closedCaptions`. */
 declare const DEFAULT_CAPTION_CHARACTER = "SFX";
 
-export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, 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 EstimatingConfig, type Expression, type FlowFile, type FlowNode, 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, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SequenceOptions, type Snippet, 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 EstimatingConfig, type Expression, type FlowFile, type FlowNode, 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, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SequenceOptions, type Snippet, type Suggestion, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };

package/dist/index.d.ts

@@ -296,8 +296,15 @@ interface CoverageDriver {
 /** A character's grammatical gender, for localisation. Translators need it to inflect the speaker's own
  *  lines in gendered languages (adjectives, participles, pronouns), which the source text alone often
  *  cannot tell them. Absent means "not specified". Authoring-only: it never reaches the runtime bundle,
- *  but it IS carried into the localisation handoff formats as translator context (spec §14). */
-type GrammaticalGender = "male" | "female" | "neuter";
+ *  but it IS carried into the localisation handoff formats as translator context (spec §14).
+ *
+ *  Free text, not a closed set: real languages need more than three genders (common/utrum, animate/
+ *  inanimate, and so on) and translators name them differently. `COMMON_GENDERS` seeds the editor's
+ *  auto-suggest so the everyday values stay spelled consistently; anything else is still valid. */
+type GrammaticalGender = string;
+/** The everyday grammatical genders the Cast editor offers as auto-suggest defaults. Not exhaustive and
+ *  not enforced - a project may use any string (see `GrammaticalGender`). */
+declare const COMMON_GENDERS: readonly ["male", "female", "neuter"];
 interface CastMember {
     /** Canonical speaker name (matched by a beat's `character`); language-neutral key. */
     name: string;
@@ -819,4 +826,4 @@ declare const DEFAULT_CAPTION_DELIMITERS: CaptionDelimiters;
  *  captions are off). Applies even to a project that pins no `closedCaptions`. */
 declare const DEFAULT_CAPTION_CHARACTER = "SFX";
 
-export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, 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 EstimatingConfig, type Expression, type FlowFile, type FlowNode, 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, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SequenceOptions, type Snippet, 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 EstimatingConfig, type Expression, type FlowFile, type FlowNode, 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, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SequenceOptions, type Snippet, type Suggestion, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };

package/dist/index.js

@@ -23,6 +23,7 @@ function effectiveGameId(entity) {
   const g = entity.gameId?.trim();
   return g ? g : gameIdify(entity.name);
 }
+var COMMON_GENDERS = ["male", "female", "neuter"];
 var DEFAULT_WRITING_STATUSES = [
   { name: "stub", colour: 0 },
   // red
@@ -69,6 +70,7 @@ function castStringKey(name) {
 var DEFAULT_CAPTION_DELIMITERS = { open: "[", close: "]" };
 var DEFAULT_CAPTION_CHARACTER = "SFX";
 export {
+  COMMON_GENDERS,
   DEFAULT_CAPTION_CHARACTER,
   DEFAULT_CAPTION_DELIMITERS,
   DEFAULT_DOCUMENTATION_CLASSES,

package/package.json

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