feat(security): add diagram

Author: jannyHou

greenkeeper.json

@@ -11,6 +11,21 @@ authorization.
 npm install --save @loopback/security
 ```
 
+## Overview
+
+- Subject
+  - It's the "who" for security
+  - contains a set of Principles, a set of Credentials, and a set of Permissions
+- Principle
+  - Represent a user, an application, or a device
+- Credential
+  - Security attributes used to authenticate the subject. Such credentials
+    include passwords, Kerberos tickets, and public key certificates.
+- Permission
+  - It's the `what` for security.
+
+![Overview](security-overview-diagram.png)
+
 ## Basic use
 
 ## Contributions

packages/security/README.md

@@ -4,4 +4,3 @@
 // License text available at https://opensource.org/licenses/MIT
 
 export * from './dist';
-

packages/security/index.d.ts

@@ -6,4 +6,3 @@
 // DO NOT EDIT THIS FILE
 // Add any additional (re)exports to src/index.ts instead.
 export * from './src';
-

packages/security/index.ts

@@ -1,13 +1,13 @@
 {
   "name": "@loopback/security",
-  "version": "1.0.0-1",
+  "version": "0.1.0",
   "description": "A LoopBack component for security support.",
   "engines": {
     "node": ">=8.9"
   },
   "scripts": {
     "acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
-    "build": "lb-tsc es2017 --outDir dist",
+    "build": "lb-tsc",
     "build:apidocs": "lb-apidocs",
     "clean": "lb-clean loopback-security*.tgz dist package api-docs",
     "integration": "lb-mocha \"dist/__tests__/integration/**/*.js\"",

packages/security/package-lock.json

@@ -17,7 +17,7 @@ export interface Principal {
    */
   [securityId]: string;
 
-  // tslint:disable-next-line:no-any
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   [attribute: string]: any;
 }
 
@@ -31,8 +31,14 @@ export class TypedPrincipal implements Principal {
   }
 }
 
+/**
+ * The minimum set of attributes that describe a user.
+ */
 export interface UserProfile extends Principal {
-  // basic user information
+  // `email` and `name` are added to be identical with the
+  // current `UserProfile` being exported from `@loopback/authentication`
+  email?: string;
+  name?: string;
 }
 
 export interface Organization extends Principal {}

packages/security/package.json

@@ -2,6 +2,7 @@
   "$schema": "http://json.schemastore.org/tsconfig",
   "extends": "@loopback/build/config/tsconfig.common.json",
   "compilerOptions": {
+    "outDir": "dist",
     "rootDir": "src"
   },
   "include": ["src"]