brand-intent 0.25.0 → 0.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brand-intent",
-  "version": "0.25.0",
+  "version": "0.26.0",
   "description": "An open file format specification for making brand intent machine-readable.",
   "author": "Christophe Stoll <christophe@stoll.studio>",
   "license": "MIT",

package/parser/purposeParser.ts

@@ -37,6 +37,8 @@ export interface ParsedPurpose {
   defaultPhoto?: string;
   /** Default video asset ID — pre-selects this video on page creation. */
   defaultVideo?: string;
+  /** Illustration ids a new page picks from; a .story page's `illustration:` overrides them. */
+  illustrations?: string[];
   /** When false, hides Take Photo / Upload buttons for this purpose. Default: true. */
   camera?: boolean;
   /** `camera: front | rear` — overrides the brand's camera facing for this purpose. */
@@ -170,6 +172,7 @@ export function parsePurposeFile(content: string, fileName: string): ParsedPurpo
   let defaultLogo: string | undefined;
   let defaultPhoto: string | undefined;
   let defaultVideo: string | undefined;
+  let illustrations: string[] | undefined;
   let camera: boolean | undefined;
   let cameraFacing: 'front' | 'rear' | undefined;
   let framing: string | undefined;
@@ -422,6 +425,12 @@ export function parsePurposeFile(content: string, fileName: string): ParsedPurpo
       continue;
     }
 
+    // Illustrations a new page picks from
+    if (line.startsWith('illustration:')) {
+      illustrations = line.slice(13).split(',').map(id => id.trim()).filter(Boolean);
+      continue;
+    }
+
     // Camera control
     if (line.startsWith('camera:')) {
       const value = line.slice(7).trim();
@@ -788,7 +797,7 @@ export function parsePurposeFile(content: string, fileName: string): ParsedPurpo
 
   const parsedExamples = resolveExamples(examples, slots, legacySamplesLine, fileName, warnings);
 
-  return { id, name, description, preferredCompositions: compositions, slots, density, palette, scope, context, voice, defaultLogo, defaultPhoto, defaultVideo, camera, cameraFacing, framing, goal, analyze, defaultIcon, bgPrompt, examples: parsedExamples, warnings };
+  return { id, name, description, preferredCompositions: compositions, slots, density, palette, scope, context, voice, defaultLogo, defaultPhoto, defaultVideo, illustrations, camera, cameraFacing, framing, goal, analyze, defaultIcon, bgPrompt, examples: parsedExamples, warnings };
 }
 
 /** Validate `example` blocks against the declared slots, or build examples from deprecated slot

package/parser/storyParser.ts

@@ -38,6 +38,8 @@ export interface ParsedStoryPage {
   purpose: string;
   /** Composition id; undefined = the implementation picks one of the purpose's compositions. */
   composition?: string;
+  /** Illustration ids; implementations pick one per story date, the same one every time for that date. */
+  illustrations?: string[];
   /** Page topic: what this page adds to the story. */
   topic?: string;
   /** Fixed slot texts, may contain `{variable}`s. A slot the page doesn't name is open. */
@@ -190,9 +192,10 @@ export function parseStoryFile(content: string, fileName: string): ParsedStory {
     // Page lines (2-space)
     if (currentPage) {
       if (indent !== 2) throw new Error(`${fileName}:${lineNum}: unexpected indent in page (page keys use 2 spaces)`);
-      const read = readKey(line, lineNum, currentPage, ['purpose', 'composition'], true);
+      const read = readKey(line, lineNum, currentPage, ['purpose', 'composition', 'illustration'], true);
       if (read && 'multi' in read) { multiKey = read.multi; multiIndent = 4; }
       else if (read?.key === 'purpose') currentPage.purpose = read.value;
+      else if (read?.key === 'illustration') currentPage.illustrations = read.value.split(',').map(id => id.trim()).filter(Boolean);
       else if (read) currentPage.composition = read.value;
       continue;
     }
@@ -278,7 +281,7 @@ export function parseStoryFile(content: string, fileName: string): ParsedStory {
  *  empty when the story fits. Variables count at their longest form for `maxLength`. */
 export function checkStory(
   story: ParsedStory,
-  brand: { purposes: ParsedPurpose[]; compositions: string[]; formats: string[] },
+  brand: { purposes: ParsedPurpose[]; compositions: string[]; formats: string[]; illustrations?: string[] },
   fileName: string,
 ): string[] {
   const problems: string[] = [];
@@ -308,6 +311,9 @@ export function checkStory(
       if (!brand.compositions.includes(page.composition)) say(`${where}: composition "${page.composition}" does not exist`);
       else if (!purpose.preferredCompositions.includes(page.composition)) say(`${where}: composition "${page.composition}" is not one of purpose "${purpose.id}"'s compositions`);
     }
+    for (const id of page.illustrations ?? []) {
+      if (brand.illustrations && !brand.illustrations.includes(id)) say(`${where}: illustration "${id}" does not exist`);
+    }
     checkTexts(where, purpose, page.texts);
   });
   story.examples.forEach((ex, i) => {

package/vscode-extension/syntaxes/purpose.tmLanguage.json

@@ -110,7 +110,7 @@
       ]
     },
     "asset-field": {
-      "match": "^(logo:|photo:|video:)\\s+([\\w-]+)",
+      "match": "^(logo:|photo:|video:|illustration:)\\s+([\\w, -]+)",
       "captures": {
         "1": { "name": "keyword.control.brand-intent-purpose" },
         "2": { "name": "entity.name.type.brand-intent-purpose" }
@@ -265,7 +265,7 @@
       "comment": "Fallback: color the keyword token on incomplete lines (while typing)",
       "patterns": [
         {
-          "match": "^(id:|name:|compositions:|density:|defaultIcon:|scope|voice|palette:|logo:|photo:|video:|camera:|framing:|goal:|analyze:|bg-prompt:|context|slot|example)(?=\\s|$)",
+          "match": "^(id:|name:|compositions:|density:|defaultIcon:|scope|voice|palette:|logo:|photo:|video:|illustration:|camera:|framing:|goal:|analyze:|bg-prompt:|context|slot|example)(?=\\s|$)",
           "captures": {
             "1": { "name": "keyword.control.brand-intent-purpose" }
           }

package/vscode-extension/syntaxes/story.tmLanguage.json

@@ -37,7 +37,7 @@
       }
     },
     "reference": {
-      "match": "^\\s+(purpose|composition)(:)\\s+([\\w:-]+)",
+      "match": "^\\s+(purpose|composition|illustration)(:)\\s+([\\w:, -]+)",
       "captures": {
         "1": { "name": "support.type.property-name.brand-intent-story" },
         "2": { "name": "punctuation.separator.brand-intent-story" },
@@ -66,7 +66,7 @@
           }
         },
         {
-          "match": "^\\s+(purpose|composition|topic|primary|secondary|detail|meta|cta|label)(?=:|\\s|$)",
+          "match": "^\\s+(purpose|composition|illustration|topic|primary|secondary|detail|meta|cta|label)(?=:|\\s|$)",
           "captures": {
             "1": { "name": "support.type.property-name.brand-intent-story" }
           }