@backstage/backend-plugin-api 1.2.0-next.0 → 1.2.0-next.1

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/backend-plugin-api
 
+## 1.2.0-next.1
+
+### Minor Changes
+
+- 92a56f6: **BREAKING ALPHA**: Removed the deprecated `featureDiscoveryServiceRef` and `FeatureDiscoveryService`.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.6.0-next.1
+  - @backstage/cli-common@0.1.15
+  - @backstage/config@1.3.2
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-permission-common@0.8.4
+  - @backstage/plugin-permission-node@0.8.8-next.1
+
 ## 1.2.0-next.0
 
 ### Minor Changes

package/dist/alpha.cjs.js

@@ -2,14 +2,9 @@
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
 
-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\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;;;;;"}
+{"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 { createServiceRef } from '@backstage/backend-plugin-api';\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":";;;;AAuBO,MAAM,6BAA6BA,iCAExC,CAAA;AAAA,EACA,EAAI,EAAA;AACN,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -1,5 +1,4 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { BackendFeature } from '@backstage/backend-plugin-api';
 
 /** @alpha */
 type BackendFeatureMeta = {
@@ -15,18 +14,6 @@ interface InstanceMetadataService {
     getInstalledFeatures: () => BackendFeatureMeta[];
 }
 
-/** @alpha */
-interface FeatureDiscoveryService {
-    getBackendFeatures(): Promise<{
-        features: Array<BackendFeature>;
-    }>;
-}
-/**
- * An optional service that can be used to dynamically load in additional BackendFeatures at runtime.
- * @alpha
- * @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.
  *
@@ -34,4 +21,4 @@ declare const featureDiscoveryServiceRef: _backstage_backend_plugin_api.ServiceR
  */
 declare const instanceMetadataServiceRef: _backstage_backend_plugin_api.ServiceRef<InstanceMetadataService, "plugin", "singleton">;
 
-export { type BackendFeatureMeta, type FeatureDiscoveryService, type InstanceMetadataService, featureDiscoveryServiceRef, instanceMetadataServiceRef };
+export { type BackendFeatureMeta, type InstanceMetadataService, instanceMetadataServiceRef };

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { JsonObject, HumanDuration, JsonValue } from '@backstage/types';
 import { Request, Response, Handler } from 'express';
 import { PermissionAttributes, EvaluatorRequestOptions, PermissionEvaluator, AuthorizePermissionRequest, AuthorizePermissionResponse, QueryPermissionRequest, QueryPermissionResponse, Permission } from '@backstage/plugin-permission-common';
 import { Knex } from 'knex';
-import { PermissionRule } from '@backstage/plugin-permission-node';
+import { PermissionResourceRef, PermissionRule, PermissionRuleset } from '@backstage/plugin-permission-node';
 import { Config } from '@backstage/config';
 import { Duration } from 'luxon';
 import { Readable } from 'stream';
@@ -661,11 +661,11 @@ type NoInfer<T> = T extends infer S ? S : never;
  *
  * @public
  */
-type PermissionsRegistryServiceAddResourceTypeOptions<TResourceType extends string, TResource> = {
+type PermissionsRegistryServiceAddResourceTypeOptions<TResourceType extends string, TResource, TQuery> = {
     /**
-     * The identifier for the resource type.
+     * The {@link @backstage/plugin-permission-node#PermissionResourceRef} that identifies the resource type.
      */
-    resourceType: TResourceType;
+    resourceRef: PermissionResourceRef<TResource, TQuery, TResourceType>;
     /**
      * Permissions that are available for this resource type.
      */
@@ -673,7 +673,7 @@ type PermissionsRegistryServiceAddResourceTypeOptions<TResourceType extends stri
     /**
      * Permission rules that are available for this resource type.
      */
-    rules: PermissionRule<TResource, any, NoInfer<TResourceType>>[];
+    rules: PermissionRule<NoInfer<TResource>, NoInfer<TQuery>, NoInfer<TResourceType>>[];
     /**
      * The function used to load associated resources based in the provided
      * references.
@@ -684,7 +684,7 @@ type PermissionsRegistryServiceAddResourceTypeOptions<TResourceType extends stri
      * resolve conditional decisions except when requesting resources directly
      * from the plugin.
      */
-    getResources?(resourceRefs: string[]): Promise<Array<TResource | undefined>>;
+    getResources?(resourceRefs: string[]): Promise<Array<NoInfer<TResource> | undefined>>;
 };
 /**
  * Permission system integration for registering resources and permissions.
@@ -744,7 +744,15 @@ interface PermissionsRegistryService {
      * called by the `permission-backend` when authorization conditions relating
      * to this plugin need to be evaluated.
      */
-    addResourceType<const TResourceType extends string, TResource>(options: PermissionsRegistryServiceAddResourceTypeOptions<TResourceType, TResource>): void;
+    addResourceType<const TResourceType extends string, TResource, TQuery>(options: PermissionsRegistryServiceAddResourceTypeOptions<TResourceType, TResource, TQuery>): void;
+    /**
+     * Returns the set of registered rules for this resource.
+     *
+     * @remarks
+     *
+     * Primarily intended for use with {@link @backstage/plugin-permission-node#createConditionAuthorizer} and {@link @backstage/plugin-permission-node#createConditionTransformer}.
+     */
+    getPermissionRuleset<TResourceType extends string, TResource, TQuery>(resourceRef: PermissionResourceRef<TResource, TQuery, TResourceType>): PermissionRuleset<TResource, TQuery, TResourceType>;
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-plugin-api",
-  "version": "1.2.0-next.0",
+  "version": "1.2.0-next.1",
   "description": "Core API used by Backstage backend plugins",
   "backstage": {
     "role": "node-library"
@@ -68,9 +68,9 @@
     "@backstage/cli-common": "0.1.15",
     "@backstage/config": "1.3.2",
     "@backstage/errors": "1.2.7",
-    "@backstage/plugin-auth-node": "0.5.7-next.0",
+    "@backstage/plugin-auth-node": "0.6.0-next.1",
     "@backstage/plugin-permission-common": "0.8.4",
-    "@backstage/plugin-permission-node": "0.8.8-next.0",
+    "@backstage/plugin-permission-node": "0.8.8-next.1",
     "@backstage/types": "1.2.1",
     "@types/express": "^4.17.6",
     "@types/luxon": "^3.0.0",
@@ -78,8 +78,8 @@
     "luxon": "^3.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.3.0-next.0",
-    "@backstage/cli": "0.30.0-next.0"
+    "@backstage/backend-test-utils": "1.3.0-next.2",
+    "@backstage/cli": "0.30.0-next.2"
   },
   "configSchema": "config.d.ts"
 }