@openpresentation/opf 0.1.0 → 0.2.2

package/dist/previews.d.ts

@@ -0,0 +1,40 @@
+interface LayoutPreviewRecord {
+    /** Layout slug — matches `spec/catalogs/layouts/<id>.json` when available, and otherwise the pptx.gallery extended catalog. */
+    id: string;
+    /** Filename relative to `spec/previews/layouts/`. */
+    file: string;
+    /** UTF-8 byte length of the HTML. */
+    bytes: number;
+}
+interface LayoutPreviewIndex {
+    $schema: string;
+    version: string;
+    description: string;
+    records: readonly LayoutPreviewRecord[];
+}
+/**
+ * Static HTML for a given layout preview. Each snippet is a self-contained
+ * Tailwind-styled fragment intended to fill a 16:9 thumbnail container.
+ *
+ * The CSS variables used by the snippets are:
+ *   --background, --foreground, --card, --muted, --muted-foreground,
+ *   --accent, --border
+ *
+ * Consumers should apply these on a parent element (or import the
+ * pptx.gallery design tokens).
+ */
+declare const layoutPreviews: Readonly<Record<string, string>>;
+/** Catalog index — the list of available preview slugs and metadata. */
+declare const layoutPreviewIndex: LayoutPreviewIndex;
+/** Slugs of every layout that ships an HTML preview, sorted alphabetically. */
+declare const layoutPreviewSlugs: readonly string[];
+/** Whether an HTML preview exists for the given slug. */
+declare function hasLayoutPreview(slug: string): boolean;
+/**
+ * Look up the HTML preview for a layout slug. Returns `undefined` for slugs
+ * with no shipped preview — callers should fall back to a generic renderer in
+ * that case (see `@openpresentation/opf/previews` README).
+ */
+declare function getLayoutPreview(slug: string): string | undefined;
+
+export { type LayoutPreviewIndex, type LayoutPreviewRecord, getLayoutPreview, hasLayoutPreview, layoutPreviewIndex, layoutPreviewSlugs, layoutPreviews };