@wezard/halo-core v0.12.0

Halo Core

Table of Content

1. Installation
   1. Firebase
2. Usage
   1. Initialization
   2. Authentication and user creation
3. Overview
   1. User
   2. Agent
   3. Room
4. Create an Halo Module

Installation

Firebase

Add Halo dependencies:

yarn add @wezard/halo-core @wezard/react-native-halo-firebase

Add Firebase dependencies:

yarn add @react-native-firebase/app @react-native-firebase/auth @react-native-firebase/firestore @react-native-firebase/storage

Setup Firebase following official guide.

Usage

Initialization

import { halo } from '@wezard/halo-core'

// ...

const initChat = () => {
    halo.initialize('firebase')
}

Authentication and user creation

Halo Firebase needs to authenticate the user before they perform any action.

import { halo } from '@wezard/halo-core'
import auth from '@react-native-firebase/app'

// ...
const signUp = async () => {
    try {
        await auth().createUserWithEmailAndPassword(email, password)
        const user = await halo.createUser({
            firstName: 'Matteo',
            lastName: 'Bianchi',
            nickname: 'mattyb98',
            image: 'https://avatar.com'
        })
        // save user data
    } catch (error) {
        // handle error
    }
}

const signIn = async () => {
    try {
        const userCredentials = await auth().signInWithEmailAndPassword(email, password)
        const user = await halo.getUser(userCredentials.user.uid)
        // save user data
    } catch (error) {
        // handle error
    }
}

Overview

User

Agent

Room

Create an Halo Module

In order to create an Halo Module, init a React Native library, you can use create-react-native-library.

Then add Halo dependency:

yarn add @wezard/halo-core

Now you have to implements IUser, IAgent and IRoom interfaces:

• user.ts

import { IUser } from '@wezard/halo-core'

export class User implements IUser {
    // implements IUser methods
}

• agent.ts

import { IAgent } from '@wezard/halo-core'

export class Agent implements IAgent {
    // implements IAgent methods
}

• room.ts

import { IRoom } from '@wezard/halo-core'

export class Room implements IRoom {
    // implements IRoom methods
}

And create an index.ts file that exports classes

export * from './agent'
export * from './room'
export * from './user'