@nextcommerce/campaigns-os 1.33.0

package/schemas/campaigns-os-legacy-migration-inventory.v0.schema.json

@@ -0,0 +1,112 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nextcommerce.com/schemas/campaigns-os-legacy-migration-inventory.v0.schema.json",
+  "title": "Campaigns OS Legacy Migration Inventory v0",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schema_version", "migration_id", "source", "target"],
+  "properties": {
+    "schema_version": { "const": "campaigns-os-legacy-migration-inventory/v0" },
+    "migration_id": { "$ref": "#/$defs/key" },
+    "source": {
+      "type": "object", "additionalProperties": false,
+      "required": ["campaign_id", "sdk_version"],
+      "properties": {
+        "campaign_id": { "type": "integer", "minimum": 1 },
+        "sdk_version": { "type": "string", "pattern": "^0\\.3\\.\\d+(?:-[0-9A-Za-z.-]+)?$" }
+      }
+    },
+    "target": {
+      "type": "object", "additionalProperties": false,
+      "required": ["campaign", "packages", "shipping_methods", "offer_intents", "authorized_domains"],
+      "properties": {
+        "campaign": { "$ref": "#/$defs/campaign" },
+        "packages": { "type": "array", "minItems": 1, "items": { "$ref": "#/$defs/package" } },
+        "shipping_methods": { "type": "array", "items": { "$ref": "#/$defs/shipping" } },
+        "offer_intents": { "type": "array", "items": { "$ref": "#/$defs/offer" } },
+        "authorized_domains": { "type": "array", "uniqueItems": true, "items": { "$ref": "#/$defs/hostname" } }
+      }
+    }
+  },
+  "$defs": {
+    "key": { "type": "string", "pattern": "^[a-z0-9][a-z0-9._-]{0,79}$" },
+    "money": { "type": "string", "pattern": "^(?:0|[1-9]\\d{0,7})(?:\\.\\d{1,2})?$" },
+    "percentage": { "type": "string", "pattern": "^(?:(?:0\\.(?:0[1-9]|[1-9]\\d?))|(?:[1-9]\\d?(?:\\.\\d{1,2})?)|100(?:\\.0{1,2})?)$" },
+    "hostname": { "type": "string", "pattern": "^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)*[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$" },
+    "campaign": {
+      "type": "object", "additionalProperties": false,
+      "required": ["name", "currency", "language", "payment_gateway_group_id"],
+      "properties": {
+        "name": { "type": "string", "minLength": 1, "maxLength": 200 },
+        "currency": { "type": "string", "pattern": "^[A-Za-z]{3}$" },
+        "language": { "type": "string", "minLength": 2, "maxLength": 16 },
+        "payment_gateway_group_id": { "type": "integer", "minimum": 1 },
+        "additional_currencies": { "type": "array", "items": { "type": "string" } },
+        "available_payment_methods": { "type": "array", "items": { "type": "string" } },
+        "available_express_payment_methods": { "type": "array", "items": { "type": "string" } },
+        "available_shipping_countries": { "type": "array", "items": { "type": "string" } },
+        "statement_descriptor": { "type": "string", "minLength": 1, "maxLength": 255 }
+      }
+    },
+    "package": {
+      "type": "object", "additionalProperties": false,
+      "required": ["package_key", "name", "product_id", "product_variant_id", "price"],
+      "properties": {
+        "package_key": { "$ref": "#/$defs/key" },
+        "name": { "type": "string", "minLength": 1, "maxLength": 200 },
+        "product_id": { "type": "integer", "minimum": 1 },
+        "product_variant_id": { "type": "integer", "minimum": 1 },
+        "price": { "$ref": "#/$defs/money" },
+        "price_recurring": { "$ref": "#/$defs/money" },
+        "interval": { "type": "string", "minLength": 1 },
+        "interval_count": { "type": "integer", "minimum": 1 }
+      }
+    },
+    "shipping": {
+      "type": "object", "additionalProperties": false,
+      "required": ["shipping_key", "shipping_method", "price"],
+      "properties": {
+        "shipping_key": { "$ref": "#/$defs/key" },
+        "shipping_method": { "type": "string", "minLength": 1 },
+        "price": { "$ref": "#/$defs/money" }
+      }
+    },
+    "offer": {
+      "type": "object", "additionalProperties": false,
+      "required": ["intent_key", "name", "offer_type", "condition", "benefit"],
+      "properties": {
+        "intent_key": { "$ref": "#/$defs/key" },
+        "name": { "type": "string", "minLength": 1, "maxLength": 128 },
+        "offer_type": { "enum": ["offer", "voucher"] },
+        "code": { "type": "string", "minLength": 1, "maxLength": 64 },
+        "condition": {
+          "type": "object", "additionalProperties": false,
+          "required": ["type", "all_packages", "package_keys"],
+          "properties": {
+            "type": { "enum": ["any", "count"] },
+            "value": { "type": ["integer", "null"], "minimum": 1 },
+            "all_packages": { "const": false },
+            "package_keys": { "type": "array", "minItems": 1, "uniqueItems": true, "items": { "$ref": "#/$defs/key" } }
+          },
+          "allOf": [
+            { "if": { "properties": { "type": { "const": "count" } }, "required": ["type"] }, "then": { "required": ["value"], "properties": { "value": { "type": "integer", "minimum": 1 } } } },
+            { "if": { "properties": { "type": { "const": "any" } }, "required": ["type"] }, "then": { "properties": { "value": { "type": "null" } } } }
+          ]
+        },
+        "benefit": {
+          "type": "object", "additionalProperties": false,
+          "required": ["type", "value"],
+          "properties": {
+            "type": { "enum": ["package_percentage", "shipping_percentage", "order_percentage"] },
+            "value": { "$ref": "#/$defs/percentage" },
+            "price_rounding": { "type": ["string", "null"], "enum": ["0.00", "0.95", "0.97", "0.99", null] }
+          }
+        }
+      },
+      "allOf": [
+        { "if": { "properties": { "offer_type": { "const": "voucher" } }, "required": ["offer_type"] }, "then": { "required": ["code"] } },
+        { "if": { "properties": { "offer_type": { "const": "offer" } }, "required": ["offer_type"] }, "then": { "not": { "required": ["code"] } } }
+      ]
+    }
+  }
+}

package/schemas/campaigns-os-legacy-provisioning-plan.v0.schema.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nextcommerce.com/schemas/campaigns-os-legacy-provisioning-plan.v0.schema.json",
+  "title": "Campaigns OS Legacy Provisioning Plan v0",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schema_version", "store", "migration_id", "inventory_hash", "preview_hash", "source", "operations", "offer_intents", "authorized_domains"],
+  "properties": {
+    "schema_version": { "const": "campaigns-os-legacy-provisioning-plan/v0" },
+    "store": { "type": "string", "minLength": 1 },
+    "migration_id": { "$ref": "#/$defs/key" },
+    "inventory_hash": { "$ref": "#/$defs/hash" },
+    "preview_hash": { "$ref": "#/$defs/hash" },
+    "source": {
+      "type": "object", "additionalProperties": false, "required": ["campaign_id", "sdk_version"],
+      "properties": { "campaign_id": { "type": "integer", "minimum": 1 }, "sdk_version": { "type": "string", "pattern": "^0\\.3\\.\\d+(?:-[0-9A-Za-z.-]+)?$" } }
+    },
+    "operations": {
+      "type": "array", "items": {
+        "type": "object", "additionalProperties": false,
+        "required": ["operation_id", "action", "resource_key", "request"],
+        "properties": {
+          "operation_id": { "type": "string", "minLength": 1 },
+          "action": { "enum": ["campaign.create", "package.create", "shipping_method.create"] },
+          "resource_key": { "type": "string", "minLength": 1 },
+          "depends_on": { "type": "string", "minLength": 1 },
+          "request": { "type": "object" }
+        }
+      }
+    },
+    "offer_intents": { "type": "array", "items": { "$ref": "campaigns-os-legacy-migration-inventory.v0.schema.json#/$defs/offer" } },
+    "authorized_domains": { "type": "array", "uniqueItems": true, "items": { "$ref": "campaigns-os-legacy-migration-inventory.v0.schema.json#/$defs/hostname" } }
+  },
+  "$defs": {
+    "key": { "type": "string", "pattern": "^[a-z0-9][a-z0-9._-]{0,79}$" },
+    "hash": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" }
+  }
+}

package/schemas/campaigns-os-legacy-provisioning-receipt.v0.schema.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nextcommerce.com/schemas/campaigns-os-legacy-provisioning-receipt.v0.schema.json",
+  "title": "Campaigns OS Legacy Provisioning Receipt v0",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["schema_version", "store", "migration_id", "inventory_hash", "preview_hash", "state", "created_at", "updated_at", "campaign_id", "writes"],
+  "properties": {
+    "schema_version": { "const": "campaigns-os-legacy-provisioning-receipt/v0" },
+    "store": { "type": "string", "minLength": 1 },
+    "migration_id": { "$ref": "#/$defs/key" },
+    "inventory_hash": { "$ref": "#/$defs/hash" },
+    "preview_hash": { "$ref": "#/$defs/hash", "description": "The exact confirmation hash of the preview plan; projected as plan_hash in build evidence." },
+    "state": { "enum": ["applying", "provisioned", "awaiting_manual_configuration", "failed", "reconciliation_required"] },
+    "created_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z$" },
+    "updated_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z$" },
+    "applied_at": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?Z$" },
+    "campaign_id": { "type": ["integer", "null"], "minimum": 1 },
+    "writes": {
+      "type": "array", "items": {
+        "type": "object", "additionalProperties": false,
+        "required": ["operation_id", "action", "resource_key", "upstream_ids"],
+        "properties": {
+          "operation_id": { "type": "string", "minLength": 1 },
+          "action": { "enum": ["campaign.create", "package.create", "shipping_method.create", "offer.create"] },
+          "resource_key": { "type": "string", "minLength": 1 },
+          "intent_key": { "$ref": "#/$defs/key" },
+          "upstream_ids": {
+            "type": "object", "additionalProperties": false, "required": ["campaign_id"],
+            "properties": {
+              "campaign_id": { "type": "integer", "minimum": 1 },
+              "package_id": { "type": ["integer", "null"], "minimum": 1 },
+              "shipping_method_id": { "type": ["integer", "null"], "minimum": 1 },
+              "offer_id": { "type": ["integer", "null"], "minimum": 1 }
+            }
+          },
+          "readback": { "type": "object" },
+          "audit_key": { "type": "string", "minLength": 1 }
+        },
+        "allOf": [
+          { "if": { "properties": { "action": { "const": "campaign.create" } }, "required": ["action"] }, "then": { "properties": { "upstream_ids": { "required": ["campaign_id"], "properties": { "campaign_id": { "type": "integer", "minimum": 1 } } } } } },
+          { "if": { "properties": { "action": { "const": "package.create" } }, "required": ["action"] }, "then": { "properties": { "upstream_ids": { "required": ["package_id"], "properties": { "package_id": { "type": "integer", "minimum": 1 } } } } } },
+          { "if": { "properties": { "action": { "const": "shipping_method.create" } }, "required": ["action"] }, "then": { "properties": { "upstream_ids": { "required": ["shipping_method_id"], "properties": { "shipping_method_id": { "type": "integer", "minimum": 1 } } } } } },
+          { "if": { "properties": { "action": { "const": "offer.create" } }, "required": ["action"] }, "then": { "required": ["intent_key"], "properties": { "upstream_ids": { "required": ["offer_id"], "properties": { "offer_id": { "type": "integer", "minimum": 1 } } } } } }
+        ]
+      }
+    },
+    "failure": { "type": ["object", "null"] }
+  },
+  "allOf": [
+    { "if": { "properties": { "state": { "enum": ["provisioned", "awaiting_manual_configuration"] } }, "required": ["state"] }, "then": { "required": ["applied_at"], "properties": { "campaign_id": { "type": "integer", "minimum": 1 } } } }
+  ],
+  "$defs": {
+    "key": { "type": "string", "pattern": "^[a-z0-9][a-z0-9._-]{0,79}$" },
+    "hash": { "type": "string", "pattern": "^sha256:[a-f0-9]{64}$" }
+  }
+}

package/schemas/campaigns-os-qa-verdict-sidecar.v0.schema.json

@@ -0,0 +1,150 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://nextcommerce.com/schemas/campaigns-os-qa-verdict-sidecar.v0.schema.json",
+  "title": "Campaigns OS QA Verdict Sidecar v0",
+  "description": "The committed QA verdict sidecar written to .campaign-runtime/qa-verdict.json beside the Build Packet — the artifact campaigns-agent's readback consumes. It is an allowlist PROJECTION of one full verdict (campaigns-os-qa-verdict.v0.schema.json), never a copy: it keeps the same schema_version literal \"1.0\" (a second version would fork the read end), keeps identity, disposition, per-assertion id/family/page/status/severity/blocked_by, and trimmed exceptions, and empties every URL-bearing field — full verdicts stay gitignored because they carry live storefront URLs, request evidence, and order references. generated_at is stamped at projection/promotion time. Produced only by `qa run` and `qa promote` (never hand-authored), and only from a verdict the projection accepts: a record stamped trusted: false by the QA verdict receiver (an anonymous submission) is refused, so the trust fields can never legitimately appear here. Additions to v0 are expected; consumers must tolerate unknown fields — but the properties this projection deliberately empties or strips are pinned empty/absent below.",
+  "type": "object",
+  "additionalProperties": true,
+  "required": [
+    "schema_version",
+    "run_id",
+    "campaign_slug",
+    "spec_version",
+    "spec_hash",
+    "started_at",
+    "completed_at",
+    "generated_at",
+    "runtime",
+    "disposition",
+    "entry_urls",
+    "page_urls",
+    "tested_urls",
+    "assertions",
+    "test_orders",
+    "exceptions"
+  ],
+  "properties": {
+    "schema_version": {
+      "const": "1.0",
+      "description": "Same literal as the full verdict — the sidecar is the same contract projected, not a second schema lineage."
+    },
+    "run_id": { "type": "string", "minLength": 1 },
+    "campaign_slug": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Carries the Campaign Map ID for schema back-compat, exactly as the source verdict did."
+    },
+    "public_route_slug": {
+      "type": "string",
+      "description": "Present only when the source verdict carried a non-null value."
+    },
+    "campaign_ref_id": {
+      "type": "integer",
+      "description": "Present only when the source verdict carried a non-null value."
+    },
+    "spec_version": { "type": "string", "minLength": 1 },
+    "spec_hash": { "type": "string", "minLength": 1 },
+    "started_at": { "type": "string", "minLength": 1 },
+    "completed_at": { "type": "string", "minLength": 1 },
+    "generated_at": {
+      "type": "string",
+      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?Z$",
+      "description": "The projection/promotion instant, strict RFC3339 UTC with a Z suffix — the freshness stamp readback staleness checks read. Distinct from completed_at, which stays the source run's own finalization time."
+    },
+    "runtime": { "type": "string", "minLength": 1 },
+    "disposition": {
+      "type": "string",
+      "enum": ["ready", "ready_with_exceptions", "blocked"],
+      "description": "The source verdict's disposition, blocked included: the sidecar records what QA concluded, it is not a pass mark."
+    },
+    "base_url": {
+      "not": {},
+      "description": "URL-bearing — never present in the projection."
+    },
+    "entry_urls": {
+      "type": "array",
+      "maxItems": 0,
+      "description": "URL-bearing — always emptied ([]) by the projection."
+    },
+    "page_urls": {
+      "type": "array",
+      "maxItems": 0,
+      "description": "URL-bearing — always emptied ([]) by the projection."
+    },
+    "tested_urls": {
+      "type": "array",
+      "maxItems": 0,
+      "description": "URL-bearing — always emptied ([]) by the projection."
+    },
+    "assertions": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/projectedAssertion" }
+    },
+    "test_orders": {
+      "type": "array",
+      "maxItems": 0,
+      "description": "Order evidence (URLs, order references, request captures) stays in the full verdict — always emptied ([]) by the projection."
+    },
+    "exceptions": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/projectedException" },
+      "description": "Re-derived from the PROJECTED assertions, then null-valued keys dropped — so url/expected/actual can never survive into the committed form."
+    },
+    "trusted": {
+      "not": {},
+      "description": "Never present: trust stamps belong to the receiver's stored records, and the projection refuses an untrusted source outright."
+    },
+    "trust_level": {
+      "not": {},
+      "description": "Never present — see trusted."
+    },
+    "verified_at": {
+      "not": {},
+      "description": "Never present — see trusted."
+    }
+  },
+  "$defs": {
+    "projectedAssertion": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": ["id", "family", "page", "status"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "family": { "type": "string", "minLength": 1 },
+        "page": { "type": "string", "minLength": 1 },
+        "status": {
+          "type": "string",
+          "enum": ["pass", "fail", "warn", "skipped", "manual_review"]
+        },
+        "severity": {
+          "type": "string",
+          "enum": ["info", "warn", "blocker"]
+        },
+        "blocked_by": {
+          "description": "Tolerated allowlist field for gate-blocked assertions; shape follows the source assertion when present."
+        },
+        "url": { "not": {}, "description": "URL-bearing — stripped by the projection." },
+        "expected": { "not": {}, "description": "Stripped by the projection — stays in the full verdict." },
+        "actual": { "not": {}, "description": "Stripped by the projection — stays in the full verdict." },
+        "evidence": { "not": {}, "description": "Stripped by the projection — stays in the full verdict." },
+        "waiver": { "not": {}, "description": "Stripped by the projection — stays in the full verdict." }
+      },
+      "description": "The assertion allowlist: id, family, page, status, severity, blocked_by. Everything else — url, expected, actual, evidence, request/response captures — stays in the full verdict."
+    },
+    "projectedException": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": ["id", "family", "page", "status", "severity"],
+      "properties": {
+        "id": { "type": ["string", "null"] },
+        "family": { "type": ["string", "null"] },
+        "page": { "type": ["string", "null"] },
+        "status": { "type": ["string", "null"] },
+        "severity": { "type": ["string", "null"] },
+        "url": { "not": {}, "description": "URL-bearing — can only derive null from projected assertions, and null keys are dropped." },
+        "expected": { "not": {}, "description": "Stripped — stays in the full verdict." },
+        "actual": { "not": {}, "description": "Stripped — stays in the full verdict." }
+      }
+    }
+  }
+}