@simitgroup/simpleapp-generator 1.0.31 → 1.0.32

package/src/processors/jsonschemabuilder.ts

@@ -13,32 +13,64 @@ import {
   ChildModels,
   SchemaModel,
   TypeForeignKey,
-  TypeForeignKeyCatalogue
+  TypeForeignKeyCatalogue,
+  DocSetting,ApiSetting,DocStatusSetting,
+  
 } from '../type';
 import { json } from 'stream/consumers';
 const log: Logger<ILogObj> = new Logger();
+
 const X_DOCUMENT_NO='x-document-no'
-const X_DOCUMENT_NAME='x-document-name'
+const X_DOCUMENT_LABEL='x-document-label'
 const X_AUTOCOMPLETE_FIELD='x-autocomplete-field'
+const X_DOCUMENT_NAME='x-document-name'
+const X_DOCUMENT_TYPE='x-document-type'
+const X_COLLECTION_NAME='x-document-collection'
+const X_DOCUMENT_STATUS='x-document-status'
+const X_DOCUMENT_API='x-document-api'
+const X_IGNORE_AUTOCOMPLETE='x-ignore-autocomplete'
 const FOREIGNKEY_PROPERTY='x-foreignkey'
-
 const X_TEL_NO='x-tel'
+const X_ISOLATION_TYPE='x-isolation-type'
+
+let docSetting:DocSetting={} as DocSetting
+
+
+
 let allmodels: ChildModels = {};
 let fullschema={}
-let fieldAutoCompleteCode=''
-let fieldAutoCompleteName=''
+// let fieldAutoCompleteCode=''
+// let fieldAutoCompleteName=''
 let moreAutoComplete:string[]=[]
+
+
+const newDocSetting=(doctype:string,docname:string):DocSetting=>{
+  return {
+    docName:docname,  //done
+    docType:doctype,  //done
+    colDocNo:'',      //done
+    colDocLabel:'',   //done
+    collectionName:docname, //done
+    autocompleteFields:[],
+    docStatusSettings:[],
+    apiSettings:[],
+    requireautocomplete:true,
+    isolationtype:"org"
+
+  }
+}
 export const readJsonSchemaBuilder = async (
   doctype: string,
   docname: string,
   orijsondata:JSONSchema7,
   allforeignkeys:TypeForeignKeyCatalogue
 ) => {
-  
-  fieldAutoCompleteCode=''
-  fieldAutoCompleteName=''
+  docSetting=newDocSetting(doctype,docname)
+  // fieldAutoCompleteCode=''
+  // fieldAutoCompleteName=''
   moreAutoComplete=[]
   allmodels = {};
+  
   const validateddata: JSONSchema7 = { ...orijsondata };
   let schema: SchemaModel | SchemaModel[];
   const  tmpjsondata = await $RefParser.dereference(orijsondata).then((schema)=>{
@@ -56,12 +88,12 @@ export const readJsonSchemaBuilder = async (
   } else if (jsondata.type == 'array') {
     throw(`unsupport array type for ${docname}.${doctype}`)
   }
-  if(fieldAutoCompleteCode=='') {
+  if(docSetting.colDocNo=='' && docSetting.requireautocomplete) {
     log.error(`you shall define 1 field with format:'${X_DOCUMENT_NO}'`)
     throw "missing field format"
   }
-  if(fieldAutoCompleteName=='') {
-    log.error(`you shall define 1 field with format: '${X_DOCUMENT_NAME}'}`)
+  if(docSetting.colDocLabel=='' && docSetting.requireautocomplete) {
+    log.error(`you shall define 1 field with format: '${X_DOCUMENT_LABEL}'}`)
     throw "missing field format"
   }
   
@@ -86,6 +118,50 @@ const processObject =  (doctype: string,
     jsondata.properties['updated'] = {type: 'string',description: 'Control value, dont edit it',};
     jsondata.properties['createdby'] = {type: 'string',description: 'Control value, dont edit it',};
     jsondata.properties['updatedby'] = {type: 'string',description: 'Control value, dont edit it',};
+
+    if(jsondata[X_ISOLATION_TYPE] && ['none','tenant','org','branch'].includes(jsondata[X_ISOLATION_TYPE])  ){      
+      docSetting.isolationtype=jsondata[X_ISOLATION_TYPE]
+    }
+    if(jsondata[X_IGNORE_AUTOCOMPLETE] && jsondata[X_IGNORE_AUTOCOMPLETE]==true){
+      docSetting.requireautocomplete=false
+    }
+    if(jsondata[X_DOCUMENT_API] && Array.isArray(jsondata[X_DOCUMENT_API])){
+      log.warn("x-document-api exists:")
+      log.warn(jsondata[X_DOCUMENT_API])
+      for(let i=0; i<jsondata[X_DOCUMENT_API].length;i++){
+        const tmp:ApiSetting =jsondata[X_DOCUMENT_API][i]
+        if(!tmp.action){
+          const errmsg = "x-document-api defined but undefine property 'action'"
+          log.error(errmsg)
+          
+          throw errmsg
+        }
+        if(!tmp.method){
+          const errmsg = "x-document-api defined but undefine property 'method'"
+          log.error(errmsg)
+          throw errmsg
+        }
+        docSetting.apiSettings.push(tmp)
+      }
+    }
+      if(jsondata[X_DOCUMENT_STATUS] && Array.isArray(jsondata[X_DOCUMENT_STATUS])){
+        for(let i=0; i<jsondata[X_DOCUMENT_STATUS].length;i++){
+          const tmp:DocStatusSetting =jsondata[X_DOCUMENT_STATUS][i]
+          if(tmp.statusCode ===undefined){
+            const errmsg = "x-document-status defined but undefine property 'statusCode'"
+            log.error(errmsg)
+            throw errmsg
+          }
+          if(!tmp.statusName ===undefined){
+            const errmsg = "x-document-status defined but undefine property 'statusName'"
+            log.error(errmsg)
+            throw errmsg            
+          }
+          docSetting.docStatusSettings.push(tmp)
+        }
+     }
+
+
     return genSchema(
       capitalizeFirstLetter(docname),
       'object',
@@ -94,12 +170,8 @@ const processObject =  (doctype: string,
     );
 }
 
-const genSchema = (
-  docname: string,
-  schematype: string,
-  jsondata: JsonSchemaProperties,//JSONSchema7,//|JsonSchemaProperties|JSONSchema7Definition,
-  requiredlist: string[] | undefined,
-): SchemaModel => {
+const genSchema = (docname: string,schematype: string,jsondata: JsonSchemaProperties,
+  requiredlist: string[] | undefined): SchemaModel => {
   const newmodel: SchemaModel = {};
   const props = Object.getOwnPropertyNames(jsondata ??{});
   // console.log('==== jsondata', jsondata);
@@ -116,18 +188,25 @@ const genSchema = (
     const isrequired = requiredlist && requiredlist.includes(key);
     const newName: string = docname + capitalizeFirstLetter(key);
    if(obj.format && obj.format==X_DOCUMENT_NO){
-    fieldAutoCompleteCode=key
+    docSetting.colDocNo=key
     obj.minLength=obj.minLength??1
     jsondata[key]['minLength']=obj.minLength
    }
-   if(obj.format && obj.format==X_DOCUMENT_NAME){
-    fieldAutoCompleteName=key
+   if(obj.format && obj.format==X_DOCUMENT_LABEL){
+    docSetting.colDocLabel=key
     obj.minLength=obj.minLength??1
     jsondata[key]['minLength']=obj.minLength
    }
+   
+   if(obj[X_COLLECTION_NAME]){
+    docSetting.collectionName=key    
+   }
+
+
    if(obj[X_AUTOCOMPLETE_FIELD]){
-    moreAutoComplete.push(key)
+    docSetting.autocompleteFields.push(key)
    }
+   
 
   //  if(obj.format && obj.format==X_TEL_NO){
   //   obj.pattern=obj.pattern ?? '/^\d{7,15}$/gm'
@@ -177,7 +256,18 @@ const genSchema = (
       // console.log(key,'--------newmodel',obj, newmodel[key]);
     }
   }
-  allmodels[docname] = { type: schematype, model: newmodel,codeField: fieldAutoCompleteCode ,nameField: fieldAutoCompleteName,moreAutoComplete:moreAutoComplete };
+  allmodels[docname] = { 
+    type: schematype, 
+    model: newmodel,
+    codeField: docSetting.colDocNo ,
+    nameField: docSetting.colDocLabel,
+    moreAutoComplete:docSetting.autocompleteFields,
+    docStatusSettings:docSetting.docStatusSettings,
+    apiSettings:docSetting.apiSettings,
+    requireautocomplete:docSetting.requireautocomplete,
+    isolationtype:docSetting.isolationtype
+  };
+  // console.warn(docname,docSetting.isolationtype)
   return newmodel;
 };
 
@@ -216,3 +306,4 @@ const getField = (
   }
   return f;
 };
+

package/src/type.ts

@@ -1,6 +1,16 @@
 import { JSONSchema7, JSONSchema7Definition } from 'json-schema';
 export type ChildModels = {
-  [key: string]: { type: string; model: SchemaModel,codeField:string,nameField:string,moreAutoComplete:string[] };
+  [key: string]: { 
+    type: string; 
+    model: SchemaModel,
+    codeField:string,
+    nameField:string,
+    moreAutoComplete:string[],
+    docStatusSettings:DocStatusSetting[],
+    apiSettings:ApiSetting[],
+    requireautocomplete: boolean
+    isolationtype:string
+  };
 };
 export enum Fieldtypes {
   'string' = 'string',
@@ -63,4 +73,37 @@ frontEndCode: string
 backEndCode: string
 controllerCode:string
 apiSchemaCode:string
+docStatusSettings:DocStatusSetting[],
+apiSettings:ApiSetting[],
+requireautocomplete:boolean,
+isolationtype:string
+}
+
+export type DocStatusSetting = {
+  statusCode:string,
+  statusName:string,
+  allowApi:string[],
+  readonly?:boolean,
+  description?:''
+}
+
+export type ApiSetting = {
+  method:string,
+  action:string,  
+  setDocStatus?:'',
+  description?:'',
+  bpmnApi?:'',
+  data?:any
+}
+export type DocSetting = {
+  docName:string,
+  docType:string,
+  colDocNo:string,
+  colDocLabel:string,
+  collectionName:string,
+  autocompleteFields:string[],
+  docStatusSettings:DocStatusSetting[],
+  apiSettings:ApiSetting[],
+  requireautocomplete:boolean
+  isolationtype:string
 }

package/templates/basic/controller.eta

@@ -2,7 +2,7 @@
  * This file was automatically generated by simpleapp generator. Every
  * MODIFICATION OVERRIDE BY GENERATEOR Except content between:
  *    <begin-controller-code><end-controller-code>
- * last change 2023-09-09
+ * last change 2023-09-18
  * Author: Ks Tan
  */
 import {
@@ -59,20 +59,6 @@ export class <%= it.typename %>Controller extends SimpleAppController<
   }
 
 
-  @Get(':id')
-  @ApiResponse({
-    status: 200,
-    description: 'Founds',
-    type: <%= it.fullApiSchemaName%>
-  })
-  @ApiResponse({ status: 404, description: 'Document not found' })
-  @ApiResponse({ status: 500, description: 'Internal error' })
-  @ApiOperation({ operationId: 'runFindOne' })
-  async findOne(@Param('id') id: string) {    
-    return await this._findOne(id);
-  }
-  
-
 
   @Post()
   @ApiResponse({
@@ -102,6 +88,38 @@ export class <%= it.typename %>Controller extends SimpleAppController<
     return await this._search(data)
   }
 
+
+/***************************** x-document-api definations *****************************************/
+
+<% for(let i=0;i<it.apiSettings.length;i++){%>
+<% let api = it.apiSettings[i] %>
+<%~ `@${capitalizeFirstLetter(api.method)}(':id/${api.action}')`%>
+@ApiResponse({status: 200,description: '<%=api.description%>'})
+@ApiOperation({ operationId: 'exec<%=capitalizeFirstLetter(api.action)%>' })
+async exec<%=capitalizeFirstLetter(api.action)%>(@Param('id') id: string){
+  return await this.service.exec<%=capitalizeFirstLetter(api.action)%>(id)
+} 
+<%}%>
+
+/*****************************customized code begin here *****************************************/
+  <%~ it.controllerCode %>
+
+/*****************************customized code end here *****************************************/
+
+  @Get(':id')
+  @ApiResponse({
+    status: 200,
+    description: 'Founds',
+    type: <%= it.fullApiSchemaName%>
+  })
+  @ApiResponse({ status: 404, description: 'Document not found' })
+  @ApiResponse({ status: 500, description: 'Internal error' })
+  @ApiOperation({ operationId: 'runFindOne' })
+  async findOne(@Param('id') id: string) {    
+    return await this._findOne(id);
+  }
+  
+
   @Put(':id')
   @ApiResponse({
     status: 200,
@@ -129,7 +147,6 @@ export class <%= it.typename %>Controller extends SimpleAppController<
   }
  
 
-   /*****************************customized code begin here *****************************************/
-  <%~ it.controllerCode %>
+   
  
 }

package/templates/basic/model.eta

@@ -29,6 +29,7 @@ const schemasetting = {
 };
 
 export const <%= it.doctype %>MongoSchema = new Schema(schemasetting,{collection: '<%= it.name %>'})
+<%if(it.requireautocomplete){%>
 .index({<%=it.autocompletecode%>:1,orgId:1},{unique:true})
 .index({<%=it.autocompletename%>:1,orgId:1});
-
+<%}%>

package/templates/basic/pageindex.vue.eta

@@ -55,7 +55,7 @@
         <% } else if(obj.type=='array'  && obj.items && obj.items.type =='string' ){ %>              
             <SimpleAppChip   autofocus :setting="o.getField('#/properties/<%= key %>')" v-model="data.<%= key %>"/>
         <% } else if(obj.type=='object'  && typeof obj['x-foreignkey']!='undefined'){ %>              
-            <SimpleAppAutocomplete  :getAutocomplete="getAutocomplete" :setting="o.getField('#/properties/<%= key %>')"
+            <SimpleAppAutocomplete :setting="o.getField('#/properties/<%= key %>')"
                     v-model="data.<%= key %>" optionLabel="label" :remote-src="getAutocomplete('<%=obj['x-foreignkey']%>')"/>
         <% } else if(obj.type=='string'){ %>            
                 <% if(obj.format=='date'){ %>

package/templates/basic/service.eta

@@ -6,6 +6,7 @@
  * last change 2023-09-09
  * Author: Ks Tan
  */
+import { UserProvider } from '../../class/UserProvider'
 import { Injectable } from '@nestjs/common';
 import { InjectModel } from '@nestjs/mongoose';
 import { Model } from 'mongoose';
@@ -20,7 +21,7 @@ export class <%= it.typename %>Service extends SimpleAppService<<%= it.typename
   protected documentIdentityName='<%~ it.autocompletename %>'
     constructor(@InjectModel('<%= it.name %>')  mydoc: Model<<%= it.typename %>>,
   ) {
-    super('<%= it.doctype %>','<%= it.name %>',mydoc,IsolationType.org);
+    super('<%= it.doctype %>','<%= it.name %>',mydoc,IsolationType.<%=it.isolationtype%>);
     this.setSchema(<%= it.typename%>JsonSchema)
     
     <%if(it.moreAutoComplete.length>0){%>
@@ -34,7 +35,22 @@ export class <%= it.typename %>Service extends SimpleAppService<<%= it.typename
     
   }
 
-  
+  /***************************** x-document-api definations *****************************************/
+
+  <%for(let i=0;i<it.apiSettings.length;i++){%>
+  <% let api = it.apiSettings[i] %>
+  async exec<%=capitalizeFirstLetter(api.action)%>(id:string){
+    <%if(api.bpmn!==undefined){%>
+    return await this.executeWorkFlow(id,"<%=api.bpmn%>","<%=api.setDocumentStatus%>")
+    <%}else if (api.setDocumentStatus !== undefined){%>
+    return await this.setDocumentStatus(id,'<%=api.setDocumentStatus%>')
+    <%}else {%>
+      return Promise.resolve("unknown action")
+    <%}%>
+    
+  } 
+  <%}%>
+
   /*****************************customized frontend + backend code*****************************************/
     
   <%~ it.bothEndCode %>

package/templates/basic/simpleappclient.eta

@@ -6,6 +6,7 @@
  * Author: Ks Tan
  */
 import { SimpleAppClient } from "@simitgroup/simpleapp-vue-component/src/SimpleAppClient";
+import {AxiosResponse} from 'axios'
 
 // import { JSONSchema7 } from 'json-schema';
 import { Configuration,
@@ -26,6 +27,9 @@ export class <%= it.typename%>Doc extends SimpleAppClient<<%= it.typename%>,<%=
   protected documentIdentityCode='<%~ it.autocompletecode %>'
   protected documentIdentityName='<%~ it.autocompletename %>'
   constructor(xorg:string,event:any,listen?:any) {    
+    if(!xorg){
+      xorg='MC0wLTA' //0-0-0
+    }
     const apiconfig = new Configuration({ basePath:  `${useRuntimeConfig().public.APP_URL}/api/${xorg}` });
     const apiobj = new <%= it.doctype.toUpperCase()%>Api(apiconfig)
     super(apiobj,'<%= it.doctype %>','<%=it.name %>')
@@ -91,6 +95,21 @@ export class <%= it.typename%>Doc extends SimpleAppClient<<%= it.typename%>,<%=
   <%})%>
   
 
+  <%for(let i=0;i<it.apiSettings.length;i++){%>
+  <% let api = it.apiSettings[i] %>
+  async exec<%=capitalizeFirstLetter(api.action)%>(){
+    const recordid: string = this.data.value._id ?? '';
+    return await this.docapi.exec<%=capitalizeFirstLetter(api.action)%>(recordid)
+    .then((res: AxiosResponse) => {
+      if(this.event){this.event('info:<%=capitalizeFirstLetter(api.action)%>',res.data)}
+      return res;
+    }).catch((res:any)=>{
+      if(this.event){this.event('error:<%=capitalizeFirstLetter(api.action)%>',res)}
+      return Promise.reject(res)
+    });
+  } 
+  <%}%>
+
   /*****************************customized frontend + backend code*****************************************/
     
   <%~ it.bothEndCode %>