@kumwe/studio-testkit 0.1.0-alpha.8 → 0.1.0-beta.2

package/fixtures/authoring-save.plan.example.json

@@ -0,0 +1,48 @@
+{
+  "contractVersion": "0.1-draft",
+  "kind": "authoring-save-plan",
+  "id": "save-plans/product-page-v2",
+  "revision": "save-plan-r1",
+  "successorContext": {
+    "key": "returns/product-trail-backpack-r8",
+    "label": {
+      "key": "studio.example/return-to-product",
+      "defaultMessage": "Return to accepted product"
+    }
+  },
+  "sessionId": "sessions/product-trail-backpack",
+  "outcome": "save-new-type-version",
+  "expected": {
+    "type": {
+      "id": "content-types/product-page",
+      "version": "1.0.0",
+      "revision": "product-page-type-r1"
+    },
+    "model": {
+      "id": "org.example.models/product",
+      "version": "1.0.0",
+      "revision": "product-model-r1"
+    },
+    "blueprint": {
+      "id": "org.example.blueprints/product-card",
+      "version": "1.0.0",
+      "revision": "product-card-r5"
+    },
+    "entry": {
+      "id": "products/trail-backpack",
+      "revision": "entry-r7"
+    }
+  },
+  "affectedArtifacts": ["model", "blueprint", "reusable-content-type"],
+  "consequences": [
+    {
+      "code": "studio.authoring/dependent-entry-migration",
+      "severity": "warning",
+      "message": {
+        "key": "studio.authoring/dependent-entry-migration",
+        "defaultMessage": "Dependent entries remain on the current type version until migrated."
+      }
+    }
+  ],
+  "confirmationRequired": true
+}

package/fixtures/authoring-session.example.json

@@ -0,0 +1,212 @@
+{
+  "contractVersion": "0.1-draft",
+  "kind": "authoring-session",
+  "sessionId": "sessions/product-trail-backpack",
+  "sessionGeneration": "session-generation-r3",
+  "target": {
+    "contractVersion": "0.1-draft",
+    "kind": "authoring-target",
+    "id": "org.example.catalog/product-content",
+    "owner": {
+      "id": "org.example/catalog",
+      "version": "1.0.0"
+    },
+    "label": {
+      "key": "org.example.catalog/product-content",
+      "defaultMessage": "Product content"
+    },
+    "surface": "org.example.catalog/product-editor",
+    "resourceTypes": ["org.example.catalog/product"],
+    "eligibility": ["create", "edit"],
+    "modes": ["model", "blueprint", "content"],
+    "startKinds": ["blank", "from-type", "existing"],
+    "presentationStates": ["inline", "fullscreen"],
+    "saveOutcomes": ["save-item", "save-new-type-version", "save-as-new-type"],
+    "requiredCapabilities": [],
+    "contributionDependencies": []
+  },
+  "resourceContext": {
+    "key": "contexts/product-trail-backpack",
+    "surface": "org.example.catalog/product-editor",
+    "revision": "context-r2",
+    "scopes": [
+      {
+        "kind": "org.example/tenant",
+        "id": "tenants/north"
+      }
+    ],
+    "resource": {
+      "type": "org.example.catalog/product",
+      "id": "products/trail-backpack"
+    }
+  },
+  "start": {
+    "kind": "existing"
+  },
+  "type": {
+    "contractVersion": "0.1-draft",
+    "kind": "reusable-content-type",
+    "id": "content-types/product-page",
+    "version": "1.0.0",
+    "revision": "product-page-type-r1",
+    "label": {
+      "key": "org.example.catalog/product-page-type",
+      "defaultMessage": "Product page"
+    },
+    "status": "published",
+    "model": {
+      "id": "org.example.models/product",
+      "version": "1.0.0",
+      "revision": "product-model-r1"
+    },
+    "blueprint": {
+      "id": "org.example.blueprints/product-card",
+      "version": "1.0.0",
+      "revision": "product-card-r5"
+    },
+    "authoringPolicy": {
+      "modes": ["model", "blueprint", "content"],
+      "itemComposition": "overrides"
+    }
+  },
+  "state": {
+    "coordinates": {
+      "type": {
+        "id": "content-types/product-page",
+        "version": "1.0.0",
+        "revision": "product-page-type-r1"
+      },
+      "model": {
+        "id": "org.example.models/product",
+        "version": "1.0.0",
+        "revision": "product-model-r1"
+      },
+      "blueprint": {
+        "id": "org.example.blueprints/product-card",
+        "version": "1.0.0",
+        "revision": "product-card-r5"
+      },
+      "entry": {
+        "id": "products/trail-backpack",
+        "revision": "entry-r7"
+      }
+    },
+    "model": {
+      "contractVersion": "0.1-draft",
+      "kind": "content-model",
+      "id": "org.example.models/product",
+      "version": "1.0.0",
+      "revision": "product-model-r1",
+      "owner": {
+        "id": "org.example/catalog",
+        "version": "1.0.0"
+      },
+      "status": "published",
+      "label": {
+        "key": "org.example.catalog/product-model",
+        "defaultMessage": "Product"
+      },
+      "fields": [
+        {
+          "id": "name",
+          "kind": "string",
+          "label": {
+            "key": "org.example.catalog/product-name",
+            "defaultMessage": "Name"
+          },
+          "required": true,
+          "localized": true,
+          "cardinality": "one"
+        }
+      ],
+      "relationships": []
+    },
+    "blueprint": {
+      "contractVersion": "0.1-draft",
+      "kind": "blueprint",
+      "id": "org.example.blueprints/product-card",
+      "version": "1.0.0",
+      "revision": "product-card-r5",
+      "owner": {
+        "id": "org.example/catalog",
+        "version": "1.0.0"
+      },
+      "status": "published",
+      "label": {
+        "key": "org.example.catalog/product-card",
+        "defaultMessage": "Product card"
+      },
+      "model": {
+        "id": "org.example.models/product",
+        "version": "1.0.0",
+        "revision": "product-model-r1"
+      },
+      "dependencyLock": {
+        "theme": {
+          "id": "org.example.themes/commerce",
+          "version": "1.0.0",
+          "revision": "commerce-theme-r3"
+        },
+        "blocks": [
+          {
+            "type": "studio.core/text",
+            "version": "1.0.0",
+            "revision": "text-block-r1"
+          }
+        ]
+      },
+      "roots": [
+        {
+          "id": "node-name",
+          "type": "studio.core/text",
+          "version": "1.0.0",
+          "properties": {},
+          "bindings": {
+            "value": {
+              "source": {
+                "kind": "entry-field",
+                "fieldPath": ["name"]
+              },
+              "transforms": [],
+              "onNull": "empty",
+              "onError": "error"
+            }
+          },
+          "slots": {},
+          "authoring": {
+            "mode": "content"
+          }
+        }
+      ]
+    },
+    "entry": {
+      "contractVersion": "0.1-draft",
+      "kind": "entry",
+      "id": "products/trail-backpack",
+      "revision": "entry-r7",
+      "model": {
+        "id": "org.example.models/product",
+        "version": "1.0.0",
+        "revision": "product-model-r1"
+      },
+      "status": "draft",
+      "values": {
+        "name": "Trail Backpack"
+      }
+    },
+    "dirty": [],
+    "diagnostics": []
+  },
+  "capabilities": {
+    "modes": ["model", "blueprint", "content"],
+    "presentationStates": ["inline", "fullscreen"],
+    "saveOutcomes": ["save-item", "save-new-type-version", "save-as-new-type"]
+  },
+  "presentation": {
+    "current": "inline",
+    "returnContext": {
+      "key": "return/product-list"
+    }
+  },
+  "contributionGeneration": "contributions-r8"
+}

package/fixtures/authoring-target.example.json

@@ -0,0 +1,34 @@
+{
+  "contractVersion": "0.1-draft",
+  "kind": "authoring-target",
+  "id": "org.example.catalog/product-content",
+  "owner": {
+    "id": "org.example/catalog",
+    "version": "1.0.0"
+  },
+  "label": {
+    "key": "org.example.catalog/product-content",
+    "defaultMessage": "Product content"
+  },
+  "surface": "org.example.catalog/product-editor",
+  "resourceTypes": ["org.example.catalog/product"],
+  "eligibility": ["create", "edit"],
+  "modes": ["model", "blueprint", "content"],
+  "startKinds": ["blank", "from-type", "existing"],
+  "presentationStates": ["inline", "minimized", "maximized", "fullscreen"],
+  "saveOutcomes": ["save-item", "save-new-type-version", "save-as-new-type"],
+  "requiredCapabilities": [
+    {
+      "id": "studio.capability/contextual-authoring",
+      "versions": ">=0.1.0 <1.0.0"
+    }
+  ],
+  "contributionDependencies": [
+    {
+      "kind": "field-adapter",
+      "id": "org.example.catalog/money-control",
+      "versions": "^1.0.0",
+      "required": true
+    }
+  ]
+}

package/fixtures/host-operations.example.json

@@ -57,6 +57,83 @@
       "required": true,
       "route": "artifact/unpublish"
     },
+    {
+      "capability": "studio.operation/authoring.list-types",
+      "expectsRevision": false,
+      "method": "listTypes",
+      "mutating": false,
+      "operation": "list-types",
+      "port": "authoring",
+      "portCapability": "studio.port/authoring",
+      "required": false,
+      "route": "authoring/list-types"
+    },
+    {
+      "capability": "studio.operation/authoring.plan-save",
+      "expectsRevision": false,
+      "method": "planSave",
+      "mutating": false,
+      "operation": "plan-save",
+      "port": "authoring",
+      "portCapability": "studio.port/authoring",
+      "required": false,
+      "route": "authoring/plan-save"
+    },
+    {
+      "capability": "studio.operation/authoring.resolve-target",
+      "expectsRevision": false,
+      "method": "resolveTarget",
+      "mutating": false,
+      "operation": "resolve-target",
+      "port": "authoring",
+      "portCapability": "studio.port/authoring",
+      "required": false,
+      "route": "authoring/resolve-target"
+    },
+    {
+      "capability": "studio.operation/authoring.save-as-new-type",
+      "expectsRevision": false,
+      "method": "saveAsNewType",
+      "mutating": true,
+      "operation": "save-as-new-type",
+      "port": "authoring",
+      "portCapability": "studio.port/authoring",
+      "required": false,
+      "route": "authoring/save-as-new-type"
+    },
+    {
+      "capability": "studio.operation/authoring.save-item",
+      "expectsRevision": false,
+      "method": "saveItem",
+      "mutating": true,
+      "operation": "save-item",
+      "port": "authoring",
+      "portCapability": "studio.port/authoring",
+      "required": false,
+      "route": "authoring/save-item"
+    },
+    {
+      "capability": "studio.operation/authoring.save-new-type-version",
+      "expectsRevision": false,
+      "method": "saveNewTypeVersion",
+      "mutating": true,
+      "operation": "save-new-type-version",
+      "port": "authoring",
+      "portCapability": "studio.port/authoring",
+      "required": false,
+      "route": "authoring/save-new-type-version"
+    },
+    {
+      "capability": "studio.operation/authoring.start",
+      "expectsRevision": false,
+      "method": "start",
+      "mutating": true,
+      "operation": "start",
+      "port": "authoring",
+      "portCapability": "studio.port/authoring",
+      "required": false,
+      "route": "authoring/start"
+    },
     {
       "capability": "studio.operation/localization.messages",
       "expectsRevision": false,

package/fixtures/plugin.example.json

@@ -14,6 +14,14 @@
   "activation": "declarative",
   "entryModules": [],
   "contributions": [
+    {
+      "kind": "authoring-target",
+      "id": "org.example.catalog/product-content",
+      "version": "1.0.0",
+      "resource": "authoring/product-content.json",
+      "integrity": "sha256-8UXhVSSK8qpAIeINL/EZAeMXvriQ6Xy97BKjuvI2gTU=",
+      "executable": false
+    },
     {
       "kind": "block",
       "id": "org.example.catalog/price",
@@ -32,6 +40,10 @@
     }
   ],
   "requiredCapabilities": [
+    {
+      "id": "studio.capability/contextual-authoring",
+      "versions": "^1.0.0"
+    },
     {
       "id": "studio.host/artifact",
       "versions": "^1.0.0"

package/fixtures/reusable-content-type.example.json

@@ -0,0 +1,26 @@
+{
+  "contractVersion": "0.1-draft",
+  "kind": "reusable-content-type",
+  "id": "content-types/product-page",
+  "version": "1.0.0",
+  "revision": "product-page-type-r1",
+  "label": {
+    "key": "org.example.catalog/product-page-type",
+    "defaultMessage": "Product page"
+  },
+  "status": "published",
+  "model": {
+    "id": "org.example.models/product",
+    "version": "1.0.0",
+    "revision": "product-model-r1"
+  },
+  "blueprint": {
+    "id": "org.example.blueprints/product-card",
+    "version": "1.0.0",
+    "revision": "product-card-r5"
+  },
+  "authoringPolicy": {
+    "modes": ["model", "blueprint", "content"],
+    "itemComposition": "overrides"
+  }
+}

package/fixtures/studio-deployment.hosted.example.json

@@ -0,0 +1,152 @@
+{
+  "contractVersion": "0.1-draft",
+  "kind": "studio-deployment",
+  "instanceId": "studio-example-page",
+  "mount": "#studio-page",
+  "release": {
+    "version": "0.1.0-beta.2",
+    "corpusManifestDigest": "sha256-HCQ5pF8NMk9nPOXfU6kVX/E8sjgJjHdyDQ86CTOjGi0="
+  },
+  "launch": {
+    "targetId": "org.example.authoring/page",
+    "intent": "create",
+    "resourceContext": {
+      "key": "contexts/example-page",
+      "surface": "org.example.surface/content",
+      "revision": "context-r1",
+      "scopes": [
+        {
+          "kind": "studio.scope/site",
+          "id": "sites/main"
+        }
+      ],
+      "resource": {
+        "type": "org.example.content/page",
+        "id": "pages/example"
+      }
+    },
+    "start": { "kind": "blank" },
+    "initialPresentation": "inline"
+  },
+  "session": {
+    "contractVersion": "0.1-draft",
+    "protocolVersion": "0.1.0-draft.2",
+    "sessionId": "session-example-page",
+    "sessionGeneration": "session-generation-1",
+    "mode": "blueprint",
+    "composite": "single",
+    "sessionState": "editable",
+    "actor": {
+      "id": "users/example-author",
+      "displayName": "Example Author"
+    },
+    "locale": {
+      "requested": "en",
+      "resolved": "en",
+      "fallbacks": [],
+      "direction": "ltr",
+      "timeZone": "Etc/UTC"
+    },
+    "displayPreferences": {
+      "calendar": "gregory",
+      "numberingSystem": "latn",
+      "hourCycle": "h23",
+      "measurementSystem": "metric"
+    },
+    "resourceContext": {
+      "key": "contexts/example-page",
+      "surface": "org.example.surface/content",
+      "revision": "context-r1",
+      "scopes": [
+        {
+          "kind": "studio.scope/site",
+          "id": "sites/main"
+        }
+      ],
+      "resource": {
+        "type": "org.example.content/page",
+        "id": "pages/example"
+      }
+    },
+    "permissions": [
+      "studio.operation/authoring.resolve-target",
+      "studio.operation/authoring.start"
+    ],
+    "artifacts": {},
+    "blocks": [],
+    "plugins": [],
+    "hostCapabilities": {
+      "contractVersion": "0.1-draft",
+      "kind": "host-capabilities",
+      "host": {
+        "id": "org.example/php-host",
+        "version": "1.0.0",
+        "generation": "php-runtime-1"
+      },
+      "protocolVersions": ["0.1.0-draft.2"],
+      "ports": [
+        {
+          "id": "studio.port/authoring",
+          "version": "1.0.0",
+          "operations": [
+            "studio.operation/authoring.resolve-target",
+            "studio.operation/authoring.start"
+          ]
+        }
+      ],
+      "capabilities": []
+    },
+    "limits": {
+      "maxNodes": 5000,
+      "maxDepth": 32,
+      "maxSlotsPerNode": 20,
+      "maxChildrenPerSlot": 1000,
+      "maxPropertyBytes": 1048576,
+      "maxExtensionBytes": 1048576,
+      "maxCommandBatch": 100,
+      "maxHistoryEntries": 1000,
+      "maxRichTextBytes": 1048576,
+      "maxRichTextDepth": 32,
+      "maxPreviewRequestsPerMinute": 600,
+      "maxPreviewBytes": 10485760,
+      "maxMediaUploadBytes": 1073741824,
+      "maxMediaBatch": 50,
+      "maxPluginCount": 50,
+      "maxContributionsPerPlugin": 500,
+      "maxLocaleBytes": 1048576
+    },
+    "features": {
+      "executablePlugins": false,
+      "customInspectors": false,
+      "externalMediaImport": false,
+      "clipboardMediaUpload": false,
+      "collaboration": false,
+      "offlineRecovery": false
+    },
+    "preview": {
+      "enabled": false,
+      "sameOriginRequired": true,
+      "allowApproximateRenderer": false
+    }
+  },
+  "transport": {
+    "kind": "http",
+    "routing": {
+      "kind": "operation-map",
+      "endpoints": {
+        "authoring/resolve-target": "/api/studio/authoring/resolve-target",
+        "authoring/start": "/api/studio/authoring/start"
+      }
+    },
+    "authentication": {
+      "kind": "same-origin-session",
+      "credentials": "same-origin",
+      "csrf": {
+        "headerName": "X-CSRF-Token",
+        "token": "<csrf-token>"
+      }
+    },
+    "requestTimeoutMilliseconds": 10000,
+    "maximumResponseBytes": 67108864
+  }
+}

package/fixtures/studio-deployment.standalone.example.json

@@ -0,0 +1,9 @@
+{
+  "kind": "studio-deployment",
+  "mount": "#studio-page",
+  "release": {
+    "version": "0.1.0-beta.2",
+    "corpusManifestDigest": "sha256-HCQ5pF8NMk9nPOXfU6kVX/E8sjgJjHdyDQ86CTOjGi0="
+  },
+  "locale": "rw"
+}

package/invalid/authoring-save.plan-missing-coordinates.json

@@ -0,0 +1,16 @@
+{
+  "schema": "authoring-save.schema.json",
+  "description": "A save plan cannot be confirmed without the exact expected Model, Blueprint, and Entry coordinates.",
+  "value": {
+    "contractVersion": "0.1-draft",
+    "kind": "authoring-save-plan",
+    "id": "save-plans/incomplete",
+    "revision": "save-plan-r1",
+    "successorContext": { "key": "returns/incomplete-r2" },
+    "sessionId": "sessions/incomplete",
+    "outcome": "save-item",
+    "affectedArtifacts": ["entry"],
+    "consequences": [],
+    "confirmationRequired": false
+  }
+}

package/invalid/authoring-save.plan-missing-successor-context.json

@@ -0,0 +1,28 @@
+{
+  "schema": "authoring-save.schema.json",
+  "description": "A save plan must bind the exact host-minted return context that an accepted result will advance to.",
+  "value": {
+    "contractVersion": "0.1-draft",
+    "kind": "authoring-save-plan",
+    "id": "save-plans/missing-successor-context",
+    "revision": "save-plan-r1",
+    "sessionId": "sessions/missing-successor-context",
+    "outcome": "save-item",
+    "expected": {
+      "model": {
+        "id": "models/article",
+        "version": "1.0.0",
+        "revision": "model-r1"
+      },
+      "blueprint": {
+        "id": "blueprints/article",
+        "version": "1.0.0",
+        "revision": "blueprint-r1"
+      },
+      "entry": { "id": "entries/article", "revision": "entry-r1" }
+    },
+    "affectedArtifacts": ["entry"],
+    "consequences": [],
+    "confirmationRequired": false
+  }
+}

package/invalid/authoring-save.request-plan-missing-successor-context.json

@@ -0,0 +1,26 @@
+{
+  "schema": "authoring-save.schema.json",
+  "description": "A save request must echo the complete plan reference, including its planned successor return context.",
+  "value": {
+    "contractVersion": "0.1-draft",
+    "kind": "authoring-save-item-request",
+    "plan": { "id": "save-plans/entry-r8", "revision": "save-plan-r1" },
+    "acceptedConsequences": [],
+    "draft": {
+      "outcome": "save-item",
+      "entry": {
+        "contractVersion": "0.1-draft",
+        "kind": "entry",
+        "id": "entries/article",
+        "revision": "entry-r7",
+        "model": {
+          "id": "models/article",
+          "version": "1.0.0",
+          "revision": "model-r1"
+        },
+        "status": "draft",
+        "values": {}
+      }
+    }
+  }
+}

package/invalid/authoring-session.missing-entry-state.json

@@ -0,0 +1,9 @@
+{
+  "schema": "authoring-session.schema.json",
+  "description": "A contextual session cannot claim coordinated hydration without a separately identified Entry document.",
+  "value": {
+    "contractVersion": "0.1-draft",
+    "kind": "authoring-session",
+    "sessionId": "sessions/incomplete"
+  }
+}