fixup! apply feedback

docs/site/BelongsTo-relation.md

@@ -67,6 +67,12 @@ export class Order extends Entity {
     super(data);
   }
 }
+
+export interface OrderRelations {
+  // describe navigational properties here
+}
+
+export type OrderWithRelations = Order & OrderRelations;
 ```
 
 The definition of the `belongsTo` relation is inferred by using the `@belongsTo`
@@ -83,6 +89,10 @@ class Order extends Entity {
   @belongsTo(() => Customer, {keyTo: 'pk'})
   customerId: number;
 }
+
+export interface OrderRelations {
+  customer?: CustomerWithRelations;
+}
 ```
 
 ## Configuring a belongsTo relation
@@ -214,7 +224,9 @@ export class Category extends Entity {
   }
 }
 
-export interface CategoryRelations {}
+export interface CategoryRelations {
+  categories?: CategoryWithRelations[];
+}
 
 export type CategoryWithRelations = Category & CategoryRelations;
 ```

docs/site/HasMany-relation.md

@@ -131,6 +131,12 @@ export class Order extends Entity {
     super(data);
   }
 }
+
+export interface OrderRelations {
+  // describe navigational properties here
+}
+
+export type OrderWithRelations = Order & OrderRelations;
 ```
 
 The foreign key property (`customerId`) in the target model can be added via a
@@ -140,7 +146,7 @@ corresponding [belongsTo](BelongsTo-relation.md) relation, too.
 
 ```ts
 import {Entity, model, property, belongsTo} from '@loopback/repository';
-import {Customer} from './customer.model';
+import {Customer, CustomerWithRelations} from './customer.model';
 
 @model()
 export class Order extends Entity {
@@ -164,6 +170,12 @@ export class Order extends Entity {
     super(data);
   }
 }
+
+export interface OrderRelations {
+  customer?: CustomerWithRelations;
+}
+
+export type OrderWithRelations = Order & OrderRelations;
 ```
 
 ## Configuring a hasMany relation

docs/site/hasOne-relation.md

@@ -57,7 +57,7 @@ defined on a source model `Supplier` in the example below:
 {% include code-caption.html content="/src/models/supplier.model.ts" %}
 
 ```ts
-import {Account} from './account.model';
+import {Account, AccountWithRelations} from './account.model';
 import {Entity, property, hasOne} from '@loopback/repository';
 
 export class Supplier extends Entity {
@@ -80,13 +80,19 @@ export class Supplier extends Entity {
     super(data);
   }
 }
+
+export interface SupplierRelations {
+  account?: AccountWithRelations;
+}
+
+export type SupplierWithRelations = Supplier & SupplierRelations;
 ```
 
 On the other side of the relation, we'd need to declare a `belongsTo` relation
 since every `Account` has to belong to exactly one `Supplier`:
 
 ```ts
-import {Supplier} from './supplier.model';
+import {Supplier, SupplierWithRelations} from './supplier.model';
 import {Entity, property, belongsTo} from '@loopback/repository';
 
 export class Account extends Entity {
@@ -108,6 +114,12 @@ export class Account extends Entity {
     super(data);
   }
 }
+
+export interface AccountRelations {
+  supplier?: SupplierWithRelations;
+}
+
+export type AccountWithRelations = Account & AccountRelations;
 ```
 
 The definition of the `hasOne` relation is inferred by using the `@hasOne`

docs/site/tutorials/todo-list/todo-list-tutorial-model.md

@@ -76,7 +76,7 @@ model. Add the following import statements and property to the `TodoList` model:
 
 ```ts
 import {hasMany} from '@loopback/repository';
-import {Todo} from './todo.model';
+import {Todo, TodoWithRelations} from './todo.model';
 
 @model()
 export class TodoList extends Entity {
@@ -88,7 +88,9 @@ export class TodoList extends Entity {
   // ...constructor def...
 }
 
-export interface TodoListRelations {}
+export interface TodoListRelations {
+  todos?: TodoWithRelations[];
+}
 
 export type TodoListWithRelations = TodoList & TodoListRelations;
 ```
@@ -113,7 +115,9 @@ export class Todo extends Entity {
   // ...constructor def...
 }
 
-export interface TodoRelations {}
+export interface TodoRelations {
+  todoList?: TodoListWithRelations;
+}
 
 export type TodoWithRelations = Todo & TodoRelations;
 ```

examples/express-composition/src/models/note.model.ts

@@ -29,6 +29,8 @@ export class Note extends Entity {
   }
 }
 
-export interface NoteRelations {}
+export interface NoteRelations {
+  // describe navigational properties here
+}
 
 export type NoteWithRelations = Note & NoteRelations;

examples/todo-list/src/models/todo-list-image.model.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {belongsTo, Entity, model, property} from '@loopback/repository';
-import {TodoList} from './todo-list.model';
+import {TodoList, TodoListWithRelations} from './todo-list.model';
 
 @model()
 export class TodoListImage extends Entity {
@@ -30,6 +30,8 @@ export class TodoListImage extends Entity {
   }
 }
 
-export interface TodoListImageRelations {}
+export interface TodoListImageRelations {
+  todoList?: TodoListWithRelations;
+}
 
 export type TodoListImageWithRelations = TodoListImage & TodoListImageRelations;

examples/todo-list/src/models/todo-list.model.ts

@@ -4,8 +4,11 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {Entity, hasMany, hasOne, model, property} from '@loopback/repository';
-import {TodoListImage} from './todo-list-image.model';
-import {Todo} from './todo.model';
+import {
+  TodoListImage,
+  TodoListImageWithRelations,
+} from './todo-list-image.model';
+import {Todo, TodoWithRelations} from './todo.model';
 
 @model()
 export class TodoList extends Entity {
@@ -37,6 +40,9 @@ export class TodoList extends Entity {
   }
 }
 
-export interface TodoListRelations {}
+export interface TodoListRelations {
+  todos?: TodoWithRelations[];
+  image?: TodoListImageWithRelations;
+}
 
 export type TodoListWithRelations = TodoList & TodoListRelations;

examples/todo-list/src/models/todo.model.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {belongsTo, Entity, model, property} from '@loopback/repository';
-import {TodoList} from './todo-list.model';
+import {TodoList, TodoListWithRelations} from './todo-list.model';
 
 @model()
 export class Todo extends Entity {
@@ -42,6 +42,8 @@ export class Todo extends Entity {
   }
 }
 
-export interface TodoRelations {}
+export interface TodoRelations {
+  todoList?: TodoListWithRelations[];
+}
 
 export type TodoWithRelations = Todo & TodoRelations;

examples/todo/src/models/todo.model.ts

@@ -45,6 +45,8 @@ export class Todo extends Entity {
   }
 }
 
-export interface TodoRelations {}
+export interface TodoRelations {
+  // describe navigational properties here
+}
 
 export type TodoWithRelations = Todo & TodoRelations;

packages/cli/generators/model/index.js

@@ -296,6 +296,12 @@ module.exports = class ModelGenerator extends ArtifactGenerator {
         if (this.artifactInfo.allowAdditionalProperties) {
           Object.assign(this.artifactInfo.modelSettings, {strict: false});
         }
+
+        this.log(
+          `Let's add a property to ${chalk.yellow(
+            this.artifactInfo.className,
+          )}`,
+        );
       })
       .catch(err => {
         debug(`Error during model strict mode prompt: ${err}`);

packages/cli/generators/model/templates/model.ts.ejs

@@ -35,7 +35,7 @@ export class <%= className %> extends <%= modelBaseClass %> {
 }
 
 export interface <%= className %>Relations {
-
+  // describe navigational properties here
 }
 
 export type <%= className %>WithRelations = <%= className %> & <%= className %>Relations;

packages/cli/test/integration/generators/model.integration.js

@@ -225,7 +225,7 @@ describe('lb4 model integration', () => {
       );
       assert.fileContent(
         expectedModelFile,
-        /export interface TestRelations {\n\n}/,
+        /export interface TestRelations {\n  \/\/ describe navigational properties here\n}/,
       );
     });
 

packages/repository/README.md

@@ -53,7 +53,9 @@ export class Note extends Entity {
   content: string;
 }
 
-export interface NoteRelations {}
+export interface NoteRelations {
+  // describe navigational properties here
+}
 
 export type NoteWithRelations = Note & NoteRelations;
 ```

packages/repository/src/__tests__/fixtures/models/address.model.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {belongsTo, Entity, model, property} from '../../..';
-import {Customer} from './customer.model';
+import {Customer, CustomerWithRelations} from './customer.model';
 
 @model()
 export class Address extends Entity {
@@ -30,6 +30,8 @@ export class Address extends Entity {
   customerId: number;
 }
 
-export interface AddressRelations {}
+export interface AddressRelations {
+  customer?: CustomerWithRelations;
+}
 
 export type AddressWithRelations = Address & AddressRelations;

packages/repository/src/__tests__/fixtures/models/customer.model.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {belongsTo, Entity, hasMany, hasOne, model, property} from '../../..';
-import {Address} from './address.model';
+import {Address, AddressWithRelations} from './address.model';
 import {Order} from './order.model';
 
 @model()
@@ -33,6 +33,10 @@ export class Customer extends Entity {
   parentId?: number;
 }
 
-export interface CustomerRelations {}
+export interface CustomerRelations {
+  address?: AddressWithRelations;
+  customers?: CustomerWithRelations[];
+  parentCustomer?: CustomerWithRelations;
+}
 
 export type CustomerWithRelations = Customer & CustomerRelations;

packages/repository/src/__tests__/fixtures/models/order.model.ts

@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {belongsTo, Entity, model, property} from '../../..';
-import {Customer} from './customer.model';
+import {Customer, CustomerWithRelations} from './customer.model';
 
 @model()
 export class Order extends Entity {
@@ -30,6 +30,8 @@ export class Order extends Entity {
   customerId: number;
 }
 
-export interface OrderRelations {}
+export interface OrderRelations {
+  customer?: CustomerWithRelations;
+}
 
 export type OrderWithRelations = Order & OrderRelations;

packages/repository/src/__tests__/fixtures/models/product.model.ts

@@ -25,6 +25,8 @@ export class Product extends Entity {
   }
 }
 
-export interface ProductRelations {}
+export interface ProductRelations {
+  // describe navigational properties here
+}
 
 export type ProductWithRelations = Product & ProductRelations;