Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
2,121 additions
and
116 deletions.
There are no files selected for viewing
414 changes: 301 additions & 113 deletions
414
docs/site/hasOne-relation.md → docs/site/HasOne-relation.md
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
197 changes: 197 additions & 0 deletions
197
packages/cli/generators/relation/has-one-relation.generator.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| // Copyright IBM Corp. 2020. All Rights Reserved. | ||
| // Node module: @loopback/cli | ||
| // This file is licensed under the MIT License. | ||
| // License text available at https://opensource.org/licenses/MIT | ||
|
|
||
| 'use strict'; | ||
|
|
||
| const path = require('path'); | ||
| const BaseRelationGenerator = require('./base-relation.generator'); | ||
| const relationUtils = require('./utils.generator'); | ||
| const utils = require('../../lib/utils'); | ||
|
|
||
| const CONTROLLER_TEMPLATE_PATH_HAS_ONE = | ||
| 'controller-relation-template-has-one.ts.ejs'; | ||
|
|
||
| module.exports = class HasOneRelationGenerator extends BaseRelationGenerator { | ||
| constructor(args, opts) { | ||
| super(args, opts); | ||
| } | ||
|
|
||
| async generateControllers(options) { | ||
| this.artifactInfo.sourceModelClassName = options.sourceModel; | ||
| this.artifactInfo.targetModelClassName = options.destinationModel; | ||
| this.artifactInfo.sourceRepositoryClassName = | ||
| this.artifactInfo.sourceModelClassName + 'Repository'; | ||
| this.artifactInfo.controllerClassName = | ||
| this.artifactInfo.sourceModelClassName + | ||
| this.artifactInfo.targetModelClassName + | ||
| 'Controller'; | ||
| this.artifactInfo.paramSourceRepository = utils.camelCase( | ||
| this.artifactInfo.sourceModelClassName + 'Repository', | ||
| ); | ||
|
|
||
| this.artifactInfo.sourceModelName = utils.toFileName(options.sourceModel); | ||
| this.artifactInfo.sourceModelPath = utils.pluralize( | ||
| this.artifactInfo.sourceModelName, | ||
| ); | ||
| this.artifactInfo.targetModelName = utils.toFileName( | ||
| options.destinationModel, | ||
| ); | ||
| this.artifactInfo.targetModelPath = utils.pluralize( | ||
| this.artifactInfo.targetModelName, | ||
| ); | ||
| this.artifactInfo.targetModelRequestBody = utils.camelCase( | ||
| this.artifactInfo.targetModelName, | ||
| ); | ||
| this.artifactInfo.relationPropertyName = options.relationName; | ||
| this.artifactInfo.sourceModelPrimaryKey = options.sourceModelPrimaryKey; | ||
| this.artifactInfo.sourceModelPrimaryKeyType = | ||
| options.sourceModelPrimaryKeyType; | ||
| this.artifactInfo.targetModelPrimaryKey = options.targetModelPrimaryKey; | ||
| this.artifactInfo.foreignKeyName = options.foreignKeyName; | ||
|
|
||
| const source = this.templatePath(CONTROLLER_TEMPLATE_PATH_HAS_ONE); | ||
|
|
||
| this.artifactInfo.name = | ||
| options.sourceModel + '-' + options.destinationModel; | ||
| this.artifactInfo.outFile = | ||
| utils.toFileName(this.artifactInfo.name) + '.controller.ts'; | ||
|
|
||
| const dest = this.destinationPath( | ||
| path.join(this.artifactInfo.outDir, this.artifactInfo.outFile), | ||
| ); | ||
|
|
||
| this.copyTemplatedFiles(source, dest, this.artifactInfo); | ||
| await relationUtils.addExportController( | ||
| this, | ||
| path.resolve(this.artifactInfo.outDir, 'index.ts'), | ||
| this.artifactInfo.controllerClassName, | ||
| utils.toFileName(this.artifactInfo.name) + '.controller', | ||
| ); | ||
| } | ||
|
|
||
| async generateModels(options) { | ||
| // for repo to generate relation name | ||
| this.artifactInfo.relationName = options.relationName; | ||
| const modelDir = this.artifactInfo.modelDir; | ||
| const sourceModel = options.sourceModel; | ||
|
|
||
| const targetModel = options.destinationModel; | ||
|
|
||
| const relationType = options.relationType; | ||
| const relationName = options.relationName; | ||
| const fktype = options.sourceModelPrimaryKeyType; | ||
| const isForeignKeyExist = options.doesForeignKeyExist; | ||
| const foreignKeyName = options.foreignKeyName; | ||
|
|
||
| const isDefaultForeignKey = | ||
| foreignKeyName === utils.camelCase(options.sourceModel) + 'Id'; | ||
|
|
||
| let modelProperty; | ||
| const project = new relationUtils.AstLoopBackProject(); | ||
|
|
||
| const sourceFile = relationUtils.addFileToProject( | ||
| project, | ||
| modelDir, | ||
| sourceModel, | ||
| ); | ||
| const sourceClass = relationUtils.getClassObj(sourceFile, sourceModel); | ||
| relationUtils.doesRelationExist(sourceClass, relationName); | ||
|
|
||
| modelProperty = this.getHasOne( | ||
| targetModel, | ||
| relationName, | ||
| isDefaultForeignKey, | ||
| foreignKeyName, | ||
| ); | ||
|
|
||
| relationUtils.addProperty(sourceClass, modelProperty); | ||
| const imports = relationUtils.getRequiredImports(targetModel, relationType); | ||
|
|
||
| relationUtils.addRequiredImports(sourceFile, imports); | ||
| await sourceFile.save(); | ||
|
|
||
| const targetFile = relationUtils.addFileToProject( | ||
| project, | ||
| modelDir, | ||
| targetModel, | ||
| ); | ||
| const targetClass = relationUtils.getClassObj(targetFile, targetModel); | ||
|
|
||
| if (isForeignKeyExist) { | ||
| if ( | ||
| !relationUtils.isValidPropertyType(targetClass, foreignKeyName, fktype) | ||
| ) { | ||
| throw new Error('foreignKey Type Error'); | ||
| } | ||
| } else { | ||
| modelProperty = relationUtils.addForeignKey(foreignKeyName, fktype); | ||
| relationUtils.addProperty(targetClass, modelProperty); | ||
| targetClass.formatText(); | ||
| await targetFile.save(); | ||
| } | ||
| } | ||
|
|
||
| getHasOne(className, relationName, isDefaultForeignKey, foreignKeyName) { | ||
| let relationDecorator = [{ | ||
| name: 'hasOne', | ||
| arguments: [`() => ${className}, {keyTo: '${foreignKeyName}'}`], | ||
| }, ]; | ||
| if (isDefaultForeignKey) { | ||
| relationDecorator = [{ | ||
| name: 'hasOne', | ||
| arguments: [`() => ${className}`] | ||
| }]; | ||
| } | ||
|
|
||
| return { | ||
| decorators: relationDecorator, | ||
| name: relationName, | ||
| type: className, | ||
| }; | ||
| } | ||
|
|
||
| _getRepositoryRequiredImports(dstModelClassName, dstRepositoryClassName) { | ||
| const importsArray = super._getRepositoryRequiredImports( | ||
| dstModelClassName, | ||
| dstRepositoryClassName, | ||
| ); | ||
| importsArray.push({ | ||
| name: 'HasOneRepositoryFactory', | ||
| module: '@loopback/repository', | ||
| }); | ||
| return importsArray; | ||
| } | ||
|
|
||
| _getRepositoryRelationPropertyName() { | ||
| return this.artifactInfo.relationName; | ||
| } | ||
|
|
||
| _getRepositoryRelationPropertyType() { | ||
| return `HasOneRepositoryFactory<${utils.toClassName( | ||
| this.artifactInfo.dstModelClass, | ||
| )}, typeof ${utils.toClassName( | ||
| this.artifactInfo.srcModelClass, | ||
| )}.prototype.${this.artifactInfo.srcModelPrimaryKey}>`; | ||
| } | ||
|
|
||
| _addCreatorToRepositoryConstructor(classConstructor) { | ||
| const relationPropertyName = this._getRepositoryRelationPropertyName(); | ||
| const statement = | ||
| `this.${relationPropertyName} = ` + | ||
| `this.createHasOneRepositoryFactoryFor('${relationPropertyName}', ` + | ||
| `${utils.camelCase(this.artifactInfo.dstRepositoryClassName)}Getter,);`; | ||
| classConstructor.insertStatements(1, statement); | ||
| } | ||
|
|
||
| _registerInclusionResolverForRelation(classConstructor, options) { | ||
| const relationPropertyName = this._getRepositoryRelationPropertyName(); | ||
| if (options.registerInclusionResolver) { | ||
| const statement = | ||
| `this.registerInclusionResolver(` + | ||
| `'${relationPropertyName}', this.${relationPropertyName}.inclusionResolver);`; | ||
| classConstructor.insertStatements(2, statement); | ||
| } | ||
| } | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
packages/cli/generators/relation/templates/controller-relation-template-has-one.ts.ejs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| import { | ||
| Count, | ||
| CountSchema, | ||
| Filter, | ||
| repository, | ||
| Where, | ||
| } from '@loopback/repository'; | ||
| import { | ||
| del, | ||
| get, | ||
| getModelSchemaRef, | ||
| getWhereSchemaFor, | ||
| param, | ||
| patch, | ||
| post, | ||
| requestBody, | ||
| } from '@loopback/rest'; | ||
| import { | ||
| <%= sourceModelClassName %>, | ||
| <%= targetModelClassName %>, | ||
| } from '../models'; | ||
| import {<%= sourceRepositoryClassName %>} from '../repositories'; | ||
|
|
||
| export class <%= controllerClassName %> { | ||
| constructor( | ||
| @repository(<%= sourceRepositoryClassName %>) protected <%= paramSourceRepository %>: <%= sourceRepositoryClassName %>, | ||
| ) { } | ||
|
|
||
| @get('/<%= sourceModelPath %>/{id}/<%= targetModelPath %>', { | ||
| responses: { | ||
| '200': { | ||
| description: '<%= sourceModelClassName %> has one <%= targetModelClassName %>', | ||
| content: { | ||
| 'application/json': { | ||
| schema: getModelSchemaRef(<%= targetModelClassName %>), | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }) | ||
| async find( | ||
| @param.path.<%= sourceModelPrimaryKeyType %>('id') id: <%= sourceModelPrimaryKeyType %>, | ||
| @param.query.object('filter') filter?: Filter<<%= targetModelClassName %>>, | ||
| ): Promise<<%= targetModelClassName %>[]> { | ||
| return this.<%= paramSourceRepository %>.<%= relationPropertyName %>(id).find(filter); | ||
| } | ||
|
|
||
| @post('/<%= sourceModelPath %>/{id}/<%= targetModelPath %>', { | ||
| responses: { | ||
| '200': { | ||
| description: '<%= sourceModelClassName %> model instance', | ||
| content: {'application/json': {schema: getModelSchemaRef(<%= targetModelClassName %>)}}, | ||
| }, | ||
| }, | ||
| }) | ||
| async create( | ||
| @param.path.<%= sourceModelPrimaryKeyType %>('id') id: typeof <%= sourceModelClassName %>.prototype.<%= sourceModelPrimaryKey %>, | ||
| @requestBody({ | ||
| content: { | ||
| 'application/json': { | ||
| schema: getModelSchemaRef(<%= targetModelClassName %>, { | ||
| title: 'New<%= targetModelClassName %>In<%= sourceModelClassName %>', | ||
| exclude: ['<%= targetModelPrimaryKey %>'], | ||
| optional: ['<%= foreignKeyName %>'] | ||
| }), | ||
| }, | ||
| }, | ||
| }) <%= targetModelRequestBody %>: Omit<<%= targetModelClassName %>, '<%= targetModelPrimaryKey %>'>, | ||
| ): Promise<<%= targetModelClassName %>> { | ||
| return this.<%= paramSourceRepository %>.<%= relationPropertyName %>(id).create(<%= targetModelRequestBody %>); | ||
| } | ||
|
|
||
| @patch('/<%= sourceModelPath %>/{id}/<%= targetModelPath %>', { | ||
| responses: { | ||
| '200': { | ||
| description: '<%= sourceModelClassName %>.<%= targetModelClassName %> PATCH success count', | ||
| content: {'application/json': {schema: CountSchema}}, | ||
| }, | ||
| }, | ||
| }) | ||
| async patch( | ||
| @param.path.<%= sourceModelPrimaryKeyType %>('id') id: <%= sourceModelPrimaryKeyType %>, | ||
| @requestBody({ | ||
| content: { | ||
| 'application/json': { | ||
| schema: getModelSchemaRef(<%= targetModelClassName %>, {partial: true}), | ||
| }, | ||
| }, | ||
| }) | ||
| <%= targetModelRequestBody %>: Partial<<%= targetModelClassName %>>, | ||
| @param.query.object('where', getWhereSchemaFor(<%= targetModelClassName %>)) where?: Where<<%= targetModelClassName %>>, | ||
| ): Promise<Count> { | ||
| return this.<%= paramSourceRepository %>.<%= relationPropertyName %>(id).patch(<%= targetModelRequestBody %>, where); | ||
| } | ||
|
|
||
| @del('/<%= sourceModelPath %>/{id}/<%= targetModelPath %>', { | ||
| responses: { | ||
| '200': { | ||
| description: '<%= sourceModelClassName %>.<%= targetModelClassName %> DELETE success count', | ||
| content: {'application/json': {schema: CountSchema}}, | ||
| }, | ||
| }, | ||
| }) | ||
| async delete( | ||
| @param.path.<%= sourceModelPrimaryKeyType %>('id') id: <%= sourceModelPrimaryKeyType %>, | ||
| @param.query.object('where', getWhereSchemaFor(<%= targetModelClassName %>)) where?: Where<<%= targetModelClassName %>>, | ||
| ): Promise<Count> { | ||
| return this.<%= paramSourceRepository %>.<%= relationPropertyName %>(id).delete(where); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.