@backstage/plugin-permission-node 0.7.7-next.1 → 0.7.7

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/plugin-permission-node
 
+## 0.7.7
+
+### Patch Changes
+
+- 788f0f5a152: Introduced alpha export of the `policyExtensionPoint` for use in the new backend system.
+- 71fd0966d10: Added createConditionAuthorizer utility function, which takes some permission conditions and returns a function that returns a definitive authorization result given a decision and a resource.
+- 1e4f5e91b8e: Bump `zod` and `zod-to-json-schema` dependencies.
+- Updated dependencies
+  - @backstage/backend-common@0.18.4
+  - @backstage/plugin-permission-common@0.7.5
+  - @backstage/plugin-auth-node@0.2.13
+  - @backstage/backend-plugin-api@0.5.1
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+
+## 0.7.7-next.2
+
+### Patch Changes
+
+- 788f0f5a152: Introduced alpha export of the `policyExtensionPoint` for use in the new backend system.
+- Updated dependencies
+  - @backstage/backend-common@0.18.4-next.2
+  - @backstage/backend-plugin-api@0.5.1-next.2
+  - @backstage/config@1.0.7
+  - @backstage/errors@1.1.5
+  - @backstage/plugin-auth-node@0.2.13-next.2
+  - @backstage/plugin-permission-common@0.7.5-next.0
+
 ## 0.7.7-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-permission-node",
+  "version": "0.7.7",
+  "main": "../dist/alpha.cjs.js",
+  "types": "../dist/alpha.d.ts"
+}

package/dist/alpha.cjs.js

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+const policyExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "permission.policy"
+});
+
+exports.policyExtensionPoint = policyExtensionPoint;
+//# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alpha.cjs.js","sources":["../src/plugin.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 { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { PermissionPolicy } from '@backstage/plugin-permission-node';\n\n/**\n * Allows supplying policies to the permissions backend\n *\n * @alpha\n */\nexport type PolicyExtensionPoint = {\n  setPolicy(policy: PermissionPolicy): void;\n};\n\n/**\n * Allows supplying policies to the permissions backend\n *\n * @alpha\n */\nexport const policyExtensionPoint = createExtensionPoint<PolicyExtensionPoint>({\n  id: 'permission.policy',\n});\n"],"names":["createExtensionPoint"],"mappings":";;;;;;AAiCO,MAAM,uBAAuBA,qCAA2C,CAAA;AAAA,EAC7E,EAAI,EAAA,mBAAA;AACN,CAAC;;;;"}

package/dist/alpha.d.ts

@@ -0,0 +1,19 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { PermissionPolicy } from '@backstage/plugin-permission-node';
+
+/**
+ * Allows supplying policies to the permissions backend
+ *
+ * @alpha
+ */
+type PolicyExtensionPoint = {
+    setPolicy(policy: PermissionPolicy): void;
+};
+/**
+ * Allows supplying policies to the permissions backend
+ *
+ * @alpha
+ */
+declare const policyExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<PolicyExtensionPoint>;
+
+export { PolicyExtensionPoint, policyExtensionPoint };

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
 import { PermissionCriteria, AllOfCriteria, AnyOfCriteria, NotCriteria, PermissionRuleParams, PermissionCondition, ResourcePermission, ConditionalPolicyDecision, IdentifiedPermissionMessage, DefinitivePolicyDecision, Permission, PolicyDecision, PermissionEvaluator, QueryPermissionRequest, EvaluatorRequestOptions, AuthorizePermissionRequest, AuthorizePermissionResponse } from '@backstage/plugin-permission-common';
 import { z } from 'zod';
 import express from 'express';
@@ -13,7 +12,7 @@ import { Config } from '@backstage/config';
  * https://github.com/Microsoft/TypeScript/issues/14829#issuecomment-980401795
  * @ignore
  */
-declare type NoInfer<T> = T extends infer S ? S : never;
+type NoInfer<T> = T extends infer S ? S : never;
 /**
  * Utility function used to parse a PermissionCriteria
  * @param criteria - a PermissionCriteria
@@ -58,7 +57,7 @@ declare const isNotCriteria: <T>(criteria: PermissionCriteria<T>) => criteria is
  *
  * @public
  */
-declare type PermissionRule<TResource, TQuery, TResourceType extends string, TParams extends PermissionRuleParams = PermissionRuleParams> = {
+type PermissionRule<TResource, TQuery, TResourceType extends string, TParams extends PermissionRuleParams = PermissionRuleParams> = {
     name: string;
     description: string;
     resourceType: TResourceType;
@@ -104,14 +103,14 @@ declare const createConditionFactory: <TResourceType extends string, TParams ext
  *
  * @public
  */
-declare type Condition<TRule> = TRule extends PermissionRule<any, any, infer TResourceType, infer TParams> ? undefined extends TParams ? () => PermissionCondition<TResourceType, TParams> : (params: TParams) => PermissionCondition<TResourceType, TParams> : never;
+type Condition<TRule> = TRule extends PermissionRule<any, any, infer TResourceType, infer TParams> ? undefined extends TParams ? () => PermissionCondition<TResourceType, TParams> : (params: TParams) => PermissionCondition<TResourceType, TParams> : never;
 /**
  * A utility type for mapping {@link PermissionRule}s to their corresponding
  * {@link @backstage/plugin-permission-common#PermissionCondition}s.
  *
  * @public
  */
-declare type Conditions<TRules extends Record<string, PermissionRule<any, any, any>>> = {
+type Conditions<TRules extends Record<string, PermissionRule<any, any, any>>> = {
     [Name in keyof TRules]: Condition<TRules[Name]>;
 };
 /**
@@ -134,13 +133,13 @@ declare type Conditions<TRules extends Record<string, PermissionRule<any, any, a
  *
  * @public
  */
-declare const createConditionExports: <TResourceType extends string, TResource, TRules extends Record<string, PermissionRule<TResource, any, TResourceType, _backstage_plugin_permission_common.PermissionRuleParams>>>(options: {
+declare const createConditionExports: <TResourceType extends string, TResource, TRules extends Record<string, PermissionRule<TResource, any, TResourceType>>>(options: {
     pluginId: string;
     resourceType: TResourceType;
     rules: TRules;
 }) => {
     conditions: Conditions<TRules>;
-    createConditionalDecision: (permission: ResourcePermission<TResourceType>, conditions: PermissionCriteria<PermissionCondition<TResourceType, _backstage_plugin_permission_common.PermissionRuleParams>>) => ConditionalPolicyDecision;
+    createConditionalDecision: (permission: ResourcePermission<TResourceType>, conditions: PermissionCriteria<PermissionCondition<TResourceType>>) => ConditionalPolicyDecision;
 };
 
 /**
@@ -151,7 +150,7 @@ declare const createConditionExports: <TResourceType extends string, TResource,
  *
  * @public
  */
-declare type ConditionTransformer<TQuery> = (conditions: PermissionCriteria<PermissionCondition>) => PermissionCriteria<TQuery>;
+type ConditionTransformer<TQuery> = (conditions: PermissionCriteria<PermissionCondition>) => PermissionCriteria<TQuery>;
 /**
  * A higher-order helper function which accepts an array of
  * {@link PermissionRule}s, and returns a {@link ConditionTransformer}
@@ -160,7 +159,7 @@ declare type ConditionTransformer<TQuery> = (conditions: PermissionCriteria<Perm
  *
  * @public
  */
-declare const createConditionTransformer: <TQuery, TRules extends PermissionRule<any, TQuery, string, _backstage_plugin_permission_common.PermissionRuleParams>[]>(permissionRules: [...TRules]) => ConditionTransformer<TQuery>;
+declare const createConditionTransformer: <TQuery, TRules extends PermissionRule<any, TQuery, string>[]>(permissionRules: [...TRules]) => ConditionTransformer<TQuery>;
 
 /**
  * A request to load the referenced resource and apply conditions in order to
@@ -168,7 +167,7 @@ declare const createConditionTransformer: <TQuery, TRules extends PermissionRule
  *
  * @public
  */
-declare type ApplyConditionsRequestEntry = IdentifiedPermissionMessage<{
+type ApplyConditionsRequestEntry = IdentifiedPermissionMessage<{
     resourceRef: string;
     resourceType: string;
     conditions: PermissionCriteria<PermissionCondition>;
@@ -178,7 +177,7 @@ declare type ApplyConditionsRequestEntry = IdentifiedPermissionMessage<{
  *
  * @public
  */
-declare type ApplyConditionsRequest = {
+type ApplyConditionsRequest = {
     items: ApplyConditionsRequestEntry[];
 };
 /**
@@ -187,13 +186,13 @@ declare type ApplyConditionsRequest = {
  *
  * @public
  */
-declare type ApplyConditionsResponseEntry = IdentifiedPermissionMessage<DefinitivePolicyDecision>;
+type ApplyConditionsResponseEntry = IdentifiedPermissionMessage<DefinitivePolicyDecision>;
 /**
  * A batch of {@link ApplyConditionsResponseEntry} objects.
  *
  * @public
  */
-declare type ApplyConditionsResponse = {
+type ApplyConditionsResponse = {
     items: ApplyConditionsResponseEntry[];
 };
 /**
@@ -202,7 +201,7 @@ declare type ApplyConditionsResponse = {
  *
  * @public
  */
-declare type MetadataResponseSerializedRule = {
+type MetadataResponseSerializedRule = {
     name: string;
     description: string;
     resourceType: string;
@@ -213,7 +212,7 @@ declare type MetadataResponseSerializedRule = {
  *
  * @public
  */
-declare type MetadataResponse = {
+type MetadataResponse = {
     permissions?: Permission[];
     rules: MetadataResponseSerializedRule[];
 };
@@ -224,14 +223,14 @@ declare type MetadataResponse = {
  *
  * @public
  */
-declare const createConditionAuthorizer: <TResource, TQuery>(rules: PermissionRule<TResource, TQuery, string, _backstage_plugin_permission_common.PermissionRuleParams>[]) => (decision: PolicyDecision, resource: TResource | undefined) => boolean;
+declare const createConditionAuthorizer: <TResource, TQuery>(rules: PermissionRule<TResource, TQuery, string>[]) => (decision: PolicyDecision, resource: TResource | undefined) => boolean;
 /**
  * Options for creating a permission integration router specific
  * for a particular resource type.
  *
  * @public
  */
-declare type CreatePermissionIntegrationRouterResourceOptions<TResourceType extends string, TResource> = {
+type CreatePermissionIntegrationRouterResourceOptions<TResourceType extends string, TResource> = {
     resourceType: TResourceType;
     permissions?: Array<Permission>;
     rules: PermissionRule<TResource, any, NoInfer<TResourceType>>[];
@@ -312,7 +311,7 @@ declare const makeCreatePermissionRule: <TResource, TQuery, TResourceType extend
  *
  * @public
  */
-declare type PolicyQuery = {
+type PolicyQuery = {
     permission: Permission;
 };
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-permission-node",
   "description": "Common permission and authorization utilities for backend plugins",
-  "version": "0.7.7-next.1",
+  "version": "0.7.7",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -10,6 +10,19 @@
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"
   },
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs.js",
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.cjs.js"
+    },
+    "./alpha": {
+      "require": "./dist/alpha.cjs.js",
+      "types": "./dist/alpha.d.ts",
+      "default": "./dist/alpha.cjs.js"
+    },
+    "./package.json": "./package.json"
+  },
   "backstage": {
     "role": "node-library"
   },
@@ -33,11 +46,12 @@
     "start": "backstage-cli package start"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.18.4-next.1",
+    "@backstage/backend-common": "^0.18.4",
+    "@backstage/backend-plugin-api": "^0.5.1",
     "@backstage/config": "^1.0.7",
     "@backstage/errors": "^1.1.5",
-    "@backstage/plugin-auth-node": "^0.2.13-next.1",
-    "@backstage/plugin-permission-common": "^0.7.5-next.0",
+    "@backstage/plugin-auth-node": "^0.2.13",
+    "@backstage/plugin-permission-common": "^0.7.5",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
@@ -45,13 +59,14 @@
     "zod-to-json-schema": "^3.20.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.36-next.1",
-    "@backstage/cli": "^0.22.6-next.1",
+    "@backstage/backend-test-utils": "^0.1.36",
+    "@backstage/cli": "^0.22.6",
     "@types/supertest": "^2.0.8",
     "msw": "^1.0.0",
     "supertest": "^6.1.3"
   },
   "files": [
-    "dist"
+    "dist",
+    "alpha"
   ]
 }