apm.schema.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "format": "regex",
            "pattern": "^[a-zA-Z0-9-_]+$",
            "description": "The name of the package"
        },
        "vendor": {
            "type": "string",
            "format": "regex",
            "pattern": "^@[a-zA-Z0-9]+$",
            "description": "The vendor of the package",
            "default": "@apm"
        },
        "description": {
            "type": "string",
            "description": "The description of the package"
        },
        "version": {
            "type": "string",
            "pattern": "^[0-9]+.[0-9]+.[0-9]+$",
            "description": "The version of the package",
            "default": "1.0.0"
        },
        "main": {
            "type": "string",
            "description": "The entrypoint of the package",
            "default": "main.lua"
        },
        "keywords": {
            "type": "array",
            "description": "The keywords of the package (max 5)",
            "items": {
                "type": "string"
            },
            "default": []
        },
        "repository": {
            "type": "string",
            "format": "uri",
            "description": "The repository url of the package"
        },
        "authors": {
            "type": "array",
            "description": "The authors of the package",
            "items": {
                "type": "object",
                "properties": {
                    "address": {
                        "type": "string",
                        "pattern": "^[a-zA-Z0-9-_]{43}$"
                    },
                    "name": {
                        "type": "string"
                    },
                    "email": {
                        "type": "string",
                        "format": "email"
                    },
                    "url": {
                        "type": "string",
                        "format": "uri"
                    }
                }
            },
            "default": []
        },
        "license": {
            "type": "string",
            "description": "The license of the package",
            "default": "MIT"
        },
        "dependencies": {
            "type": "object",
            "additionalProperties": {
                "type": "object",
                "properties": {
                    "version": {
                        "type": "string",
                        "description": "The version of the dependency | The message id of the published dependency",
                        "pattern": "^[0-9]+.[0-9]+.[0-9]+$|^[a-zA-Z0-9-_]{43}$",
                        "default": "1.0.0"
                    }
                },
                "required": [
                    "version"
                ]
            }
        },
        "warnings": {
            "type": "object",
            "properties": {
                "modifiesGlobalState": {
                    "type": "boolean"
                },
                "installMessage": {
                    "type": "string"
                }
            },
            "required": [
                "modifiesGlobalState",
                "installMessage"
            ]
        },
        "wallet": {
            "description": "The wallet path",
            "type": "string"
        }
    },
    "required": [
        "name",
        "vendor",
        "description",
        "version",
        "keywords",
        "license",
        "dependencies",
        "warnings",
        "repository"
    ]
}