@shoalrun/cli 0.1.0-alpha.12 → 0.1.0-alpha.14

package/schemas/content-export.schema.json

@@ -1,55 +1,491 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://shoalrun.com/schemas/content-export.schema.json",
-  "title": "Shoalrun portable content export, version 1",
+  "title": "Shoalrun content delivery manifest, version 1",
   "type": "object",
   "additionalProperties": false,
-  "required": ["schemaVersion", "kind", "digest", "publicBase", "publication", "review", "documents", "assets", "files", "diagnostics"],
+  "required": [
+    "schemaVersion",
+    "kind",
+    "digest",
+    "publicBase",
+    "publication",
+    "review",
+    "resources",
+    "assets",
+    "files",
+    "diagnostics"
+  ],
   "properties": {
-    "schemaVersion": { "const": 1 },
-    "kind": { "const": "shoalrun-content-export" },
-    "digest": { "$ref": "#/$defs/digest" },
-    "publicBase": { "type": "string", "pattern": "^/(?:(?!\\.{1,2}/)[A-Za-z0-9_~.-]+/)*$" },
-    "publication": { "$ref": "#/$defs/publication" },
+    "schemaVersion": {
+      "const": 1
+    },
+    "kind": {
+      "const": "shoalrun-content-export"
+    },
+    "digest": {
+      "$ref": "#/$defs/digest"
+    },
+    "publicBase": {
+      "type": "string",
+      "pattern": "^/(?:(?!\\.{1,2}/)[A-Za-z0-9_~.-]+/)*$"
+    },
+    "publication": {
+      "$ref": "#/$defs/publication"
+    },
     "review": {
-      "type": "object", "additionalProperties": false, "required": ["status", "apis"],
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "status",
+        "apis"
+      ],
       "properties": {
-        "status": { "enum": ["ok", "required"] },
-        "apis": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["apiId", "digest"], "properties": { "apiId": { "type": "string" }, "digest": { "$ref": "#/$defs/digest" } } } }
+        "status": {
+          "enum": [
+            "ok",
+            "required"
+          ]
+        },
+        "apis": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "apiId",
+              "digest"
+            ],
+            "properties": {
+              "apiId": {
+                "type": "string"
+              },
+              "digest": {
+                "$ref": "#/$defs/digest"
+              }
+            }
+          }
+        }
+      }
+    },
+    "assets": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/asset"
       }
     },
-    "documents": {
-      "type": "array", "minItems": 1,
+    "files": {
+      "type": "array",
       "items": {
-        "type": "object", "additionalProperties": false,
-        "required": ["id", "publication", "title", "summary", "type", "representations", "assets", "externalDependencies"],
+        "$ref": "#/$defs/file"
+      }
+    },
+    "diagnostics": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "code",
+          "message"
+        ],
         "properties": {
-          "id": { "type": "string", "minLength": 1 }, "publication": { "$ref": "#/$defs/publication" },
-          "title": { "type": "string" }, "summary": { "type": "string" }, "type": { "type": "string" },
-          "canonicalUrl": { "type": "string", "format": "uri" },
-          "representations": { "type": "object", "minProperties": 1, "additionalProperties": false, "properties": { "html": { "$ref": "#/$defs/representation" }, "markdown": { "$ref": "#/$defs/representation" } } },
-          "assets": { "type": "array", "uniqueItems": true, "items": { "$ref": "#/$defs/path" } },
-          "externalDependencies": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["url", "kind"], "properties": { "url": { "type": "string", "format": "uri" }, "kind": { "const": "image" } } } }
+          "code": {
+            "type": "string"
+          },
+          "documentId": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          }
         }
       }
     },
-    "assets": { "type": "array", "items": { "$ref": "#/$defs/asset" } },
-    "files": { "type": "array", "items": { "$ref": "#/$defs/file" } },
-    "diagnostics": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["code", "documentId", "message"], "properties": { "code": { "type": "string" }, "documentId": { "type": "string" }, "message": { "type": "string" } } } }
+    "resources": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": [
+          "ref",
+          "publication",
+          "title",
+          "summary",
+          "type",
+          "representations",
+          "assets",
+          "externalDependencies"
+        ],
+        "properties": {
+          "publication": {
+            "$ref": "#/$defs/publication"
+          },
+          "title": {
+            "type": "string"
+          },
+          "summary": {
+            "type": "string"
+          },
+          "type": {
+            "type": "string"
+          },
+          "canonicalUrl": {
+            "type": "string",
+            "format": "uri"
+          },
+          "representations": {
+            "type": "object",
+            "minProperties": 1,
+            "additionalProperties": false,
+            "properties": {
+              "html": {
+                "$ref": "#/$defs/representation"
+              },
+              "markdown": {
+                "$ref": "#/$defs/representation"
+              }
+            }
+          },
+          "assets": {
+            "type": "array",
+            "uniqueItems": true,
+            "items": {
+              "$ref": "#/$defs/path"
+            }
+          },
+          "externalDependencies": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "url",
+                "kind"
+              ],
+              "properties": {
+                "url": {
+                  "type": "string",
+                  "format": "uri"
+                },
+                "kind": {
+                  "const": "image"
+                }
+              }
+            }
+          },
+          "ref": {
+            "$ref": "#/$defs/contentRef"
+          },
+          "source": {
+            "type": "object",
+            "additionalProperties": false,
+            "minProperties": 1,
+            "properties": {
+              "documentId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "snippetId": {
+                "type": "string",
+                "minLength": 1
+              },
+              "valuesDigest": {
+                "$ref": "#/$defs/digest"
+              }
+            }
+          }
+        }
+      }
+    }
   },
   "$defs": {
-    "digest": { "type": "string", "pattern": "^[a-f0-9]{64}$" },
-    "path": { "type": "string", "pattern": "^(?:NOTICES\\.txt|(?:content|assets)/(?!\\.{1,2}(?:/|$))[A-Za-z0-9_.-]+(?:/(?!\\.{1,2}(?:/|$))[A-Za-z0-9_.-]+)*)$" },
-    "publication": { "type": "object", "additionalProperties": false, "required": ["channel", "version", "language"], "properties": { "channel": { "type": "string", "minLength": 1 }, "version": { "type": "string", "minLength": 1 }, "language": { "type": "string", "minLength": 1 } } },
-    "file": { "type": "object", "required": ["path", "bytes", "digest"], "properties": { "path": { "$ref": "#/$defs/path" }, "bytes": { "type": "integer", "minimum": 0 }, "digest": { "$ref": "#/$defs/digest" } } },
-    "asset": { "allOf": [{ "$ref": "#/$defs/file" }], "type": "object", "required": ["mediaType"], "properties": { "mediaType": { "type": "string" } } },
-    "representation": {
-      "allOf": [{ "$ref": "#/$defs/asset" }],
-      "type": "object", "required": ["anchors", "links"],
+    "digest": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^(?:NOTICES\\.txt|(?:content|assets)/(?!\\.{1,2}(?:/|$))[A-Za-z0-9_.-]+(?:/(?!\\.{1,2}(?:/|$))[A-Za-z0-9_.-]+)*)$"
+    },
+    "publication": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "channel",
+        "version",
+        "language"
+      ],
       "properties": {
-        "anchors": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["id", "exportedId"], "properties": { "id": { "type": "string" }, "exportedId": { "type": "string" }, "title": { "type": "string" } } } },
-        "links": { "type": "array", "items": { "type": "object", "additionalProperties": false, "required": ["key", "kind", "href"], "properties": { "key": { "type": "string" }, "kind": { "enum": ["document", "canonical", "external", "asset"] }, "href": { "type": "string" }, "documentId": { "type": "string" }, "fragment": { "type": "string" }, "query": { "type": "string" }, "asset": { "$ref": "#/$defs/path" } } } }
+        "channel": {
+          "type": "string",
+          "minLength": 1
+        },
+        "version": {
+          "type": "string",
+          "minLength": 1
+        },
+        "language": {
+          "type": "string",
+          "minLength": 1
+        }
       }
+    },
+    "file": {
+      "type": "object",
+      "required": [
+        "path",
+        "bytes",
+        "digest"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "#/$defs/path"
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        }
+      },
+      "additionalProperties": false
+    },
+    "asset": {
+      "type": "object",
+      "required": [
+        "path",
+        "bytes",
+        "digest",
+        "mediaType"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "#/$defs/path"
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        },
+        "mediaType": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "representation": {
+      "type": "object",
+      "required": [
+        "path",
+        "bytes",
+        "digest",
+        "mediaType",
+        "anchors",
+        "links"
+      ],
+      "properties": {
+        "path": {
+          "$ref": "#/$defs/path"
+        },
+        "bytes": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "digest": {
+          "$ref": "#/$defs/digest"
+        },
+        "mediaType": {
+          "type": "string"
+        },
+        "anchors": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "id",
+              "exportedId"
+            ],
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "exportedId": {
+                "type": "string"
+              },
+              "title": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "links": {
+          "type": "array",
+          "items": {
+            "oneOf": [
+              {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "key",
+                  "kind",
+                  "href",
+                  "ref"
+                ],
+                "properties": {
+                  "key": {
+                    "type": "string"
+                  },
+                  "kind": {
+                    "enum": [
+                      "resource"
+                    ]
+                  },
+                  "href": {
+                    "type": "string"
+                  },
+                  "fragment": {
+                    "type": "string"
+                  },
+                  "query": {
+                    "type": "string"
+                  },
+                  "ref": {
+                    "$ref": "#/$defs/contentRef"
+                  }
+                }
+              },
+              {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "key",
+                  "kind",
+                  "href",
+                  "asset"
+                ],
+                "properties": {
+                  "key": {
+                    "type": "string"
+                  },
+                  "kind": {
+                    "enum": [
+                      "asset"
+                    ]
+                  },
+                  "href": {
+                    "type": "string"
+                  },
+                  "fragment": {
+                    "type": "string"
+                  },
+                  "query": {
+                    "type": "string"
+                  },
+                  "asset": {
+                    "$ref": "#/$defs/path"
+                  }
+                }
+              },
+              {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                  "key",
+                  "kind",
+                  "href"
+                ],
+                "properties": {
+                  "key": {
+                    "type": "string"
+                  },
+                  "kind": {
+                    "enum": [
+                      "canonical",
+                      "external"
+                    ]
+                  },
+                  "href": {
+                    "type": "string"
+                  },
+                  "fragment": {
+                    "type": "string"
+                  },
+                  "query": {
+                    "type": "string"
+                  }
+                }
+              }
+            ]
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "contentRef": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "documentId"
+          ],
+          "properties": {
+            "kind": {
+              "const": "page"
+            },
+            "documentId": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "documentId",
+            "sectionId"
+          ],
+          "properties": {
+            "kind": {
+              "const": "section"
+            },
+            "documentId": {
+              "type": "string",
+              "minLength": 1
+            },
+            "sectionId": {
+              "type": "string",
+              "pattern": "^[a-z0-9][a-z0-9-]{0,511}$"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "kind",
+            "id"
+          ],
+          "properties": {
+            "kind": {
+              "const": "snippet"
+            },
+            "id": {
+              "type": "string",
+              "pattern": "^[A-Za-z_][A-Za-z0-9_.-]*$"
+            }
+          }
+        }
+      ]
     }
   }
 }