feat: Added Socket Support

ftgibran · ftgibran · commit d17d21bea116 · 2019-01-24T01:01:01.000-02:00
diff --git a/packages/@simpli/cli-scaffold/generator/index.js b/packages/@simpli/cli-scaffold/generator/index.js
@@ -55,7 +55,7 @@ module.exports = (api, options) => {
       'normalize-scss': '^7.0.1',
       'register-service-worker': '^1.5.2',
       'simple-line-icons': '^2.4.1',
-      'simpli-web-sdk': '^1.2.0',
+      'simpli-web-sdk': '^1.3.0',
       'vue': '^2.5.21',
       'vue-router': '^3.0.1',
       'vue-chartjs': '^3.4.0',
diff --git a/packages/@simpli/cli-scaffold/generator/injected/src/views/list/ListTemplateView.vue b/packages/@simpli/cli-scaffold/generator/injected/src/views/list/ListTemplateView.vue
@@ -82,6 +82,7 @@
   import {Component, Prop, Watch, Mixins, Vue} from 'vue-property-decorator'
   <%-model.injectIntoDependence().build()%>
   import PagedResp from '@/model/collection/PagedResp'
+  import All from '@/model/collection/All'
   import {$, MixinQueryRouter, pushByName} from '@/simpli'
 
   @Component({
@@ -113,7 +114,7 @@
 
 <%_ } _%>
     async downloadCsv() {
-      const csv = new PagedResp(<%-model.name%>, {}, null, null)
+      const csv = new All(<%-model.name%>)
 
       const fetch = async () => await csv.search()
       await $.await.run(fetch, 'downloadCsv')
diff --git a/packages/@simpli/cli-scaffold/generator/template/_env.development b/packages/@simpli/cli-scaffold/generator/template/_env.development
@@ -1,2 +1,4 @@
 <%_ var config = rootOptions.scaffoldSetup _%>
+<%_ var appNameKebabCase = rootOptions.scaffoldSetup.kebabCase(rootOptions.scaffoldSetup.appName) _%>
 VUE_APP_API_URL=<%-config.apiUrlDev%>
+VUE_APP_SOCKET_URL=ws://localhost:8080/<%-appNameKebabCase%>/ws
diff --git a/packages/@simpli/cli-scaffold/generator/template/_env.production b/packages/@simpli/cli-scaffold/generator/template/_env.production
@@ -1,2 +1,4 @@
 <%_ var config = rootOptions.scaffoldSetup _%>
+<%_ var appNameKebabCase = rootOptions.scaffoldSetup.kebabCase(rootOptions.scaffoldSetup.appName) _%>
 VUE_APP_API_URL=<%-config.apiUrlProd%>
+VUE_APP_SOCKET_URL=ws://localhost:8080/<%-appNameKebabCase%>/ws
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/bootstrap/app.ts b/packages/@simpli/cli-scaffold/generator/template/src/bootstrap/app.ts
@@ -7,16 +7,17 @@
 
 import Simpli from 'simpli-web-sdk'
 
-import {apiURL, httpInterceptor} from '@/config/http.config'
-import {defaultCurrency as currency, defaultLang as lang, locale} from '@/config/locale.config'
+import {apiURL, socketURL, httpInterceptor} from '@/config/http.config'
+import {defaultCurrency, defaultLang, locale} from '@/config/locale.config'
 import {components} from '@/config/component.config'
 import {filters} from '@/config/filter.config'
 import {router} from '@/config/router.config'
 
 Simpli.apiURL = apiURL
+Simpli.socketURL = socketURL
 Simpli.httpInterceptor = httpInterceptor
-Simpli.lang = lang
-Simpli.currency = currency
+Simpli.lang = defaultLang
+Simpli.currency = defaultCurrency
 Simpli.components = components
 Simpli.filters = filters
 Simpli.locale = locale
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/components/Sidebar.vue b/packages/@simpli/cli-scaffold/generator/template/src/components/Sidebar.vue
@@ -72,7 +72,7 @@
   export default class Sidebar extends Vue {
     @Getter('version') version!: string
 <%_ if (rootOptions.scaffoldSetup.useAuth) { _%>
-    // @Getter('auth/user') user!: User
+    // @Getter('auth/user') user?: User
     @Action('auth/signOut') signOut!: Function
 <%_ } _%>
 
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/config/http.config.ts b/packages/@simpli/cli-scaffold/generator/template/src/config/http.config.ts
@@ -21,6 +21,12 @@ import {$, getVersion, getLanguage, HttpStatus, error} from '@/simpli'
  */
 export const apiURL = process.env.VUE_APP_API_URL || 'http://localhost/api'
 
+/**
+ * Base URL of the Socket server
+ * @type {string}
+ */
+export const socketURL = process.env.VUE_APP_SOCKET_URL || 'ws://localhost/ws'
+
 /**
  * Standard behavior during a request
  * @param {VueResource.HttpOptions} request
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/helpers/vuex/auth.helper.ts b/packages/@simpli/cli-scaffold/generator/template/src/helpers/vuex/auth.helper.ts
@@ -6,9 +6,11 @@ import {store} from '@/store'
 <%_ for (var i in auth.resolvedDependencies) { var dependence = auth.resolvedDependencies[i] _%>
 <%-dependence.build()%>
 <%_ } _%>
+import {SocketConnection} from '@/simpli'
 
 export const isLogged = () => store.getters['auth/isLogged'] as boolean
 <%-rootOptions.scaffoldSetup.auth.buildExport()-%>
+export const getNotification = () => store.getters['auth/notification'] as SocketConnection<String>
 
 export const auth = () => store.dispatch('auth/auth')
 export const signIn = (request: <%-loginHolderModel.name%>) => store.dispatch('auth/signIn', request)
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/locale/en-US/lang.ts b/packages/@simpli/cli-scaffold/generator/template/src/locale/en-US/lang.ts
@@ -212,8 +212,16 @@ export default {
   },
 
   classes: {
-<%_ var resources = rootOptions.scaffoldSetup.resourceModels _%>
-<%_ for (var i in resources) { var resource = resources[i] _%>
+<%_ var requestModels = rootOptions.scaffoldSetup.requestModels _%>
+<%_ var responseModels = rootOptions.scaffoldSetup.responseModels _%>
+<%_ var resourceModels = rootOptions.scaffoldSetup.resourceModels _%>
+<%_ for (var i in requestModels) { var resource = requestModels[i] _%>
+<%- resource.buildLocale() -%>
+<%_ } _%>
+<%_ for (var i in responseModels) { var resource = responseModels[i] _%>
+<%- resource.buildLocale() -%>
+<%_ } _%>
+<%_ for (var i in resourceModels) { var resource = resourceModels[i] _%>
 <%- resource.buildLocale() -%>
 <%_ } _%>
   },
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/locale/pt-BR/lang.ts b/packages/@simpli/cli-scaffold/generator/template/src/locale/pt-BR/lang.ts
@@ -212,8 +212,16 @@ export default {
   },
 
   classes: {
-<%_ var resources = rootOptions.scaffoldSetup.resourceModels _%>
-<%_ for (var i in resources) { var resource = resources[i] _%>
+<%_ var requestModels = rootOptions.scaffoldSetup.requestModels _%>
+<%_ var responseModels = rootOptions.scaffoldSetup.responseModels _%>
+<%_ var resourceModels = rootOptions.scaffoldSetup.resourceModels _%>
+<%_ for (var i in requestModels) { var resource = requestModels[i] _%>
+<%- resource.buildLocale() -%>
+<%_ } _%>
+<%_ for (var i in responseModels) { var resource = responseModels[i] _%>
+<%- resource.buildLocale() -%>
+<%_ } _%>
+<%_ for (var i in resourceModels) { var resource = resourceModels[i] _%>
 <%- resource.buildLocale() -%>
 <%_ } _%>
   },
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/model/collection/All.ts b/packages/@simpli/cli-scaffold/generator/template/src/model/collection/All.ts
@@ -3,12 +3,12 @@
  * Used to get all items from a paged list response
  * @author Simpli CLI generator
  */
-import {Resource} from '@/simpli'
+import {Resource, ClassType} from '@/simpli'
 import PagedResp from '@/model/collection/PagedResp'
 
 export default class All<T extends Resource> extends PagedResp<T> {
   // Get all items from a paged list response
-  constructor(public type: typeof Resource) {
+  constructor(public type: ClassType<T>) {
     super(type, {}, null, null)
   }
 }
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/model/collection/PagedResp.ts b/packages/@simpli/cli-scaffold/generator/template/src/model/collection/PagedResp.ts
@@ -3,16 +3,19 @@
  * Alias of PageCollection class adapted to server response
  * @author Simpli CLI generator
  */
-import {PageCollection, Resource, ResponseFill} from '@/simpli'
+import {PageCollection, Resource, ResponseFill, ClassType} from '@/simpli'
 import {Type} from 'class-transformer'
 
-export default class PagedResp<T extends Resource> extends PageCollection<T> {
+export default class PagedResp<R extends Resource> extends PageCollection<R> {
   @ResponseFill('list')
-  @Type((options) => (options!.newObject as PagedResp<T>).type)
-  items: T[] = []
+  @Type((options) => (options!.newObject as PagedResp<R>).type)
+  items: R[] = []
+
+  constructor(type: ClassType<R>, filter = {}, perPage: number | null = 20, currentPage: number | null = 0) {
+    super(type, filter, perPage, currentPage)
+  }
 
   set recordsTotal(val: number) {
     this.total = val
   }
 }
-
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/store/modules/auth.ts b/packages/@simpli/cli-scaffold/generator/template/src/store/modules/auth.ts
@@ -1,7 +1,7 @@
 <%_ if (rootOptions.scaffoldSetup.useAuth) { _%>
 import {ActionTree, GetterTree, Module, MutationTree} from 'vuex'
 import {AuthState, RootState} from '@/types/store'
-import {$, push, success, error, successAndPush, infoAndPush} from '@/simpli'
+import {$, SocketConnection, push, success, error, successAndPush, infoAndPush} from '@/simpli'
 <%_ var auth = rootOptions.scaffoldSetup.auth _%>
 <%_ var signInApi = auth.api.signIn _%>
 <%_ var authApi = auth.api.auth _%>
@@ -21,13 +21,11 @@ import {$, push, success, error, successAndPush, infoAndPush} from '@/simpli'
 <%_ if (changePasswordRequestModel) { _%>
 <%-changePasswordRequestModel.injectIntoDependence().build()%>
 <%_ } _%>
-<%_ for (var i in auth.resolvedDependencies) { var dependence = auth.resolvedDependencies[i] _%>
-<%-dependence.build()%>
-<%_ } _%>
 
 // initial state
 const state: AuthState = {
 <%-rootOptions.scaffoldSetup.auth.buildState()-%>
+  notification: null,
   cachePath: null,
   eventListener: {
     signIn: [],
@@ -40,6 +38,7 @@ const state: AuthState = {
 const getters: GetterTree<AuthState, RootState> = {
   isLogged: ({token}) => !!token,
 <%-rootOptions.scaffoldSetup.auth.buildGetter()-%>
+  notification: ({notification}) => notification,
   cachePath: ({cachePath}) => cachePath,
 }
 
@@ -143,8 +142,11 @@ const actions: ActionTree<AuthState, RootState> = {
 
     success('system.success.recoverPassword')
 
+<%_ var userAttr = loginRespModel.objectAtrrs[0] _%>
     const authRequest = new <%-loginHolderModel.name%>()
-    authRequest.<%-auth.accountAttrName%> = getters.user.<%-auth.accountAttrName%>
+<%_ if (userAttr) { _%>
+    authRequest.<%-auth.accountAttrName%> = getters.<%-userAttr.name%>.<%-auth.accountAttrName%>
+<%_ } _%>
     authRequest.<%-auth.passwordAttrName%> = request.newPassword
 
     dispatch('signIn', authRequest)
@@ -197,12 +199,30 @@ const mutations: MutationTree<AuthState> = {
   // Populate user and plan mutation
   POPULATE(state, response: <%-loginRespModel.name%>) {
 <%-rootOptions.scaffoldSetup.auth.buildPopulate()-%>
+    state.notification = new SocketConnection(String, `/admin/notification/${response.token}`)
+
+    state.notification.onOpen(() => {
+      console.info(`Socket connection with client id=${id} established`)
+    })
+
+    state.notification.onClose(() => {
+      console.info(`Socket connection with client id=${id} lost`)
+    })
+
+    state.notification.onError(() => {
+      console.error(`Error with socket connection(client id=${id})`)
+    })
   },
 
   // Forget mutation
   FORGET(state) {
 <%-rootOptions.scaffoldSetup.auth.buildForget()-%>
 
+    if (state.notification) {
+      state.notification.disconnect()
+      state.notification = null
+    }
+
     localStorage.removeItem('token')
   },
 
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/types/store.d.ts b/packages/@simpli/cli-scaffold/generator/template/src/types/store.d.ts
@@ -1,10 +1,11 @@
-import {ID, Currency, Lang} from '@/simpli'
+import {SocketConnection, Currency, Lang} from '@/simpli'
 <%_ if (rootOptions.scaffoldSetup.useAuth) { _%>
 <%_ var auth = rootOptions.scaffoldSetup.auth _%>
 <%_ for (var i in auth.resolvedDependencies) { var dependence = auth.resolvedDependencies[i] _%>
 <%-dependence.build()%>
 <%_ } _%>
 <%_ } _%>
+
 /**
  * Root
  */
@@ -20,6 +21,7 @@ export interface RootState {
  */
 export interface AuthState {
 <%-rootOptions.scaffoldSetup.auth.buildType()-%>
+  notification: SocketConnection<String> | null,
   cachePath: string | null,
   eventListener: AuthEventListener,
 }
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/types/vue/index.d.ts b/packages/@simpli/cli-scaffold/generator/template/src/types/vue/index.d.ts
@@ -15,6 +15,7 @@ declare module 'vue/types/vue' {
   interface Vue {
     // simpli-web-sdk
     $apiURL: string
+    $socketURL: string
     $bus: Vue
     $snotify: SnotifyService | any
     $await: AwaitController
diff --git a/packages/@simpli/cli-scaffold/generator/template/src/views/layouts/DefaultPanelLayout.vue b/packages/@simpli/cli-scaffold/generator/template/src/views/layouts/DefaultPanelLayout.vue
@@ -16,22 +16,28 @@
 <script lang="ts">
 import {Component, Prop, Vue} from 'vue-property-decorator'
 <%_ if (rootOptions.scaffoldSetup.useAuth) { _%>
-import {Action} from 'vuex-class'
+import {Getter, Action} from 'vuex-class'
 <%_ } _%>
 import Sidebar from '@/components/Sidebar.vue'
+import {$, SocketConnection} from '@/simpli'
 
 @Component({
   components: { Sidebar },
 })
 export default class DefaultPanelLayout extends Vue {
 <%_ if (rootOptions.scaffoldSetup.useAuth) { _%>
+  @Getter('auth/notification') notification?: SocketConnection<String>
   @Action('auth/auth') auth!: Function
 
   authorized = false
 
   async mounted() {
     await this.auth()
     this.authorized = true
+
+    if (this.notification) {
+      this.notification.onData((resp) => $.snotify.info(resp))
+    }
   }
 <%_ } _%>
 }
diff --git a/packages/@simpli/cli-server/generator/index.js b/packages/@simpli/cli-server/generator/index.js
@@ -67,6 +67,7 @@ module.exports = (api, options) => {
     api.renderFrom('./injected', 'src/main/wrapper/ModelWrapper.kt', `../java/${dir}/wrapper/ModelWrapper.kt`)
     api.renderFrom('./injected', 'src/main/wrapper/ProcessWrapper.kt', `../java/${dir}/wrapper/ProcessWrapper.kt`)
     api.renderFrom('./injected', 'src/main/wrapper/RouterWrapper.kt', `../java/${dir}/wrapper/RouterWrapper.kt`)
+    api.renderFrom('./injected', 'src/main/wrapper/SocketWrapper.kt', `../java/${dir}/wrapper/SocketWrapper.kt`)
 
     // main/module/auth
     api.renderFrom('./injected', 'src/main/module/auth/AuthDao.kt', `../../java/${dir}/${moduleName}/auth/AuthDao.kt`)
@@ -89,6 +90,9 @@ module.exports = (api, options) => {
     // main/module/response
     api.renderFrom('./injected', 'src/main/module/response/AuthResponse.kt', `../../java/${dir}/${moduleName}/response/AuthResponse.kt`)
 
+    // main/module/socket
+    api.renderFrom('./injected', 'src/main/module/socket/NotificationSocket.kt', `../../java/${dir}/${moduleName}/socket/NotificationSocket.kt`)
+
     // test
     api.renderFrom('./injected', 'src/test/AppTest.kt', `./java/${dir}/AppTest.kt`)
 
diff --git a/packages/@simpli/cli-server/generator/injected/src/main/dao/TemplateDao.kt b/packages/@simpli/cli-server/generator/injected/src/main/dao/TemplateDao.kt
@@ -40,7 +40,7 @@ class <%-table.modelName%>Dao(con: Connection, lang: LanguageHolder) : Dao(con,
             """, { rs -> <%-table.modelName%>(rs) }, <%-table.primariesByComma(true)%>)
     }
 
-    fun list(): MutableList<<%-table.modelName%>> {
+    fun list(): List<<%-table.modelName%>> {
         // TODO: review generated method
         return selectList("""
             SELECT *
@@ -56,7 +56,7 @@ class <%-table.modelName%>Dao(con: Connection, lang: LanguageHolder) : Dao(con,
         page: Int?,
         limit: Int?,
         orderRequest: String?,
-        asc: Boolean?): MutableList<<%-table.modelName%>> {
+        asc: Boolean?): List<<%-table.modelName%>> {
         // TODO: review generated method
         val orderRequestAndColumn = HashMap<String, String>()
 
@@ -218,7 +218,7 @@ class <%-table.modelName%>Dao(con: Connection, lang: LanguageHolder) : Dao(con,
             <%-columnRef.name%>).affectedRows
     }
 
-    fun list<%-columnRef.foreign.referencedTableModelName%>Of<%-columnCross.foreign.referencedTableModelName%>(<%-columnCross.name%>: <%-columnCross.kotlinType%>): MutableList<<%-columnRef.foreign.referencedTableModelName%>> {
+    fun list<%-columnRef.foreign.referencedTableModelName%>Of<%-columnCross.foreign.referencedTableModelName%>(<%-columnCross.name%>: <%-columnCross.kotlinType%>): List<<%-columnRef.foreign.referencedTableModelName%>> {
         // TODO: review generated method
         return selectList("""
             SELECT *
diff --git a/packages/@simpli/cli-server/generator/injected/src/main/model/Template.kt b/packages/@simpli/cli-server/generator/injected/src/main/model/Template.kt
@@ -43,7 +43,7 @@ class <%-table.modelName%> : ModelWrapper<<%-table.modelName%>Dao> {
 <%_ if (!relation.isManyToMany) { _%>
     var <%-relation.name%>: <%-relation.referencedTableModelName%>? = null
 <%_ } else { _%>
-    var <%-relation.name%>: MutableList<<%-relation.referencedTableModelName%>>? = null
+    var <%-relation.name%>: List<<%-relation.referencedTableModelName%>>? = null
 <%_ } _%>
 <%_ } _%>
 <%_ if (table.validRelations.length) { _%>
diff --git a/packages/@simpli/cli-server/generator/injected/src/main/module/response/AuthResponse.kt b/packages/@simpli/cli-server/generator/injected/src/main/module/response/AuthResponse.kt
@@ -5,6 +5,7 @@
 package <%-packageAddress%>.<%-moduleName%>.response
 
 import <%-packageAddress%>.model.<%-userTable.modelName%>
+import <%-packageAddress%>.<%-moduleName%>.socket.NotificationSocket
 import io.swagger.annotations.ApiModel
 import io.swagger.annotations.ApiModelProperty
 
@@ -16,4 +17,9 @@ import io.swagger.annotations.ApiModelProperty
 class AuthResponse(var token: String, var <%-userTable.instanceName%>: <%-userTable.modelName%>) {
     val id @ApiModelProperty(hidden = true) get() = <%-userTable.instanceName%>.id
     val <%-accountColumn.name%> @ApiModelProperty(hidden = true) get() = <%-userTable.instanceName%>.<%-accountColumn.name%>
+
+    @ApiModelProperty(hidden = true)
+    fun sendNotification(content: String) {
+        NotificationSocket.socket.send(content, id)
+    }
 }
diff --git a/packages/@simpli/cli-server/generator/injected/src/main/module/socket/NotificationSocket.kt b/packages/@simpli/cli-server/generator/injected/src/main/module/socket/NotificationSocket.kt
diff --git a/packages/@simpli/cli-server/generator/injected/src/main/wrapper/SocketWrapper.kt b/packages/@simpli/cli-server/generator/injected/src/main/wrapper/SocketWrapper.kt
diff --git a/packages/@simpli/cli-server/generator/template/src/main/webapp/WEB-INF/web.xml b/packages/@simpli/cli-server/generator/template/src/main/webapp/WEB-INF/web.xml
diff --git a/packages/@simpli/cli/lib/scaffold/setup/Auth.js b/packages/@simpli/cli/lib/scaffold/setup/Auth.js
diff --git a/packages/@simpli/cli/lib/scaffold/setup/Model.js b/packages/@simpli/cli/lib/scaffold/setup/Model.js
