+ ds-http-adapter definition complete with tests

2026-09-09 11:13:57 +08:00 · 2015-02-26 10:35:21 +01:00
parent cb67739c13
commit 8385575c31
2 changed files with 201 additions and 1 deletions
@@ -0,0 +1,167 @@
+/// <reference path="js-data-http.d.ts" />
+
+var adapter = new DSHttpAdapter();
+var store = new JSData.DS();
+store.registerAdapter('http', adapter, { default: true });
+
+var ADocument:JSData_.DSResourceDefinition<any> = store.defineResource<any>('document');
+
+ADocument.inject({ id: 5, author: 'John' });
+
+// bypass the data store
+adapter.update(ADocument, 5, { author: 'Johnny' }).then(function (document:any) {
+    document; // { id: 5, author: 'Johnny' }
+
+    // The updated document has NOT been injected into the data store because we bypassed the data store
+    ADocument.get(document.id); // { id: 5, author: 'John' }
+});
+
+// Normally you would just go through the data store
+ADocument.update(5, { author: 'Johnny' }).then(function (document:any) {
+    document; // { id: 5, author: 'Johnny' }
+
+    // the updated document has been injected into the data store
+    ADocument.get(document.id); // { id: 5, author: 'Johnny' }
+});
+
+ADocument.inject({ id: 5, author: 'John' });
+ADocument.inject({ id: 6, author: 'John' });
+
+// bypass the data store
+adapter.updateAll(ADocument, { author: 'Johnny' }, { author: 'John' }).then(function (documents) {
+    documents[0]; // { id: 5, author: 'Johnny' }
+
+    // The updated documents have NOT been injected into the data store because we bypassed the data store
+    ADocument.filter({ author: 'John' }); // [{...}, {...}]
+    ADocument.filter({ author: 'Johnny' }); // []
+});
+
+// Normally you would just go through the data store
+ADocument.updateAll({ author: 'Johnny' }, { author: 'John' }).then(function (documents) {
+    documents[0]; // { id: 5, author: 'Johnny' }
+
+    // the updated documents have been injected into the data store
+    ADocument.filter({ author: 'John' }); // []
+    ADocument.filter({ author: 'Johnny' }); // [{...}, {...}]
+});
+
+adapter.PUT('/user/1', { name: 'Johnny' }).then(function (data) {
+    data.data; // { id: 1, name: 'Johnny', ... }
+    data.headers; // {...}
+    data.status; // 200
+    data.config; //{...}
+});
+
+adapter.POST('/user/1', { name: 'John' }).then(function (data) {
+    data.data; // { id: 1, name: 'John', ... }
+    data.headers; // {...}
+    data.status; // 200
+    data.config; //{...}
+});
+
+adapter.HTTP({ url: '/user/1', method: 'put', data: { name: 'Johnny' }}).then(function (data) {
+    data.data; // { id: 1, name: 'Johnny', ... }
+    data.headers; // {...}
+    data.status; // 200
+    data.config; //{...}
+});
+
+adapter.GET('/user/1').then(function (data) {
+    data.data; // { id: 1, ... }
+    data.headers; // {...}
+    data.status; // 200
+    data.config; //{...}
+});
+
+var User:JSData_.DSResourceDefinition<any> = store.defineResource('user');
+
+var params:any = {
+    age: {
+        '>': 30
+    }
+};
+
+// bypass the data store
+adapter.findAll(User, params).then(function (users) {
+    // users[0].age; 55 // etc., etc.
+
+    // the users have NOT been injected into the data store because we bypassed the data store
+    User.filter(params); // []
+});
+
+// normally you would go through the data store
+User.findAll(params).then(function (users) {
+    // users[0].age; 55 // etc., etc.
+
+    // the users have been injected into the data store
+    User.filter(params); // [{...}, {...}, ...]
+});
+
+// bypass the data store
+adapter.find(ADocument, 5).then(function (document:any) {
+    document; // { id: 5, author: 'John Anderson' }
+
+    // the document has NOT been injected into the data store because we bypassed the data store
+    ADocument.get(document.id); // undefined
+});
+
+// Normally you would just go through the data store
+ADocument.find(5).then(function (document:any) {
+    document; // { id: 5, author: 'John Anderson' }
+
+    // the document has been injected into the data store
+    ADocument.get(document.id); // { id: 5, author: 'John Anderson' }
+});
+
+var params:any = {
+    author: 'John'
+};
+
+// bypass the data store
+adapter.destroyAll(ADocument, params).then(function () {
+    // the documents have NOT been ejected from the data store because we bypassed the data store
+    ADocument.filter(params); // [{...}, {...}, ...]
+});
+
+// normally you would go through the data store
+ADocument.destroyAll(params).then(function () {
+    // the documents have been ejected from the data store
+    ADocument.filter(params); // []
+});
+
+ADocument.inject({ id: 5, author: 'John' });
+
+// bypass the data store
+adapter.destroy(ADocument, 5).then(function () {
+    // the document is still in the data store because we bypassed the data store
+    //ADocument.get(document.id); // { id: 5, author: 'John' }
+});
+
+// Normally you would just go through the data store
+ADocument.destroy(5).then(function () {
+    // the document has been ejected from the data store
+    //ADocument.get(document.id); // undefined
+});
+
+adapter.DEL('/user/1').then(function (data) {
+    data.data; // 1
+    data.headers; // {...}
+    data.status; // 204
+    data.config; //{...}
+});
+
+// bypass the data store
+adapter.create(ADocument, { author: 'John' }).then(function (document:any) {
+    document; // { id: 5, author: 'John' }
+
+    // The new document has NOT been injected into the data store because we bypassed the data store
+    ADocument.get(document.id); // undefined
+});
+
+// Normally you would just go through the data store
+ADocument.create({ author: 'John' }).then(function (document:any) {
+    document; // { id: 5, author: 'John' }
+
+    // the new document has been injected into the data store
+    ADocument.get(document.id); // { id: 5, author: 'John' }
+});
@@ -6,8 +6,41 @@
 /// <reference path="../js-data/js-data.d.ts" />

 declare module JSData_ {
+    
+    interface DSHttpAdapterOptions {
+        serialize?: (resourceName:string, data:any)=>any;
+        deserialize?: (resourceName:string, data:any)=>any;
+        queryTransform?: (resourceName:string, params:DSFilterParams)=>any;
+        httpConfig?: any;
+        forceTrailingSlash?: boolean;
+        log?: any;
+        // TODO wait for union types to be supported
+        // log: (message?: any, ...optionalParams: any[])=> void;
+        // log: boolean;
+        error?: any;
+        // TODO wait for union types to be supported
+        // error: (message?: any, ...optionalParams: any[])=> void;
+        // error: boolean;
+    }
+
+    interface DSHttpAdapterPromiseResolveType {
+        data: any;
+        headers: any;
+        status: number;
+        config: any;
+    }

    interface DSHttpAdapter extends IDSAdapter {

+        new(options?:DSHttpAdapterOptions):DSHttpAdapter;
+
+        // DSHttpAdapter uses axios so options are axios config objects.
+        HTTP(options?:Object):Promise<DSHttpAdapterPromiseResolveType>;
+        DEL(url:string, data?:Object, options?:Object):Promise<DSHttpAdapterPromiseResolveType>;
+        GET(url:string, data?:Object, options?:Object):Promise<DSHttpAdapterPromiseResolveType>;
+        POST(url:string, data?:Object, options?:Object):Promise<DSHttpAdapterPromiseResolveType>;
+        PUT(url:string, data?:Object, options?:Object):Promise<DSHttpAdapterPromiseResolveType>;
    }
-}
+}
+
+declare var DSHttpAdapter:JSData_.DSHttpAdapter;