@loopback/example-greeting-app 3.0.1

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) IBM Corp. 2019.
+Node module: @loopback/example-greeting-app
+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,61 @@
+# @loopback/example-greeting-app
+
+This application is built on top of
+[`@loopback/example-greeter-extension`](https://github.com/loopbackio/loopback-next/tree/master/examples/greeter-extension).
+
+## Compose the application
+
+1. Add REST API
+
+   - GreetingController - providing endpoints over `GreetingService`
+
+2. Add caching
+
+   - CachingService - implementing cache operations, such as set,get, delete,
+     and sweep
+   - CachingInterceptor - intercepting http requests to apply caching
+   - CacheObserver - watching and sweeping cache in the background
+
+![greeting-app](./greeting-app.png)
+
+## Contributions
+
+- [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
+
+## Try out
+
+Run `npm start`:
+
+The service is running at http://127.0.0.1:3000/greet/world.
+
+Open your browser to try the REST APIs. You can replace `world` with other
+names.
+
+The following `curl` command sets `Accept-Language` header to `zh` to receive
+the greeting in Chinese.
+
+```sh
+curl -H 'Accept-Language: zh' http://127.0.0.1:3000/greet/Ray
+```
+
+```json
+{
+  "timestamp": "2019-05-29T22:48:03.040Z",
+  "language": "zh",
+  "greeting": "Ray，你好！"
+}
+```
+
+## 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__/integration/greeting-service.integration.d.ts

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

package/dist/__tests__/integration/greeting-service.integration.js

@@ -0,0 +1,68 @@
+"use strict";
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/example-greeting-app
+// 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 util_1 = require("util");
+const __1 = require("../..");
+const keys_1 = require("../../keys");
+describe('GreetingApplication', () => {
+    let app;
+    let client;
+    before(givenRunningApplicationWithCustomConfiguration);
+    after(() => app.stop());
+    before(() => {
+        client = testlab_1.createRestAppClient(app);
+    });
+    it('gets a greeting in English', async function () {
+        const response = await client
+            .get('/greet/Raymond')
+            .set('Accept-Language', 'en')
+            .expect(200);
+        testlab_1.expect(response.body).to.containEql({
+            language: 'en',
+            greeting: 'Hello, Raymond!',
+        });
+    });
+    it('gets a greeting in Chinese', async function () {
+        const response = await client
+            .get('/greet/Raymond')
+            .set('Accept-Language', 'zh')
+            .expect(200);
+        testlab_1.expect(response.body).to.containEql({
+            language: 'zh',
+            greeting: 'Raymond，你好！',
+        });
+    });
+    it('gets a greeting from cache', async function () {
+        app.configure(keys_1.CACHING_SERVICE).to({ ttl: 100 });
+        let response = await client
+            .get('/greet/Raymond')
+            .set('Accept-Language', 'en')
+            .expect(200);
+        const msg1 = response.body;
+        // Now the result should be cached
+        response = await client
+            .get('/greet/Raymond')
+            .set('Accept-Language', 'en')
+            .expect(200);
+        testlab_1.expect(response.body).to.eql(msg1);
+        // Cache should be expired now
+        await util_1.promisify(setTimeout)(200);
+        response = await client
+            .get('/greet/Raymond')
+            .set('Accept-Language', 'en')
+            .expect(200);
+        testlab_1.expect(response.body.timestamp).to.not.eql(msg1.timestamp);
+    });
+    async function givenRunningApplicationWithCustomConfiguration() {
+        app = new __1.GreetingApplication({
+            rest: testlab_1.givenHttpServerConfig(),
+        });
+        // Start Application
+        await app.main();
+    }
+});
+//# sourceMappingURL=greeting-service.integration.js.map

package/dist/__tests__/integration/greeting-service.integration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"greeting-service.integration.js","sourceRoot":"","sources":["../../../src/__tests__/integration/greeting-service.integration.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8CAA8C;AAC9C,+CAA+C;AAC/C,gEAAgE;;AAEhE,+CAK2B;AAC3B,+BAA+B;AAC/B,6BAA0C;AAC1C,qCAA2C;AAE3C,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACnC,IAAI,GAAwB,CAAC;IAC7B,IAAI,MAAc,CAAC;IAEnB,MAAM,CAAC,8CAA8C,CAAC,CAAC;IACvD,KAAK,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;IAExB,MAAM,CAAC,GAAG,EAAE;QACV,MAAM,GAAG,6BAAmB,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK;QACpC,MAAM,QAAQ,GAAG,MAAM,MAAM;aAC1B,GAAG,CAAC,gBAAgB,CAAC;aACrB,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC;aAC5B,MAAM,CAAC,GAAG,CAAC,CAAC;QACf,gBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC;YAClC,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,iBAAiB;SAC5B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK;QACpC,MAAM,QAAQ,GAAG,MAAM,MAAM;aAC1B,GAAG,CAAC,gBAAgB,CAAC;aACrB,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC;aAC5B,MAAM,CAAC,GAAG,CAAC,CAAC;QACf,gBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC;YAClC,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,aAAa;SACxB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK;QACpC,GAAG,CAAC,SAAS,CAAC,sBAAe,CAAC,CAAC,EAAE,CAAC,EAAC,GAAG,EAAE,GAAG,EAAC,CAAC,CAAC;QAC9C,IAAI,QAAQ,GAAG,MAAM,MAAM;aACxB,GAAG,CAAC,gBAAgB,CAAC;aACrB,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC;aAC5B,MAAM,CAAC,GAAG,CAAC,CAAC;QACf,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC3B,kCAAkC;QAClC,QAAQ,GAAG,MAAM,MAAM;aACpB,GAAG,CAAC,gBAAgB,CAAC;aACrB,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC;aAC5B,MAAM,CAAC,GAAG,CAAC,CAAC;QACf,gBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACnC,8BAA8B;QAC9B,MAAM,gBAAS,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC;QACjC,QAAQ,GAAG,MAAM,MAAM;aACpB,GAAG,CAAC,gBAAgB,CAAC;aACrB,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC;aAC5B,MAAM,CAAC,GAAG,CAAC,CAAC;QACf,gBAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,KAAK,UAAU,8CAA8C;QAC3D,GAAG,GAAG,IAAI,uBAAmB,CAAC;YAC5B,IAAI,EAAE,+BAAqB,EAAE;SAC9B,CAAC,CAAC;QAEH,oBAAoB;QACpB,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IACnB,CAAC;AACH,CAAC,CAAC,CAAC"}

package/dist/application.d.ts

@@ -0,0 +1,98 @@
+import { ApplicationConfig } from '@loopback/core';
+import { RestApplication } from '@loopback/rest';
+declare const GreetingApplication_base: (new (...args: any[]) => {
+    projectRoot: string;
+    bootOptions?: import("@loopback/boot").BootOptions | undefined;
+    booted: boolean;
+    start(): Promise<void>;
+    boot(): Promise<void>;
+    booters(...booterCls: import("@loopback/core").Constructor<import("@loopback/boot").Booter>[]): import("@loopback/boot").Binding<any>[];
+    applicationBooter(subApp: import("@loopback/core").Application & import("@loopback/boot").Bootable, filter?: import("@loopback/core").BindingFilter | undefined): import("@loopback/boot").Binding<import("@loopback/boot").Booter>;
+    component<C extends import("@loopback/core").Component = import("@loopback/core").Component>(componentCtor: import("@loopback/core").Constructor<C>, nameOrOptions?: string | import("@loopback/core").BindingFromClassOptions | undefined): import("@loopback/boot").Binding<C>;
+    mountComponentBooters(componentInstanceOrClass: import("@loopback/core").Constructor<unknown> | import("@loopback/boot").InstanceWithBooters): void;
+    readonly options: ApplicationConfig;
+    readonly state: string;
+    controller: <T_1>(controllerCtor: import("@loopback/core").ControllerClass<T_1>, nameOrOptions?: string | import("@loopback/core").BindingFromClassOptions | undefined) => import("@loopback/boot").Binding<T_1>;
+    server: <T_2 extends import("@loopback/core").Server>(ctor: import("@loopback/core").Constructor<T_2>, nameOrOptions?: string | import("@loopback/core").BindingFromClassOptions | undefined) => import("@loopback/boot").Binding<T_2>;
+    servers: <T_3 extends import("@loopback/core").Server>(ctors: import("@loopback/core").Constructor<T_3>[]) => import("@loopback/boot").Binding<any>[];
+    getServer: <T_4 extends import("@loopback/core").Server>(target: string | import("@loopback/core").Constructor<T_4>) => Promise<T_4>;
+    init: () => Promise<void>;
+    onInit: (fn: () => import("@loopback/core").ValueOrPromise<void>) => import("@loopback/boot").Binding<import("@loopback/core").LifeCycleObserver>;
+    onStart: (fn: () => import("@loopback/core").ValueOrPromise<void>) => import("@loopback/boot").Binding<import("@loopback/core").LifeCycleObserver>;
+    stop: () => Promise<void>;
+    onStop: (fn: () => import("@loopback/core").ValueOrPromise<void>) => import("@loopback/boot").Binding<import("@loopback/core").LifeCycleObserver>;
+    setMetadata: (metadata: import("@loopback/core").ApplicationMetadata) => void;
+    lifeCycleObserver: <T_5 extends import("@loopback/core").LifeCycleObserver>(ctor: import("@loopback/core").Constructor<T_5>, nameOrOptions?: string | import("@loopback/core").BindingFromClassOptions | undefined) => import("@loopback/boot").Binding<T_5>;
+    service: <S>(cls: import("@loopback/core").ServiceOrProviderClass<S>, nameOrOptions?: string | import("@loopback/core").ServiceOptions | undefined) => import("@loopback/boot").Binding<S>;
+    interceptor: (interceptor: import("@loopback/core").Interceptor | import("@loopback/core").Constructor<import("@loopback/core").Provider<import("@loopback/core").Interceptor>>, nameOrOptions?: string | import("@loopback/core").InterceptorBindingOptions | undefined) => import("@loopback/boot").Binding<import("@loopback/core").Interceptor>;
+    readonly name: string;
+    readonly subscriptionManager: import("@loopback/core").ContextSubscriptionManager;
+    scope: import("@loopback/core").BindingScope;
+    readonly parent: import("@loopback/core").Context | undefined;
+    emitEvent: <T_6 extends import("@loopback/core").ContextEvent>(type: string, event: T_6) => void;
+    emitError: (err: unknown) => void;
+    bind: <ValueType = any>(key: import("@loopback/core").BindingAddress<ValueType>) => import("@loopback/boot").Binding<ValueType>;
+    add: (binding: import("@loopback/boot").Binding<unknown>) => import("@loopback/core").Application;
+    configure: <ConfigValueType = any>(key?: import("@loopback/core").BindingAddress<unknown> | undefined) => import("@loopback/boot").Binding<ConfigValueType>;
+    getConfigAsValueOrPromise: <ConfigValueType_1>(key: import("@loopback/core").BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => import("@loopback/core").ValueOrPromise<ConfigValueType_1 | undefined>;
+    getConfig: <ConfigValueType_2>(key: import("@loopback/core").BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => Promise<ConfigValueType_2 | undefined>;
+    getConfigSync: <ConfigValueType_3>(key: import("@loopback/core").BindingAddress<unknown>, propertyPath?: string | undefined, resolutionOptions?: import("@loopback/core").ResolutionOptions | undefined) => ConfigValueType_3 | undefined;
+    unbind: (key: import("@loopback/core").BindingAddress<unknown>) => boolean;
+    subscribe: (observer: import("@loopback/core").ContextEventObserver) => import("@loopback/core").Subscription;
+    unsubscribe: (observer: import("@loopback/core").ContextEventObserver) => boolean;
+    close: () => void;
+    isSubscribed: (observer: import("@loopback/core").ContextObserver) => boolean;
+    createView: <T_7 = unknown>(filter: import("@loopback/core").BindingFilter, comparator?: import("@loopback/core").BindingComparator | undefined) => import("@loopback/core").ContextView<T_7>;
+    contains: (key: import("@loopback/core").BindingAddress<unknown>) => boolean;
+    isBound: (key: import("@loopback/core").BindingAddress<unknown>) => boolean;
+    getOwnerContext: (keyOrBinding: import("@loopback/core").BindingAddress<unknown> | Readonly<import("@loopback/boot").Binding<unknown>>) => import("@loopback/core").Context | undefined;
+    getScopedContext: (scope: import("@loopback/core").BindingScope.APPLICATION | import("@loopback/core").BindingScope.SERVER | import("@loopback/core").BindingScope.REQUEST) => import("@loopback/core").Context | undefined;
+    getResolutionContext: (binding: Readonly<import("@loopback/boot").Binding<unknown>>) => import("@loopback/core").Context | undefined;
+    isVisibleTo: (ctx: import("@loopback/core").Context) => boolean;
+    find: <ValueType_1 = any>(pattern?: string | RegExp | import("@loopback/core").BindingFilter | undefined) => Readonly<import("@loopback/boot").Binding<ValueType_1>>[];
+    findByTag: <ValueType_2 = any>(tagFilter: RegExp | import("@loopback/core").BindingTag) => Readonly<import("@loopback/boot").Binding<ValueType_2>>[];
+    get: {
+        <ValueType_3>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_3>, session?: import("@loopback/core").ResolutionSession | undefined): Promise<ValueType_3>;
+        <ValueType_4>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_4>, options: import("@loopback/core").ResolutionOptions): Promise<ValueType_4 | undefined>;
+    };
+    getSync: {
+        <ValueType_5>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_5>, session?: import("@loopback/core").ResolutionSession | undefined): ValueType_5;
+        <ValueType_6>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_6>, options?: import("@loopback/core").ResolutionOptions | undefined): ValueType_6 | undefined;
+    };
+    getBinding: {
+        <ValueType_7 = any>(key: import("@loopback/core").BindingAddress<ValueType_7>): import("@loopback/boot").Binding<ValueType_7>;
+        <ValueType_8>(key: import("@loopback/core").BindingAddress<ValueType_8>, options?: {
+            optional?: boolean | undefined;
+        } | undefined): import("@loopback/boot").Binding<ValueType_8> | undefined;
+    };
+    findOrCreateBinding: <T_8>(key: import("@loopback/core").BindingAddress<T_8>, policy?: import("@loopback/core").BindingCreationPolicy | undefined) => import("@loopback/boot").Binding<T_8>;
+    getValueOrPromise: <ValueType_9>(keyWithPath: import("@loopback/core").BindingAddress<ValueType_9>, optionsOrSession?: import("@loopback/core").ResolutionOptionsOrSession | undefined) => import("@loopback/core").ValueOrPromise<ValueType_9 | undefined>;
+    toJSON: () => import("@loopback/core").JSONObject;
+    inspect: (options?: import("@loopback/core").ContextInspectOptions | undefined) => import("@loopback/core").JSONObject;
+    on: {
+        (eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): import("@loopback/core").Application;
+        (event: string | symbol, listener: (...args: any[]) => void): import("@loopback/core").Application;
+    };
+    once: {
+        (eventName: "bind" | "unbind", listener: import("@loopback/core").ContextEventListener): import("@loopback/core").Application;
+        (event: string | symbol, listener: (...args: any[]) => void): import("@loopback/core").Application;
+    };
+    addListener: (event: string | symbol, listener: (...args: any[]) => void) => import("@loopback/core").Application;
+    removeListener: (event: string | symbol, listener: (...args: any[]) => void) => import("@loopback/core").Application;
+    off: (event: string | symbol, listener: (...args: any[]) => void) => import("@loopback/core").Application;
+    removeAllListeners: (event?: string | symbol | undefined) => import("@loopback/core").Application;
+    setMaxListeners: (n: number) => import("@loopback/core").Application;
+    getMaxListeners: () => number;
+    listeners: (event: string | symbol) => Function[];
+    rawListeners: (event: string | symbol) => Function[];
+    emit: (event: string | symbol, ...args: any[]) => boolean;
+    listenerCount: (type: string | symbol) => number;
+    prependListener: (event: string | symbol, listener: (...args: any[]) => void) => import("@loopback/core").Application;
+    prependOnceListener: (event: string | symbol, listener: (...args: any[]) => void) => import("@loopback/core").Application;
+    eventNames: () => (string | symbol)[];
+}) & typeof RestApplication;
+export declare class GreetingApplication extends GreetingApplication_base {
+    constructor(config?: ApplicationConfig);
+    main(): Promise<void>;
+}
+export {};

package/dist/application.js

@@ -0,0 +1,29 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-greeting-app
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GreetingApplication = void 0;
+const boot_1 = require("@loopback/boot");
+const core_1 = require("@loopback/core");
+const example_greeter_extension_1 = require("@loopback/example-greeter-extension");
+const rest_1 = require("@loopback/rest");
+const caching_service_1 = require("./caching-service");
+const interceptors_1 = require("./interceptors");
+const keys_1 = require("./keys");
+class GreetingApplication extends boot_1.BootMixin(rest_1.RestApplication) {
+    constructor(config = {}) {
+        super(config);
+        this.projectRoot = __dirname;
+        this.add(core_1.createBindingFromClass(caching_service_1.CachingService, { key: keys_1.CACHING_SERVICE }));
+        this.add(core_1.createBindingFromClass(interceptors_1.CachingInterceptor));
+        this.component(example_greeter_extension_1.GreetingComponent);
+    }
+    async main() {
+        await this.boot();
+        await this.start();
+    }
+}
+exports.GreetingApplication = GreetingApplication;
+//# 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,iDAAiD;AACjD,8CAA8C;AAC9C,+CAA+C;AAC/C,gEAAgE;;;AAEhE,yCAAyC;AACzC,yCAAyE;AACzE,mFAAsE;AACtE,yCAA+C;AAC/C,uDAAiD;AACjD,iDAAkD;AAClD,iCAAuC;AAEvC,MAAa,mBAAoB,SAAQ,gBAAS,CAAC,sBAAe,CAAC;IACjE,YAAY,SAA4B,EAAE;QACxC,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,6BAAsB,CAAC,gCAAc,EAAE,EAAC,GAAG,EAAE,sBAAe,EAAC,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,GAAG,CAAC,6BAAsB,CAAC,iCAAkB,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,SAAS,CAAC,6CAAiB,CAAC,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;CACF;AAbD,kDAaC"}

package/dist/caching-service.d.ts

@@ -0,0 +1,64 @@
+import { ContextView } from '@loopback/core';
+import { Message } from './types';
+/**
+ * Configuration for CachingService
+ */
+export interface CachingServiceOptions {
+    ttl: number;
+}
+/**
+ * Message caching service
+ */
+export declare class CachingService {
+    private optionsView;
+    private timer;
+    private store;
+    constructor(optionsView: ContextView<CachingServiceOptions>);
+    /**
+     * Store a message in the cache
+     * @param key - Key for caching
+     * @param message - Message
+     */
+    set(key: string, message: Message): Promise<void>;
+    /**
+     * Load a message from the cache by key
+     * @param key - Key for caching
+     */
+    get(key: string): Promise<Message | undefined>;
+    /**
+     * Delete a message from the cache by key
+     * @param key - Key for caching
+     */
+    delete(key: string): Promise<boolean>;
+    /**
+     * Clear the cache
+     */
+    clear(): Promise<void>;
+    /**
+     * Check if the cached item is expired by key
+     * @param key - Key for caching
+     * @param now - The current date
+     */
+    isExpired(key: string, now?: Date): Promise<boolean>;
+    /**
+     * Get the TTL setting
+     */
+    getTTL(): Promise<number>;
+    /**
+     * Remove expired items from the cache
+     */
+    sweep(): Promise<void>;
+    /**
+     * This method will be invoked when the application starts
+     */
+    start(): Promise<void>;
+    /**
+     * This method will be invoked when the application stops
+     */
+    stop(): Promise<void>;
+    /**
+     * This method may be used to restart the service (and may be triggered by a
+     * 'refresh' event)
+     */
+    restart(): Promise<void>;
+}

package/dist/caching-service.js

@@ -0,0 +1,133 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/example-greeting-app
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CachingService = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@loopback/core");
+const debug_1 = tslib_1.__importDefault(require("debug"));
+const debug = debug_1.default('greeter-extension');
+/**
+ * Message caching service
+ */
+let CachingService = class CachingService {
+    constructor(optionsView) {
+        this.optionsView = optionsView;
+        this.store = new Map();
+        // Use a view so that we can listen on `refresh` events, which are emitted
+        // when the configuration binding is updated in the context.
+        optionsView.on('refresh', () => {
+            debug('Restarting the service as configuration changes...');
+            this.restart().catch(err => {
+                console.error('Cannot restart the caching service.', err);
+                process.exit(1);
+            });
+        });
+    }
+    // We intentionally mark all operations `async` to reflect the commonly used
+    // caching infrastructure even though our in-memory implementation is based
+    // on a `Map` that provides synchronous APIs.
+    /**
+     * Store a message in the cache
+     * @param key - Key for caching
+     * @param message - Message
+     */
+    async set(key, message) {
+        this.store.set(key, message);
+    }
+    /**
+     * Load a message from the cache by key
+     * @param key - Key for caching
+     */
+    async get(key) {
+        const expired = await this.isExpired(key);
+        debug('Getting cache for %s', key, expired);
+        return expired ? undefined : this.store.get(key);
+    }
+    /**
+     * Delete a message from the cache by key
+     * @param key - Key for caching
+     */
+    async delete(key) {
+        return this.store.delete(key);
+    }
+    /**
+     * Clear the cache
+     */
+    async clear() {
+        this.store.clear();
+    }
+    /**
+     * Check if the cached item is expired by key
+     * @param key - Key for caching
+     * @param now - The current date
+     */
+    async isExpired(key, now = new Date()) {
+        const ttl = await this.getTTL();
+        const msg = this.store.get(key);
+        if (!msg)
+            return true;
+        return now.getTime() - msg.timestamp.getTime() > ttl;
+    }
+    /**
+     * Get the TTL setting
+     */
+    async getTTL() {
+        var _a;
+        const options = await this.optionsView.singleValue();
+        debug('Caching options: %j', options);
+        return (_a = options === null || options === void 0 ? void 0 : options.ttl) !== null && _a !== void 0 ? _a : 5000;
+    }
+    /**
+     * Remove expired items from the cache
+     */
+    async sweep() {
+        debug('Sweeping cache...');
+        for (const key of this.store.keys()) {
+            if (await this.isExpired(key)) {
+                debug('Cache for %s is swept.', key);
+                await this.delete(key);
+            }
+        }
+    }
+    /**
+     * This method will be invoked when the application starts
+     */
+    async start() {
+        debug('Starting caching service');
+        await this.clear();
+        const ttl = await this.getTTL();
+        debug('TTL: %d', ttl);
+        this.timer = setInterval(() => {
+            this.sweep().catch(console.warn);
+        }, ttl);
+    }
+    /**
+     * This method will be invoked when the application stops
+     */
+    async stop() {
+        debug('Stopping caching service');
+        /* istanbul ignore if */
+        if (this.timer) {
+            clearInterval(this.timer);
+        }
+        await this.clear();
+    }
+    /**
+     * This method may be used to restart the service (and may be triggered by a
+     * 'refresh' event)
+     */
+    async restart() {
+        await this.stop();
+        await this.start();
+    }
+};
+CachingService = tslib_1.__decorate([
+    core_1.injectable({ scope: core_1.BindingScope.SINGLETON }),
+    tslib_1.__param(0, core_1.config.view()),
+    tslib_1.__metadata("design:paramtypes", [core_1.ContextView])
+], CachingService);
+exports.CachingService = CachingService;
+//# sourceMappingURL=caching-service.js.map