PouchORM-Auth

A plugin for PouchORM - the definitive ORM for working with PouchDB.

This plugin makes it easy to use a PouchORM collection as an authentication backend. This leverages the great PouchDB-Auth plugin written for PouchDB Server.

To install

npm i pouchorm-auth

or if you prefer yarn: yarn add pouchorm-auth

Make sure to also install pouchorm as a dependency of your project using npm or yarn.

How to Use

Consider this definition of a collection which uses the built-in exported model PouchUser.

1// Person.ts
2
3    import { PouchCollection, PouchORM } from 'pouchorm';
4    import { PouchUser, createPouchAuthCollection } from 'pouchorm-auth'
5
6    PouchORM.LOGGING = true; // enable diagnostic logging if desired
7
8    export class UserCollection extends PouchCollection<PouchUser> {
9    }
10    

Now that we have defined our Collection for that model, here is how we instantiate authentication collections.

1
2    // instantiate a collection by giving it the dbname it should use
3    let userCollection = new UserCollection('usersdb');
4
5    // Transform the collection.
6    userCollection = createPouchAuthCollection<PouchUser>(userCollection)
7
8    export userCollection
9

From this point:

• We have our definitions
• We have our collection instances

We are ready to start authenticating!

1    import { PouchUser } from 'pouchorm-auth'
2    import { userCollection } from '...'
3
4    // Using collections
5    let somePerson: PouchUser = await userCollection.signUp(
6        'jeanluc@picard.net',
7        'Darmok and Jalad at Tanagra',
8        {
9            age: 24,
10            email: 'jeanluc@picard.net'
11        }
12    )
13
14    somePerson = await personCollection.logIn('jeanluc@picard.net', 'Darmok and Jalad at Tanagra');
15    
16    // somePerson has been persisted and will now also have some metafields like _id, _rev, etc.
17
18    // Some data to be updated, which would need an upsert merge deltaFunction
19    // so that the password is not lost from the existing record
20    somePerson.age = 45;
21    somePerson = await personCollection.upsert(somePerson, (existing) => { ...existing, ...somePerson });
22
23    // changes to somePerson has been persisted. _rev would have also changed.
24
25    const result: PouchUser[] = await personCollection.find({age: 45})
26    
27    // result.length === 1
28

PouchCollection instance API reference

Consider that T is the provided type or class definition of your model. It is recommended that User models extend from class PouchUser to retain special logic designed to work with Pouch and Couch.

Constructor

createPouchAuthCollection<T>(collection: PouchCollection<T>)

Methods dynamically added to collection

These methods were added to provide collection-specific functionality

• userId(username: string) => string
• checkAuthInit() => Promise<void>
• useAsAuthCollection() => Promise<void>
• stopUsingAsAuthCollection() => void

These methods are wrappers for functionality provided by pouchdb-auth; see their documentation for specifics

• signUp(username: string, password: string, options?: PouchAuth.SignUpOptions) => Promise<T>
• logIn(username: string, password: string) => Promise<T> | Promise<void>
• logOut() => Promise<PouchAuth.LoginResponse>
• session() => Promise<PouchAuth.SessionResponse>

Supporting the Project

PRs are welcome. NOTE: Tests required for new PR acceptance. Those are easy to make as well.

Contributors

• Aaron Huggins