@mondaycom/apps-sdk

Public access to this SDK is currently restricted but will become available in the next few months

---

apps-sdk

This sdk is used to leverage some of the capabilities exposed via <monday-code />:

• Storage
• Secure storage
• Environment variables manager
• Logger

Storage

* Please note Storage contracts have been updated at version v1.0.0 *

key/value storage for monday-code projects

• This is the way to store customer data for your app
• key/value based where the key is a string and value can be any serializable type (object, number, string, etc.)
• Compartmentalized based on accountId and app for your specific app which means that data stored for one account will not be accessible from the context of another account
• There are two modes for the storage which are based on a passed option shared:
  • false (default) - The stored data will be accessible only you "backend" oriented apps (storage will not be shared between integrations and views).
  • true - The stored data will be accessible from both "backend" and "frontend" oriented apps.

Storage API

There are three methods exposed to manage the storage - set, get and delete

Initialize

• <ACCESS_TOKEN> - access token of the customer/account the app is working on behalf of

import { Storage } from '@mondaycom/apps-sdk';

const storage = new Storage('<ACCESS_TOKEN>');

Set

• key: string - key to store the content for
• value: any - value to store
• previousVersion?: string - the last version of the stored value for a specific key (OPTIONAL)
• shared?: boolean - whether the stored data will be accessible from both "backend" and "frontend" oriented apps (OPTIONAL)
• version: string - the new version of the stored value

const { version, success, error } = await storage.set(key, value, { previousVersion, shared });

get

const { value, version, success } = await storage.get(key, { shared });

delete

const { success, error } = await storage.delete(key, { shared });

Secure storage

key/value secure storage for monday-code projects

• This is the way to store sensitive customer data (i.e access tokens generated by OAuth for example)
• Has 3 different modes (dependent on where it is used)
  • Secure storage - when used in a deployed <monday-code/> project it will automatically utilize the real secure storage
  • Local "secure storage" - a local mock db which will mimic the api exposed by the real secure storage. Will work in this mode when sdk is used locally.

    If there are no permissions to write files on the disk, Local "secure storage" will not be persisted

• key/value based where the key is a string and value can be any type (object, number, string, etc.)
• compartmentalized for your specific app which means that data stored for one app will not be accessible by other apps

Secure Storage API

There are three methods exposed to manage the storage - set, get and delete

initialize

import { SecureStorage } from '@mondaycom/apps-sdk';

const secureStorage = new SecureStorage();

Set

• key: string - key to store the content for
• value: any - value to store (must be serializable)
  • If value is not an object it will be wrapped in an object with a key value
  • If value is an object it will be stored as is

await secureStorage.set(key, value);

get

const storedValue = await secureStorage.get(key);

delete

await secureStorage.delete(key);

Environment variables manager

Read environment variables in monday-code projects

• This is the way to read environment variables for your app in a project deployed <monday-code/>.
• Environment variables set via @mondaycom/apps-cli

  $ mapps code:env -m set -k <key> -v <value>
  

• This environment variables are stored in a secure manner and can be used to store sensitive data (i.e. DB connection string, API keys, etc.)
• The environment variables are on the app level which means that they are accessible by all the versions of the app

Environment variables manager API

There are two methods exposed to manage the environment variables - get and getKeys

initialize

import { EnvironmentVariablesManager } from '@mondaycom/apps-sdk';

// Initialize the environment variables manager without injecting env into `process.env`
let envManager = new EnvironmentVariablesManager();

// Initialize the environment variables manager and inject env into `process.env`
envManager = new EnvironmentVariablesManager({ updateProcessEnv: true });

get

// Get cached environment variable
const cachedValue = envManager.get(key, { invalidate: false });

// Get the latest version of environment variable
const latestValue = envManager.get(key);

getKeys

// Get all cached environment variables keys
const cachedKeys = envManager.getKeys({ invalidate: false });

// Get all environment variables keys
const latestKeys = envManager.getKeys();

Logger

Recommended logger for monday-code projects

• This logger provides a simple way to log messages for your app in a project deployed <monday-code/>.
• Logged messages are accessible via via @mondaycom/apps-cli

  $ mapps code:logs
  

• Logs written without this logger may not be accessible via @mondaycom/apps-cli or not get labeled correctly

Logger API

There are four methods exposed to manage the environment variables - info, warn, error and debug.

initialize

import { Logger } from '@mondaycom/apps-sdk';

const tag = 'my-app';
// tag will be added to every logged message
const logger = new Logger(tag);

info

logger.info('info message');

warn

logger.warn('warn message');

debug

logger.debug('debug message');

error

// Stack trace will be logged as well if error is provided
logger.error('error message', { error: new Error('error') });