restructured; async serialization; travis

Author: Robin Buschmann

.gitignore

@@ -16,9 +16,9 @@ certificates/*
 # documentation
 documentation
 
-# js files
-#**/*.js
-#**/*.js.map
+**/*.js
+**/*.js.map
+**/*.d.ts
 
 # Elastic Beanstalk Files
 .elasticbeanstalk/*

.npmignore

@@ -0,0 +1,8 @@
+node_modules
+npm-debug.log
+.travis.yml
+.gitignore
+tsconfig.json
+test
+.DS_Store
+.idea

.travis.yml

@@ -0,0 +1,13 @@
+language: node_js
+
+node_js:
+  - "6.1"
+
+install:
+  - npm install
+
+before_script:
+
+script:
+  - tsc
+  - mocha test/spec/**/*.js

README.md

@@ -1 +1,113 @@
-# xml-typescript
+[![Build Status](https://travis-ci.org/RobinBuschmann/ts-di.png?branch=master)](https://travis-ci.org/RobinBuschmann/xml-typescript)
+
+# xml-decorators
+
+Decorators for xml serialization. Uses [js2xmlparser](https://www.npmjs.com/package/js2xmlparser)
+under the hood.
+
+## Use decorators
+
+```typescript
+import {XMLElement, XMLAttribute, XMLChild, xml} from 'xml-decorators';
+
+const HOBBY_NS = 'h';
+
+class Hobby {
+
+  @XMLAttribute({namespace: HOBBY_NS})
+  private name: string;
+
+  @XMLAttribute({namespace: HOBBY_NS})
+  private description: string;
+}
+
+const PERSON_ROOT = 'person';
+const PERSON_NS = 'ps';
+
+@XMLElement({root: PERSON_ROOT}) // optional
+class Person {
+
+  @XMLAttribute({namespace: PERSON_NS})
+  private firstname: string;
+
+  private lastname: string;
+
+  @XMLAttribute({namespace: PERSON_NS})
+  get fullname(): string {
+
+    return this.firstname + ' ' + this.lastname;
+  }
+
+  @XMLAttribute({namespace: PERSON_NS})
+  private age: number;
+
+  @XMLChild({
+    namespace: PERSON_NS,
+    name: 'hobby'
+  })
+  private hobbies: Hobby[];
+
+  @XMLChild({
+    namespace: PERSON_NS,
+    stripPluralS: true
+  })
+  private friends: Person[];
+
+  @XMLChild({
+    name: 'pet',
+    implicitStructure: 'pets.$'
+  })
+  private pets: string[];
+  
+ }
+```
+
+## Serialization
+```typescript
+const hobbies = [
+  new Hobby('reading', 'loves to read books, magazines and web articles'),
+  new Hobby('listening to Music', 'loves to listen to rock music'),
+  new Hobby('travelling', 'loves to travel around the world'),
+];
+const pets = ['dog', 'cat'];
+const bob = new Person('Bob', 'Mad', 29, hobbies, pets);
+
+const bobXml = xml.serialize(bob);
+```
+
+Or if you want to override the root tag name or did not used the `@XMLElement` annotation.
+```typescript
+const bob2Xml = xml.serialize('great-person', bob);
+```
+
+### Result
+```xml
+<?xml version='1.0'?>
+<person ps:firstname='Bob' ps:fullname='Bob Mad' ps:age='29'>
+    <ps:hobby h:name='reading' h:description='loves to read books, magazines and web articles'/>
+    <ps:hobby h:name='listening to Music' h:description='loves to listen to rock music'/>
+    <ps:hobby h:name='travelling' h:description='loves to travel around the world'/>
+    <pets>
+        <pet>dog</pet>
+        <pet>cat</pet>
+    </pets>
+</person>
+```
+
+### Async
+```typescript
+xml
+  .serializeAsync(bob)
+  .then(bobXml => console.log(bobXml))
+  ;
+```
+
+## Schema
+If you want to retrieve the "js2xmlparser" schema instead:
+```typescript
+xml.getSchema(bob);
+xml.getSchema('root', bob);
+xml.getSchemaAsync(bob) .then(/* */);
+xml.getSchemaAsync('root', bob).then(/* */);
+```
+

annotations/XMLAttribute.d.ts

@@ -0,0 +1,7 @@
+export {XMLElement as xml} from './lib/models/XMLElement';
+
+export {ATTRIBUTE_PROPERTY, ns} from './lib/utils';
+
+export {XMLAttribute} from './lib/annotations/XMLAttribute';
+export {XMLChild} from './lib/annotations/XMLChild';
+export {XMLElement} from './lib/annotations/XMLElement';

annotations/XMLAttribute.js

@@ -15,28 +15,21 @@ export class XMLElement {
   static serialize(root: string, entity: any): string;
   static serialize(...args: any[]): string {
 
-    let entity;
-    let root;
-
-    if (args.length === 1) {
-      entity = args[0];
-    } else {
-      root = args[0];
-      entity = args[1];
-    }
+    const {root, entity} = this.getRootAndEntity(args);
+    const schema = this.getSchema(entity);
 
-    const element = this.getXMLElement(entity.constructor, false);
+    return js2xmlparser.parse(root, schema);
+  }
 
-    if (element && element.root) {
-      root = element.root;
-    }
-    if (!root) {
-      throw new Error('No root defined for entity: ' + JSON.stringify(entity));
-    }
+  static serializeAsync(entity: any): Promise<string>;
+  static serializeAsync(root: string, entity: any): Promise<string>;
+  static serializeAsync(...args: any[]): Promise<string> {
 
-    const schema = this.getSchema(entity);
+    const {root, entity} = this.getRootAndEntity(args);
 
-    return js2xmlparser.parse(root, schema);
+    return this.getSchemaAsync(entity)
+      .then(schema => js2xmlparser.parse(root, schema))
+      ;
   }
 
   static getSchema(entities: any[]): any;
@@ -102,6 +95,30 @@ export class XMLElement {
     return entity;
   }
 
+  private static getRootAndEntity(args: any[]): {root: string, entity: any} {
+
+    let entity;
+    let root;
+
+    if (args.length === 1) {
+      entity = args[0];
+    } else {
+      root = args[0];
+      entity = args[1];
+    }
+
+    const element = this.getXMLElement(entity.constructor, false);
+
+    if (!root && element && element.root) {
+      root = element.root;
+    }
+    if (!root) {
+      throw new Error('No root defined for entity: ' + JSON.stringify(entity));
+    }
+
+    return {root, entity};
+  }
+
   addAttribute(attribute: XMLAttribute): void {
 
     if (!this.attributes) this.attributes = [];