platform-types 1.10.698 → 1.10.699

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

@@ -558,8 +558,8 @@ declare global {
      * 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` answers 400
-     * `INVALID_CURSOR`.
+     * 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';

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.698",
+	"version": "1.10.699",
 	"description": "Shared wire and entity contracts for the platform.",
 	"type": "module",
 	"main": "dist/index.js",