aor firebase client

aor-firebase-client

Ein Admin-auf-REST-Client für Firebase.

Installation

npm install aor-firebase-client --save

Verwendung

Als Parameter der <Admin> -Komponente

 // 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

Mit dem Paket können Sie den Anmelde-/Anmeldeprozess verwalten, der eine optionale authClient -Requisite der Admin implementiert (siehe Dokumentation).
Es speichert ein firebaseToken in localStorage . Die verfügbaren Konfigurationsoptionen sind:

• userProfilePath : Der Datenbankpfad zu Benutzerprofilen. Standardmäßig an /users/ . Denken Sie an die Schrägstriche.

• userAdminProp : Der Datenbankschlüssel zum Zeigen, wenn ein Benutzer Administrator -Befugnisse verfügt. Standardeinstellungen nach isAdmin

Der letzte Pfad lautet: {userProfilePath}/{uid}/{userAdminProp}

• localStorageTokenName : Lokale Speicherkennung zum Halten des Firebase Client -Tokens, aorFirebaseClientToken

• handleAuthStateChange : Eine Möglichkeit, den Auth -Prozess zu überschreiben

 // 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 ;

HINWEIS: Der Authclient erfordert die Verwendung des RestClient, um Firebase zu initialisieren. Alternativ können Sie sich dafür entscheiden, den Restclient nicht wie folgt zu verwenden und FireBase zu initialisieren:

 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

• Dokumentationsfix für Authclient #17
• Behandeln Sie leere Sammlungen #18
• Bauen Sie Lib auf Vorbereitung #19
• Vielen Dank an @grahamlyus, der diesen Monat viel gearbeitet hat, um diese Veröffentlichung möglich zu machen! Lob!

v0.0.9

• Korrekturen

v0.0.8

• Beheben Sie das Speichern auf dem falschen Weg #7
• Fix ReadMe -Links

v0.0.7

• Tippfehler, Tests und Fixes #6

v0.0.6

• ReadMe Fixes #4

v0.0.4

• CI konfiguriert

v0.0.3

• Behobene Auth -Client -Konfiguration Nr. 2
• Timestempel #3 hinzugefügt
• Anfangseinheiten -Test / CI

v0.0.1

• Erstes Commit, viele zu dos

Lizenz

Diese Bibliothek ist unter der MIT -Lizenz lizenziert.