Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crowdin/crowdin-apps-functions
Common functions used by Crowdin Apps
https://github.com/crowdin/crowdin-apps-functions
app apps crowdin helper
Last synced: about 2 months ago
JSON representation
Common functions used by Crowdin Apps
- Host: GitHub
- URL: https://github.com/crowdin/crowdin-apps-functions
- Owner: crowdin
- License: mit
- Created: 2021-09-28T15:12:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-04T12:34:39.000Z (2 months ago)
- Last Synced: 2024-11-04T13:25:34.611Z (2 months ago)
- Topics: app, apps, crowdin, helper
- Language: TypeScript
- Homepage: https://support.crowdin.com/crowdin-apps/
- Size: 1.36 MB
- Stars: 6
- Watchers: 6
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://developer.crowdin.com/crowdin-apps-about/) and in the [Quick Start](https://developer.crowdin.com/crowdin-apps-quick-start/) guide.
[](https://www.npmjs.com/package/@crowdin/crowdin-apps-functions)
[](https://www.npmjs.com/package/@crowdin/crowdin-apps-functions)
[](https://github.com/crowdin/crowdin-apps-functions/actions/workflows/basic.yml)
[](https://codecov.io/gh/crowdin/crowdin-apps-functions)
[](https://github.com/crowdin/crowdin-apps-functions/releases)
[](https://github.com/crowdin/crowdin-apps-functions/graphs/contributors)
[](https://github.com/crowdin/crowdin-apps-functions/blob/master/LICENSE)
## Table of Contents
* [Installation](#installation)
* [Quick Start](#quick-start)
* [Contributing](#contributing)
* [Seeking Assistance](#seeking-assistance)
* [License](#license)
## Installation
### npm
`npm i @crowdin/crowdin-apps-functions`
### yarn
`yarn add @crowdin/crowdin-apps-functions`
## Quick Start
Typescript
```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
```javascript
import { generateOAuthToken } from '@crowdin/crowdin-apps-functions';
generateOAuthToken({ clientId: 'app_client_id', clientSecret: 'app_client_secret', code: 'code_from_install_event'});
```
Javascript CommonJS
```javascript
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 |
| `fetchAgentToken` | fetch Agent 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](https://github.com/crowdin/create-crowdin-app). It can be used as a basis for your app.
## Contributing
If you want to contribute please read the [Contributing](/CONTRIBUTING.md) 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](https://github.com/crowdin/crowdin-apps-functions/issues).
If you've found an error in these samples, please [Contact Customer Success Service](https://crowdin.com/contacts).
## 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.