feat($browser): Adding localforage and updating README

Specifying that the project is a WIP on the readme and adding a base for using localforage

Author: phillipcurl

README.md

@@ -1,3 +1,5 @@
+# WIP: DO NOT USE YET
+
 # ngx-storage
 [![Build Status](https://travis-ci.org/phillipcurl/ngx-storage.svg?branch=master)](https://travis-ci.org/phillipcurl/ngx-storage)
 [![npm version](https://badge.fury.io/js/ngx-storage.svg)](http://badge.fury.io/js/ngx-storage)

package.json

@@ -47,6 +47,7 @@
     "@types/chai": "^3.4.30",
     "@types/core-js": "^0.9.32",
     "@types/jasmine": "^2.2.33",
+    "@types/localforage": "0.0.32",
     "@types/sinon": "^1.16.27",
     "@types/sinon-chai": "^2.7.26",
     "awesome-typescript-loader": "^2.2.4",
@@ -93,5 +94,8 @@
     "commitizen": {
       "path": "node_modules/cz-conventional-changelog"
     }
+  },
+  "dependencies": {
+    "localforage": "^1.4.3"
   }
 }

src/index.ts

@@ -1 +1,4 @@
-export * from './ngxStorage.module';
+export * from './services';
+export * from './models';
+
+export * from './ngxStorage.module';

src/models/index.ts

@@ -0,0 +1 @@
+export { LocalForageItem } from './localForageItem';

src/models/localForageItem.ts

@@ -0,0 +1,4 @@
+export interface LocalForageItem {
+  key: string;
+  value: any;
+};

src/ngxStorage.module.ts

@@ -1,7 +1,16 @@
 import { NgModule, ModuleWithProviders } from '@angular/core';
 import { CommonModule } from '@angular/common';
+import * as localforage from 'localforage';
+
+import { LocalForageService } from './services';
+import { LocalForageToken } from './tokens';
+
 import { HelloWorldComponent } from './helloWorld.component';
 
+export function localforageFactory(): any {
+    return localforage;
+}
+
 @NgModule({
   declarations: [
     HelloWorldComponent
@@ -13,7 +22,13 @@ export class NgxStorageModule {
 
   static forRoot(): ModuleWithProviders {
     return {
-      ngModule: NgxStorageModule
+      ngModule: NgxStorageModule,
+      providers: [{
+          provide: LocalForageToken,
+          useFactory: localforageFactory
+        },
+        LocalForageService
+      ]
     };
   }
 

src/services/index.ts

@@ -0,0 +1 @@
+export { LocalForageService } from './localForage.service';

src/services/localForage.service.ts

@@ -0,0 +1,55 @@
+import { Injectable, Inject } from '@angular/core';
+
+import { Observable } from 'rxjs/Observable';
+import 'rxjs/add/observable/fromPromise';
+
+import { LocalForageItem } from './../models';
+import { LocalForageToken } from './../tokens';
+
+@Injectable()
+export class LocalForageService {
+
+  constructor(@Inject(LocalForageToken) private localForage: any) {}
+
+  getItem(key: string): Observable < any > {
+    let promise: Promise < any > = this.localForage.getItem(key);
+
+    return Observable.fromPromise(promise);
+  }
+
+  setItem(item: LocalForageItem): Observable < any > {
+    let promise: Promise < any > = this.localForage.setItem(item.key, item.value);
+
+    return Observable.fromPromise(promise);
+  }
+
+  removeItem(key: string): Observable < any > {
+    let promise: Promise < any > = this.localForage.removeItem(key);
+
+    return Observable.fromPromise(promise);
+  }
+
+  clear(): Observable < any > {
+    let promise: Promise < any > = this.localForage.clear();
+
+    return Observable.fromPromise(promise);
+  }
+
+  length(): Observable < number > {
+    let promise: Promise < any > = this.localForage.length();
+
+    return Observable.fromPromise(promise);
+  }
+
+  key(index: number): Observable < string > {
+    let promise: Promise < any > = this.localForage.key(index);
+
+    return Observable.fromPromise(promise);
+  }
+
+  keys(): Observable < string[] > {
+    let promise: Promise < any > = this.localForage.keys();
+
+    return Observable.fromPromise(promise);
+  }
+}

src/tokens/index.ts

@@ -0,0 +1 @@
+export { LocalForageToken } from './localForage.token';

src/tokens/localForage.token.ts

@@ -0,0 +1,5 @@
+import { OpaqueToken } from '@angular/core';
+
+export function LocalForageToken(): OpaqueToken {
+    return new OpaqueToken('localforage');
+}