Dev Tools Module

This module consists services that is useful for development.

Install

npm install @sociably/core @sociably/dev-tools
# or with yarn
yarn add @sociably/core @sociably/dev-tools

Docs

Check the package references.

Services

In-Memory State

An in-memory implementation of StateController. Check the Using State document for usage guides.

Setup

import Sociably from '@sociably/core';
import { InMemoryState } from '@sociably/dev-tools';

const app = Sociably.createApp({
  modules: [
    InMemoryState.initModule(),
  ],
});

File State

An implementation of StateController that stores state data in a local file for easy debugging. Check the Using State document for usage guides.

Setup

import Sociably from '@sociably/core';
import { FileState } from '@sociably/dev-tools';
import YAML from 'yaml';

const app = Sociably.createApp({
  modules: [
    FileState.initModule({
      path: './.state_storage.json',
    }),
  ],
  services: [
    // you can swap the serializer
    { provide: FileState.Serializer, withValue: YAML }
  ],
});

RegExp Intent Recognition

An simple IntentRecognizer implementation using RegExp. Check the Recognizing Intent document for usage guides.

Setup

import Sociably from '@sociably/core';
import { RegexIntentRecognition } from '@sociably/dev-tools';

const app = Sociably.createApp({
  modules: [
    RegexIntentRecognition.initModule({
      recognitionData: {
        defaultLanguage: 'en',
        languages: ['en', 'ja'],
        intents: {
          hello: {
            trainingPhrases: {
              en: ['hello', 'hi'],
              ja: ['こんにちは', 'おはよう'],
            },
          },
          goodBye: {
            trainingPhrases: {
              en: ['bye', 'see ya'],
              ja: ['さようなら'],
            },
          },
        },
      },
    }),
  ],
});