@backstage/plugin-permission-common 0.5.1 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/index.d.ts +14 -0
  3. package/package.json +3 -3
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @backstage/plugin-permission-common
2
2
 
3
+ ## 0.5.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 79b9d8a861: Add api doc comments to `Permission` type properties.
8
+
3
9
  ## 0.5.1
4
10
 
5
11
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -20,8 +20,22 @@ declare type PermissionAttributes = {
20
20
  * @public
21
21
  */
22
22
  declare type Permission = {
23
+ /**
24
+ * The name of the permission.
25
+ */
23
26
  name: string;
27
+ /**
28
+ * {@link PermissionAttributes} which describe characteristics of the permission, to help
29
+ * policy authors make consistent decisions for similar permissions without referring to them
30
+ * all by name.
31
+ */
24
32
  attributes: PermissionAttributes;
33
+ /**
34
+ * Some permissions can be authorized based on characteristics of a resource
35
+ * such a catalog entity. For these permissions, the resourceType field
36
+ * denotes the type of the resource whose resourceRef should be passed when
37
+ * authorizing.
38
+ */
25
39
  resourceType?: string;
26
40
  };
27
41
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@backstage/plugin-permission-common",
3
3
  "description": "Isomorphic types and client for Backstage permissions and authorization",
4
- "version": "0.5.1",
4
+ "version": "0.5.2",
5
5
  "main": "dist/index.cjs.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "publishConfig": {
@@ -48,10 +48,10 @@
48
48
  "zod": "^3.11.6"
49
49
  },
50
50
  "devDependencies": {
51
- "@backstage/cli": "^0.14.0",
51
+ "@backstage/cli": "^0.15.0",
52
52
  "@types/jest": "^26.0.7",
53
53
  "msw": "^0.35.0"
54
54
  },
55
- "gitHead": "e244b348c473700e7d5e5fbcef38bd9f9fd1d0ba",
55
+ "gitHead": "04bb0dd824b78f6b57dac62c3015e681f094045c",
56
56
  "module": "dist/index.esm.js"
57
57
  }