@openpresentation/opf 0.2.2 → 0.4.0

package/dist/examples.d.ts

@@ -0,0 +1,43 @@
+import { P as Presentation } from './presentation-BjP4yTQ1.js';
+
+interface ExampleRecord {
+    /** Filename slug, without the `.opf.json` suffix. */
+    readonly slug: string;
+    /** Path relative to the repo root, with forward slashes. */
+    readonly file: string;
+    /** Top-level examples/<category> bucket (`gallery`, `technical`, …). */
+    readonly category: string;
+    /** Gallery slug when the example lives under `examples/gallery/<slug>/`; otherwise `null`. */
+    readonly gallery: string | null;
+    /** Parsed OPF document. Validated against `presentation.schema.json` at build time. */
+    readonly deck: Presentation;
+}
+interface GalleryRecord {
+    /** Gallery slug (folder name under `examples/gallery/`). */
+    readonly slug: string;
+    /** Directory path relative to the repo root. */
+    readonly dir: string;
+    /** Lightweight summary of every example deck inside the gallery. */
+    readonly examples: readonly {
+        readonly slug: string;
+        readonly file: string;
+        readonly name: string | null;
+    }[];
+}
+
+/** Every example deck shipped with this release, sorted by file path. */
+declare const examples: readonly ExampleRecord[];
+/** Examples grouped by `examples/gallery/<slug>/` folder. */
+declare const galleries: readonly GalleryRecord[];
+/** Top-level `examples/<category>` buckets present in this release. */
+declare const exampleCategories: readonly string[];
+/** Look up an example deck by slug (the filename without `.opf.json`). */
+declare function getExample(slug: string): ExampleRecord | undefined;
+/** Look up a gallery by slug. */
+declare function getGallery(slug: string): GalleryRecord | undefined;
+/** All examples that belong to a given gallery slug. */
+declare function getExamplesByGallery(slug: string): readonly ExampleRecord[];
+/** All examples that belong to a given top-level category (`gallery`, `technical`, …). */
+declare function getExamplesByCategory(category: string): readonly ExampleRecord[];
+
+export { type ExampleRecord, type GalleryRecord, exampleCategories, examples, galleries, getExample, getExamplesByCategory, getExamplesByGallery, getGallery };