node-firefox-marketplace

0.0.3 • Public • Published

WIP node-firefox-marketplace

JavaScript library for communicating with the Firefox Marketplace.

This is a work in progress. The library currently only supports validating a manifest and uploading it to the Marketplace so you can continue the app submission process.

Install

npm install node-firefox-marketplace

Usage

var MarketplaceClient = require('node-firefox-marketplace');
 
var fxos = new MarketplaceClient(options);

where options is an object consisting of: consumerKey (String) consumerSecret (String) environment (String) can be either development or production. If left blank, it will default to 'development'

The consumerKey and consumerSecret properties should correspond to your Marketplace Developer API key pair.

For development, you can generate OAuth keys on the Beta Firefox Marketplace here.

To work with the production Firefox Marketplace, you can generate your API keys here.

Choose 'command line' for the client type when generating your key.

Validating a manifest file

fxos.validateManifest(manifestUrl).then(function(result) {
  console.log('Result: ', result);
});

manifestUrl is a hosted manifest.webapp URL. (i.e. http://brittanystoroz.github.io/its-five-o-clock-somewhere/manifest.webapp). The promise resolves with the response body object, which might look something like this:

{ id: '30d2555502e046b4a92b31e8dac233e2',
  processed: true,
  valid: true,
  validation: { 
    ending_tier: 2,
    success: false,
    warnings: 1,
    feature_profile: [],
    messages: [ [Object], [Object], [Object], [Object] ],
    metadata: {},
    manifest: false,
    errors: 0,
    notices: 0,
    feature_usage: {},
    permissions: []
  }
}

Assuming the manifest is valid, you can then use the id property to publish your application to the marketplace.

Validating a packaged application

fxos.validatePackage(packagePath).then(function(result) {
  console.log('Result: ', result);
});

packagePath is a path to a local webapp package (normally a zip file). The promise resolves with the same results as documented above in the validateManifest method.

Publishing an app

fxos.publish(validationId, format).then(function(result) {
  console.log('Result: ', result);
});

validationId is the id property from the object returned by the validateManifest or validatePackage method. The format is needed, if you are publishing a packaged app and has to hold the value "packaged", when publishing a validated manifest the value doesn't matter. The promise resolves with an application object, and you will see your newly created app under 'My Submissions' in the Marketplace Developer Hub.

Readme

Keywords

Package Sidebar

Install

npm i node-firefox-marketplace

Weekly Downloads

0

Version

0.0.3

License

none

Last publish

Collaborators

  • brittanystoroz