crowdin/crowdin-apps-functions

Common functions used by Crowdin Apps

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.

Table of Contents

• Installation
• Quick Start
• Contributing
• Seeking Assistance
• License

Installation

npm

npm i @crowdin/crowdin-apps-functions

yarn

yarn add @crowdin/crowdin-apps-functions

Quick Start

Typescript

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

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

Javascript ES6 modules

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

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

Javascript CommonJS

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

Also please have a look to working example of the Crowdin App. It can be used as a basis for your app.

Contributing

If you want to contribute please read the Contributing guidelines.

Seeking Assistance

If you find any problems or would like to suggest a feature, please feel free to file an issue on Github at Issues Page.

If you've found an error in these samples, please Contact Customer Success Service.

License

The Crowdin Apps Functions library is licensed under the MIT License. 
See the LICENSE.md file distributed with this work for additional 
information regarding copyright ownership.

Except as contained in the LICENSE file, the name(s) of the above copyright
holders shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written authorization.