@backstage/plugin-user-settings-backend 0.2.18-next.2 → 0.2.18-next.3

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/plugin-user-settings-backend
 
+## 0.2.18-next.3
+
+### Patch Changes
+
+- d44a20a: Added additional plugin metadata to `package.json`.
+- e6ec179: Use signals to update user settings across sessions
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.6.19-next.3
+  - @backstage/plugin-auth-node@0.4.14-next.3
+  - @backstage/plugin-user-settings-common@0.0.1-next.0
+  - @backstage/plugin-signals-node@0.1.5-next.3
+  - @backstage/backend-common@0.23.0-next.3
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+
 ## 0.2.18-next.2
 
 ### Patch Changes

package/README.md

@@ -6,13 +6,26 @@ authorization token.
 
 ## Setup backend
 
-1. Install the backend plugin:
+Install the backend plugin
 
 ```bash
 # From your Backstage root directory
 yarn --cwd packages/backend add @backstage/plugin-user-settings-backend
 ```
 
+### New backend
+
+Add the plugin to your backend in `packages/backend/src/index.ts`:
+
+```ts
+backend.add(import('@backstage/plugin-user-settings-backend/alpha'));
+```
+
+To get real-time updates of the user settings across different user sessions, you must also install
+the `@backstage/plugin-signals-backend` plugin.
+
+### Old backend
+
 1. Configure the routes by adding a new `userSettings.ts` file in
    `packages/backend/src/plugins/`:
 
@@ -29,7 +42,7 @@ export default async function createPlugin(env: PluginEnvironment) {
 }
 ```
 
-3. Add the new routes to your backend by modifying `packages/backend/src/index.ts`:
+2. Add the new routes to your backend by modifying `packages/backend/src/index.ts`:
 
 ```diff
  // packages/backend/src/index.ts
@@ -58,6 +71,7 @@ To make use of the user settings backend, replace the `WebStorage` with the
 +  storageApiRef,
  } from '@backstage/core-plugin-api';
 +import { UserSettingsStorage } from '@backstage/plugin-user-settings';
++import { signalApiRef } from '@backstage/plugin-signals-react';
 
  export const apis: AnyApiFactory[] = [
 +  createApiFactory({
@@ -66,7 +80,8 @@ To make use of the user settings backend, replace the `WebStorage` with the
 +      discoveryApi: discoveryApiRef,
 +      errorApi: errorApiRef,
 +      fetchApi: fetchApiRef,
-+      identityApi: identityApiRef
++      identityApi: identityApiRef,
++      signalApi: signalApiRef, // Optional
 +    },
 +    factory: deps => UserSettingsStorage.create(deps),
 +  }),

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-user-settings-backend",
-  "version": "0.2.18-next.2",
+  "version": "0.2.18-next.3",
   "main": "../dist/alpha.cjs.js",
   "types": "../dist/alpha.d.ts"
 }

package/dist/alpha.cjs.js

@@ -3,7 +3,8 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var backendPluginApi = require('@backstage/backend-plugin-api');
-var router = require('./cjs/router-eX4-iM1L.cjs.js');
+var router = require('./cjs/router-BZCjWZvO.cjs.js');
+var pluginSignalsNode = require('@backstage/plugin-signals-node');
 require('@backstage/backend-common');
 require('@backstage/errors');
 require('express');
@@ -16,10 +17,11 @@ var alpha = backendPluginApi.createBackendPlugin({
       deps: {
         database: backendPluginApi.coreServices.database,
         identity: backendPluginApi.coreServices.identity,
-        httpRouter: backendPluginApi.coreServices.httpRouter
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        signals: pluginSignalsNode.signalsServiceRef
       },
-      async init({ database, identity, httpRouter }) {
-        httpRouter.use(await router.createRouter({ database, identity }));
+      async init({ database, identity, httpRouter, signals }) {
+        httpRouter.use(await router.createRouter({ database, identity, signals }));
       }
     });
   }

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  createBackendPlugin,\n  coreServices,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\n\n/**\n * The user settings backend plugin.\n *\n * @alpha\n */\nexport default createBackendPlugin({\n  pluginId: 'user-settings',\n  register(env) {\n    env.registerInit({\n      deps: {\n        database: coreServices.database,\n        identity: coreServices.identity,\n        httpRouter: coreServices.httpRouter,\n      },\n      async init({ database, identity, httpRouter }) {\n        httpRouter.use(await createRouter({ database, identity }));\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","createRouter"],"mappings":";;;;;;;;;;;AA2BA,YAAeA,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,eAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,UAAUC,6BAAa,CAAA,QAAA;AAAA,QACvB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,OAC3B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,QAAU,EAAA,QAAA,EAAU,YAAc,EAAA;AAC7C,QAAA,UAAA,CAAW,IAAI,MAAMC,mBAAA,CAAa,EAAE,QAAU,EAAA,QAAA,EAAU,CAAC,CAAA,CAAA;AAAA,OAC3D;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 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 {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './service/router';\nimport { signalsServiceRef } from '@backstage/plugin-signals-node';\n\n/**\n * The user settings backend plugin.\n *\n * @alpha\n */\nexport default createBackendPlugin({\n  pluginId: 'user-settings',\n  register(env) {\n    env.registerInit({\n      deps: {\n        database: coreServices.database,\n        identity: coreServices.identity,\n        httpRouter: coreServices.httpRouter,\n        signals: signalsServiceRef,\n      },\n      async init({ database, identity, httpRouter, signals }) {\n        httpRouter.use(await createRouter({ database, identity, signals }));\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","signalsServiceRef","createRouter"],"mappings":";;;;;;;;;;;;AA4BA,YAAeA,oCAAoB,CAAA;AAAA,EACjC,QAAU,EAAA,eAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,UAAUC,6BAAa,CAAA,QAAA;AAAA,QACvB,UAAUA,6BAAa,CAAA,QAAA;AAAA,QACvB,YAAYA,6BAAa,CAAA,UAAA;AAAA,QACzB,OAAS,EAAAC,mCAAA;AAAA,OACX;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,UAAU,QAAU,EAAA,UAAA,EAAY,SAAW,EAAA;AACtD,QAAW,UAAA,CAAA,GAAA,CAAI,MAAMC,mBAAa,CAAA,EAAE,UAAU,QAAU,EAAA,OAAA,EAAS,CAAC,CAAA,CAAA;AAAA,OACpE;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;"}

package/dist/cjs/{router-eX4-iM1L.cjs.js → router-BZCjWZvO.cjs.js}

@@ -69,7 +69,8 @@ async function createRouter(options) {
   });
   return await createRouterInternal({
     userSettingsStore,
-    identity: options.identity
+    identity: options.identity,
+    signals: options.signals
   });
 }
 async function createRouterInternal(options) {
@@ -110,12 +111,26 @@ async function createRouterInternal(options) {
       bucket,
       key
     });
+    if (options.signals) {
+      await options.signals.publish({
+        recipients: { type: "user", entityRef: userEntityRef },
+        channel: `user-settings`,
+        message: { type: "key-changed", key }
+      });
+    }
     res.json(setting);
   });
   router.delete("/buckets/:bucket/keys/:key", async (req, res) => {
     const userEntityRef = await getUserEntityRef(req);
     const { bucket, key } = req.params;
     await options.userSettingsStore.delete({ userEntityRef, bucket, key });
+    if (options.signals) {
+      await options.signals.publish({
+        recipients: { type: "user", entityRef: userEntityRef },
+        channel: "user-settings",
+        message: { type: "key-deleted", key }
+      });
+    }
     res.status(204).end();
   });
   router.use(backendCommon.errorHandler());
@@ -123,4 +138,4 @@ async function createRouterInternal(options) {
 }
 
 exports.createRouter = createRouter;
-//# sourceMappingURL=router-eX4-iM1L.cjs.js.map
+//# sourceMappingURL=router-BZCjWZvO.cjs.js.map

package/dist/cjs/router-BZCjWZvO.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"router-BZCjWZvO.cjs.js","sources":["../../src/database/DatabaseUserSettingsStore.ts","../../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 { PluginDatabaseManager } from '@backstage/backend-common';\nimport { resolvePackagePath } from '@backstage/backend-plugin-api';\nimport { NotFoundError } from '@backstage/errors';\nimport { JsonValue } from '@backstage/types';\nimport { Knex } from 'knex';\nimport { UserSettingsStore, type UserSetting } from './UserSettingsStore';\n\nconst migrationsDir = resolvePackagePath(\n  '@backstage/plugin-user-settings-backend',\n  'migrations',\n);\n\n/**\n * @public\n */\nexport type RawDbUserSettingsRow = {\n  user_entity_ref: string;\n  bucket: string;\n  key: string;\n  value: string;\n};\n\n/**\n * Store to manage the user settings.\n *\n * @public\n */\nexport class DatabaseUserSettingsStore implements UserSettingsStore {\n  static async create(options: {\n    database: PluginDatabaseManager;\n  }): Promise<DatabaseUserSettingsStore> {\n    const { database } = options;\n    const client = await database.getClient();\n\n    if (!database.migrations?.skip) {\n      await client.migrate.latest({\n        directory: migrationsDir,\n      });\n    }\n\n    return new DatabaseUserSettingsStore(client);\n  }\n\n  private constructor(private readonly db: Knex) {}\n\n  async get(options: {\n    userEntityRef: string;\n    bucket: string;\n    key: string;\n  }): Promise<UserSetting> {\n    const rows = await this.db<RawDbUserSettingsRow>('user_settings')\n      .where({\n        user_entity_ref: options.userEntityRef,\n        bucket: options.bucket,\n        key: options.key,\n      })\n      .select(['bucket', 'key', 'value']);\n\n    if (!rows.length) {\n      throw new NotFoundError(\n        `Unable to find '${options.key}' in bucket '${options.bucket}'`,\n      );\n    }\n\n    return {\n      bucket: rows[0].bucket,\n      key: rows[0].key,\n      value: JSON.parse(rows[0].value),\n    };\n  }\n\n  async set(options: {\n    userEntityRef: string;\n    bucket: string;\n    key: string;\n    value: JsonValue;\n  }): Promise<void> {\n    await this.db<RawDbUserSettingsRow>('user_settings')\n      .insert({\n        user_entity_ref: options.userEntityRef,\n        bucket: options.bucket,\n        key: options.key,\n        value: JSON.stringify(options.value),\n      })\n      .onConflict(['user_entity_ref', 'bucket', 'key'])\n      .merge(['value']);\n  }\n\n  async delete(options: {\n    userEntityRef: string;\n    bucket: string;\n    key: string;\n  }): Promise<void> {\n    await this.db<RawDbUserSettingsRow>('user_settings')\n      .where({\n        user_entity_ref: options.userEntityRef,\n        bucket: options.bucket,\n        key: options.key,\n      })\n      .delete();\n  }\n}\n","/*\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 { errorHandler, PluginDatabaseManager } from '@backstage/backend-common';\nimport { AuthenticationError, InputError } from '@backstage/errors';\nimport { IdentityApi } from '@backstage/plugin-auth-node';\nimport express, { Request } from 'express';\nimport Router from 'express-promise-router';\nimport { DatabaseUserSettingsStore } from '../database/DatabaseUserSettingsStore';\nimport { UserSettingsStore } from '../database/UserSettingsStore';\nimport { SignalsService } from '@backstage/plugin-signals-node';\nimport { UserSettingsSignal } from '@backstage/plugin-user-settings-common';\n\n/**\n * @public\n */\nexport interface RouterOptions {\n  database: PluginDatabaseManager;\n  identity: IdentityApi;\n  signals?: SignalsService;\n}\n\n/**\n * Create the user settings backend routes.\n *\n * @public\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const userSettingsStore = await DatabaseUserSettingsStore.create({\n    database: options.database,\n  });\n\n  return await createRouterInternal({\n    userSettingsStore,\n    identity: options.identity,\n    signals: options.signals,\n  });\n}\n\nexport async function createRouterInternal(options: {\n  identity: IdentityApi;\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    // throws an AuthenticationError in case the token exists but is invalid\n    const identity = await options.identity.getIdentity({ request: req });\n    if (!identity) {\n      throw new AuthenticationError(`Missing token in 'authorization' header`);\n    }\n\n    return identity.identity.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  // get 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  router.use(errorHandler());\n\n  return router;\n}\n"],"names":["resolvePackagePath","NotFoundError","Router","express","AuthenticationError","InputError","errorHandler"],"mappings":";;;;;;;;;;;;;AAuBA,MAAM,aAAgB,GAAAA,mCAAA;AAAA,EACpB,yCAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAiBO,MAAM,yBAAuD,CAAA;AAAA,EAgB1D,YAA6B,EAAU,EAAA;AAAV,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA,CAAA;AAAA,GAAW;AAAA,EAfhD,aAAa,OAAO,OAEmB,EAAA;AACrC,IAAM,MAAA,EAAE,UAAa,GAAA,OAAA,CAAA;AACrB,IAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA,CAAA;AAExC,IAAI,IAAA,CAAC,QAAS,CAAA,UAAA,EAAY,IAAM,EAAA;AAC9B,MAAM,MAAA,MAAA,CAAO,QAAQ,MAAO,CAAA;AAAA,QAC1B,SAAW,EAAA,aAAA;AAAA,OACZ,CAAA,CAAA;AAAA,KACH;AAEA,IAAO,OAAA,IAAI,0BAA0B,MAAM,CAAA,CAAA;AAAA,GAC7C;AAAA,EAIA,MAAM,IAAI,OAIe,EAAA;AACvB,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,EAAyB,CAAA,eAAe,EAC7D,KAAM,CAAA;AAAA,MACL,iBAAiB,OAAQ,CAAA,aAAA;AAAA,MACzB,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,KAAK,OAAQ,CAAA,GAAA;AAAA,KACd,CACA,CAAA,MAAA,CAAO,CAAC,QAAU,EAAA,KAAA,EAAO,OAAO,CAAC,CAAA,CAAA;AAEpC,IAAI,IAAA,CAAC,KAAK,MAAQ,EAAA;AAChB,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,CAAmB,gBAAA,EAAA,OAAA,CAAQ,GAAG,CAAA,aAAA,EAAgB,QAAQ,MAAM,CAAA,CAAA,CAAA;AAAA,OAC9D,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,MAAA,EAAQ,IAAK,CAAA,CAAC,CAAE,CAAA,MAAA;AAAA,MAChB,GAAA,EAAK,IAAK,CAAA,CAAC,CAAE,CAAA,GAAA;AAAA,MACb,OAAO,IAAK,CAAA,KAAA,CAAM,IAAK,CAAA,CAAC,EAAE,KAAK,CAAA;AAAA,KACjC,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,IAAI,OAKQ,EAAA;AAChB,IAAA,MAAM,IAAK,CAAA,EAAA,CAAyB,eAAe,CAAA,CAChD,MAAO,CAAA;AAAA,MACN,iBAAiB,OAAQ,CAAA,aAAA;AAAA,MACzB,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,KAAK,OAAQ,CAAA,GAAA;AAAA,MACb,KAAO,EAAA,IAAA,CAAK,SAAU,CAAA,OAAA,CAAQ,KAAK,CAAA;AAAA,KACpC,CAAA,CACA,UAAW,CAAA,CAAC,iBAAmB,EAAA,QAAA,EAAU,KAAK,CAAC,CAC/C,CAAA,KAAA,CAAM,CAAC,OAAO,CAAC,CAAA,CAAA;AAAA,GACpB;AAAA,EAEA,MAAM,OAAO,OAIK,EAAA;AAChB,IAAA,MAAM,IAAK,CAAA,EAAA,CAAyB,eAAe,CAAA,CAChD,KAAM,CAAA;AAAA,MACL,iBAAiB,OAAQ,CAAA,aAAA;AAAA,MACzB,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,KAAK,OAAQ,CAAA,GAAA;AAAA,KACd,EACA,MAAO,EAAA,CAAA;AAAA,GACZ;AACF;;AC7EA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,iBAAA,GAAoB,MAAM,yBAAA,CAA0B,MAAO,CAAA;AAAA,IAC/D,UAAU,OAAQ,CAAA,QAAA;AAAA,GACnB,CAAA,CAAA;AAED,EAAA,OAAO,MAAM,oBAAqB,CAAA;AAAA,IAChC,iBAAA;AAAA,IACA,UAAU,OAAQ,CAAA,QAAA;AAAA,IAClB,SAAS,OAAQ,CAAA,OAAA;AAAA,GAClB,CAAA,CAAA;AACH,CAAA;AAEA,eAAsB,qBAAqB,OAIf,EAAA;AAC1B,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAKzB,EAAM,MAAA,gBAAA,GAAmB,OAAO,GAAkC,KAAA;AAEhE,IAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,QAAA,CAAS,YAAY,EAAE,OAAA,EAAS,KAAK,CAAA,CAAA;AACpE,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAM,MAAA,IAAIC,2BAAoB,CAAyC,uCAAA,CAAA,CAAA,CAAA;AAAA,KACzE;AAEA,IAAA,OAAO,SAAS,QAAS,CAAA,aAAA,CAAA;AAAA,GAC3B,CAAA;AAGA,EAAA,MAAA,CAAO,GAAI,CAAA,4BAAA,EAA8B,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC3D,IAAM,MAAA,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAI,EAAA,GAAI,GAAI,CAAA,MAAA,CAAA;AAE5B,IAAA,MAAM,OAAU,GAAA,MAAM,OAAQ,CAAA,iBAAA,CAAkB,GAAI,CAAA;AAAA,MAClD,aAAA;AAAA,MACA,MAAA;AAAA,MACA,GAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,KAAK,OAAO,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAGD,EAAA,MAAA,CAAO,GAAI,CAAA,4BAAA,EAA8B,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC3D,IAAM,MAAA,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAI,EAAA,GAAI,GAAI,CAAA,MAAA,CAAA;AAC5B,IAAM,MAAA,EAAE,KAAM,EAAA,GAAI,GAAI,CAAA,IAAA,CAAA;AAEtB,IAAA,IAAI,UAAU,KAAW,CAAA,EAAA;AACvB,MAAM,MAAA,IAAIC,kBAAW,gCAAgC,CAAA,CAAA;AAAA,KACvD;AAEA,IAAM,MAAA,OAAA,CAAQ,kBAAkB,GAAI,CAAA;AAAA,MAClC,aAAA;AAAA,MACA,MAAA;AAAA,MACA,GAAA;AAAA,MACA,KAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAA,MAAM,OAAU,GAAA,MAAM,OAAQ,CAAA,iBAAA,CAAkB,GAAI,CAAA;AAAA,MAClD,aAAA;AAAA,MACA,MAAA;AAAA,MACA,GAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAA,IAAI,QAAQ,OAAS,EAAA;AACnB,MAAM,MAAA,OAAA,CAAQ,QAAQ,OAA4B,CAAA;AAAA,QAChD,UAAY,EAAA,EAAE,IAAM,EAAA,MAAA,EAAQ,WAAW,aAAc,EAAA;AAAA,QACrD,OAAS,EAAA,CAAA,aAAA,CAAA;AAAA,QACT,OAAS,EAAA,EAAE,IAAM,EAAA,aAAA,EAAe,GAAI,EAAA;AAAA,OACrC,CAAA,CAAA;AAAA,KACH;AAEA,IAAA,GAAA,CAAI,KAAK,OAAO,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAGD,EAAA,MAAA,CAAO,MAAO,CAAA,4BAAA,EAA8B,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC9D,IAAM,MAAA,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAI,EAAA,GAAI,GAAI,CAAA,MAAA,CAAA;AAE5B,IAAA,MAAM,QAAQ,iBAAkB,CAAA,MAAA,CAAO,EAAE,aAAe,EAAA,MAAA,EAAQ,KAAK,CAAA,CAAA;AACrE,IAAA,IAAI,QAAQ,OAAS,EAAA;AACnB,MAAM,MAAA,OAAA,CAAQ,QAAQ,OAA4B,CAAA;AAAA,QAChD,UAAY,EAAA,EAAE,IAAM,EAAA,MAAA,EAAQ,WAAW,aAAc,EAAA;AAAA,QACrD,OAAS,EAAA,eAAA;AAAA,QACT,OAAS,EAAA,EAAE,IAAM,EAAA,aAAA,EAAe,GAAI,EAAA;AAAA,OACrC,CAAA,CAAA;AAAA,KACH;AAEA,IAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,GAAI,EAAA,CAAA;AAAA,GACrB,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AAEzB,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}

package/dist/index.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var router = require('./cjs/router-eX4-iM1L.cjs.js');
+var router = require('./cjs/router-BZCjWZvO.cjs.js');
 require('@backstage/backend-common');
 require('@backstage/errors');
 require('express');

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { PluginDatabaseManager } from '@backstage/backend-common';
 import { IdentityApi } from '@backstage/plugin-auth-node';
 import express from 'express';
+import { SignalsService } from '@backstage/plugin-signals-node';
 
 /**
  * @public
@@ -8,6 +9,7 @@ import express from 'express';
 interface RouterOptions {
     database: PluginDatabaseManager;
     identity: IdentityApi;
+    signals?: SignalsService;
 }
 /**
  * Create the user settings backend routes.

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "@backstage/plugin-user-settings-backend",
-  "version": "0.2.18-next.2",
+  "version": "0.2.18-next.3",
   "description": "The Backstage backend plugin to manage user settings",
   "backstage": {
-    "role": "backend-plugin"
+    "role": "backend-plugin",
+    "pluginId": "user-settings",
+    "pluginPackages": [
+      "@backstage/plugin-user-settings",
+      "@backstage/plugin-user-settings-backend",
+      "@backstage/plugin-user-settings-common"
+    ]
   },
   "publishConfig": {
     "access": "public"
@@ -45,11 +51,13 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.23.0-next.2",
-    "@backstage/backend-plugin-api": "^0.6.19-next.2",
+    "@backstage/backend-common": "^0.23.0-next.3",
+    "@backstage/backend-plugin-api": "^0.6.19-next.3",
     "@backstage/config": "^1.2.0",
     "@backstage/errors": "^1.2.4",
-    "@backstage/plugin-auth-node": "^0.4.14-next.2",
+    "@backstage/plugin-auth-node": "^0.4.14-next.3",
+    "@backstage/plugin-signals-node": "^0.1.5-next.3",
+    "@backstage/plugin-user-settings-common": "^0.0.1-next.0",
     "@backstage/types": "^1.1.1",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
@@ -59,9 +67,9 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "^0.3.0-next.2",
-    "@backstage/backend-test-utils": "^0.4.0-next.2",
-    "@backstage/cli": "^0.26.7-next.2",
+    "@backstage/backend-defaults": "^0.3.0-next.3",
+    "@backstage/backend-test-utils": "^0.4.0-next.3",
+    "@backstage/cli": "^0.26.7-next.3",
     "@types/supertest": "^2.0.8",
     "supertest": "^6.1.3"
   }

package/dist/cjs/router-eX4-iM1L.cjs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"router-eX4-iM1L.cjs.js","sources":["../../src/database/DatabaseUserSettingsStore.ts","../../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 { PluginDatabaseManager } from '@backstage/backend-common';\nimport { resolvePackagePath } from '@backstage/backend-plugin-api';\nimport { NotFoundError } from '@backstage/errors';\nimport { JsonValue } from '@backstage/types';\nimport { Knex } from 'knex';\nimport { UserSettingsStore, type UserSetting } from './UserSettingsStore';\n\nconst migrationsDir = resolvePackagePath(\n  '@backstage/plugin-user-settings-backend',\n  'migrations',\n);\n\n/**\n * @public\n */\nexport type RawDbUserSettingsRow = {\n  user_entity_ref: string;\n  bucket: string;\n  key: string;\n  value: string;\n};\n\n/**\n * Store to manage the user settings.\n *\n * @public\n */\nexport class DatabaseUserSettingsStore implements UserSettingsStore {\n  static async create(options: {\n    database: PluginDatabaseManager;\n  }): Promise<DatabaseUserSettingsStore> {\n    const { database } = options;\n    const client = await database.getClient();\n\n    if (!database.migrations?.skip) {\n      await client.migrate.latest({\n        directory: migrationsDir,\n      });\n    }\n\n    return new DatabaseUserSettingsStore(client);\n  }\n\n  private constructor(private readonly db: Knex) {}\n\n  async get(options: {\n    userEntityRef: string;\n    bucket: string;\n    key: string;\n  }): Promise<UserSetting> {\n    const rows = await this.db<RawDbUserSettingsRow>('user_settings')\n      .where({\n        user_entity_ref: options.userEntityRef,\n        bucket: options.bucket,\n        key: options.key,\n      })\n      .select(['bucket', 'key', 'value']);\n\n    if (!rows.length) {\n      throw new NotFoundError(\n        `Unable to find '${options.key}' in bucket '${options.bucket}'`,\n      );\n    }\n\n    return {\n      bucket: rows[0].bucket,\n      key: rows[0].key,\n      value: JSON.parse(rows[0].value),\n    };\n  }\n\n  async set(options: {\n    userEntityRef: string;\n    bucket: string;\n    key: string;\n    value: JsonValue;\n  }): Promise<void> {\n    await this.db<RawDbUserSettingsRow>('user_settings')\n      .insert({\n        user_entity_ref: options.userEntityRef,\n        bucket: options.bucket,\n        key: options.key,\n        value: JSON.stringify(options.value),\n      })\n      .onConflict(['user_entity_ref', 'bucket', 'key'])\n      .merge(['value']);\n  }\n\n  async delete(options: {\n    userEntityRef: string;\n    bucket: string;\n    key: string;\n  }): Promise<void> {\n    await this.db<RawDbUserSettingsRow>('user_settings')\n      .where({\n        user_entity_ref: options.userEntityRef,\n        bucket: options.bucket,\n        key: options.key,\n      })\n      .delete();\n  }\n}\n","/*\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 { errorHandler, PluginDatabaseManager } from '@backstage/backend-common';\nimport { AuthenticationError, InputError } from '@backstage/errors';\nimport { IdentityApi } from '@backstage/plugin-auth-node';\nimport express, { Request } from 'express';\nimport Router from 'express-promise-router';\nimport { DatabaseUserSettingsStore } from '../database/DatabaseUserSettingsStore';\nimport { UserSettingsStore } from '../database/UserSettingsStore';\n\n/**\n * @public\n */\nexport interface RouterOptions {\n  database: PluginDatabaseManager;\n  identity: IdentityApi;\n}\n\n/**\n * Create the user settings backend routes.\n *\n * @public\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  const userSettingsStore = await DatabaseUserSettingsStore.create({\n    database: options.database,\n  });\n\n  return await createRouterInternal({\n    userSettingsStore,\n    identity: options.identity,\n  });\n}\n\nexport async function createRouterInternal(options: {\n  identity: IdentityApi;\n  userSettingsStore: UserSettingsStore;\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    // throws an AuthenticationError in case the token exists but is invalid\n    const identity = await options.identity.getIdentity({ request: req });\n    if (!identity) {\n      throw new AuthenticationError(`Missing token in 'authorization' header`);\n    }\n\n    return identity.identity.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    res.json(setting);\n  });\n\n  // get 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\n    res.status(204).end();\n  });\n\n  router.use(errorHandler());\n\n  return router;\n}\n"],"names":["resolvePackagePath","NotFoundError","Router","express","AuthenticationError","InputError","errorHandler"],"mappings":";;;;;;;;;;;;;AAuBA,MAAM,aAAgB,GAAAA,mCAAA;AAAA,EACpB,yCAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAiBO,MAAM,yBAAuD,CAAA;AAAA,EAgB1D,YAA6B,EAAU,EAAA;AAAV,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA,CAAA;AAAA,GAAW;AAAA,EAfhD,aAAa,OAAO,OAEmB,EAAA;AACrC,IAAM,MAAA,EAAE,UAAa,GAAA,OAAA,CAAA;AACrB,IAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA,CAAA;AAExC,IAAI,IAAA,CAAC,QAAS,CAAA,UAAA,EAAY,IAAM,EAAA;AAC9B,MAAM,MAAA,MAAA,CAAO,QAAQ,MAAO,CAAA;AAAA,QAC1B,SAAW,EAAA,aAAA;AAAA,OACZ,CAAA,CAAA;AAAA,KACH;AAEA,IAAO,OAAA,IAAI,0BAA0B,MAAM,CAAA,CAAA;AAAA,GAC7C;AAAA,EAIA,MAAM,IAAI,OAIe,EAAA;AACvB,IAAA,MAAM,OAAO,MAAM,IAAA,CAAK,EAAyB,CAAA,eAAe,EAC7D,KAAM,CAAA;AAAA,MACL,iBAAiB,OAAQ,CAAA,aAAA;AAAA,MACzB,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,KAAK,OAAQ,CAAA,GAAA;AAAA,KACd,CACA,CAAA,MAAA,CAAO,CAAC,QAAU,EAAA,KAAA,EAAO,OAAO,CAAC,CAAA,CAAA;AAEpC,IAAI,IAAA,CAAC,KAAK,MAAQ,EAAA;AAChB,MAAA,MAAM,IAAIC,oBAAA;AAAA,QACR,CAAmB,gBAAA,EAAA,OAAA,CAAQ,GAAG,CAAA,aAAA,EAAgB,QAAQ,MAAM,CAAA,CAAA,CAAA;AAAA,OAC9D,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,MAAA,EAAQ,IAAK,CAAA,CAAC,CAAE,CAAA,MAAA;AAAA,MAChB,GAAA,EAAK,IAAK,CAAA,CAAC,CAAE,CAAA,GAAA;AAAA,MACb,OAAO,IAAK,CAAA,KAAA,CAAM,IAAK,CAAA,CAAC,EAAE,KAAK,CAAA;AAAA,KACjC,CAAA;AAAA,GACF;AAAA,EAEA,MAAM,IAAI,OAKQ,EAAA;AAChB,IAAA,MAAM,IAAK,CAAA,EAAA,CAAyB,eAAe,CAAA,CAChD,MAAO,CAAA;AAAA,MACN,iBAAiB,OAAQ,CAAA,aAAA;AAAA,MACzB,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,KAAK,OAAQ,CAAA,GAAA;AAAA,MACb,KAAO,EAAA,IAAA,CAAK,SAAU,CAAA,OAAA,CAAQ,KAAK,CAAA;AAAA,KACpC,CAAA,CACA,UAAW,CAAA,CAAC,iBAAmB,EAAA,QAAA,EAAU,KAAK,CAAC,CAC/C,CAAA,KAAA,CAAM,CAAC,OAAO,CAAC,CAAA,CAAA;AAAA,GACpB;AAAA,EAEA,MAAM,OAAO,OAIK,EAAA;AAChB,IAAA,MAAM,IAAK,CAAA,EAAA,CAAyB,eAAe,CAAA,CAChD,KAAM,CAAA;AAAA,MACL,iBAAiB,OAAQ,CAAA,aAAA;AAAA,MACzB,QAAQ,OAAQ,CAAA,MAAA;AAAA,MAChB,KAAK,OAAQ,CAAA,GAAA;AAAA,KACd,EACA,MAAO,EAAA,CAAA;AAAA,GACZ;AACF;;AChFA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,iBAAA,GAAoB,MAAM,yBAAA,CAA0B,MAAO,CAAA;AAAA,IAC/D,UAAU,OAAQ,CAAA,QAAA;AAAA,GACnB,CAAA,CAAA;AAED,EAAA,OAAO,MAAM,oBAAqB,CAAA;AAAA,IAChC,iBAAA;AAAA,IACA,UAAU,OAAQ,CAAA,QAAA;AAAA,GACnB,CAAA,CAAA;AACH,CAAA;AAEA,eAAsB,qBAAqB,OAGf,EAAA;AAC1B,EAAA,MAAM,SAASC,uBAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,wBAAQ,CAAA,IAAA,EAAM,CAAA,CAAA;AAKzB,EAAM,MAAA,gBAAA,GAAmB,OAAO,GAAkC,KAAA;AAEhE,IAAM,MAAA,QAAA,GAAW,MAAM,OAAQ,CAAA,QAAA,CAAS,YAAY,EAAE,OAAA,EAAS,KAAK,CAAA,CAAA;AACpE,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAM,MAAA,IAAIC,2BAAoB,CAAyC,uCAAA,CAAA,CAAA,CAAA;AAAA,KACzE;AAEA,IAAA,OAAO,SAAS,QAAS,CAAA,aAAA,CAAA;AAAA,GAC3B,CAAA;AAGA,EAAA,MAAA,CAAO,GAAI,CAAA,4BAAA,EAA8B,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC3D,IAAM,MAAA,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAI,EAAA,GAAI,GAAI,CAAA,MAAA,CAAA;AAE5B,IAAA,MAAM,OAAU,GAAA,MAAM,OAAQ,CAAA,iBAAA,CAAkB,GAAI,CAAA;AAAA,MAClD,aAAA;AAAA,MACA,MAAA;AAAA,MACA,GAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,KAAK,OAAO,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAGD,EAAA,MAAA,CAAO,GAAI,CAAA,4BAAA,EAA8B,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC3D,IAAM,MAAA,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAI,EAAA,GAAI,GAAI,CAAA,MAAA,CAAA;AAC5B,IAAM,MAAA,EAAE,KAAM,EAAA,GAAI,GAAI,CAAA,IAAA,CAAA;AAEtB,IAAA,IAAI,UAAU,KAAW,CAAA,EAAA;AACvB,MAAM,MAAA,IAAIC,kBAAW,gCAAgC,CAAA,CAAA;AAAA,KACvD;AAEA,IAAM,MAAA,OAAA,CAAQ,kBAAkB,GAAI,CAAA;AAAA,MAClC,aAAA;AAAA,MACA,MAAA;AAAA,MACA,GAAA;AAAA,MACA,KAAA;AAAA,KACD,CAAA,CAAA;AACD,IAAA,MAAM,OAAU,GAAA,MAAM,OAAQ,CAAA,iBAAA,CAAkB,GAAI,CAAA;AAAA,MAClD,aAAA;AAAA,MACA,MAAA;AAAA,MACA,GAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAA,GAAA,CAAI,KAAK,OAAO,CAAA,CAAA;AAAA,GACjB,CAAA,CAAA;AAGD,EAAA,MAAA,CAAO,MAAO,CAAA,4BAAA,EAA8B,OAAO,GAAA,EAAK,GAAQ,KAAA;AAC9D,IAAM,MAAA,aAAA,GAAgB,MAAM,gBAAA,CAAiB,GAAG,CAAA,CAAA;AAChD,IAAA,MAAM,EAAE,MAAA,EAAQ,GAAI,EAAA,GAAI,GAAI,CAAA,MAAA,CAAA;AAE5B,IAAA,MAAM,QAAQ,iBAAkB,CAAA,MAAA,CAAO,EAAE,aAAe,EAAA,MAAA,EAAQ,KAAK,CAAA,CAAA;AAErE,IAAI,GAAA,CAAA,MAAA,CAAO,GAAG,CAAA,CAAE,GAAI,EAAA,CAAA;AAAA,GACrB,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AAEzB,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}