mirror of
https://github.com/scratchfoundation/scratch-parser.git
synced 2025-08-28 22:18:45 -04:00
a74a97a906
Added sb3 schema, renamed sb2 schema, and updated validate to check given input against both sb2 and sb3 schemas. Validate appends a projectVersion to the given project with 2 or 3 if the given project is valid against the corresponding schema. Validate now returns an object containing an error message and both the sb2 and sb3 validation errors upon failure to validate against both schemas. BREAKING CHANGE: Changes to validate API and what it returns (namely, error returned by validate is no longer a string, but is now an object which contains an error message string as well as the sb2 errors and the sb3 errors). Users of this library function should expect to parse the given error to figure out why validation failed.
363 lines
11 KiB
JSON
363 lines
11 KiB
JSON
{
|
|
"id": "https://scratch.mit.edu/sb3_schema.json",
|
|
"$schema": "http://json-schema.org/schema#",
|
|
"description": "Scratch 3.0 Project Schema",
|
|
"definitions": {
|
|
"optionalString": {
|
|
"oneOf": [
|
|
{"type": "string"},
|
|
{"type": "null"}
|
|
]
|
|
},
|
|
"assetId": {
|
|
"type": "string",
|
|
"pattern": "^[a-f0-9]{32}$"
|
|
},
|
|
"costume": {
|
|
"type": "object",
|
|
"properties": {
|
|
"assetId": { "$ref": "#/definitions/assetId"},
|
|
"bitmapResolution": {
|
|
"type": "integer"
|
|
},
|
|
"dataFormat": {
|
|
"type": "string",
|
|
"enum": ["png", "PNG", "svg", "SVG", "jpeg", "JPEG", "jpg", "JPG", "bmp", "BMP"]
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"rotationCenterX": {
|
|
"type": "number"
|
|
},
|
|
"rotationCenterY": {
|
|
"type": "number"
|
|
},
|
|
"skinId": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"assetId",
|
|
"dataFormat",
|
|
"name",
|
|
"rotationCenterX",
|
|
"rotationCenterY"
|
|
]
|
|
},
|
|
"sound": {
|
|
"type": "object",
|
|
"properties": {
|
|
"assetId": { "$ref": "#/definitions/assetId"},
|
|
"dataFormat": {
|
|
"type": "string",
|
|
"enum": ["wav", "WAV", "wave", "WAVE", "mp3", "MP3"]
|
|
},
|
|
"format": {
|
|
"type": "string",
|
|
"enum": ["", "adpcm"]
|
|
},
|
|
"md5": {
|
|
"type": "string",
|
|
"pattern": "^[a-f0-9]{32}.[a-z]+$"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"rate": {
|
|
"type": "integer"
|
|
},
|
|
"sampleCount": {
|
|
"type": "integer"
|
|
},
|
|
"soundID": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"assetId",
|
|
"dataFormat",
|
|
"format",
|
|
"name",
|
|
"rate",
|
|
"sampleCount"
|
|
]
|
|
},
|
|
"scalar_variable": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["", "scalar"]
|
|
},
|
|
"value": {
|
|
"oneOf": [
|
|
{"type": "string"},
|
|
{"type": "number"}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"list": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["list"]
|
|
},
|
|
"value": {
|
|
"type": "array"
|
|
}
|
|
}
|
|
},
|
|
"broadcast_message": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": ["broadcast_msg"]
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"not": {"enum": [""]}
|
|
}
|
|
}
|
|
},
|
|
"block": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"opcode": {
|
|
"type": "string"
|
|
},
|
|
"inputs": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"block": {
|
|
"type": "string"
|
|
},
|
|
"shadow": {"$ref":"#/definitions/optionalString"},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"fields": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"value": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"next": {"$ref":"#/definitions/optionalString"},
|
|
"topLevel": {
|
|
"type": "boolean"
|
|
},
|
|
"parent": {"$ref":"#/definitions/optionalString"},
|
|
"shadow": {
|
|
"type": "boolean"
|
|
},
|
|
"x": {
|
|
"type": "number"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
},
|
|
"mutation": {
|
|
"type": "object",
|
|
"properties": {
|
|
"tagName": {
|
|
"type": "string",
|
|
"enum": ["mutation"]
|
|
},
|
|
"children": {
|
|
"type": "array"
|
|
},
|
|
"proccode": {
|
|
"type": "string"
|
|
},
|
|
"argumentids": {
|
|
"type": "string"
|
|
},
|
|
"warp": {
|
|
"type": "string",
|
|
"enum": ["true", "false"]
|
|
},
|
|
"hasnext": {
|
|
"type": "string",
|
|
"enum": ["true", "false"]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"opcode",
|
|
"topLevel"
|
|
]
|
|
},
|
|
"stage": {
|
|
"type": "object",
|
|
"description": "Description of property (and/or property/value pairs) that are unique to the stage.",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"enum": ["Stage"]
|
|
},
|
|
"isStage": {
|
|
"type": "boolean",
|
|
"enum": [true]
|
|
}
|
|
}
|
|
},
|
|
"sprite": {
|
|
"type": "object",
|
|
"description": "Description of property (and/or property/value pairs) for sprites.",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"not": {"enum": ["Stage", "stage"]}
|
|
},
|
|
"isStage": {
|
|
"type": "boolean",
|
|
"enum": [false]
|
|
},
|
|
"visible": {
|
|
"type": "boolean"
|
|
},
|
|
"x": {
|
|
"type": "number"
|
|
},
|
|
"y": {
|
|
"type": "number"
|
|
},
|
|
"size": {
|
|
"type": "number"
|
|
},
|
|
"direction": {
|
|
"type": "number"
|
|
},
|
|
"draggable": {
|
|
"type": "boolean"
|
|
},
|
|
"rotationStyle": {
|
|
"type": "string",
|
|
"enum": ["all around", "don't rotate", "left-right"]
|
|
}
|
|
},
|
|
"required": [
|
|
"name",
|
|
"isStage"
|
|
]
|
|
},
|
|
"target": {
|
|
"type": "object",
|
|
"description" : "Properties common to both Scratch 3.0 Stage and Sprite",
|
|
"properties": {
|
|
"currentCostume": {
|
|
"type": "integer",
|
|
"minimum": 0
|
|
},
|
|
"blocks": {
|
|
"type": "object",
|
|
"additionalProperties": {"$ref":"#/definitions/block"}
|
|
},
|
|
"variables": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"oneOf": [
|
|
{"$ref":"#/definitions/scalar_variable"},
|
|
{"$ref":"#/definitions/list"},
|
|
{"$ref":"#/definitions/broadcast_message"}
|
|
]
|
|
}
|
|
},
|
|
"costumes": {
|
|
"type": "array",
|
|
"items": {"$ref":"#/definitions/costume"},
|
|
"minItems": 1,
|
|
"uniqueItems": true
|
|
},
|
|
"sounds":{
|
|
"type": "array",
|
|
"items": {"$ref":"#/definitions/sound"},
|
|
"uniqueItems": true
|
|
}
|
|
},
|
|
"required": [
|
|
"variables",
|
|
"costumes",
|
|
"sounds",
|
|
"blocks"
|
|
]
|
|
}
|
|
},
|
|
"type": "object",
|
|
"properties": {
|
|
"meta": {
|
|
"type": "object",
|
|
"properties": {
|
|
"semver": {
|
|
"type": "string",
|
|
"pattern": "^(3.[0-9]+.[0-9]+)$"
|
|
},
|
|
"vm": {
|
|
"type": "string",
|
|
"pattern": "^([0-9]+.[0-9]+.[0-9]+)$"
|
|
},
|
|
"agent": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"semver"
|
|
]
|
|
},
|
|
|
|
"targets": {
|
|
"type": "array",
|
|
"items": [
|
|
{
|
|
"allOf": [
|
|
{"$ref": "#/definitions/stage" },
|
|
{"$ref": "#/definitions/target"}
|
|
]
|
|
}
|
|
],
|
|
"additionalItems": {
|
|
"allOf": [
|
|
{"$ref": "#/definitions/sprite"},
|
|
{"$ref": "#/definitions/target"}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"meta",
|
|
"targets"
|
|
]
|
|
}
|