Merge pull request #16 from reyesoft/feature/mergin_relationships

pablorsk · web-flow · commit c7ee27ce235a · 2017-04-27T21:02:52.000-03:00
Feature/mergin relationships
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "ts-angular-jsonapi",
-  "version": "0.4.15",
+  "version": "0.5.12",
   "description": "JSONAPI library developed for AngularJS in Typescript",
   "repository": {
     "type": "git",
@@ -51,7 +51,6 @@
     "gulp-typescript": "^2.13.6",
     "gulp-util": "^3.0.7",
     "html-webpack-plugin": "^2.9.0",
-    "isparta-loader": "^2.0.0",
     "jasmine": "^2.4.1",
     "json-loader": "^0.5.4",
     "karma": "^0.13.14",
diff --git a/src/demo/authors/authors.service.ts b/src/demo/authors/authors.service.ts
@@ -2,7 +2,7 @@
 
 import * as Jsonapi from '../../library/index';
 
-export class AuthorsService extends Jsonapi.Resource {
+export class AuthorsService extends Jsonapi.Service {
     type = 'authors';
     public schema: Jsonapi.ISchema = {
         attributes: {
diff --git a/src/demo/books/books.component.ts b/src/demo/books/books.component.ts
@@ -32,6 +32,30 @@ class BooksController {
             },
             success => {
                 console.log('success books controller', success, this.books);
+
+                // TEST 1
+                // this test merge data with cache (this not include author or photos)
+                console.log('BooksRequest#1 received (author data from server)',
+                    (<Jsonapi.IResource>this.books[2].relationships.author.data).attributes
+                );
+
+                console.log('BooksRequest#2 requested');
+                let books2 = this.BooksService.all(
+                    success => {
+                        console.log('BooksRequest#2 received (author data from cache)',
+                            (<Jsonapi.IResource>books2[1].relationships.author.data)
+                        );
+                    }
+                );
+
+                // TEST 2
+                console.log('BookRequest#3 requested');
+                let book1 = this.BooksService.get(1,
+                    success => {
+                        console.log('BookRequest#3 received (author data from cache)',
+                            (<Jsonapi.IResource>book1.relationships.author.data).attributes
+                        );
+                    });
             },
             error => {
                 console.log('error books controller', error);
diff --git a/src/demo/books/books.service.ts b/src/demo/books/books.service.ts
@@ -2,7 +2,7 @@
 
 import * as Jsonapi from '../../library/index';
 
-export class BooksService extends Jsonapi.Resource {
+export class BooksService extends Jsonapi.Service {
     type = 'books';
     public schema: Jsonapi.ISchema = {
         attributes: {
diff --git a/src/demo/photos/photos.service.ts b/src/demo/photos/photos.service.ts
@@ -2,7 +2,7 @@
 
 import * as Jsonapi from '../../library/index';
 
-export class PhotosService extends Jsonapi.Resource {
+export class PhotosService extends Jsonapi.Service {
     type = 'photos';
     public schema: Jsonapi.ISchema = {
         attributes: {
diff --git a/src/library/core.ts b/src/library/core.ts
@@ -1,40 +1,37 @@
-/// <reference path="./index.d.ts" />
-
 import './services/core-services.service';
-import { ICore, IResource } from './interfaces';
+import { ICore, IService } from './interfaces';
 
 export class Core implements ICore {
-    public rootPath: string = 'http://url/';
-    public resources: Object = {};
+    private resourceServices: Object = {};
 
     public loadingsCounter: number = 0;
     public loadingsStart = () => {};
     public loadingsDone = () => {};
     public loadingsError = () => {};
     public loadingsOffline = () => {};
 
-    public static Me: ICore = null;
-    public static Services: any = null;
+    public static me: ICore;
+    public static injectedServices: any;
 
     /** @ngInject */
     public constructor(
         protected rsJsonapiConfig,
         protected JsonapiCoreServices
     ) {
-        Core.Me = this;
-        Core.Services = JsonapiCoreServices;
+        Core.me = this;
+        Core.injectedServices = JsonapiCoreServices;
     }
 
-    public _register(clase: IResource): boolean {
-        if (clase.type in this.resources) {
+    public _register(clase: IService): boolean {
+        if (clase.type in this.resourceServices) {
             return false;
         }
-        this.resources[clase.type] = clase;
+        this.resourceServices[clase.type] = clase;
         return true;
     }
 
-    public getResource(type: string): IResource {
-        return this.resources[type];
+    public getResourceService(type: string): IService {
+        return this.resourceServices[type];
     }
 
     public refreshLoadings(factor: number): void {
@@ -46,4 +43,5 @@ export class Core implements ICore {
         }
     }
 }
+
 angular.module('Jsonapi.services').service('JsonapiCore', Core);
diff --git a/src/library/index.ts b/src/library/index.ts
@@ -1,5 +1,3 @@
-/// <reference path="./index.d.ts" />
-
 import * as angular from 'angular';
 import 'angular-localforage';
 
@@ -26,12 +24,15 @@ angular.module('rsJsonapi', [
 ]);
 
 import { Core } from './core';
+import { Service } from './service';
 import { Resource } from './resource';
 
 // just for bootstrap this library on demo.
 // On dist version, all is exported inside a Jsonapi module
 export { Core };
 export { Resource };
+export { Service };
+
 export * from './interfaces';
 import { IResource } from './interfaces';
 import { IService } from './interfaces';
diff --git a/src/library/interfaces/attributes.d.ts b/src/library/interfaces/attributes.d.ts
@@ -1,3 +1,9 @@
 export interface IAttributes {
-    [value: string]: boolean | string | number;
+    // problem with lines like
+    /*
+    this._receipt_number = order.attributes.receipt_number;
+    this.transaction.attributes._due_date_with_format = new Date(this.transaction.attributes.due_date);
+    */
+    // [value: string]: boolean | string | number;
+    [value: string]: any;
 }
diff --git a/src/library/interfaces/cache.d.ts b/src/library/interfaces/cache.d.ts
@@ -1,4 +1,4 @@
-import { ICollection } from '../interfaces';
+import { ICollection, IResource } from '../interfaces';
 
 export interface ICache {
     // collections: Object;
@@ -8,7 +8,10 @@ export interface ICache {
     isCollectionLive(url: string, ttl: number): boolean;
     getCollection(url: string): ICollection;
     setCollection(url: string, collection: ICollection): void;
-    clearAllCollections(): void;
+    clearAllCollections(): boolean;
+    isResourceLive(id: string, ttl: number): boolean;
+    setResource(resource: IResource): void;
+    getCollection(url: string): ICollection;
 
     removeResource(id: string): void;
 }
diff --git a/src/library/interfaces/collection.d.ts b/src/library/interfaces/collection.d.ts
@@ -1,5 +1,6 @@
 import { IResource } from './resource';
 import { IPage } from './page';
+import { IDataResource } from './data-resource';
 
 export interface ICollection extends Array<IResource> {
     $length: number;
diff --git a/src/library/interfaces/core.d.ts b/src/library/interfaces/core.d.ts
@@ -1,18 +1,19 @@
-import { IResource } from './resource';
+import { IService } from './index';
 
 export interface ICore {
-    rootPath?: string;
-    resources?: Object;
+    // jsonapiServices: Object;
 
-    Me?: IResource;
-    Services?: any;
+    loadingsCounter: number;
+    loadingsStart: Function;
+    loadingsDone: Function;
+    loadingsError: Function;
+    loadingsOffline: Function;
 
-    loadingsStart?: Function;
-    loadingsDone?: Function;
-    loadingsError?: Function;
-    loadingsOffline?: Function;
+    _register (clase: IService): boolean;
+    getResourceService (type: string): IService;
+    refreshLoadings (factor: number): void;
 
-    _register? (clase: any): boolean;
-    getResource? (type: string): IResource;
-    refreshLoadings?(factor: number): void;
+    // static
+    me?: IService;
+    injectedServices?: any;
 }
diff --git a/src/library/interfaces/data-collection.d.ts b/src/library/interfaces/data-collection.d.ts
@@ -1,3 +1,6 @@
+import { IDataResource } from './data-resource';
+import { IDocument } from '../interfaces/document';
+
 interface IDataCollection extends IDocument {
     data: IDataResource[];
 }
diff --git a/src/library/interfaces/data-object.d.ts b/src/library/interfaces/data-object.d.ts
@@ -1,3 +1,6 @@
+import { IDocument } from './document';
+import { IDataResource } from './data-resource';
+
 interface IDataObject extends IDocument {
     data: IDataResource;
 }
diff --git a/src/library/interfaces/data-resource.d.ts b/src/library/interfaces/data-resource.d.ts
@@ -1,8 +1,10 @@
-    interface IDataResource {
-        type: string;
-        id: string;
-        attributes?: any;
-        relationships?: any;
-        links?: ILinks;
-        meta?: any;
-    }
+import { IAttributes } from '../interfaces';
+
+interface IDataResource {
+    type: string;
+    id: string;
+    attributes?: IAttributes;
+    relationships?: any;
+    links?: ILinks;
+    meta?: any;
+}
diff --git a/src/library/interfaces/document.d.ts b/src/library/interfaces/document.d.ts
@@ -1,11 +1,13 @@
+import { IDataResource } from '../interfaces/data-resource';
+
 // http://org/format/#document-top-level
-    interface IDocument {
-        // data in child interface IJsonapiCollection
-        // error in child interface IJsonapiErrors
-        jsonapi?: string;
-        links?: ILinks;
-        included?: Array<IDataResource>;
-        meta?: Object;
+interface IDocument {
+    // data in child interface IJsonapiCollection
+    // error in child interface IJsonapiErrors
+    jsonapi?: string;
+    links?: ILinks;
+    included?: Array<IDataResource>;
+    meta?: Object;
 
-        promise?: any;
-    }
+    promise?: any;
+}
diff --git a/src/library/interfaces/errors.d.ts b/src/library/interfaces/errors.d.ts
@@ -1,13 +1,15 @@
-    interface IErrors extends IDocument {
-        errors: [
-            {
-                code?: string,
-                source?: {
-                    attributes?: string,
-                    pointer: string
-                },
-                title?: string,
-                detail?: string
-            }
-        ];
-    }
+import { IDocument } from './document';
+
+interface IErrors extends IDocument {
+    errors: [
+        {
+            code?: string,
+            source?: {
+                attributes?: string,
+                pointer: string
+            },
+            title?: string,
+            detail?: string
+        }
+    ];
+}
diff --git a/src/library/interfaces/exec-params.d.ts b/src/library/interfaces/exec-params.d.ts
@@ -0,0 +1,9 @@
+import { IParamsCollection } from '../interfaces';
+
+export interface IExecParams {
+    id: string;
+    params?: IParamsCollection | Function;
+    fc_success?: Function;
+    fc_error?: Function;
+    exec_type: string;
+}
diff --git a/src/library/interfaces/index.d.ts b/src/library/interfaces/index.d.ts
@@ -9,3 +9,6 @@ export * from './relationships.d'
 export * from './cache.d'
 export * from './params-collection.d'
 export * from './params-resource.d'
+export * from './resources-by-id.d'
+export * from './resources-by-type.d'
+export * from './exec-params.d'
diff --git a/src/library/interfaces/relationship.d.ts b/src/library/interfaces/relationship.d.ts
@@ -1,4 +1,5 @@
 import { ICollection, IResource } from '../interfaces';
+import { IDataResource } from './data-resource';
 
 interface IRelationship {
     // IDataResource added for this reason:
diff --git a/src/library/interfaces/resource.d.ts b/src/library/interfaces/resource.d.ts
@@ -1,15 +1,14 @@
-import { IRelationships, ICollection, ICache, IParamsResource } from './index';
+import { IRelationships, ICollection, IParamsResource, IService } from './index';
+import { IDataResource } from './data-resource';
+import { IDataObject } from './data-object';
 
 export interface IResource extends IDataResource {
     is_new: boolean;
     is_loading: boolean;
     is_saving: boolean;
     lastupdate?: number;
 
-    memorycache: ICache;
-
     type: string;   // dont work extend?
-
     relationships: IRelationships;    // redefined from IDataResource
 
     reset? (): void;
@@ -19,4 +18,5 @@ export interface IResource extends IDataResource {
     addRelationshipsArray <T extends IResource>(resources: Array<T>, type_alias?: string): void;
     save? (params?: IParamsResource, fc_success?: Function, fc_error?: Function): any;
     toObject? (params?: IParamsResource): IDataObject;
+    getService(): IService;
 }
diff --git a/src/library/interfaces/resources-by-id.d.ts b/src/library/interfaces/resources-by-id.d.ts
@@ -0,0 +1,5 @@
+import { IResource } from './resource';
+
+export interface IResourcesById {
+    [resource_id: string]: IResource;
+}
diff --git a/src/library/interfaces/resources-by-type.d.ts b/src/library/interfaces/resources-by-type.d.ts
@@ -0,0 +1,5 @@
+import { IResourcesById } from './resources-by-id';
+
+export interface IResourcesByType {
+    [type: string]: IResourcesById;
+}
diff --git a/src/library/interfaces/service.d.ts b/src/library/interfaces/service.d.ts
@@ -1,13 +1,16 @@
-import { ISchema, IResource, ICollection, IParamsCollection, IParamsResource } from './index';
+import { ISchema, IResource, ICollection, IParamsCollection, ICache, IParamsResource } from './index';
 
 export interface IService {
-    smartfilter?: string;
-    schema?: ISchema;
-    new? (): IResource;
-    register? (): boolean;
+    type: string;
+    schema: ISchema;
+    getPrePath(): string;
+    getPath(): string;
+    register(): boolean;
     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
+    getService<T extends IService> ():T;
     clearMemoryCache? (): boolean;
+    new?<T extends IResource>(): T;
+    memorycache: ICache;
 }
diff --git a/src/library/parent-resource-service.ts b/src/library/parent-resource-service.ts
diff --git a/src/library/resource.ts b/src/library/resource.ts
diff --git a/src/library/service.ts b/src/library/service.ts
diff --git a/src/library/services/base.ts b/src/library/services/base.ts
diff --git a/src/library/services/http.service.ts b/src/library/services/http.service.ts
diff --git a/src/library/services/memorycache.ts b/src/library/services/memorycache.ts
diff --git a/src/library/services/path-builder.ts b/src/library/services/path-builder.ts
diff --git a/src/library/services/resource-converter.ts b/src/library/services/resource-converter.ts
diff --git a/src/library/services/resource-functions.ts b/src/library/services/resource-functions.ts
diff --git a/src/library/services/resource-relationships-converter.ts b/src/library/services/resource-relationships-converter.ts
