@openpresentation/opf 0.2.2 → 0.3.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export { SchemaName, audience, chartType, colorScheme, fontScheme, language, layout, narrative, presentation, purpose, schemaEntries, schemaNames, schemas, socialPlatform, theme, tone } from './schemas.js';
 export { CatalogKind, audiences, catalogEntries, catalogIndexes, catalogKinds, catalogSchemaNames, catalogs, chartTypes, colorSchemes, fontSchemes, languages, layouts, narratives, purposes, socialPlatforms, themes, tones } from './catalogs.js';
-export { O as OPFValidationError, P as Presentation, V as ValidationIssue, a as ValidationResult, b as assertValid, c as assertValidCatalogRecord, d as assertValidPresentation, v as validate, e as validateCatalogRecord, f as validatePresentation } from './validator-MwlR2F56.js';
+export { OPFValidationError, ValidationIssue, ValidationResult, assertValid, assertValidCatalogRecord, assertValidPresentation, validate, validateCatalogRecord, validatePresentation } from './validator.js';
 export { SpecFileEntry, SpecFileKind, SpecFilePath, specFileEntries, specFileKinds, specFilePaths } from './spec-files.js';
 export { LayoutPreviewIndex, LayoutPreviewRecord, getLayoutPreview, hasLayoutPreview, layoutPreviewIndex, layoutPreviewSlugs, layoutPreviews } from './previews.js';
+export { P as Presentation } from './presentation-C8BOK0-5.js';
 export { Audience, ChartType, ColorScheme, FontScheme, Language, Layout, Narrative, Purpose, SocialPlatform, Theme, Tone } from './types.js';

package/dist/index.js

@@ -6338,7 +6338,7 @@ var audiences = [
     "decisionPower": "advisory",
     "attentionBudgetMinutes": 45,
     "recommendedNarratives": [
-      "engineering-update",
+      "status-update",
       "challenge-resolution",
       "innovation",
       "weekly-progress"
@@ -6854,7 +6854,7 @@ var tones = [
       "weekly-progress",
       "status-update",
       "company-intro",
-      "all-hands"
+      "focus"
     ],
     "tags": [
       "internal",
@@ -6924,7 +6924,7 @@ var tones = [
       "challenge-resolution",
       "innovation",
       "conference-talk",
-      "engineering-update"
+      "status-update"
     ],
     "tags": [
       "technical",
@@ -7027,7 +7027,7 @@ var tones = [
       "If you take one thing from this section, take this."
     ],
     "recommendedNarratives": [
-      "all-hands",
+      "focus",
       "company-intro",
       "weekly-progress",
       "performance-review"
@@ -24774,6 +24774,413 @@ var catalogEntries = [
     "yu-gothic.json"
   ], records: fontSchemes, index: catalogIndexes.fontSchemes }
 ];
+
+// src/generated/catalog-ids.ts
+var catalogIds = {
+  audiences: [
+    "executives",
+    "board",
+    "engineering-team",
+    "investors",
+    "customers",
+    "sales-team",
+    "marketing-team",
+    "all-hands",
+    "candidates",
+    "regulators"
+  ],
+  purposes: [
+    "inform",
+    "decide",
+    "align",
+    "persuade",
+    "educate",
+    "report",
+    "pitch",
+    "sell",
+    "plan"
+  ],
+  tones: [
+    "formal",
+    "casual",
+    "inspirational",
+    "technical",
+    "persuasive",
+    "authoritative",
+    "conversational"
+  ],
+  themes: [
+    "bold",
+    "classic",
+    "dark",
+    "minimal"
+  ],
+  layouts: [
+    "blank",
+    "chart-1x",
+    "chart-2x",
+    "chart-3x",
+    "code-1x",
+    "image-1x",
+    "image-2x",
+    "image-3x",
+    "image-bleed",
+    "list-1x",
+    "list-2x",
+    "list-3x",
+    "list-4x",
+    "list-5x",
+    "list-6x",
+    "media-1x",
+    "number-1x",
+    "number-2x",
+    "number-3x",
+    "number-4x",
+    "number-5x",
+    "number-6x",
+    "table-1x",
+    "text-1x",
+    "text-2x",
+    "text-3x",
+    "title",
+    "title-subtitle"
+  ],
+  chartTypes: [
+    "100pct-bullet-bar",
+    "100pct-bullet-bar-2x",
+    "100pct-bullet-bar-3x",
+    "100pct-bullet-column",
+    "100pct-bullet-column-2x",
+    "100pct-bullet-column-3x",
+    "100pct-progress-bar",
+    "100pct-stacked-area-2x",
+    "100pct-stacked-area-3x",
+    "100pct-stacked-bar-2x",
+    "100pct-stacked-bar-3x",
+    "100pct-stacked-column-2x",
+    "100pct-stacked-column-3x",
+    "area",
+    "australia",
+    "bar",
+    "box-and-whisker",
+    "box-and-whisker-2x",
+    "box-and-whisker-3x",
+    "bullet-bar",
+    "bullet-bar-2x",
+    "bullet-bar-3x",
+    "bullet-column",
+    "bullet-column-2x",
+    "bullet-column-3x",
+    "canada",
+    "clustered-bar-2x",
+    "clustered-column",
+    "column",
+    "dot-plot",
+    "dot-plot-2x",
+    "dot-plot-3x",
+    "dot-plot-4x",
+    "dot-plot-5x",
+    "dot-plot-6x",
+    "doughnut",
+    "dumbbell",
+    "filled-radar",
+    "funnel",
+    "histogram",
+    "line",
+    "line-2x",
+    "line-3x",
+    "line-with-high-low",
+    "line-with-high-low-and-markers",
+    "line-with-markers",
+    "line-with-markers-2x",
+    "line-with-markers-3x",
+    "pareto",
+    "pie",
+    "radar",
+    "radar-with-markers",
+    "scatter",
+    "sparkline",
+    "sparkline-2x",
+    "sparkline-3x",
+    "sparkline-4x",
+    "sparkline-5x",
+    "sparkline-6x",
+    "stacked-area-2x",
+    "stacked-area-3x",
+    "stacked-bar-2x",
+    "stacked-bar-3x",
+    "stacked-column-2x",
+    "stacked-column-3x",
+    "stacked-line-2x",
+    "stacked-line-3x",
+    "stacked-line-with-markers-2x",
+    "stacked-line-with-markers-3x",
+    "treemap",
+    "treemap-2x",
+    "treemap-3x",
+    "united-kingdom",
+    "united-states",
+    "waterfall",
+    "world"
+  ],
+  narratives: [
+    "problem-solution",
+    "scqa",
+    "strategic-narrative",
+    "golden-circle",
+    "conference-talk",
+    "transformation-arc",
+    "pitch-deck",
+    "early-startup-pitch",
+    "venture-pitch",
+    "persuasive-sales",
+    "company-intro",
+    "marketing-strategy",
+    "product-launch",
+    "strategic-advisory",
+    "challenge-resolution",
+    "project-proposal",
+    "failure-analysis",
+    "classic-story",
+    "business-narrative",
+    "rags-to-riches",
+    "underdog-victory",
+    "survival-story",
+    "educate",
+    "persuade",
+    "reveal",
+    "justice",
+    "innovation",
+    "focus",
+    "qbr",
+    "business-review",
+    "board-meeting",
+    "weekly-progress",
+    "status-update",
+    "performance-review",
+    "survey-analysis",
+    "trend-analysis",
+    "employee-review",
+    "performance-improvement-plan",
+    "capacity-planning"
+  ],
+  socialPlatforms: [
+    "linkedin",
+    "x",
+    "github",
+    "youtube",
+    "instagram",
+    "facebook",
+    "tiktok",
+    "threads",
+    "mastodon",
+    "bluesky"
+  ],
+  languages: [
+    "afrikaans",
+    "albanian",
+    "amharic",
+    "arabic",
+    "armenian",
+    "aymara",
+    "azerbaijani",
+    "bengali",
+    "berber-latin",
+    "bosnian-latin",
+    "bulgarian",
+    "catalan",
+    "cebuano",
+    "chinese-simplified",
+    "chinese-traditional",
+    "chittagonian",
+    "croatian",
+    "czech",
+    "danish",
+    "dutch",
+    "english",
+    "english-au",
+    "english-ca",
+    "english-gb",
+    "english-in",
+    "english-us",
+    "estonian",
+    "filipino",
+    "finnish",
+    "french",
+    "fulfulde",
+    "galician",
+    "georgian",
+    "german",
+    "greek",
+    "gujarati",
+    "hausa",
+    "hebrew",
+    "hindi",
+    "hungarian",
+    "igbo",
+    "indonesian",
+    "italian",
+    "japanese",
+    "kannada",
+    "kazakh",
+    "khmer",
+    "kinyarwanda",
+    "korean",
+    "kurmanji",
+    "latvian",
+    "lithuanian",
+    "macedonian",
+    "malagasy",
+    "malay",
+    "malayalam",
+    "maori",
+    "marathi",
+    "mongolian",
+    "nepali",
+    "norwegian",
+    "odia",
+    "oromo",
+    "pashto",
+    "persian",
+    "polish",
+    "portuguese",
+    "punjabi-gurmukhi",
+    "punjabi-shahmukhi",
+    "romanian",
+    "russian",
+    "serbian-cyrillic",
+    "serbian-latin",
+    "shona",
+    "slovak",
+    "slovenian",
+    "somali",
+    "spanish",
+    "swahili",
+    "swedish",
+    "tagalog",
+    "tajik",
+    "tamil",
+    "telugu",
+    "thai",
+    "turkish",
+    "ukrainian",
+    "urdu",
+    "uzbek-latin",
+    "vietnamese-quoc-ngu",
+    "xhosa",
+    "yoruba",
+    "zulu"
+  ],
+  colorSchemes: [
+    "black-and-white",
+    "bold-red",
+    "boost",
+    "burnt-orange",
+    "cool-horizon",
+    "corporate-blue",
+    "deep-purple",
+    "forest-green",
+    "golden-yellow",
+    "luxury",
+    "pastel-red",
+    "slate-gray",
+    "steel-blue",
+    "vibes"
+  ],
+  fontSchemes: [
+    "angsana-new",
+    "aparajita",
+    "aptos",
+    "arabic-typesetting",
+    "arial",
+    "batang",
+    "bookman",
+    "calibri",
+    "century-schoolbook",
+    "consolas",
+    "constantia",
+    "courier-new",
+    "daunpenh",
+    "david",
+    "dilleniaupc",
+    "fangsong",
+    "garamond",
+    "gautami",
+    "georgia",
+    "gisha",
+    "grandview",
+    "gungsuh",
+    "impact",
+    "kalinga",
+    "kartika",
+    "khmer-ui",
+    "latha",
+    "lucida-sans",
+    "malgun-gothic",
+    "mangal",
+    "meiryo",
+    "microsoft-jhenghei",
+    "microsoft-yahei",
+    "mingliu",
+    "miriam",
+    "montserrat",
+    "ms-mincho",
+    "nirmala-ui",
+    "noto-naksh-arabic",
+    "noto-nastaliq-urdu",
+    "noto-sans",
+    "noto-sans-arabic",
+    "noto-sans-armenian",
+    "noto-sans-bengali",
+    "noto-sans-devangari",
+    "noto-sans-ethiopic",
+    "noto-sans-georgian",
+    "noto-sans-gujarati",
+    "noto-sans-gurmukhi",
+    "noto-sans-hebrew",
+    "noto-sans-jp",
+    "noto-sans-kannada",
+    "noto-sans-khmer",
+    "noto-sans-kr",
+    "noto-sans-malayalam",
+    "noto-sans-mongolian",
+    "noto-sans-oriya",
+    "noto-sans-sc",
+    "noto-sans-tamil",
+    "noto-sans-tc",
+    "noto-sans-telugu",
+    "noto-sans-thai",
+    "nyala",
+    "open-sans",
+    "pmingliu",
+    "poppins",
+    "pt-serif",
+    "raavi",
+    "raleway",
+    "roboto",
+    "rockwell",
+    "sakkal-majalla",
+    "seaford",
+    "segoe-ui",
+    "segoe-ui-light",
+    "shonar-bangla",
+    "shruti",
+    "simsun",
+    "skeena",
+    "sylfaen",
+    "tahoma",
+    "tenorite",
+    "times-new-roman",
+    "traditional-arabic",
+    "trebuchet-ms",
+    "tunga",
+    "verdana",
+    "vrinda",
+    "yu-gothic"
+  ]
+};
+
+// src/validator.ts
 var OPFValidationError = class extends Error {
   issues;
   result;
@@ -25173,6 +25580,126 @@ function validatePresentationSemantics(value) {
   });
   return issues;
 }
+var bareIdPattern = /^[a-z0-9][a-z0-9-]*$/;
+function inlineCatalogEntry(context, kind) {
+  const catalogsField = context.document.catalogs;
+  if (!isRecord(catalogsField)) {
+    return void 0;
+  }
+  const entry = catalogsField[kind];
+  return isRecord(entry) ? entry : void 0;
+}
+function unknownIdWarning(kind, value, path, context) {
+  if (typeof value !== "string" || !bareIdPattern.test(value)) {
+    return void 0;
+  }
+  if (context) {
+    const entry = inlineCatalogEntry(context, kind);
+    if (entry) {
+      if (Array.isArray(entry.records) && entry.records.some((record) => isRecord(record) && record.id === value)) {
+        return void 0;
+      }
+      if (typeof entry.source === "string") {
+        return void 0;
+      }
+    }
+  }
+  if (catalogIds[kind].includes(value)) {
+    return void 0;
+  }
+  return semanticIssue(path, `unknown ${kind} catalog id '${value}'`, { kind, id: value });
+}
+function referenceObjectWarning(kind, value, path, context) {
+  if (typeof value === "string") {
+    return unknownIdWarning(kind, value, path, context);
+  }
+  if (isRecord(value)) {
+    return unknownIdWarning(kind, value.id, pathFor(path, "id"), context);
+  }
+  return void 0;
+}
+function pushIfDefined(issues, issue) {
+  if (issue) {
+    issues.push(issue);
+  }
+}
+function designReferenceWarnings(design, path, context) {
+  if (!isRecord(design)) {
+    return [];
+  }
+  const issues = [];
+  pushIfDefined(issues, referenceObjectWarning("themes", design.theme, pathFor(path, "theme"), context));
+  pushIfDefined(issues, referenceObjectWarning("colorSchemes", design.colorScheme, pathFor(path, "colorScheme"), context));
+  pushIfDefined(issues, referenceObjectWarning("fontSchemes", design.fontScheme, pathFor(path, "fontScheme"), context));
+  if (isRecord(design.theme)) {
+    const themePath = pathFor(path, "theme");
+    pushIfDefined(issues, referenceObjectWarning("colorSchemes", design.theme.colorScheme, pathFor(themePath, "colorScheme"), context));
+    pushIfDefined(issues, referenceObjectWarning("fontSchemes", design.theme.fontScheme, pathFor(themePath, "fontScheme"), context));
+  }
+  return issues;
+}
+function chartTypeWarnings(payload, path, context) {
+  if (!isRecord(payload)) {
+    return [];
+  }
+  const issues = [];
+  if (isRecord(payload.chart)) {
+    pushIfDefined(issues, unknownIdWarning("chartTypes", payload.chart.type, `${pathFor(path, "chart")}/type`, context));
+  }
+  if (Array.isArray(payload.blocks)) {
+    payload.blocks.forEach((block, index) => {
+      issues.push(...chartTypeWarnings(block, `${pathFor(path, "blocks")}/${index}`, context));
+    });
+  }
+  return issues;
+}
+function presentationReferenceWarnings(value) {
+  if (!isRecord(value) || !Array.isArray(value.slides)) {
+    return [];
+  }
+  const context = { document: value };
+  const issues = [];
+  if (typeof value.narrative === "string") {
+    pushIfDefined(issues, unknownIdWarning("narratives", value.narrative, "/narrative", context));
+  }
+  issues.push(...designReferenceWarnings(value.design, "/design", context));
+  value.slides.forEach((slide, index) => {
+    if (!isRecord(slide)) {
+      return;
+    }
+    const slidePath = `/slides/${index}`;
+    issues.push(...designReferenceWarnings(slide.design, pathFor(slidePath, "design"), context));
+    issues.push(...chartTypeWarnings(slide, slidePath, context));
+    for (const key of Object.keys(slide)) {
+      if (promotedRegionKeySet.has(key)) {
+        issues.push(...chartTypeWarnings(slide[key], pathFor(slidePath, key), context));
+      }
+    }
+  });
+  return issues;
+}
+var catalogCrossLinkFields = {
+  audience: { recommendedNarratives: "narratives", recommendedTones: "tones" },
+  purpose: { recommendedNarratives: "narratives", recommendedTones: "tones" },
+  tone: { recommendedNarratives: "narratives" }
+};
+function catalogCrossLinkWarnings(schemaName, value) {
+  const fields = catalogCrossLinkFields[schemaName];
+  if (!fields || !isRecord(value)) {
+    return [];
+  }
+  const issues = [];
+  for (const [field, kind] of Object.entries(fields)) {
+    const links = value[field];
+    if (!Array.isArray(links)) {
+      continue;
+    }
+    links.forEach((link, index) => {
+      pushIfDefined(issues, unknownIdWarning(kind, link, `${pathFor("/", field)}/${index}`));
+    });
+  }
+  return issues;
+}
 function validateLanguageSemantics(value) {
   if (!isRecord(value)) {
     return [];
@@ -25188,14 +25715,20 @@ function validate(value, schemaOrKind = "presentation") {
   const resolved = resolveValidator(schemaOrKind);
   const valid = resolved.validate(value) === true;
   const errors = valid ? [] : (resolved.validate.errors ?? []).map(toIssue);
+  const warnings = [];
   if (resolved.schemaName === "presentation") {
     errors.push(...validatePresentationSemantics(value));
+    warnings.push(...presentationReferenceWarnings(value));
   } else if (resolved.schemaName === "language") {
     errors.push(...validateLanguageSemantics(value));
   }
+  if (resolved.schemaName) {
+    warnings.push(...catalogCrossLinkWarnings(resolved.schemaName, value));
+  }
   return {
     valid: errors.length === 0,
     errors,
+    warnings,
     schemaName: resolved.schemaName,
     catalogKind: resolved.catalogKind
   };
@@ -25222,6 +25755,12 @@ function assertValidCatalogRecord(kind, value) {
 
 // src/generated/spec-files.ts
 var specFileEntries = [
+  {
+    "path": "README.md",
+    "packagePath": "@openpresentation/opf/spec/README.md",
+    "kind": "spec",
+    "mediaType": "text/markdown"
+  },
   {
     "path": "catalogs/audiences/all-hands.json",
     "packagePath": "@openpresentation/opf/spec/catalogs/audiences/all-hands.json",
@@ -28080,6 +28619,7 @@ var specFileEntries = [
   }
 ];
 var specFilePaths = [
+  "README.md",
   "catalogs/audiences/all-hands.json",
   "catalogs/audiences/board.json",
   "catalogs/audiences/candidates.json",
@@ -28558,10 +29098,10 @@ var specFilePaths = [
   "schemas/tone.schema.json"
 ];
 var specFileKinds = [
+  "spec",
   "catalogRecord",
   "catalogIndex",
   "openapi",
-  "spec",
   "reference",
   "schema"
 ];