feat: make Api, Field and Resource more flexible

feat: add Flow type
feat: add .editorconfig

Author: Gregcop1

.babelrc

@@ -1,6 +1,7 @@
 {
   "plugins": [
-    "transform-runtime"
+    "transform-runtime",
+    "transform-flow-strip-types"
   ],
   "presets": [
     "es2015",

.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.flowconfig

@@ -0,0 +1,7 @@
+[ignore]
+
+[include]
+
+[libs]
+
+[options]

package.json

@@ -19,11 +19,13 @@
     "babel-core": "^6.24.0",
     "babel-eslint": "^7.2.0",
     "babel-jest": "^19.0.0",
+    "babel-plugin-transform-flow-strip-types": "^6.22.0",
     "babel-plugin-transform-runtime": "^6.23.0",
     "babel-preset-es2015": "^6.24.0",
     "babel-preset-stage-0": "^6.22.0",
     "eslint": "^3.18.0",
     "eslint-plugin-import": "^2.2.0",
+    "flow-bin": "^0.42.0",
     "jest": "^19.0.2",
     "jest-fetch-mock": "^1.0.8"
   },
@@ -33,7 +35,7 @@
   },
   "scripts": {
     "test": "jest",
-    "lint": "eslint src",
+    "lint": "eslint src && flow check",
     "build": "babel src -d lib --ignore '*.test.js'"
   },
   "jest": {

src/Api.js

@@ -1,12 +1,32 @@
+// @flow
+
+import Resource from './Resource';
+
+type ApiOptions = {
+  title?: string,
+  resource?: Map<string, Resource>,
+}
+
 /**
- * @property {string} entrypoint                - The URL of the API's entrypoint
- * @property {string} title                     - The title
- * @property {Map.<string, Resource>} resources - Resources of this API
+ * @property {string} entrypoint  - The URL of the API's entrypoint
  */
 export default class Api {
-  constructor(entrypoint, title = '', resources = new Map()) {
+  entrypoint: string;
+
+  /**
+   * @param {string}      entrypoint
+   * @param {?ApiOptions} options
+   */
+  constructor(entrypoint: string, options: ApiOptions = {}) {
     this.entrypoint = entrypoint;
-    this.title = title;
-    this.resources = resources;
+
+    Object.keys(options).forEach((key) => {
+      Object.defineProperty(this, key, {
+        readable: true,
+        writable: true,
+        enumerable: true,
+        value: options[key],
+      });
+    });
   }
 }

src/Field.js

@@ -1,18 +1,33 @@
+// @flow
+
+type FieldOptions = {
+  id?: string,
+  range?: string,
+  reference?: string,
+  required?: boolean,
+  description?: string,
+}
+
 /**
- * @property {string} name         - The name of this field
- * @property {?string} id          - The IRI identifying this field (e.g. http://schema.org/email)
- * @property {?string} range       - The range of this field (e.g. http://www.w3.org/2001/XMLSchema#string or http://schema.org/Book)
- * @property {?string} reference   - The name of the referenced resource
- * @property {boolean} required    - Is this field mandatory?
- * @property {string} description  - A description of this field
+ * @property {string} name    - The name of this field
  */
 export default class Field {
-  constructor(name, id = null, range = null, reference = null, required = false, description = '') {
+  name: string;
+
+  /**
+   * @param {string}        name
+   * @param {?FieldOptions}  options
+   */
+  constructor(name: string, options: FieldOptions = {}) {
     this.name = name;
-    this.id = id;
-    this.range = range;
-    this.reference = reference;
-    this.required = required;
-    this.description = description;
+
+    Object.keys(options).forEach((key) => {
+      Object.defineProperty(this, key, {
+        readable: true,
+        writable: true,
+        enumerable: true,
+        value: options[key],
+      });
+    });
   }
 }

src/Resource.js

@@ -1,16 +1,37 @@
+// @flow
+
+import Field from './Field';
+
+type ResourceOptions = {
+  id?: string,
+  readableFields?: Field[],
+  writableFields?: Field[],
+}
+
 /**
  * @property {string} name            - The name of the resource
  * @property {string} url             - The base URL for this resource
- * @property {?string} id             - The id of the resource (e.g. http://schema.org/Book)
- * @property {Field[]} readableFields - The list of readable fields
- * @property {Field[]} writableFields - The list of writable fields
  */
 export default class Resource {
-  constructor(name, url, id = null, readableFields = [], writableFields = []) {
+  name: string;
+  url: string;
+
+  /**
+   * @param {string}          name
+   * @param {string}          url
+   * @param {ResourceOptions} options
+   */
+  constructor(name: string, url: string, options: ResourceOptions = {}) {
     this.name = name;
     this.url = url;
-    this.id = id;
-    this.readableFields = readableFields;
-    this.writableFields = writableFields;
+
+    Object.keys(options).forEach((key) => {
+      Object.defineProperty(this, key, {
+        readable: true,
+        writable: true,
+        enumerable: true,
+        value: options[key],
+      });
+    });
   }
 }

src/hydra/parseHydraDocumentation.js

@@ -118,11 +118,13 @@ export default function parseHydraDocumentation(entrypointUrl) {
 
           const field = new Field(
             supportedProperty['http://www.w3.org/ns/hydra/core#property'][0]['http://www.w3.org/2000/01/rdf-schema#label'][0]['@value'],
-            supportedProperty['http://www.w3.org/ns/hydra/core#property'][0]['@id'],
-            range,
-            'http://www.w3.org/ns/hydra/core#Link' === supportedProperty['http://www.w3.org/ns/hydra/core#property'][0]['@type'][0] ? range : null, // Will be updated in a subsequent pass
-            supportedProperty['http://www.w3.org/ns/hydra/core#required'] ? supportedProperty['http://www.w3.org/ns/hydra/core#required'][0]['@value'] : false,
-            supportedProperty['http://www.w3.org/ns/hydra/core#description'] ? supportedProperty['http://www.w3.org/ns/hydra/core#description'][0]['@value'] : ''
+            {
+              id: supportedProperty['http://www.w3.org/ns/hydra/core#property'][0]['@id'],
+              range,
+              reference: 'http://www.w3.org/ns/hydra/core#Link' === supportedProperty['http://www.w3.org/ns/hydra/core#property'][0]['@type'][0] ? range : null, // Will be updated in a subsequent pass
+              required: supportedProperty['http://www.w3.org/ns/hydra/core#required'] ? supportedProperty['http://www.w3.org/ns/hydra/core#required'][0]['@value'] : false,
+              description: supportedProperty['http://www.w3.org/ns/hydra/core#description'] ? supportedProperty['http://www.w3.org/ns/hydra/core#description'][0]['@value'] : ''
+            },
           );
 
           fields.push(field);
@@ -139,9 +141,11 @@ export default function parseHydraDocumentation(entrypointUrl) {
         resources.push(new Resource(
           guessNameFromUrl(entrypoint[0][property['@id']][0]['@id'], entrypointUrl),
           entrypoint[0][property['@id']][0]['@id'],
-          supportedClass['@id'],
-          readableFields,
-          writableFields
+          {
+            id: supportedClass['@id'],
+            readableFields,
+            writableFields
+          }
         ));
 
         break;
@@ -155,6 +159,6 @@ export default function parseHydraDocumentation(entrypointUrl) {
       }
     }
 
-    return new Api(entrypointUrl, title, resources);
+    return new Api(entrypointUrl, {title, resources});
   });
 }