@lenne.tech/cli 0.0.82 → 0.0.85

package/build/templates/monorepro/README.md.ejs

@@ -0,0 +1,100 @@
+# <%= props.name %>
+
+This is a [lerna](https://lerna.js.org/) [Monorepro](https://monorepo.tools) for App ([Angular](https://angular.io)) and API ([NestJS](https://nestjs.com)).
+Build with [NgBaseStarter](https://github.com/lenneTech/ng-base-starter) and [Starter for Nest Server](https://github.com/lenneTech/nest-server-starter)
+via [CLI](https://github.com/lenneTech/cli).
+
+If you are not yet familiar with Angular or NestJS, we recommend you to have a look at the following sections of our
+academy [lenne.Learning](https://lennelearning.de):
+- [Angular](https://lennelearning.de/lernpfad/angular)
+- [NestJS](https://lennelearning.de/lernpfad/nestjs)
+
+## Requirements
+
+- [Node.js incl. npm](https://nodejs.org):
+  the runtime environment for your server
+
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git):
+  the version control system for your source code
+
+- [MongoDB](https://docs.mongodb.com/manual/installation/#mongodb-community-edition-installation-tutorials)
+  (or any other database compatible with [MikroORM](https://mikro-orm.io)):
+  the database for your objects
+
+Installation on MacOS:
+```
+/bin/bash -c "$(curl - fsSL https: //raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+brew tap mongodb/brew
+brew update
+brew install mongodb-community@6.O
+brew services start mongodb
+brew install node
+npm install -g n
+```
+
+To check if all requirements are met, we can display the versions of the respective software
+(the version may differ from your versions in the following example):
+```
+mongod --version
+  db version v6.0.1
+  Build Info: {
+      "version": "6.0.1",
+      "gitVersion": "32f0f9c88dc44a2c8073a5bd47cf779d4bfdee6b",
+      "modules": [],
+      "allocator": "system",
+      "environment": {
+          "distarch": "aarch64",
+          "target_arch": "aarch64"
+      }
+  }
+
+node -v
+  v16.17.0
+
+npm -v
+  8.15.0
+```
+
+## Initialization of a local instance
+
+Clone this repository and install packages:
+```
+git clone <%= props.repository %>
+cd <%= props.nameKebab %>
+npm i
+```
+
+## Testing
+
+Check if the requirements are met by running the tests (in the root directory):
+```
+npm test
+```
+
+## Start
+
+Both the app and the API are started with the following command (in the root directory):
+```
+npm start
+```
+
+The following URLs are then accessible:
+
+- App: http://localhost:4200
+- Documentation of the API: http://localhost:3000
+- Playground for using the API: http://localhost:3000/graphql
+
+If a URL is not reachable, it may be due to an error in the source code or because another process is already
+occupying the corresponding port (3000 / 4200). In this case you can either stop the other process or set another
+port in the configuration of the app or server.
+
+## Architecture
+
+The architecture of the projects is based on the following structures:
+- Both the app and the API can be found with their respective dependencies in the `projects` directory
+- Both technologies are still compatible with their own CLI ([Angular CLI](angular cli) / [NestJS CLI](https://docs.nestjs.com/cli/overview))
+- The [lt CLI](https://github.com/lenneTech/cli) also offers a few benefits regarding the extensions [NgBaseStarter](https://github.com/lenneTech/ng-base-starter) and [Starter for Nest Server](https://github.com/lenneTech/nest-server-starter)
+- To organize the monorepro [lerna](https://lerna.js.org/) is used
+
+## History
+- Initialized via `lt create angular`

package/build/templates/nest-server-module/inputs/template.input.ts.ejs

@@ -1,4 +1,4 @@
-import { Restricted, RoleEnum } from '@lenne.tech/nest-server';
+import { CoreInput, Restricted, RoleEnum } from '@lenne.tech/nest-server';
 import { Field, InputType } from '@nestjs/graphql';
 import { IsOptional } from 'class-validator';<%- props.imports %>
 
@@ -7,7 +7,7 @@ import { IsOptional } from 'class-validator';<%- props.imports %>
  */
 @Restricted(RoleEnum.ADMIN)
 @InputType({ description: 'Input data to update an existing <%= props.namePascal %>' })
-export class <%= props.namePascal %>Input {
+export class <%= props.namePascal %>Input extends CoreInput {
 
   // ===================================================================================================================
   // Properties

package/build/templates/nest-server-module/template.model.ts.ejs

@@ -3,6 +3,7 @@ import { Field, ObjectType } from '@nestjs/graphql';
 import { Prop, Schema as MongooseSchema, SchemaFactory } from '@nestjs/mongoose';
 import { Document, Schema } from 'mongoose';
 import { PersistenceModel } from '../../common/models/persistence.model';
+import { User } from '../user/user.model';
 
 export type <%= props.namePascal %>Document = <%= props.namePascal %> & Document;
 
@@ -26,7 +27,7 @@ export class <%= props.namePascal %> extends PersistenceModel {
   /**
    * Initialize instance with default values instead of undefined
    */
-  init() {
+  override init() {
     super.init();
     // this.xxx = [];
     return this;
@@ -37,10 +38,21 @@ export class <%= props.namePascal %> extends PersistenceModel {
    *
    * Hint: Non-primitive variables should always be mapped (see mapClasses / mapClassesAsync in ModelHelper)
    */
-  map(input) {
+  override map(input) {
     super.map(input);
     return <%- props.mappings %>
   }
+
+  /**
+   * Verification of the user's rights to access the properties of this object
+   */
+  override securityCheck(user: User, force?: boolean) {
+    if (force || user?.hasRole(RoleEnum.ADMIN)) {
+      return this;
+    }
+    // Check rights for properties of this object
+    return this;
+  }
 }
 
 export const <%= props.namePascal %>Schema = SchemaFactory.createForClass(<%= props.namePascal %>);

package/build/templates/nest-server-module/template.module.ts.ejs

@@ -1,4 +1,5 @@
-import { Module } from '@nestjs/common';
+import { ConfigService } from '@lenne.tech/nest-server';
+import { forwardRef, Module } from '@nestjs/common';
 import { MongooseModule } from '@nestjs/mongoose';
 import { PubSub } from 'graphql-subscriptions';
 import { UserModule } from '../user/user.module';
@@ -10,9 +11,13 @@ import { <%= props.namePascal %>Service } from './<%= props.nameKebab %>.service
  * <%= props.namePascal %> module
  */
 @Module({
-  imports: [MongooseModule.forFeature([{ name: <%= props.namePascal %>.name, schema: <%= props.namePascal %>Schema }]), UserModule],
+  imports: [
+    MongooseModule.forFeature([{ name: <%= props.namePascal %>.name, schema: <%= props.namePascal %>Schema }]),
+    forwardRef(() => UserModule),
+  ],
   controllers: [],
   providers: [
+    ConfigService,
     <%= props.namePascal %>Resolver,
     <%= props.namePascal %>Service,
     {

package/build/templates/nest-server-module/template.service.ts.ejs

@@ -1,4 +1,4 @@
-import { assignPlain, CrudService, ServiceOptions } from '@lenne.tech/nest-server';
+import { assignPlain, ConfigService, CrudService, ServiceOptions } from '@lenne.tech/nest-server';
 import { Inject, Injectable, NotFoundException } from '@nestjs/common';
 import { InjectModel } from '@nestjs/mongoose';
 import { PubSub } from 'graphql-subscriptions';
@@ -22,12 +22,17 @@ export class <%= props.namePascal %>Service extends CrudService<<%= props.namePa
 
   /**
    * Constructor for injecting services
+   *
+   * Hints:
+   * To resolve circular dependencies, integrate services as follows:
+   * @Inject(forwardRef(() => XxxService)) protected readonly xxxService: XxxService
    */
   constructor(
+    protected override readonly configService: ConfigService,
     @InjectModel('<%= props.namePascal %>') protected readonly <%= props.nameCamel %>Model: Model<<%= props.namePascal %>Document>,
     @Inject('PUB_SUB') protected readonly pubSub: PubSub
   ) {
-    super({mainDbModel: <%= props.nameCamel %>Model, mainModelConstructor: <%= props.namePascal %>});
+    super({configService: configService, mainDbModel: <%= props.nameCamel %>Model, mainModelConstructor: <%= props.namePascal %>});
   }
 
   // ===================================================================================================================
@@ -38,7 +43,7 @@ export class <%= props.namePascal %>Service extends CrudService<<%= props.namePa
    * Create new <%= props.namePascal %>
    * Overwrites create method from CrudService
    */
-  async create(input: <%= props.namePascal %>CreateInput, serviceOptions?: ServiceOptions): Promise<<%= props.namePascal %>> {
+  override async create(input: <%= props.namePascal %>CreateInput, serviceOptions?: ServiceOptions): Promise<<%= props.namePascal %>> {
     // Get new <%= props.namePascal %>
     const created<%= props.namePascal %> = await super.create(input, serviceOptions);
 

package/build/templates/nest-server-object/template-create.input.ts.ejs

@@ -0,0 +1,18 @@
+import { Restricted, RoleEnum } from '@lenne.tech/nest-server';
+import { Field, InputType } from '@nestjs/graphql';
+import { IsOptional } from 'class-validator';
+import { <%= props.namePascal %>Input } from './<%= props.nameKebab %>.input';<%- props.imports %>
+
+
+/**
+ * <%= props.namePascal %> create input
+ */
+@Restricted(RoleEnum.ADMIN)
+@InputType({ description: 'Input data to create a new <%= props.namePascal %>' })
+export class <%= props.namePascal %>CreateInput extends <%= props.namePascal %>Input {
+
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+  <%- props.props %>
+}

package/build/templates/nest-server-object/template.input.ts.ejs

@@ -0,0 +1,16 @@
+import { CoreInput, Restricted, RoleEnum } from '@lenne.tech/nest-server';
+import { Field, InputType } from '@nestjs/graphql';
+import { IsOptional } from 'class-validator';<%- props.imports %>
+
+/**
+ * <%= props.namePascal %> input
+ */
+@Restricted(RoleEnum.ADMIN)
+@InputType({ description: 'Input data to update an existing <%= props.namePascal %>' })
+export class <%= props.namePascal %>Input extends CoreInput {
+
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+  <%- props.props %>
+}

package/build/templates/nest-server-object/template.object.ts.ejs

@@ -0,0 +1,57 @@
+import { CoreModel, mapClasses, Restricted, RoleEnum } from '@lenne.tech/nest-server';
+import { Field, ObjectType } from '@nestjs/graphql';
+import { Prop, Schema as MongooseSchema, SchemaFactory } from '@nestjs/mongoose';
+import { Document, Schema } from 'mongoose';
+import { User } from '../../../modules/user/user.model';
+
+export type <%= props.namePascal %>Document = <%= props.namePascal %> & Document;
+
+/**
+ * <%= props.namePascal %> model
+ */
+@Restricted(RoleEnum.ADMIN)
+@ObjectType({ description: '<%= props.namePascal %>' })
+@MongooseSchema({ _id: false })
+export class <%= props.namePascal %> extends CoreModel {
+
+  // ===================================================================================================================
+  // Properties
+  // ===================================================================================================================
+  <%- props.props %>
+
+  // ===================================================================================================================
+  // Methods
+  // ===================================================================================================================
+
+  /**
+   * Initialize instance with default values instead of undefined
+   */
+  override init() {
+    super.init();
+    // this.xxx = [];
+    return this;
+  }
+
+  /**
+   * Map input
+   *
+   * Hint: Non-primitive variables should always be mapped (see mapClasses / mapClassesAsync in ModelHelper)
+   */
+  override map(input) {
+    super.map(input);
+    return <%- props.mappings %>
+  }
+
+  /**
+   * Verification of the user's rights to access the properties of this object
+   */
+  override securityCheck(user: User, force?: boolean) {
+    if (force || user?.hasRole(RoleEnum.ADMIN)) {
+      return this;
+    }
+    // Check rights for properties of this object
+    return this;
+  }
+}
+
+export const <%= props.namePascal %>Schema = SchemaFactory.createForClass(<%= props.namePascal %>);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/cli",
-  "version": "0.0.82",
+  "version": "0.0.85",
   "description": "lenne.Tech CLI: lt",
   "keywords": [
     "lenne.Tech",