fix(repository): clarify argument type for @repository

docs/site/Controller-generator.md

@@ -76,7 +76,7 @@ Here's an example of what the template will produce given a `Todo` model and a
 `TodoRepository`:
 
 ```ts
-import {Filter, Where} from '@loopback/repository';
+import {Filter, Where, repository} from '@loopback/repository';
 import {
   post,
   param,
@@ -86,13 +86,12 @@ import {
   del,
   requestBody
 } from '@loopback/rest';
-import {inject} from '@loopback/context';
 import {Todo} from '../models';
 import {TodoRepository} from '../repositories';
 
 export class TodoController {
   constructor(
-    @inject('repositories.TodoRepository')
+    @repository(TodoRepository)
     public todoRepository: TodoRepository,
   ) {}
 

docs/site/Controllers.md

@@ -195,7 +195,7 @@ import {repository} from '@loopback/repository';
 
 export class HelloController {
   constructor(
-    @repository(HelloRepository.name) protected repository: HelloRepository,
+    @repository(HelloRepository) protected repository: HelloRepository,
   ) {}
 
   // returns a list of our objects
@@ -273,7 +273,7 @@ import {repository} from '@loopback/repository';
 
 export class HelloController {
   constructor(
-    @repository(HelloRepository.name) protected repo: HelloRepository,
+    @repository(HelloRepository) protected repo: HelloRepository,
   ) {}
 
   // returns a list of our objects

docs/site/Decorators.md

@@ -575,7 +575,8 @@ For usage examples, see [Define Models](Repositories.md#define-models)
 ### Repository Decorator
 
 Syntax:
-[`@repository(model: string | typeof Entity, dataSource?: string | juggler.DataSource)`](http://apidocs.loopback.io/@loopback%2frepository/#1503)
+
+[@repository(modelOrRepo: string | Class<Repository<Model>> | typeof Entity, dataSource?: string | juggler.DataSource)](http://apidocs.loopback.io/@loopback%2frepository/#1503)
 
 This decorator either injects an existing repository or creates a repository
 from a model and a datasource.

docs/site/Repositories.md

@@ -155,7 +155,7 @@ DataSource for in the constructor of your controller class as follows:
 ```ts
 export class AccountController {
   constructor(
-    @repository(AccountRepository.name) public repository: AccountRepository,
+    @repository(AccountRepository) public repository: AccountRepository,
   ) {}
 ```
 
@@ -331,7 +331,7 @@ Injection:
 
    ```ts
    export class AccountController {
-     @repository(NewRepository.name) private repository: NewRepository;
+     @repository(NewRepository) private repository: NewRepository;
    }
    ```
 

docs/site/todo-tutorial-controller.md

@@ -41,7 +41,7 @@ import {TodoRepository} from '../repositories';
 
 export class TodoController {
   constructor(
-    @repository(TodoRepository.name) protected todoRepo: TodoRepository,
+    @repository(TodoRepository) protected todoRepo: TodoRepository,
   ) {}
 }
 ```
@@ -71,7 +71,7 @@ import {HttpErrors, post, param, requestBody} from '@loopback/rest';
 
 export class TodoController {
   constructor(
-    @repository(TodoRepository.name) protected todoRepo: TodoRepository,
+    @repository(TodoRepository) protected todoRepo: TodoRepository,
   ) {}
 
   @post('/todo')
@@ -121,7 +121,7 @@ import {
 
 export class TodoController {
   constructor(
-    @repository(TodoRepository.name) protected todoRepo: TodoRepository,
+    @repository(TodoRepository) protected todoRepo: TodoRepository,
   ) {}
 
   @post('/todo')

examples/todo/src/controllers/todo.controller.ts

@@ -18,12 +18,7 @@ import {
 } from '@loopback/rest';
 
 export class TodoController {
-  // TODO(bajtos) Fix documentation (and argument names?) of @repository()
-  // to allow the usage below.
-  // See https://github.com/strongloop/loopback-next/issues/744
-  constructor(
-    @repository(TodoRepository.name) protected todoRepo: TodoRepository,
-  ) {}
+  constructor(@repository(TodoRepository) protected todoRepo: TodoRepository) {}
 
   @post('/todo')
   async createTodo(@requestBody() todo: Todo) {

packages/cli/generators/controller/templates/src/controllers/controller-rest-template.ts.ejs

@@ -1,4 +1,4 @@
-import {Filter, Where} from '@loopback/repository';
+import {Filter, Where, repository} from '@loopback/repository';
 import {
   post,
   param,
@@ -8,14 +8,13 @@ import {
   del,
   requestBody
 } from '@loopback/openapi-v3';
-import {inject} from '@loopback/context';
 import {<%= modelName %>} from '../models';
 import {<%= repositoryName %>} from '../repositories';
 
 export class <%= name %>Controller {
 
   constructor(
-    @inject('repositories.<%= repositoryName %>')
+    @repository(<%= repositoryName %>)
     public <%= repositoryNameCamel %> : <%= repositoryName %>,
   ) {}
 

packages/cli/test/controller.js

@@ -281,10 +281,7 @@ describe('lb4 controller', () => {
     assert.fileContent(tmpDir + withInputName, /class FooBarController/);
 
     // Repository and injection
-    assert.fileContent(
-      tmpDir + withInputName,
-      /\@inject\('repositories.BarRepository'\)/
-    );
+    assert.fileContent(tmpDir + withInputName, /\@repository\(BarRepository\)/);
     assert.fileContent(
       tmpDir + withInputName,
       /barRepository \: BarRepository/

packages/repository/README.md

@@ -93,7 +93,7 @@ import {post, requestBody, get, param} from '@loopback/openapi-v3';
 export class NoteController {
   constructor(
     // Use constructor dependency injection to set up the repository
-    @repository(NoteRepository.name) public noteRepo: NoteRepository,
+    @repository(NoteRepository) public noteRepo: NoteRepository,
   ) {}
 
   // Create a new note

packages/repository/src/decorators/repository.ts

@@ -4,15 +4,27 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import * as assert from 'assert';
-import {Model, Entity} from '../model';
-import {Repository} from '../repository';
+import {Entity} from '../model';
 import {DataSource} from '../datasource';
 import {
   DefaultCrudRepository,
   DataSourceConstructor,
 } from '../legacy-juggler-bridge';
 import {juggler} from '../loopback-datasource-juggler';
 import {inject, Context, Injection} from '@loopback/context';
+import {Class} from '../common-types';
+import {Repository} from '../repository';
+import {Model} from '../model';
+
+/**
+ * Type definition for decorators returned by `@repository` decorator factory
+ */
+export type RepositoryDecorator = (
+  target: Object,
+  key?: string | symbol,
+  // tslint:disable-next-line:no-any
+  descriptorOrIndex?: TypedPropertyDescriptor<any> | number,
+) => void;
 
 /**
  * Metadata for a repository
@@ -42,7 +54,7 @@ export class RepositoryMetadata {
   /**
    * Constructor for RepositoryMetadata
    *
-   * @param model Name or class of the model. If the value is a string and
+   * @param modelOrRepo Name or class of the model. If the value is a string and
    * `dataSource` is not present, it will treated as the name of a predefined
    * repository
    * @param dataSource Name or instance of the data source
@@ -76,41 +88,85 @@ export class RepositoryMetadata {
 }
 
 /**
- * Decorator for model definitions
- * @param model Name of the repo or name/class of the model
- * @param dataSource Name or instance of the data source
- * @returns {(target:AnyType)}
+ * Decorator for repository injections on properties or method arguments
+ *
+ * ```ts
+ * class CustomerController {
+ *   @repository(CustomerRepository) public custRepo: CustomerRepository;
  *
- * For example:
+ *   constructor(
+ *     @repository(ProductRepository) public prodRepo: ProductRepository,
+ *   ) {}
+ *   // ...
+ * }
+ * ```
  *
- * - @repository('myCustomerRepo')
- * - @repository('Customer', 'mysqlDataSource')
- * - @repository(Customer, mysqlDataSource)
- * - @repository('Customer', mysqlDataSource)
- * - @repository(Customer, 'mysqlDataSource')
+ * @param repositoryName Name of the repo
  */
-export function repository<T extends Model>(
+export function repository(
+  repositoryName: string | Class<Repository<Model>>,
+): RepositoryDecorator;
+
+/**
+ * Decorator for DefaultCrudRepository generation and injection on properties
+ * or method arguments based on the given model and dataSource (or their names)
+ *
+ * ```ts
+ * class CustomerController {
+ *   @repository('Customer', 'mySqlDataSource')
+ *   public custRepo: DefaultCrudRepository<
+ *     Customer,
+ *     typeof Customer.prototype.id
+ *   >;
+ *
+ *   constructor(
+ *     @repository(Product, mySqlDataSource)
+ *     public prodRepo: DefaultCrudRepository<
+ *       Product,
+ *       typeof Product.prototype.id
+ *     >,
+ *   ) {}
+ *   // ...
+ * }
+ * ```
+ *
+ * @param model Name/class of the model
+ * @param dataSource Name/instance of the dataSource
+ */
+export function repository(
   model: string | typeof Entity,
+  dataSource: string | juggler.DataSource,
+): RepositoryDecorator;
+
+export function repository(
+  modelOrRepo: string | Class<Repository<Model>> | typeof Entity,
   dataSource?: string | juggler.DataSource,
 ) {
-  const meta = new RepositoryMetadata(model, dataSource);
+  const stringOrModel =
+    typeof modelOrRepo !== 'string' && modelOrRepo.prototype.execute
+      ? modelOrRepo.name
+      : (modelOrRepo as typeof Entity);
+  const meta = new RepositoryMetadata(stringOrModel, dataSource);
   return function(
     target: Object,
     key?: symbol | string,
-    descriptor?: TypedPropertyDescriptor<Repository<T>> | number,
+    // tslint:disable-next-line:no-any
+    descriptorOrIndex?: TypedPropertyDescriptor<any> | number,
   ) {
-    if (key || typeof descriptor === 'number') {
+    if (key || typeof descriptorOrIndex === 'number') {
       if (meta.name) {
         // Make it shortcut to `@inject('repositories.MyRepo')`
         // Please note key is undefined for constructor. If strictNullChecks
         // is true, the compiler will complain as reflect-metadata won't
         // accept undefined or null for key. Use ! to fool the compiler.
-        inject('repositories.' + meta.name, meta)(target, key!, descriptor);
+        inject('repositories.' + meta.name, meta)(
+          target,
+          key!,
+          descriptorOrIndex,
+        );
       } else {
         // Use repository-factory to create a repository from model + dataSource
-        // inject('repository-factory', meta)(target, key!, descriptor);
-        inject('', meta, resolve)(target, key!, descriptor);
-        // throw new Error('@repository(model, dataSource) is not implemented');
+        inject('', meta, resolve)(target, key!, descriptorOrIndex);
       }
       return;
     }