Revision: [Initial Draft Revision] Date: 01-2009 Deployment information will be stored in a meta-data file inside the Javascript Bundle. Valid archives must contain a file named META_DATA stored inside a directory named JS_DEPLOY. The contents of the META_DATA file must be in valid JSON notation. META_DATA FormatThe META_DATA file will contain the information necessary to deploy the Javascript Bundle. The information should be in the structure presented below. {"appName": string,} Bolded values are required fields. Non-bolded fields are not required and may be omitted. Deployment servers should not fail if a non-required field is not present. The appName field should contain the name of the program contained in the bundle. This may be used for display purposes by the deploying server. The type field must contain the deployment specification being targeted. (FIX ME: Define the specifications supported.) If the deployment server is unfamiliar with the requested deployment specification, the server must reject the deployment of the archive. The main field must point to the entry point for this bundle. The entry point is expected to be a file in the archive. The type, format, and nature of that file is determined by the deployment specification set by the type field. The specification field will contain the version of this specification being targeted. If the major field is greater than the deployment server is familiar with, the deployment server must reject the archive. If the minor field is greater than the deployment server is familiar with, the deployment server may reject the archive. Deployment servers should not reject archives with major or minor number lower than they are familiar with. As of this writing, valid values for major and minor are 0 and 1 respectively. The genre field may contain a string that identifies which genre the containing program belongs to. Not all forms of Javascript program will belong to a discernible genre, so this field is optional in all situations. Deployment servers that categorize Javascript Bundles by genre should have a fall-back solution for categorization in the cases where this field is absent. (TODO: Should we define standard genres?) The author field may contain a personal name or organization name to credit for the creation of the program contained inside the Javascript Bundle. This field is optional, so deployment servers should expect the situation where it is not available. (TODO: Should we have an alternative credits array for multi-person projects?) The homePage field may optionally point to a URL containing information about the author or the program. This field is optional, so deployment servers should expect the situation where it is not available. The description field may contain a textual description of the program contained in the bundle. It is advised that this field exist so that deploying servers may display useful information about the program. If this field is absent, deployment servers should treat the situation as a blank description. The dimensions field must contain the initial width and height of the contained program. Dimensional measurements are in screen pixels. Programs of variable dimensions should store an initial width and height in this field. (FIX ME: Should we add information about variable dimensions so that the deployment server does not generate a fixed size container?) The preload field may contain a list of files that may be cached in the web browser prior to initialization and execution of the contained program. Deployment servers are not required to honor the contents of the preload section and may ignore the contents. Deployment servers that do honor the preload information should consider displaying a progress meter while the resources are being cached. Currently this specification only supports image preloading. Images should be in a format compatible with the web browser or errors may occur during preload. |