Merge pull request #18 from reyesoft/feature/store_with_promise

Feature/store with promise

Author: pablorsk

CHANGELOG.md

@@ -1,8 +1,19 @@
+# 0.7.x (planned)
+
+- Interfaces are in `ng.jsonapi` now
+- Resources can be extended for personalized classes
+
 # 0.6.x
 
 ## Localstorage cache
 
 - Save on localstore all data. When you request a resource or collection, first check memory. If its empty, read from store. If is empty, get the data from back-end.
+- HttpStorage deprecated: jsons were saved as sent by the server, now we save json with logic (saving ids and resources separately).
+- Service with `toServer()` and `fromServer()` functions. They execute before and after http request. Ideal for type conversions.
+- `JsonapiCore.duplicateResource(resouce, ...relationtypes)` return a duplication of resource. You can duplicate resources and, optionally, their relationships. (v0.6.16)
+
+## No more declaration file .d.ts
+
 - typings and index.d.ts removed. We only use `import`
 
 # 0.5.x

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-angular-jsonapi",
-  "version": "0.6.2",
+  "version": "0.6.22",
   "description": "JSONAPI library developed for AngularJS in Typescript",
   "repository": {
     "type": "git",

src/demo/authors/authors.component.ts

@@ -5,7 +5,7 @@ class AuthorsController {
 
     /** @ngInject */
     constructor(
-        protected JsonapiCore,
+        protected JsonapiCore: Jsonapi.ICore,
         protected AuthorsService: Jsonapi.IService
     ) {
         this.authors = AuthorsService.all(

src/demo/authors/authors.service.ts

@@ -22,4 +22,14 @@ export class AuthorsService extends Jsonapi.Service {
         },
         ttl: 10
     };
+
+    // executed before get data from server
+    public parseFromServer(attributes): void {
+        attributes.name = attributes.name + ' ♥';
+    }
+
+    // executed before send to server
+    public parseToServer(attributes): void {
+        attributes.name = attributes.name.replace('♥', '').trim();
+    }
 }

src/library/core.ts

@@ -1,6 +1,6 @@
 import * as angular from 'angular';
 import './services/core-services.service';
-import { ICore, IService } from './interfaces';
+import { ICore, IResource, ICollection, IService } from './interfaces';
 
 export class Core implements ICore {
     private resourceServices: Object = {};
@@ -48,6 +48,33 @@ export class Core implements ICore {
         Core.injectedServices.JsonapiStoreService.clearCache();
         return true;
     }
+
+    // just an helper
+    public duplicateResource(resource: IResource, ...relations_alias_to_duplicate_too: Array<string>): IResource {
+        let newresource = this.getResourceService(resource.type).new();
+        angular.merge(newresource.attributes, resource.attributes);
+        newresource.attributes.name = newresource.attributes.name + ' xXx';
+        angular.forEach(resource.relationships, (relationship, alias) => {
+            if ('id' in relationship.data) {
+                // relation hasOne
+                if (relations_alias_to_duplicate_too.indexOf(alias) > -1) {
+                    newresource.addRelationship(this.duplicateResource(<IResource>relationship.data), alias);
+                } else {
+                    newresource.addRelationship(<IResource>relationship.data, alias);
+                }
+            } else {
+                // relation hasMany
+                if (relations_alias_to_duplicate_too.indexOf(alias) > -1) {
+                    angular.forEach(relationship.data, relationresource => {
+                        newresource.addRelationship(this.duplicateResource(relationresource), alias);
+                    });
+                } else {
+                    newresource.addRelationships(<ICollection>relationship.data, alias);
+                }
+            }
+        });
+        return newresource;
+    }
 }
 
 angular.module('Jsonapi.services').service('JsonapiCore', Core);

src/library/interfaces/cache.d.ts

@@ -1,19 +1,7 @@
 import { ICollection, IResource } from '../interfaces';
 
 export interface ICache {
-    resources: Object;
-
-    isCollectionExist(url: string): boolean;
-    isCollectionLive(url: string, ttl: number): boolean;
-    getOrCreateCollection(url: string, use_store?: boolean): ICollection;
     setCollection(url: string, collection: ICollection): void;
-    clearAllCollections(): boolean;
-
-    isResourceLive(id: string, ttl: number): boolean;
-    getOrCreateResource(type: string, id: string, use_store?: boolean): IResource;
-    getResource(id: string): IResource;
-    getResourceFromStore(resource: IResource): void;
     setResource(resource: IResource): void;
-
-    removeResource(id: string): void;
+    deprecateCollections(path_start_with: string): boolean;
 }

src/library/interfaces/cachememory.d.ts

@@ -0,0 +1,15 @@
+import { ICollection, IResource } from '../interfaces';
+import { ICache } from '../interfaces/cache.d';
+
+export interface ICacheMemory extends ICache {
+    resources: { [id: string]: IResource };
+
+    getOrCreateCollection(url: string): ICollection;
+    isCollectionExist(url: string): boolean;
+    isCollectionLive(url: string, ttl: number): boolean;
+
+    isResourceLive(id: string, ttl: number): boolean;
+    getOrCreateResource(type: string, id: string): IResource;
+
+    removeResource(id: string): void;
+}

src/library/interfaces/cachestore.d.ts

@@ -0,0 +1,7 @@
+import { ICollection, IResource } from '../interfaces';
+import { ICache } from '../interfaces/cache.d';
+
+export interface ICacheStore extends ICache {
+    getResource(resource: IResource): ng.IPromise<object>;
+    getCollectionFromStorePromise(url:string, collection: ICollection): ng.IPromise<ICollection>;
+}

src/library/interfaces/collection.d.ts

@@ -6,7 +6,7 @@ export interface ICollection extends Array<IResource> {
     $length: number;
     $toArray: Array<IResource>;
     $is_loading: boolean;
-    $source: 'new' | 'memory' | 'store' | 'server' | 'httpstorage';
+    $source: 'new' | 'memory' | 'store' | 'server';
     $cache_last_update: number;
     data: Array<IDataResource>; // this need disapear is for datacollection
     page: IPage;

src/library/interfaces/core.d.ts

@@ -1,4 +1,4 @@
-import { IService } from './index';
+import { IService, IResource } from './index';
 
 export interface ICore {
     // jsonapiServices: Object;
@@ -13,6 +13,7 @@ export interface ICore {
     getResourceService(type: string): IService;
     refreshLoadings(factor: number): void;
     clearCache(): void;
+    duplicateResource(resource: IResource, ...relations_types: Array<string>): IResource;
 
     // static
     me?: IService;