@adobe/spacecat-shared-data-access 4.13.0 → 4.15.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [@adobe/spacecat-shared-data-access-v4.15.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v4.14.0...@adobe/spacecat-shared-data-access-v4.15.0) (2026-07-29)
+
+### Features
+
+* **site-config:** add showWww flag to llmo config ([#1850](https://github.com/adobe/spacecat-shared/issues/1850)) ([e87b454](https://github.com/adobe/spacecat-shared/commit/e87b45481d2b34cdb9f86e569f7598dea967ed6e))
+
+## [@adobe/spacecat-shared-data-access-v4.14.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v4.13.0...@adobe/spacecat-shared-data-access-v4.14.0) (2026-07-27)
+
+### Features
+
+* **data-access:** derive portable JSON Schema artifact for changeDetails v2 (SITES-47997) ([#1830](https://github.com/adobe/spacecat-shared/issues/1830)) ([02163de](https://github.com/adobe/spacecat-shared/commit/02163dea72d007678777b8341d0ded2b97fb56cf)), closes [#1828](https://github.com/adobe/spacecat-shared/issues/1828) [blocking-#4](https://github.com/adobe/blocking-/issues/4)
+
 ## [@adobe/spacecat-shared-data-access-v4.13.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v4.12.0...@adobe/spacecat-shared-data-access-v4.13.0) (2026-07-23)
 
 ### Features

package/CLAUDE.md

@@ -277,6 +277,17 @@ validated "deploy action" record (who/when/what/which-pages/result) from ADR
     `CALL_STATUSES`, `APPLIED`, `CHANGE_RESULT_STATUSES`, `VERIFY_VERDICTS`,
     `SCHEMA_VERSION`, `DEPLOY_RESPONSE_PAYLOAD_MAX_BYTES`). Kept on the model
     (not the barrel) to avoid collisions on these generic names.
+- **Portable JSON Schema artifact** (for the Python runtime, mystique). The Joi
+  schema is the single source of truth; a **JSON Schema is derived from it** and
+  shipped at `schemas/fix-entity-change-details.v2.schema.json` (draft-2019-09).
+  Regenerate with `npm run generate:schemas` (script:
+  `scripts/generate-change-details-schema.js`, uses `joi-to-json`); a unit test
+  fails CI if the committed artifact drifts from the Joi schema. mystique vendors
+  this file and validates against it. **Caveat:** JSON Schema captures
+  structure/enums/required/patterns only — the cross-field invariants
+  (`changeResults`↔`target.changes` key-match, `applied:ALL` completeness,
+  `deployResponsePayload` 4 KB cap) are Joi `.custom()` rules and are NOT in the
+  artifact; a consumer needing them must port those checks.
 - **Not yet done** (tracked on SITES-47997): the `publishedBy` column +
   `executedBy/At` → `deployedBy/At` rename (dual-write, needs a companion
   mysticat-data-service migration), and gating the `DEPLOYED`/`PUBLISHED`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "4.13.0",
+  "version": "4.15.0",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "engines": {
@@ -19,7 +19,8 @@
     "test:debug:grep": "mocha --inspect-brk --require ./test/setup-env.js --grep",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
-    "clean": "rm -rf package-lock.json node_modules"
+    "clean": "rm -rf package-lock.json node_modules",
+    "generate:schemas": "node scripts/generate-change-details-schema.js"
   },
   "mocha": {
     "require": "test/setup-env.js",
@@ -42,9 +43,9 @@
   "dependencies": {
     "@adobe/fetch": "^4.2.3",
     "@adobe/spacecat-shared-utils": "1.105.0",
-    "@supabase/postgrest-js": "2.106.2",
     "@aws-sdk/client-s3": "^3.940.0",
     "@smithy/util-retry": "^4.0.0",
+    "@supabase/postgrest-js": "2.106.2",
     "@types/joi": "17.2.3",
     "aws-xray-sdk": "3.12.0",
     "joi": "18.2.1",
@@ -54,6 +55,7 @@
     "chai": "6.2.2",
     "chai-as-promised": "8.0.2",
     "electrodb": "3.9.0",
+    "joi-to-json": "^5.0.5",
     "nock": "14.0.15",
     "sinon": "22.0.0",
     "sinon-chai": "4.0.1"

package/schemas/fix-entity-change-details.v2.schema.json

@@ -0,0 +1,268 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "https://ns.adobe.com/spacecat/fix-entity/change-details/v2",
+  "title": "FixEntity changeDetails v2",
+  "description": "Canonical v2 deploy-action record for FixEntity.changeDetails (SITES-47997, ADR adobe/mysticat-architecture#200). GENERATED from the Joi source of truth (changeDetailsV2Schema in spacecat-shared-data-access) — DO NOT EDIT BY HAND; run `npm run generate:schemas -w packages/spacecat-shared-data-access`. Structure/enums/required/patterns only: the cross-field invariants (changeResults<->target.changes key-match, applied:ALL completeness, deployResponsePayload 4KB cap) are Joi-enforced and NOT expressible in JSON Schema.",
+  "type": "object",
+  "properties": {
+    "schemaVersion": {
+      "const": 2
+    },
+    "surface": {
+      "type": "string",
+      "enum": [
+        "ASO",
+        "AUTHOR_PUBLISH",
+        "GIT_MERGE",
+        "SYSTEM"
+      ]
+    },
+    "actorType": {
+      "type": "string",
+      "enum": [
+        "IMS_USER",
+        "SERVICE",
+        "GITHUB",
+        "DETECTOR",
+        "UNKNOWN"
+      ]
+    },
+    "target": {
+      "type": "object",
+      "properties": {
+        "system": {
+          "type": "string"
+        },
+        "changeType": {
+          "type": "string"
+        },
+        "siteId": {
+          "type": "string"
+        },
+        "pageId": {
+          "type": "string"
+        },
+        "documentPath": {
+          "type": "string"
+        },
+        "detectedPageAuthorUrl": {
+          "type": "string"
+        },
+        "changes": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "object",
+            "properties": {
+              "targetPath": {
+                "type": "string"
+              },
+              "property": {
+                "type": "string"
+              },
+              "intendedValue": {
+                "type": [
+                  "array",
+                  "boolean",
+                  "number",
+                  "object",
+                  "string",
+                  "null"
+                ]
+              }
+            },
+            "required": [
+              "targetPath",
+              "property",
+              "intendedValue"
+            ],
+            "additionalProperties": false
+          }
+        }
+      },
+      "required": [
+        "changeType",
+        "changes"
+      ],
+      "additionalProperties": false
+    },
+    "result": {
+      "type": "object",
+      "properties": {
+        "callStatus": {
+          "type": "string",
+          "enum": [
+            "success",
+            "no_op",
+            "client_error",
+            "server_error",
+            "timeout"
+          ]
+        },
+        "applied": {
+          "type": "string",
+          "enum": [
+            "ALL",
+            "PARTIAL",
+            "NONE"
+          ]
+        },
+        "deployResponsePayload": {
+          "type": [
+            "array",
+            "boolean",
+            "number",
+            "object",
+            "string",
+            "null"
+          ],
+          "description": "Raw deploy/apply API response (body + status + relevant headers). MUST be <= 4096 bytes at the write chokepoint; larger payloads must be hashed into deployResponseSha256 and truncated. Size cap enforced by the Joi validator, not by this JSON Schema."
+        },
+        "deployResponseSha256": {
+          "type": "string",
+          "pattern": "^[a-fA-F0-9]{64}$"
+        },
+        "changeResults": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "targetPath": {
+                "type": "string"
+              },
+              "property": {
+                "type": "string"
+              },
+              "previousValue": {
+                "type": [
+                  "array",
+                  "boolean",
+                  "number",
+                  "object",
+                  "string",
+                  "null"
+                ]
+              },
+              "appliedValue": {
+                "type": [
+                  "array",
+                  "boolean",
+                  "number",
+                  "object",
+                  "string",
+                  "null"
+                ]
+              },
+              "status": {
+                "type": "string",
+                "enum": [
+                  "applied",
+                  "unchanged",
+                  "failed"
+                ]
+              }
+            },
+            "required": [
+              "targetPath",
+              "property",
+              "status"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "preVerify": {
+          "type": "object",
+          "properties": {
+            "verdict": {
+              "type": "string",
+              "enum": [
+                "verified",
+                "rejected",
+                "inconclusive",
+                "verify_failed"
+              ]
+            },
+            "reasonCode": {
+              "type": "string"
+            },
+            "evidence": {
+              "type": [
+                "array",
+                "boolean",
+                "number",
+                "object",
+                "string",
+                "null"
+              ]
+            },
+            "preVerifiedAt": {
+              "type": "string",
+              "format": "date-time"
+            }
+          },
+          "required": [
+            "verdict"
+          ],
+          "additionalProperties": false
+        },
+        "postVerify": {
+          "type": "object",
+          "properties": {
+            "verdict": {
+              "type": "string",
+              "enum": [
+                "verified",
+                "rejected",
+                "inconclusive",
+                "verify_failed"
+              ]
+            },
+            "reasonCode": {
+              "type": "string"
+            },
+            "evidence": {
+              "type": [
+                "array",
+                "boolean",
+                "number",
+                "object",
+                "string",
+                "null"
+              ]
+            },
+            "revert": {
+              "type": [
+                "array",
+                "boolean",
+                "number",
+                "object",
+                "string",
+                "null"
+              ]
+            },
+            "postVerifiedAt": {
+              "type": "string",
+              "format": "date-time"
+            }
+          },
+          "required": [
+            "verdict"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "callStatus",
+        "applied"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "schemaVersion",
+    "surface",
+    "actorType",
+    "target"
+  ],
+  "additionalProperties": false
+}

package/src/models/fix-entity/change-details.schema.js

@@ -157,10 +157,17 @@ const resultSchema = Joi.object({
       return helpers.error('any.invalid');
     }
     return value;
-  }).messages({
-    'any.invalid': `result.deployResponsePayload exceeds ${DEPLOY_RESPONSE_PAYLOAD_MAX_BYTES} bytes; hash it into deployResponseSha256 and truncate at the write chokepoint`,
-  }),
-  deployResponseSha256: Joi.string().pattern(/^[a-f0-9]{64}$/i),
+  })
+    // Carried into the derived JSON Schema so the size-cap caveat travels with
+    // the field for JSON-Schema-only (mystique) consumers — the cap itself is a
+    // Joi `.custom()` rule and is NOT expressible/enforced in JSON Schema.
+    .description(`Raw deploy/apply API response (body + status + relevant headers). MUST be <= ${DEPLOY_RESPONSE_PAYLOAD_MAX_BYTES} bytes at the write chokepoint; larger payloads must be hashed into deployResponseSha256 and truncated. Size cap enforced by the Joi validator, not by this JSON Schema.`)
+    .messages({
+      'any.invalid': `result.deployResponsePayload exceeds ${DEPLOY_RESPONSE_PAYLOAD_MAX_BYTES} bytes; hash it into deployResponseSha256 and truncate at the write chokepoint`,
+    }),
+  // Explicit case ranges (not the /i flag) so the derived JSON Schema `pattern`
+  // stays flag-free and portable to Python's re-based validators.
+  deployResponseSha256: Joi.string().pattern(/^[a-fA-F0-9]{64}$/),
   changeResults: Joi.array().items(changeResultSchema),
   preVerify: preVerifySchema,
   postVerify: postVerifySchema,

package/src/models/site/config.js

@@ -389,6 +389,7 @@ export const configSchema = Joi.object({
       'ams-frontdoor',
       'other',
     ).optional(),
+    showWww: Joi.boolean().optional(),
   }).optional(),
   cdnLogsConfig: Joi.object({
     bucketName: Joi.string().required(),
@@ -721,6 +722,11 @@ export const Config = (data = {}) => {
     state.llmo.brand = brand;
   };
 
+  self.updateLlmoShowWww = (showWww) => {
+    state.llmo = state.llmo || {};
+    state.llmo.showWww = showWww;
+  };
+
   self.addLlmoHumanQuestions = (questions) => {
     state.llmo = state.llmo || {};
     state.llmo.questions = state.llmo.questions || {};