relationships has a types now

pablorsk · pablorsk · commit c68d7111731b · 2017-04-12T15:40:57.000-03:00
diff --git a/README.md b/README.md
@@ -212,6 +212,12 @@ let authors = AuthorsService.all(
 );
 ```
 
+#### Collection page
+
+- number: number of the current page
+- limit: limit of resources per page ([it's sended to server by url](http://jsonapi.org/format/#fetching-pagination))
+- information returned from server (check if is avaible) **total_resources: total of avaible resources on server** resources_per_page: total of resources returned per page requested
+
 ### Include anothers resources (is comming)
 
 ## Demo local
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ts-angular-jsonapi",
-  "version": "0.4.2",
+  "version": "0.4.14",
   "description": "JSONAPI library developed for AngularJS in Typescript",
   "repository": {
     "type": "git",
@@ -74,7 +74,7 @@
     "ts-loader": "^0.7.2",
     "tslint": "^3.2.1",
     "tslint-loader": "^2.1.0",
-    "typescript": "^1.7.5",
+    "typescript": "^2.2.0",
     "typings": "^1.0.4",
     "webpack": "2.1.0-beta.8",
     "webpack-split-by-path": "^0.0.10"
diff --git a/src/library/index.d.ts b/src/library/index.d.ts
@@ -10,6 +10,9 @@
 /// <reference path="./interfaces/errors.d.ts"/>
 /// <reference path="./interfaces/links.d.ts"/>
 
+/// <reference path="./interfaces/relationship.d.ts"/>
+/// <reference path="./interfaces/relationships.d.ts"/>
+
 // Parameters for TS-Jsonapi Classes
 /// <reference path="./interfaces/schema.d.ts"/>
 
diff --git a/src/library/interfaces/attributes.d.ts b/src/library/interfaces/attributes.d.ts
@@ -0,0 +1,3 @@
+export interface IAttributes {
+    [value: string]: boolean | string | number;
+}
diff --git a/src/library/interfaces/index.d.ts b/src/library/interfaces/index.d.ts
@@ -1,8 +1,11 @@
+export * from './attributes.d'
 export * from './core.d'
 export * from './collection.d'
 export * from './schema.d'
 export * from './service.d'
 export * from './resource.d'
+export * from './relationship.d'
+export * from './relationships.d'
 export * from './cache.d'
 export * from './params-collection.d'
 export * from './params-resource.d'
diff --git a/src/library/interfaces/params-collection.d.ts b/src/library/interfaces/params-collection.d.ts
@@ -4,6 +4,7 @@ import { IPage } from './page.d';
 interface IParamsCollection extends IParams {
     localfilter?: any;
     remotefilter?: any;
+    smartfilter?: any;
     page?: IPage;
     storage_ttl?: number;
 }
diff --git a/src/library/interfaces/relationship.d.ts b/src/library/interfaces/relationship.d.ts
@@ -0,0 +1,7 @@
+import { ICollection, IResource } from '../interfaces';
+
+interface IRelationship {
+    // IDataResource added for this reason:
+    // redefined from IDataResource (return errors /home/rsk/desarrollo/ts-angular-jsonapi/src/library/services/resource-functions.ts)
+    data: ICollection | IResource | IDataResource | {};
+}
diff --git a/src/library/interfaces/relationships.d.ts b/src/library/interfaces/relationships.d.ts
@@ -0,0 +1,5 @@
+import { IRelationship } from '../interfaces/relationship.d';
+
+interface IRelationships {
+    [value: string]: IRelationship;
+}
diff --git a/src/library/interfaces/resource.d.ts b/src/library/interfaces/resource.d.ts
@@ -1,4 +1,4 @@
-import { ICollection, ICache, IParamsResource } from './index';
+import { IRelationships, ICollection, ICache, IParamsResource } from './index';
 
 export interface IResource extends IDataResource {
     is_new: boolean;
@@ -8,6 +8,10 @@ export interface IResource extends IDataResource {
 
     memorycache: ICache;
 
+    type: string;   // dont work extend?
+
+    relationships: IRelationships;    // redefined from IDataResource
+
     reset? (): void;
     addRelationship? (resource: IResource, type_alias?: string): void;
     addRelationships? (resources: ICollection, type_alias: string): void;
diff --git a/src/library/interfaces/service.d.ts b/src/library/interfaces/service.d.ts
@@ -1,10 +1,11 @@
 import { ISchema, IResource, ICollection, IParamsCollection, IParamsResource } from './index';
 
 export interface IService {
+    smartfilter?: string;
     schema?: ISchema;
     new? (): IResource;
     register? (): boolean;
-    get (id: String, params?: Object | Function, success?: Function, error?: Function): IResource;
+    get<T extends IResource>(id: string | number, params?: IParamsResource | Function, fc_success?: Function, fc_error?: Function): T;
     all(params?: IParamsCollection | Function, success?: Function, error?: Function): ICollection;
     delete (id: String, params?: IParamsResource | Function, success?: Function, error?: Function): void;
     getService? (): any;    // any, becouse depends of extended class
diff --git a/src/library/resource.ts b/src/library/resource.ts
@@ -9,30 +9,23 @@ import { Converter } from './services/resource-converter';
 import { LocalFilter } from './services/localfilter';
 import { MemoryCache } from './services/memorycache';
 
-import { ISchema, IResource, ICollection, ICache, IParamsCollection, IParamsResource } from './interfaces';
-
-export class Resource implements IResource {
-    public schema: ISchema;
-    protected path: string;   // without slashes
+import { IService, IAttributes, ISchema, IResource, ICollection, ICache, IParamsCollection, IParamsResource } from './interfaces';
+import { IRelationships, IRelationship } from './interfaces';
 
+export class Resource implements IResource, IService {
     public is_new = true;
     public is_loading = false;
     public is_saving = false;
-    public type: string;
-    public id: string;
-    public attributes: any ;
-    public relationships: any = {}; // [];
-
+    public schema: ISchema;
     public memorycache: ICache;
-    public cache_vars: Object = {};
 
+    public type: string;
+    public id: string;
+    public attributes: IAttributes;
+    public relationships: IRelationships = {};
 
-    /*
-    just for fix _delete becouse we duplicate collection before
-    return on _all()
-    this need to go out on the future
-    with this prevent do delete resource on user app next to success
-    */
+    private path: string;   // without slashes
+    public smartfiltertype = 'undefined';
     private tempororay_collection: ICollection;
 
     public clone(): any {
@@ -81,8 +74,10 @@ export class Resource implements IResource {
         });
         this.relationships = {};
         angular.forEach(this.schema.relationships, (value, key) => {
-            self.relationships[key] = {};
-            self.relationships[key]['data'] = this.schema.relationships[key].hasMany ? Base.newCollection() : {};
+            self.relationships[key] = <IRelationship>{ data: {} };
+            if (this.schema.relationships[key].hasMany) {
+                self.relationships[key].data = Base.newCollection();
+            }
         });
         this.is_new = true;
     }
@@ -96,7 +91,7 @@ export class Resource implements IResource {
         let included_ids = [ ]; // just for control don't repeat any resource
 
         // REALTIONSHIPS
-        angular.forEach(this.relationships, (relationship, relation_alias) => {
+        angular.forEach(this.relationships, (relationship: IRelationship, relation_alias) => {
 
             if (this.schema.relationships[relation_alias] && this.schema.relationships[relation_alias].hasMany) {
                 // has many (hasMany:true)
@@ -115,21 +110,23 @@ export class Resource implements IResource {
                 });
             } else {
                 // has one (hasMany:false)
+
+                let relationship_data = (<IResource>relationship.data);
                 if (!('id' in relationship.data) && !angular.equals({}, relationship.data)) {
                     console.warn(relation_alias + ' defined with hasMany:false, but I have a collection');
                 }
 
-                if (relationship.data.id && relationship.data.type) {
-                    relationships[relation_alias] = { data: { id: relationship.data.id, type: relationship.data.type } };
+                if (relationship_data.id && relationship_data.type) {
+                    relationships[relation_alias] = { data: { id: relationship_data.id, type: relationship_data.type } };
                 } else {
                     relationships[relation_alias] = { data: { } };
                 }
 
                 // no se agregó aún a included && se ha pedido incluir con el parms.include
-                let temporal_id = relationship.data.type + '_' + relationship.data.id;
-                if (included_ids.indexOf(temporal_id) === -1 && params.include.indexOf(relationship.data.type) !== -1) {
+                let temporal_id = relationship_data.type + '_' + relationship_data.id;
+                if (included_ids.indexOf(temporal_id) === -1 && params.include.indexOf(relationship_data.type) !== -1) {
                     included_ids.push(temporal_id);
-                    included.push(relationship.data.toObject({ }).data);
+                    included.push(relationship_data.toObject({ }).data);
                 }
             }
         });
@@ -150,7 +147,7 @@ export class Resource implements IResource {
         return ret;
     }
 
-    public get<T extends IResource>(id: string, params?: IParamsResource | Function, fc_success?: Function, fc_error?: Function): T {
+    public get<T extends IResource>(id, params?: IParamsResource | Function, fc_success?: Function, fc_error?: Function): T {
         return this.__exec(id, params, fc_success, fc_error, 'get');
     }
 
@@ -255,6 +252,11 @@ export class Resource implements IResource {
 
     public _all(params: IParamsCollection, fc_success, fc_error): ICollection {
 
+        // check smartfiltertype, and set on remotefilter
+        if (params.smartfilter && this.smartfiltertype !== 'localfilter') {
+            angular.extend(params.remotefilter, params.smartfilter);
+        }
+
         // http request
         let path = new PathBuilder();
         let paramsurl = new UrlParamsBuilder();
@@ -280,6 +282,11 @@ export class Resource implements IResource {
             // get cached data and merge with temporal collection
             tempororay_collection.$source = 'memorycache';
 
+            // check smartfiltertype, and set on localfilter
+            if (params.smartfilter && this.smartfiltertype === 'localfilter') {
+                angular.extend(params.localfilter, params.smartfilter);
+            }
+
             // fill collection and localfilter
             let localfilter = new LocalFilter();
             tempororay_collection = localfilter.filterCollection(tempororay_collection, params.localfilter);
@@ -349,6 +356,16 @@ export class Resource implements IResource {
                 let localfilter = new LocalFilter();
                 tempororay_collection = localfilter.filterCollection(tempororay_collection, params.localfilter);
 
+                // trying to define smartfiltertype
+                if (this.smartfiltertype === 'undefined') {
+                    let page = tempororay_collection.page;
+                    if (page.number === 1 && page.total_resources <= page.resources_per_page) {
+                        this.smartfiltertype = 'localfilter';
+                    } else if (page.number === 1 && page.total_resources > page.resources_per_page) {
+                        this.smartfiltertype = 'remotefilter';
+                    }
+                }
+
                 this.runFc(fc_success, success);
             },
             error => {
@@ -370,7 +387,8 @@ export class Resource implements IResource {
         .delete(path.get())
         .then(
             success => {
-                delete this.tempororay_collection[id];
+                // we don't use more temporary_collection
+                // delete this.tempororay_collection[id];
                 this.getService().memorycache.removeResource(id);
                 this.runFc(fc_success, success);
             },
diff --git a/src/library/services/memorycache.ts b/src/library/services/memorycache.ts
@@ -61,7 +61,6 @@ export class MemoryCache implements ICache {
         angular.forEach(this.collections, (value, url) => {
             delete value[id];
         });
-        this.resources[id].id = ''; // just for confirm deletion on view
         this.resources[id].attributes = {}; // just for confirm deletion on view
         this.resources[id].relationships = {}; // just for confirm deletion on view
         delete this.resources[id];
diff --git a/src/library/services/resource-functions.ts b/src/library/services/resource-functions.ts
@@ -1,4 +1,4 @@
-import { IResource } from '../interfaces';
+import { IResource, ICollection } from '../interfaces';
 
 export class ResourceFunctions {
     static resourceToResource(source: IResource, destination: IResource): void {
@@ -23,9 +23,12 @@ export class ResourceFunctions {
         // add source relationships to destination
         for (let type_alias in source.relationships) {
             if ('id' in source.relationships[type_alias].data) {
-                destination.addRelationship(source.relationships[type_alias].data, source.relationships[type_alias].data.type);
+                destination.addRelationship(
+                        (<IResource>source.relationships[type_alias].data),
+                        (<IResource>source.relationships[type_alias].data).type
+                    );
             } else {
-                destination.addRelationships(source.relationships[type_alias].data, type_alias);
+                destination.addRelationships(<ICollection>source.relationships[type_alias].data, type_alias);
             }
         }
     }
diff --git a/src/library/services/resource-relationships-converter.ts b/src/library/services/resource-relationships-converter.ts
@@ -1,21 +1,21 @@
-import * as Jsonapi from '../interfaces';
+import { IResource, IRelationships, ISchema } from '../interfaces';
 import { Base } from '../services/base';
 // import { Converter } from './resource-converter';
 
 export class ResourceRelationshipsConverter {
     private getService: Function;
     private relationships_from: Array<any>;
-    private relationships_dest: Array<any>;
+    private relationships_dest: IRelationships;
     private included_resources: Object;
-    private schema: Jsonapi.ISchema;
+    private schema: ISchema;
 
     /** @ngInject */
     public constructor(
         getService: Function,
         relationships_from: Array<any>,
-        relationships_dest: Array<any>,
+        relationships_dest: IRelationships,
         included_resources: Object,
-        schema: Jsonapi.ISchema
+        schema: ISchema
     ) {
         this.getService = getService;
         this.relationships_from = relationships_from;
@@ -102,22 +102,22 @@ export class ResourceRelationshipsConverter {
         // new related resource <> cached related resource <> ? delete!
         if (
             this.relationships_dest[relation_key].data == null ||
-            relation_from_value.data.id !== this.relationships_dest[relation_key].data.id
+            relation_from_value.data.id !== (<IResource>this.relationships_dest[relation_key].data).id
         ) {
             this.relationships_dest[relation_key].data = {};
         }
 
         // trae datos o cambió resource? actualizamos!
         if (
             'attributes' in relation_from_value.data ||
-            this.relationships_dest[relation_key].data.id !== relation_from_value.data.id
+            (<IResource>this.relationships_dest[relation_key].data).id !== relation_from_value.data.id
         ) {
             let tmp = this.__buildRelationship(relation_from_value.data, this.included_resources);
             this.relationships_dest[relation_key].data = tmp;
         }
     }
 
-    private __buildRelationship(relation: IDataResource, included_array): Jsonapi.IResource | IDataResource {
+    private __buildRelationship(relation: IDataResource, included_array): IResource | IDataResource {
         if (relation.type in included_array &&
             relation.id in included_array[relation.type]
         ) {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export interface IAttributes {`
	`2`	`+ [value: string]: boolean \| string \| number;`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import { IPage } from './page.d';`
`4`	`4`	`interface IParamsCollection extends IParams {`
`5`	`5`	`localfilter?: any;`
`6`	`6`	`remotefilter?: any;`
	`7`	`+ smartfilter?: any;`
`7`	`8`	`page?: IPage;`
`8`	`9`	`storage_ttl?: number;`
`9`	`10`	`}`