@pagefront/lint-commerce 0.8.0 → 0.10.0

package/README.md

@@ -26,9 +26,11 @@ lint with their own catalogue, dispatched by sheet type.
 
 ## Catalogue
 
-Catalogue 0.11.0, targeting format 0.9: 48 product rules (`PDP-E-001` to
-`PDP-E-012`, `PDP-W-001` to `PDP-W-035`, `PDP-I-001`) and 7 organization
-rules (`ORG-E-001`, `ORG-W-001` to `ORG-W-006`), each defined in
+Catalogue 0.15.0, supporting commerce release 0.3.0 (Product Sheet spec
+0.9.0, Organization Sheet spec 0.3.0) and the legacy draft line (format
+0.9): 56 product rules (`PDP-E-001` to `PDP-E-016`, `PDP-W-001` to
+`PDP-W-039`, `PDP-I-001`) and 9 organization rules (`ORG-E-001` to
+`ORG-E-003`, `ORG-W-001` to `ORG-W-006`), each defined in
 [`rules.md`](https://github.com/themachineweb/pagefront/blob/main/commerce/spec/rules.md)
 with its target, check, message and remediation. Every report carries the
 `catalogue_version` it was produced with.
@@ -93,6 +95,54 @@ configurator now fails Layer 1.
 
 Amounts are summed and compared as exact decimals.
 
+Added in 0.9.0 (catalogue 0.14.0), from the same section and from
+["Size guidance"](https://themachineweb.org/pagefront/spec/commerce/product#size-guidance-pagefrontsizechart-and-pagefrontsizerecommendation):
+option values are identifiers, free-text dimensions, order-time services
+kept out of `options`, notes as facts, and size advice in the sizing
+dimension's system. From 0.9.0 every amount is a JSON number or a plain
+decimal string, one carrier per Sheet, and amounts are compared numerically
+whatever the carrier; 0.8.0 validated pricing-block amounts as decimal
+strings only. An Offer's `price`, a variant's `price` and a promotion's
+`discountAmount` no longer accept a string that is not a plain decimal, and
+prices, bounds and base prices no longer accept a negative amount.
+
+- `PDP-E-013` — a dimension declares `inputType: "text"` and enumerates
+  options
+- `PDP-W-036` — an option value looks like a display label (whitespace,
+  an uppercase letter, or a unit suffix); sizing dimensions are exempt
+- `PDP-W-037` — an option in a sizing dimension (`system` of `UK`, `EU`,
+  `US` or `JP`) is not written as a size in that system
+- `PDP-W-032`, `PDP-E-009` and the computed band of `PDP-E-011` now cover
+  the `"*"` modifier of a priced text dimension
+- `PDP-E-014` — a size adjustment's `sizeSystem` is another system than
+  the configurator's sizing dimension
+- `PDP-E-015` — the Sheet's amounts mix JSON numbers and strings
+- `PDP-W-038` — a configurator dimension's `note` reads as page copy
+  (English Sheets: `you`, `your`, `select`, `order`, `contact`)
+- `PDP-W-039` — size advice carries a `description` and no
+  `sizeAdjustment` beside a sizing dimension
+
+Added in 0.10.0 (catalogue 0.15.0), with commerce release 0.3.0 and the
+[versioning scheme](https://github.com/themachineweb/pagefront/blob/main/commerce/spec/releases.md)
+that replaces format versions:
+
+- Sheets carry `release` in place of `format_version`, and `$schema` names
+  the sheet-spec version (`product/v0.9.0.json`, `organization/v0.3.0.json`).
+  Sheets carrying `format_version` are the legacy draft line and keep
+  validating against the bundled legacy schemas.
+- `PDP-E-002` becomes "Release / schema mismatch": `$schema` must name the
+  sheet-spec version the release manifest maps the declared `release` to.
+  On legacy sheets it compares `format_version` with `$schema`, as before.
+  `ORG-E-003` is the same check for Organization Sheets.
+- `PDP-E-016` and `ORG-E-002` — a sheet carries both `format_version` and
+  `release`
+- **Breaking:** the report carries `release` (the value the sheet declares;
+  a legacy sheet's `format_version` value) and `sheet_spec_version` (parsed
+  from `$schema`) in place of `spec_version`. Requires
+  `@pagefront/lint-core` 0.2.0.
+- New exports: `detectSheetLine`, `RELEASE_MANIFEST`, `KNOWN_RELEASES`,
+  `sheetSpecVersionFor`.
+
 ## API
 
 The public surface — everything importable from the package root, and
@@ -106,9 +156,11 @@ internal):
   Commerce Organization Sheets to the organization ones (see
   `detectSheetType`). Returns
   `{ layer: 1, schemaErrors: SchemaError[] }` or
-  `{ layer: 2, report: Report }`. The bundled schemas are the current
-  format version; a document declaring another `format_version` fails
-  Layer 1 by design. Layer 1 runs validators compiled ahead of time at
+  `{ layer: 2, report: Report }`. Two lines are validated: a sheet
+  carrying `release` against the current sheet-spec schema for its type,
+  and a legacy sheet carrying `format_version` against the frozen legacy
+  schema (format 0.9). A sheet carrying both fields fails Layer 1.
+  Layer 1 runs validators compiled ahead of time at
   package build, so the pipeline needs no runtime code generation and
   runs under Cloudflare Workers and strict Content Security Policies.
 - `lintSheet(sheet: Sheet, options?: LintOptions): Report` — Layer 2
@@ -184,6 +236,12 @@ await writeFile("report.html", renderHtml(report));
 
 ## Versioning
 
+This package has its own semver, separate from the rule catalogue's
+(`catalogue_version` in every report) and from the commerce release and
+sheet-spec versions a sheet declares (`release` and `sheet_spec_version`
+in every report). The scheme is in
+[`releases.md`](https://github.com/themachineweb/pagefront/blob/main/commerce/spec/releases.md).
+
 Pre-1.0: minor versions may break the API. The surface listed above is
 what versioning tracks — imports that reach past it (`dist/` paths,
 rule modules) are internal and may change without notice in any

package/dist/catalogue.js

@@ -1,3 +1,4 @@
+import { KNOWN_RELEASES } from "./releases.js";
 import { pdpE001 } from "./rules/pdp-e-001.js";
 import { pdpE002 } from "./rules/pdp-e-002.js";
 import { pdpE003 } from "./rules/pdp-e-003.js";
@@ -10,6 +11,10 @@ import { pdpE009 } from "./rules/pdp-e-009.js";
 import { pdpE010 } from "./rules/pdp-e-010.js";
 import { pdpE011 } from "./rules/pdp-e-011.js";
 import { pdpE012 } from "./rules/pdp-e-012.js";
+import { pdpE013 } from "./rules/pdp-e-013.js";
+import { pdpE014 } from "./rules/pdp-e-014.js";
+import { pdpE015 } from "./rules/pdp-e-015.js";
+import { pdpE016 } from "./rules/pdp-e-016.js";
 import { pdpW001 } from "./rules/pdp-w-001.js";
 import { pdpW002 } from "./rules/pdp-w-002.js";
 import { pdpW003 } from "./rules/pdp-w-003.js";
@@ -45,6 +50,10 @@ import { pdpW032 } from "./rules/pdp-w-032.js";
 import { pdpW033 } from "./rules/pdp-w-033.js";
 import { pdpW034 } from "./rules/pdp-w-034.js";
 import { pdpW035 } from "./rules/pdp-w-035.js";
+import { pdpW036 } from "./rules/pdp-w-036.js";
+import { pdpW037 } from "./rules/pdp-w-037.js";
+import { pdpW038 } from "./rules/pdp-w-038.js";
+import { pdpW039 } from "./rules/pdp-w-039.js";
 import { pdpI001 } from "./rules/pdp-i-001.js";
 /**
  * The commerce product-sheet rule catalogue — the executable form of
@@ -55,7 +64,7 @@ import { pdpI001 } from "./rules/pdp-i-001.js";
  */
 export const commerceCatalogue = {
     vertical: "commerce",
-    formatVersion: "0.9",
-    catalogueVersion: "0.11.0",
-    rules: [pdpE001, pdpE002, pdpE003, pdpE004, pdpE005, pdpE006, pdpE007, pdpE008, pdpE009, pdpE010, pdpE011, pdpE012, pdpW001, pdpW002, pdpW003, pdpW004, pdpW005, pdpW006, pdpW007, pdpW008, pdpW009, pdpW010, pdpW011, pdpW012, pdpW013, pdpW014, pdpW015, pdpW016, pdpW017, pdpW018, pdpW019, pdpW020, pdpW021, pdpW022, pdpW023, pdpW024, pdpW025, pdpW026, pdpW027, pdpW028, pdpW029, pdpW030, pdpW031, pdpW032, pdpW033, pdpW034, pdpW035, pdpI001],
+    releases: KNOWN_RELEASES,
+    catalogueVersion: "0.15.0",
+    rules: [pdpE001, pdpE002, pdpE003, pdpE004, pdpE005, pdpE006, pdpE007, pdpE008, pdpE009, pdpE010, pdpE011, pdpE012, pdpE013, pdpE014, pdpE015, pdpE016, pdpW001, pdpW002, pdpW003, pdpW004, pdpW005, pdpW006, pdpW007, pdpW008, pdpW009, pdpW010, pdpW011, pdpW012, pdpW013, pdpW014, pdpW015, pdpW016, pdpW017, pdpW018, pdpW019, pdpW020, pdpW021, pdpW022, pdpW023, pdpW024, pdpW025, pdpW026, pdpW027, pdpW028, pdpW029, pdpW030, pdpW031, pdpW032, pdpW033, pdpW034, pdpW035, pdpW036, pdpW037, pdpW038, pdpW039, pdpI001],
 };

package/dist/index.d.ts

@@ -7,8 +7,10 @@
  * `validateOrganizationSheet` (Layer 1 for the Commerce Organization
  * Sheet; no organization catalogue exists yet), the commerce
  * catalogue object, and the types those signatures mention.
- * `product-schema.ts`, `organization-schema.ts`, and the individual
- * rule modules are internal.
+ * `product-schema.ts`, `organization-schema.ts`, `legacy-schemas.ts`
+ * and the individual rule modules are internal. The release manifest
+ * (`RELEASE_MANIFEST`, `sheetSpecVersionFor`) is exported so callers
+ * can resolve a release to its sheet-spec versions.
  */
 export { lintSheet } from "./lint-sheet.js";
 export { validateAndLint } from "./validate-and-lint.js";
@@ -17,6 +19,7 @@ export { validateOrganizationSheet } from "./validate-organization.js";
 export type { ValidateOrganizationResult } from "./validate-organization.js";
 export { commerceCatalogue } from "./catalogue.js";
 export { organizationCatalogue } from "./organization-catalogue.js";
-export { detectSheetType } from "./sheet-type.js";
-export type { SheetType } from "./sheet-type.js";
+export { detectSheetType, detectSheetLine } from "./sheet-type.js";
+export type { SheetType, SheetLine } from "./sheet-type.js";
+export { RELEASE_MANIFEST, KNOWN_RELEASES, sheetSpecVersionFor } from "./releases.js";
 export type { Report, Finding, Summary, Severity, LintOptions, Sheet, } from "@pagefront/lint-core";

package/dist/index.js

@@ -7,12 +7,15 @@
  * `validateOrganizationSheet` (Layer 1 for the Commerce Organization
  * Sheet; no organization catalogue exists yet), the commerce
  * catalogue object, and the types those signatures mention.
- * `product-schema.ts`, `organization-schema.ts`, and the individual
- * rule modules are internal.
+ * `product-schema.ts`, `organization-schema.ts`, `legacy-schemas.ts`
+ * and the individual rule modules are internal. The release manifest
+ * (`RELEASE_MANIFEST`, `sheetSpecVersionFor`) is exported so callers
+ * can resolve a release to its sheet-spec versions.
  */
 export { lintSheet } from "./lint-sheet.js";
 export { validateAndLint } from "./validate-and-lint.js";
 export { validateOrganizationSheet } from "./validate-organization.js";
 export { commerceCatalogue } from "./catalogue.js";
 export { organizationCatalogue } from "./organization-catalogue.js";
-export { detectSheetType } from "./sheet-type.js";
+export { detectSheetType, detectSheetLine } from "./sheet-type.js";
+export { RELEASE_MANIFEST, KNOWN_RELEASES, sheetSpecVersionFor } from "./releases.js";

package/dist/legacy-schemas.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The legacy draft line's JSON Schemas (commerce/spec/legacy/*.v0.9.json),
+ * bundled verbatim so sheets carrying `format_version` keep validating
+ * against the schemas their `$schema` URLs name. The files are frozen:
+ * the schema drift test (test/schema.test.mjs) fails if a bundled copy
+ * and its source diverge.
+ */
+export declare const LEGACY_PRODUCT_SCHEMA: Record<string, unknown>;
+export declare const LEGACY_ORGANIZATION_SCHEMA: Record<string, unknown>;