@shoplix-ai/block-kit 3.4.0 → 3.5.0

package/README.md

@@ -55,9 +55,10 @@ written against this package and nothing else from the runtime. It holds:
   `imageSourceFor` (the rendition to paint at a given display width),
   `platformWords`, the word catalog below, `moneyParts`, `moneyText`,
   `moneyAmount` and `discountPercent`, the money presentation below, and
-  `productCardColors`, the one colour table the product card reads on the
-  phone and on the web: a theme role per part of the card, with a component
-  token at `product_card.<part>` over it.
+  `productCardColors`, `collectionTileColors` and `heroBannerColors` beside
+  `heroBannerRadius`, the colour tables the promoted blocks read on the phone
+  and on the web alike: a theme role per part of the block, with a component
+  token at `<block>.<part>` over it.
 
 ## The theme a renderer receives
 

package/dist/hero-banner.d.ts

@@ -0,0 +1,27 @@
+import { type ThemeStyle } from '@shoplix-ai/sdui-schema';
+/** The parts of the hero banner, each with the theme role it draws unless a component token names another. */
+declare const HERO_BANNER_ROLES: {
+    readonly artwork: "sunken";
+    readonly scrim: "overlay";
+    readonly title: "text";
+    readonly subtitle: "subtle";
+    readonly page: "action";
+    readonly page_idle: "border";
+};
+export type HeroBannerPart = keyof typeof HERO_BANNER_ROLES;
+export type HeroBannerColors = Readonly<Record<HeroBannerPart, string>>;
+/**
+ * Every colour the hero banner draws, one per part: the theme role behind it,
+ * with a per component token at `hero_banner.<part>` as the escape hatch over
+ * it. The phone's hero and its web twin read this one table, so a slide and
+ * its page indicator cannot disagree on what a merchant's theme means.
+ */
+export declare function heroBannerColors(theme: ThemeStyle): HeroBannerColors;
+/**
+ * The corner a slide is cut with: the merchant's own, with
+ * `hero_banner.radius` as the escape hatch for a design whose hero is softer
+ * than its cards.
+ */
+export declare function heroBannerRadius(theme: ThemeStyle): number;
+export {};
+//# sourceMappingURL=hero-banner.d.ts.map

package/dist/hero-banner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hero-banner.d.ts","sourceRoot":"","sources":["../src/hero-banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE/E,8GAA8G;AAC9G,QAAA,MAAM,iBAAiB;;;;;;;CAOwC,CAAC;AAEhE,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,iBAAiB,CAAC;AAE5D,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;AAExE;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,GAAG,gBAAgB,CAOpE;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAE1D"}

package/dist/hero-banner.js

@@ -0,0 +1,33 @@
+import { componentTokenValue } from '@shoplix-ai/sdui-schema';
+/** The parts of the hero banner, each with the theme role it draws unless a component token names another. */
+const HERO_BANNER_ROLES = {
+    artwork: 'sunken',
+    scrim: 'overlay',
+    title: 'text',
+    subtitle: 'subtle',
+    page: 'action',
+    page_idle: 'border',
+};
+/**
+ * Every colour the hero banner draws, one per part: the theme role behind it,
+ * with a per component token at `hero_banner.<part>` as the escape hatch over
+ * it. The phone's hero and its web twin read this one table, so a slide and
+ * its page indicator cannot disagree on what a merchant's theme means.
+ */
+export function heroBannerColors(theme) {
+    const colors = {};
+    for (const part of Object.keys(HERO_BANNER_ROLES)) {
+        const role = theme.colors[HERO_BANNER_ROLES[part]];
+        colors[part] = componentTokenValue(theme, `hero_banner.${part}`, role);
+    }
+    return colors;
+}
+/**
+ * The corner a slide is cut with: the merchant's own, with
+ * `hero_banner.radius` as the escape hatch for a design whose hero is softer
+ * than its cards.
+ */
+export function heroBannerRadius(theme) {
+    return componentTokenValue(theme, 'hero_banner.radius', theme.radius);
+}
+//# sourceMappingURL=hero-banner.js.map

package/dist/hero-banner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hero-banner.js","sourceRoot":"","sources":["../src/hero-banner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAmB,MAAM,yBAAyB,CAAC;AAE/E,8GAA8G;AAC9G,MAAM,iBAAiB,GAAG;IACxB,OAAO,EAAE,QAAQ;IACjB,KAAK,EAAE,SAAS;IAChB,KAAK,EAAE,MAAM;IACb,QAAQ,EAAE,QAAQ;IAClB,IAAI,EAAE,QAAQ;IACd,SAAS,EAAE,QAAQ;CAC0C,CAAC;AAMhE;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAiB;IAChD,MAAM,MAAM,GAAG,EAAoC,CAAC;IACpD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAqB,EAAE,CAAC;QACtE,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;QACnD,MAAM,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,KAAK,EAAE,eAAe,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAiB;IAChD,OAAO,mBAAmB,CAAC,KAAK,EAAE,oBAAoB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;AACxE,CAAC"}

package/dist/index.d.ts

@@ -15,6 +15,8 @@ export { productCardColors } from './product-card.js';
 export type { ProductCardColors, ProductCardPart } from './product-card.js';
 export { collectionTileColors } from './collection-tile.js';
 export type { CollectionTileColors, CollectionTilePart } from './collection-tile.js';
+export { heroBannerColors, heroBannerRadius } from './hero-banner.js';
+export type { HeroBannerColors, HeroBannerPart } from './hero-banner.js';
 export { discountPercent, formatMoney, moneyAmount, moneyParts, moneyText } from './money.js';
 export type { MoneyParts } from './money.js';
 export { imageSourceFor } from './renditions.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC7F,YAAY,EACV,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,aAAa,EACb,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,aAAa,EACb,WAAW,EACX,aAAa,GACd,MAAM,eAAe,CAAC;AAEvB,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC/D,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhF,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC9D,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACrF,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC9F,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAClE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACzE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAC7F,YAAY,EACV,YAAY,EACZ,cAAc,EACd,gBAAgB,EAChB,iBAAiB,EACjB,uBAAuB,EACvB,aAAa,EACb,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,UAAU,EACV,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,SAAS,EACT,aAAa,EACb,WAAW,EACX,aAAa,GACd,MAAM,eAAe,CAAC;AAEvB,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AACpD,YAAY,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC/D,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhF,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC9D,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAElE,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACtD,YAAY,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACtE,YAAY,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC9F,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,YAAY,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAClE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AACzE,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -7,6 +7,7 @@ export { CONTRACT_MAJOR, CONTRACT_VERSION } from './version.js';
 export { resolveToken } from './tokens.js';
 export { productCardColors } from './product-card.js';
 export { collectionTileColors } from './collection-tile.js';
+export { heroBannerColors, heroBannerRadius } from './hero-banner.js';
 export { discountPercent, formatMoney, moneyAmount, moneyParts, moneyText } from './money.js';
 export { imageSourceFor } from './renditions.js';
 export { localize, pickLocale, textDirection } from './locale.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAY7F,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAgB5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGpD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAG/D,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG9D,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE9F,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAY7F,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAgB5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAGpD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAG/D,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG9D,OAAO,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEtE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE9F,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAElE,OAAO,EAAE,iBAAiB,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC"}

package/dist/version.d.ts

@@ -4,6 +4,6 @@
  * The major is the compatibility line: a Shop package built against another
  * major never meets this runtime, and a major bump is an announced event.
  */
-export declare const CONTRACT_VERSION = "3.4.0";
+export declare const CONTRACT_VERSION = "3.5.0";
 export declare const CONTRACT_MAJOR = 3;
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -4,6 +4,6 @@
  * The major is the compatibility line: a Shop package built against another
  * major never meets this runtime, and a major bump is an announced event.
  */
-export const CONTRACT_VERSION = '3.4.0';
+export const CONTRACT_VERSION = '3.5.0';
 export const CONTRACT_MAJOR = 3;
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shoplix-ai/block-kit",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "The renderer contract every Block Type renderer is written against: what a renderer receives, how a Block Type is registered with its owner, the closed capability set, and the small helpers renderers share. Contract only, no renderers.",
   "license": "MIT",
   "repository": {