@simitgroup/simpleapp-generator 1.6.7-m-alpha → 2.0.0-a-alpha

package/templates/nest/src/simple-app/.core/framework/custom-exception.ts.eta

@@ -0,0 +1,26 @@
+import { HttpException, HttpStatus } from '@nestjs/common';
+
+export class CustomException extends HttpException {
+  constructor(errorCode: string, errorMessage: string, fields: { field: string; message: string }[] = [], status: number = 400) {
+    const errorResponse = {
+      ts: new Date().toISOString(),
+      elapsed: 0,
+      fields: fields,
+      statusCode: errorCode,
+      // statusMessage: errorMessage,
+      message: errorMessage,
+      data: {
+        message: errorMessage,
+        statusCode: errorCode,
+        timestamp: new Date().toISOString(),
+        path: '', // Dynamic path support
+        error: fields.reduce((acc, field) => {
+          acc[field.field] = field.message;
+          return acc;
+        }, {}),
+      },
+    };
+
+    super(errorResponse, status);
+  }
+}

package/templates/nest/src/simple-app/.core/framework/framework.module.ts.eta

@@ -0,0 +1,12 @@
+import { Module } from '@nestjs/common';
+import { SimpleAppInterceptor } from './simple-app.interceptor';
+import { SimpleAppMiddleware } from './simple-app.middleware';
+import { SimpleAppCoreFeaturesModule } from '../features/simple-app-core-features.module';
+import {SimpleAppCoreResourcesModule} from '../resources/core-resources.module'
+@Module({
+  imports: [SimpleAppCoreFeaturesModule,SimpleAppCoreResourcesModule],
+  controllers: [],
+  providers: [SimpleAppMiddleware, SimpleAppInterceptor],
+  exports: [SimpleAppCoreFeaturesModule,SimpleAppCoreResourcesModule,SimpleAppMiddleware, SimpleAppInterceptor],
+})
+export class SimpleAppFrameworkModule {}

package/templates/nest/src/simple-app/.core/framework/schemas/index.ts.eta

@@ -0,0 +1,3 @@
+export * from './others.schema';
+export * from './simple-app.schema';
+

package/templates/nest/src/simple-app/.core/framework/schemas/others.schema.ts.eta

@@ -0,0 +1,153 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Field, ObjectType, ID } from '@nestjs/graphql';
+import GraphQLJSON, { GraphQLJSONObject } from 'graphql-type-json';
+
+export class TMiniApiTokenInfo {
+  miniAppId: string;
+}
+export type TUserType = 'normal' | 'miniApi' | 'robot' | 'guest' | 'miniAppSdk';
+
+export class PreparedKey {
+  _id: string;
+  fullName?: string;
+  uid?: string;
+}
+
+
+export class PatchManyRequest<T> {
+  @ApiProperty({ type: () => Object, required: true })
+  data: Partial<T>;
+
+  @ApiProperty({ type: () => Object, required: false })  
+  filter?: Object | null;
+}
+
+@ObjectType()
+export class UpdateManyResponse {
+  /** Indicates whether this write result was acknowledged. If not, then all other members of this result will be undefined */
+  @ApiProperty({ type: 'boolean' })
+  @Field()
+  acknowledged: boolean;
+
+  /** The number of documents that matched the filter */
+  @ApiProperty({ type: 'number' })
+  @Field()
+  matchedCount: number;
+
+  /** The number of documents that were modified */
+  @ApiProperty({ type: 'number' })
+  @Field()
+  modifiedCount: number;
+
+  /** The number of documents that were upserted */
+  @ApiProperty({ type: 'number' })
+  @Field()
+  upsertedCount: number;
+
+  /** The identifier of the inserted document if an upsert took place */
+  @ApiProperty({ type: 'string', nullable: true })
+  @Field()
+  upsertedId: string | null
+}
+
+
+
+@ObjectType()
+export class CodeLabelValue {
+  @Field()
+  @ApiProperty({ type: () => String })
+  _id: string;
+  @Field()
+  @ApiProperty({ type: () => String })
+  code: string;
+  @Field()
+  @ApiProperty({ type: () => String })
+  label: string;
+  @Field()
+  @ApiProperty({ type: () => Number })
+  value: number;
+}
+
+@ObjectType()
+export class KeyValue {
+  @Field()
+  @ApiProperty({ type: () => String })
+  key: string;
+  @Field()
+  @ApiProperty({ type: () => String })
+  value: string;
+  @Field()
+  @ApiProperty({ type: () => String, required: false })
+  id?: string;
+}
+
+@ObjectType()
+export class ImportErrorMessgeError {
+  @Field()
+  @ApiProperty({ type: () => String })
+  message: string;
+
+  // @Field()
+  // @ApiProperty({ type: () => Object})
+  [key: string]: any;
+}
+
+@ObjectType()
+export class ImportErrorMessage {
+  @Field()
+  @ApiProperty({ type: () => String })
+  code: string;
+  @Field()
+  @ApiProperty({ type: () => String })
+  label: string;
+  @Field()
+  @ApiProperty({ type: () => String })
+  message: string;
+  @Field()
+  @ApiProperty({ type: () => ImportErrorMessgeError })
+  error: ImportErrorMessgeError;
+}
+
+@ObjectType()
+export class QueueJobProducerResponse {
+  @Field()
+  @ApiProperty({ type: () => String })
+  id: string;
+  @Field()
+  @ApiProperty({ type: () => String })
+  name: string;
+  @Field()
+  @ApiProperty({ type: () => String })
+  processor: string;
+}
+
+export class DocnoformatBranch {
+  _id: string;
+  code: string;
+  label: string;
+  branchId: number;
+}
+
+export class Docnoformat {
+  _id: string;
+  created: string;
+  updated: string;
+  createdBy: string;
+  updatedBy: string;
+  tenantId: number;
+  orgId: number;
+  branchId: number;
+  docNoFormatNo: string;
+  docNoFormatName: string;
+  active: boolean;
+  default: boolean;
+  docNoType: string;
+  docNoPattern: string;
+  nextNumber: number;
+  branch: DocnoformatBranch;
+}
+
+@ObjectType()
+export class UniqueKeyExistResponse {
+  [code: string]: 0 | 1;
+}

package/templates/nest/src/simple-app/.core/framework/schemas/simple-app.schema.ts.eta

@@ -0,0 +1,172 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { Field, ObjectType, ID } from '@nestjs/graphql';
+import { JSONSchema7, JSONSchema7Type, JSONSchema7Version, JSONSchema7TypeName, JSONSchema7Definition } from 'json-schema';
+import { Permission } from 'src/simple-app/.core/resources/permission/permission.schema';
+
+export class ModifiedCollection {
+  [key: string]: string[];
+}
+export class ModifiedRecords {
+  createds: ModifiedCollection;
+  updateds: ModifiedCollection;
+  deleteds: ModifiedCollection;
+}
+export class DocNumberFormatResult {
+  formatId: string;
+  formatName: string;
+  result: string;
+}
+
+export class SearchBody {
+  filter?: Object;
+
+  fields?: any[];
+
+  sorts?: any[];
+  lookup?: Object;
+}
+
+export enum IsolationType {
+  'none' = 'none',
+  'org' = 'org',
+  'tenant' = 'tenant',
+  'branch' = 'branch',
+}
+export class MoreProjectionType {
+  [key: string]: string;
+}
+export class ApiEvent {
+  _id: string;
+  created: string;
+  updated?: string;
+  duration: number;
+  createdBy: string;
+  path: string;
+  ip: string;
+  method: string;
+  headers: any;
+  data?: any;
+  statusCode: number;
+  status: string;
+  errMsg?: string;
+  errData?: any;
+}
+
+export class DeleteResultType<T> {
+  data: T;
+  result: {
+    acknowledged: boolean;
+    deletedCount: number;
+  };
+}
+
+export class DocumentStatus {
+  status: string; //'CO', 'V', 'CL', 'D' and etc
+  statusName: string;
+  readOnly: boolean;
+  actions: string[]; //api name ['confirm','revert','close','void' and etc]
+}
+export enum RESTMethods {
+  'post' = 'post',
+  'get' = 'get',
+  'delete' = 'delete',
+  'put' = 'put',
+  'patch' = 'patch',
+}
+export class DocumentApi {
+  action: string; //api action name
+  entryPoint: string; //api entry point example:':id', ':id/confirm'
+  queryPara?: string[]; //what query parameter wish to accept, example:  ['description','date']
+  requiredRole?: string[]; // what special user role wish to allow for this api, example: ['SuperUser']
+  workflowSetting?: { bpmn: string }; //optional property, once define code gen connect the bpmn workflow
+  method: RESTMethods;
+  schema?: string; //any schema/type name in types & apischemas
+  responseType?: string; //any schema/type name for response
+  description: string; //description of api
+}
+//export enum IsolationType {"none"="none" , "tenant"="tenant","org"="org", "branch"="branch"}
+// export class  ImportLibs = {"lib":string,"as":string}
+export class Formula {
+  jsonPath: string; //example: "$.subtotal","$.details[*]"
+  formula: string; //example "jslib.getDocumentSubTotal(@F{$.details})"
+}
+export class SchemaPrintFormat {
+  formatName: string;
+  formatId: string;
+  description?: string;
+}
+export class SchemaConfig {
+  isolationType: string;
+  requiredRoles?: string[];
+  pageType?: string;
+  uniqueKey?: string;
+  uniqueKeys?: string[][];
+  documentTitle?: string;
+  generateDocumentNumber?: boolean;
+  docNoPattern?: string;
+  documentDate?: string;
+  allStatus?: DocumentStatus[];
+  additionalApis?: DocumentApi[];
+  additionalAutoCompleteFields?: string[];
+  search?: string[];
+  // libs?:ImportLibs[]   // both process class and frontend client class will import same lib
+  formulas?: Formula[];
+  documentType: string;
+  documentName: string;
+  collectionName?: string;
+  foreignKeys?: MyForeignKey;
+}
+
+@ObjectType()
+export class ForeignKey {
+  @Field()
+  @ApiProperty({ type: () => String })
+  _id?: String;
+  @Field()
+  @ApiProperty({ type: () => String })
+  code?: String;
+  @Field()
+  @ApiProperty({ type: () => String })
+  label?: String;
+  [key: string]: any;
+}
+export class MyForeignKey {
+  [collectionname: string]: string[];
+}
+
+export class NoParam {}
+
+export class DynamicParam {
+  [key: string]: any;
+}
+
+export class TextSearchBody {
+  keyword: string;
+  fields?: string[];
+  sorts?: string[][];
+  lookup?: Record<string, string>;
+}
+
+export class SchemaFields {
+  _id?: string;
+  tenantId?: number;
+  orgId?: number;
+  branchId?: number;
+  created?: string;
+  updated?: string;
+  createdBy?: string;
+  updatedBy?: string;
+  __v?: number;
+  documentStatus?: string;
+  [key: string]: any; //SimpleAppJSONSchema7 | SimpleAppJSONSchema7[] | undefined;
+}
+
+export class SimpleAppJSONSchema7 implements JSONSchema7 {
+  'x-simpleapp-config': SchemaConfig;
+}
+export const SimpleAppJSONSchema7Definition = SimpleAppJSONSchema7;
+
+export class BranchPermission extends Permission {
+  @ApiProperty({ type: () => ForeignKey })
+  branch: ForeignKey;
+}

package/templates/nest/src/{simpleapp/generate/commons/interceptors/response.interceptor.ts.eta → simple-app/.core/framework/simple-app.interceptor.ts.eta}

@@ -4,41 +4,31 @@
  * last change 2023-03-17
  * Author: Ks Tan
  */
-import {
-  Injectable,
-  NestInterceptor,
-  ExecutionContext,
-  CallHandler,
-  BadGatewayException,
-  HttpException,
-} from '@nestjs/common';
+import { Injectable, NestInterceptor, ExecutionContext, CallHandler, BadGatewayException, HttpException } from '@nestjs/common';
 import { Observable, throwError } from 'rxjs';
 import { catchError, tap } from 'rxjs/operators';
 import { Model, Connection, ClientSession } from 'mongoose';
 import { InjectConnection, InjectModel } from '@nestjs/mongoose';
-import { UserContext } from '../user.context';
-import { ApiEvent } from '../../types';
+import { UserContext } from '../features/user-context/user.context';
+import { ApiEvent } from './schemas';
 @Injectable()
-export class ResponseInterceptor implements NestInterceptor {
+export class SimpleAppInterceptor implements NestInterceptor {
   constructor(
     @InjectConnection() private readonly connection: Connection,
     @InjectModel('ApiEvent') private apieventmodel: Model<ApiEvent>,
   ) {}
 
-  async intercept(
-    context: ExecutionContext,
-    next: CallHandler,
-  ): Promise<Observable<any>> {
-    
+  async intercept(context: ExecutionContext, next: CallHandler): Promise<Observable<any>> {
     //not http request then exclude such as graphql
-    if(context.getType()!='http'){
-      // obtain usersession here        
-      return next.handle().pipe(tap(async () => {
-        //console.log("none http, do nothing at interceptor")
-      }))
+    if (context.getType() != 'http') {
+      // obtain usersession here
+      return next.handle().pipe(
+        tap(async () => {
+          //console.log("none http, do nothing at interceptor")
+        }),
+      );
     }
 
-
     const req = context.switchToHttp().getRequest();
     const resp = context.switchToHttp().getResponse();
     //console.log("want to get user session:", Object.keys(req))

package/templates/nest/src/{simpleapp/generate/commons/middlewares/tenant.middleware.ts.eta → simple-app/.core/framework/simple-app.middleware.ts.eta}

@@ -1,25 +1,27 @@
 /**
  * This file was automatically generated by simpleapp generator. Every
  * MODIFICATION OVERRIDE BY GENERATEOR
- * last change 2024-03-17
+ * last change 2025-08-27
  * Author: Ks Tan
  */
 
 import Base64URL from '@darkwolf/base64url';
-import { BadRequestException, Injectable, Logger, NestMiddleware } from '@nestjs/common';
+import { BadRequestException, Injectable, Logger, NestMiddleware, ServiceUnavailableException } from '@nestjs/common';
 import { InjectModel } from '@nestjs/mongoose';
 import { NextFunction, Request, Response } from 'express';
 import { Model } from 'mongoose';
-import { Permission } from '../../types/perm.type';
-import { User } from '../../types/user.type';
-import { Appintegration } from '../../types/appintegration.type';
-import { Miniappinstallation, Webhook } from '../../types';
-import { UserContext } from '../user.context';
-import { ApiKeyService } from './api-key/api-key.service';
-import { HEADER_X_API_KEY, HEADER_X_API_SECRET } from '../constants/header';
-
+import { Permission } from '../resources/permission/permission.schema';
+import { User } from '../resources/user/user.schema';
+// import { Miniappinstallation } from '../../resources/';
+import { Webhook } from '../features/webhook/schemas';
+// import { Appintegration } from '../../types/appintegration.type';
+import { MiniAppInstallation } from 'src/simple-app/.core/resources/mini-app-installation/mini-app-installation.schema';
+import { UserContext } from '../features/user-context/user.context';
+import { ApiKeyService } from '../features/auth/api-key/api-key.service';
+import { HEADER_X_API_KEY, HEADER_X_API_SECRET } from '../features/auth/api-key/api-key.type';
+import { Environment } from '../features/maintenance/schemas';
 @Injectable()
-export class TenantMiddleware implements NestMiddleware {
+export class SimpleAppMiddleware implements NestMiddleware {
   protected defaultXOrg = Base64URL.encodeText('0-0-0');
 
   protected excludeXOrgPaths = ['/profile', '/profile/tenant', '/profile/session'];
@@ -29,11 +31,14 @@ export class TenantMiddleware implements NestMiddleware {
   constructor(
     @InjectModel('User') private readonly userModel: Model<User>,
     @InjectModel('Permission') private readonly permModel: Model<Permission>,
-    @InjectModel('Appintegration') private readonly appModel: Model<Appintegration>,
+    // @InjectModel('Appintegration') private readonly appModel: Model<Appintegration>,
     @InjectModel('Webhook') private readonly webhookModel: Model<Webhook>,
-    @InjectModel('Miniappinstallation') private readonly miniAppInstallationModel: Model<Miniappinstallation>,
+    @InjectModel('MiniAppInstallation') private readonly miniAppInstallationModel: Model<MiniAppInstallation>,
+    @InjectModel('Environment') private envModel: Model<Environment>,
     private readonly apiKeyService: ApiKeyService,
-  ) {}
+  ) {
+    // console.log("middleware userModel aggregate",this.userModel)
+  }
 
   requireXOrg(baseurl: string): boolean {
     for (let i = 0; i < this.excludeXOrgPaths.length; i++) {
@@ -51,16 +56,27 @@ export class TenantMiddleware implements NestMiddleware {
       return;
     }
 
+    const envs = await this.envModel.find();
+    let maintenanceMode = false;
+    if (envs) {
+      maintenanceMode = !envs[0].systemEnable;
+    }
+
     let tokenStr: string = req.get('authorization') ?? '';
     tokenStr = tokenStr.replace('Bearer ', '');
     const xOrg = req.get('x-org') ?? this.defaultXOrg;
 
-    const user = new UserContext(this.userModel, this.permModel, this.appModel, this.miniAppInstallationModel);
+    const user = new UserContext(this.userModel, this.permModel, this.miniAppInstallationModel);
 
     if (req.baseUrl == '/graphql') {
       if (tokenStr) {
         await user.setCurrentUserInfo(tokenStr, xOrg, this.webhookModel);
       }
+
+      if (maintenanceMode && !user.isRealmAdmin()) {
+        throw new ServiceUnavailableException('System in maintenance mode');
+      }
+
       req['sessionuser'] = user;
       next();
       return;
@@ -74,6 +90,9 @@ export class TenantMiddleware implements NestMiddleware {
         await this.apiKeyService.validate(req, user);
 
         req['sessionuser'] = user;
+        if (maintenanceMode) {
+          throw new ServiceUnavailableException('System in maintenance mode');
+        }
         next();
         return;
       } catch (e) {
@@ -110,6 +129,11 @@ export class TenantMiddleware implements NestMiddleware {
 
     try {
       await user.setCurrentUserInfo(tokenStr, xOrg, this.webhookModel);
+
+      if (maintenanceMode && !user.isRealmAdmin()) {
+        throw new ServiceUnavailableException('System in maintenance mode');
+      }
+
       user.detectMiniAppSdkRequest(req);
       if (user.getId() == '' && this.requireXOrg(req.baseUrl)) {
         this.logger.log('Access deny for user:', req.baseUrl);

package/templates/nest/src/simple-app/.core/readme.md.eta

@@ -0,0 +1,3 @@
+- leave everything in this folder under change!!
+- any modification will be override by generator
+- store system librarly and some system resources 

package/templates/nest/src/simple-app/.core/resources/core-resources.module.ts.eta

@@ -0,0 +1,38 @@
+/**
+ * This file was automatically generated by simpleapp generator. Every
+ * MODIFICATION OVERRIDE BY GENERATEOR
+ * last change 2024-04-02
+ * Author: Ks Tan
+ */
+import { Module } from '@nestjs/common';
+
+
+<% for(let i=0;i<it.modules.length; i++){ %>
+<% let obj = it.modules[i]%>
+<% if(getSystemResources().includes(obj.docname.toLowerCase())){%>
+  import { <%= obj.typename %>Module } from './<%= camelToKebab(obj.resourcename) %>/<%= camelToKebab(obj.resourcename) %>.module';    
+<%}%>
+<%}%>
+
+
+@Module({
+  imports: [
+    <% for(let i=0;i<it.modules.length; i++){ %>
+      <% let obj = it.modules[i]%>
+      <% if(getSystemResources().includes(obj.docname.toLowerCase())){%>
+        <%= obj.typename %>Module,    
+      <%}%>
+    <%}%>
+    ],
+  controllers:[],
+  providers: [],
+  exports: [
+     <% for(let i=0;i<it.modules.length; i++){ %>
+      <% let obj = it.modules[i]%>
+      <% if(getSystemResources().includes(obj.docname.toLowerCase())){%>
+        <%= obj.typename %>Module,    
+      <%}%>
+    <%}%>
+  ],
+})
+export class SimpleAppCoreResourcesModule {}

package/templates/nest/src/simple-app/.core/simple-app-core.module.ts.eta

@@ -0,0 +1,18 @@
+/**
+ * This file was automatically generated by simpleapp generator. Every
+ * MODIFICATION OVERRIDE BY GENERATEOR
+ * last change 2024-04-02
+ * Author: Ks Tan
+ */
+import { Module } from '@nestjs/common';
+
+import { SimpleAppCoreFeaturesModule } from './features/simple-app-core-features.module';
+import { SimpleAppFrameworkModule } from './framework/framework.module';
+import { SimpleAppCoreResourcesModule } from './resources/core-resources.module';
+@Module({
+  imports: [SimpleAppCoreFeaturesModule, SimpleAppCoreResourcesModule,SimpleAppFrameworkModule],
+  controllers: [],
+  providers: [],
+  exports: [SimpleAppCoreFeaturesModule, SimpleAppCoreResourcesModule,SimpleAppFrameworkModule],
+})
+export class SimpleAppCoreModule {}

package/templates/nest/src/simple-app/.core/utils/dayjs.ts.eta

@@ -0,0 +1,47 @@
+import dayjs from 'dayjs';
+import duration from 'dayjs/plugin/duration';
+import timezone from 'dayjs/plugin/timezone';
+import utc from 'dayjs/plugin/utc';
+
+dayjs.extend(utc);
+dayjs.extend(duration);
+dayjs.extend(timezone);
+
+export const getDayJs = () => {
+  return dayjs;
+};
+
+
+/**
+   * this function is used to convert user time date to UTC
+   * @param date
+   * @param timeZone from appuser, example Asia/Malaysia
+   * @returns
+   */
+export const convertToStartOfDayUTC = (date: string, timeZone: string): string => {
+  const startOfDay = dayjs.tz(date, timeZone).startOf('day');
+  const utcTime = startOfDay.utc().format();
+  return utcTime;
+}
+
+/**
+ * this function is used to convert user time date to UTC
+ * @param appuser
+ * @param date
+ * @returns
+ */
+export const convertToEndOfDayUTC = (date: string, timeZone: string): string => {
+  const endOfDay = dayjs.tz(date, timeZone).endOf('day');
+  const utcTime = endOfDay.utc().format();
+  return utcTime;
+}
+
+/**
+ * this function is used to convert UTC time to user timezone
+ * @param date example, 2024-12-31T23:45:00Z
+ * @param timeZone example, Asia/Kuala_Lumpur
+ */
+export const convertUTCToTimezone = (date: string, timeZone: string): string => {
+  const localTime = dayjs(date).tz(timeZone).format();
+  return localTime;
+}

package/templates/nest/src/simple-app/.core/utils/locale-tool.ts.eta

@@ -0,0 +1,11 @@
+import * as countrytimezone from 'countries-and-timezones';
+
+import countryToCurrency, { Countries } from 'country-to-currency';
+
+export const getCurrencyCode = (countryCode: Countries) => {
+  return countryToCurrency[countryCode];
+};
+
+export const getCountriesForTimezone = (timeZone: string) => {
+  return countrytimezone.getCountriesForTimezone(timeZone)[0];
+};

package/templates/nest/src/simple-app/.core/utils/string-utils.ts.eta

@@ -0,0 +1 @@
+export const camelToKebab = (value) => value.replace(/([a-z])([A-Z])/g, "$1-$2").toLowerCase()

package/templates/nest/src/simple-app/.resources/readme.md.eta

@@ -0,0 +1,3 @@
+- leave everything in this folder under change!!
+- any modification will be override by generator
+- jsonschemas will generate all resources here