npm - @loopback/example-lb3-application - Versions diffs - 3.0.1 - Mend

@loopback/example-lb3-application 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (59) hide show

package/.prettierignore +2 -0
package/.prettierrc +7 -0
package/.vscode/settings.json +20 -0
package/.vscode/tasks.json +29 -0
package/CHANGELOG.md +626 -0
package/LICENSE +25 -0
package/README.md +560 -0
package/dist/__tests__/acceptance/home-page.acceptance.d.ts +1 -0
package/dist/__tests__/acceptance/home-page.acceptance.js +38 -0
package/dist/__tests__/acceptance/home-page.acceptance.js.map +1 -0
package/dist/__tests__/acceptance/lb3app.acceptance.d.ts +1 -0
package/dist/__tests__/acceptance/lb3app.acceptance.js +200 -0
package/dist/__tests__/acceptance/lb3app.acceptance.js.map +1 -0
package/dist/__tests__/acceptance/test-helper.d.ts +11 -0
package/dist/__tests__/acceptance/test-helper.js +33 -0
package/dist/__tests__/acceptance/test-helper.js.map +1 -0
package/dist/application.d.ts +187 -0
package/dist/application.js +41 -0
package/dist/application.js.map +1 -0
package/dist/index.d.ts +3 -0
package/dist/index.js +38 -0
package/dist/index.js.map +1 -0
package/dist/migrate.d.ts +1 -0
package/dist/migrate.js +25 -0
package/dist/migrate.js.map +1 -0
package/dist/openapi-spec.d.ts +1 -0
package/dist/openapi-spec.js +28 -0
package/dist/openapi-spec.js.map +1 -0
package/dist/sequence.d.ts +3 -0
package/dist/sequence.js +12 -0
package/dist/sequence.js.map +1 -0
package/dist/server.d.ts +15 -0
package/dist/server.js +58 -0
package/dist/server.js.map +1 -0
package/lb3app/common/models/coffee-shop.js +44 -0
package/lb3app/common/models/coffee-shop.json +30 -0
package/lb3app/server/boot/authentication.js +11 -0
package/lb3app/server/boot/create-sample-models.js +28 -0
package/lb3app/server/config.json +21 -0
package/lb3app/server/datasources.json +6 -0
package/lb3app/server/middleware.json +9 -0
package/lb3app/server/model-config.json +39 -0
package/lb3app/server/server.js +17 -0
package/lb3app/test/acceptance.js +107 -0
package/lb3app/test/authentication.js +135 -0
package/lb3app/test/integration.js +75 -0
package/package.json +78 -0
package/public/index.html +74 -0
package/public/lb3-index.html +5 -0
package/src/__tests__/acceptance/home-page.acceptance.ts +44 -0
package/src/__tests__/acceptance/lb3app.acceptance.ts +244 -0
package/src/__tests__/acceptance/test-helper.ts +40 -0
package/src/application.ts +44 -0
package/src/index.ts +35 -0
package/src/migrate.ts +25 -0
package/src/openapi-spec.ts +28 -0
package/src/sequence.ts +8 -0
package/src/server.ts +71 -0
package/tsconfig.json +36 -0

package/public/lb3-index.html ADDED Viewed

@@ -0,0 +1,5 @@
+<head><title>LoopBack</title></head>
+<body>
+    <h1>LoopBack Rocks!</h1>
+    <p>Hello World... </p>
+</body>

package/src/__tests__/acceptance/home-page.acceptance.ts ADDED Viewed

@@ -0,0 +1,44 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+import {Client} from '@loopback/testlab';
+import {ExpressServer} from '../../server';
+import {setupApplication} from './test-helper';
+describe('HomePage', () => {
+  let app: ExpressServer;
+  let client: Client;
+  before('setupApplication', async () => {
+    ({app, client} = await setupApplication());
+  });
+  after(async () => {
+    await app.stop();
+  });
+  it('exposes a default home page', async () => {
+    await client
+      .get('/')
+      .expect(200)
+      .expect('Content-Type', /text\/html/);
+  });
+  it('exposes self-hosted explorer', async () => {
+    await client
+      .get('/api/explorer/')
+      .expect(200)
+      .expect('Content-Type', /text\/html/)
+      .expect(/<title>LoopBack API Explorer/);
+  });
+  it('exposes LoopBack 3 home page', async () => {
+    await client
+      .get('/lb3-index.html')
+      .expect(200)
+      .expect('Content-Type', /text\/html/)
+      .expect(/<h1>LoopBack Rocks!/);
+  });
+});

package/src/__tests__/acceptance/lb3app.acceptance.ts ADDED Viewed

@@ -0,0 +1,244 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+import {OpenApiSpec} from '@loopback/rest';
+import {Client, expect} from '@loopback/testlab';
+import _ from 'lodash';
+import {ExpressServer} from '../../server';
+import {givenCoffeeShop, setupApplication} from './test-helper';
+const lb3App = require('../../../lb3app/server/server');
+describe('CoffeeShopApplication', () => {
+  let app: ExpressServer;
+  let client: Client;
+  before('setupApplication', async () => {
+    ({app, client} = await setupApplication());
+  });
+  after('closes application', async () => {
+    if (app) await app.stop();
+  });
+  context('basic REST calls for LoopBack 3 application', () => {
+    it('creates and finds a CoffeeShop', async () => {
+      const coffeeShop = givenCoffeeShop();
+      const response = await client
+        .post('/api/CoffeeShops')
+        .send(coffeeShop)
+        .expect(200);
+      expect(response.body).to.containDeep(
+        _.pick(coffeeShop, ['name', 'city']),
+      );
+      const result = await client.get(`/api/CoffeeShops/${response.body.id}`);
+      expect(result.body).to.containDeep(_.pick(coffeeShop, ['name', 'city']));
+    });
+    it("gets the CoffeeShop's status", async () => {
+      const response = await client.get('/api/CoffeeShops/status').expect(200);
+      expect(response.body.status).to.be.equalOneOf(
+        'We are open for business.',
+        'Sorry, we are closed. Open daily from 6am to 8pm.',
+      );
+    });
+    it('gets external route in application', async () => {
+      await client.get('/ping').expect(200, 'pong');
+    });
+  });
+  context('LoopBack 3 authentication', () => {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    let User: any;
+    before(() => {
+      User = lb3App.models.User;
+    });
+    it('creates a User and logs them in and out', async () => {
+      const user = await User.create({
+        email: 'created@email.com',
+        password: 'L00pBack!',
+      });
+      expect(user.email).to.eql('created@email.com');
+      const token = await User.login({
+        email: 'created@email.com',
+        password: 'L00pBack!',
+      });
+      expect(token).to.have.properties('ttl', 'userId', 'created', 'id');
+      expect(token.userId).to.eql(user.id);
+      await User.logout(token.id);
+    });
+    it('makes an authenticated request', async () => {
+      const token = await User.login({
+        email: 'created@email.com',
+        password: 'L00pBack!',
+      });
+      const response = await client
+        .get(`/api/CoffeeShops/greet?access_token=${token.id}`)
+        .expect(200);
+      expect(response.body.greeting).to.eql('Hello from this Coffee Shop');
+    });
+    it('rejects anonymous requests to protected endpoints', async () => {
+      await client.get('/api/CoffeeShops/greet').expect(401);
+    });
+    it("denies request made by another user's access token", async () => {
+      const users = await User.create([
+        {
+          email: 'original@email.com',
+          password: 'L00pBack!',
+        },
+        {
+          email: 'other@email.com',
+          password: 'L00pBack!',
+        },
+      ]);
+      const token = await User.login({
+        email: users[0].email,
+        password: 'L00pBack!',
+      });
+      const otherToken = await User.login({
+        email: users[1].email,
+        password: 'L00pBack!',
+      });
+      const response = await client
+        .get(`/api/Users/${users[0].id}?access_token=${token.id}`)
+        .expect(200);
+      expect(response.body).to.containEql({
+        email: users[0].email,
+        id: users[0].id,
+      });
+      await client
+        .get(`/api/Users/${users[0].id}?access_token=${otherToken.id}`)
+        .expect(401);
+    });
+  });
+  context('OpenAPI spec', () => {
+    let apiSpec: OpenApiSpec;
+    before(async () => {
+      apiSpec = await app.lbApp.restServer.getApiSpec();
+    });
+    it('has the same properties in both the LB3 and LB4 specs', () => {
+      const lb4SpecProperties = Object.keys(apiSpec);
+      expect(lb4SpecProperties).to.eql([
+        'openapi',
+        'info',
+        'paths',
+        'servers',
+        'components',
+        'tags',
+      ]);
+    });
+    it('uses OpenApi version 3', () => {
+      expect(apiSpec.openapi).to.eql('3.0.0');
+    });
+    it('transfers the tags from the LB3 spec to the LB4 spec', () => {
+      expect(apiSpec.tags).to.containDeep([
+        {name: 'User', description: undefined, externalDocs: undefined},
+        {name: 'CoffeeShop', description: undefined, externalDocs: undefined},
+      ]);
+    });
+    it('transfers the components from the LB3 spec to the LB4 spec', () => {
+      const components = apiSpec.components;
+      expect(components).to.have.properties('requestBodies', 'schemas');
+      expect(components!.requestBodies).to.containDeep({
+        CoffeeShop: {
+          content: {
+            'application/json': {
+              schema: {$ref: '#/components/schemas/CoffeeShop'},
+            },
+          },
+          description: 'Model instance data',
+        },
+      });
+      expect(components!.schemas).to.containDeep({
+        CoffeeShop: {
+          description: undefined,
+          properties: {
+            name: {type: 'string'},
+            city: {type: 'string'},
+            id: {type: 'number', format: 'double'},
+          },
+          required: ['name'],
+          additionalProperties: false,
+        },
+      });
+    });
+    it('appends the basePath and transfers the paths from the LB3 spec to the LB4 spec', () => {
+      const paths = Object.keys(apiSpec.paths);
+      expect(paths).to.have.length(32);
+      // some of the expected paths
+      expect(paths).to.containDeep([
+        '/Users/{id}/accessTokens/{fk}',
+        '/Users',
+        '/Users/{id}/exists',
+        '/Users/login',
+        '/CoffeeShops',
+        '/CoffeeShops/{id}',
+        '/CoffeeShops/greet',
+      ]);
+    });
+    it("transfers the path's details", () => {
+      const CoffeeShopsEndpoint = apiSpec.paths['/CoffeeShops'];
+      expect(CoffeeShopsEndpoint).to.have.properties([
+        'post',
+        'patch',
+        'put',
+        'get',
+      ]);
+      expect(CoffeeShopsEndpoint['post']).to.containDeep({
+        tags: ['CoffeeShop'],
+        summary:
+          'Create a new instance of the model and persist it into the data source.',
+        operationId: 'CoffeeShop.create',
+        requestBody: {$ref: '#/components/requestBodies/CoffeeShop'},
+        responses: {
+          '200': {
+            description: 'Request was successful',
+            content: {
+              'application/json': {
+                schema: {
+                  $ref: '#/components/schemas/CoffeeShop',
+                },
+              },
+            },
+          },
+        },
+        deprecated: false,
+      });
+    });
+  });
+});

package/src/__tests__/acceptance/test-helper.ts ADDED Viewed

@@ -0,0 +1,40 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+import {Client, givenHttpServerConfig, supertest} from '@loopback/testlab';
+import {ExpressServer} from '../../server';
+const lb3app = require('../../../lb3app/server/server');
+export async function setupApplication(): Promise<AppWithClient> {
+  const app = new ExpressServer({
+    rest: givenHttpServerConfig(),
+  });
+  await app.boot();
+  await app.start();
+  const client = supertest(app.url);
+  return {app, client};
+}
+export interface AppWithClient {
+  app: ExpressServer;
+  client: Client;
+}
+/**
+ * Generate a complete Coffee object for use with tests.
+ */
+export function givenCoffeeShop() {
+  const CoffeeShop = lb3app.models.CoffeeShop;
+  const data = {
+    name: 'Coffee Shop',
+    city: 'Toronto',
+  };
+  return new CoffeeShop(data);
+}

package/src/application.ts ADDED Viewed

@@ -0,0 +1,44 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+import {BootMixin} from '@loopback/boot';
+import {Lb3AppBooterComponent} from '@loopback/booter-lb3app';
+import {ApplicationConfig} from '@loopback/core';
+import {RepositoryMixin} from '@loopback/repository';
+import {RestApplication} from '@loopback/rest';
+import {RestExplorerComponent} from '@loopback/rest-explorer';
+import path from 'path';
+import {MySequence} from './sequence';
+export class CoffeeShopApplication extends BootMixin(
+  RepositoryMixin(RestApplication),
+) {
+  constructor(options: ApplicationConfig = {}) {
+    super(options);
+    // Set up the custom sequence
+    this.sequence(MySequence);
+    // Set up default home page
+    this.static('/', path.join(__dirname, '../public'));
+    this.component(RestExplorerComponent);
+    this.component(Lb3AppBooterComponent);
+    this.projectRoot = __dirname;
+    // Customize @loopback/boot Booter Conventions here
+    this.bootOptions = {
+      controllers: {
+        // Customize ControllerBooter Conventions here
+        dirs: ['controllers'],
+        extensions: ['.controller.js'],
+        nested: true,
+      },
+      lb3app: {
+        mode: 'fullApp',
+      },
+    };
+  }
+}

package/src/index.ts ADDED Viewed

@@ -0,0 +1,35 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+import {ApplicationConfig, ExpressServer} from './server';
+export * from './server';
+export async function main(options: ApplicationConfig = {}) {
+  const server = new ExpressServer(options);
+  await server.boot();
+  await server.start();
+  console.log(`Server is running at ${server.url}`);
+}
+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,
+      },
+      // Use the LB4 application as a route. It should not be listening.
+      listenOnStart: false,
+    },
+  };
+  main(config).catch(err => {
+    console.error('Cannot start the application.', err);
+    process.exit(1);
+  });
+}

package/src/migrate.ts ADDED Viewed

@@ -0,0 +1,25 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+import {ExpressServer} from './server';
+export async function migrate(args: string[]) {
+  const existingSchema = args.includes('--rebuild') ? 'drop' : 'alter';
+  console.log('Migrating schemas (%s existing schema)', existingSchema);
+  const server = new ExpressServer();
+  await server.boot();
+  await server.lbApp.migrateSchema({existingSchema});
+  // Connectors usually keep a pool of opened connections,
+  // this keeps the process running even after all work is done.
+  // We need to exit explicitly.
+  process.exit(0);
+}
+migrate(process.argv).catch(err => {
+  console.error('Cannot migrate database schema', err);
+  process.exit(1);
+});

package/src/openapi-spec.ts ADDED Viewed

@@ -0,0 +1,28 @@
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+import {ApplicationConfig} from '@loopback/core';
+import {CoffeeShopApplication} from './application';
+/**
+ * Export the OpenAPI spec from the application
+ */
+async function exportOpenApiSpec(): Promise<void> {
+  const config: ApplicationConfig = {
+    rest: {
+      port: +(process.env.PORT ?? 3000),
+      host: process.env.HOST ?? 'localhost',
+    },
+  };
+  const outFile = process.argv[2] ?? '';
+  const app = new CoffeeShopApplication(config);
+  await app.boot();
+  await app.exportOpenApiSpec(outFile);
+}
+exportOpenApiSpec().catch(err => {
+  console.error('Fail to export OpenAPI spec from the application.', err);
+  process.exit(1);
+});