@backstage/backend-defaults 0.1.5-next.0 → 0.1.5

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/backend-defaults
 
+## 0.1.5
+
+### Patch Changes
+
+- 6cfd4d7073: Include implementations for the new `rootLifecycleServiceRef`.
+- ecc6bfe4c9: Use new `ServiceFactoryOrFunction` type.
+- 015a6dced6: Updated to make sure that service implementations replace default service implementations.
+- 843a0a158c: Added factory for the new core identity service to the set of default service factories.
+- 5b7bcd3c5e: Added support to supply a shared environment to `createBackend`, which can be created using `createSharedEnvironment` from `@backstage/backend-plugin-api`.
+- 02b119ff93: The new root HTTP router service is now installed by default.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.3.0
+  - @backstage/backend-app-api@0.3.0
+
+## 0.1.5-next.1
+
+### Patch Changes
+
+- ecc6bfe4c9: Use new `ServiceFactoryOrFunction` type.
+- 015a6dced6: Updated to make sure that service implementations replace default service implementations.
+- 02b119ff93: The new root HTTP router service is now installed by default.
+- Updated dependencies
+  - @backstage/backend-app-api@0.3.0-next.1
+  - @backstage/backend-plugin-api@0.3.0-next.1
+
 ## 0.1.5-next.0
 
 ### Patch Changes

package/dist/index.cjs.js

@@ -5,25 +5,46 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var backendAppApi = require('@backstage/backend-app-api');
 
 const defaultServiceFactories = [
-  backendAppApi.cacheFactory,
-  backendAppApi.configFactory,
-  backendAppApi.databaseFactory,
-  backendAppApi.discoveryFactory,
-  backendAppApi.loggerFactory,
-  backendAppApi.rootLoggerFactory,
-  backendAppApi.permissionsFactory,
-  backendAppApi.schedulerFactory,
-  backendAppApi.tokenManagerFactory,
-  backendAppApi.urlReaderFactory,
-  backendAppApi.httpRouterFactory,
-  backendAppApi.lifecycleFactory,
-  backendAppApi.rootLifecycleFactory
+  backendAppApi.cacheFactory(),
+  backendAppApi.configFactory(),
+  backendAppApi.databaseFactory(),
+  backendAppApi.discoveryFactory(),
+  backendAppApi.httpRouterFactory(),
+  backendAppApi.identityFactory(),
+  backendAppApi.lifecycleFactory(),
+  backendAppApi.loggerFactory(),
+  backendAppApi.permissionsFactory(),
+  backendAppApi.rootHttpRouterFactory(),
+  backendAppApi.rootLifecycleFactory(),
+  backendAppApi.rootLoggerFactory(),
+  backendAppApi.schedulerFactory(),
+  backendAppApi.tokenManagerFactory(),
+  backendAppApi.urlReaderFactory()
 ];
 function createBackend(options) {
-  var _a;
-  return backendAppApi.createSpecializedBackend({
-    services: [...defaultServiceFactories, ...(_a = options == null ? void 0 : options.services) != null ? _a : []]
-  });
+  var _a, _b, _c;
+  const services = new Array();
+  const providedServices = ((_a = options == null ? void 0 : options.services) != null ? _a : []).map(
+    (sf) => typeof sf === "function" ? sf() : sf
+  );
+  services.push(...providedServices);
+  if (options == null ? void 0 : options.env) {
+    const env = options.env;
+    if (env.version !== "v1") {
+      throw new Error(
+        `Shared environment version '${env.version}' is invalid or not supported`
+      );
+    }
+    const environmentServices = (_c = (_b = env.services) == null ? void 0 : _b.filter(
+      (sf) => !services.some(({ service }) => sf.service.id === service.id)
+    )) != null ? _c : [];
+    services.push(...environmentServices);
+  }
+  const defaultServices = defaultServiceFactories.filter(
+    (sf) => !services.some(({ service }) => service.id === sf.service.id)
+  );
+  services.push(...defaultServices);
+  return backendAppApi.createSpecializedBackend({ services });
 }
 
 exports.createBackend = createBackend;

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/CreateBackend.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  Backend,\n  cacheFactory,\n  configFactory,\n  createSpecializedBackend,\n  databaseFactory,\n  discoveryFactory,\n  httpRouterFactory,\n  lifecycleFactory,\n  rootLifecycleFactory,\n  loggerFactory,\n  permissionsFactory,\n  rootLoggerFactory,\n  schedulerFactory,\n  tokenManagerFactory,\n  urlReaderFactory,\n} from '@backstage/backend-app-api';\nimport { ServiceFactory } from '@backstage/backend-plugin-api';\n\nexport const defaultServiceFactories = [\n  cacheFactory,\n  configFactory,\n  databaseFactory,\n  discoveryFactory,\n  loggerFactory,\n  rootLoggerFactory,\n  permissionsFactory,\n  schedulerFactory,\n  tokenManagerFactory,\n  urlReaderFactory,\n  httpRouterFactory,\n  lifecycleFactory,\n  rootLifecycleFactory,\n];\n\n/**\n * @public\n */\nexport interface CreateBackendOptions {\n  services?: (ServiceFactory | (() => ServiceFactory))[];\n}\n\n/**\n * @public\n */\nexport function createBackend(options?: CreateBackendOptions): Backend {\n  return createSpecializedBackend({\n    services: [...defaultServiceFactories, ...(options?.services ?? [])],\n  });\n}\n"],"names":["cacheFactory","configFactory","databaseFactory","discoveryFactory","loggerFactory","rootLoggerFactory","permissionsFactory","schedulerFactory","tokenManagerFactory","urlReaderFactory","httpRouterFactory","lifecycleFactory","rootLifecycleFactory","createSpecializedBackend"],"mappings":";;;;;;AAmCO,MAAM,uBAA0B,GAAA;AAAA,EACrCA,0BAAA;AAAA,EACAC,2BAAA;AAAA,EACAC,6BAAA;AAAA,EACAC,8BAAA;AAAA,EACAC,2BAAA;AAAA,EACAC,+BAAA;AAAA,EACAC,gCAAA;AAAA,EACAC,8BAAA;AAAA,EACAC,iCAAA;AAAA,EACAC,8BAAA;AAAA,EACAC,+BAAA;AAAA,EACAC,8BAAA;AAAA,EACAC,kCAAA;AACF,CAAA,CAAA;AAYO,SAAS,cAAc,OAAyC,EAAA;AA7DvE,EAAA,IAAA,EAAA,CAAA;AA8DE,EAAA,OAAOC,sCAAyB,CAAA;AAAA,IAC9B,QAAA,EAAU,CAAC,GAAG,uBAAA,EAAyB,IAAI,EAAS,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAA,QAAA,KAAT,IAAqB,GAAA,EAAA,GAAA,EAAG,CAAA;AAAA,GACpE,CAAA,CAAA;AACH;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/CreateBackend.ts"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  Backend,\n  cacheFactory,\n  configFactory,\n  createSpecializedBackend,\n  databaseFactory,\n  discoveryFactory,\n  httpRouterFactory,\n  rootHttpRouterFactory,\n  lifecycleFactory,\n  rootLifecycleFactory,\n  loggerFactory,\n  permissionsFactory,\n  rootLoggerFactory,\n  schedulerFactory,\n  tokenManagerFactory,\n  urlReaderFactory,\n  identityFactory,\n} from '@backstage/backend-app-api';\nimport {\n  ServiceFactory,\n  ServiceFactoryOrFunction,\n  SharedBackendEnvironment,\n} from '@backstage/backend-plugin-api';\n\n// Internal import of the type to avoid needing to export this.\n// eslint-disable-next-line monorepo/no-internal-import\nimport type { InternalSharedBackendEnvironment } from '@backstage/backend-plugin-api/src/wiring/createSharedEnvironment';\n\nexport const defaultServiceFactories = [\n  cacheFactory(),\n  configFactory(),\n  databaseFactory(),\n  discoveryFactory(),\n  httpRouterFactory(),\n  identityFactory(),\n  lifecycleFactory(),\n  loggerFactory(),\n  permissionsFactory(),\n  rootHttpRouterFactory(),\n  rootLifecycleFactory(),\n  rootLoggerFactory(),\n  schedulerFactory(),\n  tokenManagerFactory(),\n  urlReaderFactory(),\n];\n\n/**\n * @public\n */\nexport interface CreateBackendOptions {\n  env?: SharedBackendEnvironment;\n  services?: ServiceFactoryOrFunction[];\n}\n\n/**\n * @public\n */\nexport function createBackend(options?: CreateBackendOptions): Backend {\n  const services = new Array<ServiceFactory>();\n\n  // Highest priority: Services passed directly to createBackend\n  const providedServices = (options?.services ?? []).map(sf =>\n    typeof sf === 'function' ? sf() : sf,\n  );\n  services.push(...providedServices);\n\n  // Middle priority: Services from the shared environment\n  if (options?.env) {\n    const env = options.env as unknown as InternalSharedBackendEnvironment;\n    if (env.version !== 'v1') {\n      throw new Error(\n        `Shared environment version '${env.version}' is invalid or not supported`,\n      );\n    }\n\n    const environmentServices =\n      env.services?.filter(\n        sf => !services.some(({ service }) => sf.service.id === service.id),\n      ) ?? [];\n    services.push(...environmentServices);\n  }\n\n  // Lowest priority: Default services that are not already provided by environment or directly to createBackend\n  const defaultServices = defaultServiceFactories.filter(\n    sf => !services.some(({ service }) => service.id === sf.service.id),\n  );\n  services.push(...defaultServices);\n\n  return createSpecializedBackend({ services });\n}\n"],"names":["cacheFactory","configFactory","databaseFactory","discoveryFactory","httpRouterFactory","identityFactory","lifecycleFactory","loggerFactory","permissionsFactory","rootHttpRouterFactory","rootLifecycleFactory","rootLoggerFactory","schedulerFactory","tokenManagerFactory","urlReaderFactory","createSpecializedBackend"],"mappings":";;;;;;AA6CO,MAAM,uBAA0B,GAAA;AAAA,EACrCA,0BAAa,EAAA;AAAA,EACbC,2BAAc,EAAA;AAAA,EACdC,6BAAgB,EAAA;AAAA,EAChBC,8BAAiB,EAAA;AAAA,EACjBC,+BAAkB,EAAA;AAAA,EAClBC,6BAAgB,EAAA;AAAA,EAChBC,8BAAiB,EAAA;AAAA,EACjBC,2BAAc,EAAA;AAAA,EACdC,gCAAmB,EAAA;AAAA,EACnBC,mCAAsB,EAAA;AAAA,EACtBC,kCAAqB,EAAA;AAAA,EACrBC,+BAAkB,EAAA;AAAA,EAClBC,8BAAiB,EAAA;AAAA,EACjBC,iCAAoB,EAAA;AAAA,EACpBC,8BAAiB,EAAA;AACnB,CAAA,CAAA;AAaO,SAAS,cAAc,OAAyC,EAAA;AA1EvE,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AA2EE,EAAM,MAAA,QAAA,GAAW,IAAI,KAAsB,EAAA,CAAA;AAG3C,EAAA,MAAM,gBAAoB,GAAA,CAAA,CAAA,EAAA,GAAA,OAAA,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,OAAA,CAAS,QAAT,KAAA,IAAA,GAAA,EAAA,GAAqB,EAAI,EAAA,GAAA;AAAA,IAAI,CACrD,EAAA,KAAA,OAAO,EAAO,KAAA,UAAA,GAAa,IAAO,GAAA,EAAA;AAAA,GACpC,CAAA;AACA,EAAS,QAAA,CAAA,IAAA,CAAK,GAAG,gBAAgB,CAAA,CAAA;AAGjC,EAAA,IAAI,mCAAS,GAAK,EAAA;AAChB,IAAA,MAAM,MAAM,OAAQ,CAAA,GAAA,CAAA;AACpB,IAAI,IAAA,GAAA,CAAI,YAAY,IAAM,EAAA;AACxB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,+BAA+B,GAAI,CAAA,OAAA,CAAA,6BAAA,CAAA;AAAA,OACrC,CAAA;AAAA,KACF;AAEA,IAAM,MAAA,mBAAA,GAAA,CACJ,EAAI,GAAA,CAAA,EAAA,GAAA,GAAA,CAAA,QAAA,KAAJ,IAAc,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAA;AAAA,MACZ,CAAM,EAAA,KAAA,CAAC,QAAS,CAAA,IAAA,CAAK,CAAC,EAAE,OAAQ,EAAA,KAAM,EAAG,CAAA,OAAA,CAAQ,EAAO,KAAA,OAAA,CAAQ,EAAE,CAAA;AAAA,KAAA,KADpE,YAEK,EAAC,CAAA;AACR,IAAS,QAAA,CAAA,IAAA,CAAK,GAAG,mBAAmB,CAAA,CAAA;AAAA,GACtC;AAGA,EAAA,MAAM,kBAAkB,uBAAwB,CAAA,MAAA;AAAA,IAC9C,CAAM,EAAA,KAAA,CAAC,QAAS,CAAA,IAAA,CAAK,CAAC,EAAE,OAAQ,EAAA,KAAM,OAAQ,CAAA,EAAA,KAAO,EAAG,CAAA,OAAA,CAAQ,EAAE,CAAA;AAAA,GACpE,CAAA;AACA,EAAS,QAAA,CAAA,IAAA,CAAK,GAAG,eAAe,CAAA,CAAA;AAEhC,EAAO,OAAAC,sCAAA,CAAyB,EAAE,QAAA,EAAU,CAAA,CAAA;AAC9C;;;;"}

package/dist/index.d.ts

@@ -1,11 +1,12 @@
+import { SharedBackendEnvironment, ServiceFactoryOrFunction } from '@backstage/backend-plugin-api';
 import { Backend } from '@backstage/backend-app-api';
-import { ServiceFactory } from '@backstage/backend-plugin-api';
 
 /**
  * @public
  */
 interface CreateBackendOptions {
-    services?: (ServiceFactory | (() => ServiceFactory))[];
+    env?: SharedBackendEnvironment;
+    services?: ServiceFactoryOrFunction[];
 }
 /**
  * @public

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/backend-defaults",
   "description": "Backend defaults used by Backstage backend apps",
-  "version": "0.1.5-next.0",
+  "version": "0.1.5",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
@@ -32,11 +32,12 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-app-api": "^0.2.5-next.0",
-    "@backstage/backend-plugin-api": "^0.2.1-next.0"
+    "@backstage/backend-app-api": "^0.3.0",
+    "@backstage/backend-plugin-api": "^0.3.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.1-next.1"
+    "@backstage/backend-test-utils": "^0.1.32",
+    "@backstage/cli": "^0.22.1"
   },
   "files": [
     "dist"