custom APIs specifications can be references to a file

[iislucas]

Currently custom APIs can be defined in a freedom.json file like this:

{
    "name": "log-provider",
    "description": "",
    "app": { "script": "log-provider.js" },
    "constraints": { "isolation": "never" },
    "provides": [ "LogProvider" ],
    "api": {
        "LogProvider": { ... API specified inline here ... }
    },
    "dependencies": [ ... ],
    "permissions": [ ... ]
}

If I have multiple implementation of the same interface, I have to make a new module and include the same API specification within each one.

Proposal: allow APIs to be referenced from a file so you don't need to have multiple copies of the API specification for each implementation. e.g. this could be done by allowing api specification to be a string instead of an object. The string is a relative path to a JSON file that specifies the api. e.g.

{
    "name": "log-provider",
    "description": "",
    "app": { "script": "log-provider.js" },
    "constraints": { "isolation": "never" },
    "provides": [ "LogProvider" ],
    "api": {
        "LogProvider": "logger.api.json"
    },
    "dependencies": [ ... ],
    "permissions": [ ... ]
}

If you want to get a bit fancier, you could make the API specification file a JS that runs in a web-worker and sends a message with the actual object. Then you're not stuck with JSON, you can have comments, and you can support some nicer abbreviations for writing specifications (e.g. Lally's IDL compiler could be used directly). :)