@patterkit/model 0.2.1 → 0.4.0

package/dist/index.cjs

@@ -29,12 +29,16 @@ __export(index_exports, {
   PROJECT_LOCALE_SCENE: () => PROJECT_LOCALE_SCENE,
   RERECORD_STATUS: () => RERECORD_STATUS,
   RERECORD_STATUS_DECL: () => RERECORD_STATUS_DECL,
+  RESERVED_PROPERTY_NAMES: () => RESERVED_PROPERTY_NAMES,
   castStringKey: () => castStringKey,
   deriveRecordingFolders: () => deriveRecordingFolders,
   effectiveGameId: () => effectiveGameId,
   gameIdify: () => gameIdify,
+  isCaseOnlyPropertyName: () => isCaseOnlyPropertyName,
   isContentlessBeat: () => isContentlessBeat,
   isValidGameId: () => isValidGameId,
+  isValidPropertyName: () => isValidPropertyName,
+  propertyNameify: () => propertyNameify,
   walkNodes: () => walkNodes
 });
 module.exports = __toCommonJS(index_exports);
@@ -58,6 +62,22 @@ function gameIdify(text) {
 function isValidGameId(gameId) {
   return /^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/.test(gameId);
 }
+var RESERVED_PROPERTY_NAMES = ["true", "false", "and", "or", "not"];
+function propertyNameify(text) {
+  const trimmed = text.trim();
+  const deliberateLeading = trimmed.startsWith("_");
+  let out = trimmed.toLowerCase().replace(/['\u2019]/g, "").replace(/[^a-z0-9_]+/g, "_").replace(/_+/g, "_").replace(/^_+|_+$/g, "");
+  if (out === "") return "";
+  if (deliberateLeading || /^[0-9]/.test(out)) out = `_${out}`;
+  if (RESERVED_PROPERTY_NAMES.includes(out)) out = `${out}_`;
+  return out;
+}
+function isValidPropertyName(name) {
+  return /^[a-z_][a-z0-9_]*$/.test(name) && !RESERVED_PROPERTY_NAMES.includes(name);
+}
+function isCaseOnlyPropertyName(name) {
+  return !isValidPropertyName(name) && isValidPropertyName(name.toLowerCase());
+}
 function effectiveGameId(entity) {
   const g = entity.gameId?.trim();
   return g ? g : gameIdify(entity.name);
@@ -119,11 +139,15 @@ var DEFAULT_CAPTION_CHARACTER = "SFX";
   PROJECT_LOCALE_SCENE,
   RERECORD_STATUS,
   RERECORD_STATUS_DECL,
+  RESERVED_PROPERTY_NAMES,
   castStringKey,
   deriveRecordingFolders,
   effectiveGameId,
   gameIdify,
+  isCaseOnlyPropertyName,
   isContentlessBeat,
   isValidGameId,
+  isValidPropertyName,
+  propertyNameify,
   walkNodes
 });

package/dist/index.d.cts

@@ -207,12 +207,27 @@ declare function isContentlessBeat(beat: Beat, hasText: boolean): boolean;
 declare function gameIdify(text: string): string;
 /** A valid authored game id: lowercase alphanumerics + hyphens, no leading / trailing hyphen. */
 declare function isValidGameId(gameId: string): boolean;
+/** The words `@wildwinter/expr` lexes as keywords, so no property may be called one.
+ *  `packages/model/test/property-name-grammar.test.ts` probes the real parser rather
+ *  than trusting this copy. */
+declare const RESERVED_PROPERTY_NAMES: readonly string[];
+/** Coerce a label into a legal property name: lower case, apostrophes dropped, runs of
+ *  anything else to a single underscore, no trailing underscore, an underscore in front
+ *  of a leading digit, one behind a keyword. "" when nothing usable was left. */
+declare function propertyNameify(text: string): string;
+/** Is this a name an expression can actually reach? Lower case letters, digits and
+ *  underscores, not starting with a digit, not a keyword. "" is not a name. */
+declare function isValidPropertyName(name: string): boolean;
+/** True when folding case ALONE would make it legal (`isNight`). The only violation a
+ *  loader may repair without guessing at intent: every reference is folded already, so
+ *  folding the declaration to match changes nothing observable. */
+declare function isCaseOnlyPropertyName(name: string): boolean;
 /** The effective address: the explicit `gameId` if pinned, else derived from `name`. */
 declare function effectiveGameId(entity: {
     gameId?: string;
     name: string;
 }): string;
-type PropertyType = "boolean" | "number" | "string" | "flags" | "enum";
+type PropertyType = "boolean" | "number" | "string" | "flags" | "enum" | "quality";
 interface PropertyDecl {
     name: string;
     type: PropertyType;
@@ -236,6 +251,11 @@ interface PropertyDecl {
     temporary?: boolean;
     /** For enum / flags. */
     values?: string[];
+    /** For quality: the ORDERED ladder of stage names (the shared engine's quality type, expr 0.4.0).
+     *  Ordering operators compare by position in this list and `advance()` steps along it, so the order
+     *  is the meaning - unlike `values`, whose order is presentation only. Default seeds to the first
+     *  stage when no `default` is declared. */
+    stages?: string[];
     /** Free-text author note documenting what this property is for (authoring only; shown as a hint). */
     purpose?: string;
 }
@@ -250,6 +270,8 @@ interface HostScopeDecl {
     name: string;
     type: PropertyType;
     values?: string[];
+    /** For quality: the ordered stage ladder (see `PropertyDecl.stages`). */
+    stages?: string[];
     default?: ScalarValue;
     writable?: boolean;
     /** Free-text author note documenting the property (authoring only; shown as a hint). */
@@ -356,7 +378,7 @@ interface WritingStatusDecl {
     /** Threshold marker: this status and every later one classify as "ready to ship". */
     readyToShip?: boolean;
     /** Theme character-palette slot (0-11) for the per-line status badge / inspector swatch (Patterpad #196).
-     *  A slot (not a hex) so it adapts to light/dark + the reading palettes. Absent = no colour (neutral). */
+     *  A slot (not a hex) so it adapts to light/dark + the colour themes. Absent = no colour (neutral). */
     colour?: number;
 }
 /**
@@ -607,6 +629,17 @@ interface CommentMessage {
     author: string;
     ts: string;
     body: string;
+    /** A TOMBSTONE: the words are gone, the turn in the conversation is not.
+     *
+     *  Removing a reply outright would renumber the argument around it, so what is
+     *  left records who spoke and when, and that they withdrew it. The `body` is
+     *  EMPTIED rather than kept and hidden, because "deleted" has to mean gone from
+     *  a file that lives in version control.
+     *
+     *  This is the one message allowed an empty body: `saveSceneComments` prunes
+     *  empty messages so a cancelled composer leaves nothing behind, and without
+     *  this flag a tombstone would be pruned on the way to disk. */
+    deleted?: boolean;
 }
 /** A sub-text range a comment is pinned to, within its anchor node's say text (#148). Offsets are
  *  character positions over the rendered (plain) source text - inline formatting is marks, not part of
@@ -826,4 +859,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, 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 };
+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, RESERVED_PROPERTY_NAMES, 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, isCaseOnlyPropertyName, isContentlessBeat, isValidGameId, isValidPropertyName, propertyNameify, walkNodes };

package/dist/index.d.ts

@@ -207,12 +207,27 @@ declare function isContentlessBeat(beat: Beat, hasText: boolean): boolean;
 declare function gameIdify(text: string): string;
 /** A valid authored game id: lowercase alphanumerics + hyphens, no leading / trailing hyphen. */
 declare function isValidGameId(gameId: string): boolean;
+/** The words `@wildwinter/expr` lexes as keywords, so no property may be called one.
+ *  `packages/model/test/property-name-grammar.test.ts` probes the real parser rather
+ *  than trusting this copy. */
+declare const RESERVED_PROPERTY_NAMES: readonly string[];
+/** Coerce a label into a legal property name: lower case, apostrophes dropped, runs of
+ *  anything else to a single underscore, no trailing underscore, an underscore in front
+ *  of a leading digit, one behind a keyword. "" when nothing usable was left. */
+declare function propertyNameify(text: string): string;
+/** Is this a name an expression can actually reach? Lower case letters, digits and
+ *  underscores, not starting with a digit, not a keyword. "" is not a name. */
+declare function isValidPropertyName(name: string): boolean;
+/** True when folding case ALONE would make it legal (`isNight`). The only violation a
+ *  loader may repair without guessing at intent: every reference is folded already, so
+ *  folding the declaration to match changes nothing observable. */
+declare function isCaseOnlyPropertyName(name: string): boolean;
 /** The effective address: the explicit `gameId` if pinned, else derived from `name`. */
 declare function effectiveGameId(entity: {
     gameId?: string;
     name: string;
 }): string;
-type PropertyType = "boolean" | "number" | "string" | "flags" | "enum";
+type PropertyType = "boolean" | "number" | "string" | "flags" | "enum" | "quality";
 interface PropertyDecl {
     name: string;
     type: PropertyType;
@@ -236,6 +251,11 @@ interface PropertyDecl {
     temporary?: boolean;
     /** For enum / flags. */
     values?: string[];
+    /** For quality: the ORDERED ladder of stage names (the shared engine's quality type, expr 0.4.0).
+     *  Ordering operators compare by position in this list and `advance()` steps along it, so the order
+     *  is the meaning - unlike `values`, whose order is presentation only. Default seeds to the first
+     *  stage when no `default` is declared. */
+    stages?: string[];
     /** Free-text author note documenting what this property is for (authoring only; shown as a hint). */
     purpose?: string;
 }
@@ -250,6 +270,8 @@ interface HostScopeDecl {
     name: string;
     type: PropertyType;
     values?: string[];
+    /** For quality: the ordered stage ladder (see `PropertyDecl.stages`). */
+    stages?: string[];
     default?: ScalarValue;
     writable?: boolean;
     /** Free-text author note documenting the property (authoring only; shown as a hint). */
@@ -356,7 +378,7 @@ interface WritingStatusDecl {
     /** Threshold marker: this status and every later one classify as "ready to ship". */
     readyToShip?: boolean;
     /** Theme character-palette slot (0-11) for the per-line status badge / inspector swatch (Patterpad #196).
-     *  A slot (not a hex) so it adapts to light/dark + the reading palettes. Absent = no colour (neutral). */
+     *  A slot (not a hex) so it adapts to light/dark + the colour themes. Absent = no colour (neutral). */
     colour?: number;
 }
 /**
@@ -607,6 +629,17 @@ interface CommentMessage {
     author: string;
     ts: string;
     body: string;
+    /** A TOMBSTONE: the words are gone, the turn in the conversation is not.
+     *
+     *  Removing a reply outright would renumber the argument around it, so what is
+     *  left records who spoke and when, and that they withdrew it. The `body` is
+     *  EMPTIED rather than kept and hidden, because "deleted" has to mean gone from
+     *  a file that lives in version control.
+     *
+     *  This is the one message allowed an empty body: `saveSceneComments` prunes
+     *  empty messages so a cancelled composer leaves nothing behind, and without
+     *  this flag a tombstone would be pruned on the way to disk. */
+    deleted?: boolean;
 }
 /** A sub-text range a comment is pinned to, within its anchor node's say text (#148). Offsets are
  *  character positions over the rendered (plain) source text - inline formatting is marks, not part of
@@ -826,4 +859,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, 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 };
+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, RESERVED_PROPERTY_NAMES, 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, isCaseOnlyPropertyName, isContentlessBeat, isValidGameId, isValidPropertyName, propertyNameify, walkNodes };

package/dist/index.js

@@ -19,6 +19,22 @@ function gameIdify(text) {
 function isValidGameId(gameId) {
   return /^[a-z0-9]([a-z0-9-]*[a-z0-9])?$/.test(gameId);
 }
+var RESERVED_PROPERTY_NAMES = ["true", "false", "and", "or", "not"];
+function propertyNameify(text) {
+  const trimmed = text.trim();
+  const deliberateLeading = trimmed.startsWith("_");
+  let out = trimmed.toLowerCase().replace(/['\u2019]/g, "").replace(/[^a-z0-9_]+/g, "_").replace(/_+/g, "_").replace(/^_+|_+$/g, "");
+  if (out === "") return "";
+  if (deliberateLeading || /^[0-9]/.test(out)) out = `_${out}`;
+  if (RESERVED_PROPERTY_NAMES.includes(out)) out = `${out}_`;
+  return out;
+}
+function isValidPropertyName(name) {
+  return /^[a-z_][a-z0-9_]*$/.test(name) && !RESERVED_PROPERTY_NAMES.includes(name);
+}
+function isCaseOnlyPropertyName(name) {
+  return !isValidPropertyName(name) && isValidPropertyName(name.toLowerCase());
+}
 function effectiveGameId(entity) {
   const g = entity.gameId?.trim();
   return g ? g : gameIdify(entity.name);
@@ -79,11 +95,15 @@ export {
   PROJECT_LOCALE_SCENE,
   RERECORD_STATUS,
   RERECORD_STATUS_DECL,
+  RESERVED_PROPERTY_NAMES,
   castStringKey,
   deriveRecordingFolders,
   effectiveGameId,
   gameIdify,
+  isCaseOnlyPropertyName,
   isContentlessBeat,
   isValidGameId,
+  isValidPropertyName,
+  propertyNameify,
   walkNodes
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patterkit/model",
-  "version": "0.2.1",
+  "version": "0.4.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",
@@ -34,6 +34,6 @@
     "build": "tsup src/index.ts --format esm,cjs --dts --clean"
   },
   "dependencies": {
-    "@wildwinter/expr": "^0.3.0"
+    "@wildwinter/expr": "^0.4.0"
   }
 }