@backstage/plugin-user-settings-backend 0.0.0-nightly-20220923030237

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# @backstage/plugin-user-settings-backend
+
+## 0.0.0-nightly-20220923030237
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@0.0.0-nightly-20220923030237
+  - @backstage/backend-common@0.0.0-nightly-20220923030237
+  - @backstage/errors@0.0.0-nightly-20220923030237
+  - @backstage/types@1.0.0
+  - @backstage/plugin-auth-node@0.0.0-nightly-20220923030237
+
+## 0.1.0
+
+### Minor Changes
+
+- 108cdc3912: Added new plugin `@backstage/plugin-user-settings-backend` to store user related
+  settings in the database.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.15.1
+  - @backstage/plugin-auth-node@0.2.5
+  - @backstage/catalog-model@1.1.1
+  - @backstage/errors@1.1.1

package/README.md

@@ -0,0 +1,88 @@
+# User settings backend
+
+This backend allows to save user specific settings. All requests need to be
+authorized, as the user identifier (`userEntityRef`) is resolved using the
+authorization token.
+
+## Setup backend
+
+1. Install the backend plugin:
+
+```bash
+# From your Backstage root directory
+yarn --cwd packages/backend add @backstage/plugin-user-settings-backend
+```
+
+1. Configure the routes by adding a new `userSettings.ts` file in
+   `packages/backend/src/plugins/`:
+
+```ts
+// packages/backend/src/plugins/userSettings.ts
+import { createRouter } from '@backstage/plugin-user-settings-backend';
+import { PluginEnvironment } from '../types';
+
+export default async function createPlugin(env: PluginEnvironment) {
+  return await createRouter({
+    database: env.database,
+    identity: env.identity,
+  });
+}
+```
+
+3. Add the new routes to your backend by modifying `packages/backend/src/index.ts`:
+
+```diff
+ // packages/backend/src/index.ts
++import userSettings from './plugins/userSettings';
+ async function main() {
++  const userSettingsEnv = useHotMemoize(module, () => createEnv('user-settings'));
+   const apiRouter = Router();
++  apiRouter.use('/user-settings', await userSettings(userSettingsEnv));
+}
+```
+
+## Setup app
+
+To make use of the user settings backend, replace the `WebStorage` with the
+`UserSettingsStorage` by using the `storageApiRef`.
+
+```diff
+ // packages/app/src/apis.ts
+ import {
+   AnyApiFactory,
+   createApiFactory,
++  discoveryApiRef,
++  fetchApiRef,
+   errorApiRef,
++  identityApi,
++  storageApiRef,
+ } from '@backstage/core-plugin-api';
++import { UserSettingsStorage } from '@backstage/plugin-user-settings';
+
+ export const apis: AnyApiFactory[] = [
++  createApiFactory({
++    api: storageApiRef,
++    deps: {
++      discoveryApi: discoveryApiRef,
++      errorApi: errorApiRef,
++      fetchApi: fetchApiRef,
++      identityApi: identityApiRef
++    },
++    factory: deps => UserSettingsStorage.create(deps),
++  }),
+ ];
+```
+
+## Development
+
+Use `yarn start` to start the local dev environment. To simplify the access to
+the API, the token will automatically be set to `user:default/john_doe`.
+
+You can change the user by setting a custom `Authorization` header. To keep
+things simple, the raw `Bearer` value will directly be used as user.
+
+_Example:_
+
+```bash
+curl --request GET 'http://localhost:7007/user-settings' --header 'Authorization: Bearer user:default/custom-user'
+```

package/dist/index.cjs.js

@@ -0,0 +1,128 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendCommon = require('@backstage/backend-common');
+var errors = require('@backstage/errors');
+var express = require('express');
+var Router = require('express-promise-router');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var express__default = /*#__PURE__*/_interopDefaultLegacy(express);
+var Router__default = /*#__PURE__*/_interopDefaultLegacy(Router);
+
+const migrationsDir = backendCommon.resolvePackagePath(
+  "@backstage/plugin-user-settings-backend",
+  "migrations"
+);
+class DatabaseUserSettingsStore {
+  constructor(db) {
+    this.db = db;
+  }
+  static async create(options) {
+    var _a;
+    const { database } = options;
+    const client = await database.getClient();
+    if (!((_a = database.migrations) == null ? void 0 : _a.skip)) {
+      await client.migrate.latest({
+        directory: migrationsDir
+      });
+    }
+    return new DatabaseUserSettingsStore(client);
+  }
+  async get(options) {
+    const rows = await this.db("user_settings").where({
+      user_entity_ref: options.userEntityRef,
+      bucket: options.bucket,
+      key: options.key
+    }).select(["bucket", "key", "value"]);
+    if (!rows.length) {
+      throw new errors.NotFoundError(
+        `Unable to find '${options.key}' in bucket '${options.bucket}'`
+      );
+    }
+    return {
+      bucket: rows[0].bucket,
+      key: rows[0].key,
+      value: JSON.parse(rows[0].value)
+    };
+  }
+  async set(options) {
+    await this.db("user_settings").insert({
+      user_entity_ref: options.userEntityRef,
+      bucket: options.bucket,
+      key: options.key,
+      value: JSON.stringify(options.value)
+    }).onConflict(["user_entity_ref", "bucket", "key"]).merge(["value"]);
+  }
+  async delete(options) {
+    await this.db("user_settings").where({
+      user_entity_ref: options.userEntityRef,
+      bucket: options.bucket,
+      key: options.key
+    }).delete();
+  }
+}
+
+async function createRouter(options) {
+  const userSettingsStore = await DatabaseUserSettingsStore.create({
+    database: options.database
+  });
+  return await createRouterInternal({
+    userSettingsStore,
+    identity: options.identity
+  });
+}
+async function createRouterInternal(options) {
+  const router = Router__default["default"]();
+  router.use(express__default["default"].json());
+  const getUserEntityRef = async (req) => {
+    const identity = await options.identity.getIdentity({ request: req });
+    if (!identity) {
+      throw new errors.AuthenticationError(`Missing token in 'authorization' header`);
+    }
+    return identity.identity.userEntityRef;
+  };
+  router.get("/buckets/:bucket/keys/:key", async (req, res) => {
+    const userEntityRef = await getUserEntityRef(req);
+    const { bucket, key } = req.params;
+    const setting = await options.userSettingsStore.get({
+      userEntityRef,
+      bucket,
+      key
+    });
+    res.json(setting);
+  });
+  router.put("/buckets/:bucket/keys/:key", async (req, res) => {
+    const userEntityRef = await getUserEntityRef(req);
+    const { bucket, key } = req.params;
+    const { value } = req.body;
+    if (value === void 0) {
+      throw new errors.InputError('Missing required field "value"');
+    }
+    await options.userSettingsStore.set({
+      userEntityRef,
+      bucket,
+      key,
+      value
+    });
+    const setting = await options.userSettingsStore.get({
+      userEntityRef,
+      bucket,
+      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 });
+    res.send(204).end();
+  });
+  router.use(backendCommon.errorHandler());
+  return router;
+}
+
+exports.createRouter = createRouter;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.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 {\n  PluginDatabaseManager,\n  resolvePackagePath,\n} from '@backstage/backend-common';\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.send(204).end();\n  });\n\n  router.use(errorHandler());\n\n  return router;\n}\n"],"names":["resolvePackagePath","NotFoundError","Router","express","AuthenticationError","InputError","errorHandler"],"mappings":";;;;;;;;;;;;;;AAyBA,MAAM,aAAgB,GAAAA,gCAAA;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;AAhDzC,IAAA,IAAA,EAAA,CAAA;AAiDI,IAAM,MAAA,EAAE,UAAa,GAAA,OAAA,CAAA;AACrB,IAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,SAAU,EAAA,CAAA;AAExC,IAAA,IAAI,EAAC,CAAA,EAAA,GAAA,QAAA,CAAS,UAAT,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAqB,IAAM,CAAA,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,CAAA,gBAAA,EAAmB,OAAQ,CAAA,GAAA,CAAA,aAAA,EAAmB,OAAQ,CAAA,MAAA,CAAA,CAAA,CAAA;AAAA,OACxD,CAAA;AAAA,KACF;AAEA,IAAO,OAAA;AAAA,MACL,MAAA,EAAQ,KAAK,CAAG,CAAA,CAAA,MAAA;AAAA,MAChB,GAAA,EAAK,KAAK,CAAG,CAAA,CAAA,GAAA;AAAA,MACb,KAAO,EAAA,IAAA,CAAK,KAAM,CAAA,IAAA,CAAK,GAAG,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;;AClFA,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,0BAAO,EAAA,CAAA;AACtB,EAAO,MAAA,CAAA,GAAA,CAAIC,2BAAQ,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,IAAA,CAAK,GAAG,CAAA,CAAE,GAAI,EAAA,CAAA;AAAA,GACnB,CAAA,CAAA;AAED,EAAO,MAAA,CAAA,GAAA,CAAIC,4BAAc,CAAA,CAAA;AAEzB,EAAO,OAAA,MAAA,CAAA;AACT;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import { PluginDatabaseManager } from '@backstage/backend-common';
+import { IdentityApi } from '@backstage/plugin-auth-node';
+import express from 'express';
+
+/**
+ * @public
+ */
+interface RouterOptions {
+    database: PluginDatabaseManager;
+    identity: IdentityApi;
+}
+/**
+ * Create the user settings backend routes.
+ *
+ * @public
+ */
+declare function createRouter(options: RouterOptions): Promise<express.Router>;
+
+export { RouterOptions, createRouter };

package/migrations/20220824183000_init.js

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2022 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.up = async function up(knex) {
+  await knex.schema.createTable('user_settings', table => {
+    table.comment('The table of user related settings');
+
+    table
+      .string('user_entity_ref')
+      .notNullable()
+      .comment('The entityRef of the user');
+    table.string('bucket').notNullable().comment('Name of the bucket');
+    table.string('key').notNullable().comment('Key of a bucket value');
+    table.text('value').notNullable().comment('The value');
+
+    table.primary(['user_entity_ref', 'bucket', 'key']);
+  });
+};
+
+/**
+ * @param {import('knex').Knex} knex
+ */
+exports.down = async function down(knex) {
+  await knex.schema.dropTable('user_settings');
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@backstage/plugin-user-settings-backend",
+  "description": "The Backstage backend plugin to manage user settings",
+  "version": "0.0.0-nightly-20220923030237",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "backstage": {
+    "role": "backend-plugin"
+  },
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/user-settings-backend"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20220923030237",
+    "@backstage/catalog-model": "^0.0.0-nightly-20220923030237",
+    "@backstage/errors": "^0.0.0-nightly-20220923030237",
+    "@backstage/plugin-auth-node": "^0.0.0-nightly-20220923030237",
+    "@backstage/types": "^1.0.0",
+    "@types/express": "^4.17.6",
+    "express": "^4.17.1",
+    "express-promise-router": "^4.1.0",
+    "knex": "^2.0.0",
+    "winston": "^3.2.1",
+    "yn": "^4.0.0"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20220923030237",
+    "@backstage/cli": "^0.0.0-nightly-20220923030237",
+    "@types/supertest": "^2.0.8",
+    "supertest": "^6.1.3"
+  },
+  "files": [
+    "dist",
+    "migrations"
+  ]
+}