@zohofinance/commerce 2.2.1 → 2.2.2

package/VALIDATIONS.md

@@ -11,7 +11,7 @@ Findings are printed in groups: missing translation keys, invalid JSON, section
 | Error | Preview is replaced with a validation page. The dev server stays up and rechecks when files change. | The errors are printed, the command throws, and no zip is written. |
 | Warning | Printed. Preview continues. | Printed. The zip is still written. |
 
-A section file that is missing `available_in` or a named preset is the one check whose severity depends on the command. It is a warning during `theme dev` and an error during `theme build`.
+A section that declares `available_in` but has no named preset is the one check whose severity depends on the command. It is a warning during `theme dev` and an error during `theme build`.
 
 Everything else below is an error unless it is marked as a warning.
 
@@ -43,22 +43,24 @@ Checked on the `{% schema %}` block in `sections/*.liquid` and `blocks/*.liquid`
 
 - The schema must be valid JSON.
 - A block file with no schema is a **warning**.
-- A section file with no schema is treated as missing both `available_in` and a named preset.
+- A section file with no schema is allowed at file level. If that section is placed in a page or section-group JSON, the placement check below still fails because `available_in` cannot list the page.
 - `name` is required and must be a non-empty string. `tag` and `class`, when set, must be strings.
 - `max_blocks`, when set, must be a positive integer.
 
 ### `available_in` and `presets` on sections
 
-Every `sections/*.liquid` file must have:
+`available_in` is not required on every section file. Placement is checked from each page / section-group JSON instead (see below).
 
-- `available_in.templates` with at least one page
-- `presets` as an array, with every preset object carrying a non-empty `name`
+When a section does declare `available_in`:
+
+- `available_in.templates` must be a non-empty array of page keys
+- `presets` must be an array with every preset object carrying a non-empty `name`
 
 Preset objects may also include `settings`, `blocks`, and other defaults. A missing array, an empty array, or a preset without a name fails this check. `theme dev` logs it and still previews. `theme build` logs it, throws, and does not create the zip.
 
 Allowed page values are `index`, `cart`, `product`, `page`, `blog`, `blogs`, `collection`, `category`, `checkout`, `orders`, `search`, `404`, `header-group`, and `footer-group`. A value outside that list is a **warning** in both commands. A malformed `available_in` (not an object, `templates` not an array, or a non-string entry) is also a **warning**.
 
-Block files do not require `available_in` or `presets`.
+Block files do not use `available_in` or `presets`.
 
 ### Settings
 
@@ -101,6 +103,7 @@ Checked on `pages/*.json` and on `sections/*.json` (header and footer groups).
 - `order` must be an array and `sections` must be an object.
 - Each `order` entry must name a section that exists in `sections` and has `type`. Listing the same section twice is a **warning**.
 - `sections/<type>.liquid` must exist. Types starting with `custom_section_` are stored outside the theme and are not looked up as theme files.
+- On editable pages and section groups only (`index`, `cart`, `product`, `page`, `blog`, `blogs`, `collection`, `category`, `checkout`, `orders`, `search`, `404`, `header-group`, `footer-group`), each placed theme section's schema must list this JSON's basename in `available_in.templates` (e.g. every section in `pages/index.json` must include `"index"`). Non-editable page JSON (`signin`, `account-*`, etc.) skips this check. `custom_section_*` types also skip it.
 - A section present in `sections` but missing from `order` is a **warning**. It is never rendered.
 - `blocks` and `block_order` must be set together: `blocks` is an object and `block_order` is an array.
 - Every `block_order` entry must exist in `blocks` and must have `type`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohofinance/commerce",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "main": "ts-dist/index.js",
   "bin": {
     "zcommerce": "ts-dist/index.js"

package/ts-dist/mocks/init-theme/package.json

@@ -9,7 +9,7 @@
     }
   },
   "scripts": {
-    "build": "zcommerce theme build --prod",
+    "build": "zcommerce theme build",
     "dev": "zcommerce theme dev"
   }
 }

package/ts-dist/mocks/init-theme/sections/promo-banner.liquid

@@ -35,12 +35,6 @@
       "label": "t:sections.promo_banner.settings.eyebrow.label",
       "default": "t:sections.promo_banner.settings.eyebrow.default"
     },
-    {
-      "type": "textarea",
-      "id": "subtext",
-      "label": "t:sections.promo_banner.settings.subtext.label",
-      "default": "t:sections.promo_banner.settings.subtext.default"
-    },
     {
       "type": "text",
       "id": "cta_label",

package/ts-dist/utils/schema-validation.d.ts

@@ -7,6 +7,7 @@
 export declare const MAX_BLOCK_NESTING_DEPTH = 5;
 export declare const EDITABLE_PAGE_KEYS: readonly ["index", "cart", "product", "page", "blog", "blogs", "collection", "category", "checkout", "orders", "search", "404"];
 export declare const SECTION_GROUP_KEYS: readonly ["header-group", "footer-group"];
+export declare function isEditableTemplateName(name: string): boolean;
 /** Engine SchemaValidator.KNOWN_SETTING_TYPES plus color_scheme. */
 export declare const SUPPORTED_SETTING_TYPES: Set<string>;
 export type JsonRecord = Record<string, unknown>;
@@ -18,10 +19,10 @@ export type SchemaFinding = {
 export declare function validateSchemaDocument(schema: JsonRecord, options?: {
     requireAvailableIn?: boolean;
     requirePresets?: boolean;
-    /** Severity for a missing available_in or a missing named preset. */
     requirementSeverity?: 'error' | 'warning';
     themeBlockSchemas?: Map<string, JsonRecord>;
 }): SchemaFinding[];
+export declare function schemaAllowsTemplate(schema: JsonRecord | null | undefined, templateName: string): boolean;
 export declare function isBlockTypeAllowed(containerSchema: JsonRecord | null, blockType: string): boolean;
 /**
  * Schema whose `blocks` allow a placed block's children.

package/ts-dist/utils/schema-validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema-validation.d.ts","sourceRoot":"","sources":["../../src/utils/schema-validation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,uBAAuB,IAAI,CAAC;AAEzC,eAAO,MAAM,kBAAkB,iIAarB,CAAC;AAEX,eAAO,MAAM,kBAAkB,2CAA4C,CAAC;AAO5E,oEAAoE;AACpE,eAAO,MAAM,uBAAuB,aAqBlC,CAAC;AAiBH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEjD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAE5D;AAUD,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B,CAAC;AAUF,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,UAAU,EAClB,OAAO,GAAE;IACP,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qEAAqE;IACrE,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACxC,GACL,aAAa,EAAE,CAsCjB;AAogBD,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,UAAU,GAAG,IAAI,EAClC,SAAS,EAAE,MAAM,GAChB,OAAO,CAoCT;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,eAAe,EAAE,UAAU,GAAG,IAAI,EAClC,SAAS,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAC1C,UAAU,GAAG,IAAI,CAoBnB;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,EAAE,CAgBpE;AAED,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,OAAO,GAAG,aAAa,EAAE,CA2B5E;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,EAAE,CA4CxE"}
+{"version":3,"file":"schema-validation.d.ts","sourceRoot":"","sources":["../../src/utils/schema-validation.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,uBAAuB,IAAI,CAAC;AAEzC,eAAO,MAAM,kBAAkB,iIAarB,CAAC;AAEX,eAAO,MAAM,kBAAkB,2CAA4C,CAAC;AAO5E,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE5D;AAED,oEAAoE;AACpE,eAAO,MAAM,uBAAuB,aAqBlC,CAAC;AAiBH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEjD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAE5D;AAUD,MAAM,MAAM,aAAa,GAAG;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;CAC/B,CAAC;AAUF,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,UAAU,EAClB,OAAO,GAAE;IACP,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC1C,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACxC,GACL,aAAa,EAAE,CAuCjB;AAED,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,UAAU,GAAG,IAAI,GAAG,SAAS,EACrC,YAAY,EAAE,MAAM,GACnB,OAAO,CAMT;AAkgBD,wBAAgB,kBAAkB,CAChC,eAAe,EAAE,UAAU,GAAG,IAAI,EAClC,SAAS,EAAE,MAAM,GAChB,OAAO,CAoCT;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CACzC,eAAe,EAAE,UAAU,GAAG,IAAI,EAClC,SAAS,EAAE,MAAM,EACjB,iBAAiB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,GAC1C,UAAU,GAAG,IAAI,CAoBnB;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,EAAE,CAgBpE;AAED,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,OAAO,GAAG,aAAa,EAAE,CA2B5E;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,EAAE,CA4CxE"}

package/ts-dist/utils/schema-validation.js

@@ -24,6 +24,9 @@ const ALLOWED_AVAILABLE_IN = new Set([
     ...EDITABLE_PAGE_KEYS,
     ...SECTION_GROUP_KEYS
 ]);
+export function isEditableTemplateName(name) {
+    return ALLOWED_AVAILABLE_IN.has(name);
+}
 /** Engine SchemaValidator.KNOWN_SETTING_TYPES plus color_scheme. */
 export const SUPPORTED_SETTING_TYPES = new Set([
     'checkbox',
@@ -85,12 +88,20 @@ export function validateSchemaDocument(schema, options = {}) {
         push(issues, 'max_blocks must be a positive integer');
     }
     const requirementSeverity = options.requirementSeverity ?? 'warning';
+    const requirePresets = options.requirePresets === true || 'available_in' in schema;
     validateAvailableIn(schema, issues, options.requireAvailableIn === true, requirementSeverity);
     validateSettingsArray(schema.settings, 'settings', issues);
     validateSchemaBlocks(schema.blocks, 'blocks', issues, 1);
-    validatePresets(schema, issues, options.requirePresets === true, options.themeBlockSchemas, requirementSeverity);
+    validatePresets(schema, issues, requirePresets, options.themeBlockSchemas, requirementSeverity);
     return issues;
 }
+export function schemaAllowsTemplate(schema, templateName) {
+    if (!schema || !isRecord(schema.available_in)) {
+        return false;
+    }
+    const templates = schema.available_in.templates;
+    return Array.isArray(templates) && templates.includes(templateName);
+}
 function validateAvailableIn(schema, issues, required, requirementSeverity) {
     if (!('available_in' in schema)) {
         if (required) {
@@ -104,17 +115,15 @@ function validateAvailableIn(schema, issues, required, requirementSeverity) {
     }
     const templates = schema.available_in.templates;
     if (templates === undefined || templates === null) {
-        if (required) {
-            push(issues, 'available_in.templates must contain at least one page', requirementSeverity);
-        }
+        push(issues, 'available_in.templates must contain at least the pages the sections are present in json', requirementSeverity);
         return;
     }
     if (!Array.isArray(templates)) {
         push(issues, 'available_in.templates must be an array', 'warning');
         return;
     }
-    if (required && templates.length === 0) {
-        push(issues, 'available_in.templates must contain at least one page', requirementSeverity);
+    if (templates.length === 0) {
+        push(issues, 'available_in.templates must contain at least the pages the sections are present in json', requirementSeverity);
     }
     templates.forEach((value, index) => {
         const path = `available_in.templates[${index}]`;

package/ts-dist/utils/template-reference-validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"template-reference-validation.d.ts","sourceRoot":"","sources":["../../src/utils/template-reference-validation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AA8J7D,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,KAAK,GAAG,OAAiB,GAC9B,eAAe,EAAE,CA6GnB;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,EAAE,CAsCzE;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,EAAE,CAsKnE;AAkOD,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,EAAE,CAkFvE"}
+{"version":3,"file":"template-reference-validation.d.ts","sourceRoot":"","sources":["../../src/utils/template-reference-validation.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAgK7D,wBAAgB,qBAAqB,CACnC,GAAG,EAAE,MAAM,EACX,IAAI,GAAE,KAAK,GAAG,OAAiB,GAC9B,eAAe,EAAE,CAqFnB;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,EAAE,CAsCzE;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,EAAE,CAuLnE;AAkOD,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,EAAE,CAkFvE"}

package/ts-dist/utils/template-reference-validation.js

@@ -5,7 +5,7 @@
  */
 import fs from 'fs-extra';
 import path from 'path';
-import { MAX_BLOCK_NESTING_DEPTH, declaredThemeBlockNames, isBlockTypeAllowed, isRecord, resolveChildContainerSchema, validateSchemaDocument, validateThemeSettingsData, validateThemeSettingsGroups } from './schema-validation.js';
+import { MAX_BLOCK_NESTING_DEPTH, declaredThemeBlockNames, isBlockTypeAllowed, isEditableTemplateName, isRecord, resolveChildContainerSchema, schemaAllowsTemplate, validateSchemaDocument, validateThemeSettingsData, validateThemeSettingsGroups } from './schema-validation.js';
 const SCHEMA_BLOCK = /\{%-?\s*schema\s*-?%\}([\s\S]*?)\{%-?\s*endschema\s*-?%\}/;
 const UNSUPPORTED_TAGS = new Set([
     'paginate',
@@ -129,8 +129,8 @@ export function validateLiquidSchemas(cwd, mode = 'build') {
     const issues = [];
     const themeBlockSchemas = loadSchemaIndex(cwd, 'blocks');
     const themeBlockFiles = liquidBaseNames(cwd, 'blocks');
+    // available_in → presets requirement: warning in dev, error in build.
     const sectionRequirementSeverity = mode === 'build' ? 'error' : 'warning';
-    // Requirement findings are warnings in dev but errors in build.
     const requirementFailsBuild = mode !== 'build';
     for (const folder of ['sections', 'blocks']) {
         const dir = path.join(cwd, folder);
@@ -145,10 +145,6 @@ export function validateLiquidSchemas(cwd, mode = 'build') {
                 if (folder === 'blocks') {
                     issues.push(issue('schema', 'Theme block file must contain {% schema %}...{% endschema %}', relative, 'warning'));
                 }
-                else {
-                    issues.push(issue('schema', 'available_in is required and must list at least one page in available_in.templates', relative, sectionRequirementSeverity, requirementFailsBuild));
-                    issues.push(issue('schema', 'presets must contain at least one preset with a name', relative, sectionRequirementSeverity, requirementFailsBuild));
-                }
                 continue;
             }
             if (extracted.invalid) {
@@ -159,8 +155,8 @@ export function validateLiquidSchemas(cwd, mode = 'build') {
                 continue;
             }
             const schemaOptions = {
-                requireAvailableIn: folder === 'sections',
-                requirePresets: folder === 'sections',
+                requireAvailableIn: false,
+                requirePresets: false,
                 themeBlockSchemas
             };
             const messages = validateSchemaDocument(extracted.schema, {
@@ -168,12 +164,7 @@ export function validateLiquidSchemas(cwd, mode = 'build') {
                 requirementSeverity: folder === 'sections' ? sectionRequirementSeverity : 'error'
             });
             // Same findings, in the same order, as build would report them.
-            const buildMessages = requirementFailsBuild
-                ? validateSchemaDocument(extracted.schema, {
-                    ...schemaOptions,
-                    requirementSeverity: 'error'
-                })
-                : messages;
+            const buildMessages = requirementFailsBuild ? validateSchemaDocument(extracted.schema, { ...schemaOptions, requirementSeverity: 'error' }) : messages;
             messages.forEach((finding, index) => {
                 issues.push(issue('schema', finding.message, relative, finding.severity, finding.severity === 'warning' &&
                     buildMessages[index]?.severity === 'error'));
@@ -236,6 +227,7 @@ export function validateTemplateJson(cwd) {
         if (!isRecord(parsed)) {
             continue;
         }
+        const templateName = path.basename(relative, '.json');
         if (typeof parsed.layout === 'string' && parsed.layout.trim()) {
             const layoutFile = `layouts/${parsed.layout}.liquid`;
             if (!fs.existsSync(path.join(cwd, layoutFile))) {
@@ -281,6 +273,11 @@ export function validateTemplateJson(cwd) {
                 }
             }
             const sectionSchema = sectionSchemas.get(type) ?? null;
+            if (!type.startsWith(CUSTOM_SECTION_PREFIX) &&
+                isEditableTemplateName(templateName) &&
+                !schemaAllowsTemplate(sectionSchema, templateName)) {
+                issues.push(issue('page', `Section '${type}' is used here but its available_in.templates does not include '${templateName}'`, relative));
+            }
             validatePlacedBlocks(section, sectionSchema, entry, relative, issues, themeBlockSchemas, themeBlockFiles, 1);
             if (sectionSchema &&
                 typeof sectionSchema.max_blocks === 'number' &&

package/ts-dist/utils/theme-validation.js

@@ -167,8 +167,8 @@ function validateRequiredFiles(cwd) {
 }
 export async function validateTheme(cwd = process.cwd(), options = {}) {
     const mode = options.mode ?? 'build';
-    // Dev and build share one rule set. A section missing available_in or a
-    // named preset is logged in dev and blocks the zip on build.
+    // Dev and build share one rule set. A section that declares available_in
+    // without a named preset is logged in dev and blocks the zip on build.
     if (mode !== 'dev' && mode !== 'build') {
         return { valid: true, issues: [] };
     }