@backstage/plugin-user-settings-backend 0.4.1-next.1 → 0.4.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.
- package/CHANGELOG.md +10 -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,15 @@
|
|
|
1
1
|
# @backstage/plugin-user-settings-backend
|
|
2
2
|
|
|
3
|
+
## 0.4.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- a49a40d: Updated dependency `zod` to `^3.25.76 || ^4.0.0` & migrated to `/v3` or `/v4` imports.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/backend-plugin-api@1.8.0
|
|
10
|
+
- @backstage/plugin-auth-node@0.6.14
|
|
11
|
+
- @backstage/plugin-signals-node@0.1.29
|
|
12
|
+
|
|
3
13
|
## 0.4.1-next.1
|
|
4
14
|
|
|
5
15
|
### Patch Changes
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
var errors = require('@backstage/errors');
|
|
4
4
|
var express = require('express');
|
|
5
5
|
var Router = require('express-promise-router');
|
|
6
|
-
var
|
|
6
|
+
var v3 = require('zod/v3');
|
|
7
7
|
|
|
8
8
|
function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
|
|
9
9
|
|
|
@@ -13,8 +13,8 @@ var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
|
|
|
13
13
|
async function createRouter(options) {
|
|
14
14
|
const router = Router__default.default();
|
|
15
15
|
router.use(express__default.default.json());
|
|
16
|
-
const multiGetRequestSchema =
|
|
17
|
-
items:
|
|
16
|
+
const multiGetRequestSchema = v3.z.object({
|
|
17
|
+
items: v3.z.array(v3.z.object({ bucket: v3.z.string(), key: v3.z.string() }))
|
|
18
18
|
});
|
|
19
19
|
const getUserEntityRef = async (req) => {
|
|
20
20
|
const credentials = await options.httpAuth.credentials(req, {
|
|
@@ -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 { z } from 'zod';\nimport { UserSettingsStore } from '../database/UserSettingsStore';\nimport { SignalsService } from '@backstage/plugin-signals-node';\nimport {\n MultiGetResponse,\n UserSettingsSignal,\n} 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 const multiGetRequestSchema = z.object({\n items: z.array(z.object({ bucket: z.string(), key: z.string() })),\n });\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 multiple values\n router.post('/multiget', async (req, res) => {\n const userEntityRef = await getUserEntityRef(req);\n\n const bucketsAndKeys = multiGetRequestSchema.parse(req.body).items;\n\n const items = await options.userSettingsStore.multiget({\n userEntityRef,\n items: bucketsAndKeys,\n });\n\n res.json({ items } satisfies MultiGetResponse);\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","z","InputError"],"mappings":";;;;;;;;;;;;AA4BA,eAAsB,aAAa,OAAA,EAIP;AAC1B,EAAA,MAAM,SAASA,uBAAA,EAAO;AACtB,EAAA,MAAA,CAAO,GAAA,CAAIC,wBAAA,CAAQ,IAAA,EAAM,CAAA;AAEzB,EAAA,MAAM,qBAAA,GAAwBC,
|
|
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 { z } from 'zod/v3';\nimport { UserSettingsStore } from '../database/UserSettingsStore';\nimport { SignalsService } from '@backstage/plugin-signals-node';\nimport {\n MultiGetResponse,\n UserSettingsSignal,\n} 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 const multiGetRequestSchema = z.object({\n items: z.array(z.object({ bucket: z.string(), key: z.string() })),\n });\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 multiple values\n router.post('/multiget', async (req, res) => {\n const userEntityRef = await getUserEntityRef(req);\n\n const bucketsAndKeys = multiGetRequestSchema.parse(req.body).items;\n\n const items = await options.userSettingsStore.multiget({\n userEntityRef,\n items: bucketsAndKeys,\n });\n\n res.json({ items } satisfies MultiGetResponse);\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","z","InputError"],"mappings":";;;;;;;;;;;;AA4BA,eAAsB,aAAa,OAAA,EAIP;AAC1B,EAAA,MAAM,SAASA,uBAAA,EAAO;AACtB,EAAA,MAAA,CAAO,GAAA,CAAIC,wBAAA,CAAQ,IAAA,EAAM,CAAA;AAEzB,EAAA,MAAM,qBAAA,GAAwBC,KAAE,MAAA,CAAO;AAAA,IACrC,KAAA,EAAOA,IAAA,CAAE,KAAA,CAAMA,IAAA,CAAE,OAAO,EAAE,MAAA,EAAQA,IAAA,CAAE,MAAA,IAAU,GAAA,EAAKA,IAAA,CAAE,MAAA,EAAO,EAAG,CAAC;AAAA,GACjE,CAAA;AAKD,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,IAAA,CAAK,WAAA,EAAa,OAAO,GAAA,EAAK,GAAA,KAAQ;AAC3C,IAAA,MAAM,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA;AAEhD,IAAA,MAAM,cAAA,GAAiB,qBAAA,CAAsB,KAAA,CAAM,GAAA,CAAI,IAAI,CAAA,CAAE,KAAA;AAE7D,IAAA,MAAM,KAAA,GAAQ,MAAM,OAAA,CAAQ,iBAAA,CAAkB,QAAA,CAAS;AAAA,MACrD,aAAA;AAAA,MACA,KAAA,EAAO;AAAA,KACR,CAAA;AAED,IAAA,GAAA,CAAI,IAAA,CAAK,EAAE,KAAA,EAAkC,CAAA;AAAA,EAC/C,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;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.4.1
|
|
3
|
+
"version": "0.4.1",
|
|
4
4
|
"description": "The Backstage backend plugin to manage user settings",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "backend-plugin",
|
|
@@ -56,23 +56,23 @@
|
|
|
56
56
|
"test": "backstage-cli package test"
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
|
-
"@backstage/backend-plugin-api": "1.8.0
|
|
60
|
-
"@backstage/errors": "1.2.7",
|
|
61
|
-
"@backstage/plugin-auth-node": "0.6.14
|
|
62
|
-
"@backstage/plugin-signals-node": "0.1.29
|
|
63
|
-
"@backstage/plugin-user-settings-common": "0.1.0",
|
|
64
|
-
"@backstage/types": "1.2.2",
|
|
59
|
+
"@backstage/backend-plugin-api": "^1.8.0",
|
|
60
|
+
"@backstage/errors": "^1.2.7",
|
|
61
|
+
"@backstage/plugin-auth-node": "^0.6.14",
|
|
62
|
+
"@backstage/plugin-signals-node": "^0.1.29",
|
|
63
|
+
"@backstage/plugin-user-settings-common": "^0.1.0",
|
|
64
|
+
"@backstage/types": "^1.2.2",
|
|
65
65
|
"already": "^2.2.1",
|
|
66
66
|
"express": "^4.22.0",
|
|
67
67
|
"express-promise-router": "^4.1.0",
|
|
68
68
|
"knex": "^3.0.0",
|
|
69
69
|
"p-limit": "^3.1.0",
|
|
70
|
-
"zod": "^3.25.76"
|
|
70
|
+
"zod": "^3.25.76 || ^4.0.0"
|
|
71
71
|
},
|
|
72
72
|
"devDependencies": {
|
|
73
|
-
"@backstage/backend-defaults": "0.16.0
|
|
74
|
-
"@backstage/backend-test-utils": "1.11.1
|
|
75
|
-
"@backstage/cli": "0.36.0
|
|
73
|
+
"@backstage/backend-defaults": "^0.16.0",
|
|
74
|
+
"@backstage/backend-test-utils": "^1.11.1",
|
|
75
|
+
"@backstage/cli": "^0.36.0",
|
|
76
76
|
"@types/express": "^4.17.6",
|
|
77
77
|
"@types/supertest": "^2.0.8",
|
|
78
78
|
"supertest": "^7.0.0"
|