@simitgroup/simpleapp-generator 1.0.52 → 1.0.54

package/README.md

@@ -22,7 +22,10 @@ SimpleApp generator is a typescript code generator for convert jsonschemas becom
   g. document uploads[]
   h. workflow integration[]
 
-
+# Documentation
+1. [jsonschemas](./docs/jsonschema.md)
+2. backend
+3. frontend
 
 
 # Quick start
@@ -49,11 +52,11 @@ docker exec -it mongo1 mongosh --eval "rs.initiate({
 })"
 
 # set mongod1 high priority as primary server
-docker exec -it mongo1 ` mongosh --eval "cfg = rs.conf()
+docker exec -it mongo1 mongosh --eval "cfg = rs.conf()
 cfg.members[0].priority = 50
 cfg.members[1].priority = 1
 cfg.members[2].priority = 1
-rs.reconfig(cfg)"`
+rs.reconfig(cfg)"
 
 #check cluster status
 docker exec -it mongo1 mongosh --eval "rs.status()"
@@ -104,6 +107,10 @@ sh build.sh frontend
 ```sh
 cd ~/project1/frontend
 pnpm dev
+
+#or use production way
+nuxi build
+nuxi preview
 ```
 
 

package/docs/jsonschema.md

@@ -0,0 +1,123 @@
+# Json Schema
+Simpleapp implement customized version of json schema. This chapter cover some explanation of the special property. 
+To understannd what is json schema, refer [official documentation](https://json-schema.org/learn/getting-started-step-by-step)
+To prepare jsonschema efficiently, we can convert json sample data to jsonschema [here](https://redocly.com/tools/json-to-json-schema/)
+
+
+# Sample
+
+refer below example `product.json`:
+```json
+{
+  "type": "object",
+  "x-simpleapp-config": {
+    "documentType": "prd",
+    "documentName": "product",
+    "uniqueKey": "productCode",
+    "documentTitle": "productName",
+    "isolationType": "org",
+    "pageType": "crud",
+    "additionalAutoCompleteFields": ["defaultprice"]
+  },
+  "properties": {
+    ...
+    "productCode": { "type": "string", "examples": ["BK-MTHP1"] },
+    "productName": { "type": "string", "examples": ["Math Primary 1 Book"] },
+    "category": {
+      "type": "object",
+      "x-foreignkey": "category",
+      "properties": {
+        "_id": { "type": "string" },
+        "label": { "type": "string" }
+      }
+    },    
+    ...
+  }
+}
+```
+There is 2 special property (and only 2) which is
+1. root level property `x-simpleapp-config`, which define how the json schema been use to generate source code
+2. field level property `x-foreignkey`: field level property, which declare foreign key `category`. It require another json schema `category.json` which will store at different mongodb collection
+
+
+## `x-simpleapp-config`
+It tell code generator what it need to do with this schema such as:
+1. store under which collection
+2. tag with what api name
+3. rules of data isolation 
+4. implement special document numbering format
+5. how data index and much more.
+
+| property | datatype | required | description|
+| --- | --- | --- | --- | 
+| documentType | string | yes |short form of document name, it is unique identity of resource use by some place, like configure document running number, tags in swagger ui, backend file prefix and etc. Example: inv, po |
+| documentName | string | yes | default name of mongodb collection, also act as long unique identity of resources, most of the place will use this name as as resource name, or prefix of resource name. Example invoice,purchaseorder
+| isolationType | string | yes | data isolation rules. `none`: shall all tenant, `tenant`: shall all organization in same tenant, `org`: shall to all branch under same org. `branch`: only share within same branch
+| uniqueKey | string | usually yes | declare unique key field name, such as itemCode, documentNo, studentCode. auto generate document running number shall use field name declare here too. it auto appear in autocomplete. it will auto index in mongodb
+| documentTitle | string | usually yes | label or title of this record. such as itemName, categoryName, customerName, invoiceTitle. it auto appear in autocomplete
+| documentDate | string | no | define which field name of date. like invoiceDate, orderDate. it allow frontend know how to filter current month record.  |
+| generateDocumentNumber | boolean | no | it tell code generator whether current schema have document numbering control|
+| pageType | string | usually yes| define 'crud' to generate template page, else no auto create page|
+|additionalAutoCompleteFields| array of string| no | define what others field you want to put in autocomplete. such as product always like to include `defaultprice`, `uom`
+| formula | array | no | define array of formula which will apply in fields. target field define with `jsonpath` format. formula usually define in sharelibs |
+|additionalApis| array | no | define additional api for current schema. use case such as `suspend`, `confirm`, `reschedule`. We can define which customized function here
+| collectionName | string | no | default value same with documentName. Avoid define it, it reserve for special situation which we want multiple document store in same collection
+|allStatus| array| no | not implement yet, determine current document allow what document status, different document status may act differently like readonly, next status, available api and etc
+|foreignKeys| object | no | system property, it auto fill in base on current document connect to which collection. It ensure current document join to record which is valid. It used during data validation during create and update
+
+
+## `x-foreignkey`
+1. it define at field level, which allow frontend pick list of value easily.
+2. backend only allow _id which is exists in destinated collection, invalid designate _id will cause create/update blocked. product only can store valid category's _id
+3. it act like foreign key constraint, delete category which was connected to product will block
+
+## format
+all field define as string support additional property `format`. such as:
+```json
+{...
+"email": {"type":"string","format":"email"}
+..}
+```
+
+input which not compatible with `format` will be block by frontend and backend.
+
+simpleapp support [ajv](https://ajv.js.org/guide/formats.html#string-formats`), plus a few as below:
+| format name | example | description|
+| --- | --- | --- | 
+| documentno | SI-HQ-0001 |  generator will auto prepare special input element for field with this format. apply this format to field declared as `uniqueKey` only
+| tel | 0129988772 |  7-15 character numbering only
+| text| any word | no control, generator will auto prepare textarea for field with this format
+| html| any word | no control, reserve, reserve to auto prepare html editor. yet to decide implement or not
+    
+
+
+# Compulsory schema properties 
+to allow data traceable and isolated properly, there is compulsory property in highest level
+```json
+{
+...
+"_id": { "type": "string" },
+"created": { "type": "string" },
+"updated": { "type": "string" },
+"createdby": { "type": "string" },
+"updatedby": { "type": "string" },
+"tenantId": { "type": "integer", "default": 1, "minimum": 1 },
+"orgId": { "type": "integer", "default": 1, "minimum": 1 },
+"branchId": { "type": "integer", "default": 1, "minimum": 1 },
+...
+}
+
+```
+
+
+# Data validation
+There is 2 kind of data validation which is:
+1. jsonschema rules
+2. backend validation rules
+
+## jsonschema data validation
+we use [AJV](https://ajv.js.org/guide/getting-started.html) to jsonschema rules validation, it support `required`,`minimum`,`minLength`, `format`, `pattern` and etc. Refer jsonschema official website to know more rules
+
+
+## backend validation rules
+it require to write programming hook in backend, cover at backend development guide

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simitgroup/simpleapp-generator",
-  "version": "1.0.52",
+  "version": "1.0.54",
   "description": "frontend nuxtjs and backend nests code generator using jsonschema",
   "main": "dist/index.js",
   "scripts": {

package/templates/nuxt/components/ButtonPermissionInfo.vue.eta

@@ -4,10 +4,7 @@
         <Button
               class="btn-primary pi pi-question"
               @click="previewPermission"
-            >
-            <svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6">
-              <path stroke-linecap="round" stroke-linejoin="round" d="M9.879 7.519c1.171-1.025 3.071-1.025 4.242 0 1.172 1.025 1.172 2.687 0 3.712-.203.179-.43.326-.67.442-.745.361-1.45.999-1.45 1.827v.75M21 12a9 9 0 11-18 0 9 9 0 0118 0zm-9 5.25h.008v.008H12v-.008z" />
-            </svg>
+            >          
         </Button>
         <Sidebar
                 v-model:visible="showpermissioninfo"

package/templates/nuxt/components/SimpleAppAutocomplete.vue.eta

@@ -122,10 +122,3 @@ const capitalizeFirstLetter = (str: string) => {
   return res;
 };
 </script>
-<style scoped>
-.simpleapp-autocomplete{
-  @apply w-auto ;
-  line-height: 1rem;
-}
-
-</style>

package/templates/nuxt/layouts/sidelistcrud.vue.eta

@@ -25,7 +25,7 @@ const selectItem=(item:any)=>{
 <template>
     <div>
 
-        <Menus />
+        <HeaderBar />
         <Invitation/>
         <div class="grid grid-cols-4">
             <div class="col col-span-1  ">

package/templates/nuxt/nuxt.config.ts.eta

@@ -88,7 +88,10 @@ tailwindcss: {
       "./src/**/*.{vue,js,ts,jsx,tsx}",
       "./node_modules/primevue/**/*.{vue,js,ts,jsx,tsx}"
   ],
-  css: [ path.resolve(__dirname,'./assets/css/style.css')],
+  css: [ 
+    'primeicons/primeicons.css',
+    path.resolve(__dirname,'./assets/css/style.css')
+    ],
 
   // devtools: { enabled: true },
   // build: {

package/templates/project/README.md

@@ -1,11 +1,3 @@
 # how to use
-1. add/edit schemas in ./schemas/*, edit index to include all schemas
-2. add/edit groupss in groups folder
-3. run build schemas
-```
-sh ./build.sh schema
-```
-4. then run
-```
-sh ./build.sh 
-``` 
+refer to
+https://github.com/SIMITGROUP/simpleapp-generator

package/templates/project/build.sh.eta

@@ -1,8 +1,8 @@
 #!/bin/bash
 type=$1
 
-ts-node generate.ts   
-npx prettier  --write jsonschemas
+# ts-node generate.ts   
+# npx prettier  --write jsonschemas
 
 
 if [ $type == 'frontend' ]; then

package/templates/project/jsonschemas/category.json._eta

@@ -0,0 +1,34 @@
+{
+  "type": "object",
+  "x-simpleapp-config": {
+    "documentType": "cat",
+    "documentName": "category",
+    "isolationType": "org",
+    "uniqueKey": "categoryCode",
+    "documentTitle": "categoryName",
+    "pageType": "crud"
+  },
+  "properties": {
+    "_id": { "type": "string" },
+    "created": { "type": "string" },
+    "updated": { "type": "string" },
+    "createdby": { "type": "string" },
+    "updatedby": { "type": "string" },
+    "tenantId": { "type": "integer", "default": 1, "minimum": 1 },
+    "orgId": { "type": "integer", "default": 1, "minimum": 1 },
+    "branchId": { "type": "integer", "default": 1, "minimum": 1 },
+    "categoryCode": { "type": "string", "examples": ["TUITION"] },
+    "categoryName": { "type": "string", "examples": ["Tuition Service"] },
+    "active": { "type": "boolean", "default": true, "examples": [true] },
+    "categoryType": {
+      "type": "string",
+      "enum": ["class", "charge"],
+      "examples": ["class"]
+    },
+    "description": {
+      "type": "string",
+      "format": "text",
+      "examples": ["Maths Tuition primary 1"]
+    }
+  }
+}

package/templates/project/jsonschemas/customer.json._eta

@@ -0,0 +1,38 @@
+{
+  "type": "object",
+  "x-simpleapp-config": {
+    "documentType": "cust",
+    "documentName": "customer",
+    "uniqueKey": "customerNo",
+    "documentTitle": "customerName",
+    "generateDocumentNumber": true,
+    "isolationType": "org",
+    "pageType": "crud"
+  },
+  "properties": {
+    "_id": { "type": "string" },
+    "created": { "type": "string" },
+    "updated": { "type": "string" },
+    "createdby": { "type": "string" },
+    "updatedby": { "type": "string" },
+    "tenantId": { "type": "integer", "default": 1, "minimum": 1 },
+    "orgId": { "type": "integer", "default": 1, "minimum": 1 },
+    "branchId": { "type": "integer", "default": 1, "minimum": 1 },
+    "customerNo": {
+      "type": "string",
+      "format": "documentno",
+      "examples": ["S0001"]
+    },
+    "customerName": { "type": "string", "examples": ["Customer 1"] },
+    "active": { "type": "boolean", "default": true, "examples": [true] },
+    "description": { "type": "string", "format": "text" },
+    "docNoFormat": {
+      "type": "object",
+      "x-foreignkey": "docnoformat",
+      "properties": {
+        "_id": { "type": "string" },
+        "label": { "type": "string" }
+      }
+    }
+  }
+}

package/templates/project/jsonschemas/invoice.json._eta

@@ -0,0 +1,70 @@
+{
+  "type": "object",
+  "x-simpleapp-config": {
+    "documentType": "inv",
+    "documentName": "invoice",
+    "isolationType": "org",
+    "uniqueKey": "invoiceNo",
+    "documentTitle": "invoiceTitle",
+    "documentDate": "invoiceDate",
+    "generateDocumentNumber": true,
+    "pageType": "crud",
+    "formulas": [
+      { "jsonpath": "$.details[*]", "formula": "sharelibs.getSubtotal(value)" },
+      {
+        "jsonpath": "$.invoiceTotal",
+        "formula": "sharelibs.getTotal(data.details)"
+      }
+    ]
+  },
+  "properties": {
+    "_id": { "type": "string" },
+    "created": { "type": "string" },
+    "updated": { "type": "string" },
+    "createdby": { "type": "string" },
+    "updatedby": { "type": "string" },
+    "tenantId": { "type": "integer", "default": 1, "minimum": 1 },
+    "orgId": { "type": "integer", "default": 1, "minimum": 1 },
+    "branchId": { "type": "integer", "default": 1, "minimum": 1 },
+    "customer": {
+      "type": "object",
+      "x-foreignkey": "customer",
+      "properties": {
+        "_id": { "type": "string" },
+        "label": { "type": "string" }
+      }
+    },
+    "invoiceNo": {
+      "type": "string",
+      "examples": ["SI1111"],
+      "format": "documentno"
+    },
+    "invoiceTitle": { "type": "string", "examples": ["Sales to XYZ"] },
+    "invoiceTotal": { "type": "number", "default": 0 },
+    "details": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "product": {
+            "type": "object",
+            "x-foreignkey": "product",
+            "properties": {
+              "_id": { "type": "string" },
+              "label": { "type": "string" },
+              "defaultprice": { "type": "number", "default": 0 }
+            }
+          },
+          "quantity": { "type": "integer", "default": 1 },
+          "unitprice": { "type": "number", "default": 0 },
+          "subtotal": { "type": "number", "default": 0 }
+        }
+      }
+    },
+    "description": {
+      "type": "string",
+      "format": "text",
+      "examples": ["Maths Tuition primary 1"]
+    }
+  }
+}

package/templates/project/jsonschemas/product.json._eta

@@ -0,0 +1,39 @@
+{
+  "type": "object",
+  "x-simpleapp-config": {
+    "documentType": "prd",
+    "documentName": "product",
+    "uniqueKey": "productCode",
+    "documentTitle": "productName",
+    "isolationType": "org",
+    "pageType": "crud",
+    "additionalAutoCompleteFields": ["defaultprice"]
+  },
+  "properties": {
+    "_id": { "type": "string" },
+    "created": { "type": "string" },
+    "updated": { "type": "string" },
+    "createdby": { "type": "string" },
+    "updatedby": { "type": "string" },
+    "tenantId": { "type": "integer", "default": 1, "minimum": 1 },
+    "orgId": { "type": "integer", "default": 1, "minimum": 1 },
+    "branchId": { "type": "integer", "default": 1, "minimum": 1 },
+    "productCode": { "type": "string", "examples": ["BK-MTHP1"] },
+    "productName": { "type": "string", "examples": ["Math Primary 1 Book"] },
+    "category": {
+      "type": "object",
+      "x-foreignkey": "category",
+      "properties": {
+        "_id": { "type": "string" },
+        "label": { "type": "string" }
+      }
+    },
+    "defaultprice": { "type": "number" },
+    "active": { "type": "boolean", "default": true },
+    "description": { "type": "string" },
+    "tags": {
+      "type": "array",
+      "items": { "type": "string", "examples": ["P1", "Math"] }
+    }
+  }
+}

package/templates/project/generate.ts.eta

@@ -1,10 +0,0 @@
-import * as schemas from './schemas'
-import {writeFileSync} from 'fs'
-type keyofschema = keyof typeof schemas 
-Object.keys(schemas).forEach( (schemaname)=>{
-    const mykey :keyofschema = schemaname   as keyofschema
-    // console.log("writing",schemas[mykey])
-    const content = JSON.stringify(schemas[mykey])
-    // console.log(content)
-    writeFileSync(`./jsonschemas/${schemaname}.json`,content)
-})

package/templates/project/jsonschemas/category.json.eta

@@ -1 +0,0 @@
-{}

package/templates/project/schemas/category.ts.eta

@@ -1,40 +0,0 @@
-import {
-  SchemaType,
-  RESTMethods,
-  IsolationType,
-} from '/usr/local/lib/node_modules/@simitgroup/simpleapp-generator/src/type'
-//"/Users/kstan/dev/lowcode/simpleapp-generator/src/type";
-export const category: SchemaType = {
-  type: "object",
-  "x-simpleapp-config": {
-    documentType: "cat",
-    documentName: "category",
-    isolationType: IsolationType.org,
-    uniqueKey:'categoryCode',
-    documentTitle:'categoryName',
-    pageType: "crud",
-  },
-  properties: {
-    _id: { type: "string" },
-    created: { type: "string" },
-    updated: { type: "string" },
-    createdby: { type: "string" },
-    updatedby: { type: "string" },
-    tenantId: { type: "integer", default: 1, minimum: 1 },
-    orgId: { type: "integer", default: 1, minimum: 1 },
-    branchId: { type: "integer", default: 1, minimum: 1 },
-    categoryCode: { type: "string", examples: ["TUITION"] },
-    categoryName: { type: "string", examples: ["Tuition Service"] },
-    active: { type: "boolean", default: true, examples: [true] },
-    categoryType: {
-      type: "string",
-      enum: ["class", "charge"],
-      examples: ["class"],
-    },
-    description: {
-      type: "string",
-      format: "text",
-      examples: ["Maths Tuition primary 1"],
-    },
-  },
-};

package/templates/project/schemas/customer.ts.eta

@@ -1,35 +0,0 @@
-import {
-  SchemaType,
-  RESTMethods,
-  IsolationType,
-} from '/usr/local/lib/node_modules/@simitgroup/simpleapp-generator/src/type'
-//"/Users/kstan/dev/lowcode/simpleapp-generator/src/type";
-export const customer: SchemaType = {
-  type: "object",
-  "x-simpleapp-config": {
-    documentType: "cust",
-    documentName: "customer",
-    uniqueKey:'customerNo',
-    documentTitle:'customerName',
-    generateDocumentNumber:true,
-    isolationType: IsolationType.org,
-    pageType: "crud",
-  },
-  properties: {
-    _id: { type: "string" },
-    created: { type: "string" },
-    updated: { type: "string" },
-    createdby: { type: "string" },
-    updatedby: { type: "string" },
-    tenantId: { type: "integer", default: 1, minimum: 1 },
-    orgId: { type: "integer", default: 1, minimum: 1 },
-    branchId: { type: "integer", default: 1, minimum: 1 },
-    customerNo: { type: "string", format:"documentno",examples: ["S0001"] },
-    customerName: { type: "string", examples: ["Customer 1"] },
-    active: { type: "boolean", default: true, examples: [true] },            
-    description: {type: "string",format: "text"},      
-    docNoFormat: {type: "object","x-foreignkey":"docnoformat", 
-      properties: { _id: { type: "string" }, label: { type: "string" } },
-    },
-  },
-};

package/templates/project/schemas/index.ts.eta

@@ -1,5 +0,0 @@
-//examples
-export { product } from "./product";
-export { category } from "./category";
-export { customer } from "./customer";
-export { invoice } from "./invoice";

package/templates/project/schemas/invoice.ts.eta

@@ -1,56 +0,0 @@
-import {
-    SchemaType,
-    RESTMethods,
-    IsolationType,
-  } from '/usr/local/lib/node_modules/@simitgroup/simpleapp-generator/src/type'
-  //"/Users/kstan/dev/lowcode/simpleapp-generator/src/type";
-  export const invoice: SchemaType = {
-    type: "object",
-    "x-simpleapp-config": {
-      documentType: "inv",
-      documentName: "invoice",
-      isolationType: IsolationType.org,
-      uniqueKey:'invoiceNo',
-      documentTitle:'invoiceTitle',
-      documentDate:"invoiceDate",
-      generateDocumentNumber:true,
-      pageType: "crud",
-      formulas:[
-        {jsonpath:'$.details[*]',formula:'sharelibs.getSubtotal(value)'},
-        {jsonpath:'$.invoiceTotal',formula:'sharelibs.getTotal(data.details)'},
-    ]
-    },
-    properties: {
-      _id: { type: "string", },
-
-      created: { type: "string" },
-      updated: { type: "string" },
-      createdby: { type: "string" },
-      updatedby: { type: "string" },
-      tenantId: { type: "integer", default: 1, minimum: 1 },
-      orgId: { type: "integer", default: 1, minimum: 1 },
-      branchId: { type: "integer", default: 1, minimum: 1 },
-      customer:{type:'object','x-foreignkey':'customer',properties:{_id:{type:'string'},label:{type:'string'}, }},
-      invoiceNo: { type: "string", examples: ["SI1111"],format:'documentno' },
-      invoiceTitle: { type: "string", examples: ["Sales to XYZ"] },
-      invoiceTotal:{ type:'number',default:0.00},
-      details:{
-        type:'array',
-        items:{
-            type:'object',
-            properties:{
-                product:{ type:'object',  'x-foreignkey':'product',properties:{_id:{type:'string'},label:{type:'string'},defaultprice:{type:'number',default:0.00}}},
-                quantity:{type:'integer',default:1},
-                unitprice:{type:'number',default:0.00},
-                subtotal:{type:'number', default:0.00}
-            }
-        }
-      },
-      description: {
-        type: "string",
-        format: "text",
-        examples: ["Maths Tuition primary 1"],
-      },
-    },
-  };
-  

package/templates/project/schemas/product.ts.eta

@@ -1,43 +0,0 @@
-//examples
-import {
-  SchemaType,
-  RESTMethods,
-  IsolationType,
-} from '/usr/local/lib/node_modules/@simitgroup/simpleapp-generator/src/type';
-export const product: SchemaType = {
-  type: "object",
-  "x-simpleapp-config": {
-    documentType: "prd",
-    documentName: "product",
-    uniqueKey:'productCode',
-    documentTitle:'productName',
-    isolationType: IsolationType.org,
-    pageType: "crud",
-    additionalAutoCompleteFields:['defaultprice'],
-  },
-
-  properties: {
-    _id: { type: "string" },
-    created: { type: "string" },
-    updated: { type: "string" },
-    createdby: { type: "string" },
-    updatedby: { type: "string" },
-    tenantId: { type: "integer", default: 1, minimum: 1 },
-    orgId: { type: "integer", default: 1, minimum: 1 },
-    branchId: { type: "integer", default: 1, minimum: 1 },
-    productCode: { type: "string", examples: ["BK-MTHP1"] },
-    productName: { type: "string", examples: ["Math Primary 1 Book"] },    
-    category: {
-      type: "object",
-      "x-foreignkey": "category",
-      properties: { _id: { type: "string" }, label: { type: "string" } },
-    },
-    defaultprice: { type: "number" },    
-    active: { type: "boolean", default: true },
-    description: { type: "string" },
-    tags: {
-      type: "array",
-      items: { type: "string", examples: ["P1", "Math"] },
-    },
-  },
-};