@backstage-community/plugin-rbac-common 1.12.1

package/CHANGELOG.md

@@ -0,0 +1,126 @@
+## @backstage-community/plugin-rbac-common [1.8.2](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.8.1...@backstage-community/plugin-rbac-common@1.8.2) (2024-08-06)
+
+## 1.12.1
+
+### Patch Changes
+
+- 019f010: Migrated from [janus-idp/backstage-plugins](https://github.com/janus-idp/backstage-plugins).
+
+## 1.12.0
+
+### Minor Changes
+
+- 8244f28: chore(deps): update to backstage 1.32
+
+## 1.11.0
+
+### Minor Changes
+
+- d9551ae: feat(deps): update to backstage 1.31
+
+### Patch Changes
+
+- d9551ae: change deps to peer deps in common packages
+- d9551ae: upgrade to yarn v3
+
+### Bug Fixes
+
+- **rbac:** implement conditional aliases ([#1847](https://github.com/janus-idp/backstage-plugins/issues/1847)) ([dbc9a0b](https://github.com/janus-idp/backstage-plugins/commit/dbc9a0bc92f19a4382e406f83b4889905dc6e33d))
+
+## @backstage-community/plugin-rbac-common [1.8.1](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.8.0...@backstage-community/plugin-rbac-common@1.8.1) (2024-08-05)
+
+### Bug Fixes
+
+- **rbac:** add additional validation for permission policies ([#1908](https://github.com/janus-idp/backstage-plugins/issues/1908)) ([592498f](https://github.com/janus-idp/backstage-plugins/commit/592498f34a3b605162d3c242184aa6877b0360e8)), closes [#1939](https://github.com/janus-idp/backstage-plugins/issues/1939)
+
+## @backstage-community/plugin-rbac-common [1.8.0](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.7.2...@backstage-community/plugin-rbac-common@1.8.0) (2024-07-26)
+
+### Features
+
+- **deps:** update to backstage 1.29 ([#1900](https://github.com/janus-idp/backstage-plugins/issues/1900)) ([f53677f](https://github.com/janus-idp/backstage-plugins/commit/f53677fb02d6df43a9de98c43a9f101a6db76802))
+
+## @backstage-community/plugin-rbac-common [1.7.2](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.7.1...@backstage-community/plugin-rbac-common@1.7.2) (2024-07-24)
+
+### Bug Fixes
+
+- **deps:** rollback unreleased plugins ([#1951](https://github.com/janus-idp/backstage-plugins/issues/1951)) ([8b77969](https://github.com/janus-idp/backstage-plugins/commit/8b779694f02f8125587296305276b84cdfeeaebe))
+
+## @backstage-community/plugin-rbac-common [1.7.1](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.7.0...@backstage-community/plugin-rbac-common@1.7.1) (2024-07-19)
+
+## @backstage-community/plugin-rbac-common [1.7.0](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.6.1...@backstage-community/plugin-rbac-common@1.7.0) (2024-07-17)
+
+### Features
+
+- **deps:** update to backstage 1.28 ([#1891](https://github.com/janus-idp/backstage-plugins/issues/1891)) ([1ba1108](https://github.com/janus-idp/backstage-plugins/commit/1ba11088e0de60e90d138944267b83600dc446e5))
+
+## @backstage-community/plugin-rbac-common [1.6.1](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.6.0...@backstage-community/plugin-rbac-common@1.6.1) (2024-06-28)
+
+### Bug Fixes
+
+- **rbac:** correct plugin ID matching to permission policy ([#1795](https://github.com/janus-idp/backstage-plugins/issues/1795)) ([6dc4b1c](https://github.com/janus-idp/backstage-plugins/commit/6dc4b1c23d22252f394eecd8b795ac15507ecc50))
+
+## @backstage-community/plugin-rbac-common [1.6.0](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.5.0...@backstage-community/plugin-rbac-common@1.6.0) (2024-06-13)
+
+### Features
+
+- **deps:** update to backstage 1.27 ([#1683](https://github.com/janus-idp/backstage-plugins/issues/1683)) ([a14869c](https://github.com/janus-idp/backstage-plugins/commit/a14869c3f4177049cb8d6552b36c3ffd17e7997d))
+
+## @backstage-community/plugin-rbac-common [1.5.0](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.4.2...@backstage-community/plugin-rbac-common@1.5.0) (2024-06-04)
+
+### Features
+
+- **rbac:** add audit log for RBAC backend ([#1726](https://github.com/janus-idp/backstage-plugins/issues/1726)) ([e50464b](https://github.com/janus-idp/backstage-plugins/commit/e50464bcb38e9897ddfe208fdeef699e4bfeda3a))
+
+## @backstage-community/plugin-rbac-common [1.4.2](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.4.1...@backstage-community/plugin-rbac-common@1.4.2) (2024-05-09)
+
+## @backstage-community/plugin-rbac-common [1.4.1](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.4.0...@backstage-community/plugin-rbac-common@1.4.1) (2024-04-17)
+
+### Bug Fixes
+
+- **rbac:** reduce the number of permissions returned, add isResourced flag ([#1474](https://github.com/janus-idp/backstage-plugins/issues/1474)) ([e5dda95](https://github.com/janus-idp/backstage-plugins/commit/e5dda95bfc87d1d5d404726cbbe05c8bfdb73845))
+
+## @backstage-community/plugin-rbac-common [1.4.0](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.3.2...@backstage-community/plugin-rbac-common@1.4.0) (2024-04-05)
+
+### Features
+
+- **rbac:** save role modification information to the metadata ([#1280](https://github.com/janus-idp/backstage-plugins/issues/1280)) ([0454509](https://github.com/janus-idp/backstage-plugins/commit/0454509e41db2ae332d1b2bf8f72d34241483efd))
+
+## @backstage-community/plugin-rbac-common [1.3.2](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.3.1...@backstage-community/plugin-rbac-common@1.3.2) (2024-04-04)
+
+### Bug Fixes
+
+- **rbac:** rework condition policies to bound them to RBAC roles ([#1330](https://github.com/janus-idp/backstage-plugins/issues/1330)) ([55c00b2](https://github.com/janus-idp/backstage-plugins/commit/55c00b21b27b449cb0e5100c7b64a6ae742536ac))
+
+## @backstage-community/plugin-rbac-common [1.3.1](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.3.0...@backstage-community/plugin-rbac-common@1.3.1) (2024-03-29)
+
+## @backstage-community/plugin-rbac-common [1.3.0](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.2.1...@backstage-community/plugin-rbac-common@1.3.0) (2024-02-21)
+
+### Features
+
+- **rbac:** backend part - store role description to the database ([#1178](https://github.com/janus-idp/backstage-plugins/issues/1178)) ([ec8b1c2](https://github.com/janus-idp/backstage-plugins/commit/ec8b1c27cce5c36997f84a068dc4cc5cc542f428))
+
+## @backstage-community/plugin-rbac-common [1.2.1](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.2.0...@backstage-community/plugin-rbac-common@1.2.1) (2024-02-02)
+
+### Bug Fixes
+
+- **rbac:** split policies and roles by source ([#1042](https://github.com/janus-idp/backstage-plugins/issues/1042)) ([03a678d](https://github.com/janus-idp/backstage-plugins/commit/03a678d96deeb1d42448e94ac95d735e61393a40)), closes [#1103](https://github.com/janus-idp/backstage-plugins/issues/1103)
+
+## @backstage-community/plugin-rbac-common [1.2.0](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.1.0...@backstage-community/plugin-rbac-common@1.2.0) (2023-12-05)
+
+### Features
+
+- **rbac:** role overview ([#972](https://github.com/janus-idp/backstage-plugins/issues/972)) ([43c1906](https://github.com/janus-idp/backstage-plugins/commit/43c19064e9477a5449ff5d56b00efe27cf640c27))
+
+## @backstage-community/plugin-rbac-common [1.1.0](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.0.1...@backstage-community/plugin-rbac-common@1.1.0) (2023-10-27)
+
+### Features
+
+- **rbac:** implement the concept of roles in rbac ([#867](https://github.com/janus-idp/backstage-plugins/issues/867)) ([4d878a2](https://github.com/janus-idp/backstage-plugins/commit/4d878a29babd86bd7896d69e6b2b63392b6e6cc8))
+
+## @backstage-community/plugin-rbac-common [1.0.1](https://github.com/janus-idp/backstage-plugins/compare/@backstage-community/plugin-rbac-common@1.0.0...@backstage-community/plugin-rbac-common@1.0.1) (2023-10-19)
+
+## @backstage-community/plugin-rbac-common 1.0.0 (2023-09-29)
+
+### Bug Fixes
+
+- **rbac:** remove private package ([#809](https://github.com/janus-idp/backstage-plugins/issues/809)) ([cf59d6d](https://github.com/janus-idp/backstage-plugins/commit/cf59d6d1c5a65363a7ccdd7490d3148d665e7d46))

package/README.md

@@ -0,0 +1,5 @@
+# @backstage-community/plugin-rbac-common
+
+The RBAC plugin provides your Backstage instance with role based access control and policy management.
+
+For more information about RBAC plugin, see the [RBAC plugin documentation](https://github.com/backstage/community-plugins/tree/main/workspaces/rbac/plugins/rbac-backend) on GitHub.

package/dist/index.cjs.js

@@ -0,0 +1,21 @@
+'use strict';
+
+var types = require('./types.cjs.js');
+var permissions = require('./permissions.cjs.js');
+
+
+
+exports.CONDITION_ALIAS_SIGN = types.CONDITION_ALIAS_SIGN;
+exports.ConditionalAliases = types.ConditionalAliases;
+exports.PermissionActionValues = types.PermissionActionValues;
+exports.UnauthorizedError = types.UnauthorizedError;
+exports.isResourcedPolicy = types.isResourcedPolicy;
+exports.isValidPermissionAction = types.isValidPermissionAction;
+exports.toPermissionAction = types.toPermissionAction;
+exports.RESOURCE_TYPE_POLICY_ENTITY = permissions.RESOURCE_TYPE_POLICY_ENTITY;
+exports.policyEntityCreatePermission = permissions.policyEntityCreatePermission;
+exports.policyEntityDeletePermission = permissions.policyEntityDeletePermission;
+exports.policyEntityPermissions = permissions.policyEntityPermissions;
+exports.policyEntityReadPermission = permissions.policyEntityReadPermission;
+exports.policyEntityUpdatePermission = permissions.policyEntityUpdatePermission;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,98 @@
+import { NotAllowedError } from '@backstage/errors';
+import { PermissionAttributes, ConditionalPolicyDecision, ResourcePermission } from '@backstage/plugin-permission-common';
+
+type Source = string;
+type PermissionPolicyMetadata = {
+    source: Source;
+};
+type RoleMetadata = {
+    description?: string;
+    source?: Source;
+    modifiedBy?: string;
+    author?: string;
+    lastModified?: string;
+    createdAt?: string;
+};
+type Policy = {
+    permission?: string;
+    policy?: string;
+};
+type RoleBasedPolicy = Policy & {
+    entityReference?: string;
+    effect?: string;
+    metadata?: PermissionPolicyMetadata;
+};
+type Role = {
+    memberReferences: string[];
+    name: string;
+    metadata?: RoleMetadata;
+};
+type UpdatePolicy = {
+    oldPolicy: Policy;
+    newPolicy: Policy;
+};
+type NamedPolicy = {
+    name: string;
+    policy: string;
+};
+type ResourcedPolicy = NamedPolicy & {
+    resourceType: string;
+};
+type PolicyDetails = NamedPolicy | ResourcedPolicy;
+declare function isResourcedPolicy(policy: PolicyDetails): policy is ResourcedPolicy;
+type PluginPermissionMetaData = {
+    pluginId: string;
+    policies: PolicyDetails[];
+};
+type NonEmptyArray<T> = [T, ...T[]];
+declare const PermissionActionValues: readonly ["create", "read", "update", "delete", "use"];
+type PermissionAction = (typeof PermissionActionValues)[number];
+declare const toPermissionAction: (attr: PermissionAttributes) => PermissionAction;
+declare function isValidPermissionAction(action: string): action is PermissionAction;
+type PermissionInfo = {
+    name: string;
+    action: PermissionAction;
+};
+type RoleConditionalPolicyDecision<T extends PermissionAction | PermissionInfo> = ConditionalPolicyDecision & {
+    id: number;
+    roleEntityRef: string;
+    permissionMapping: T[];
+};
+declare const ConditionalAliases: {
+    readonly CURRENT_USER: "currentUser";
+    readonly OWNER_REFS: "ownerRefs";
+};
+declare const CONDITION_ALIAS_SIGN = "$";
+declare class UnauthorizedError extends NotAllowedError {
+    constructor();
+}
+
+declare const RESOURCE_TYPE_POLICY_ENTITY = "policy-entity";
+/**
+ * Convenience type for permission entity
+ */
+type PolicyEntityPermission = ResourcePermission<typeof RESOURCE_TYPE_POLICY_ENTITY>;
+/**
+ * This permission is used to authorize actions that involve reading
+ * permission policies.
+ */
+declare const policyEntityReadPermission: ResourcePermission<"policy-entity">;
+/**
+ * This permission is used to authorize the creation of new permission policies.
+ */
+declare const policyEntityCreatePermission: ResourcePermission<"policy-entity">;
+/**
+ * This permission is used to authorize actions that involve removing permission
+ * policies.
+ */
+declare const policyEntityDeletePermission: ResourcePermission<"policy-entity">;
+/**
+ * This permission is used to authorize updating permission policies
+ */
+declare const policyEntityUpdatePermission: ResourcePermission<"policy-entity">;
+/**
+ * List of all permissions on permission polices.
+ */
+declare const policyEntityPermissions: ResourcePermission<"policy-entity">[];
+
+export { CONDITION_ALIAS_SIGN, ConditionalAliases, type NamedPolicy, type NonEmptyArray, type PermissionAction, PermissionActionValues, type PermissionInfo, type PermissionPolicyMetadata, type PluginPermissionMetaData, type Policy, type PolicyDetails, type PolicyEntityPermission, RESOURCE_TYPE_POLICY_ENTITY, type ResourcedPolicy, type Role, type RoleBasedPolicy, type RoleConditionalPolicyDecision, type RoleMetadata, type Source, UnauthorizedError, type UpdatePolicy, isResourcedPolicy, isValidPermissionAction, policyEntityCreatePermission, policyEntityDeletePermission, policyEntityPermissions, policyEntityReadPermission, policyEntityUpdatePermission, toPermissionAction };

package/dist/index.esm.js

@@ -0,0 +1,3 @@
+export { CONDITION_ALIAS_SIGN, ConditionalAliases, PermissionActionValues, UnauthorizedError, isResourcedPolicy, isValidPermissionAction, toPermissionAction } from './types.esm.js';
+export { RESOURCE_TYPE_POLICY_ENTITY, policyEntityCreatePermission, policyEntityDeletePermission, policyEntityPermissions, policyEntityReadPermission, policyEntityUpdatePermission } from './permissions.esm.js';
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/permissions.cjs.js

@@ -0,0 +1,47 @@
+'use strict';
+
+var pluginPermissionCommon = require('@backstage/plugin-permission-common');
+
+const RESOURCE_TYPE_POLICY_ENTITY = "policy-entity";
+const policyEntityReadPermission = pluginPermissionCommon.createPermission({
+  name: "policy.entity.read",
+  attributes: {
+    action: "read"
+  },
+  resourceType: RESOURCE_TYPE_POLICY_ENTITY
+});
+const policyEntityCreatePermission = pluginPermissionCommon.createPermission({
+  name: "policy.entity.create",
+  attributes: {
+    action: "create"
+  },
+  resourceType: RESOURCE_TYPE_POLICY_ENTITY
+});
+const policyEntityDeletePermission = pluginPermissionCommon.createPermission({
+  name: "policy.entity.delete",
+  attributes: {
+    action: "delete"
+  },
+  resourceType: RESOURCE_TYPE_POLICY_ENTITY
+});
+const policyEntityUpdatePermission = pluginPermissionCommon.createPermission({
+  name: "policy.entity.update",
+  attributes: {
+    action: "update"
+  },
+  resourceType: RESOURCE_TYPE_POLICY_ENTITY
+});
+const policyEntityPermissions = [
+  policyEntityReadPermission,
+  policyEntityCreatePermission,
+  policyEntityDeletePermission,
+  policyEntityUpdatePermission
+];
+
+exports.RESOURCE_TYPE_POLICY_ENTITY = RESOURCE_TYPE_POLICY_ENTITY;
+exports.policyEntityCreatePermission = policyEntityCreatePermission;
+exports.policyEntityDeletePermission = policyEntityDeletePermission;
+exports.policyEntityPermissions = policyEntityPermissions;
+exports.policyEntityReadPermission = policyEntityReadPermission;
+exports.policyEntityUpdatePermission = policyEntityUpdatePermission;
+//# sourceMappingURL=permissions.cjs.js.map

package/dist/permissions.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.cjs.js","sources":["../src/permissions.ts"],"sourcesContent":["/*\n * Copyright 2024 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 */\nimport {\n  createPermission,\n  ResourcePermission,\n} from '@backstage/plugin-permission-common';\n\nexport const RESOURCE_TYPE_POLICY_ENTITY = 'policy-entity';\n\n/**\n * Convenience type for permission entity\n */\nexport type PolicyEntityPermission = ResourcePermission<\n  typeof RESOURCE_TYPE_POLICY_ENTITY\n>;\n\n/**\n * This permission is used to authorize actions that involve reading\n * permission policies.\n */\nexport const policyEntityReadPermission = createPermission({\n  name: 'policy.entity.read',\n  attributes: {\n    action: 'read',\n  },\n  resourceType: RESOURCE_TYPE_POLICY_ENTITY,\n});\n\n/**\n * This permission is used to authorize the creation of new permission policies.\n */\nexport const policyEntityCreatePermission = createPermission({\n  name: 'policy.entity.create',\n  attributes: {\n    action: 'create',\n  },\n  resourceType: RESOURCE_TYPE_POLICY_ENTITY,\n});\n\n/**\n * This permission is used to authorize actions that involve removing permission\n * policies.\n */\nexport const policyEntityDeletePermission = createPermission({\n  name: 'policy.entity.delete',\n  attributes: {\n    action: 'delete',\n  },\n  resourceType: RESOURCE_TYPE_POLICY_ENTITY,\n});\n\n/**\n * This permission is used to authorize updating permission policies\n */\nexport const policyEntityUpdatePermission = createPermission({\n  name: 'policy.entity.update',\n  attributes: {\n    action: 'update',\n  },\n  resourceType: RESOURCE_TYPE_POLICY_ENTITY,\n});\n\n/**\n * List of all permissions on permission polices.\n */\nexport const policyEntityPermissions = [\n  policyEntityReadPermission,\n  policyEntityCreatePermission,\n  policyEntityDeletePermission,\n  policyEntityUpdatePermission,\n];\n"],"names":["createPermission"],"mappings":";;;;AAoBO,MAAM,2BAA8B,GAAA,gBAAA;AAapC,MAAM,6BAA6BA,uCAAiB,CAAA;AAAA,EACzD,IAAM,EAAA,oBAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA,MAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA,2BAAA;AAChB,CAAC,EAAA;AAKM,MAAM,+BAA+BA,uCAAiB,CAAA;AAAA,EAC3D,IAAM,EAAA,sBAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA,QAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA,2BAAA;AAChB,CAAC,EAAA;AAMM,MAAM,+BAA+BA,uCAAiB,CAAA;AAAA,EAC3D,IAAM,EAAA,sBAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA,QAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA,2BAAA;AAChB,CAAC,EAAA;AAKM,MAAM,+BAA+BA,uCAAiB,CAAA;AAAA,EAC3D,IAAM,EAAA,sBAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA,QAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA,2BAAA;AAChB,CAAC,EAAA;AAKM,MAAM,uBAA0B,GAAA;AAAA,EACrC,0BAAA;AAAA,EACA,4BAAA;AAAA,EACA,4BAAA;AAAA,EACA,4BAAA;AACF;;;;;;;;;"}

package/dist/permissions.esm.js

@@ -0,0 +1,40 @@
+import { createPermission } from '@backstage/plugin-permission-common';
+
+const RESOURCE_TYPE_POLICY_ENTITY = "policy-entity";
+const policyEntityReadPermission = createPermission({
+  name: "policy.entity.read",
+  attributes: {
+    action: "read"
+  },
+  resourceType: RESOURCE_TYPE_POLICY_ENTITY
+});
+const policyEntityCreatePermission = createPermission({
+  name: "policy.entity.create",
+  attributes: {
+    action: "create"
+  },
+  resourceType: RESOURCE_TYPE_POLICY_ENTITY
+});
+const policyEntityDeletePermission = createPermission({
+  name: "policy.entity.delete",
+  attributes: {
+    action: "delete"
+  },
+  resourceType: RESOURCE_TYPE_POLICY_ENTITY
+});
+const policyEntityUpdatePermission = createPermission({
+  name: "policy.entity.update",
+  attributes: {
+    action: "update"
+  },
+  resourceType: RESOURCE_TYPE_POLICY_ENTITY
+});
+const policyEntityPermissions = [
+  policyEntityReadPermission,
+  policyEntityCreatePermission,
+  policyEntityDeletePermission,
+  policyEntityUpdatePermission
+];
+
+export { RESOURCE_TYPE_POLICY_ENTITY, policyEntityCreatePermission, policyEntityDeletePermission, policyEntityPermissions, policyEntityReadPermission, policyEntityUpdatePermission };
+//# sourceMappingURL=permissions.esm.js.map

package/dist/permissions.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.esm.js","sources":["../src/permissions.ts"],"sourcesContent":["/*\n * Copyright 2024 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 */\nimport {\n  createPermission,\n  ResourcePermission,\n} from '@backstage/plugin-permission-common';\n\nexport const RESOURCE_TYPE_POLICY_ENTITY = 'policy-entity';\n\n/**\n * Convenience type for permission entity\n */\nexport type PolicyEntityPermission = ResourcePermission<\n  typeof RESOURCE_TYPE_POLICY_ENTITY\n>;\n\n/**\n * This permission is used to authorize actions that involve reading\n * permission policies.\n */\nexport const policyEntityReadPermission = createPermission({\n  name: 'policy.entity.read',\n  attributes: {\n    action: 'read',\n  },\n  resourceType: RESOURCE_TYPE_POLICY_ENTITY,\n});\n\n/**\n * This permission is used to authorize the creation of new permission policies.\n */\nexport const policyEntityCreatePermission = createPermission({\n  name: 'policy.entity.create',\n  attributes: {\n    action: 'create',\n  },\n  resourceType: RESOURCE_TYPE_POLICY_ENTITY,\n});\n\n/**\n * This permission is used to authorize actions that involve removing permission\n * policies.\n */\nexport const policyEntityDeletePermission = createPermission({\n  name: 'policy.entity.delete',\n  attributes: {\n    action: 'delete',\n  },\n  resourceType: RESOURCE_TYPE_POLICY_ENTITY,\n});\n\n/**\n * This permission is used to authorize updating permission policies\n */\nexport const policyEntityUpdatePermission = createPermission({\n  name: 'policy.entity.update',\n  attributes: {\n    action: 'update',\n  },\n  resourceType: RESOURCE_TYPE_POLICY_ENTITY,\n});\n\n/**\n * List of all permissions on permission polices.\n */\nexport const policyEntityPermissions = [\n  policyEntityReadPermission,\n  policyEntityCreatePermission,\n  policyEntityDeletePermission,\n  policyEntityUpdatePermission,\n];\n"],"names":[],"mappings":";;AAoBO,MAAM,2BAA8B,GAAA,gBAAA;AAapC,MAAM,6BAA6B,gBAAiB,CAAA;AAAA,EACzD,IAAM,EAAA,oBAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA,MAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA,2BAAA;AAChB,CAAC,EAAA;AAKM,MAAM,+BAA+B,gBAAiB,CAAA;AAAA,EAC3D,IAAM,EAAA,sBAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA,QAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA,2BAAA;AAChB,CAAC,EAAA;AAMM,MAAM,+BAA+B,gBAAiB,CAAA;AAAA,EAC3D,IAAM,EAAA,sBAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA,QAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA,2BAAA;AAChB,CAAC,EAAA;AAKM,MAAM,+BAA+B,gBAAiB,CAAA;AAAA,EAC3D,IAAM,EAAA,sBAAA;AAAA,EACN,UAAY,EAAA;AAAA,IACV,MAAQ,EAAA,QAAA;AAAA,GACV;AAAA,EACA,YAAc,EAAA,2BAAA;AAChB,CAAC,EAAA;AAKM,MAAM,uBAA0B,GAAA;AAAA,EACrC,0BAAA;AAAA,EACA,4BAAA;AAAA,EACA,4BAAA;AAAA,EACA,4BAAA;AACF;;;;"}

package/dist/types.cjs.js

@@ -0,0 +1,37 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+
+function isResourcedPolicy(policy) {
+  return "resourceType" in policy;
+}
+const PermissionActionValues = [
+  "create",
+  "read",
+  "update",
+  "delete",
+  "use"
+];
+const toPermissionAction = (attr) => attr.action ?? "use";
+function isValidPermissionAction(action) {
+  return PermissionActionValues.includes(action);
+}
+const ConditionalAliases = {
+  CURRENT_USER: "currentUser",
+  OWNER_REFS: "ownerRefs"
+};
+const CONDITION_ALIAS_SIGN = "$";
+class UnauthorizedError extends errors.NotAllowedError {
+  constructor() {
+    super("Unauthorized");
+  }
+}
+
+exports.CONDITION_ALIAS_SIGN = CONDITION_ALIAS_SIGN;
+exports.ConditionalAliases = ConditionalAliases;
+exports.PermissionActionValues = PermissionActionValues;
+exports.UnauthorizedError = UnauthorizedError;
+exports.isResourcedPolicy = isResourcedPolicy;
+exports.isValidPermissionAction = isValidPermissionAction;
+exports.toPermissionAction = toPermissionAction;
+//# sourceMappingURL=types.cjs.js.map

package/dist/types.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs.js","sources":["../src/types.ts"],"sourcesContent":["/*\n * Copyright 2024 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 */\nimport { NotAllowedError } from '@backstage/errors';\nimport {\n  ConditionalPolicyDecision,\n  PermissionAttributes,\n} from '@backstage/plugin-permission-common';\n\n// 'rest' created via REST API\n// 'csv-file' created via policies-csv-file with defined path in the application configuration\n// 'configuration' created from application configuration\n// 'legacy'; preexisting policies\nexport type Source = string;\n\nexport type PermissionPolicyMetadata = {\n  source: Source;\n};\n\nexport type RoleMetadata = {\n  description?: string;\n  source?: Source;\n  modifiedBy?: string;\n  author?: string;\n  lastModified?: string;\n  createdAt?: string;\n};\n\nexport type Policy = {\n  permission?: string;\n  policy?: string;\n};\n\nexport type RoleBasedPolicy = Policy & {\n  entityReference?: string;\n  effect?: string;\n  metadata?: PermissionPolicyMetadata;\n};\n\nexport type Role = {\n  memberReferences: string[];\n  name: string;\n  metadata?: RoleMetadata;\n};\n\nexport type UpdatePolicy = {\n  oldPolicy: Policy;\n  newPolicy: Policy;\n};\n\nexport type NamedPolicy = {\n  name: string;\n\n  policy: string;\n};\n\nexport type ResourcedPolicy = NamedPolicy & {\n  resourceType: string;\n};\n\nexport type PolicyDetails = NamedPolicy | ResourcedPolicy;\n\nexport function isResourcedPolicy(\n  policy: PolicyDetails,\n): policy is ResourcedPolicy {\n  return 'resourceType' in policy;\n}\n\nexport type PluginPermissionMetaData = {\n  pluginId: string;\n  policies: PolicyDetails[];\n};\n\nexport type NonEmptyArray<T> = [T, ...T[]];\n\n// Permission framework attributes action has values: 'create' | 'read' | 'update' | 'delete' | undefined.\n// But we are introducing an action named \"use\" when action does not exist('undefined') to avoid\n// a more complicated model with multiple policy and request shapes.\nexport const PermissionActionValues = [\n  'create',\n  'read',\n  'update',\n  'delete',\n  'use',\n] as const;\nexport type PermissionAction = (typeof PermissionActionValues)[number];\nexport const toPermissionAction = (\n  attr: PermissionAttributes,\n): PermissionAction => attr.action ?? 'use';\n\nexport function isValidPermissionAction(\n  action: string,\n): action is PermissionAction {\n  return (PermissionActionValues as readonly string[]).includes(action);\n}\n\nexport type PermissionInfo = {\n  name: string;\n  action: PermissionAction;\n};\n\n// Frontend should use RoleConditionalPolicyDecision<PermissionAction>\nexport type RoleConditionalPolicyDecision<\n  T extends PermissionAction | PermissionInfo,\n> = ConditionalPolicyDecision & {\n  id: number;\n  roleEntityRef: string;\n\n  permissionMapping: T[];\n};\n\nexport const ConditionalAliases = {\n  CURRENT_USER: 'currentUser',\n  OWNER_REFS: 'ownerRefs',\n} as const;\n\nexport const CONDITION_ALIAS_SIGN = '$';\n\n// UnauthorizedError should be uniformely used for authorization errors.\nexport class UnauthorizedError extends NotAllowedError {\n  constructor() {\n    super('Unauthorized');\n  }\n}\n"],"names":["NotAllowedError"],"mappings":";;;;AA0EO,SAAS,kBACd,MAC2B,EAAA;AAC3B,EAAA,OAAO,cAAkB,IAAA,MAAA,CAAA;AAC3B,CAAA;AAYO,MAAM,sBAAyB,GAAA;AAAA,EACpC,QAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AACF,EAAA;AAEO,MAAM,kBAAqB,GAAA,CAChC,IACqB,KAAA,IAAA,CAAK,MAAU,IAAA,MAAA;AAE/B,SAAS,wBACd,MAC4B,EAAA;AAC5B,EAAQ,OAAA,sBAAA,CAA6C,SAAS,MAAM,CAAA,CAAA;AACtE,CAAA;AAiBO,MAAM,kBAAqB,GAAA;AAAA,EAChC,YAAc,EAAA,aAAA;AAAA,EACd,UAAY,EAAA,WAAA;AACd,EAAA;AAEO,MAAM,oBAAuB,GAAA,IAAA;AAG7B,MAAM,0BAA0BA,sBAAgB,CAAA;AAAA,EACrD,WAAc,GAAA;AACZ,IAAA,KAAA,CAAM,cAAc,CAAA,CAAA;AAAA,GACtB;AACF;;;;;;;;;;"}

package/dist/types.esm.js

@@ -0,0 +1,29 @@
+import { NotAllowedError } from '@backstage/errors';
+
+function isResourcedPolicy(policy) {
+  return "resourceType" in policy;
+}
+const PermissionActionValues = [
+  "create",
+  "read",
+  "update",
+  "delete",
+  "use"
+];
+const toPermissionAction = (attr) => attr.action ?? "use";
+function isValidPermissionAction(action) {
+  return PermissionActionValues.includes(action);
+}
+const ConditionalAliases = {
+  CURRENT_USER: "currentUser",
+  OWNER_REFS: "ownerRefs"
+};
+const CONDITION_ALIAS_SIGN = "$";
+class UnauthorizedError extends NotAllowedError {
+  constructor() {
+    super("Unauthorized");
+  }
+}
+
+export { CONDITION_ALIAS_SIGN, ConditionalAliases, PermissionActionValues, UnauthorizedError, isResourcedPolicy, isValidPermissionAction, toPermissionAction };
+//# sourceMappingURL=types.esm.js.map

package/dist/types.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.esm.js","sources":["../src/types.ts"],"sourcesContent":["/*\n * Copyright 2024 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 */\nimport { NotAllowedError } from '@backstage/errors';\nimport {\n  ConditionalPolicyDecision,\n  PermissionAttributes,\n} from '@backstage/plugin-permission-common';\n\n// 'rest' created via REST API\n// 'csv-file' created via policies-csv-file with defined path in the application configuration\n// 'configuration' created from application configuration\n// 'legacy'; preexisting policies\nexport type Source = string;\n\nexport type PermissionPolicyMetadata = {\n  source: Source;\n};\n\nexport type RoleMetadata = {\n  description?: string;\n  source?: Source;\n  modifiedBy?: string;\n  author?: string;\n  lastModified?: string;\n  createdAt?: string;\n};\n\nexport type Policy = {\n  permission?: string;\n  policy?: string;\n};\n\nexport type RoleBasedPolicy = Policy & {\n  entityReference?: string;\n  effect?: string;\n  metadata?: PermissionPolicyMetadata;\n};\n\nexport type Role = {\n  memberReferences: string[];\n  name: string;\n  metadata?: RoleMetadata;\n};\n\nexport type UpdatePolicy = {\n  oldPolicy: Policy;\n  newPolicy: Policy;\n};\n\nexport type NamedPolicy = {\n  name: string;\n\n  policy: string;\n};\n\nexport type ResourcedPolicy = NamedPolicy & {\n  resourceType: string;\n};\n\nexport type PolicyDetails = NamedPolicy | ResourcedPolicy;\n\nexport function isResourcedPolicy(\n  policy: PolicyDetails,\n): policy is ResourcedPolicy {\n  return 'resourceType' in policy;\n}\n\nexport type PluginPermissionMetaData = {\n  pluginId: string;\n  policies: PolicyDetails[];\n};\n\nexport type NonEmptyArray<T> = [T, ...T[]];\n\n// Permission framework attributes action has values: 'create' | 'read' | 'update' | 'delete' | undefined.\n// But we are introducing an action named \"use\" when action does not exist('undefined') to avoid\n// a more complicated model with multiple policy and request shapes.\nexport const PermissionActionValues = [\n  'create',\n  'read',\n  'update',\n  'delete',\n  'use',\n] as const;\nexport type PermissionAction = (typeof PermissionActionValues)[number];\nexport const toPermissionAction = (\n  attr: PermissionAttributes,\n): PermissionAction => attr.action ?? 'use';\n\nexport function isValidPermissionAction(\n  action: string,\n): action is PermissionAction {\n  return (PermissionActionValues as readonly string[]).includes(action);\n}\n\nexport type PermissionInfo = {\n  name: string;\n  action: PermissionAction;\n};\n\n// Frontend should use RoleConditionalPolicyDecision<PermissionAction>\nexport type RoleConditionalPolicyDecision<\n  T extends PermissionAction | PermissionInfo,\n> = ConditionalPolicyDecision & {\n  id: number;\n  roleEntityRef: string;\n\n  permissionMapping: T[];\n};\n\nexport const ConditionalAliases = {\n  CURRENT_USER: 'currentUser',\n  OWNER_REFS: 'ownerRefs',\n} as const;\n\nexport const CONDITION_ALIAS_SIGN = '$';\n\n// UnauthorizedError should be uniformely used for authorization errors.\nexport class UnauthorizedError extends NotAllowedError {\n  constructor() {\n    super('Unauthorized');\n  }\n}\n"],"names":[],"mappings":";;AA0EO,SAAS,kBACd,MAC2B,EAAA;AAC3B,EAAA,OAAO,cAAkB,IAAA,MAAA,CAAA;AAC3B,CAAA;AAYO,MAAM,sBAAyB,GAAA;AAAA,EACpC,QAAA;AAAA,EACA,MAAA;AAAA,EACA,QAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AACF,EAAA;AAEO,MAAM,kBAAqB,GAAA,CAChC,IACqB,KAAA,IAAA,CAAK,MAAU,IAAA,MAAA;AAE/B,SAAS,wBACd,MAC4B,EAAA;AAC5B,EAAQ,OAAA,sBAAA,CAA6C,SAAS,MAAM,CAAA,CAAA;AACtE,CAAA;AAiBO,MAAM,kBAAqB,GAAA;AAAA,EAChC,YAAc,EAAA,aAAA;AAAA,EACd,UAAY,EAAA,WAAA;AACd,EAAA;AAEO,MAAM,oBAAuB,GAAA,IAAA;AAG7B,MAAM,0BAA0B,eAAgB,CAAA;AAAA,EACrD,WAAc,GAAA;AACZ,IAAA,KAAA,CAAM,cAAc,CAAA,CAAA;AAAA,GACtB;AACF;;;;"}

package/package.json

@@ -0,0 +1,70 @@
+{
+  "name": "@backstage-community/plugin-rbac-common",
+  "description": "Common functionalities for the rbac-common plugin",
+  "version": "1.12.1",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "common-library",
+    "supported-versions": "1.32.5",
+    "pluginId": "rbac",
+    "pluginPackages": [
+      "@backstage-community/plugin-rbac",
+      "@backstage-community/plugin-rbac-backend",
+      "@backstage-community/plugin-rbac-common",
+      "@backstage-community/plugin-rbac-node"
+    ]
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "backstage-cli package build",
+    "tsc": "tsc",
+    "prettier:check": "prettier --ignore-unknown --check .",
+    "prettier:fix": "prettier --ignore-unknown --write .",
+    "lint:check": "backstage-cli package lint",
+    "lint:fix": "backstage-cli package lint --fix",
+    "test": "backstage-cli package test --passWithNoTests --coverage",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "peerDependencies": {
+    "@backstage/errors": "^1.2.4",
+    "@backstage/plugin-permission-common": "^0.8.1"
+  },
+  "devDependencies": {
+    "@backstage/cli": "0.28.2",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/plugin-permission-common": "^0.8.1",
+    "@spotify/prettier-config": "^15.0.0",
+    "prettier": "3.3.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/community-plugins",
+    "directory": "workspaces/rbac/plugins/rbac-common"
+  },
+  "keywords": [
+    "support:production",
+    "lifecycle:active",
+    "backstage",
+    "plugin"
+  ],
+  "homepage": "https://red.ht/rhdh",
+  "bugs": "https://github.com/backstage/community-plugins/issues",
+  "maintainers": [
+    "@PatAKnight"
+  ],
+  "author": "Red Hat",
+  "module": "dist/index.esm.js"
+}