brand-intent 0.33.0 → 0.35.0

package/package.json

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

package/parser/brandParser.ts

@@ -138,6 +138,8 @@ export interface ParsedPhotoLookDef {
   duotone?: { shadow: string; highlight: string };
   /** Keys the person cannot change. All others are starting values. */
   fixed: PhotoLookKey[];
+  /** Darkest a gradient under light text on a photo may get, 0..100 (%). Absent → no scrim. */
+  scrim?: number;
 }
 
 export interface ParsedCameraDef {
@@ -1973,7 +1975,7 @@ export function parseBrandFile(content: string, fileName: string): ParsedBrand {
   if (photoLookDeclared) {
     const keys: PhotoLookKey[] = ['saturation', 'contrast', 'warmth', 'fade', 'mono', 'duotone'];
     for (const [key, { line }] of Object.entries(photoLookRaw)) {
-      if (key !== 'fixed' && !keys.includes(key as PhotoLookKey)) throw new Error(`${fileName}:${line}: unknown photo-look property "${key}"`);
+      if (key !== 'fixed' && key !== 'scrim' && !keys.includes(key as PhotoLookKey)) throw new Error(`${fileName}:${line}: unknown photo-look property "${key}"`);
     }
     const int = (key: string, min: number, max: number): number => {
       const p = photoLookRaw[key];
@@ -2021,6 +2023,14 @@ export function parseBrandFile(content: string, fileName: string): ParsedBrand {
         look.fixed.push(key as PhotoLookKey);
       }
     }
+    const scrim = photoLookRaw['scrim'];
+    if (scrim) {
+      const m = /^(\d+)%$/.exec(scrim.value);
+      if (!m || Number(m[1]) < 1 || Number(m[1]) > 100) {
+        throw new Error(`${fileName}:${scrim.line}: photo-look scrim must be a percentage from 1% to 100%, got "${scrim.value}"`);
+      }
+      look.scrim = Number(m[1]);
+    }
     result.photoLook = look;
   }
 

package/parser/purposeParser.ts

@@ -43,6 +43,8 @@ export interface ParsedPurpose {
   camera?: boolean;
   /** `camera: front | rear` — overrides the brand's camera facing for this purpose. */
   cameraFacing?: 'front' | 'rear';
+  /** `scrim: none`: no scrim under this purpose's text, whatever the brand declares. */
+  scrim?: 'none';
   /** `framing: <id>` — the brand framing module photos for this purpose are shot in. */
   framing?: string;
   /** `goal: <id>` — the identity goal this purpose serves by default. */
@@ -183,6 +185,7 @@ export function parsePurposeFile(content: string, fileName: string): ParsedPurpo
   let illustrations: string[] | undefined;
   let camera: boolean | undefined;
   let cameraFacing: 'front' | 'rear' | undefined;
+  let scrim: 'none' | undefined;
   let framing: string | undefined;
   let goal: string | undefined;
   let analyze: boolean | undefined;
@@ -442,6 +445,14 @@ export function parsePurposeFile(content: string, fileName: string): ParsedPurpo
       continue;
     }
 
+    // No scrim for this purpose
+    if (line.startsWith('scrim:')) {
+      const value = line.slice(6).trim();
+      if (value !== 'none') throw new Error(`${fileName}:${lineNum}: invalid scrim "${value}" (expected none; how dark is the brand's photo-look scrim)`);
+      scrim = 'none';
+      continue;
+    }
+
     // Camera control
     if (line.startsWith('camera:')) {
       const value = line.slice(7).trim();
@@ -832,7 +843,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, illustrations, 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, ...(scrim ? { scrim } : {}), 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

@@ -40,6 +40,8 @@ export interface ParsedStory {
   format: string;
   /** Story topic: what the whole story is about, one sentence. */
   topic?: string;
+  /** `scrim: none`: no scrim under the story's text, whatever the brand and purposes declare. */
+  scrim?: 'none';
   pages: ParsedStoryPage[];
   /** Example fills for the open slots, one story topic each. */
   examples: ParsedStoryExample[];
@@ -93,6 +95,7 @@ export function parseStoryFile(content: string, fileName: string): ParsedStory {
   let description = '';
   let format = '';
   let topic: string | undefined;
+  let scrim: 'none' | undefined;
   const pages: (ParsedStoryPage & { line: number; keys: Set<string> })[] = [];
   const examples: (ParsedStoryExample & { line: number })[] = [];
 
@@ -200,6 +203,11 @@ export function parseStoryFile(content: string, fileName: string): ParsedStory {
         else topic = value;
         continue;
       }
+      if (key === 'scrim') {
+        if (value !== 'none') throw new Error(`${fileName}:${lineNum}: invalid scrim "${value}" (expected none; how dark is the brand's photo-look scrim)`);
+        scrim = 'none';
+        continue;
+      }
       throw new Error(`${fileName}:${lineNum}: unexpected "${line}"`);
     }
 
@@ -279,6 +287,7 @@ export function parseStoryFile(content: string, fileName: string): ParsedStory {
     description,
     format,
     topic,
+    ...(scrim ? { scrim } : {}),
     pages: pages.map(({ line: _line, keys: _keys, ...p }) => p),
     examples: examples.map(({ line: _line, ...ex }) => ({
       ...ex,

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

@@ -117,7 +117,7 @@
       }
     },
     "camera-field": {
-      "match": "^(camera:)\\s+(true|false|front|rear)",
+      "match": "^(camera:|scrim:)\\s+(true|false|front|rear|none)",
       "captures": {
         "1": { "name": "keyword.control.brand-intent-purpose" },
         "2": { "name": "constant.language.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:|illustration:|camera:|framing:|goal:|analyze:|bg-prompt:|context|slot|example)(?=\\s|$)",
+          "match": "^(id:|name:|compositions:|density:|defaultIcon:|scope|voice|palette:|logo:|photo:|video:|illustration:|camera:|scrim:|framing:|goal:|analyze:|bg-prompt:|context|slot|example)(?=\\s|$)",
           "captures": {
             "1": { "name": "keyword.control.brand-intent-purpose" }
           }

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

@@ -17,7 +17,7 @@
       "name": "comment.line.number-sign.brand-intent-story"
     },
     "top-field": {
-      "match": "^(id:|format:)\\s+(.*)",
+      "match": "^(id:|format:|scrim:)\\s+(.*)",
       "captures": {
         "1": { "name": "keyword.control.brand-intent-story" },
         "2": { "name": "entity.name.type.brand-intent-story" }
@@ -60,7 +60,7 @@
       "comment": "Fallback: color the keyword token on incomplete lines (while typing)",
       "patterns": [
         {
-          "match": "^(id:|name:|format:|topic:|page|example)(?=\\s|$)",
+          "match": "^(id:|name:|format:|topic:|scrim:|page|example)(?=\\s|$)",
           "captures": {
             "1": { "name": "keyword.control.brand-intent-story" }
           }