platform-types 1.10.697 → 1.10.699

package/dist/cjs/storefrontTheme.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveStorefrontTheme = exports.resolveStorefrontEffectiveSettings = exports.storefrontGlobalSettingsLayer = exports.storefrontContrastRatio = void 0;
 const storefrontDesignRegistry_ts_1 = require("./storefrontDesignRegistry.js");
+/*
+ * The one binding of a warning role and of a surface to the setting it reads: `surfaceTokens`
+ * and `makeMode` read the colours THROUGH these maps, and the `warnings` filter judges by them,
+ * so the tokens and the "design caused it" filter cannot name different settings.
+ */
 const WARNING_SETTING = {
     link: 'primaryColor',
     button: 'primaryColor',
@@ -54,22 +59,23 @@ const ensureContrast = (color, background, minimum) => {
     return target;
 };
 const surfaceTokens = (background, settings, mode, surface, warnings) => {
-    const adjusted = (role, requested, minimum) => {
+    const adjusted = (role, minimum) => {
+        const requested = settings[WARNING_SETTING[role]];
         const effective = ensureContrast(requested, background, minimum);
         if (effective !== requested.toUpperCase())
             warnings.push({ mode, surface, role, requested, effective });
         return effective;
     };
     const text = readableText(background);
-    const button = adjusted('button', settings.primaryColor, 3);
+    const button = adjusted('button', 3);
     const hover = ensureContrast(mix(button, readableText(background), 0.2), background, 3);
     const disabledBackground = mix(background, text, 0.12);
     return {
         background,
         text,
         secondaryText: ensureContrast(mix(background, text, 0.6), background, 4.5),
-        link: adjusted('link', settings.primaryColor, 4.5),
-        focus: adjusted('focus', settings.accentColor, 3),
+        link: adjusted('link', 4.5),
+        focus: adjusted('focus', 3),
         border: ensureContrast(mix(background, text, 0.3), background, 3),
         button: { background: button, text: readableText(button), hover, hoverText: readableText(hover) },
         disabled: { background: disabledBackground, text: readableText(disabledBackground) },
@@ -117,11 +123,8 @@ const resolveStorefrontTheme = (overrides = {}, globalsRow) => {
     const warnings = [];
     const makeMode = (mode) => {
         const background = (requested) => mode === 'light' ? requested.toUpperCase() : mix(requested, '#000000', 0.9);
-        return {
-            page: surfaceTokens(background(settings.backgroundColor), settings, mode, 'page', warnings),
-            header: surfaceTokens(background(settings.headerColor), settings, mode, 'header', warnings),
-            footer: surfaceTokens(background(settings.footerColor), settings, mode, 'footer', warnings),
-        };
+        const surface = (id) => surfaceTokens(background(settings[SURFACE_SETTING[id]]), settings, mode, id, warnings);
+        return { page: surface('page'), header: surface('header'), footer: surface('footer') };
     };
     const scale = { compact: 0.875, standard: 1, large: 1.125 }[settings.textSize];
     return {

package/dist/cjs/storefrontWebLiteralKeys.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isAllowedStorefrontLiteralValue = exports.isStorefrontLiteralKey = exports.STOREFRONT_WEB_LITERAL_KEYS = void 0;
+exports.isAdoptableStorefrontLiteral = exports.isAllowedStorefrontLiteralValue = exports.isStorefrontLiteralKey = exports.STOREFRONT_WEB_LITERAL_KEYS = void 0;
+const storefrontDesignRegistry_ts_1 = require("./storefrontDesignRegistry.js");
 /**
  * Every storefront `WEB` literal key a shop may override, in code-unit order.
  *
@@ -1178,3 +1179,14 @@ const STOREFRONT_SAME_ORIGIN_PATH_RE = /^\/(?![/\\])[^\s\\\p{Cc}\p{Cf}]*$/u;
  */
 const isAllowedStorefrontLiteralValue = (key, value) => !key.startsWith(STOREFRONT_NAVIGATE_LITERAL_PREFIX) || STOREFRONT_SAME_ORIGIN_PATH_RE.test(value);
 exports.isAllowedStorefrontLiteralValue = isAllowedStorefrontLiteralValue;
+/**
+ * Whether a shop's stored `value` for `key` is one a save keeps, a read serves and the editor
+ * baseline adopts: a shop-overridable key, a well-formed string within
+ * {@link STOREFRONT_DESIGN_LITERAL_MAX_CODE_POINTS} code points, and an allowed value for it.
+ */
+const isAdoptableStorefrontLiteral = (key, value) => (0, exports.isStorefrontLiteralKey)(key) &&
+    typeof value === 'string' &&
+    value.isWellFormed() &&
+    Array.from(value).length <= storefrontDesignRegistry_ts_1.STOREFRONT_DESIGN_LITERAL_MAX_CODE_POINTS &&
+    (0, exports.isAllowedStorefrontLiteralValue)(key, value);
+exports.isAdoptableStorefrontLiteral = isAdoptableStorefrontLiteral;

package/dist/storefrontDesign.d.ts

@@ -358,7 +358,11 @@ declare global {
         /** Always `[]`: an invalid colour, an unmapped Home switch, the banner and every refused or oversized literal fall back to defaults. */
         mappingConflicts: StorefrontDesignMappingConflict[];
         legacySourceRevision: string;
-        /** The store's own logo, offered as a suggestion; init copies it into `branding.logo`, and a copy that cannot complete leaves no logo and no conflict. */
+        /**
+         * The store's own logo, offered as a suggestion; init copies it into `branding.logo`. A logo
+         * that is not adoptable or would exceed the asset capacity leaves no logo and no conflict;
+         * any other copy failure answers 503 `STOREFRONT_DRAFT_UNAVAILABLE`.
+         */
         legacyLogo?: {
             source: 'store.photoURL';
             key: string;
@@ -476,7 +480,11 @@ declare global {
     type StorefrontDesignPublishOperationResult = StorefrontDesignPublishResult;
     type StorefrontDesignPublishOperationResponse = StorefrontDesignPublishResponse;
     interface StorefrontDesignPublishResult {
-        /** Only adjustments to a colour the design itself sets; a default colour is never listed. */
+        /**
+         * Only adjustments the design itself caused: the adjusted colour, or the background of the
+         * surface it sits on, is set by the design. So a default primary or accent colour IS listed
+         * when the design sets that surface's background.
+         */
         changeSummary: {
             contrastAdjustments: StorefrontThemeWarning[];
         };
@@ -546,10 +554,12 @@ declare global {
     /**
      * Web `GET /products?updatedAt=`'s recency listing (the shop's «Ingresos» page), with the
      * same rows and cursor shape, in the grant's store: enabled products updated after
-     * `updatedAt` (epoch ms, digits), newest first; `LastEvaluatedKey` resumes as `startKey`.
-     * Non-digits or a `startKey` over 2048 characters answer 400 `STOREFRONT_PREVIEW_INVALID`;
-     * an `updatedAt` past `Number.MAX_SAFE_INTEGER` answers 400 `INVALID_UPDATED_AT`; a
-     * malformed or foreign `startKey` answers 400 `INVALID_CURSOR`.
+     * `updatedAt` (epoch ms), newest first; `LastEvaluatedKey` resumes as `startKey`. The web
+     * route's one rule: an absent or empty `updatedAt` reads from 0; anything but digits within
+     * `Number.MAX_SAFE_INTEGER` (`1e5`, `-5`, `0x10`, a blank) answers 400 `INVALID_UPDATED_AT`,
+     * on both routes alike. An `updatedAt` over 32 characters or a `startKey` over 2048 answers
+     * 400 `STOREFRONT_PREVIEW_INVALID`; a malformed or foreign `startKey`, one whose `updatedAt`
+     * DynamoDB cannot store, or one at or below the `updatedAt` floor answers 400 `INVALID_CURSOR`.
      */
      | {
         operation: 'incomes';
@@ -600,10 +610,12 @@ declare global {
     /**
      * The codes a catalogue operation answers through its public web route's own core, as that
      * route does: 404 `PRODUCT_NOT_FOUND` / `PRODUCT_GROUP_NOT_FOUND` / `COLLECTION_NOT_FOUND`,
-     * 400 `INVALID_CURSOR` / `INVALID_DISCOVERY_QUERY`, 409 `CURSOR_STALE` (a collection that
-     * changed between the reads bracketing a page) and 503 `PRODUCT_LOOKUP_INCOMPLETE`.
+     * 400 `INVALID_CURSOR` / `INVALID_DISCOVERY_QUERY` / `INVALID_UPDATED_AT` (an `incomes`
+     * `updatedAt` that is not digits within the safe-integer range), 409 `CURSOR_STALE` (a
+     * collection that changed between the reads bracketing a page) and 503
+     * `PRODUCT_LOOKUP_INCOMPLETE`.
      */
-    type StorefrontPreviewCatalogueErrorCode = 'PRODUCT_NOT_FOUND' | 'PRODUCT_GROUP_NOT_FOUND' | 'COLLECTION_NOT_FOUND' | 'INVALID_CURSOR' | 'INVALID_DISCOVERY_QUERY' | 'CURSOR_STALE' | 'PRODUCT_LOOKUP_INCOMPLETE';
+    type StorefrontPreviewCatalogueErrorCode = 'PRODUCT_NOT_FOUND' | 'PRODUCT_GROUP_NOT_FOUND' | 'COLLECTION_NOT_FOUND' | 'INVALID_CURSOR' | 'INVALID_DISCOVERY_QUERY' | 'INVALID_UPDATED_AT' | 'CURSOR_STALE' | 'PRODUCT_LOOKUP_INCOMPLETE';
     interface StorefrontPreviewReadFailure {
         message: string;
         error: StorefrontPreviewReadErrorCode | StorefrontPreviewCatalogueErrorCode;

package/dist/storefrontTheme.js

@@ -1,4 +1,9 @@
 import { resolveStorefrontDesignSettings, validateStorefrontDesignSetting, } from "./storefrontDesignRegistry.js";
+/*
+ * The one binding of a warning role and of a surface to the setting it reads: `surfaceTokens`
+ * and `makeMode` read the colours THROUGH these maps, and the `warnings` filter judges by them,
+ * so the tokens and the "design caused it" filter cannot name different settings.
+ */
 const WARNING_SETTING = {
     link: 'primaryColor',
     button: 'primaryColor',
@@ -50,22 +55,23 @@ const ensureContrast = (color, background, minimum) => {
     return target;
 };
 const surfaceTokens = (background, settings, mode, surface, warnings) => {
-    const adjusted = (role, requested, minimum) => {
+    const adjusted = (role, minimum) => {
+        const requested = settings[WARNING_SETTING[role]];
         const effective = ensureContrast(requested, background, minimum);
         if (effective !== requested.toUpperCase())
             warnings.push({ mode, surface, role, requested, effective });
         return effective;
     };
     const text = readableText(background);
-    const button = adjusted('button', settings.primaryColor, 3);
+    const button = adjusted('button', 3);
     const hover = ensureContrast(mix(button, readableText(background), 0.2), background, 3);
     const disabledBackground = mix(background, text, 0.12);
     return {
         background,
         text,
         secondaryText: ensureContrast(mix(background, text, 0.6), background, 4.5),
-        link: adjusted('link', settings.primaryColor, 4.5),
-        focus: adjusted('focus', settings.accentColor, 3),
+        link: adjusted('link', 4.5),
+        focus: adjusted('focus', 3),
         border: ensureContrast(mix(background, text, 0.3), background, 3),
         button: { background: button, text: readableText(button), hover, hoverText: readableText(hover) },
         disabled: { background: disabledBackground, text: readableText(disabledBackground) },
@@ -111,11 +117,8 @@ export const resolveStorefrontTheme = (overrides = {}, globalsRow) => {
     const warnings = [];
     const makeMode = (mode) => {
         const background = (requested) => mode === 'light' ? requested.toUpperCase() : mix(requested, '#000000', 0.9);
-        return {
-            page: surfaceTokens(background(settings.backgroundColor), settings, mode, 'page', warnings),
-            header: surfaceTokens(background(settings.headerColor), settings, mode, 'header', warnings),
-            footer: surfaceTokens(background(settings.footerColor), settings, mode, 'footer', warnings),
-        };
+        const surface = (id) => surfaceTokens(background(settings[SURFACE_SETTING[id]]), settings, mode, id, warnings);
+        return { page: surface('page'), header: surface('header'), footer: surface('footer') };
     };
     const scale = { compact: 0.875, standard: 1, large: 1.125 }[settings.textSize];
     return {

package/dist/storefrontWebLiteralKeys.d.ts

@@ -28,3 +28,9 @@ export declare const isStorefrontLiteralKey: (key: string) => boolean;
  * unconstrained here (key membership, well-formedness and length are checked apart).
  */
 export declare const isAllowedStorefrontLiteralValue: (key: string, value: string) => boolean;
+/**
+ * Whether a shop's stored `value` for `key` is one a save keeps, a read serves and the editor
+ * baseline adopts: a shop-overridable key, a well-formed string within
+ * {@link STOREFRONT_DESIGN_LITERAL_MAX_CODE_POINTS} code points, and an allowed value for it.
+ */
+export declare const isAdoptableStorefrontLiteral: (key: string, value: unknown) => value is string;

package/dist/storefrontWebLiteralKeys.js

@@ -1,3 +1,4 @@
+import { STOREFRONT_DESIGN_LITERAL_MAX_CODE_POINTS } from "./storefrontDesignRegistry.js";
 /**
  * Every storefront `WEB` literal key a shop may override, in code-unit order.
  *
@@ -1173,3 +1174,13 @@ const STOREFRONT_SAME_ORIGIN_PATH_RE = /^\/(?![/\\])[^\s\\\p{Cc}\p{Cf}]*$/u;
  * unconstrained here (key membership, well-formedness and length are checked apart).
  */
 export const isAllowedStorefrontLiteralValue = (key, value) => !key.startsWith(STOREFRONT_NAVIGATE_LITERAL_PREFIX) || STOREFRONT_SAME_ORIGIN_PATH_RE.test(value);
+/**
+ * Whether a shop's stored `value` for `key` is one a save keeps, a read serves and the editor
+ * baseline adopts: a shop-overridable key, a well-formed string within
+ * {@link STOREFRONT_DESIGN_LITERAL_MAX_CODE_POINTS} code points, and an allowed value for it.
+ */
+export const isAdoptableStorefrontLiteral = (key, value) => isStorefrontLiteralKey(key) &&
+    typeof value === 'string' &&
+    value.isWellFormed() &&
+    Array.from(value).length <= STOREFRONT_DESIGN_LITERAL_MAX_CODE_POINTS &&
+    isAllowedStorefrontLiteralValue(key, value);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "platform-types",
-	"version": "1.10.697",
+	"version": "1.10.699",
 	"description": "Shared wire and entity contracts for the platform.",
 	"type": "module",
 	"main": "dist/index.js",