Skip to main content

@appblocks/node-sdk

This includes the server-side libraries used by applications using Appblocks services.

Installation​

This SDK is distributed via:

npm package

npm install @appblocks/node-sdk

For source code, see the Appblocks Node SDK Github repo.

Modules​

This @appblocks/node-sdk included following modules,

  1. Functions SDK
  2. Internals SDK
  3. Shield SDK
  4. Environment SDK

Functions SDK​

Functions SDK module is used to run the Block functions.

Run Handler / Function using run method by importing functions sdk from @appblocks/node-sdk.

Functions​

run () : void

Example​

import { functions } from "@appblocks/node-sdk";

functions.run(ExampleHandler)

To work with functions in local, There are 2 options.

  1. Using emulator

Make use of BB CLI emulator. Emulator will act as a proxy, instead of we pointing and managing multiple port emulator will takecare of that hard jobs then run functions.

cd ./examples/functions-example
node index.js

the above command will run function in port provided by emulator.

  1. Assigning a port manually using flags.

Use the flag --port to run the function in specific port

cd ./examples/functions-example/
npm index.js --port=3000

the above command will run function in port 3000

go to functions-example repo to see example.

Internals SDK​

Internals SDK module is used to initialize the app using credentials from Appblocks app, so that only your account and its resources are accessed by the SDK.

Functions​

initialize ( options: Object ) :void

Parameters​

options Object: { clientId : string, clientSecret : string }

Example​

import { internals } from "@appblocks/node-sdk";

internals.initialize({
        clientId:     AB_APP_CLIENT_ID,
        clientSecret: AB_APP_CLIENT_SECRET,
    })

Shield SDK​

Shield SDK module is used to implement and interact with the Appblocks SHIELD.

note

Before using shield, Initialze the application using internals SDK.

Functions​

getUser( request : ResquestObject ) : ShieldUserResponse getUID( request : ResquestObject ) : ShieldUIDResponse

Example​

import { shield, internals } from "@appblocks/node-sdk";

// Initialize using Appblocks credentials
internals.initialize({
        clientId:     AB_APP_CLIENT_ID,
        clientSecret: AB_APP_CLIENT_SECRET,
    })

const SheildExampleHandler = async (req, res, next) => {
  try {

    // Get user details using shield
    const userDetails = await shield.getUser(req);

    // Get user uid using shield
    const userUID = await shield.getUID(req);

  } catch (error) {
    // handle the error
  }
};

go to shield-example repo to see example.

Environment SDK​

Environment SDK module is used initialize the enviroments, So that block functions can access the environments.

Functions​

init() : void

Example​

import { env } from "@appblocks/node-sdk";

// Initialize the env
env.init();

const envExampleHandler = async (req, res, next) => {
  try {
      const MY_SECRET = process.env.MY_SECRET
      // Your code
  } catch (error) {
    // handle the error
  }
};

go to env-example repo to see example.