@cardanvil/frame-kit 0.6.0 → 0.7.0

package/dist/schema/frameAssets.d.ts

@@ -7,13 +7,13 @@ import { z } from "zod";
  */
 export declare const FRAME_COLORS: readonly ["w", "u", "b", "r", "g", "m", "a", "c", "l", "v"];
 export declare const FrameColorEnum: z.ZodEnum<{
+    a: "a";
     w: "w";
     u: "u";
     b: "b";
     r: "r";
     g: "g";
     m: "m";
-    a: "a";
     c: "c";
     l: "l";
     v: "v";
@@ -21,13 +21,13 @@ export declare const FrameColorEnum: z.ZodEnum<{
 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<{
+    a: "a";
     w: "w";
     u: "u";
     b: "b";
     r: "r";
     g: "g";
     m: "m";
-    a: "a";
     c: "c";
     l: "l";
     v: "v";
@@ -67,13 +67,13 @@ export type DfcIconSet = z.infer<typeof DfcIconSetSchema>;
  */
 export declare const BASE_COLORS: readonly ["w", "u", "b", "r", "g", "m", "a", "c", "l", "v", "c2"];
 export declare const BaseColorEnum: z.ZodEnum<{
+    a: "a";
     w: "w";
     u: "u";
     b: "b";
     r: "r";
     g: "g";
     m: "m";
-    a: "a";
     c: "c";
     l: "l";
     v: "v";
@@ -81,13 +81,13 @@ export declare const BaseColorEnum: z.ZodEnum<{
 }>;
 export type BaseColor = z.infer<typeof BaseColorEnum>;
 export declare const BaseColorSetSchema: z.ZodRecord<z.ZodEnum<{
+    a: "a";
     w: "w";
     u: "u";
     b: "b";
     r: "r";
     g: "g";
     m: "m";
-    a: "a";
     c: "c";
     l: "l";
     v: "v";
@@ -97,73 +97,73 @@ 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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+        a: "a";
         w: "w";
         u: "u";
         b: "b";
         r: "r";
         g: "g";
         m: "m";
-        a: "a";
         c: "c";
         l: "l";
         v: "v";
@@ -175,7 +175,7 @@ export declare const PlaneswalkerAssetConfigSchema: z.ZodObject<{
     plus: z.ZodString;
     minus: z.ZodString;
     zero: z.ZodString;
-    separator: z.ZodString;
+    separator: z.ZodOptional<z.ZodString>;
     startingLoyalty: z.ZodString;
     masks: z.ZodOptional<z.ZodObject<{
         regular: z.ZodOptional<z.ZodString>;
@@ -197,25 +197,25 @@ export declare const SagaAssetConfigSchema: z.ZodObject<{
     badge: z.ZodString;
     divider: z.ZodString;
     banner: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        a: "a";
         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<{
+        a: "a";
         w: "w";
         u: "u";
         b: "b";
         r: "r";
         g: "g";
         m: "m";
-        a: "a";
         c: "c";
         l: "l";
         v: "v";
@@ -228,6 +228,10 @@ export declare const SagaAssetConfigSchema: z.ZodObject<{
         right: z.ZodString;
         stripe: z.ZodString;
     }, z.core.$strip>>;
+    bannerOrigin: z.ZodOptional<z.ZodObject<{
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+    }, z.core.$strip>>;
     bannerReadAheadMasks: z.ZodOptional<z.ZodObject<{
         right: z.ZodString;
         stripe: z.ZodString;
@@ -237,172 +241,172 @@ 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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+        a: "a";
         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<{
+            a: "a";
             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<{
+            a: "a";
             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<{
+            a: "a";
             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<{
+            a: "a";
             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<{
+            a: "a";
             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<{
+            a: "a";
             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<{
+        a: "a";
         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<{
+        a: "a";
         w: "w";
         u: "u";
         b: "b";
         r: "r";
         g: "g";
         m: "m";
-        a: "a";
         c: "c";
         l: "l";
         v: "v";
@@ -412,7 +416,7 @@ export declare const FrameAssetsSchema: z.ZodObject<{
         plus: z.ZodString;
         minus: z.ZodString;
         zero: z.ZodString;
-        separator: z.ZodString;
+        separator: z.ZodOptional<z.ZodString>;
         startingLoyalty: z.ZodString;
         masks: z.ZodOptional<z.ZodObject<{
             regular: z.ZodOptional<z.ZodString>;
@@ -427,25 +431,25 @@ export declare const FrameAssetsSchema: z.ZodObject<{
         badge: z.ZodString;
         divider: z.ZodString;
         banner: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+            a: "a";
             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<{
+            a: "a";
             w: "w";
             u: "u";
             b: "b";
             r: "r";
             g: "g";
             m: "m";
-            a: "a";
             c: "c";
             l: "l";
             v: "v";
@@ -458,12 +462,18 @@ export declare const FrameAssetsSchema: z.ZodObject<{
             right: z.ZodString;
             stripe: z.ZodString;
         }, z.core.$strip>>;
+        bannerOrigin: z.ZodOptional<z.ZodObject<{
+            x: z.ZodNumber;
+            y: z.ZodNumber;
+        }, z.core.$strip>>;
         bannerReadAheadMasks: z.ZodOptional<z.ZodObject<{
             right: z.ZodString;
             stripe: z.ZodString;
         }, z.core.$strip>>;
     }, z.core.$strip>>;
+    sectionDivider: z.ZodOptional<z.ZodString>;
     extendedOverlay: z.ZodOptional<z.ZodString>;
+    fullBorder: z.ZodOptional<z.ZodString>;
     dfcIcon: z.ZodOptional<z.ZodString>;
     dfcIconSet: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
         convertdfc: "convertdfc";
@@ -476,30 +486,36 @@ export declare const FrameAssetsSchema: z.ZodObject<{
         upsidedowndfc: "upsidedowndfc";
     }> & z.core.$partial, z.ZodString>>;
     dfcIconColorSet: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
+        a: "a";
         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<{
+        a: "a";
         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>;
+    dividerBar: z.ZodOptional<z.ZodEnum<{
+        old: "old";
+    }>>;
+    dividerBarScale: z.ZodOptional<z.ZodNumber>;
+    dividerBarGapBefore: z.ZodOptional<z.ZodNumber>;
+    dividerBarGapAfter: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 export type FrameAssets = z.infer<typeof FrameAssetsSchema>;
 /**
@@ -524,10 +540,14 @@ export declare const LayoutMasksSchema: z.ZodObject<{
     extended: z.ZodOptional<z.ZodString>;
     topHalf: z.ZodOptional<z.ZodString>;
     bottomHalf: z.ZodOptional<z.ZodString>;
+    rulesRight: z.ZodOptional<z.ZodString>;
+    adventureRules: z.ZodOptional<z.ZodString>;
+    adventureRulesRight: z.ZodOptional<z.ZodString>;
+    wings: 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";
+export type OverlayMaskName = "pinlines" | "titleAndType" | "rules" | "rightHalf" | "title" | "type" | "rulesRight" | "adventureRules" | "adventureRulesRight" | "wings";
 /**
  * A structured reference to one frame image. "c2" is valid only in the base
  * family; land/nyx/tall families use plain frame colors.

package/dist/schema/frameAssets.js

@@ -64,7 +64,8 @@ export const PlaneswalkerAssetConfigSchema = z.object({
     plus: AssetUrlSchema,
     minus: AssetUrlSchema,
     zero: AssetUrlSchema,
-    separator: AssetUrlSchema,
+    /** Drawn between the ability bands; not needed with `abilityBacking` off. */
+    separator: AssetUrlSchema.optional(),
     startingLoyalty: AssetUrlSchema,
     /** Ability box masks. */
     masks: PlaneswalkerMasksSchema.optional(),
@@ -88,6 +89,19 @@ export const SagaAssetConfigSchema = z.object({
     bannerTransform: ColorSetSchema.optional(),
     bannerMasks: BannerMasksSchema.optional(),
     bannerTransformMasks: BannerMasksSchema.optional(),
+    /**
+     * Where the banners and their masks sit on the sheet: the top-left corner
+     * of every one of them. Set it when they are trimmed to their visible part
+     * — `frame-kit trim --shared` cuts them all to one rectangle and prints this
+     * position. Omitted, they are full sheets, drawn from the corner. A read-ahead
+     * banner is moved down from here as one piece, masks and all.
+     */
+    bannerOrigin: z.object({ x: z.number(), y: z.number() }).optional(),
+    /**
+     * @deprecated Read-ahead cards use `bannerTransformMasks`, moved down with
+     * their banner. Still accepted so a frame that declares these loads, but
+     * never drawn.
+     */
     bannerReadAheadMasks: BannerMasksSchema.optional(),
 });
 /** The full frame-asset tree for a layout. */
@@ -112,8 +126,24 @@ export const FrameAssetsSchema = z.object({
     black: AssetUrlSchema.optional(),
     planeswalker: PlaneswalkerAssetConfigSchema.optional(),
     saga: SagaAssetConfigSchema.optional(),
+    /**
+     * Drawn between the sections of a column — a Case's steps, a Class's
+     * levels — the way a Saga's divider is drawn between its chapters: across
+     * nine tenths of the `abilities` box, centered, at its own aspect ratio.
+     * Without it the sections keep only their gaps.
+     */
+    sectionDivider: AssetUrlSchema.optional(),
     /** Extended-art overlay drawn on top of the masked frame. */
     extendedOverlay: AssetUrlSchema.optional(),
+    /**
+     * Border art drawn *under* the base frame while the `useFullBorder` template
+     * setting is on — for a frame whose base art leaves part of the ring empty.
+     * It is one image for every color, cut by the same cutouts as the frame
+     * ("No Border" among them), and filled with the border color when one is
+     * picked: on its own, before the base frame goes on top, so the frame's own
+     * art is never repainted.
+     */
+    fullBorder: AssetUrlSchema.optional(),
     /**
      * Legacy single DFC icon overlaid on the crown of transform cards. Superseded
      * by `dfcIconSet` (resolved from the card's actual `frame_effects`); kept as
@@ -145,6 +175,28 @@ export const FrameAssetsSchema = z.object({
      * see `getCardLayout`) in place of the usual `dfcIconSet`/`dfcIcon` mark.
      */
     lessonIcon: AssetUrlSchema.optional(),
+    /**
+     * Selects a built-in rules-text divider bar (between oracle and flavor
+     * text) instead of the app's default. Not an `AssetUrlSchema` — these are
+     * shared app assets any layout can opt into, not something a frame package
+     * bundles itself.
+     */
+    dividerBar: z.enum(["old"]).optional(),
+    /**
+     * Scales the divider bar's width (and, following its aspect ratio,
+     * height) relative to the app default. 1 = default size.
+     */
+    dividerBarScale: z.number().optional(),
+    /**
+     * Scales the gap between the oracle text and the divider bar. 1 =
+     * default gap.
+     */
+    dividerBarGapBefore: z.number().optional(),
+    /**
+     * Scales the gap between the divider bar and the flavor text. 1 =
+     * default gap.
+     */
+    dividerBarGapAfter: z.number().optional(),
 });
 /**
  * Section masks the renderer actually reads. `rightHalf` overrides the global
@@ -172,10 +224,12 @@ export const LayoutMasksSchema = z.object({
      * A frame ships this only when its plain `border` mask deliberately covers
      * *less* than the whole ring — m15's stops short of the collector strip, so
      * that the default border recolor leaves the collector line on its original
-     * black. Declaring `borderFull` is therefore also what tells the renderer
-     * that `border` is a partial mask: see `useFullBorder` in `drawCardToStage`,
-     * which picks between the two and decides whether the collector text has to
-     * adapt to the border color.
+     * black. A `useFullBorder` template setting swaps this in for `border`, and
+     * draws `frameAssets.fullBorder` when the frame ships one.
+     *
+     * The renderer does not work out which text that puts on the recolored
+     * ring: a box that should adapt says so in its `overrides`, as m15's
+     * collector info does with `settings: { useFullBorder: true }`.
      */
     borderFull: AssetUrlSchema.optional(),
     legendary: AssetUrlSchema.optional(),
@@ -202,4 +256,22 @@ export const LayoutMasksSchema = z.object({
      */
     topHalf: AssetUrlSchema.optional(),
     bottomHalf: AssetUrlSchema.optional(),
+    /**
+     * A storybook Adventure's text box is an open book, each page coloured on
+     * its own: the right page (`rules`) by the card, the left page
+     * (`adventureRules`) by its adventure. A two-colour page lays its second
+     * colour over the first through `rulesRight`/`adventureRulesRight`, a copy
+     * of the page's mask faded in towards its right edge. A layout that ships
+     * `adventureRules` has its pages coloured this way — see
+     * `selectStorybookFrameLayers`.
+     */
+    rulesRight: AssetUrlSchema.optional(),
+    adventureRules: AssetUrlSchema.optional(),
+    adventureRulesRight: AssetUrlSchema.optional(),
+    /**
+     * The storybook's page edges either side of the book. A two-colour gold
+     * card halves its frame between its colours, and lays gold over these as
+     * it does over the title and type bars.
+     */
+    wings: AssetUrlSchema.optional(),
 });

package/dist/schema/index.d.ts

@@ -1,5 +1,8 @@
 export * from "./assetUrl.js";
+export * from "./collectorInfo.js";
+export * from "./condition.js";
 export * from "./frame.js";
 export * from "./frameAssets.js";
 export * from "./frameMeta.js";
 export * from "./layout.js";
+export * from "./paint.js";

package/dist/schema/index.js

@@ -1,5 +1,8 @@
 export * from "./assetUrl.js";
+export * from "./collectorInfo.js";
+export * from "./condition.js";
 export * from "./frame.js";
 export * from "./frameAssets.js";
 export * from "./frameMeta.js";
 export * from "./layout.js";
+export * from "./paint.js";