@deckspec/schema 0.1.0 → 0.1.2

package/dist/base.d.ts

@@ -0,0 +1,51 @@
+import { z } from "zod";
+/**
+ * Slide lifecycle state.
+ * Controls whether a slide can be edited, is approved, or locked as a template.
+ */
+export declare const slideStateSchema: z.ZodEnum<["generated", "derived", "approved", "locked"]>;
+export type SlideState = z.infer<typeof slideStateSchema>;
+/**
+ * Deck lifecycle state.
+ * Decks are either active (in use) or archived (shelved).
+ * Separate from slide approval — decks don't need approval.
+ */
+export declare const deckLifecycleSchema: z.ZodEnum<["active", "archived"]>;
+export type DeckLifecycle = z.infer<typeof deckLifecycleSchema>;
+/**
+ * Deck-level metadata.
+ */
+export declare const metaSchema: z.ZodObject<{
+    title: z.ZodString;
+    theme: z.ZodString;
+    state: z.ZodDefault<z.ZodEnum<["active", "archived"]>>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    theme: string;
+    state: "active" | "archived";
+}, {
+    title: string;
+    theme: string;
+    state?: "active" | "archived" | undefined;
+}>;
+export type Meta = z.infer<typeof metaSchema>;
+/**
+ * Slide schema for file-based slides.
+ * Each slide references a file (.html passthrough or pattern name for .tsx SSR).
+ * Pattern slides can include vars validated against the pattern's Zod schema.
+ */
+export declare const slideSchema: z.ZodObject<{
+    file: z.ZodString;
+    state: z.ZodOptional<z.ZodEnum<["generated", "derived", "approved", "locked"]>>;
+    vars: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    file: string;
+    state?: "generated" | "derived" | "approved" | "locked" | undefined;
+    vars?: Record<string, unknown> | undefined;
+}, {
+    file: string;
+    state?: "generated" | "derived" | "approved" | "locked" | undefined;
+    vars?: Record<string, unknown> | undefined;
+}>;
+export type Slide = z.infer<typeof slideSchema>;
+//# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,eAAO,MAAM,gBAAgB,2DAEsC,CAAC;AAEpE,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAE1D;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,mCAEoC,CAAC;AAErE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;EAMrB,CAAC;AAEH,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAE9C;;;;GAIG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;EAStB,CAAC;AAEH,MAAM,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC"}

package/dist/base.js

@@ -0,0 +1,42 @@
+import { z } from "zod";
+/**
+ * Slide lifecycle state.
+ * Controls whether a slide can be edited, is approved, or locked as a template.
+ */
+export const slideStateSchema = z
+    .enum(["generated", "derived", "approved", "locked"])
+    .describe("Slide lifecycle state: generated → approved → locked");
+/**
+ * Deck lifecycle state.
+ * Decks are either active (in use) or archived (shelved).
+ * Separate from slide approval — decks don't need approval.
+ */
+export const deckLifecycleSchema = z
+    .enum(["active", "archived"])
+    .describe("Deck lifecycle: active (in use) or archived (shelved)");
+/**
+ * Deck-level metadata.
+ */
+export const metaSchema = z.object({
+    title: z.string().describe("Deck title displayed on the cover slide"),
+    theme: z.string().describe("Theme name from themes/ directory"),
+    state: deckLifecycleSchema
+        .default("active")
+        .describe("Deck lifecycle state; defaults to active"),
+});
+/**
+ * Slide schema for file-based slides.
+ * Each slide references a file (.html passthrough or pattern name for .tsx SSR).
+ * Pattern slides can include vars validated against the pattern's Zod schema.
+ */
+export const slideSchema = z.object({
+    file: z.string().min(1).describe("Slide file path (.html) or pattern name"),
+    state: slideStateSchema
+        .optional()
+        .describe("Per-slide state override; inherits deck state if omitted"),
+    vars: z
+        .record(z.unknown())
+        .optional()
+        .describe("Variables for pattern slides, validated against pattern schema"),
+});
+//# sourceMappingURL=base.js.map

package/dist/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC;KAC9B,IAAI,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;KACpD,QAAQ,CAAC,sDAAsD,CAAC,CAAC;AAIpE;;;;GAIG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC;KACjC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;KAC5B,QAAQ,CAAC,uDAAuD,CAAC,CAAC;AAIrE;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IACrE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;IAC/D,KAAK,EAAE,mBAAmB;SACvB,OAAO,CAAC,QAAQ,CAAC;SACjB,QAAQ,CAAC,0CAA0C,CAAC;CACxD,CAAC,CAAC;AAIH;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IAC3E,KAAK,EAAE,gBAAgB;SACpB,QAAQ,EAAE;SACV,QAAQ,CAAC,0DAA0D,CAAC;IACvE,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;SACnB,QAAQ,EAAE;SACV,QAAQ,CAAC,gEAAgE,CAAC;CAC9E,CAAC,CAAC"}

package/dist/deck.d.ts

@@ -0,0 +1,57 @@
+import { z } from "zod";
+/**
+ * Deck schema for file-based slides.
+ * Validates structure (meta + slides array with file references).
+ */
+export declare const deckSchema: z.ZodObject<{
+    meta: z.ZodObject<{
+        title: z.ZodString;
+        theme: z.ZodString;
+        state: z.ZodDefault<z.ZodEnum<["active", "archived"]>>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        theme: string;
+        state: "active" | "archived";
+    }, {
+        title: string;
+        theme: string;
+        state?: "active" | "archived" | undefined;
+    }>;
+    slides: z.ZodArray<z.ZodObject<{
+        file: z.ZodString;
+        state: z.ZodOptional<z.ZodEnum<["generated", "derived", "approved", "locked"]>>;
+        vars: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, "strip", z.ZodTypeAny, {
+        file: string;
+        state?: "generated" | "derived" | "approved" | "locked" | undefined;
+        vars?: Record<string, unknown> | undefined;
+    }, {
+        file: string;
+        state?: "generated" | "derived" | "approved" | "locked" | undefined;
+        vars?: Record<string, unknown> | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    meta: {
+        title: string;
+        theme: string;
+        state: "active" | "archived";
+    };
+    slides: {
+        file: string;
+        state?: "generated" | "derived" | "approved" | "locked" | undefined;
+        vars?: Record<string, unknown> | undefined;
+    }[];
+}, {
+    meta: {
+        title: string;
+        theme: string;
+        state?: "active" | "archived" | undefined;
+    };
+    slides: {
+        file: string;
+        state?: "generated" | "derived" | "approved" | "locked" | undefined;
+        vars?: Record<string, unknown> | undefined;
+    }[];
+}>;
+export type Deck = z.infer<typeof deckSchema>;
+//# sourceMappingURL=deck.d.ts.map

package/dist/deck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deck.d.ts","sourceRoot":"","sources":["../src/deck.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;;GAGG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMrB,CAAC;AAEH,MAAM,MAAM,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC"}

package/dist/deck.js

@@ -0,0 +1,14 @@
+import { z } from "zod";
+import { metaSchema, slideSchema } from "./base.js";
+/**
+ * Deck schema for file-based slides.
+ * Validates structure (meta + slides array with file references).
+ */
+export const deckSchema = z.object({
+    meta: metaSchema.describe("Deck metadata (title, theme, state)"),
+    slides: z
+        .array(slideSchema)
+        .min(1)
+        .describe("Ordered list of slides; at least one required"),
+});
+//# sourceMappingURL=deck.js.map

package/dist/deck.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deck.js","sourceRoot":"","sources":["../src/deck.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAEpD;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IACjC,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IAChE,MAAM,EAAE,CAAC;SACN,KAAK,CAAC,WAAW,CAAC;SAClB,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,CAAC,+CAA+C,CAAC;CAC7D,CAAC,CAAC"}

package/dist/elements.d.ts

@@ -0,0 +1,30 @@
+import { z } from "zod";
+export declare const iconSchema: z.ZodString;
+export declare const chartDataPointSchema: z.ZodObject<{
+    label: z.ZodString;
+    value: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    value: number;
+    label: string;
+}, {
+    value: number;
+    label: string;
+}>;
+export type ChartDataPoint = z.infer<typeof chartDataPointSchema>;
+export declare const chartSeriesSchema: z.ZodObject<{
+    name: z.ZodString;
+    color: z.ZodOptional<z.ZodString>;
+    data: z.ZodArray<z.ZodNumber, "many">;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    data: number[];
+    color?: string | undefined;
+}, {
+    name: string;
+    data: number[];
+    color?: string | undefined;
+}>;
+export type ChartSeries = z.infer<typeof chartSeriesSchema>;
+export declare const svgAssetSchema: z.ZodString;
+export declare const imageSchema: z.ZodString;
+//# sourceMappingURL=elements.d.ts.map

package/dist/elements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"elements.d.ts","sourceRoot":"","sources":["../src/elements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,eAAO,MAAM,UAAU,aAGoC,CAAC;AAG5D,eAAO,MAAM,oBAAoB;;;;;;;;;EAG/B,CAAC;AAEH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,eAAO,MAAM,iBAAiB;;;;;;;;;;;;EAI5B,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAG5D,eAAO,MAAM,cAAc,aAG+B,CAAC;AAE3D,eAAO,MAAM,WAAW,aAGoC,CAAC"}

package/dist/elements.js

@@ -0,0 +1,26 @@
+import { z } from "zod";
+// --- Icons ---
+export const iconSchema = z
+    .string()
+    .min(1)
+    .describe("Icon name (e.g. 'rocket', 'ph:shield-check')");
+// --- Charts ---
+export const chartDataPointSchema = z.object({
+    label: z.string().describe("Data point label"),
+    value: z.number().describe("Data point value"),
+});
+export const chartSeriesSchema = z.object({
+    name: z.string().describe("Series name for legend"),
+    color: z.string().optional().describe("Color token name or CSS value"),
+    data: z.array(z.number()).min(1).describe("Data values"),
+});
+// --- Assets ---
+export const svgAssetSchema = z
+    .string()
+    .min(1)
+    .describe("Path to SVG file relative to deck directory");
+export const imageSchema = z
+    .string()
+    .min(1)
+    .describe("Image path (relative to deck) or https:// URL");
+//# sourceMappingURL=elements.js.map

package/dist/elements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"elements.js","sourceRoot":"","sources":["../src/elements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,gBAAgB;AAChB,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACxB,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CAAC,8CAA8C,CAAC,CAAC;AAE5D,iBAAiB;AACjB,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IAC9C,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;CAC/C,CAAC,CAAC;AAIH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;IACnD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACtE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC;CACzD,CAAC,CAAC;AAIH,iBAAiB;AACjB,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CAAC,6CAA6C,CAAC,CAAC;AAE3D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KACzB,MAAM,EAAE;KACR,GAAG,CAAC,CAAC,CAAC;KACN,QAAQ,CAAC,+CAA+C,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { slideStateSchema, type SlideState, deckLifecycleSchema, type DeckLifecycle, metaSchema, type Meta, slideSchema, type Slide, } from "./base.js";
+export { deckSchema, type Deck } from "./deck.js";
+export { describeSchema } from "./utils.js";
+export { iconSchema, chartDataPointSchema, type ChartDataPoint, chartSeriesSchema, type ChartSeries, svgAssetSchema, imageSchema, } from "./elements.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,KAAK,UAAU,EACf,mBAAmB,EACnB,KAAK,aAAa,EAClB,UAAU,EACV,KAAK,IAAI,EACT,WAAW,EACX,KAAK,KAAK,GACX,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,UAAU,EAAE,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,EACL,UAAU,EACV,oBAAoB,EACpB,KAAK,cAAc,EACnB,iBAAiB,EACjB,KAAK,WAAW,EAChB,cAAc,EACd,WAAW,GACZ,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -0,0 +1,5 @@
+export { slideStateSchema, deckLifecycleSchema, metaSchema, slideSchema, } from "./base.js";
+export { deckSchema } from "./deck.js";
+export { describeSchema } from "./utils.js";
+export { iconSchema, chartDataPointSchema, chartSeriesSchema, svgAssetSchema, imageSchema, } from "./elements.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAEhB,mBAAmB,EAEnB,UAAU,EAEV,WAAW,GAEZ,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,UAAU,EAAa,MAAM,WAAW,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,EACL,UAAU,EACV,oBAAoB,EAEpB,iBAAiB,EAEjB,cAAc,EACd,WAAW,GACZ,MAAM,eAAe,CAAC"}

package/dist/utils.d.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+/**
+ * Extracts `.describe()` metadata from each field of a ZodObject schema
+ * into a plain record. Useful for generating documentation or AI prompts
+ * from schema definitions.
+ *
+ * Fields without a description are omitted from the result.
+ *
+ * @example
+ * ```ts
+ * const descriptions = describeSchema(baseSlideSchema);
+ * // { html: 'Freeform HTML content for the slide', ... }
+ * ```
+ */
+export declare function describeSchema(schema: z.ZodObject<z.ZodRawShape>): Record<string, string>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,WAAW,CAAC,GACjC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAYxB"}

package/dist/utils.js

@@ -0,0 +1,25 @@
+/**
+ * Extracts `.describe()` metadata from each field of a ZodObject schema
+ * into a plain record. Useful for generating documentation or AI prompts
+ * from schema definitions.
+ *
+ * Fields without a description are omitted from the result.
+ *
+ * @example
+ * ```ts
+ * const descriptions = describeSchema(baseSlideSchema);
+ * // { html: 'Freeform HTML content for the slide', ... }
+ * ```
+ */
+export function describeSchema(schema) {
+    const shape = schema.shape;
+    const result = {};
+    for (const [key, value] of Object.entries(shape)) {
+        const description = value.description;
+        if (description) {
+            result[key] = description;
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAkC;IAElC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC3B,MAAM,MAAM,GAA2B,EAAE,CAAC;IAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,MAAM,WAAW,GAAI,KAAsB,CAAC,WAAW,CAAC;QACxD,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "@deckspec/schema",
-  "version": "0.1.0",
+  "version": "0.1.2",
+  "files": [
+    "dist",
+    "src"
+  ],
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src",
-    "composite": true
-  },
-  "include": ["src/"]
-}