Git Product home page Git Product logo

actions-on-google-i18n's Introduction

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 be) a valid JSON content. Each key can have a text and ssml entry:

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

Or, you can use simple string which will default to a text entry:

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

In either cases, you can also use an array of text utterances (A), you will get a random phrase on each call:

// src/locales/en-GB.json
{
  "WELCOME": [
    "Hi {name}, I'm your amazing assistant. How can I help?",
    "Hi {name}",
    "How can I help?"
  ]
}

Or an array of SSML and text utterances (B):

// src/locales/en-GB.json
{
  "WELCOME": [
    {
      "text": "Hi {name}, I'm your amazing assistant. How can I help?",
      "ssml": "<speak>Hi {name}, I'm your amazing assistant. How can I help?</speak>"
    },
    {
      "text": "Hi {name}",
      "ssml": "<speak>Hi {name}</speak>"
    },
    {
      "text": "How can I help?",
      "ssml": "<speak>How can I help?</speak>"
    }
  ]
}

Make sure NOT to mix and match (A) and (B) when using an array of utterances. This is not supported for now!

Install

npm i @sfeir/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('@sfeir/actions-on-google-i18n');
const app = dialogflow({ debug: true });;
i18n.use(app);

Use

To get the localized content, call the conv.__(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:

app.intent('welcome', (conv) => {
    conv.ask(conv.__('WELCOME', { name: 'Wassim' }));
});

Full setup

'use strict';
const i18n = require('@sfeir/actions-on-google-i18n');
const functions = require('firebase-functions');
const { dialogflow } = require('actions-on-google');

const app = dialogflow({ debug: true });

i18n
  .configure({
    directory: `${__dirname}/src/locales`,
    defaultFile: `${__dirname}/src/locales/index.json`,
    defaultLocale: 'en-US',
  })
  .use(app);
  
app.intent('welcome', (conv) => {
  conv.ask(conv.__('WELCOME', { name: 'Wassim' }));
});

exports.agent = functions.https.onRequest(app);

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.

actions-on-google-i18n's People

Contributors

fmeuman avatar manekinekko avatar renovate[bot] avatar santima10 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

actions-on-google-i18n's Issues

file "/srv/locales/en-us" does not exist

I'm trying to deploy, with the local emulator works fine, a Firebase Cloud Function, but I get the following error:

Detailed stack trace: Error: [actions-on-google-i18n] file "/srv/locales/en-us" does not exist.
    at __i18nFactory (/srv/node_modules/@sfeir/actions-on-google-i18n/index.js:68:15)
    at I18n.use (/srv/node_modules/@sfeir/actions-on-google-i18n/index.js:100:25)
    at Object.<anonymous> (/srv/index.js:12:6)
    at Module._compile (module.js:652:30)
    at Object.Module._extensions..js (module.js:663:10)
    at Module.load (module.js:565:32)
    at tryModuleLoad (module.js:505:12)
    at Function.Module._load (module.js:497:3)
    at Module.require (module.js:596:17)
    at require (internal/module.js:11:18)

Here is my code

app.getUserLocale is not a function

Hello, I'm trying to use your library but as soon as I try to run it, I got this error:

TypeError: app.getUserLocale is not a function at I18n.use (D:\GitHub\Coffee-Advisor\node_modules\@manekinekko\actions-on-google-i18n\index.js:50:22) at Object.<anonymous> (D:\GitHub\Coffee-Advisor\functions\index.js:36:6) at Module._compile (module.js:652:30) at Object.Module._extensions..js (module.js:663:10) at Module.load (module.js:565:32) at tryModuleLoad (module.js:505:12) at Function.Module._load (module.js:497:3) at Module.require (module.js:596:17) at require (internal/module.js:11:18) at C:\Users\david\AppData\Roaming\npm\node_modules\firebase-tools\lib\triggerParser.js:21:11

That's how i wrote my webhook with V2 library:

const functions = require('firebase-functions');
const i18n = require('@manekinekko/actions-on-google-i18n');

const app = dialogflow();
i18n.use(app);

...

exports.myapp= functions.https.onRequest(app);

Typescript mapping

Hi, do you have plans to rewrite this to Typescript or add TS mappings? It's hard to use with typescript. I see that i18n had the same trouble
mashpie/i18n-node#399

There is dts-gen but it's not working correctly with current code as there is no mapping for __.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.