@loopback/example-hello-world 3.0.1

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2018,2019.
+Node module: @loopback/example-hello-world
+This project is licensed under the MIT License, full text below.
+
+--------
+
+MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# @loopback/example-hello-world
+
+A simple hello-world application using LoopBack 4!
+
+## Summary
+
+This project shows how to write the simplest LoopBack 4 application possible.
+Check out
+[src/application.ts](https://github.com/loopbackio/loopback-next/blob/master/examples/hello-world/src/application.ts)
+to learn how we configured our application to always respond with "Hello
+World!".
+
+## Prerequisites
+
+Before we can begin, you'll need to make sure you have some things installed:
+
+- [Node.js](https://nodejs.org/en/) at v10 or greater
+
+Additionally, this tutorial assumes that you are comfortable with certain
+technologies, languages and concepts.
+
+- JavaScript (ES6)
+- [npm](https://www.npmjs.com/)
+- [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)
+
+## Installation
+
+1.  Install the new loopback CLI toolkit.
+
+```sh
+npm i -g @loopback/cli
+```
+
+2.  Download the "hello-world" application.
+
+```sh
+lb4 example hello-world
+```
+
+3.  Switch to the directory.
+
+```sh
+cd loopback4-example-hello-world
+```
+
+## Use
+
+Start the app:
+
+```sh
+npm start
+```
+
+The application will start on port `3000`. Use your favourite browser or REST
+client to access any path with a GET request, and watch it return
+`Hello world!`.
+
+## Contributions
+
+- [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
+
+## Tests
+
+Run `npm test` from the root folder.
+
+## Contributors
+
+See
+[all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors).
+
+## License
+
+MIT

package/dist/__tests__/acceptance/application.acceptance.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/acceptance/application.acceptance.js

@@ -0,0 +1,31 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-hello-world
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const testlab_1 = require("@loopback/testlab");
+const application_1 = require("../../application");
+describe('Application', () => {
+    let app;
+    let client;
+    before(givenAnApplication);
+    before(async () => {
+        await app.start();
+        client = testlab_1.createRestAppClient(app);
+    });
+    after(async () => {
+        await app.stop();
+    });
+    it('responds with hello world', async () => {
+        const response = await client.get('/').expect(200);
+        testlab_1.expect(response.text).to.eql('Hello World!');
+    });
+    function givenAnApplication() {
+        app = new application_1.HelloWorldApplication({
+            rest: testlab_1.givenHttpServerConfig(),
+            disableConsoleLog: true,
+        });
+    }
+});
+//# sourceMappingURL=application.acceptance.js.map

package/dist/__tests__/acceptance/application.acceptance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.acceptance.js","sourceRoot":"","sources":["../../../src/__tests__/acceptance/application.acceptance.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,6CAA6C;AAC7C,+CAA+C;AAC/C,gEAAgE;;AAEhE,+CAK2B;AAC3B,mDAAwD;AAExD,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAI,GAA0B,CAAC;IAC/B,IAAI,MAAc,CAAC;IAEnB,MAAM,CAAC,kBAAkB,CAAC,CAAC;IAC3B,MAAM,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;QAClB,MAAM,GAAG,6BAAmB,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,KAAK,IAAI,EAAE;QACf,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnD,gBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,SAAS,kBAAkB;QACzB,GAAG,GAAG,IAAI,mCAAqB,CAAC;YAC9B,IAAI,EAAE,+BAAqB,EAAE;YAC7B,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC;IACL,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/application.d.ts

@@ -0,0 +1,7 @@
+import { ApplicationConfig } from '@loopback/core';
+import { RestApplication } from '@loopback/rest';
+export { ApplicationConfig };
+export declare class HelloWorldApplication extends RestApplication {
+    constructor(options?: ApplicationConfig);
+    start(): Promise<void>;
+}

package/dist/application.js

@@ -0,0 +1,30 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/example-hello-world
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HelloWorldApplication = void 0;
+const rest_1 = require("@loopback/rest");
+class HelloWorldApplication extends rest_1.RestApplication {
+    constructor(options = {}) {
+        super(options);
+        // In this example project, we configure a sequence that always
+        // returns the same HTTP response: Hello World!
+        // Learn more about the concept of Sequence in our docs:
+        //   http://loopback.io/doc/en/lb4/Sequence.html
+        this.handler(({ response }, sequence) => {
+            sequence.send(response, 'Hello World!');
+        });
+    }
+    async start() {
+        var _a;
+        await super.start();
+        if (!((_a = this.options) === null || _a === void 0 ? void 0 : _a.disableConsoleLog)) {
+            const rest = await this.getServer(rest_1.RestServer);
+            console.log(`REST server running on port: ${await rest.get('rest.port')}`);
+        }
+    }
+}
+exports.HelloWorldApplication = HelloWorldApplication;
+//# sourceMappingURL=application.js.map

package/dist/application.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"application.js","sourceRoot":"","sources":["../src/application.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,6CAA6C;AAC7C,+CAA+C;AAC/C,gEAAgE;;;AAGhE,yCAA2D;AAG3D,MAAa,qBAAsB,SAAQ,sBAAe;IACxD,YAAY,UAA6B,EAAE;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,+DAA+D;QAC/D,+CAA+C;QAC/C,wDAAwD;QACxD,gDAAgD;QAChD,IAAI,CAAC,OAAO,CAAC,CAAC,EAAC,QAAQ,EAAC,EAAE,QAAQ,EAAE,EAAE;YACpC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,KAAK;;QACT,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QAEpB,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,iBAAiB,CAAA,EAAE;YACpC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,iBAAU,CAAC,CAAC;YAC9C,OAAO,CAAC,GAAG,CACT,gCAAgC,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE,CAC9D,CAAC;SACH;IACH,CAAC;CACF;AAvBD,sDAuBC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { ApplicationConfig, HelloWorldApplication } from './application';
+export declare function main(config: ApplicationConfig): Promise<HelloWorldApplication>;

package/dist/index.js

@@ -0,0 +1,33 @@
+"use strict";
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/example-hello-world
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const application_1 = require("./application");
+async function main(config) {
+    const app = new application_1.HelloWorldApplication();
+    await app.start();
+    return app;
+}
+exports.main = main;
+if (require.main === module) {
+    // Run the application
+    const config = {
+        rest: {
+            port: +((_a = process.env.PORT) !== null && _a !== void 0 ? _a : 3000),
+            host: (_b = process.env.HOST) !== null && _b !== void 0 ? _b : 'localhost',
+            openApiSpec: {
+                // useful when used with OpenAPI-to-GraphQL to locate your application
+                setServersFromRequest: true,
+            },
+        },
+    };
+    main(config).catch(err => {
+        console.error('Cannot start the application.', err);
+        process.exit(1);
+    });
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,6CAA6C;AAC7C,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,+CAAuE;AAEhE,KAAK,UAAU,IAAI,CAAC,MAAyB;IAClD,MAAM,GAAG,GAAG,IAAI,mCAAqB,EAAE,CAAC;IACxC,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;IAClB,OAAO,GAAG,CAAC;AACb,CAAC;AAJD,oBAIC;AAED,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE;IAC3B,sBAAsB;IACtB,MAAM,MAAM,GAAG;QACb,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,CAAC,MAAA,OAAO,CAAC,GAAG,CAAC,IAAI,mCAAI,IAAI,CAAC;YACjC,IAAI,EAAE,MAAA,OAAO,CAAC,GAAG,CAAC,IAAI,mCAAI,WAAW;YACrC,WAAW,EAAE;gBACX,sEAAsE;gBACtE,qBAAqB,EAAE,IAAI;aAC5B;SACF;KACF,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;QACvB,OAAO,CAAC,KAAK,CAAC,+BAA+B,EAAE,GAAG,CAAC,CAAC;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;CACJ"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@loopback/example-hello-world",
+  "description": "A simple hello-world Application using LoopBack 4",
+  "version": "3.0.1",
+  "keywords": [
+    "loopback",
+    "LoopBack",
+    "example",
+    "tutorial"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp.",
+  "copyright.owner": "IBM Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "examples/hello-world"
+  },
+  "engines": {
+    "node": "^10.16 || 12 || 14 || 16"
+  },
+  "scripts": {
+    "acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
+    "build": "lb-tsc",
+    "build:watch": "lb-tsc --watch",
+    "clean": "lb-clean *example-hello-world*.tgz dist *.tsbuildinfo package",
+    "verify": "npm pack && tar xf *example-hello-world*.tgz && tree package && npm run clean",
+    "lint": "npm run prettier:check && npm run eslint",
+    "lint:fix": "npm run eslint:fix && npm run prettier:fix",
+    "prettier:cli": "lb-prettier \"**/*.ts\" \"**/*.js\"",
+    "prettier:check": "npm run prettier:cli -- -l",
+    "prettier:fix": "npm run prettier:cli -- --write",
+    "eslint": "lb-eslint --report-unused-disable-directives .",
+    "eslint:fix": "npm run eslint -- --fix",
+    "pretest": "npm run rebuild",
+    "test": "lb-mocha --allow-console-logs \"dist/__tests__/**/*.js\"",
+    "posttest": "npm run lint",
+    "test:dev": "lb-mocha --allow-console-logs dist/__tests__/**/*.js && npm run posttest",
+    "rebuild": "npm run clean && npm run build",
+    "prestart": "npm run rebuild",
+    "start": "node ."
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@loopback/core": "^2.17.0",
+    "@loopback/rest": "^10.0.1",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@loopback/build": "^7.0.1",
+    "@loopback/eslint-config": "^11.0.1",
+    "@loopback/testlab": "^3.4.3",
+    "@types/node": "^10.17.60",
+    "eslint": "^7.32.0",
+    "typescript": "~4.3.5"
+  },
+  "gitHead": "1df36bb1ee2e513d9e197bd6010c4cfb296d50b8"
+}

package/src/__tests__/acceptance/application.acceptance.ts

@@ -0,0 +1,38 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-hello-world
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {
+  Client,
+  createRestAppClient,
+  expect,
+  givenHttpServerConfig,
+} from '@loopback/testlab';
+import {HelloWorldApplication} from '../../application';
+
+describe('Application', () => {
+  let app: HelloWorldApplication;
+  let client: Client;
+
+  before(givenAnApplication);
+  before(async () => {
+    await app.start();
+    client = createRestAppClient(app);
+  });
+  after(async () => {
+    await app.stop();
+  });
+
+  it('responds with hello world', async () => {
+    const response = await client.get('/').expect(200);
+    expect(response.text).to.eql('Hello World!');
+  });
+
+  function givenAnApplication() {
+    app = new HelloWorldApplication({
+      rest: givenHttpServerConfig(),
+      disableConsoleLog: true,
+    });
+  }
+});

package/src/application.ts

@@ -0,0 +1,33 @@
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/example-hello-world
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {ApplicationConfig} from '@loopback/core';
+import {RestApplication, RestServer} from '@loopback/rest';
+export {ApplicationConfig};
+
+export class HelloWorldApplication extends RestApplication {
+  constructor(options: ApplicationConfig = {}) {
+    super(options);
+
+    // In this example project, we configure a sequence that always
+    // returns the same HTTP response: Hello World!
+    // Learn more about the concept of Sequence in our docs:
+    //   http://loopback.io/doc/en/lb4/Sequence.html
+    this.handler(({response}, sequence) => {
+      sequence.send(response, 'Hello World!');
+    });
+  }
+
+  async start() {
+    await super.start();
+
+    if (!this.options?.disableConsoleLog) {
+      const rest = await this.getServer(RestServer);
+      console.log(
+        `REST server running on port: ${await rest.get('rest.port')}`,
+      );
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,30 @@
+// Copyright IBM Corp. 2018,2020. All Rights Reserved.
+// Node module: @loopback/example-hello-world
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {ApplicationConfig, HelloWorldApplication} from './application';
+
+export async function main(config: ApplicationConfig) {
+  const app = new HelloWorldApplication();
+  await app.start();
+  return app;
+}
+
+if (require.main === module) {
+  // Run the application
+  const config = {
+    rest: {
+      port: +(process.env.PORT ?? 3000),
+      host: process.env.HOST ?? 'localhost',
+      openApiSpec: {
+        // useful when used with OpenAPI-to-GraphQL to locate your application
+        setServersFromRequest: true,
+      },
+    },
+  };
+  main(config).catch(err => {
+    console.error('Cannot start the application.', err);
+    process.exit(1);
+  });
+}

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "@loopback/build/config/tsconfig.common.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "composite": true
+  },
+  "include": [
+    "src/**/*",
+    "src/**/*.json"
+  ],
+  "references": [
+    {
+      "path": "../../packages/core/tsconfig.json"
+    },
+    {
+      "path": "../../packages/rest/tsconfig.json"
+    },
+    {
+      "path": "../../packages/testlab/tsconfig.json"
+    }
+  ]
+}