@loopback/core 4.0.0-alpha.8 → 4.0.1

package/dist/service.d.ts

@@ -0,0 +1,63 @@
+import { Binding, BindingFilter, BindingFromClassOptions, BindingTemplate, InjectionMetadata } from '@loopback/context';
+import { ServiceOrProviderClass } from './application';
+/**
+ * Representing an interface for services. In TypeScript, the `interface` does
+ * not have reflections at runtime. We use a string, a symbol or a Function as
+ * the type for the service interface.
+ */
+export declare type ServiceInterface = string | symbol | Function;
+/**
+ * Options to register a service binding
+ */
+export interface ServiceOptions extends BindingFromClassOptions {
+    interface?: ServiceInterface;
+}
+/**
+ * `@service` injects a service instance that matches the class or interface.
+ *
+ * @param serviceInterface - Interface for the service. It can be in one of the
+ * following forms:
+ *
+ * - A class, such as MyService
+ * - A string that identifies the interface, such as `'MyService'`
+ * - A symbol that identifies the interface, such as `Symbol('MyService')`
+ *
+ * If not provided, the value is inferred from the design:type of the parameter
+ * or property
+ *
+ * @example
+ * ```ts
+ *
+ * const ctx = new Context();
+ * ctx.bind('my-service').toClass(MyService);
+ * ctx.bind('logger').toClass(Logger);
+ *
+ * export class MyController {
+ *   constructor(@service(MyService) private myService: MyService) {}
+ *
+ *   @service()
+ *   private logger: Logger;
+ * }
+ *
+ * ctx.bind('my-controller').toClass(MyController);
+ * await myController = ctx.get<MyController>('my-controller');
+ * ```
+ */
+export declare function service(serviceInterface?: ServiceInterface, metadata?: InjectionMetadata): (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void;
+/**
+ * Create a binding filter by service class
+ * @param serviceInterface - Service class matching the one used by `binding.toClass()`
+ * @param options - Options to control if subclasses should be skipped for matching
+ */
+export declare function filterByServiceInterface(serviceInterface: ServiceInterface): BindingFilter;
+/**
+ * Create a service binding from a class or provider
+ * @param cls - Service class or provider
+ * @param options - Service options
+ */
+export declare function createServiceBinding<S>(cls: ServiceOrProviderClass<S>, options?: ServiceOptions): Binding<S>;
+/**
+ * Create a binding template for a service interface
+ * @param serviceInterface - Service interface
+ */
+export declare function asService(serviceInterface: ServiceInterface): BindingTemplate;

package/dist/service.js

@@ -0,0 +1,151 @@
+"use strict";
+// Copyright IBM Corp. and LoopBack contributors 2019,2020. All Rights Reserved.
+// Node module: @loopback/core
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.asService = exports.createServiceBinding = exports.filterByServiceInterface = exports.service = void 0;
+const context_1 = require("@loopback/context");
+const keys_1 = require("./keys");
+/**
+ * `@service` injects a service instance that matches the class or interface.
+ *
+ * @param serviceInterface - Interface for the service. It can be in one of the
+ * following forms:
+ *
+ * - A class, such as MyService
+ * - A string that identifies the interface, such as `'MyService'`
+ * - A symbol that identifies the interface, such as `Symbol('MyService')`
+ *
+ * If not provided, the value is inferred from the design:type of the parameter
+ * or property
+ *
+ * @example
+ * ```ts
+ *
+ * const ctx = new Context();
+ * ctx.bind('my-service').toClass(MyService);
+ * ctx.bind('logger').toClass(Logger);
+ *
+ * export class MyController {
+ *   constructor(@service(MyService) private myService: MyService) {}
+ *
+ *   @service()
+ *   private logger: Logger;
+ * }
+ *
+ * ctx.bind('my-controller').toClass(MyController);
+ * await myController = ctx.get<MyController>('my-controller');
+ * ```
+ */
+function service(serviceInterface, metadata) {
+    return (0, context_1.inject)('', { decorator: '@service', ...metadata }, (ctx, injection, session) => {
+        var _a;
+        let serviceType = serviceInterface;
+        if (!serviceType) {
+            if (typeof injection.methodDescriptorOrParameterIndex === 'number') {
+                serviceType = (_a = context_1.MetadataInspector.getDesignTypeForMethod(injection.target, injection.member)) === null || _a === void 0 ? void 0 : _a.parameterTypes[injection.methodDescriptorOrParameterIndex];
+            }
+            else {
+                serviceType = context_1.MetadataInspector.getDesignTypeForProperty(injection.target, injection.member);
+            }
+        }
+        if (serviceType === undefined) {
+            const targetName = context_1.DecoratorFactory.getTargetName(injection.target, injection.member, injection.methodDescriptorOrParameterIndex);
+            const msg = `No design-time type metadata found while inspecting ${targetName}. ` +
+                'You can either use `@service(ServiceClass)` or ensure `emitDecoratorMetadata` is enabled in your TypeScript configuration. ' +
+                'Run `tsc --showConfig` to print the final TypeScript configuration of your project.';
+            throw new Error(msg);
+        }
+        if (serviceType === Object || serviceType === Array) {
+            throw new Error('Service class cannot be inferred from design type. Use @service(ServiceClass).');
+        }
+        const view = new context_1.ContextView(ctx, filterByServiceInterface(serviceType));
+        const result = view.resolve({
+            optional: metadata === null || metadata === void 0 ? void 0 : metadata.optional,
+            asProxyWithInterceptors: metadata === null || metadata === void 0 ? void 0 : metadata.asProxyWithInterceptors,
+            session,
+        });
+        const serviceTypeName = typeof serviceType === 'string'
+            ? serviceType
+            : typeof serviceType === 'symbol'
+                ? serviceType.toString()
+                : serviceType.name;
+        return (0, context_1.transformValueOrPromise)(result, values => {
+            if (values.length === 1)
+                return values[0];
+            if (values.length >= 1) {
+                throw new Error(`More than one bindings found for ${serviceTypeName}`);
+            }
+            else {
+                if (metadata === null || metadata === void 0 ? void 0 : metadata.optional) {
+                    return undefined;
+                }
+                throw new Error(`No binding found for ${serviceTypeName}. Make sure a service ` +
+                    `binding is created in context ${ctx.name} with serviceInterface (${serviceTypeName}).`);
+            }
+        });
+    });
+}
+exports.service = service;
+/**
+ * Create a binding filter by service class
+ * @param serviceInterface - Service class matching the one used by `binding.toClass()`
+ * @param options - Options to control if subclasses should be skipped for matching
+ */
+function filterByServiceInterface(serviceInterface) {
+    return binding => binding.valueConstructor === serviceInterface ||
+        binding.tagMap[keys_1.CoreTags.SERVICE_INTERFACE] === serviceInterface;
+}
+exports.filterByServiceInterface = filterByServiceInterface;
+/**
+ * Create a service binding from a class or provider
+ * @param cls - Service class or provider
+ * @param options - Service options
+ */
+function createServiceBinding(cls, options = {}) {
+    var _a;
+    let name = options.name;
+    if (!name && (0, context_1.isProviderClass)(cls)) {
+        // Trim `Provider` from the default service name
+        // This is needed to keep backward compatibility
+        const templateFn = (0, context_1.bindingTemplateFor)(cls);
+        const template = context_1.Binding.bind('template').apply(templateFn);
+        if (template.tagMap[context_1.ContextTags.PROVIDER] &&
+            !template.tagMap[context_1.ContextTags.NAME]) {
+            // The class is a provider and no `name` tag is found
+            name = cls.name.replace(/Provider$/, '');
+        }
+    }
+    if (!name && (0, context_1.isDynamicValueProviderClass)(cls)) {
+        // Trim `Provider` from the default service name
+        const templateFn = (0, context_1.bindingTemplateFor)(cls);
+        const template = context_1.Binding.bind('template').apply(templateFn);
+        if (template.tagMap[context_1.ContextTags.DYNAMIC_VALUE_PROVIDER] &&
+            !template.tagMap[context_1.ContextTags.NAME]) {
+            // The class is a provider and no `name` tag is found
+            name = cls.name.replace(/Provider$/, '');
+        }
+    }
+    const binding = (0, context_1.createBindingFromClass)(cls, {
+        name,
+        type: keys_1.CoreTags.SERVICE,
+        ...options,
+    }).apply(asService((_a = options.interface) !== null && _a !== void 0 ? _a : cls));
+    return binding;
+}
+exports.createServiceBinding = createServiceBinding;
+/**
+ * Create a binding template for a service interface
+ * @param serviceInterface - Service interface
+ */
+function asService(serviceInterface) {
+    return function serviceTemplate(binding) {
+        binding.tag({
+            [context_1.ContextTags.TYPE]: keys_1.CoreTags.SERVICE,
+            [keys_1.CoreTags.SERVICE_INTERFACE]: serviceInterface,
+        });
+    };
+}
+exports.asService = asService;
+//# sourceMappingURL=service.js.map

package/dist/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,8BAA8B;AAC9B,+CAA+C;AAC/C,gEAAgE;;;AAEhE,+CAgB2B;AAE3B,iCAAgC;AAgBhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,OAAO,CACrB,gBAAmC,EACnC,QAA4B;IAE5B,OAAO,IAAA,gBAAM,EACX,EAAE,EACF,EAAC,SAAS,EAAE,UAAU,EAAE,GAAG,QAAQ,EAAC,EACpC,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE;;QAC1B,IAAI,WAAW,GAAG,gBAAgB,CAAC;QACnC,IAAI,CAAC,WAAW,EAAE;YAChB,IAAI,OAAO,SAAS,CAAC,gCAAgC,KAAK,QAAQ,EAAE;gBAClE,WAAW,GAAG,MAAA,2BAAiB,CAAC,sBAAsB,CACpD,SAAS,CAAC,MAAM,EAChB,SAAS,CAAC,MAAO,CAClB,0CAAE,cAAc,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;aAC/D;iBAAM;gBACL,WAAW,GAAG,2BAAiB,CAAC,wBAAwB,CACtD,SAAS,CAAC,MAAM,EAChB,SAAS,CAAC,MAAO,CAClB,CAAC;aACH;SACF;QACD,IAAI,WAAW,KAAK,SAAS,EAAE;YAC7B,MAAM,UAAU,GAAG,0BAAgB,CAAC,aAAa,CAC/C,SAAS,CAAC,MAAM,EAChB,SAAS,CAAC,MAAM,EAChB,SAAS,CAAC,gCAAgC,CAC3C,CAAC;YACF,MAAM,GAAG,GACP,uDAAuD,UAAU,IAAI;gBACrE,6HAA6H;gBAC7H,qFAAqF,CAAC;YACxF,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;SACtB;QAED,IAAI,WAAW,KAAK,MAAM,IAAI,WAAW,KAAK,KAAK,EAAE;YACnD,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAC;SACH;QACD,MAAM,IAAI,GAAG,IAAI,qBAAW,CAAC,GAAG,EAAE,wBAAwB,CAAC,WAAW,CAAC,CAAC,CAAC;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;YAC1B,QAAQ,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ;YAC5B,uBAAuB,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,uBAAuB;YAC1D,OAAO;SACR,CAAC,CAAC;QAEH,MAAM,eAAe,GACnB,OAAO,WAAW,KAAK,QAAQ;YAC7B,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,OAAO,WAAW,KAAK,QAAQ;gBACjC,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE;gBACxB,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC;QACvB,OAAO,IAAA,iCAAuB,EAAC,MAAM,EAAE,MAAM,CAAC,EAAE;YAC9C,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,MAAM,CAAC,CAAC,CAAC,CAAC;YAC1C,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE;gBACtB,MAAM,IAAI,KAAK,CACb,oCAAoC,eAAe,EAAE,CACtD,CAAC;aACH;iBAAM;gBACL,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,QAAQ,EAAE;oBACtB,OAAO,SAAS,CAAC;iBAClB;gBACD,MAAM,IAAI,KAAK,CACb,wBAAwB,eAAe,wBAAwB;oBAC7D,iCAAiC,GAAG,CAAC,IAAI,2BAA2B,eAAe,IAAI,CAC1F,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CACF,CAAC;AACJ,CAAC;AAvED,0BAuEC;AAED;;;;GAIG;AACH,SAAgB,wBAAwB,CACtC,gBAAkC;IAElC,OAAO,OAAO,CAAC,EAAE,CACf,OAAO,CAAC,gBAAgB,KAAK,gBAAgB;QAC7C,OAAO,CAAC,MAAM,CAAC,eAAQ,CAAC,iBAAiB,CAAC,KAAK,gBAAgB,CAAC;AACpE,CAAC;AAND,4DAMC;AAED;;;;GAIG;AACH,SAAgB,oBAAoB,CAClC,GAA8B,EAC9B,UAA0B,EAAE;;IAE5B,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IACxB,IAAI,CAAC,IAAI,IAAI,IAAA,yBAAe,EAAC,GAAG,CAAC,EAAE;QACjC,gDAAgD;QAChD,gDAAgD;QAChD,MAAM,UAAU,GAAG,IAAA,4BAAkB,EAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAI,UAAU,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC/D,IACE,QAAQ,CAAC,MAAM,CAAC,qBAAW,CAAC,QAAQ,CAAC;YACrC,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAW,CAAC,IAAI,CAAC,EAClC;YACA,qDAAqD;YACrD,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;SAC1C;KACF;IACD,IAAI,CAAC,IAAI,IAAI,IAAA,qCAA2B,EAAC,GAAG,CAAC,EAAE;QAC7C,gDAAgD;QAChD,MAAM,UAAU,GAAG,IAAA,4BAAkB,EAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,iBAAO,CAAC,IAAI,CAAI,UAAU,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC/D,IACE,QAAQ,CAAC,MAAM,CAAC,qBAAW,CAAC,sBAAsB,CAAC;YACnD,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAW,CAAC,IAAI,CAAC,EAClC;YACA,qDAAqD;YACrD,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;SAC1C;KACF;IACD,MAAM,OAAO,GAAG,IAAA,gCAAsB,EAAC,GAAG,EAAE;QAC1C,IAAI;QACJ,IAAI,EAAE,eAAQ,CAAC,OAAO;QACtB,GAAG,OAAO;KACX,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,MAAA,OAAO,CAAC,SAAS,mCAAI,GAAG,CAAC,CAAC,CAAC;IAC9C,OAAO,OAAO,CAAC;AACjB,CAAC;AApCD,oDAoCC;AAED;;;GAGG;AACH,SAAgB,SAAS,CAAC,gBAAkC;IAC1D,OAAO,SAAS,eAAe,CAAC,OAAgB;QAC9C,OAAO,CAAC,GAAG,CAAC;YACV,CAAC,qBAAW,CAAC,IAAI,CAAC,EAAE,eAAQ,CAAC,OAAO;YACpC,CAAC,eAAQ,CAAC,iBAAiB,CAAC,EAAE,gBAAgB;SAC/C,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAPD,8BAOC"}

package/package.json

@@ -1,48 +1,50 @@
 {
   "name": "@loopback/core",
-  "version": "4.0.0-alpha.8",
-  "description": "",
+  "description": "Define and implement core constructs such as Application and Component",
+  "version": "4.0.1",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp. and LoopBack contributors",
+  "copyright.owner": "IBM Corp. and LoopBack contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "packages/core"
+  },
+  "engines": {
+    "node": "14 || 16 || 17 || 18"
+  },
   "scripts": {
-    "acceptance": "mocha --opts ../../test/mocha.opts 'test/acceptance/**/*.ts'",
-    "build": "npm run build:lib && npm run build:lib6",
-    "build:lib": "node ../../bin/compile-package es2017",
-    "build:lib6": "node ../../bin/compile-package es2015",
-    "clean": "rm -rf loopback-core*.tgz lib* package",
-    "prepublish": "npm run build",
+    "acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
+    "build": "lb-tsc",
+    "clean": "lb-clean loopback-core*.tgz dist *.tsbuildinfo package",
     "pretest": "npm run build",
-    "integration": "mocha --opts ../../test/mocha.opts 'test/integration/**/*.ts'",
-    "test": "mocha --opts ../../test/mocha.opts 'test/unit/**/*.ts' 'test/integration/**/*.ts' 'test/acceptance/**/*.ts'",
-    "unit": "mocha --opts ../../test/mocha.opts 'test/unit/**/*.ts'",
+    "integration": "lb-mocha \"dist/__tests__/integration/**/*.js\"",
+    "test": "lb-mocha \"dist/__tests__/**/*.js\"",
+    "unit": "lb-mocha \"dist/__tests__/unit/**/*.js\"",
     "verify": "npm pack && tar xf loopback-core*.tgz && tree package && npm run clean"
   },
-  "author": "IBM",
-  "license": "MIT",
-  "dependencies": {
-    "@loopback/context": "^4.0.0-alpha.7",
-    "@loopback/openapi-spec": "^4.0.0-alpha.5",
-    "@types/bluebird": "^3.5.2",
-    "@types/http-errors": "^1.5.34",
-    "bluebird": "^3.5.0",
-    "body": "^5.1.0",
-    "debug": "^2.6.0",
-    "http-errors": "^1.6.1",
-    "path-to-regexp": "^1.7.0"
-  },
-  "devDependencies": {
-    "@loopback/openapi-spec-builder": "^4.0.0-alpha.3",
-    "@loopback/testlab": "^4.0.0-alpha.4",
-    "mocha": "^3.2.0",
-    "typescript": "^2.3.2"
+  "publishConfig": {
+    "access": "public"
   },
   "files": [
     "README.md",
-    "index.js",
-    "index.d.ts",
-    "lib",
-    "lib6"
+    "dist",
+    "src",
+    "!*/__tests__"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/strongloop/loopback-next.git"
-  }
+  "dependencies": {
+    "@loopback/context": "^5.0.1",
+    "debug": "^4.3.4",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@loopback/build": "^9.0.1",
+    "@loopback/eslint-config": "^13.0.1",
+    "@loopback/testlab": "^5.0.1",
+    "@types/debug": "^4.1.7",
+    "@types/node": "^14.18.21"
+  },
+  "gitHead": "ccf7863d0639de966d6c6129b4aa94ba1dce2c33"
 }