brand-intent 0.31.0 → 0.33.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "brand-intent",
-  "version": "0.31.0",
+  "version": "0.33.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

@@ -117,6 +117,8 @@ export interface ParsedBrand {
   photoLook?: ParsedPhotoLookDef;
   /** Named yearly date windows (`windows` block): name → ranges. Referenced by sample `@name` markers and photo `when:`. */
   windows?: Record<string, DateWindowRange[]>;
+  /** Where the brand is (`location` block). Sky and weather story variables need it. */
+  location?: ParsedLocationDef;
 }
 
 export type PhotoLookKey = 'saturation' | 'contrast' | 'warmth' | 'fade' | 'mono' | 'duotone';
@@ -145,6 +147,15 @@ export interface ParsedCameraDef {
   grid?: { rows: number; cols: number };
 }
 
+export interface ParsedLocationDef {
+  /** Place name, as people say it. */
+  name: string;
+  /** Decimal degrees, north positive. */
+  latitude: number;
+  /** Decimal degrees, east positive. */
+  longitude: number;
+}
+
 export interface ParsedFramingDef {
   id: string;
   /** Display name. Defaults to the id. */
@@ -438,7 +449,7 @@ export function parseBrandFile(content: string, fileName: string): ParsedBrand {
 
   const result: Partial<ParsedBrand> = {};
 
-  type ActiveBlock = 'none' | 'brand-colors' | 'state-colors' | 'color-bounds' | 'color-adherence' | 'color-rules' | 'tones' | 'levels' | 'color-families' | 'theme' | 'spacing' | 'divider' | 'typography' | 'font' | 'logo' | 'photo' | 'video' | 'illustration' | 'label' | 'cta' | 'icons' | 'counter' | 'framing' | 'camera' | 'photo-look' | 'windows';
+  type ActiveBlock = 'none' | 'brand-colors' | 'state-colors' | 'color-bounds' | 'color-adherence' | 'color-rules' | 'tones' | 'levels' | 'color-families' | 'theme' | 'spacing' | 'divider' | 'typography' | 'font' | 'logo' | 'photo' | 'video' | 'illustration' | 'label' | 'cta' | 'icons' | 'counter' | 'framing' | 'camera' | 'photo-look' | 'windows' | 'location';
   let activeBlock: ActiveBlock = 'none';
   let currentThemeName = '';
   let currentDividerName = '';
@@ -498,6 +509,8 @@ export function parseBrandFile(content: string, fileName: string): ParsedBrand {
   let counterDeclared = false;
   const cameraRaw: Record<string, { value: string; line: number }> = {};
   let cameraDeclared = false;
+  const locationRaw: Record<string, { value: string; line: number }> = {};
+  let locationDeclared = false;
   const photoLookRaw: Record<string, { value: string; line: number }> = {};
   let photoLookDeclared = false;
   const windowsRaw: Array<{ name: string; value: string; line: number }> = [];
@@ -947,6 +960,15 @@ export function parseBrandFile(content: string, fileName: string): ParsedBrand {
         cameraRaw[entry.slice(0, colonIdx).trim()] = { value: entry.slice(colonIdx + 1).trim(), line: lineNum };
         continue;
       }
+      if (activeBlock === 'location') {
+        const trimmed = raw.trim();
+        if (trimmed.startsWith('#')) continue;
+        const entry = trimmed.replace(/\s+#.*$/, '');
+        const colonIdx = entry.indexOf(':');
+        if (colonIdx === -1) throw new Error(`${fileName}:${lineNum}: location property must be "KEY: VALUE", got "${trimmed}"`);
+        locationRaw[entry.slice(0, colonIdx).trim()] = { value: entry.slice(colonIdx + 1).trim(), line: lineNum };
+        continue;
+      }
       if (activeBlock === 'photo-look') {
         const trimmed = raw.trim();
         if (trimmed.startsWith('#')) continue;
@@ -1065,6 +1087,14 @@ export function parseBrandFile(content: string, fileName: string): ParsedBrand {
       continue;
     }
 
+    // location — where the brand is (sky and weather variables)
+    if (raw.trim() === 'location') {
+      if (locationDeclared) throw new Error(`${fileName}:${lineNum}: duplicate location block`);
+      locationDeclared = true;
+      activeBlock = 'location';
+      continue;
+    }
+
     // photo-look — photo treatment (saturation)
     if (raw.trim() === 'photo-look') {
       if (photoLookDeclared) throw new Error(`${fileName}:${lineNum}: duplicate photo-look block`);
@@ -1919,6 +1949,26 @@ export function parseBrandFile(content: string, fileName: string): ParsedBrand {
     result.camera = camera;
   }
 
+  // Finalise location
+  if (locationDeclared) {
+    const known = new Set(['name', 'latitude', 'longitude']);
+    for (const [key, { line }] of Object.entries(locationRaw)) {
+      if (!known.has(key)) throw new Error(`${fileName}:${line}: unknown location property "${key}"`);
+    }
+    for (const key of known) {
+      if (!locationRaw[key]?.value) throw new Error(`${fileName}: location needs ${key}:`);
+    }
+    const degrees = (key: 'latitude' | 'longitude', limit: number) => {
+      const { value, line } = locationRaw[key];
+      const n = Number(value);
+      if (!/^-?\d+(\.\d+)?$/.test(value) || Math.abs(n) > limit) {
+        throw new Error(`${fileName}:${line}: location ${key} must be decimal degrees (−${limit} to ${limit}), got "${value}"`);
+      }
+      return n;
+    };
+    result.location = { name: locationRaw['name'].value, latitude: degrees('latitude', 90), longitude: degrees('longitude', 180) };
+  }
+
   // Finalise photo treatment
   if (photoLookDeclared) {
     const keys: PhotoLookKey[] = ['saturation', 'contrast', 'warmth', 'fade', 'mono', 'duotone'];

package/parser/icons.ts

@@ -138,3 +138,10 @@ export function parseListItem(item: string): { icon?: IconRef; text: string } {
   if (!m) return { text: item };
   return { icon: parseIconRef(m[1], `list item "${item}"`), text: m[2] };
 }
+
+/** A `labels: above` list item: `Label: value`, split at the first colon followed by a space. */
+export function splitLabelledItem(text: string): { label?: string; value: string } {
+  const at = text.indexOf(': ');
+  if (at <= 0) return { value: text };
+  return { label: text.slice(0, at).trim(), value: text.slice(at + 2).trim() };
+}

package/parser/index.ts

@@ -29,12 +29,12 @@ export {
   DEFAULT_COLOR_RULES,
 } from './colorSystem';
 export type { ReachConfig, ToneAnchors } from './colorSystem';
-export type { ParsedBrand, ParsedFontDef, ParsedTypographyDef, ParsedDividerDef, BrandColorPrintSpec, ParsedAssetDef, ParsedBadgeStyle, LogoAlign, ParsedCounterDef, CounterFormat, CounterShape, ParsedFramingDef, ParsedCameraDef, ParsedPhotoLookDef, PhotoLookKey } from './brandParser';
+export type { ParsedBrand, ParsedFontDef, ParsedTypographyDef, ParsedDividerDef, BrandColorPrintSpec, ParsedAssetDef, ParsedBadgeStyle, LogoAlign, ParsedCounterDef, CounterFormat, CounterShape, ParsedFramingDef, ParsedCameraDef, ParsedLocationDef, ParsedPhotoLookDef, PhotoLookKey } from './brandParser';
 
 export { parseDateWindowRanges, isInDateWindow, SAMPLE_WINDOW_MARKER } from './dateWindows';
 export type { DateWindowRange } from './dateWindows';
 
-export { parseIconRef, parseIconSource, resolveIconRef, parseListItem, phosphorName, PHOSPHOR_WEIGHTS } from './icons';
+export { parseIconRef, parseIconSource, resolveIconRef, parseListItem, splitLabelledItem, phosphorName, PHOSPHOR_WEIGHTS } from './icons';
 export type { IconRef, IconSource, ParsedIconDef, ResolvedIcon, PhosphorWeight } from './icons';
 export type {
   ColorMode,

package/parser/purposeParser.ts

@@ -6,7 +6,7 @@
  */
 
 import type { SlotId } from './types';
-import { parseIconRef, parseListItem } from './icons';
+import { parseIconRef, parseListItem, splitLabelledItem } from './icons';
 import type { IconRef } from './icons';
 import { SAMPLE_WINDOW_MARKER } from './dateWindows';
 
@@ -105,6 +105,14 @@ export interface ParsedPurposeSlot {
   itemGap?: number;
   /** List layout direction: 'vertical' (default) or 'horizontal'. */
   listDirection?: 'vertical' | 'horizontal';
+  /** Grid columns for a vertical list, filled row by row (list slots only). Default: 1 */
+  listColumns?: number;
+  /** 'above': each item is `Label: value`, the label set small above the value (list slots only). */
+  listLabels?: 'none' | 'above';
+  /** Label size relative to the item text, with `labels: above`. Default: 0.7 */
+  labelSize?: number;
+  /** Line between grid columns (list slots with `columns:` 2 or more). */
+  listDivider?: 'none' | 'hairline';
   /** When false, this slot is locked — users cannot edit it in any mode. Default: true (editable). */
   editable?: boolean;
   typography: {
@@ -210,6 +218,9 @@ export function parsePurposeFile(content: string, fileName: string): ParsedPurpo
       if (s.marker && s.marker !== 'icon') throw new Error(`${fileName}:${lineNum}: slot "${s.id}": iconOnly needs "marker: icon", got "${s.marker}"`);
       s.marker = 'icon';
     }
+    if (s.listColumns && s.listColumns > 1 && s.listDirection === 'horizontal') throw new Error(`${fileName}:${lineNum}: slot "${s.id}": columns needs a vertical list`);
+    if (s.labelSize !== undefined && s.listLabels !== 'above') throw new Error(`${fileName}:${lineNum}: slot "${s.id}": labelSize needs "labels: above"`);
+    if (s.listDivider === 'hairline' && !(s.listColumns && s.listColumns > 1)) throw new Error(`${fileName}:${lineNum}: slot "${s.id}": divider needs "columns:" 2 or more`);
     if (s.defaultIcon && s.marker !== 'icon') throw new Error(`${fileName}:${lineNum}: slot "${s.id}": defaultIcon needs "marker: icon"`);
     if (!s.value && s.samples) {
       // Trailing `@name` window marker, on the sample's first line only
@@ -644,6 +655,30 @@ export function parsePurposeFile(content: string, fileName: string): ParsedPurpo
           currentSlot.listDirection = d;
           continue;
         }
+        if (prop.startsWith('columns:')) {
+          const n = Number(prop.slice(8).trim());
+          if (!Number.isInteger(n) || n < 1 || n > 6) throw new Error(`${fileName}:${lineNum}: invalid columns "${prop.slice(8).trim()}" — must be 1 to 6`);
+          currentSlot.listColumns = n;
+          continue;
+        }
+        if (prop.startsWith('labels:')) {
+          const l = prop.slice(7).trim();
+          if (l !== 'none' && l !== 'above') throw new Error(`${fileName}:${lineNum}: invalid labels "${l}" — must be "none" or "above"`);
+          currentSlot.listLabels = l;
+          continue;
+        }
+        if (prop.startsWith('labelSize:')) {
+          const n = parseFloat(prop.slice(10).trim());
+          if (isNaN(n) || n <= 0 || n > 1) throw new Error(`${fileName}:${lineNum}: invalid labelSize "${prop.slice(10).trim()}" — must be above 0 and at most 1`);
+          currentSlot.labelSize = n;
+          continue;
+        }
+        if (prop.startsWith('divider:')) {
+          const d = prop.slice(8).trim();
+          if (d !== 'none' && d !== 'hairline') throw new Error(`${fileName}:${lineNum}: invalid list divider "${d}" — must be "none" or "hairline"`);
+          currentSlot.listDivider = d;
+          continue;
+        }
         throw new Error(`${fileName}:${lineNum}: unknown list property "${prop}"`);
       }
     }
@@ -828,6 +863,7 @@ function resolveExamples(
           for (const item of text.split('\n')) {
             const { icon } = parseListItem(item);
             if (icon && slot.marker !== 'icon') throw new Error(`${at(slotId)}: slot "${slotId}": item "${item}" names an icon, but the list has no "marker: icon"`);
+            if (slot.listLabels === 'above' && !splitLabelledItem(item).label) throw new Error(`${at(slotId)}: slot "${slotId}": item "${item}" needs a label ("Label: value") for "labels: above"`);
           }
         }
       }

package/parser/storyParser.ts

@@ -13,12 +13,23 @@ import type { ParsedPurpose } from './purposeParser';
 // ── Parsed types ──────────────────────────────────────────────────────────────
 
 /** Placeholders a page text may contain. Implementations resolve them for the story's date. */
-export type StoryVariable = 'weekday' | 'date';
-
-/** Longest resolved form per variable (German and English), used for the `maxLength` check. */
-export const STORY_VARIABLES: Record<StoryVariable, { maxLength: number }> = {
-  weekday: { maxLength: 10 }, // "Donnerstag"
-  date: { maxLength: 13 },    // "30. September"
+export type StoryVariable =
+  | 'weekday' | 'date'
+  | 'sunrise' | 'sunset' | 'day-length' | 'moon'
+  | 'temperature' | 'wind' | 'weather';
+
+/** Longest resolved form per variable (German and English), used for the `maxLength` check.
+ *  `location`: the variable needs the brand's `location` block. */
+export const STORY_VARIABLES: Record<StoryVariable, { maxLength: number; location?: true }> = {
+  weekday: { maxLength: 10 },                       // "Donnerstag"
+  date: { maxLength: 13 },                          // "30. September"
+  sunrise: { maxLength: 8, location: true },        // "12:59 PM"
+  sunset: { maxLength: 8, location: true },
+  'day-length': { maxLength: 15, location: true },  // "16 Std. 59 Min."
+  moon: { maxLength: 20, location: true },          // "abnehmender Halbmond"
+  temperature: { maxLength: 6, location: true },    // "-12 °C"
+  wind: { maxLength: 6, location: true },           // "12 Bft"
+  weather: { maxLength: 13, location: true },       // "teils bewölkt"
 };
 
 export interface ParsedStory {
@@ -282,10 +293,11 @@ export function parseStoryFile(content: string, fileName: string): ParsedStory {
 // ── Cross-file checks ─────────────────────────────────────────────────────────
 
 /** Checks a story against the brand's other files. Returns problems as "file: message";
- *  empty when the story fits. Variables count at their longest form for `maxLength`. */
+ *  empty when the story fits. Variables count at their longest form for `maxLength`.
+ *  `location: false` reports sky and weather variables (the brand has no `location` block). */
 export function checkStory(
   story: ParsedStory,
-  brand: { purposes: ParsedPurpose[]; compositions: string[]; formats: string[]; illustrations?: string[]; photos?: string[] },
+  brand: { purposes: ParsedPurpose[]; compositions: string[]; formats: string[]; illustrations?: string[]; photos?: string[]; location?: boolean },
   fileName: string,
 ): string[] {
   const problems: string[] = [];
@@ -298,6 +310,11 @@ export function checkStory(
       const slot = purpose.slots.find(s => s.id === slotId);
       if (!slot) { say(`${where}: slot "${slotId}" is not declared by purpose "${purpose.id}"`); continue; }
       if (slot.value) { say(`${where}: slot "${slotId}" has a fixed value in purpose "${purpose.id}"`); continue; }
+      if (brand.location === false) {
+        for (const v of new Set(storyTextVariables(text))) {
+          if (STORY_VARIABLES[v as StoryVariable]?.location) say(`${where}: variable "{${v}}" needs a location block in the .brand`);
+        }
+      }
       const longest = text.replace(VARIABLE, (_, v: string) => 'x'.repeat(STORY_VARIABLES[v as StoryVariable]?.maxLength ?? 0));
       const parts = slot.slotType === 'list' ? longest.split('\n') : [longest];
       if (slot.slotType === 'list' && slot.maxItems && parts.length > slot.maxItems) say(`${where}: slot "${slotId}" has ${parts.length} items, maxItems is ${slot.maxItems}`);

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

@@ -458,8 +458,8 @@
       }
     },
     "icons-counter-header": {
-      "comment": "Bare `icons` / `counter` / `camera` / `photo-look` / `windows` block headers.",
-      "match": "^(icons|counter|camera|photo-look|windows)\\s*$",
+      "comment": "Bare `icons` / `counter` / `camera` / `photo-look` / `windows` / `location` block headers.",
+      "match": "^(icons|counter|camera|photo-look|windows|location)\\s*$",
       "captures": {
         "1": { "name": "keyword.control.brand-intent-brand" }
       }
@@ -535,7 +535,7 @@
     },
     "keyword-partial": {
       "comment": "Fallback: color the keyword token on incomplete lines (while typing)",
-      "match": "^(id:|name:|language:|locale:|spacing:|label:|cta:|color-mode:|color-strategy:|color-adherence:|brand-colors|state-colors|color-bounds|color-rules|color-families|theme|divider|font|typography|logo|photo|video|illustration|icons|counter|framing|windows)(?=\\s|$)",
+      "match": "^(id:|name:|language:|locale:|spacing:|label:|cta:|color-mode:|color-strategy:|color-adherence:|brand-colors|state-colors|color-bounds|color-rules|color-families|theme|divider|font|typography|logo|photo|video|illustration|icons|counter|framing|windows|location)(?=\\s|$)",
       "captures": {
         "1": { "name": "keyword.control.brand-intent-brand" }
       }

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

@@ -232,7 +232,7 @@
     },
     "list-property": {
       "comment": "4-space indented properties under type: list blocks",
-      "match": "^\\s{4,}(marker|icons|iconOnly|iconGap|itemGap|maxItems|direction)(:)\\s+(.*)",
+      "match": "^\\s{4,}(marker|icons|iconOnly|iconGap|itemGap|maxItems|direction|columns|labels|labelSize|divider)(:)\\s+(.*)",
       "captures": {
         "1": { "name": "support.type.property-name.brand-intent-purpose" },
         "2": { "name": "punctuation.separator.brand-intent-purpose" },

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

@@ -52,7 +52,7 @@
       }
     },
     "variable": {
-      "comment": "{weekday}, {date} placeholders in page texts",
+      "comment": "{weekday}, {date}, {sunrise} … placeholders in page texts",
       "match": "\\{[a-z][a-z0-9-]*\\}",
       "name": "variable.other.brand-intent-story"
     },