@vectoriox/iox-ui 5.46.0 → 5.47.0

package/fesm2022/vectoriox-iox-ui-generation-core.mjs

@@ -29,7 +29,7 @@ const SPEC_SITE_PLAN_SHAPE = {
     "business": {
         "name": "string — the brand: the header, the hero, the copyright line",
         "tagline?": "string — the hero lead and the footer line",
-        "facts?": "{ [fact]: string } — facts (email, phone, city): only the customer's own words; a blank fact is a publish-blocking placeholder, never invented"
+        "facts?": "{ [fact]: string } — facts (email, phone, city, address, hours): only the customer's own words; a blank fact is a publish-blocking placeholder, never invented"
     },
     "design": {
         "flavorId": "string — a v2 flavor pack id",
@@ -107,7 +107,9 @@ const SPEC_SITE_PLAN_SHAPE = {
 const SPEC_SITE_FACTS = {
     "email": "Email address",
     "phone": "Phone number",
-    "city": "City or area"
+    "city": "City or area",
+    "address": "Street address",
+    "hours": "Opening hours"
 };
 const SPEC_SITE_PATTERNS = {
     "nav.inline-cta": {
@@ -2053,6 +2055,132 @@ const SPEC_SITE_TEMPLATES = {
         }
     }
 };
+const SPEC_SITE_LIBRARY = [
+    {
+        "id": "nav.inline-cta",
+        "family": "nav"
+    },
+    {
+        "id": "nav.centered-logo",
+        "family": "nav"
+    },
+    {
+        "id": "nav.overlay-menu",
+        "family": "nav"
+    },
+    {
+        "id": "hero.split",
+        "family": "hero"
+    },
+    {
+        "id": "hero.centered",
+        "family": "hero"
+    },
+    {
+        "id": "hero.full-bleed-media",
+        "family": "hero"
+    },
+    {
+        "id": "hero.stacked-editorial",
+        "family": "hero"
+    },
+    {
+        "id": "proof.logo-strip",
+        "family": "proof"
+    },
+    {
+        "id": "proof.stat-row",
+        "family": "proof"
+    },
+    {
+        "id": "proof.testimonial-single",
+        "family": "proof"
+    },
+    {
+        "id": "proof.testimonial-carousel",
+        "family": "proof"
+    },
+    {
+        "id": "feature.triad",
+        "family": "feature"
+    },
+    {
+        "id": "feature.alternating-rows",
+        "family": "feature"
+    },
+    {
+        "id": "feature.icon-list",
+        "family": "feature"
+    },
+    {
+        "id": "feature.tabbed",
+        "family": "feature"
+    },
+    {
+        "id": "collection.card-grid",
+        "family": "collection"
+    },
+    {
+        "id": "collection.masonry-gallery",
+        "family": "collection"
+    },
+    {
+        "id": "collection.slider",
+        "family": "collection"
+    },
+    {
+        "id": "collection.list-detail",
+        "family": "collection"
+    },
+    {
+        "id": "story.long-form",
+        "family": "story"
+    },
+    {
+        "id": "story.timeline",
+        "family": "story"
+    },
+    {
+        "id": "story.quote-break",
+        "family": "story"
+    },
+    {
+        "id": "cta.banner",
+        "family": "cta"
+    },
+    {
+        "id": "cta.split-form",
+        "family": "cta"
+    },
+    {
+        "id": "contact.split-map",
+        "family": "contact"
+    },
+    {
+        "id": "contact.simple",
+        "family": "contact"
+    },
+    {
+        "id": "faq.accordion",
+        "family": "faq"
+    },
+    {
+        "id": "pricing.tiers",
+        "family": "pricing"
+    },
+    {
+        "id": "footer.three-column",
+        "family": "footer"
+    },
+    {
+        "id": "footer.mega",
+        "family": "footer"
+    },
+    {
+        "id": "footer.minimal",
+        "family": "footer"
+    }
+];
 
 const NODE_BASELINES = {
     "Button": {
@@ -7531,6 +7659,76 @@ function walkSerialized(nodes, visit, ancestors = []) {
     }
 }
 
+/**
+ * The ONE way a framework-free gate refuses a document "with a path, never repairs" (W1's site-plan gate, the
+ * harness's analysis gate): a documented shape table (key → type text; `key?` optional, `[name]` the object's
+ * own field names) whose key lists the gate READS — so the shape a model is told about is the shape refused —
+ * and a collector that records each refusal at its dotted path. Generic over each gate's issue-code enum.
+ */
+const OPTIONAL_MARK = '?';
+const DYNAMIC_KEY = /^\[[^\]]+\]\??$/;
+const isDynamic = (key) => DYNAMIC_KEY.test(key);
+/** Every fixed key an object of the shape may carry. */
+function shapeKeys(entry) {
+    return Object.keys(entry).filter(k => !isDynamic(k)).map(k => (k.endsWith(OPTIONAL_MARK) ? k.slice(0, -1) : k));
+}
+/** The keys an object of the shape must carry. */
+function requiredShapeKeys(entry) {
+    return Object.keys(entry).filter(k => !isDynamic(k) && !k.endsWith(OPTIONAL_MARK));
+}
+const isPlainObject = (v) => !!v && typeof v === 'object' && !Array.isArray(v);
+const isNonEmptyString = (v) => typeof v === 'string' && v.trim() !== '';
+/** `path.key`, or `key` at the root. */
+const pathAt = (path, key) => (path ? `${path}.${key}` : key);
+class PathIssueCollector {
+    /** `subject` names the document in a refusal ("… is not part of the plan shape"). */
+    constructor(subject, codes) {
+        this.subject = subject;
+        this.codes = codes;
+        this.issues = [];
+    }
+    add(code, path, message) {
+        this.issues.push({ code, path, message });
+    }
+    keys(obj, allowed, path) {
+        for (const key of Object.keys(obj))
+            if (!allowed.includes(key))
+                this.add(this.codes.unknownKey, pathAt(path, key), `"${key}" is not part of the ${this.subject} shape`);
+    }
+    string(obj, key, path, required = true) {
+        const v = obj[key];
+        if (v === undefined && !required)
+            return null;
+        if (!isNonEmptyString(v)) {
+            this.add(this.codes.shape, pathAt(path, key), 'must be a non-empty string');
+            return null;
+        }
+        return v;
+    }
+    boolean(obj, key, path) {
+        if (obj[key] !== undefined && typeof obj[key] !== 'boolean')
+            this.add(this.codes.shape, pathAt(path, key), 'must be a boolean');
+    }
+    array(obj, key, path) {
+        const v = obj[key];
+        if (!Array.isArray(v)) {
+            this.add(this.codes.shape, pathAt(path, key), 'must be an array');
+            return [];
+        }
+        return v;
+    }
+    unique(values, path, what) {
+        const seen = new Set();
+        values.forEach((v, i) => {
+            if (v === null)
+                return;
+            if (seen.has(v))
+                this.add(this.codes.duplicate, path(i), `${what} "${v}" is used twice`);
+            seen.add(v);
+        });
+    }
+}
+
 /**
  * The Site Plan validator — the gate in front of the composer. The wizard's plan and (later) the AI's
  * plan go through the SAME checks: an unknown pattern, a slot the pattern does not declare, a source
@@ -7576,17 +7774,8 @@ class SitePlanError extends Error {
 /** Route-scope aliases (`$route`, `$current`, …) are platform-owned. */
 const RESERVED_PREFIX = '$';
 const ID_FIELD = '_id';
-const OPTIONAL_MARK = '?';
-const DYNAMIC_KEY = /^\[[^\]]+\]\??$/;
-const isDynamic = (key) => DYNAMIC_KEY.test(key);
-/** Every fixed key an object of the shape may carry. */
-function shapeKeys(entry) {
-    return Object.keys(entry).filter(k => !isDynamic(k)).map(k => (k.endsWith(OPTIONAL_MARK) ? k.slice(0, -1) : k));
-}
-/** The keys an object of the shape must carry. */
-function requiredShapeKeys(entry) {
-    return Object.keys(entry).filter(k => !isDynamic(k) && !k.endsWith(OPTIONAL_MARK));
-}
+/** The documented plan shape (contract `site.planShape`): its key lists are READ (`shape-check`), so a key
+ *  the plan documents is a key the gate validates — and an undocumented one is refused. */
 const SHAPE = SPEC_SITE_PLAN_SHAPE;
 const PLAN_KEYS = shapeKeys(SHAPE['plan']);
 const TEMPLATE_SOURCE_KEYS = shapeKeys(SHAPE['sourceTemplate']);
@@ -7607,61 +7796,18 @@ const GLOBAL_POSITION = {
 };
 const ROUTE = /^\/(?:(?:[a-z0-9]+(?:-[a-z0-9]+)*|:[a-zA-Z_][a-zA-Z0-9_]*)(?:\/(?:[a-z0-9]+(?:-[a-z0-9]+)*|:[a-zA-Z_][a-zA-Z0-9_]*))*)?$/;
 const ROUTE_PARAM$1 = /:([a-zA-Z_][a-zA-Z0-9_]*)/g;
-const isObject = (v) => !!v && typeof v === 'object' && !Array.isArray(v);
-const isNonEmptyString = (v) => typeof v === 'string' && v.trim() !== '';
 const has = (table, key) => Object.prototype.hasOwnProperty.call(table, key);
-const at = (path, key) => (path ? `${path}.${key}` : key);
 /** The `:param` names of a route, in order. */
 function routeParams(route) {
     return [...route.matchAll(ROUTE_PARAM$1)].map(m => m[1]);
 }
-class Collector {
+class Collector extends PathIssueCollector {
     constructor() {
-        this.issues = [];
-    }
-    add(code, path, message) {
-        this.issues.push({ code, path, message });
-    }
-    keys(obj, allowed, path) {
-        for (const key of Object.keys(obj))
-            if (!allowed.includes(key))
-                this.add(SitePlanIssueCode.UnknownKey, at(path, key), `"${key}" is not part of the plan shape`);
-    }
-    string(obj, key, path, required = true) {
-        const v = obj[key];
-        if (v === undefined && !required)
-            return null;
-        if (!isNonEmptyString(v)) {
-            this.add(SitePlanIssueCode.Shape, at(path, key), 'must be a non-empty string');
-            return null;
-        }
-        return v;
-    }
-    boolean(obj, key, path) {
-        if (obj[key] !== undefined && typeof obj[key] !== 'boolean')
-            this.add(SitePlanIssueCode.Shape, at(path, key), 'must be a boolean');
-    }
-    array(obj, key, path) {
-        const v = obj[key];
-        if (!Array.isArray(v)) {
-            this.add(SitePlanIssueCode.Shape, at(path, key), 'must be an array');
-            return [];
-        }
-        return v;
-    }
-    unique(values, path, what) {
-        const seen = new Set();
-        values.forEach((v, i) => {
-            if (v === null)
-                return;
-            if (seen.has(v))
-                this.add(SitePlanIssueCode.Duplicate, path(i), `${what} "${v}" is used twice`);
-            seen.add(v);
-        });
+        super('plan', { shape: SitePlanIssueCode.Shape, unknownKey: SitePlanIssueCode.UnknownKey, duplicate: SitePlanIssueCode.Duplicate });
     }
 }
 function validateSource(c, source) {
-    if (!isObject(source))
+    if (!isPlainObject(source))
         return c.add(SitePlanIssueCode.Shape, 'source', 'must be an object');
     if (source['kind'] === SitePlanSourceKind.Template) {
         c.keys(source, TEMPLATE_SOURCE_KEYS, 'source');
@@ -7678,7 +7824,7 @@ function validateSource(c, source) {
     }
 }
 function validateBusiness(c, business) {
-    if (!isObject(business))
+    if (!isPlainObject(business))
         return c.add(SitePlanIssueCode.Shape, 'business', 'must be an object');
     c.keys(business, BUSINESS_KEYS, 'business');
     if (!isNonEmptyString(business['name']))
@@ -7688,7 +7834,7 @@ function validateBusiness(c, business) {
     const facts = business['facts'];
     if (facts === undefined)
         return;
-    if (!isObject(facts))
+    if (!isPlainObject(facts))
         return c.add(SitePlanIssueCode.Shape, 'business.facts', 'must be an object');
     for (const [key, value] of Object.entries(facts)) {
         if (!FACT_KEYS.includes(key))
@@ -7698,7 +7844,7 @@ function validateBusiness(c, business) {
     }
 }
 function validateDesign(c, design) {
-    if (!isObject(design))
+    if (!isPlainObject(design))
         return c.add(SitePlanIssueCode.Shape, 'design', 'must be an object');
     c.keys(design, DESIGN_KEYS, 'design');
     for (const key of DESIGN_REQUIRED)
@@ -7728,14 +7874,14 @@ function validateDesign(c, design) {
         bad('mode', `must be one of ${SPEC_AXES.modes.join(', ')}`);
     if (design['pillButtons'] !== undefined && typeof design['pillButtons'] !== 'boolean')
         bad('pillButtons', 'must be a boolean');
-    if (design['fonts'] !== undefined && !isObject(design['fonts']))
+    if (design['fonts'] !== undefined && !isPlainObject(design['fonts']))
         bad('fonts', 'must be an object');
 }
 function validateContentTypes(c, list) {
     const types = new Map();
     list.forEach((raw, i) => {
         const path = `contentTypes[${i}]`;
-        if (!isObject(raw))
+        if (!isPlainObject(raw))
             return c.add(SitePlanIssueCode.Shape, path, 'must be an object');
         c.keys(raw, CONTENT_TYPE_KEYS, path);
         const name = c.string(raw, 'name', path);
@@ -7743,7 +7889,7 @@ function validateContentTypes(c, list) {
         const fields = c.array(raw, 'fields', path);
         const names = fields.map((f, j) => {
             const fp = `${path}.fields[${j}]`;
-            if (!isObject(f)) {
+            if (!isPlainObject(f)) {
                 c.add(SitePlanIssueCode.Shape, fp, 'must be an object');
                 return null;
             }
@@ -7764,7 +7910,7 @@ function validateContentTypes(c, list) {
         }
         const seed = raw['seed'];
         if (seed !== undefined) {
-            if (!isObject(seed))
+            if (!isPlainObject(seed))
                 c.add(SitePlanIssueCode.Shape, `${path}.seed`, 'must be an object');
             else {
                 if (!Number.isInteger(seed['count']) || seed['count'] < 0)
@@ -7789,7 +7935,7 @@ function validateDataSources(c, list, types) {
     const sources = new Map();
     list.forEach((raw, i) => {
         const path = `dataSources[${i}]`;
-        if (!isObject(raw))
+        if (!isPlainObject(raw))
             return c.add(SitePlanIssueCode.Shape, path, 'must be an object');
         const alias = c.string(raw, 'alias', path);
         if (alias && alias.startsWith(RESERVED_PREFIX)) {
@@ -7809,7 +7955,7 @@ function validateDataSources(c, list, types) {
             let routeParam;
             const byRoute = raw['filterByRouteParam'];
             if (byRoute !== undefined) {
-                if (!isObject(byRoute))
+                if (!isPlainObject(byRoute))
                     c.add(SitePlanIssueCode.Shape, `${path}.filterByRouteParam`, 'must be an object');
                 else {
                     c.keys(byRoute, ['field', 'routeParam'], `${path}.filterByRouteParam`);
@@ -7837,10 +7983,10 @@ function validateDataSources(c, list, types) {
             c.add(SitePlanIssueCode.InvalidDataSource, `${path}.type`, `must be "${PlanDataSourceType.Cms}" or "${PlanDataSourceType.Relative}"`);
         }
     });
-    c.unique(list.map(r => (isObject(r) && isNonEmptyString(r['alias']) ? r['alias'] : null)), i => `dataSources[${i}].alias`, 'alias');
+    c.unique(list.map(r => (isPlainObject(r) && isNonEmptyString(r['alias']) ? r['alias'] : null)), i => `dataSources[${i}].alias`, 'alias');
     // A relative source locates its subject (a single item) within a collection of the SAME type.
     list.forEach((raw, i) => {
-        if (!isObject(raw) || raw['type'] !== PlanDataSourceType.Relative)
+        if (!isPlainObject(raw) || raw['type'] !== PlanDataSourceType.Relative)
             return;
         const of = sources.get(raw['of']);
         const within = sources.get(raw['within']);
@@ -7857,7 +8003,7 @@ function validatePages(c, list, types, sources) {
     const homes = [];
     list.forEach((raw, i) => {
         const path = `pages[${i}]`;
-        if (!isObject(raw))
+        if (!isPlainObject(raw))
             return c.add(SitePlanIssueCode.Shape, path, 'must be an object');
         c.keys(raw, PAGE_KEYS, path);
         c.string(raw, 'key', path);
@@ -7898,7 +8044,7 @@ function validatePages(c, list, types, sources) {
         }
         c.array(raw, 'sections', path).forEach((s, j) => {
             const sp = `${path}.sections[${j}]`;
-            if (!isObject(s))
+            if (!isPlainObject(s))
                 return c.add(SitePlanIssueCode.Shape, sp, 'must be an object');
             c.keys(s, SECTION_KEYS, sp);
             const patternId = c.string(s, 'pattern', sp);
@@ -7911,7 +8057,7 @@ function validatePages(c, list, types, sources) {
                 c.add(SitePlanIssueCode.GlobalPattern, `${sp}.pattern`, `"${patternId}" is a header/footer pattern (globals)`);
             const slots = s['slots'];
             if (slots !== undefined) {
-                if (!isObject(slots))
+                if (!isPlainObject(slots))
                     c.add(SitePlanIssueCode.Shape, `${sp}.slots`, 'must be an object');
                 else {
                     const declared = patternSlots(pattern);
@@ -7970,8 +8116,8 @@ function validatePages(c, list, types, sources) {
             }
         });
     });
-    c.unique(list.map(p => (isObject(p) && isNonEmptyString(p['key']) ? p['key'] : null)), i => `pages[${i}].key`, 'page key');
-    c.unique(list.map(p => (isObject(p) && isNonEmptyString(p['route']) ? p['route'] : null)), i => `pages[${i}].route`, 'route');
+    c.unique(list.map(p => (isPlainObject(p) && isNonEmptyString(p['key']) ? p['key'] : null)), i => `pages[${i}].key`, 'page key');
+    c.unique(list.map(p => (isPlainObject(p) && isNonEmptyString(p['route']) ? p['route'] : null)), i => `pages[${i}].route`, 'route');
     if (homes.length !== 1)
         c.add(SitePlanIssueCode.Home, 'pages', `exactly one page is the home page (found ${homes.length})`);
 }
@@ -7983,7 +8129,7 @@ function nextSourceOf(sources, routeSource) {
     return null;
 }
 function validateGlobals(c, globals) {
-    if (!isObject(globals))
+    if (!isPlainObject(globals))
         return c.add(SitePlanIssueCode.Shape, 'globals', 'must be an object');
     c.keys(globals, Object.values(GlobalSlot), 'globals');
     for (const slot of Object.values(GlobalSlot)) {
@@ -7998,7 +8144,7 @@ function validateGlobals(c, globals) {
 /** Check a Site Plan against the plan shape and the pattern library. Never throws, never repairs. */
 function validateSitePlan(plan) {
     const c = new Collector();
-    if (!isObject(plan)) {
+    if (!isPlainObject(plan)) {
         c.add(SitePlanIssueCode.Shape, '', 'a site plan is an object');
         return { valid: false, issues: c.issues };
     }
@@ -9575,5 +9721,5 @@ function composeSection(patternId, input, options) {
  * Generated bundle index. Do not edit.
  */
 
-export { BAR_ITEMS_MAX, BAR_ITEMS_MIN, BASELINE_ROLES, BaselineRole, BindScope, CardBindTarget, ComposeError, ComposeIssueCode, DANGLING_LINK_CODES, DEFAULT_PHONE_MENU_BREAKPOINT, FACT_KEYS, GlobalSlot, NAV_PART_LABELS, NAV_SHAPE_COPY, NEUTRAL_STYLE_PROPS, NODE_BASELINES, NavPagesSource, NavRole, NavShape, NavShapeError, PRICING_PATTERN, PUBLISH_BLOCKING_PLACEHOLDERS, PatternDirective, PatternGlobalPosition, PatternOpens, PatternPlaceholder, PatternRecipe, PhoneMenuBreakpoint, PlaceholderKind, PlanDataSourceMode, PlanDataSourceType, RelativeOp, SAMPLE_IMAGE_REF, SITE_FACT_LABELS, SITE_HEADER_PATTERN, SITE_PATTERNS, SITE_PLAN_VERSION, SITE_TEMPLATES, SPEC_SITE_FACTS, SPEC_SITE_PATTERNS, SPEC_SITE_PLAN_SHAPE, SPEC_SITE_TEMPLATES, STUDIO_TEMPLATE, SitePlanError, SitePlanIssueCode, SitePlanSourceKind, SiteTemplateError, SiteTemplateId, addBarItem, altSourceScopes, assertStyleSlots, assertValidSitePlan, barIconForRoute, blocksPublish, composeNavHeader, composeSection, composeSite, createSerializedNode, findNavRoot, moveBarItem, navPages, navShapeBreakpoint, navShapeOf, nextSourceOf, nodeBindPaths, parseSampleImageRef, patternById, patternNeedsBinding, patternNodes, patternOptionalParts, patternScopes, patternSlots, patternTakesBinding, phoneMenuPages, planFromTemplate, planNavShape, releasedLayoutDefaults, removeBarItem, requiredShapeKeys, routeParams, sampleImageRef, setStyleProps, shapeKeys, siteNavPages, validateSitePlan, walkSerialized };
+export { BAR_ITEMS_MAX, BAR_ITEMS_MIN, BASELINE_ROLES, BaselineRole, BindScope, CardBindTarget, ComposeError, ComposeIssueCode, DANGLING_LINK_CODES, DEFAULT_PHONE_MENU_BREAKPOINT, FACT_KEYS, GlobalSlot, NAV_PART_LABELS, NAV_SHAPE_COPY, NEUTRAL_STYLE_PROPS, NODE_BASELINES, NavPagesSource, NavRole, NavShape, NavShapeError, PRICING_PATTERN, PUBLISH_BLOCKING_PLACEHOLDERS, PathIssueCollector, PatternDirective, PatternGlobalPosition, PatternOpens, PatternPlaceholder, PatternRecipe, PhoneMenuBreakpoint, PlaceholderKind, PlanDataSourceMode, PlanDataSourceType, RelativeOp, SAMPLE_IMAGE_REF, SITE_FACT_LABELS, SITE_HEADER_PATTERN, SITE_PATTERNS, SITE_PLAN_VERSION, SITE_TEMPLATES, SPEC_SITE_FACTS, SPEC_SITE_LIBRARY, SPEC_SITE_PATTERNS, SPEC_SITE_PLAN_SHAPE, SPEC_SITE_TEMPLATES, STUDIO_TEMPLATE, SitePlanError, SitePlanIssueCode, SitePlanSourceKind, SiteTemplateError, SiteTemplateId, addBarItem, altSourceScopes, assertStyleSlots, assertValidSitePlan, barIconForRoute, blocksPublish, composeNavHeader, composeSection, composeSite, createSerializedNode, findNavRoot, isNonEmptyString, isPlainObject, moveBarItem, navPages, navShapeBreakpoint, navShapeOf, nextSourceOf, nodeBindPaths, parseSampleImageRef, pathAt, patternById, patternNeedsBinding, patternNodes, patternOptionalParts, patternScopes, patternSlots, patternTakesBinding, phoneMenuPages, planFromTemplate, planNavShape, releasedLayoutDefaults, removeBarItem, requiredShapeKeys, routeParams, sampleImageRef, setStyleProps, shapeKeys, siteNavPages, validateSitePlan, walkSerialized };
 //# sourceMappingURL=vectoriox-iox-ui-generation-core.mjs.map