mythix 1.0.6 → 1.1.2

package/.eslintrc.js

@@ -28,14 +28,14 @@ module.exports = {
     'comma-dangle':                           [ 'error', 'always-multiline' ],
     'comma-spacing':                          [ 'error', { before: false, after: true } ],
     'comma-style':                            [ 'error', 'last' ],
-    'curly':                                  [ 'error', 'multi-or-nest' ],
+    'curly':                                  [ 'error', 'multi-or-nest', 'consistent' ],
     'default-case-last':                      'error',
     'default-param-last':                     'error',
     'eqeqeq':                                 [ 'error', 'smart' ],
     'func-call-spacing':                      [ 'error', 'never' ],
     'guard-for-in':                           'error',
     'implicit-arrow-linebreak':               [ 'error', 'beside' ],
-    'indent':                                 [ 'error', 2 ],
+    'indent':                                 [ 'error', 2, { 'SwitchCase': 1 } ],
     'jsx-quotes':                             [ 'error', 'prefer-double' ],
     'key-spacing':                            [ 'error', { beforeColon: false, afterColon: true, mode: 'minimum', 'align': 'value' } ],
     'keyword-spacing':                        [ 'error', { before: true, after: true } ],
@@ -57,14 +57,14 @@ module.exports = {
     'no-implied-eval':                        'error',
     'no-labels':                              'error',
     'no-lone-blocks':                         'warn',
-    'no-loop-func':                           'warn',
-    'no-magic-numbers':                       [ 'warn', { ignoreArrayIndexes: true, ignoreDefaultValues: true, ignore: [ -1, 0, 1, 2, 16, 32, 64, 128, 256, 1024, 2048, 200, 301, 302, 400, 401, 404, 500 ] } ],
+    'no-loop-func':                           0,
+    'no-magic-numbers':                       [ 'warn', { ignoreArrayIndexes: true, ignoreDefaultValues: true, ignore: [ -1, 0, 1, 2, 16, 32, 64, 128, 256, 1024, 2048, 200, 301, 302, 400, 401, 403, 404, 500 ] } ],
     'no-nested-ternary':                      'error',
     'no-param-reassign':                      'error',
     'no-promise-executor-return':             'error',
     'no-return-assign':                       'error',
     'no-sequences':                           'error',
-    'no-shadow':                              'warn',
+    'no-shadow':                              0,
     'no-throw-literal':                       'warn',
     'no-trailing-spaces':                     'error',
     'no-unmodified-loop-condition':           'warn',

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "mythix",
-  "version": "1.0.6",
+  "version": "1.1.2",
   "description": "Mythix is a NodeJS web-app framework",
   "main": "src/index.js",
   "scripts": {
-    "test": "node ./node_modules/.bin/jasmine"
+    "test": "node ./node_modules/.bin/jasmine",
+    "test-watch": "watch 'clear ; node --trace-warnings ./node_modules/.bin/jasmine' . --wait=3 --interval=1"
   },
   "repository": {
     "type": "git",
@@ -18,22 +19,26 @@
   },
   "homepage": "https://github.com/th317erd/mythix#readme",
   "devDependencies": {
+    "colors": "^1.4.0",
+    "diff": "^5.1.0",
     "jasmine": "^4.0.2"
   },
   "dependencies": {
+    "@spothero/eslint-plugin-spothero": "github:spothero/eslint-plugin-spothero",
     "chokidar": "^3.5.3",
     "deep-diff": "^1.0.2",
+    "eslint": "^8.13.0",
     "express": "^4.17.3",
     "express-busboy": "^8.0.2",
+    "form-data": "^4.0.0",
     "inflection": "^1.13.2",
     "lodash": "^4.17.21",
-    "nife": "^1.6.0",
+    "nife": "^1.8.1",
     "object-hash": "^3.0.0",
-    "sequelize": "^6.18.0",
-    "sqlite3": "^4.2.0",
     "pg": "^8.7.3",
     "pg-hstore": "^2.3.4",
-    "@spothero/eslint-plugin-spothero": "github:spothero/eslint-plugin-spothero",
-    "eslint": "^8.13.0"
+    "prompts": "^2.4.2",
+    "sequelize": "^6.18.0",
+    "sqlite3": "^4.2.0"
   }
 }

package/spec/{controller-utils-spec.js → controllers/controller-utils-spec.js}

@@ -2,7 +2,7 @@
 
 /* global describe, it, expect */
 
-const ControllerUtils = require('../src/controllers/controller-utils');
+const ControllerUtils = require('../../src/controllers/controller-utils');
 
 describe('controller-utils', function() {
   describe('buildMethodMatcher', function() {

package/spec/controllers/generate-client-api-interface-spec.js

@@ -0,0 +1,156 @@
+'use strict';
+
+/* global describe, it, beforeAll, expect, __dirname */
+
+const { generateClientAPIInterface }  = require('../../src/controllers/generate-client-api-interface');
+const { newTestApplication }          = require('../support/application');
+const { _matchesSnapshot }            = require('../support/snapshots');
+
+const matchesSnapshot = _matchesSnapshot.bind(this, __dirname);
+
+function getRoutes() {
+  return {
+    'api': {
+      'v1': {
+        'auth': {
+          'authenticate': [
+            {
+              'methods':    [ 'GET' ],
+              'controller': 'AuthController.authenticate',
+            },
+            {
+              'name':       'login',
+              'methods':    [ 'POST' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'AuthController.authenticate',
+            },
+          ],
+          'sendMagicLink': [
+            {
+              'name':       'sendMagicLink',
+              'methods':    [ 'POST' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'AuthController.sendMagicLink',
+            },
+          ],
+          'registerUser': [
+            {
+              'name':       'registerUser',
+              'methods':    [ 'POST' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'AuthController.registerUser',
+            },
+          ],
+        },
+        'user': {
+          '/<userID:string>': [
+            {
+              'name':       'getUser',
+              'methods':    [ 'GET' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'UserController.show',
+            },
+            {
+              'name':       'updateUser',
+              'methods':    [ 'POST', 'PATCH' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'UserController.update',
+            },
+          ],
+          '/search':    {
+            'name':       'searchUsers',
+            'methods':    [ 'POST' ],
+            'accept':     [ 'application/json' ],
+            'controller': 'UserController.list',
+          },
+          '/': [
+            {
+              'name':       'getUsers',
+              'methods':    [ 'GET' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'UserController.list',
+            },
+          ],
+        },
+        'organization': {
+          '/<organizationID:string>': [
+            {
+              'name':       'getOrganization',
+              'methods':    [ 'GET' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'OrganizationController.show',
+            },
+            {
+              'name':       'updateOrganization',
+              'methods':    [ 'POST', 'PATCH' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'OrganizationController.update',
+            },
+          ],
+          '/<organizationID:string>/inviteUser': [
+            {
+              'name':       'inviteUserToOrganization',
+              'methods':    [ 'POST' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'OrganizationController.inviteUser',
+            },
+          ],
+          '/search':    {
+            'name':       'searchOrganizations',
+            'methods':    [ 'POST' ],
+            'accept':     [ 'application/json' ],
+            'controller': 'OrganizationController.list',
+          },
+          '/': [
+            {
+              'name':       'getOrganizations',
+              'methods':    [ 'GET' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'OrganizationController.list',
+            },
+            {
+              'name':       'createOrganization',
+              'methods':    [ 'PUT' ],
+              'accept':     [ 'application/json' ],
+              'controller': 'OrganizationController.create',
+            },
+          ],
+        },
+      },
+    },
+  };
+}
+
+describe('generateClientAPIInterface', () => {
+  let app;
+
+  beforeAll(async () => {
+    app = await newTestApplication();
+    app.getRoutes = getRoutes.bind(app);
+  });
+
+  it('should be able to generate an interface using route definitions', () => {
+    let result = generateClientAPIInterface(app);
+    expect(matchesSnapshot('generateClientAPIInterface01', result)).toBe(true);
+  });
+
+  it('should be able to generate an interface for node', () => {
+    let result = generateClientAPIInterface(app, { environment: 'node' });
+    expect(matchesSnapshot('generateClientAPIInterface02', result)).toBe(true);
+  });
+
+  it('should be able to generate an interface for the browser', () => {
+    let result = generateClientAPIInterface(app, { environment: 'browser' });
+    expect(matchesSnapshot('generateClientAPIInterface03', result)).toBe(true);
+  });
+
+  it('should be able to export a global', () => {
+    let result = generateClientAPIInterface(app, { globalName: 'API' });
+    expect(matchesSnapshot('generateClientAPIInterface04', result)).toBe(true);
+  });
+
+  it('should be able to specify a domain', () => {
+    let result = generateClientAPIInterface(app, { domain: 'http://localhost:8080' });
+    expect(matchesSnapshot('generateClientAPIInterface05', result)).toBe(true);
+  });
+});