@manekinekko/actions-on-google-i18n

An i18n module for the Actions On Google SDK

Stats

StarsIssuesVersionUpdatedCreatedSize
@manekinekko/actions-on-google-i18n
1511.3.54 years ago4 years agoMinified + gzip package size for @manekinekko/actions-on-google-i18n in KB

Readme

An i18n module for the Actions On Google SDK

Prepare

Create a folder with your locales (you can use either js or json files), e.g.:

├── src/
│   ├── locales/
│   │   ├── en-GB.json
│   │   └── en-US.json

Each file must export (or have) a valid JSON content:

// src/locales/en-US.json
{
  "WELCOME": "<speak>Hi {name}, I'm your awesome assistant. What can I do for ya?</speak>"
}
// src/locales/en-GB.json
{
  "WELCOME": "<speak>Hi {name}, I'm your amazing assistant. How can I help?</speak>"
};

Install

npm i @manekinekko/actions-on-google-i18n -S

Options

directory

default: ./src/locales/

The directory where the locale files are located.

defaultFile

default: index.js || index.json

The default locale file that will ALWAYS be used for ANY locale.

defaultLocale

default: en-US

The default locale that will be used if no locale can be extracted from the Actions On Google SDK.

Quick setup

Import in your main entry file and call the .use() method to register your DialogflowApp instance:

const i18n = require('@manekinekko/actions-on-google-i18n');
const app = new DialogflowApp({ request, response });
i18n.use(app);

Use

To get the localized content, call the app.__(string, context) method and provide the content key to get the content. You can also provide an optional context object if you set variables in your content:


  const actionMap = new Map();
  actionMap.set('input.welcome', (app) => {
    
    app.ask(app.__('WELCOME', { name: 'Wassim' }));

  });
  app.handleRequest(actionMap);

Full setup

'use strict';
const i18n = require('@manekinekko/actions-on-google-i18n');
const aog = require('actions-on-google');
const DialogflowApp = aog.DialogflowApp;

exports.agent = (request, response) => {
  const app = new DialogflowApp({ request, response });
  i18n
    .configure({
      directory: `${__dirname}/src/locales`,
      defaultFile: `${__dirname}/src/locales/index.json`,
      defaultLocale: 'en-US',
    })
    .use(app);

  const actionMap = new Map();
  actionMap.set('input.welcome', (app) => {
    
    app.ask(app.__('WELCOME', { name: 'Wassim' }));

  });
  app.handleRequest(actionMap);

};

Licence

The MIT License (MIT) Copyright (c) 2017 - Wassim CHEGHAM

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.