Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@crowdin/crowdin-apps-functions
Advanced tools
Readme
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.
npm i @crowdin/crowdin-apps-functions
yarn add @crowdin/crowdin-apps-functions
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'});
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.
If you want to contribute please read the Contributing guidelines.
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.
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.
FAQs
Utility library to easily and quickly develop Crowdin App
The npm package @crowdin/crowdin-apps-functions receives a total of 29 weekly downloads. As such, @crowdin/crowdin-apps-functions popularity was classified as not popular.
We found that @crowdin/crowdin-apps-functions demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.