aor firebase client

Aor-FireBase-Client

Административный клиент для Firebase.

Установка

npm install aor-firebase-client --save

Использование

В качестве параметра компонента <Admin>

 // in src/App.js
import React from 'react' ;
import { Admin , Resource } from 'admin-on-rest' ;
import { RestClient } from 'aor-firebase-client' ;

const firebaseConfig = {
    apiKey : '<your-api-key>' ,
    authDomain : '<your-auth-domain>' ,
    databaseURL : '<your-database-url>' ,
    storageBucket : '<your-storage-bucket>' ,
    messagingSenderId : '<your-sender-id>'
} ;

const clientOptions = {
  timestampFieldNames : {
    createdAt : 'createdAt' ,
    updatedAt : 'updatedAt'
  } ,
  trackedResources : [ {
    name : 'posts' , // The name reference to be used in all other places in AOR
    path : 'blog' , // The path in the database. If missing will use the name
    public : true ,
    uploadFields : [ ] // The string name of the field
  } , 'contacts' ] // A single string assumes path and name as equal, non private and without upload fields
}

const App = ( ) => (
    < Admin restClient = { RestClient ( trackedResources , clientOptions ) } >
        < Resource name = "posts" list = { PostList } />
        < Resource name = "contacts" list = { ContactList } />
    </ Admin >
) ;

export default App ;

Auth Client

Пакет позволяет управлять процессом входа в систему/входа в реализацию необязательной authClient Prop компонента Admin (см. Документацию).
Он хранит firebaseToken в localStorage . Доступные параметры конфигурации:

• userProfilePath : путь базы данных к профилям пользователей. По умолчанию /users/ . Имейте в виду черты.

• userAdminProp : ключ базы данных к точке, если у пользователя есть полномочия администратора. По умолчанию isAdmin

Окончательный путь: {userProfilePath}/{uid}/{userAdminProp}

• localStorageTokenName : местный идентификатор хранения для удержания токена клиента Firebase, по умолчанию aorFirebaseClientToken

• handleAuthStateChange : способ переопределить процесс AUTH

 // in src/App.js
...
import { RestClient , AuthClient } from 'aor-firebase-client' ;

const firebaseConfig = {
    apiKey : '<your-api-key>' ,
    authDomain : '<your-auth-domain>' ,
    databaseURL : '<your-database-url>' ,
    storageBucket : '<your-storage-bucket>' ,
    messagingSenderId : '<your-sender-id>'
} ;

const authConfig = {
    userProfilePath : 'profiles' ,
    userAdminProp : 'superuser'
}

const App = ( ) => (
    < Admin restClient = { RestClient ( firebaseConfig ) } authClient = { AuthClient ( authConfig ) } >
        < Resource name = "posts" list = { PostList } />
    </ Admin >
) ;

export default App ;

Примечание. Authclient требует использования RestClient для инициализации Firebase. В качестве альтернативы, вы можете не использовать RestClient и инициализировать Firebase самостоятельно:

 import { RestClient , AuthClient } from 'aor-firebase-client' ;
import firebase from 'firebase' ;

const firebaseConfig = {
    apiKey : '<your-api-key>' ,
    authDomain : '<your-auth-domain>' ,
    databaseURL : '<your-database-url>' ,
    storageBucket : '<your-storage-bucket>' ,
    messagingSenderId : '<your-sender-id>'
} ;

firebase . initializeApp ( firebaseConfig ) ;

const App = ( ) => (
    < Admin authClient = { AuthClient ( ) } >
        < Resource name = "posts" list = { PostList } />
    </ Admin >
) ;

export default App ; 

Изменение

v0.0.10

• Исправление документации для Authclient #17
• Обрабатывать пустые коллекции #18
• Построить LIB на подготовке #19
• Спасибо @grahamlyus, который много работал в этом месяце, чтобы сделать этот релиз возможным! Слава!

v0.0.9

• Исправляет

v0.0.8

• Исправьте это сохранение на неправильном пути № 7
• Исправить ссылки README

v0.0.7

• Опечатки, тесты и исправления #6

v0.0.6

• Ридме исправляет #4

v0.0.4

• CI настроен

v0.0.3

• Фиксированная конфигурация клиента Auth #2
• Добавлены временные метки № 3
• Начальное модульное тестирование / CI

v0.0.1

• Первоначальный коммит, много DOS

Лицензия

Эта библиотека лицензирована по лицензии MIT.