@openpresentation/opf 0.11.2 → 0.11.3

package/dist/{catalogs-DJ-B5ZyD.d.ts → catalogs-CUClB3nl.d.ts}

@@ -16,6 +16,23 @@ interface Audience {
      * Human-readable audience name shown in pickers.
      */
     name: string;
+    /**
+     * Present when this audience is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated audience record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * One-sentence positioning of the audience — who they are and what they care about.
      */
@@ -89,6 +106,23 @@ interface Purpose {
      * Human-readable purpose name shown in pickers.
      */
     name: string;
+    /**
+     * Present when this purpose is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated purpose record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * One-sentence positioning of the purpose — what this deck is trying to accomplish.
      */
@@ -154,6 +188,23 @@ interface Tone {
      * Human-readable tone name shown in pickers.
      */
     name: string;
+    /**
+     * Present when this tone is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated tone record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * One-sentence positioning of the tone — when to reach for it.
      */
@@ -226,6 +277,23 @@ interface Theme {
      * Human-readable theme name shown in pickers.
      */
     name: string;
+    /**
+     * Present when this theme is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated theme record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * One-sentence positioning of the theme — when to reach for it.
      */
@@ -302,6 +370,23 @@ interface Layout {
      * Human-readable layout name shown in layout pickers.
      */
     name: string;
+    /**
+     * Present when this layout is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated layout record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * One-sentence positioning of the layout — when to reach for it.
      */
@@ -553,6 +638,29 @@ interface ChartType {
         vectorSrc?: string;
         [k: string]: unknown;
     };
+    /**
+     * Publisher extension member, such as the `x-gallery` presentation metadata that pptx.gallery adds to the records it publishes. Engines and validators ignore top-level `x-*` members, and the pinned snapshot in spec/catalogs never carries them.
+     *
+     * This interface was referenced by `ChartType`'s JSON-Schema definition
+     * via the `patternProperty` "^x-".
+     */
+    [k: string]: {
+        [k: string]: unknown;
+    } | "https://openpresentation.org/schema/opf-chart-type/v1" | string | ChartTypeMappings | ChartTypeDeprecation | number | "simple" | "calculated" | "hierarchical" | "normalized" | boolean | string[] | ChartDataColumn[] | ChartSampleData | {
+        /**
+         * Main preview image (PNG/JPG). Used as the primary visual in picker UIs and previews of the record.
+         */
+        src?: string;
+        /**
+         * Smaller thumbnail preview suited to dense grid views.
+         */
+        thumbnailSrc?: string;
+        /**
+         * SVG / vector preview for crisp scaling at any size.
+         */
+        vectorSrc?: string;
+        [k: string]: unknown;
+    } | undefined;
 }
 /**
  * Canonical and optional renderer-specific mappings used by engines to render this chart type.
@@ -729,6 +837,23 @@ interface Narrative {
      * Human-readable template name, e.g. 'Problem → Solution'.
      */
     name: string;
+    /**
+     * Present when this narrative is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated narrative record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * One-sentence description of when and why to use this narrative.
      */
@@ -822,7 +947,7 @@ interface Beat {
 }
 
 /**
- * Schema for social-platform records in the pptx.gallery library. Each record describes a single social-media platform — its base URL, profile-URL pattern, handle prefix, brand color, and themed icons. Records are referenced from OPF documents indirectly: the property keys of any Socials object (Organization.socials, Speaker.socials) match record ids, and renderers use the catalog record to format URLs and pick icons. The engine resolves references against catalogs.socialPlatforms (inline) → catalogs.socialPlatforms.source → the default catalog at https://www.pptx.gallery/social-platforms.
+ * Schema for social-platform records in the pptx.gallery library. Each record describes a single social-media platform — its base URL, profile-URL pattern, handle prefix, brand color, and themed icons. Records are referenced from OPF documents indirectly: the property keys of any Socials object (Organization.socials, Speaker.socials) match record ids, and engines use the catalog record's URL patterns and handle prefix to format and link the profile URL. The brand color and the themed icons are catalog metadata for authoring UIs: engines (opf-render, opf-pptx) render the profile URL, not icons or brand colors. The engine resolves references against catalogs.socialPlatforms (inline) → catalogs.socialPlatforms.source → the default catalog at https://www.pptx.gallery/social-platforms.
  */
 interface SocialPlatform {
     /**
@@ -837,6 +962,23 @@ interface SocialPlatform {
      * Human-readable platform name shown in pickers and footers.
      */
     name: string;
+    /**
+     * Present when this social platform is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated social platform record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * One-sentence positioning of the platform — what it's used for and who's on it.
      */
@@ -866,19 +1008,19 @@ interface SocialPlatform {
      */
     handleExample?: string;
     /**
-     * Brand color (hex) used for branded icon chips, link styling, or section accents.
+     * Brand color (hex) for branded icon chips, link styling, or section accents in authoring UIs. Catalog metadata: engines do not draw it.
      */
     brandColor?: string;
     /**
-     * Default icon source. Accepts an HTTPS URL, data URI, relative path, or asset reference. Used as the fallback when a themed (Light/Dark) variant isn't set.
+     * Default icon source. Accepts an HTTPS URL, data URI, relative path, or asset reference. Used as the fallback when a themed (Light/Dark) variant isn't set. Catalog metadata for authoring UIs: engines do not draw icons.
      */
     icon?: string;
     /**
-     * Light-colored icon variant intended for rendering on dark backgrounds.
+     * Light-colored icon variant intended for authoring UIs that draw the icon on dark backgrounds (engines do not draw icons).
      */
     iconLight?: string;
     /**
-     * Dark-colored icon variant intended for rendering on light backgrounds.
+     * Dark-colored icon variant intended for authoring UIs that draw the icon on light backgrounds (engines do not draw icons).
      */
     iconDark?: string;
     /**
@@ -922,6 +1064,23 @@ interface Language {
      * Human-readable language name.
      */
     name: string;
+    /**
+     * Present when this language is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated language record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * ISO 639-3 (or 639-2) three-letter language code. Carried for engines that prefer ISO codes.
      */
@@ -1001,6 +1160,23 @@ interface ColorScheme {
      * Human-readable scheme name shown in pickers.
      */
     name: string;
+    /**
+     * Present when this color scheme is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated color scheme record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * One-sentence positioning of the palette — what mood it evokes and where to use it.
      */
@@ -1098,6 +1274,23 @@ interface FontScheme {
      * Human-readable scheme name shown in pickers.
      */
     name: string;
+    /**
+     * Present when this font scheme is deprecated, for example an alias kept for backward compatibility. Deprecated records stay resolvable so existing documents keep validating and rendering unchanged, but pickers and default listings exclude them and validators warn when a document references them. Same shape as the chart-type deprecation.
+     */
+    deprecation?: {
+        /**
+         * Id of the non-deprecated font scheme record that documents should reference instead.
+         */
+        replacedBy: string;
+        /**
+         * Why the record is deprecated.
+         */
+        reason?: string;
+        /**
+         * Package version in which the record is scheduled for removal from the bundled catalog, if any.
+         */
+        removal?: string;
+    };
     /**
      * Heading (major) font family — mirrors the OOXML majorFont entry.
      */
@@ -1221,8 +1414,12 @@ interface CatalogIndexRecord {
 /** Parsed shape of a catalog's `index.json`. */
 interface CatalogIndex {
     readonly $schema: string;
+    /** Catalog kind as its default-catalog URL segment, e.g. `chart-types`. */
+    readonly kind?: string;
     readonly version: string;
     readonly description: string;
+    /** SHA-256 of the canonical JSON of the index-ordered records (see docs/default-catalog.md). */
+    readonly contentSha256?: string;
     readonly records: readonly CatalogIndexRecord[];
     readonly [key: string]: unknown;
 }

package/dist/catalogs.d.ts

@@ -1,2 +1,2 @@
-export { a as CatalogEntry, b as CatalogIndex, c as CatalogIndexRecord, C as CatalogKind, d as CatalogRecord, i as audiences, j as catalogEntries, k as catalogIndexes, l as catalogKinds, m as catalogSchemaNames, n as catalogs, o as chartTypes, p as colorSchemes, q as fontSchemes, r as languages, s as layouts, t as narratives, u as purposes, v as socialPlatforms, w as themes, x as tones } from './catalogs-DJ-B5ZyD.js';
+export { a as CatalogEntry, b as CatalogIndex, c as CatalogIndexRecord, C as CatalogKind, d as CatalogRecord, i as audiences, j as catalogEntries, k as catalogIndexes, l as catalogKinds, m as catalogSchemaNames, n as catalogs, o as chartTypes, p as colorSchemes, q as fontSchemes, r as languages, s as layouts, t as narratives, u as purposes, v as socialPlatforms, w as themes, x as tones } from './catalogs-CUClB3nl.js';
 import './schemas-X_NniU4A.js';

package/dist/catalogs.js

@@ -1 +1 @@
-export { audiences, catalogEntries, catalogIndexes, catalogKinds, catalogSchemaNames, catalogs, chartTypes, colorSchemes, fontSchemes, languages, layouts, narratives, purposes, socialPlatforms, themes, tones } from './chunk-7LF37SG3.js';
+export { audiences, catalogEntries, catalogIndexes, catalogKinds, catalogSchemaNames, catalogs, chartTypes, colorSchemes, fontSchemes, languages, layouts, narratives, purposes, socialPlatforms, themes, tones } from './chunk-AEUSVEUY.js';

package/dist/{chunk-K7IWYODS.js → chunk-57NWIYX3.js}

@@ -1,6 +1,6 @@
-import { validatePresentation, validationDefinition, validateCatalogRecord } from './chunk-DJRZMGKY.js';
-import { schemas, schemaEntries } from './chunk-LTSDDBNW.js';
-import { catalogKinds, catalogEntries, catalogSchemaNames } from './chunk-7LF37SG3.js';
+import { validatePresentation, validationDefinition, validateCatalogRecord } from './chunk-JCXHSTSM.js';
+import { schemas, schemaEntries } from './chunk-JTXCMVVP.js';
+import { catalogKinds, catalogEntries, catalogSchemaNames } from './chunk-AEUSVEUY.js';
 import { parseTree, printParseErrorCode, getNodePath } from 'jsonc-parser';
 
 var own = (value, key) => Object.hasOwn(value, key);
@@ -447,7 +447,20 @@ function lintPresentation(document, options = {}) {
     }
   }
   for (const issue of validation.warnings) {
-    const kind = issue.params.kind, id = issue.params.id;
+    const kind = issue.params.kind, id = issue.params.id, replacedBy = issue.params.replacedBy;
+    if (typeof replacedBy === "string" && typeof id === "string") {
+      const target = catalogs.get(kind)?.get(replacedBy);
+      diagnostics.push({
+        ...schemaDiagnostic(issue),
+        ruleId: "opf/deprecated-catalog-id",
+        severity: "warning",
+        message: `Deprecated ${kind} catalog id ${JSON.stringify(id)}; use ${JSON.stringify(replacedBy)} instead.`,
+        help: "The deprecated id still resolves to its original record, so nothing breaks. Switch to the replacement when you next edit this reference.",
+        lookup: ["opf", "catalog", kind],
+        ...target ? { suggestions: [target] } : {}
+      });
+      continue;
+    }
     if (seen.has(issue.path) || typeof id === "string" && catalogs.get(kind)?.has(id))
       continue;
     diagnostics.push({