An npm package that provides you with a simple promise API, that fetches languages and translations from the OneSky REST API and can also upload files to it.
npm install --save onesky-fetch
// ES5 syntax
var OneSkyFetch = require('onesky-fetch');
// ES6 syntax
import OneSkyFetch from 'onesky-fetch';Obtain the necessary settings from here:
https://<Your OneSky URL prefix>.oneskyapp.com/admin/site/settings
and here:
https://<Your OneSky URL prefix>.oneskyapp.com/admin/project/dashboard/project/<The ID of the currently open project>
// ES6 syntax
const oneSkyConfig = {
secret: '<Your OneSky Secret Key>',
apiKey: '<Your OneSky Public Key',
projectId: '<Your OneSky project ID'
};// ES6 syntax
const osf = OneSkyFetch(oneSkyConfig);// in ES5 syntax
osf.fetchLanguages()
.then(function(languages) {
console.log(languages);
});
// or ES6 syntax
osf.fetchLanguages()
.then(languages => {
console.log(languages);
});
// or even async / await syntax
async function test() {
const languages = await osf.fetchLanguages();
console.log(languages);
}[
{
code: 'it-IT',
english_name: 'Italian (Italy)',
local_name: 'Italiano (Italia)\u0000',
custom_locale: null,
locale: 'it',
region: 'IT',
is_base_language: false,
is_ready_to_publish: false,
translation_progress: '0.0%',
last_updated_at: '#####',
last_updated_at_timestamp: #####
},
// other languages
]
const languages = ['en','it-IT'];
const fileName = 'strings.json';
osf.fetchTranslations(languages, fileName)
.then(function(translations) {
console.log(translations);
});[
{ language: 'en', text: '<Your english strings>' },
{ language: 'it-IT', text: '<Your italian strings>' }
]
A convenient function to fetch all translations:
const fileName = 'strings.json';
osf.fetchAllTranslations(fileName)
.then(function(translations) {
console.log(translations);
});This is just a chain of fetching languages and fetching their translations.
Feel free to contribute with additional functions.
That isn't really a fetch, but it may be a useful extension to the existing features.
The options paramter is optional and can be used to pass additional parameters, like for example locale to upload specific translations - see OneSky's API documentation for more information.
const content = '{"hello","Hallo"}';
const fileName = 'string.json';
const fileFormat = 'HIERARCHICAL_JSON';
const options = {locale: 'de'};
osf.uploadFile(content, fileName, fileFormat, options)
.then(function(result) {
console.log("Status Code:", result.status);
});Status Code: 201