@backstage/plugin-notifications-backend 0.6.6 → 0.6.7-next.1

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 (4) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/config.schema.json +160 -0
  3. package/package.json +21 -21
  4. package/config.d.ts +0 -75
package/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
1
1
  # @backstage/plugin-notifications-backend
2
2
 
3
+ ## 0.6.7-next.1
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+ - @backstage/backend-openapi-utils@0.7.0-next.1
9
+ - @backstage/backend-plugin-api@1.9.3-next.1
10
+
11
+ ## 0.6.7-next.0
12
+
13
+ ### Patch Changes
14
+
15
+ - Updated dependencies
16
+ - @backstage/backend-plugin-api@1.9.3-next.0
17
+ - @backstage/plugin-catalog-node@2.2.3-next.0
18
+ - @backstage/plugin-notifications-node@0.2.28-next.0
19
+ - @backstage/backend-openapi-utils@0.6.11-next.0
20
+ - @backstage/plugin-signals-node@0.2.3-next.0
21
+
3
22
  ## 0.6.6
4
23
 
5
24
  ### Patch Changes
package/config.schema.json ADDED
@@ -0,0 +1,160 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "notifications": {
6
+ "type": "object",
7
+ "properties": {
8
+ "concurrencyLimit": {
9
+ "type": "number",
10
+ "description": "Concurrency limit for notification sending, defaults to 10"
11
+ },
12
+ "throttleInterval": {
13
+ "anyOf": [
14
+ {
15
+ "type": "object",
16
+ "properties": {
17
+ "years": {
18
+ "type": "number"
19
+ },
20
+ "months": {
21
+ "type": "number"
22
+ },
23
+ "weeks": {
24
+ "type": "number"
25
+ },
26
+ "days": {
27
+ "type": "number"
28
+ },
29
+ "hours": {
30
+ "type": "number"
31
+ },
32
+ "minutes": {
33
+ "type": "number"
34
+ },
35
+ "seconds": {
36
+ "type": "number"
37
+ },
38
+ "milliseconds": {
39
+ "type": "number"
40
+ }
41
+ },
42
+ "description": "Human friendly durations object."
43
+ },
44
+ {
45
+ "type": "string"
46
+ }
47
+ ],
48
+ "description": "Throttle duration between notification sending, defaults to 50ms"
49
+ },
50
+ "defaultSettings": {
51
+ "type": "object",
52
+ "properties": {
53
+ "channels": {
54
+ "type": "array",
55
+ "items": {
56
+ "type": "object",
57
+ "properties": {
58
+ "id": {
59
+ "type": "string",
60
+ "description": "Channel identifier (e.g., 'Web', 'Email')"
61
+ },
62
+ "enabled": {
63
+ "type": "boolean",
64
+ "description": "Optional flag to enable/disable the channel by default. If not set, defaults to true for backwards compatibility. When set to false, the channel uses an opt-in strategy where origins are disabled by default unless explicitly enabled."
65
+ },
66
+ "origins": {
67
+ "type": "array",
68
+ "items": {
69
+ "type": "object",
70
+ "properties": {
71
+ "id": {
72
+ "type": "string",
73
+ "description": "Origin identifier (e.g., 'plugin:catalog', 'external:jenkins')"
74
+ },
75
+ "enabled": {
76
+ "type": "boolean",
77
+ "description": "Whether notifications from this origin are enabled by default"
78
+ },
79
+ "topics": {
80
+ "type": "array",
81
+ "items": {
82
+ "type": "object",
83
+ "properties": {
84
+ "id": {
85
+ "type": "string",
86
+ "description": "Topic identifier (e.g., 'entity-refresh', 'build-failure')"
87
+ },
88
+ "enabled": {
89
+ "type": "boolean",
90
+ "description": "Whether notifications for this topic are enabled by default"
91
+ }
92
+ },
93
+ "required": [
94
+ "id",
95
+ "enabled"
96
+ ]
97
+ }
98
+ }
99
+ },
100
+ "required": [
101
+ "id",
102
+ "enabled"
103
+ ]
104
+ }
105
+ }
106
+ },
107
+ "required": [
108
+ "id"
109
+ ]
110
+ }
111
+ }
112
+ },
113
+ "description": "Default settings for user specific notification settings"
114
+ },
115
+ "retention": {
116
+ "anyOf": [
117
+ {
118
+ "type": "object",
119
+ "properties": {
120
+ "years": {
121
+ "type": "number"
122
+ },
123
+ "months": {
124
+ "type": "number"
125
+ },
126
+ "weeks": {
127
+ "type": "number"
128
+ },
129
+ "days": {
130
+ "type": "number"
131
+ },
132
+ "hours": {
133
+ "type": "number"
134
+ },
135
+ "minutes": {
136
+ "type": "number"
137
+ },
138
+ "seconds": {
139
+ "type": "number"
140
+ },
141
+ "milliseconds": {
142
+ "type": "number"
143
+ }
144
+ },
145
+ "description": "Human friendly durations object."
146
+ },
147
+ {
148
+ "type": "string"
149
+ },
150
+ {
151
+ "type": "boolean",
152
+ "const": false
153
+ }
154
+ ]
155
+ }
156
+ },
157
+ "description": "Configuration options for notifications-backend"
158
+ }
159
+ }
160
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-notifications-backend",
3
- "version": "0.6.6",
3
+ "version": "0.6.7-next.1",
4
4
  "backstage": {
5
5
  "role": "backend-plugin",
6
6
  "pluginId": "notifications",
@@ -32,7 +32,7 @@
32
32
  "types": "dist/index.d.ts",
33
33
  "files": [
34
34
  "dist",
35
- "config.d.ts",
35
+ "config.schema.json",
36
36
  "migrations/**/*.{js,d.ts}"
37
37
  ],
38
38
  "scripts": {
@@ -46,35 +46,35 @@
46
46
  "test": "backstage-cli package test"
47
47
  },
48
48
  "dependencies": {
49
- "@backstage/backend-openapi-utils": "^0.6.10",
50
- "@backstage/backend-plugin-api": "^1.9.2",
51
- "@backstage/catalog-model": "^1.9.0",
52
- "@backstage/config": "^1.3.8",
53
- "@backstage/errors": "^1.3.1",
54
- "@backstage/plugin-catalog-node": "^2.2.2",
55
- "@backstage/plugin-notifications-common": "^0.2.3",
56
- "@backstage/plugin-notifications-node": "^0.2.27",
57
- "@backstage/plugin-signals-node": "^0.2.2",
58
- "@backstage/types": "^1.2.2",
49
+ "@backstage/backend-openapi-utils": "0.7.0-next.1",
50
+ "@backstage/backend-plugin-api": "1.9.3-next.1",
51
+ "@backstage/catalog-model": "1.9.0",
52
+ "@backstage/config": "1.3.8",
53
+ "@backstage/errors": "1.3.1",
54
+ "@backstage/plugin-catalog-node": "2.2.3-next.0",
55
+ "@backstage/plugin-notifications-common": "0.2.3",
56
+ "@backstage/plugin-notifications-node": "0.2.28-next.0",
57
+ "@backstage/plugin-signals-node": "0.2.3-next.0",
58
+ "@backstage/types": "1.2.2",
59
59
  "express": "^4.22.0",
60
60
  "express-promise-router": "^4.1.0",
61
61
  "knex": "^3.0.0",
62
62
  "p-throttle": "^4.1.1"
63
63
  },
64
64
  "devDependencies": {
65
- "@backstage/backend-defaults": "^0.17.3",
66
- "@backstage/backend-test-utils": "^1.11.4",
67
- "@backstage/cli": "^0.36.3",
68
- "@backstage/plugin-auth-backend": "^0.29.1",
69
- "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.20",
70
- "@backstage/plugin-events-backend": "^0.6.3",
71
- "@backstage/plugin-signals-backend": "^0.3.16",
72
- "@backstage/repo-tools": "^0.17.3",
65
+ "@backstage/backend-defaults": "0.17.5-next.2",
66
+ "@backstage/backend-test-utils": "1.11.5-next.0",
67
+ "@backstage/cli": "0.36.4-next.2",
68
+ "@backstage/plugin-auth-backend": "0.29.2-next.1",
69
+ "@backstage/plugin-auth-backend-module-guest-provider": "0.2.21-next.0",
70
+ "@backstage/plugin-events-backend": "0.6.4-next.1",
71
+ "@backstage/plugin-signals-backend": "0.3.17-next.0",
72
+ "@backstage/repo-tools": "0.18.0-next.1",
73
73
  "@types/express": "^4.17.6",
74
74
  "@types/supertest": "^2.0.8",
75
75
  "supertest": "^7.0.0"
76
76
  },
77
- "configSchema": "config.d.ts",
77
+ "configSchema": "config.schema.json",
78
78
  "typesVersions": {
79
79
  "*": {
80
80
  "package.json": [
package/config.d.ts DELETED
@@ -1,75 +0,0 @@
1
- /*
2
- * Copyright 2024 The Backstage Authors
3
- *
4
- * Licensed under the Apache License, Version 2.0 (the "License");
5
- * you may not use this file except in compliance with the License.
6
- * You may obtain a copy of the License at
7
- *
8
- * http://www.apache.org/licenses/LICENSE-2.0
9
- *
10
- * Unless required by applicable law or agreed to in writing, software
11
- * distributed under the License is distributed on an "AS IS" BASIS,
12
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
- * See the License for the specific language governing permissions and
14
- * limitations under the License.
15
- */
16
- import { HumanDuration } from '@backstage/types';
17
-
18
- export interface Config {
19
- /**
20
- * Configuration options for notifications-backend
21
- */
22
- notifications?: {
23
- /**
24
- * Concurrency limit for notification sending, defaults to 10
25
- */
26
- concurrencyLimit?: number;
27
- /**
28
- * Throttle duration between notification sending, defaults to 50ms
29
- */
30
- throttleInterval?: HumanDuration | string;
31
- /**
32
- * Default settings for user specific notification settings
33
- */
34
- defaultSettings?: {
35
- channels?: {
36
- /**
37
- * Channel identifier (e.g., 'Web', 'Email')
38
- */
39
- id: string;
40
- /**
41
- * Optional flag to enable/disable the channel by default.
42
- * If not set, defaults to true for backwards compatibility.
43
- * When set to false, the channel uses an opt-in strategy where
44
- * origins are disabled by default unless explicitly enabled.
45
- */
46
- enabled?: boolean;
47
- origins?: {
48
- /**
49
- * Origin identifier (e.g., 'plugin:catalog', 'external:jenkins')
50
- */
51
- id: string;
52
- /**
53
- * Whether notifications from this origin are enabled by default
54
- */
55
- enabled: boolean;
56
- topics?: {
57
- /**
58
- * Topic identifier (e.g., 'entity-refresh', 'build-failure')
59
- */
60
- id: string;
61
- /**
62
- * Whether notifications for this topic are enabled by default
63
- */
64
- enabled: boolean;
65
- }[];
66
- }[];
67
- }[];
68
- };
69
- /*
70
- * Time to keep the notifications in the database, defaults to 365 days.
71
- * Can be disabled by setting to false.
72
- */
73
- retention?: HumanDuration | string | false;
74
- };
75
- }