Add typescript interface generator

Author: abluchet

package.json

@@ -30,7 +30,7 @@
     "tmp": "^0.0.31"
   },
   "dependencies": {
-    "api-doc-parser": "^0.1.1",
+    "api-doc-parser": "^0.2",
     "babel-runtime": "^6.23.0",
     "chalk": "^2.1.0",
     "commander": "^2.9.0",

src/generators.js

@@ -1,4 +1,5 @@
 import ReactCrudGenerator from './generators/ReactCrudGenerator';
+import TypescriptInterfaceGenerator from './generators/TypescriptInterfaceGenerator';
 
 function wrap (cl) {
   return (prefix) => new cl(prefix)
@@ -7,7 +8,9 @@ function wrap (cl) {
 function generators (generator = 'react') {
   switch (generator) {
     case 'react':
-      return wrap(ReactCrudGenerator)
+      return wrap(ReactCrudGenerator);
+    case 'typescript':
+      return wrap(TypescriptInterfaceGenerator);
   }
 }
 

src/generators/TypescriptInterfaceGenerator.js

@@ -0,0 +1,90 @@
+import mkdirp from 'mkdirp';
+import handlebars from 'handlebars';
+import fs from 'fs';
+
+export default class TypescriptInterfaceGenerator {
+  templates = {};
+
+  constructor() {
+    const templatePath = `${__dirname}/../../templates/typescript`;
+    this.template = handlebars.compile(fs.readFileSync(`${templatePath}/interface.ts`).toString())
+  }
+
+  help() {
+  }
+
+  generate(api, resource, dir) {
+    const fields = this.parseFields(resource)
+    const name = resource.title
+    let dest = `${dir}/interfaces`
+
+    try {
+      mkdirp.sync(dest);
+    } catch(e) {
+      // nothing
+    }
+
+    dest += `/${name.toLowerCase()}.ts`;
+
+    fs.writeFileSync(dest, this.template({fields, name}));
+  }
+
+  getType(field) {
+    if (field.reference) {
+      return field.reference.title;
+    }
+
+    switch (field.range) {
+      case 'http://www.w3.org/2001/XMLSchema#integer':
+      case 'http://www.w3.org/2001/XMLSchema#decimal':
+        return 'number';
+      case 'http://www.w3.org/2001/XMLSchema#boolean':
+        return 'bool';
+      case 'http://www.w3.org/2001/XMLSchema#date':
+      case 'http://www.w3.org/2001/XMLSchema#dateTime':
+      case 'http://www.w3.org/2001/XMLSchema#time':
+        return 'Date';
+      case 'http://www.w3.org/2001/XMLSchema#string':
+        return 'string';
+    }
+
+    return 'any';
+  }
+
+  getDescription(field) {
+    return field.description ? field.description.replace(/"/g, "'") : ''
+  }
+
+  parseFields(resource) {
+    const fields = {}
+
+    for (let field of resource.writableFields) {
+      fields[field.name] = {
+        notrequired: !field.required,
+        name: field.name,
+        type: this.getType(field),
+        description: this.getDescription(field),
+        readonly: false
+      }
+    }
+
+    for (let field of resource.readableFields) {
+      if (fields[field.name] !== undefined) {
+        continue;
+      }
+
+      fields[field.name] = {
+        notrequired: !field.required,
+        name: field.name,
+        type: this.getType(field),
+        description: this.getDescription(field),
+        readonly: true
+      }
+    }
+
+    return Object.keys(fields).map((e) => fields[e]);
+  }
+
+  // createFile(template, dest, context) {
+  // }
+}

src/generators/TypescriptInterfaceGenerator.test.js

@@ -0,0 +1,55 @@
+import Api from 'api-doc-parser/lib/Api';
+import Resource from 'api-doc-parser/lib/Resource';
+import Field from 'api-doc-parser/lib/Field';
+import fs from 'fs';
+import tmp from 'tmp';
+import TypescriptInterfaceGenerator from './TypescriptInterfaceGenerator';
+
+
+test('Generate a typescript interface', () => {
+  const generator = new TypescriptInterfaceGenerator('hydra:');
+  const tmpobj = tmp.dirSync({unsafeCleanup: true});
+
+  const resource = new Resource('abc', 'http://example.com/foos', {
+    id: 'foo',
+    title: 'Foo',
+    readableFields: [new Field('bar', {
+    id: 'http://schema.org/url',
+    range: 'http://www.w3.org/2001/XMLSchema#string',
+    reference: null,
+    required: true,
+    description: 'An URL'
+  })],
+    writableFields: [new Field('foo', {
+    id: 'http://schema.org/url',
+    range: 'http://www.w3.org/2001/XMLSchema#datetime',
+    reference: null,
+    required: true,
+    description: 'An URL'
+  }), new Field('foobar', {
+    id: 'http://schema.org/url',
+    range: undefined,
+    reference: new Resource('foobar', 'http://example.com/FooBar', {title: 'FooBar'}),
+    required: false
+  })]
+  });
+  const api = new Api('http://example.com', {
+    title: 'My API',
+    resources: [resource]
+  });
+  generator.generate(api, resource, tmpobj.name);
+
+  expect(fs.existsSync(tmpobj.name+'/interfaces/foo.ts'), true);
+
+const res = `interface Foo {
+  '@id'?: string;
+  id: string;
+  foo: any;
+  foobar?: FooBar;
+  readonly bar: string;
+}
+`
+  expect(fs.readFileSync(tmpobj.name+'/interfaces/foo.ts').toString()).toEqual(res)
+
+  tmpobj.removeCallback();
+});

src/index.js

@@ -23,17 +23,23 @@ const generator = generators(program.generator)(program.hydraPrefix)
 const resourceToGenerate = program.resource ? program.resource.toLowerCase() : null;
 
 parseHydraDocumentation(program.args[0]).then(api => {
-    for (let resource of api.resources) {
-      const nameLc = resource.name.toLowerCase();
-      const titleLc = resource.title.toLowerCase();
-
-      if (null === resourceToGenerate || nameLc === resourceToGenerate || titleLc === resourceToGenerate) {
-        generator.generate(api, resource, program.args[1]);
-        generator.help(resource)
-      }
+  for (let resource of api.api.resources) {
+    const nameLc = resource.name.toLowerCase();
+    const titleLc = resource.title.toLowerCase();
+
+    if (null === resourceToGenerate || nameLc === resourceToGenerate || titleLc === resourceToGenerate) {
+      generator.generate(api, resource, program.args[1]);
+      generator.help(resource)
     }
+  }
+
+  if ('entrypoint' in generator) {
     generator.entrypoint(program.args[0], program.args[1]);
+  }
+
+  if ('utils' in generator) {
     generator.utils(program.args[1]);
+  }
 }).catch((e) => {
   console.log(e);
 });

templates/typescript/interface.ts

@@ -0,0 +1,7 @@
+interface {{ name }} {
+  '@id'?: string;
+  id: string;
+{{#each fields}}
+ {{#if readonly}} readonly{{/if}} {{{ name }}}{{#if notrequired}}?{{/if}}: {{{ type }}};
+{{/each}}
+}

yarn.lock

@@ -84,9 +84,9 @@ anymatch@^1.3.0:
     arrify "^1.0.0"
     micromatch "^2.1.5"
 
-api-doc-parser@^0.1.1:
-  version "0.1.5"
-  resolved "https://registry.yarnpkg.com/api-doc-parser/-/api-doc-parser-0.1.5.tgz#719b9af21ab599995549bca63a8f10514cf26aaa"
+api-doc-parser@^0.2:
+  version "0.2.1"
+  resolved "https://registry.yarnpkg.com/api-doc-parser/-/api-doc-parser-0.2.1.tgz#1fa6fd25ecf8d3a005be7de3095f0ecb9c15b4cc"
   dependencies:
     babel-runtime "^6.23.0"
     jsonld "^0.4.11"