Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

ncmb

3.1.0 • Public • Published

JavaScript SDK for NIFCLOUD mobile backend

Build Status

This is JavaScript SDK for NIFCLOUD mobile backend, a cloud based backend service for smartphone applications. By importing SDK, the following functions can be used from the application.

To use the API through SDK, you need to register to NIFCLOUD mobile backend. For SDK installation steps, see Quick Start.

Supported environment

Environment Supported version
Node.js 8.x, 10.x, latest
Mozilla Firefox Latest version
Google Chrome Latest version

(※as of May, 2020)

Remember to turn on Allow Cookies on your browsers.

Support desk coverage version

Please read Developer guidelines.

  • v3.0.1 ~ (※as of May, 2020)

Install

$ npm install ncmb -S

Getting Start

  1. Create Account and create application.
  2. Get API KEY / Client KEY
  3. Write codes!
  • Initialize
var NCMB = NCMB || require("../lib/ncmb");
var ncmb = new NCMB("your_apikey", "your_clientkey");
  • DataStore
// get data from ncmb
var Food = ncmb.DataStore("Food");
Food.equalTo("name", "orange")
    .limit(3)
    .skip(1)
    .fetchAll()
    .then(function(foods){
      console.log(foods);
      foods[0].delete();
    })
    .catch(function(err){
      console.log(err);
    });
 
// cerate instance and save into ncmb
var food = new Food({name: "apple"});
food.save()
    .then(function(apple){
      console.log(apple);
    })
    .catch(function(err){
      console.log(err);
    });
 
  • Push
// send push notification
var push = new ncmb.Push()
push.set("title", "Hello, NCMB!")
    .send()
    .then(function(newPush){
      console.log(newPush);
    })
    .catch(function(err){
      console.log(err);
    });
 
  • User
//get data
ncmb.User.fetchAll()
    .then(function(users){
      console.log(users[0]);
    })
    .catch(function(err){
      console.log(err);
    });
 
// signup and login
var user = new ncmb.User({userName:"Tarou", password:"1234"});
user.signUpByAccount()
    .then(function(user){
      return ncmb.User.login(user);
    })
    .then(function(user){
      console.log(user.isCurrentUser); //true
      return user.set("NickName", "taro")
                 .update();
    })
    .then(function(user){
      ncmb.User.logout(user);
    })
    .catch(function(err){
      console.log(err);
    });
 
  • File
// download binary data
ncmb.File.download()
    .then(function(data){
        console.log(data);
      })
    .catch(function(err){
      console.log(err);
    });
 
// upload file (Case of Node.js)
var fs = require('fs');
fs.readFile("/filepath/test.text", function(err, data){
  if(err) throw err;
  ncmb.File.upload("upload.text", data)
      .then(function(data){
          console.log(data);
        })
      .catch(function(err){
          console.log(err);
        });
});
 
  • Role
// get role and subroles
ncmb.Role.fetchAll()
    .then(function(roles){
      return roles[0].fetchRole();
    })
    .then(function(subroles){
      console.log(subroles);
    })
    .catch(function(err){
      console.log(err);
    });
 
//set member and subrole
var role = new ncmb.Role("roleName");
role.addUser([user1,user2])
    .addRole([role1,role2])
    .save()
    .then(function(role){
      console.log(role);
    })
    .catch(function(err){
      console.log(err);
    });
 
  • acl
// set acl
var acl = new ncmb.Acl();
acl.setPublicReadAccess(false)
   .setRoleReadAccess("admin", true);
var Food = ncmb.DataStore("Food");
var food = new Food({name:"orange", acl:acl});
food.save()
    .then(function(food){
      console.log(food)
    })
    .catch(function(err){
      onsole.log(err);
    });
 
// check acl
ncmb.Role.equalTo("roleName", "admin")
         .fetch()
         .then(function(role){
            console.log(role.acl.get("public", "read"));
          })
         .catch(function(err){
            console.log(err);
          });
  • Relation
//set relation
var relation = new ncmb.Relation();
var Food = ncmb.DataStore("Food");
var food = new Food({name:"orange"});
relation.add(food);
var user = new ncmb.User({userName:"Hanako", password:"password"});
user.login()
.then(function(user){
  user.set("foods", relation);
  return user.update();
})
.catch(function(err){
  console.log(err);
});
 
// get related object
Food.relatedTo(user, "foods")
    .fetchAll()
    .then(function(food){
      console.log(food);
    })
    .catch(function(err){
      console.log(err);
    });
  • GeoPoint
// set geopoint
var point = new ncmb.GeoPoint(35, 135);
var Country = ncmb.DataStore("Country");
var Japan = new Country();
Japan.set("location", point);
Japan.save()
     .then(function(data){
        console.log(data);
      })
     .catch(function(err){
        console.log(err);
      });
 

Use in Browser

$ browserify -r -p licensify -t [ uglifyify -x .js ] -o ncmb.min.js lib/ncmb.js
<script src="js/ncmb.min.js"></script>
<script>
  var ncmb = new NCMB("your_apikey", "your_clientkey");
  ...
</script>

For Developer

$ git clone https://github.com/NIFCLOUD-mbaas/ncmb_js
cd ncmb_js
$ npm install
$ npm test

npm test is not working on default Windows OS environment. If you want to do that, please setup nohup command.

Automated Test On Frontend

  1. Generate test files
$ npm run build                 # if library is updated, frontend test need to update ncmb.min.js 
$ npm run test:frontend:modules # run only once at the first time 
$ npm run test:frontend:prepare # generate test files at test/frontend/www 
  1. Make app on mBaaS
  2. Change anonymous user flag from disable to enable in application setting page
  3. Files exists as below after npm commands
  4. Set Appkey and Secretkey in config.js
  5. Run index.html on browser
  6. Run application in Monaca (Upload files as below)

Directory Structure On Browser

(Any directory)/
 ├ index.html
 ├ ncmb.min.js
 ├ ncmb.test.full.js
 ├ config.js
 └css/
   └mocha.css

Directory Structure On Monaca

www/
 ├ index.html //overwrite
 ├ ncmb.min.js
 ├ ncmb.test.full.js
 ├ config.js
 └css/
   └mocha.css

Create SDK Document

Run npm run document:generate command, then documents has created in jsdoc directory.

Dependency

Please refer to Dependencies part in package.json for details.

References

License

Please read LICENSE.

Keywords

none

Install

npm i ncmb

DownloadsWeekly Downloads

106

Version

3.1.0

License

Apache License Version 2.0

Unpacked Size

1.9 MB

Total Files

214

Last publish

Collaborators

  • avatar
  • avatar