npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@crowdin/crowdin-apps-functions

v0.9.2

Published

Utility library to easily and quickly develop Crowdin App

Downloads

654

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 and in the Quick Start guide.

npm npm CI codecov GitHub Release Date GitHub contributors License

Table of Contents

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 | | 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. 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