@cardanvil/frame-kit 0.2.0

package/dist/schema/frameAssets.d.ts

@@ -0,0 +1,539 @@
+import { z } from "zod";
+/**
+ * Canonical frame color codes: WUBRG, gold (m), artifact (a), colorless (c),
+ * land (l), vehicle (v). Land is always the lowercase "l" — some legacy configs
+ * also shipped an uppercase "L" alias pointing at the same art, but the nested
+ * configs standardize on "l".
+ */
+export declare const FRAME_COLORS: readonly ["w", "u", "b", "r", "g", "m", "a", "c", "l", "v"];
+export declare const FrameColorEnum: z.ZodEnum<{
+    w: "w";
+    u: "u";
+    b: "b";
+    r: "r";
+    g: "g";
+    m: "m";
+    a: "a";
+    c: "c";
+    l: "l";
+    v: "v";
+}>;
+export type FrameColor = z.infer<typeof FrameColorEnum>;
+/** Image URLs keyed by frame color. Every frame family is a (partial) color set. */
+export declare const ColorSetSchema: z.ZodRecord<z.ZodEnum<{
+    w: "w";
+    u: "u";
+    b: "b";
+    r: "r";
+    g: "g";
+    m: "m";
+    a: "a";
+    c: "c";
+    l: "l";
+    v: "v";
+}> & z.core.$partial, z.ZodString>;
+export type ColorSet = z.infer<typeof ColorSetSchema>;
+/**
+ * Scryfall `frame_effects` values that name a specific transform-DFC icon
+ * variant (mirrors `ScryfallFrameEffect`'s `*Dfc` members, plus `fandfc`).
+ */
+export declare const DFC_ICON_EFFECTS: readonly ["convertdfc", "sunmoondfc", "compasslanddfc", "originpwdfc", "mooneldrazidfc", "waxingandwaningmoondfc", "fandfc", "upsidedowndfc"];
+export declare const DfcIconEffectEnum: z.ZodEnum<{
+    convertdfc: "convertdfc";
+    sunmoondfc: "sunmoondfc";
+    compasslanddfc: "compasslanddfc";
+    originpwdfc: "originpwdfc";
+    mooneldrazidfc: "mooneldrazidfc";
+    waxingandwaningmoondfc: "waxingandwaningmoondfc";
+    fandfc: "fandfc";
+    upsidedowndfc: "upsidedowndfc";
+}>;
+export type DfcIconEffect = z.infer<typeof DfcIconEffectEnum>;
+/** DFC icon image URLs keyed by which `frame_effects` variant they render. */
+export declare const DfcIconSetSchema: z.ZodRecord<z.ZodEnum<{
+    convertdfc: "convertdfc";
+    sunmoondfc: "sunmoondfc";
+    compasslanddfc: "compasslanddfc";
+    originpwdfc: "originpwdfc";
+    mooneldrazidfc: "mooneldrazidfc";
+    waxingandwaningmoondfc: "waxingandwaningmoondfc";
+    fandfc: "fandfc";
+    upsidedowndfc: "upsidedowndfc";
+}> & z.core.$partial, z.ZodString>;
+export type DfcIconSet = z.infer<typeof DfcIconSetSchema>;
+/**
+ * Base frames additionally allow "c2" — the hybrid title/type wash used by the
+ * two-color hybrid split rendering. "c2" only ever exists in the base family.
+ */
+export declare const BASE_COLORS: readonly ["w", "u", "b", "r", "g", "m", "a", "c", "l", "v", "c2"];
+export declare const BaseColorEnum: z.ZodEnum<{
+    w: "w";
+    u: "u";
+    b: "b";
+    r: "r";
+    g: "g";
+    m: "m";
+    a: "a";
+    c: "c";
+    l: "l";
+    v: "v";
+    c2: "c2";
+}>;
+export type BaseColor = z.infer<typeof BaseColorEnum>;
+export declare const BaseColorSetSchema: z.ZodRecord<z.ZodEnum<{
+    w: "w";
+    u: "u";
+    b: "b";
+    r: "r";
+    g: "g";
+    m: "m";
+    a: "a";
+    c: "c";
+    l: "l";
+    v: "v";
+    c2: "c2";
+}> & z.core.$partial, z.ZodString>;
+export type BaseColorSet = z.infer<typeof BaseColorSetSchema>;
+/** Legendary-crown asset sets, grouped by variant. */
+export declare const CrownAssetsSchema: z.ZodObject<{
+    base: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    ub: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    nickname: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    nicknameUb: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    nyxInsert: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    nyxInsertUb: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+}, z.core.$strip>;
+export type CrownAssets = z.infer<typeof CrownAssetsSchema>;
+/** Planeswalker ability-icon assets. */
+export declare const PlaneswalkerAssetConfigSchema: z.ZodObject<{
+    plus: z.ZodString;
+    minus: z.ZodString;
+    zero: z.ZodString;
+    separator: z.ZodString;
+    startingLoyalty: z.ZodString;
+    masks: z.ZodOptional<z.ZodObject<{
+        regular: z.ZodOptional<z.ZodString>;
+        tall: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    colorlessNicknameMasks: z.ZodOptional<z.ZodObject<{
+        regular: z.ZodOptional<z.ZodString>;
+        tall: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PlaneswalkerAssetConfig = z.infer<typeof PlaneswalkerAssetConfigSchema>;
+/**
+ * Saga ability badge/divider + per-color chapter banners. Read-ahead cards use
+ * the `bannerTransform`/`bannerTransformMasks` variants. Banner masks live here
+ * (not in `masks`) because they are per-banner-variant art wired straight into
+ * the saga node, never resolved through the layout-mask path.
+ */
+export declare const SagaAssetConfigSchema: z.ZodObject<{
+    badge: z.ZodString;
+    divider: z.ZodString;
+    banner: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    bannerTransform: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    bannerMasks: z.ZodOptional<z.ZodObject<{
+        right: z.ZodString;
+        stripe: z.ZodString;
+    }, z.core.$strip>>;
+    bannerTransformMasks: z.ZodOptional<z.ZodObject<{
+        right: z.ZodString;
+        stripe: z.ZodString;
+    }, z.core.$strip>>;
+    bannerReadAheadMasks: z.ZodOptional<z.ZodObject<{
+        right: z.ZodString;
+        stripe: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SagaAssetConfig = z.infer<typeof SagaAssetConfigSchema>;
+/** The full frame-asset tree for a layout. */
+export declare const FrameAssetsSchema: z.ZodObject<{
+    base: z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+        c2: "c2";
+    }> & z.core.$partial, z.ZodString>;
+    tall: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    land: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    nyx: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    creature: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    pt: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    crown: z.ZodOptional<z.ZodObject<{
+        base: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            w: "w";
+            u: "u";
+            b: "b";
+            r: "r";
+            g: "g";
+            m: "m";
+            a: "a";
+            c: "c";
+            l: "l";
+            v: "v";
+        }> & z.core.$partial, z.ZodString>>;
+        ub: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            w: "w";
+            u: "u";
+            b: "b";
+            r: "r";
+            g: "g";
+            m: "m";
+            a: "a";
+            c: "c";
+            l: "l";
+            v: "v";
+        }> & z.core.$partial, z.ZodString>>;
+        nickname: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            w: "w";
+            u: "u";
+            b: "b";
+            r: "r";
+            g: "g";
+            m: "m";
+            a: "a";
+            c: "c";
+            l: "l";
+            v: "v";
+        }> & z.core.$partial, z.ZodString>>;
+        nicknameUb: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            w: "w";
+            u: "u";
+            b: "b";
+            r: "r";
+            g: "g";
+            m: "m";
+            a: "a";
+            c: "c";
+            l: "l";
+            v: "v";
+        }> & z.core.$partial, z.ZodString>>;
+        nyxInsert: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            w: "w";
+            u: "u";
+            b: "b";
+            r: "r";
+            g: "g";
+            m: "m";
+            a: "a";
+            c: "c";
+            l: "l";
+            v: "v";
+        }> & z.core.$partial, z.ZodString>>;
+        nyxInsertUb: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            w: "w";
+            u: "u";
+            b: "b";
+            r: "r";
+            g: "g";
+            m: "m";
+            a: "a";
+            c: "c";
+            l: "l";
+            v: "v";
+        }> & z.core.$partial, z.ZodString>>;
+    }, z.core.$strip>>;
+    nickname: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    tokenTitle: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    black: z.ZodOptional<z.ZodString>;
+    planeswalker: z.ZodOptional<z.ZodObject<{
+        plus: z.ZodString;
+        minus: z.ZodString;
+        zero: z.ZodString;
+        separator: z.ZodString;
+        startingLoyalty: z.ZodString;
+        masks: z.ZodOptional<z.ZodObject<{
+            regular: z.ZodOptional<z.ZodString>;
+            tall: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        colorlessNicknameMasks: z.ZodOptional<z.ZodObject<{
+            regular: z.ZodOptional<z.ZodString>;
+            tall: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    saga: z.ZodOptional<z.ZodObject<{
+        badge: z.ZodString;
+        divider: z.ZodString;
+        banner: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            w: "w";
+            u: "u";
+            b: "b";
+            r: "r";
+            g: "g";
+            m: "m";
+            a: "a";
+            c: "c";
+            l: "l";
+            v: "v";
+        }> & z.core.$partial, z.ZodString>>;
+        bannerTransform: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            w: "w";
+            u: "u";
+            b: "b";
+            r: "r";
+            g: "g";
+            m: "m";
+            a: "a";
+            c: "c";
+            l: "l";
+            v: "v";
+        }> & z.core.$partial, z.ZodString>>;
+        bannerMasks: z.ZodOptional<z.ZodObject<{
+            right: z.ZodString;
+            stripe: z.ZodString;
+        }, z.core.$strip>>;
+        bannerTransformMasks: z.ZodOptional<z.ZodObject<{
+            right: z.ZodString;
+            stripe: z.ZodString;
+        }, z.core.$strip>>;
+        bannerReadAheadMasks: z.ZodOptional<z.ZodObject<{
+            right: z.ZodString;
+            stripe: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    extendedOverlay: z.ZodOptional<z.ZodString>;
+    dfcIcon: z.ZodOptional<z.ZodString>;
+    dfcIconSet: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        convertdfc: "convertdfc";
+        sunmoondfc: "sunmoondfc";
+        compasslanddfc: "compasslanddfc";
+        originpwdfc: "originpwdfc";
+        mooneldrazidfc: "mooneldrazidfc";
+        waxingandwaningmoondfc: "waxingandwaningmoondfc";
+        fandfc: "fandfc";
+        upsidedowndfc: "upsidedowndfc";
+    }> & z.core.$partial, z.ZodString>>;
+    dfcIconColorSet: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    flipside: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        w: "w";
+        u: "u";
+        b: "b";
+        r: "r";
+        g: "g";
+        m: "m";
+        a: "a";
+        c: "c";
+        l: "l";
+        v: "v";
+    }> & z.core.$partial, z.ZodString>>;
+    lessonIcon: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type FrameAssets = z.infer<typeof FrameAssetsSchema>;
+/**
+ * Section masks the renderer actually reads. `rightHalf` overrides the global
+ * default (`globalMasks.rightHalf`) when a layout ships its own. The legacy
+ * `frame`/`border` mask keys are intentionally absent — nothing reads them.
+ */
+export declare const LayoutMasksSchema: z.ZodObject<{
+    pinlines: z.ZodOptional<z.ZodString>;
+    titleAndType: z.ZodOptional<z.ZodString>;
+    rules: z.ZodOptional<z.ZodString>;
+    noBorder: z.ZodOptional<z.ZodString>;
+    legendary: z.ZodOptional<z.ZodString>;
+    legendaryTransform: z.ZodOptional<z.ZodString>;
+    noBorderTransform: z.ZodOptional<z.ZodString>;
+    rightHalf: z.ZodOptional<z.ZodString>;
+    title: z.ZodOptional<z.ZodString>;
+    type: z.ZodOptional<z.ZodString>;
+    keyword: z.ZodOptional<z.ZodString>;
+    extended: z.ZodOptional<z.ZodString>;
+    topHalf: z.ZodOptional<z.ZodString>;
+    bottomHalf: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type LayoutMasks = z.infer<typeof LayoutMasksSchema>;
+/** Mask names an overlay may reference. `rightHalf` falls back to globalMasks. */
+export type OverlayMaskName = "pinlines" | "titleAndType" | "rules" | "rightHalf" | "title" | "type";
+/**
+ * A structured reference to one frame image. "c2" is valid only in the base
+ * family; land/nyx/tall families use plain frame colors.
+ */
+export type FrameRef = {
+    family: "base";
+    color: FrameColor | "c2";
+} | {
+    family: "land" | "nyx" | "tall" | "creature";
+    color: FrameColor;
+};