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 ;

認証クライアント

このパッケージを使用すると、 AdminコンポーネントのオプションのauthClientプロップを実装するログイン/ログアウトプロセスを管理できます（ドキュメントを参照）。
localStorageにfirebaseTokenを保管しています。利用可能な構成オプションは次のとおりです。

• userProfilePath ：ユーザープロファイルへのデータベースパス。デフォルト/users/ 。スラッシュに注意してください。

• userAdminProp ：ユーザーが管理電力を持っている場合にポイントするデータベースキー。デフォルトはisAdminになります

最後のパスは次のとおりです。 {userProfilePath}/{uid}/{userAdminProp}

• localStorageTokenName ：Firebaseクライアントトークンを保持するローカルストレージ識別子、デフォルトはaorFirebaseClientTokenになります

• handleAuthStateChange ：認証プロセスをオーバーライドする方法

 // 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は、FireBaseを初期化するためにRESTClientを使用する必要があります。または、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 ; 

Changelog

v0.0.10

• AuthClient＃17のドキュメント修正
• 空のコレクション＃18を処理します
• 準備＃19でLIBを構築します
• 今月このリリースを可能にするために多くのことをした@grahamlyusに感謝します！称賛！

v0.0.9

• 修正

v0.0.8

• 間違ったパス＃7で保存することを修正します
• readmeリンクを修正します

v0.0.7

• タイプミス、テスト、修正＃6

v0.0.6

• readme修正＃4

v0.0.4

• CI構成

v0.0.3

• Auth Client Configuration＃2を修正しました
• タイムスタンプ＃3を追加しました
• 初期単位テスト / CI

v0.0.1

• 最初のコミット、DOSにたくさん

ライセンス

このライブラリは、MITライセンスに基づいてライセンスされています。