@backstage/plugin-user-settings-backend 0.3.10-next.0 → 0.3.10
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.
- package/CHANGELOG.md +18 -0
- package/dist/service/router.cjs.js +3 -3
- package/dist/service/router.cjs.js.map +1 -1
- package/package.json +11 -11
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# @backstage/plugin-user-settings-backend
|
|
2
2
|
|
|
3
|
+
## 0.3.10
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- ad01e54: Resolves an issue where user setting keys containing slashes returned 404 not found.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/backend-defaults@0.15.0
|
|
10
|
+
- @backstage/backend-plugin-api@1.6.1
|
|
11
|
+
- @backstage/plugin-auth-node@0.6.11
|
|
12
|
+
|
|
13
|
+
## 0.3.10-next.1
|
|
14
|
+
|
|
15
|
+
### Patch Changes
|
|
16
|
+
|
|
17
|
+
- Updated dependencies
|
|
18
|
+
- @backstage/backend-defaults@0.15.0-next.2
|
|
19
|
+
- @backstage/plugin-auth-node@0.6.10
|
|
20
|
+
|
|
3
21
|
## 0.3.10-next.0
|
|
4
22
|
|
|
5
23
|
### Patch Changes
|
|
@@ -18,7 +18,7 @@ async function createRouter(options) {
|
|
|
18
18
|
});
|
|
19
19
|
return credentials.principal.userEntityRef;
|
|
20
20
|
};
|
|
21
|
-
router.get("/buckets/:bucket/keys/:key", async (req, res) => {
|
|
21
|
+
router.get("/buckets/:bucket/keys/:key(*)", async (req, res) => {
|
|
22
22
|
const userEntityRef = await getUserEntityRef(req);
|
|
23
23
|
const { bucket, key } = req.params;
|
|
24
24
|
const setting = await options.userSettingsStore.get({
|
|
@@ -28,7 +28,7 @@ async function createRouter(options) {
|
|
|
28
28
|
});
|
|
29
29
|
res.json(setting);
|
|
30
30
|
});
|
|
31
|
-
router.put("/buckets/:bucket/keys/:key", async (req, res) => {
|
|
31
|
+
router.put("/buckets/:bucket/keys/:key(*)", async (req, res) => {
|
|
32
32
|
const userEntityRef = await getUserEntityRef(req);
|
|
33
33
|
const { bucket, key } = req.params;
|
|
34
34
|
const { value } = req.body;
|
|
@@ -55,7 +55,7 @@ async function createRouter(options) {
|
|
|
55
55
|
}
|
|
56
56
|
res.json(setting);
|
|
57
57
|
});
|
|
58
|
-
router.delete("/buckets/:bucket/keys/:key", async (req, res) => {
|
|
58
|
+
router.delete("/buckets/:bucket/keys/:key(*)", async (req, res) => {
|
|
59
59
|
const userEntityRef = await getUserEntityRef(req);
|
|
60
60
|
const { bucket, key } = req.params;
|
|
61
61
|
await options.userSettingsStore.delete({ userEntityRef, bucket, key });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { InputError } from '@backstage/errors';\nimport express, { Request } from 'express';\nimport Router from 'express-promise-router';\nimport { UserSettingsStore } from '../database/UserSettingsStore';\nimport { SignalsService } from '@backstage/plugin-signals-node';\nimport { UserSettingsSignal } from '@backstage/plugin-user-settings-common';\nimport { HttpAuthService } from '@backstage/backend-plugin-api';\n\nexport async function createRouter(options: {\n httpAuth: HttpAuthService;\n userSettingsStore: UserSettingsStore;\n signals: SignalsService;\n}): Promise<express.Router> {\n const router = Router();\n router.use(express.json());\n\n /**\n * Helper method to extract the userEntityRef from the request.\n */\n const getUserEntityRef = async (req: Request): Promise<string> => {\n const credentials = await options.httpAuth.credentials(req, {\n allow: ['user'],\n });\n return credentials.principal.userEntityRef;\n };\n\n // get a single value\n router.get('/buckets/:bucket/keys/:key', async (req, res) => {\n const userEntityRef = await getUserEntityRef(req);\n const { bucket, key } = req.params;\n\n const setting = await options.userSettingsStore.get({\n userEntityRef,\n bucket,\n key,\n });\n\n res.json(setting);\n });\n\n // set a single value\n router.put('/buckets/:bucket/keys/:key', async (req, res) => {\n const userEntityRef = await getUserEntityRef(req);\n const { bucket, key } = req.params;\n const { value } = req.body;\n\n if (value === undefined) {\n throw new InputError('Missing required field \"value\"');\n }\n\n await options.userSettingsStore.set({\n userEntityRef,\n bucket,\n key,\n value,\n });\n const setting = await options.userSettingsStore.get({\n userEntityRef,\n bucket,\n key,\n });\n\n if (options.signals) {\n await options.signals.publish<UserSettingsSignal>({\n recipients: { type: 'user', entityRef: userEntityRef },\n channel: `user-settings`,\n message: { type: 'key-changed', key },\n });\n }\n\n res.json(setting);\n });\n\n //
|
|
1
|
+
{"version":3,"file":"router.cjs.js","sources":["../../src/service/router.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { InputError } from '@backstage/errors';\nimport express, { Request } from 'express';\nimport Router from 'express-promise-router';\nimport { UserSettingsStore } from '../database/UserSettingsStore';\nimport { SignalsService } from '@backstage/plugin-signals-node';\nimport { UserSettingsSignal } from '@backstage/plugin-user-settings-common';\nimport { HttpAuthService } from '@backstage/backend-plugin-api';\n\nexport async function createRouter(options: {\n httpAuth: HttpAuthService;\n userSettingsStore: UserSettingsStore;\n signals: SignalsService;\n}): Promise<express.Router> {\n const router = Router();\n router.use(express.json());\n\n /**\n * Helper method to extract the userEntityRef from the request.\n */\n const getUserEntityRef = async (req: Request): Promise<string> => {\n const credentials = await options.httpAuth.credentials(req, {\n allow: ['user'],\n });\n return credentials.principal.userEntityRef;\n };\n\n // get a single value\n router.get('/buckets/:bucket/keys/:key(*)', async (req, res) => {\n const userEntityRef = await getUserEntityRef(req);\n const { bucket, key } = req.params;\n\n const setting = await options.userSettingsStore.get({\n userEntityRef,\n bucket,\n key,\n });\n\n res.json(setting);\n });\n\n // set a single value\n router.put('/buckets/:bucket/keys/:key(*)', async (req, res) => {\n const userEntityRef = await getUserEntityRef(req);\n const { bucket, key } = req.params;\n const { value } = req.body;\n\n if (value === undefined) {\n throw new InputError('Missing required field \"value\"');\n }\n\n await options.userSettingsStore.set({\n userEntityRef,\n bucket,\n key,\n value,\n });\n const setting = await options.userSettingsStore.get({\n userEntityRef,\n bucket,\n key,\n });\n\n if (options.signals) {\n await options.signals.publish<UserSettingsSignal>({\n recipients: { type: 'user', entityRef: userEntityRef },\n channel: `user-settings`,\n message: { type: 'key-changed', key },\n });\n }\n\n res.json(setting);\n });\n\n // delete a single value\n router.delete('/buckets/:bucket/keys/:key(*)', async (req, res) => {\n const userEntityRef = await getUserEntityRef(req);\n const { bucket, key } = req.params;\n\n await options.userSettingsStore.delete({ userEntityRef, bucket, key });\n if (options.signals) {\n await options.signals.publish<UserSettingsSignal>({\n recipients: { type: 'user', entityRef: userEntityRef },\n channel: 'user-settings',\n message: { type: 'key-deleted', key },\n });\n }\n\n res.status(204).end();\n });\n\n return router;\n}\n"],"names":["Router","express","InputError"],"mappings":";;;;;;;;;;;AAwBA,eAAsB,aAAa,OAAA,EAIP;AAC1B,EAAA,MAAM,SAASA,uBAAA,EAAO;AACtB,EAAA,MAAA,CAAO,GAAA,CAAIC,wBAAA,CAAQ,IAAA,EAAM,CAAA;AAKzB,EAAA,MAAM,gBAAA,GAAmB,OAAO,GAAA,KAAkC;AAChE,IAAA,MAAM,WAAA,GAAc,MAAM,OAAA,CAAQ,QAAA,CAAS,YAAY,GAAA,EAAK;AAAA,MAC1D,KAAA,EAAO,CAAC,MAAM;AAAA,KACf,CAAA;AACD,IAAA,OAAO,YAAY,SAAA,CAAU,aAAA;AAAA,EAC/B,CAAA;AAGA,EAAA,MAAA,CAAO,GAAA,CAAI,+BAAA,EAAiC,OAAO,GAAA,EAAK,GAAA,KAAQ;AAC9D,IAAA,MAAM,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,GAAA,CAAI,MAAA;AAE5B,IAAA,MAAM,OAAA,GAAU,MAAM,OAAA,CAAQ,iBAAA,CAAkB,GAAA,CAAI;AAAA,MAClD,aAAA;AAAA,MACA,MAAA;AAAA,MACA;AAAA,KACD,CAAA;AAED,IAAA,GAAA,CAAI,KAAK,OAAO,CAAA;AAAA,EAClB,CAAC,CAAA;AAGD,EAAA,MAAA,CAAO,GAAA,CAAI,+BAAA,EAAiC,OAAO,GAAA,EAAK,GAAA,KAAQ;AAC9D,IAAA,MAAM,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,GAAA,CAAI,MAAA;AAC5B,IAAA,MAAM,EAAE,KAAA,EAAM,GAAI,GAAA,CAAI,IAAA;AAEtB,IAAA,IAAI,UAAU,MAAA,EAAW;AACvB,MAAA,MAAM,IAAIC,kBAAW,gCAAgC,CAAA;AAAA,IACvD;AAEA,IAAA,MAAM,OAAA,CAAQ,kBAAkB,GAAA,CAAI;AAAA,MAClC,aAAA;AAAA,MACA,MAAA;AAAA,MACA,GAAA;AAAA,MACA;AAAA,KACD,CAAA;AACD,IAAA,MAAM,OAAA,GAAU,MAAM,OAAA,CAAQ,iBAAA,CAAkB,GAAA,CAAI;AAAA,MAClD,aAAA;AAAA,MACA,MAAA;AAAA,MACA;AAAA,KACD,CAAA;AAED,IAAA,IAAI,QAAQ,OAAA,EAAS;AACnB,MAAA,MAAM,OAAA,CAAQ,QAAQ,OAAA,CAA4B;AAAA,QAChD,UAAA,EAAY,EAAE,IAAA,EAAM,MAAA,EAAQ,WAAW,aAAA,EAAc;AAAA,QACrD,OAAA,EAAS,CAAA,aAAA,CAAA;AAAA,QACT,OAAA,EAAS,EAAE,IAAA,EAAM,aAAA,EAAe,GAAA;AAAI,OACrC,CAAA;AAAA,IACH;AAEA,IAAA,GAAA,CAAI,KAAK,OAAO,CAAA;AAAA,EAClB,CAAC,CAAA;AAGD,EAAA,MAAA,CAAO,MAAA,CAAO,+BAAA,EAAiC,OAAO,GAAA,EAAK,GAAA,KAAQ;AACjE,IAAA,MAAM,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAA,EAAI,GAAI,GAAA,CAAI,MAAA;AAE5B,IAAA,MAAM,QAAQ,iBAAA,CAAkB,MAAA,CAAO,EAAE,aAAA,EAAe,MAAA,EAAQ,KAAK,CAAA;AACrE,IAAA,IAAI,QAAQ,OAAA,EAAS;AACnB,MAAA,MAAM,OAAA,CAAQ,QAAQ,OAAA,CAA4B;AAAA,QAChD,UAAA,EAAY,EAAE,IAAA,EAAM,MAAA,EAAQ,WAAW,aAAA,EAAc;AAAA,QACrD,OAAA,EAAS,eAAA;AAAA,QACT,OAAA,EAAS,EAAE,IAAA,EAAM,aAAA,EAAe,GAAA;AAAI,OACrC,CAAA;AAAA,IACH;AAEA,IAAA,GAAA,CAAI,MAAA,CAAO,GAAG,CAAA,CAAE,GAAA,EAAI;AAAA,EACtB,CAAC,CAAA;AAED,EAAA,OAAO,MAAA;AACT;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-user-settings-backend",
|
|
3
|
-
"version": "0.3.10
|
|
3
|
+
"version": "0.3.10",
|
|
4
4
|
"description": "The Backstage backend plugin to manage user settings",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin",
|
|
@@ -56,21 +56,21 @@
|
|
|
56
56
|
"test": "backstage-cli package test"
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
|
-
"@backstage/backend-defaults": "0.
|
|
60
|
-
"@backstage/backend-plugin-api": "1.6.
|
|
61
|
-
"@backstage/errors": "1.2.7",
|
|
62
|
-
"@backstage/plugin-auth-node": "0.6.
|
|
63
|
-
"@backstage/plugin-signals-node": "0.1.27",
|
|
64
|
-
"@backstage/plugin-user-settings-common": "0.0.1",
|
|
65
|
-
"@backstage/types": "1.2.2",
|
|
59
|
+
"@backstage/backend-defaults": "^0.15.0",
|
|
60
|
+
"@backstage/backend-plugin-api": "^1.6.1",
|
|
61
|
+
"@backstage/errors": "^1.2.7",
|
|
62
|
+
"@backstage/plugin-auth-node": "^0.6.11",
|
|
63
|
+
"@backstage/plugin-signals-node": "^0.1.27",
|
|
64
|
+
"@backstage/plugin-user-settings-common": "^0.0.1",
|
|
65
|
+
"@backstage/types": "^1.2.2",
|
|
66
66
|
"express": "^4.22.0",
|
|
67
67
|
"express-promise-router": "^4.1.0",
|
|
68
68
|
"knex": "^3.0.0"
|
|
69
69
|
},
|
|
70
70
|
"devDependencies": {
|
|
71
|
-
"@backstage/backend-defaults": "0.
|
|
72
|
-
"@backstage/backend-test-utils": "1.10.3
|
|
73
|
-
"@backstage/cli": "0.35.2
|
|
71
|
+
"@backstage/backend-defaults": "^0.15.0",
|
|
72
|
+
"@backstage/backend-test-utils": "^1.10.3",
|
|
73
|
+
"@backstage/cli": "^0.35.2",
|
|
74
74
|
"@types/express": "^4.17.6",
|
|
75
75
|
"@types/supertest": "^2.0.8",
|
|
76
76
|
"supertest": "^7.0.0"
|