@crowdin/crowdin-apps-functions NPM

Crowdin Apps Functions library

Lightweight library with utility functions to help you quickly create your own Crowdin App.

Information about Crowdin Apps can be found in the About Crowdin Apps and in the Quick Start guide.

Installation

npm

npm i @crowdin/crowdin-apps-functions

yarn

yarn add @crowdin/crowdin-apps-functions

Quick Start

import { generateOAuthToken } from '@crowdin/crowdin-apps-functions';

generateOAuthToken({ clientId: 'app_client_id', clientSecret: 'app_client_secret', code: 'code_from_install_event'});

import { generateOAuthToken } from '@crowdin/crowdin-apps-functions';

generateOAuthToken({ clientId: 'app_client_id', clientSecret: 'app_client_secret', code: 'code_from_install_event'});

const crowdinFunctions = require('@crowdin/crowdin-apps-functions');

crowdinFunctions.generateOAuthToken({ clientId: 'app_client_id', clientSecret: 'app_client_secret', code: 'code_from_install_event'});

Functions summary

Mainly all functions are intended to help you quickly develop your app but they also can reduce some work when you are integrating with Crowdin API. Please refer to JSDoc for more details.

Method name	Description
`fetchAppToken`	fetch API token for communication with Crowdin API
`generateOAuthToken`	generates OAuth token for communication with Crowdin API
`refreshOAuthToken`	refresh OAuth token in case if it was expired
`constructCrowdinIdFromJwtPayload`	creates unique id of crowdin user and project from the context
`getProjectId`	extracts project id from crowdin id
`validateJwtToken`	validates if jwt token for your app is valid
`updateOrCreateFile`	create or update file in Crowdin
`getFolder`	get folder with and files under it
`getOrCreateFolder`	get folder with files under it or create it
`uploadTranslations`	adds file to storage and sends it in upload translation request
`updateSourceFiles`	updates source files under specific directory
`handleTranslations`	executes side effect function for each translated file
`createOrUpdateWebhook`	create or update webhook
`getSubscription`	returns an information about app subscription
`convertString`	converts source or translation according to specified config
`getBundleConfigurationForm`	returns UI template config for custom formatters
`generateReport`	generates Crowdin report, covers check if finished