@backstage/backend-plugin-api 1.0.3-next.0 → 1.1.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @backstage/backend-plugin-api
 
+## 1.1.0-next.2
+
+### Patch Changes
+
+- 0e9c9fa: The `RootLifecycleService` now has a new `addBeforeShutdownHook` method, and hooks added through this method will run immediately when a termination event is received.
+
+  The backend will not proceed with the shutdown and run the `Shutdown` hooks until all `BeforeShutdown` hooks have completed.
+
+- Updated dependencies
+  - @backstage/errors@1.2.6-next.0
+  - @backstage/plugin-auth-node@0.5.5-next.2
+  - @backstage/cli-common@0.1.15
+  - @backstage/config@1.3.1-next.0
+  - @backstage/types@1.2.0
+  - @backstage/plugin-permission-common@0.8.3-next.0
+
+## 1.1.0-next.1
+
+### Minor Changes
+
+- 12eac85: **EXPERIMENTAL**: Adds a new `instanceMetadataService` to hold information about a specific backend instance.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.5.5-next.1
+  - @backstage/cli-common@0.1.15
+  - @backstage/config@1.3.0
+  - @backstage/errors@1.2.5
+  - @backstage/types@1.2.0
+  - @backstage/plugin-permission-common@0.8.2
+
 ## 1.0.3-next.0
 
 ### Patch Changes

package/dist/alpha.cjs.js

@@ -6,6 +6,10 @@ const featureDiscoveryServiceRef = backendPluginApi.createServiceRef({
   id: "core.featureDiscovery",
   scope: "root"
 });
+const instanceMetadataServiceRef = backendPluginApi.createServiceRef({
+  id: "core.instanceMetadata"
+});
 
 exports.featureDiscoveryServiceRef = featureDiscoveryServiceRef;
+exports.instanceMetadataServiceRef = instanceMetadataServiceRef;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 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  BackendFeature,\n  createServiceRef,\n} from '@backstage/backend-plugin-api';\n\n/** @alpha */\nexport interface FeatureDiscoveryService {\n  getBackendFeatures(): Promise<{ features: Array<BackendFeature> }>;\n}\n\n/**\n * An optional service that can be used to dynamically load in additional BackendFeatures at runtime.\n * @alpha\n * @deprecated The `featureDiscoveryServiceRef` is deprecated in favor of using {@link @backstage/backend-defaults#discoveryFeatureLoader} instead.\n */\nexport const featureDiscoveryServiceRef =\n  createServiceRef<FeatureDiscoveryService>({\n    id: 'core.featureDiscovery',\n    scope: 'root',\n  });\n"],"names":["createServiceRef"],"mappings":";;;;AA+BO,MAAM,6BACXA,iCAA0C,CAAA;AAAA,EACxC,EAAI,EAAA,uBAAA;AAAA,EACJ,KAAO,EAAA;AACT,CAAC;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 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  BackendFeature,\n  createServiceRef,\n} from '@backstage/backend-plugin-api';\n\n/** @alpha */\nexport interface FeatureDiscoveryService {\n  getBackendFeatures(): Promise<{ features: Array<BackendFeature> }>;\n}\n\n/**\n * An optional service that can be used to dynamically load in additional BackendFeatures at runtime.\n * @alpha\n * @deprecated The `featureDiscoveryServiceRef` is deprecated in favor of using {@link @backstage/backend-defaults#discoveryFeatureLoader} instead.\n */\nexport const featureDiscoveryServiceRef =\n  createServiceRef<FeatureDiscoveryService>({\n    id: 'core.featureDiscovery',\n    scope: 'root',\n  });\n\n/**\n * EXPERIMENTAL: Instance metadata service.\n *\n * @alpha\n */\nexport const instanceMetadataServiceRef = createServiceRef<\n  import('./services/definitions/InstanceMetadataService').InstanceMetadataService\n>({\n  id: 'core.instanceMetadata',\n});\n\nexport type {\n  BackendFeatureMeta,\n  InstanceMetadataService,\n} from './services/definitions/InstanceMetadataService';\n"],"names":["createServiceRef"],"mappings":";;;;AA+BO,MAAM,6BACXA,iCAA0C,CAAA;AAAA,EACxC,EAAI,EAAA,uBAAA;AAAA,EACJ,KAAO,EAAA;AACT,CAAC;AAOI,MAAM,6BAA6BA,iCAExC,CAAA;AAAA,EACA,EAAI,EAAA;AACN,CAAC;;;;;"}

package/dist/alpha.d.ts

@@ -1,6 +1,20 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { BackendFeature } from '@backstage/backend-plugin-api';
 
+/** @alpha */
+type BackendFeatureMeta = {
+    type: 'plugin';
+    pluginId: string;
+} | {
+    type: 'module';
+    pluginId: string;
+    moduleId: string;
+};
+/** @alpha */
+interface InstanceMetadataService {
+    getInstalledFeatures: () => BackendFeatureMeta[];
+}
+
 /** @alpha */
 interface FeatureDiscoveryService {
     getBackendFeatures(): Promise<{
@@ -13,5 +27,11 @@ interface FeatureDiscoveryService {
  * @deprecated The `featureDiscoveryServiceRef` is deprecated in favor of using {@link @backstage/backend-defaults#discoveryFeatureLoader} instead.
  */
 declare const featureDiscoveryServiceRef: _backstage_backend_plugin_api.ServiceRef<FeatureDiscoveryService, "root", "singleton">;
+/**
+ * EXPERIMENTAL: Instance metadata service.
+ *
+ * @alpha
+ */
+declare const instanceMetadataServiceRef: _backstage_backend_plugin_api.ServiceRef<InstanceMetadataService, "plugin", "singleton">;
 
-export { type FeatureDiscoveryService, featureDiscoveryServiceRef };
+export { type BackendFeatureMeta, type FeatureDiscoveryService, type InstanceMetadataService, featureDiscoveryServiceRef, instanceMetadataServiceRef };

package/dist/index.d.ts

@@ -726,6 +726,7 @@ interface LifecycleService {
  * @public
  */
 interface RootLifecycleService extends LifecycleService {
+    addBeforeShutdownHook(hook: () => void | Promise<void>): void;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-plugin-api",
-  "version": "1.0.3-next.0",
+  "version": "1.1.0-next.2",
   "description": "Core API used by Backstage backend plugins",
   "backstage": {
     "role": "node-library"
@@ -66,10 +66,10 @@
   },
   "dependencies": {
     "@backstage/cli-common": "0.1.15",
-    "@backstage/config": "1.3.0",
-    "@backstage/errors": "1.2.5",
-    "@backstage/plugin-auth-node": "0.5.5-next.0",
-    "@backstage/plugin-permission-common": "0.8.2",
+    "@backstage/config": "1.3.1-next.0",
+    "@backstage/errors": "1.2.6-next.0",
+    "@backstage/plugin-auth-node": "0.5.5-next.2",
+    "@backstage/plugin-permission-common": "0.8.3-next.0",
     "@backstage/types": "1.2.0",
     "@types/express": "^4.17.6",
     "@types/luxon": "^3.0.0",
@@ -77,8 +77,8 @@
     "luxon": "^3.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.2.0-next.0",
-    "@backstage/cli": "0.29.3-next.0"
+    "@backstage/backend-test-utils": "1.2.0-next.2",
+    "@backstage/cli": "0.29.3-next.2"
   },
   "configSchema": "config.d.ts"
 }