revert(example-getting-started): sync code and docs

This reverts commit ae1a7f8.

Author: virkt25

packages/example-getting-started/docs/controller.md

@@ -10,8 +10,8 @@ logic will live_!
 
 ### Create your controller
 
-So, let's create a controller to handle our Todo routes. Inside the
-`src/controllers` directory create the following two files:
+So, let's create a controller to handle our Todo routes. Create the
+`src/controllers` directory and two files inside:
 - `index.ts` (export helper)
 - `todo.controller.ts`
 
@@ -25,7 +25,7 @@ repository, which we'll use to perform our operations against the datasource.
 #### src/controllers/todo.controller.ts
 ```ts
 import {repository} from '@loopback/repository';
-import {TodoRepository} from '../repositories';
+import {TodoRepository} from '../repositories/index';
 
 export class TodoController {
   constructor(
@@ -51,10 +51,11 @@ Now that we have the repository wireup, let's create our first handler function.
 
 #### src/controllers/todo.controller.ts
 ```ts
-import {repository} from '@loopback/repository';
-import {TodoRepository} from '../repositories';
+import {post, param} from '@loopback/openapi-v3';
+import {HttpErrors} from '@loopback/rest';
 import {Todo} from '../models';
-import {HttpErrors, post, param, requestBody} from '@loopback/rest';
+import {repository} from '@loopback/repository';
+import {TodoRepository} from '../repositories/index';
 
 export class TodoController {
   constructor(
@@ -93,36 +94,29 @@ verbs:
 
 #### src/controllers/todo.controller.ts
 ```ts
-import {repository} from '@loopback/repository';
-import {TodoRepository} from '../repositories';
+import {post, param, requestBody, get, put, patch, del} from '@loopback/openapi-v3';
+import {HttpErrors} from '@loopback/rest';
 import {Todo} from '../models';
-import {
-  HttpErrors,
-  post,
-  param,
-  requestBody,
-  get,
-  put,
-  patch,
-  del,
-} from '@loopback/rest';
+import {repository} from '@loopback/repository';
+import {TodoRepository} from '../repositories/index';
 
 export class TodoController {
   constructor(
     @repository(TodoRepository.name) protected todoRepo: TodoRepository,
   ) {}
 
   @post('/todo')
-  async createTodo(@requestBody() todo: Todo) {
+  async createTodo(@requestBody()todo: Todo) {
     if (!todo.title) {
       return Promise.reject(new HttpErrors.BadRequest('title is required'));
     }
     return await this.todoRepo.create(todo);
   }
 
   @get('/todo/{id}')
-  async findTodoById(@param.path.number('id') id: number): Promise<Todo> {
-    id = +id;
+  async findTodoById(
+    @param.path.number('id') id: number, 
+    @param.query.boolean('items') items?: boolean): Promise<Todo> {
     return await this.todoRepo.findById(id);
   }
 
@@ -134,18 +128,14 @@ export class TodoController {
   @put('/todo/{id}')
   async replaceTodo(
     @param.path.number('id') id: number,
-    @requestBody() todo: Todo,
-  ): Promise<boolean> {
-    id = +id;
+    @requestBody() todo: Todo): Promise<boolean> {
     return await this.todoRepo.replaceById(id, todo);
   }
 
   @patch('/todo/{id}')
   async updateTodo(
     @param.path.number('id') id: number,
-    @requestBody() todo: Todo,
-  ): Promise<boolean> {
-    id = +id;
+    @requestBody() todo: Todo): Promise<boolean> {
     return await this.todoRepo.updateById(id, todo);
   }
 
@@ -160,7 +150,7 @@ Some additional things to note about this example:
 - Routes like `@get('/todo/{id}')` can be paired with the `@param.path`
 decorators to inject those values at request time into the handler function.
 - LoopBack's `@param` decorator also contains a namespace full of other
-"subdecorators" like `@param.path`, `@param.query`, and `@param.header` that
+"subdecorators" like `@param.path`, `@param.query`, and `@param.body` that
 allow specification of metadata for those parts of a REST request.
 - LoopBack's `@param.path` and `@param.query` also provide subdecorators for
 specifying the type of certain value primitives, such as

packages/example-getting-started/docs/datasource.md

@@ -26,7 +26,8 @@ of this tutorial, we'll be using the memory connector provided with the Juggler.
 }
 ```
 
-Inside the `src/datasources` directory create a new file called `db.datasource.ts`. This file will create
+Create another folder called `datasources` in the `src` directory, and inside
+that folder, create a new file called `db.datasource.ts`. This file will create
 a strongly-typed export of our datasource using the `DataSourceConstructor`,
 which we can consume in our application via injection.
 

packages/example-getting-started/docs/juggler.md

@@ -20,29 +20,24 @@ the `RepositoryMixin`:
 #### src/application.ts
 ```ts
 import {ApplicationConfig} from '@loopback/core';
-import {RestApplication, RestServer} from '@loopback/rest';
-import {MySequence} from './sequence';
+import {RestApplication} from '@loopback/rest';
 
 /* tslint:disable:no-unused-variable */
+// Do not remove!
+// Class and Repository imports required to infer types in consuming code!
 // Binding and Booter imports are required to infer types for BootMixin!
 import {BootMixin, Booter, Binding} from '@loopback/boot';
 import {
   Class,
   Repository,
   RepositoryMixin,
-  juggler,
 } from '@loopback/repository';
 /* tslint:enable:no-unused-variable */
-
-export class TodoListApplication extends BootMixin(
+export class TodoApplication extends BootMixin(
   RepositoryMixin(RestApplication),
 ) {
   constructor(options?: ApplicationConfig) {
     super(options);
-
-    // Set up the custom sequence
-    this.sequence(MySequence);
-
     this.projectRoot = __dirname;
     // Customize @loopback/boot Booter Conventions here
     this.bootOptions = {
@@ -54,15 +49,6 @@ export class TodoListApplication extends BootMixin(
       },
     };
   }
-
-  async start() {
-    await super.start();
-
-    const server = await this.getServer(RestServer);
-    const port = await server.get('rest.port');
-    console.log(`Server is running at http://127.0.0.1:${port}`);
-    console.log(`Try http://127.0.0.1:${port}/ping`);
-  }
 }
 ```
 

packages/example-getting-started/docs/model.md

@@ -26,7 +26,8 @@ For our Todo model to represent our Todo instances, it will need:
 - a description that details what the todo is all about
 - a boolean flag for whether or not we've completed the task
 
-Inside the `src/models` folder, create two files:
+Create another folder in `src` called `models` and inside of that folder,
+create two files:
 - `index.ts`
 - `todo.model.ts`
 

packages/example-getting-started/docs/putting-it-together.md

@@ -26,31 +26,26 @@ other artifacts and inject them into our application for use.
 #### src/application.ts
 ```ts
 import {ApplicationConfig} from '@loopback/core';
-import {RestApplication, RestServer} from '@loopback/rest';
-import {MySequence} from './sequence';
+import {RestApplication} from '@loopback/rest';
 import {db} from './datasources/db.datasource';
 
 /* tslint:disable:no-unused-variable */
+// Do not remove!
+// Class and Repository imports required to infer types in consuming code!
 // Binding and Booter imports are required to infer types for BootMixin!
 import {BootMixin, Booter, Binding} from '@loopback/boot';
 import {
   Class,
   Repository,
   RepositoryMixin,
-  juggler,
-  DataSourceConstructor,
 } from '@loopback/repository';
 /* tslint:enable:no-unused-variable */
 
-export class TodoListApplication extends BootMixin(
+export class TodoApplication extends BootMixin(
   RepositoryMixin(RestApplication),
 ) {
   constructor(options?: ApplicationConfig) {
     super(options);
-
-    // Set up the custom sequence
-    this.sequence(MySequence);
-
     this.projectRoot = __dirname;
     // Customize @loopback/boot Booter Conventions here
     this.bootOptions = {
@@ -61,7 +56,6 @@ export class TodoListApplication extends BootMixin(
         nested: true,
       },
     };
-
     this.setupDatasources();
   }
 
@@ -74,17 +68,7 @@ export class TodoListApplication extends BootMixin(
         : db;
     this.bind('datasource').to(datasource);
   }
-
-  async start() {
-    await super.start();
-
-    const server = await this.getServer(RestServer);
-    const port = await server.get('rest.port');
-    console.log(`Server is running at http://127.0.0.1:${port}`);
-    console.log(`Try http://127.0.0.1:${port}/ping`);
-  }
-}
-
+}}
 ```
 
 ### Try it out

packages/example-getting-started/docs/repository.md

@@ -8,7 +8,8 @@ layer.
 
 ### Create your repository
 
-In the `src/repositories` directory create two files:
+Create another folder in `src` called `repositories` and inside of that folder,
+create two files:
 - `index.ts` (our export helper)
 - `todo.repository.ts`
 

packages/example-getting-started/docs/scaffolding.md

@@ -8,7 +8,7 @@ To generate your application using the toolkit, run the `lb4 app` command
 and fill out the on-screen prompts:
 ```
 $ lb4 app
-? Project name: todo-list
+? Project name: (todo-list)
 ? Project description: A todo list API made with LoopBack 4.
 ? Project root directory: (todo-list)
 ? Application class name: (TodoListApplication)

packages/example-getting-started/src/application.ts

@@ -5,51 +5,39 @@
 
 import {ApplicationConfig} from '@loopback/core';
 import {RestApplication} from '@loopback/rest';
-import {MySequence} from './sequence';
 import {db} from './datasources/db.datasource';
 
 /* tslint:disable:no-unused-variable */
+// Do not remove!
+// Class and Repository imports required to infer types in consuming code!
 // Binding and Booter imports are required to infer types for BootMixin!
 import {BootMixin, Booter, Binding} from '@loopback/boot';
 import {
   Class,
   Repository,
+  DataSourceConstructor,
   RepositoryMixin,
   juggler,
-  DataSourceConstructor,
 } from '@loopback/repository';
 /* tslint:enable:no-unused-variable */
 
-export class TodoListApplication extends BootMixin(
+export class TodoApplication extends BootMixin(
   RepositoryMixin(RestApplication),
 ) {
   constructor(options?: ApplicationConfig) {
     super(options);
-
-    // Set up the custom sequence
-    this.sequence(MySequence);
-
     this.projectRoot = __dirname;
-    // Customize @loopback/boot Booter Conventions here
-    this.bootOptions = {
-      controllers: {
-        // Customize ControllerBooter Conventions here
-        dirs: ['controllers'],
-        extensions: ['.controller.js'],
-        nested: true,
-      },
-    };
-
-    this.setupDatasources();
+    this.setupDataSources();
   }
 
-  setupDatasources() {
-    // This will allow you to test your application without needing to
-    // use the "real" datasource!
+  // Helper functions (just to keep things organized)
+  setupDataSources() {
+    // TODO(bajtos) Automate datasource and repo registration via @loopback/boot
+    // See https://github.com/strongloop/loopback-next/issues/441
     const datasource =
       this.options && this.options.datasource
         ? new DataSourceConstructor(this.options.datasource)
         : db;
-    this.bind('datasource').to(datasource);
+    this.dataSource(datasource);
   }
 }

packages/example-getting-started/src/controllers/todo.controller.ts

@@ -1,16 +1,16 @@
-import {repository} from '@loopback/repository';
-import {TodoRepository} from '../repositories';
-import {Todo} from '../models';
 import {
-  HttpErrors,
   post,
   param,
-  requestBody,
   get,
   put,
   patch,
   del,
-} from '@loopback/rest';
+  requestBody,
+} from '@loopback/openapi-v3';
+import {HttpErrors} from '@loopback/rest';
+import {Todo} from '../models';
+import {repository} from '@loopback/repository';
+import {TodoRepository} from '../repositories';
 
 export class TodoController {
   // TODO(bajtos) Fix documentation (and argument names?) of @repository()
@@ -35,7 +35,6 @@ export class TodoController {
     @param.path.number('id') id: number,
     @param.query.boolean('items') items?: boolean,
   ): Promise<Todo> {
-    id = +id;
     return await this.todoRepo.findById(id);
   }
 

packages/example-getting-started/src/index.ts

@@ -3,12 +3,11 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {TodoListApplication} from './application';
-import {ApplicationConfig} from '@loopback/core';
+import {TodoApplication} from './application';
 import {RestServer} from '@loopback/rest';
 
-export async function main(options?: ApplicationConfig) {
-  const app = new TodoListApplication(options);
+export async function main() {
+  const app = new TodoApplication();
   try {
     await app.boot();
     await app.start();