@backstage/plugin-user-settings-backend 0.2.25-next.1 → 0.2.25

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @backstage/plugin-user-settings-backend
 
+## 0.2.25
+
+### Patch Changes
+
+- 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
+- Updated dependencies
+  - @backstage/backend-defaults@0.5.1
+  - @backstage/plugin-auth-node@0.5.3
+  - @backstage/plugin-signals-node@0.1.12
+  - @backstage/backend-plugin-api@1.0.1
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-user-settings-common@0.0.1
+
+## 0.2.25-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-defaults@0.5.1-next.2
+  - @backstage/plugin-auth-node@0.5.3-next.1
+  - @backstage/backend-plugin-api@1.0.1-next.1
+  - @backstage/config@1.2.0
+  - @backstage/errors@1.2.4
+  - @backstage/types@1.1.1
+  - @backstage/plugin-signals-node@0.1.12-next.1
+  - @backstage/plugin-user-settings-common@0.0.1
+
 ## 0.2.25-next.1
 
 ### Patch Changes

package/README.md

@@ -16,7 +16,7 @@ yarn --cwd packages/backend add @backstage/plugin-user-settings-backend @backsta
 Add the plugin to your backend in `packages/backend/src/index.ts`:
 
 ```ts
-backend.add(import('@backstage/plugin-user-settings-backend/alpha'));
+backend.add(import('@backstage/plugin-user-settings-backend'));
 // The signals backend is technically optional but enables real-time update of user
 // settings across different sessions
 backend.add(import('@backstage/plugin-signals-backend'));

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -2,34 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var backendPluginApi = require('@backstage/backend-plugin-api');
-var router = require('./cjs/router-BIXN0wtq.cjs.js');
-var pluginSignalsNode = require('@backstage/plugin-signals-node');
-require('@backstage/errors');
-require('express');
-require('express-promise-router');
+var plugin = require('./plugin.cjs.js');
 
-var alpha = backendPluginApi.createBackendPlugin({
-  pluginId: "user-settings",
-  register(env) {
-    env.registerInit({
-      deps: {
-        database: backendPluginApi.coreServices.database,
-        httpAuth: backendPluginApi.coreServices.httpAuth,
-        httpRouter: backendPluginApi.coreServices.httpRouter,
-        signals: pluginSignalsNode.signalsServiceRef
-      },
-      async init({ database, httpAuth, httpRouter, signals }) {
-        const userSettingsStore = await router.DatabaseUserSettingsStore.create({
-          database
-        });
-        httpRouter.use(
-          await router.createRouterInternal({ userSettingsStore, httpAuth, signals })
-        );
-      }
-    });
-  }
-});
+const _feature = plugin.default;
 
-exports.default = alpha;
+exports.default = _feature;
 //# sourceMappingURL=alpha.cjs.js.map

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  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouterInternal } from './service/router';\nimport { signalsServiceRef } from '@backstage/plugin-signals-node';\nimport { DatabaseUserSettingsStore } from './database/DatabaseUserSettingsStore';\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        httpAuth: coreServices.httpAuth,\n        httpRouter: coreServices.httpRouter,\n        signals: signalsServiceRef,\n      },\n      async init({ database, httpAuth, httpRouter, signals }) {\n        const userSettingsStore = await DatabaseUserSettingsStore.create({\n          database,\n        });\n        httpRouter.use(\n          await createRouterInternal({ userSettingsStore, httpAuth, signals }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","signalsServiceRef","DatabaseUserSettingsStore","createRouterInternal"],"mappings":";;;;;;;;;;;AA6BA,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,QAAM,MAAA,iBAAA,GAAoB,MAAMC,gCAAA,CAA0B,MAAO,CAAA;AAAA,UAC/D,QAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,2BAAqB,CAAA,EAAE,iBAAmB,EAAA,QAAA,EAAU,SAAS,CAAA;AAAA,SACrE,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { default as feature } from './plugin';\n\n/** @alpha */\nconst _feature = feature;\nexport default _feature;\n"],"names":["feature"],"mappings":";;;;;;AAmBA,MAAM,QAAW,GAAAA;;;;"}

package/dist/alpha.d.ts

@@ -1,10 +1,6 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 
-/**
- * The user settings backend plugin.
- *
- * @alpha
- */
-declare const _default: _backstage_backend_plugin_api.BackendFeature;
+/** @alpha */
+declare const _feature: _backstage_backend_plugin_api.BackendFeature;
 
-export { _default as default };
+export { _feature as default };

package/dist/database/DatabaseUserSettingsStore.cjs.js

@@ -0,0 +1,59 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var errors = require('@backstage/errors');
+
+const migrationsDir = backendPluginApi.resolvePackagePath(
+  "@backstage/plugin-user-settings-backend",
+  "migrations"
+);
+class DatabaseUserSettingsStore {
+  constructor(db) {
+    this.db = db;
+  }
+  static async create(options) {
+    const { database } = options;
+    const client = await database.getClient();
+    if (!database.migrations?.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();
+  }
+}
+
+exports.DatabaseUserSettingsStore = DatabaseUserSettingsStore;
+//# sourceMappingURL=DatabaseUserSettingsStore.cjs.js.map

package/dist/database/DatabaseUserSettingsStore.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DatabaseUserSettingsStore.cjs.js","sources":["../../src/database/DatabaseUserSettingsStore.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  resolvePackagePath,\n  DatabaseService,\n} 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: DatabaseService;\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"],"names":["resolvePackagePath","NotFoundError"],"mappings":";;;;;AAyBA,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;;;;"}

package/dist/deprecated.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+var router = require('./service/router.cjs.js');
+
+async function createRouter(options) {
+  return await router.createRouter(options);
+}
+
+exports.createRouter = createRouter;
+//# sourceMappingURL=deprecated.cjs.js.map

package/dist/deprecated.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecated.cjs.js","sources":["../src/deprecated.ts"],"sourcesContent":["/*\n * Copyright 2024 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 express from 'express';\nimport { DatabaseService } from '@backstage/backend-plugin-api';\nimport { SignalsService } from '@backstage/plugin-signals-node';\n\nimport { createRouter as internalCreateRouter } from './service';\nimport { IdentityApi } from '@backstage/plugin-auth-node';\n\n/**\n * Type for the options passed to the \"createRouter\" function.\n *\n * @public\n * @deprecated This type is only exported for legacy reasons and will be removed in the future.\n */\nexport type RouterOptions = {\n  database: DatabaseService;\n  identity: IdentityApi;\n  signals?: SignalsService;\n};\n\n/**\n * Create the user settings backend routes.\n *\n * @public\n * @deprecated This function is only exported for legacy reasons and will be removed in the future.\n * Please {@link https://backstage.io/docs/backend-system/building-backends/migrating | migrate } to use the new backend system and follow these {@link https://github.com/backstage/backstage/tree/master/plugins/user-settings-backend#new-backend | instructions } to install the user settings backend plugin.\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  return await internalCreateRouter(options);\n}\n"],"names":["internalCreateRouter"],"mappings":";;;;AA0CA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAO,OAAA,MAAMA,oBAAqB,OAAO,CAAA,CAAA;AAC3C;;;;"}

package/dist/index.cjs.js

@@ -1,14 +1,12 @@
 'use strict';
 
-var router = require('./cjs/router-BIXN0wtq.cjs.js');
-require('@backstage/errors');
-require('express');
-require('express-promise-router');
-require('@backstage/backend-plugin-api');
+Object.defineProperty(exports, '__esModule', { value: true });
 
-async function createRouter(options) {
-  return await router.createRouter(options);
-}
+var plugin = require('./plugin.cjs.js');
+var deprecated = require('./deprecated.cjs.js');
 
-exports.createRouter = createRouter;
+
+
+exports.default = plugin.default;
+exports.createRouter = deprecated.createRouter;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/deprecated.ts"],"sourcesContent":["/*\n * Copyright 2024 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 express from 'express';\nimport { DatabaseService } from '@backstage/backend-plugin-api';\nimport { SignalsService } from '@backstage/plugin-signals-node';\n\nimport { createRouter as internalCreateRouter } from './service';\nimport { IdentityApi } from '@backstage/plugin-auth-node';\n\n/**\n * Type for the options passed to the \"createRouter\" function.\n *\n * @public\n * @deprecated This type is only exported for legacy reasons and will be removed in the future.\n */\nexport type RouterOptions = {\n  database: DatabaseService;\n  identity: IdentityApi;\n  signals?: SignalsService;\n};\n\n/**\n * Create the user settings backend routes.\n *\n * @public\n * @deprecated This function is only exported for legacy reasons and will be removed in the future.\n * Please {@link https://backstage.io/docs/backend-system/building-backends/migrating | migrate } to use the new backend system and follow these {@link https://github.com/backstage/backstage/tree/master/plugins/user-settings-backend#new-backend | instructions } to install the user settings backend plugin.\n */\nexport async function createRouter(\n  options: RouterOptions,\n): Promise<express.Router> {\n  return await internalCreateRouter(options);\n}\n"],"names":["internalCreateRouter"],"mappings":";;;;;;;;AA0CA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAO,OAAA,MAAMA,oBAAqB,OAAO,CAAA,CAAA;AAC3C;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,8 +1,16 @@
-import express from 'express';
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
 import { DatabaseService } from '@backstage/backend-plugin-api';
+import express from 'express';
 import { SignalsService } from '@backstage/plugin-signals-node';
 import { IdentityApi } from '@backstage/plugin-auth-node';
 
+/**
+ * The user settings backend plugin.
+ *
+ * @public
+ */
+declare const _default: _backstage_backend_plugin_api.BackendFeature;
+
 /**
  * Type for the options passed to the "createRouter" function.
  *
@@ -23,4 +31,4 @@ type RouterOptions = {
  */
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
-export { type RouterOptions, createRouter };
+export { type RouterOptions, createRouter, _default as default };

package/dist/plugin.cjs.js

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var router = require('./service/router.cjs.js');
+var pluginSignalsNode = require('@backstage/plugin-signals-node');
+var DatabaseUserSettingsStore = require('./database/DatabaseUserSettingsStore.cjs.js');
+
+var feature = backendPluginApi.createBackendPlugin({
+  pluginId: "user-settings",
+  register(env) {
+    env.registerInit({
+      deps: {
+        database: backendPluginApi.coreServices.database,
+        httpAuth: backendPluginApi.coreServices.httpAuth,
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        signals: pluginSignalsNode.signalsServiceRef
+      },
+      async init({ database, httpAuth, httpRouter, signals }) {
+        const userSettingsStore = await DatabaseUserSettingsStore.DatabaseUserSettingsStore.create({
+          database
+        });
+        httpRouter.use(
+          await router.createRouterInternal({ userSettingsStore, httpAuth, signals })
+        );
+      }
+    });
+  }
+});
+
+exports.default = feature;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.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 { createRouterInternal } from './service/router';\nimport { signalsServiceRef } from '@backstage/plugin-signals-node';\nimport { DatabaseUserSettingsStore } from './database/DatabaseUserSettingsStore';\n\n/**\n * The user settings backend plugin.\n *\n * @public\n */\nexport default createBackendPlugin({\n  pluginId: 'user-settings',\n  register(env) {\n    env.registerInit({\n      deps: {\n        database: coreServices.database,\n        httpAuth: coreServices.httpAuth,\n        httpRouter: coreServices.httpRouter,\n        signals: signalsServiceRef,\n      },\n      async init({ database, httpAuth, httpRouter, signals }) {\n        const userSettingsStore = await DatabaseUserSettingsStore.create({\n          database,\n        });\n        httpRouter.use(\n          await createRouterInternal({ userSettingsStore, httpAuth, signals }),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","coreServices","signalsServiceRef","DatabaseUserSettingsStore","createRouterInternal"],"mappings":";;;;;;;;;AA6BA,cAAeA,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,QAAM,MAAA,iBAAA,GAAoB,MAAMC,mDAAA,CAA0B,MAAO,CAAA;AAAA,UAC/D,QAAA;AAAA,SACD,CAAA,CAAA;AACD,QAAW,UAAA,CAAA,GAAA;AAAA,UACT,MAAMC,2BAAqB,CAAA,EAAE,iBAAmB,EAAA,QAAA,EAAU,SAAS,CAAA;AAAA,SACrE,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,CAAA;;;;"}

package/dist/{cjs/router-BIXN0wtq.cjs.js → service/router.cjs.js}

@@ -3,67 +3,15 @@
 var errors = require('@backstage/errors');
 var express = require('express');
 var Router = require('express-promise-router');
-var backendPluginApi = require('@backstage/backend-plugin-api');
+var DatabaseUserSettingsStore = require('../database/DatabaseUserSettingsStore.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var express__default = /*#__PURE__*/_interopDefaultCompat(express);
 var Router__default = /*#__PURE__*/_interopDefaultCompat(Router);
 
-const migrationsDir = backendPluginApi.resolvePackagePath(
-  "@backstage/plugin-user-settings-backend",
-  "migrations"
-);
-class DatabaseUserSettingsStore {
-  constructor(db) {
-    this.db = db;
-  }
-  static async create(options) {
-    const { database } = options;
-    const client = await database.getClient();
-    if (!database.migrations?.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({
+  const userSettingsStore = await DatabaseUserSettingsStore.DatabaseUserSettingsStore.create({
     database: options.database
   });
   return await createRouterInternal({
@@ -141,7 +89,6 @@ async function createRouterInternal(options) {
   return router;
 }
 
-exports.DatabaseUserSettingsStore = DatabaseUserSettingsStore;
 exports.createRouter = createRouter;
 exports.createRouterInternal = createRouterInternal;
-//# sourceMappingURL=router-BIXN0wtq.cjs.js.map
+//# sourceMappingURL=router.cjs.js.map

package/dist/service/router.cjs.js.map

@@ -0,0 +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 { 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';\nimport {\n  DatabaseService,\n  HttpAuthService,\n} from '@backstage/backend-plugin-api';\n\n/**\n * @public\n */\nexport interface RouterOptions {\n  database: DatabaseService;\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(\n  options:\n    | {\n        identity: IdentityApi;\n        userSettingsStore: UserSettingsStore;\n        signals?: SignalsService;\n      }\n    | {\n        httpAuth: HttpAuthService;\n        userSettingsStore: UserSettingsStore;\n        signals?: SignalsService;\n      },\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    if ('httpAuth' in options) {\n      const credentials = await options.httpAuth.credentials(req, {\n        allow: ['user'],\n      });\n      return credentials.principal.userEntityRef;\n    }\n\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  return router;\n}\n"],"names":["DatabaseUserSettingsStore","Router","express","AuthenticationError","InputError"],"mappings":";;;;;;;;;;;;AA2CA,eAAsB,aACpB,OACyB,EAAA;AACzB,EAAM,MAAA,iBAAA,GAAoB,MAAMA,mDAAA,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,qBACpB,OAWyB,EAAA;AACzB,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;AAChE,IAAA,IAAI,cAAc,OAAS,EAAA;AACzB,MAAA,MAAM,WAAc,GAAA,MAAM,OAAQ,CAAA,QAAA,CAAS,YAAY,GAAK,EAAA;AAAA,QAC1D,KAAA,EAAO,CAAC,MAAM,CAAA;AAAA,OACf,CAAA,CAAA;AACD,MAAA,OAAO,YAAY,SAAU,CAAA,aAAA,CAAA;AAAA,KAC/B;AAGA,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,OAAA,MAAA,CAAA;AACT;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-user-settings-backend",
-  "version": "0.2.25-next.1",
+  "version": "0.2.25",
   "description": "The Backstage backend plugin to manage user settings",
   "backstage": {
     "role": "backend-plugin",
@@ -23,6 +23,7 @@
   "license": "Apache-2.0",
   "exports": {
     ".": {
+      "backstage": "@backstage/BackendFeature",
       "require": "./dist/index.cjs.js",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.cjs.js"
@@ -52,14 +53,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-defaults": "0.5.1-next.1",
-    "@backstage/backend-plugin-api": "1.0.1-next.0",
-    "@backstage/config": "1.2.0",
-    "@backstage/errors": "1.2.4",
-    "@backstage/plugin-auth-node": "0.5.3-next.0",
-    "@backstage/plugin-signals-node": "0.1.12-next.0",
-    "@backstage/plugin-user-settings-common": "0.0.1",
-    "@backstage/types": "1.1.1",
+    "@backstage/backend-defaults": "^0.5.1",
+    "@backstage/backend-plugin-api": "^1.0.1",
+    "@backstage/config": "^1.2.0",
+    "@backstage/errors": "^1.2.4",
+    "@backstage/plugin-auth-node": "^0.5.3",
+    "@backstage/plugin-signals-node": "^0.1.12",
+    "@backstage/plugin-user-settings-common": "^0.0.1",
+    "@backstage/types": "^1.1.1",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
     "express-promise-router": "^4.1.0",
@@ -67,9 +68,9 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-defaults": "0.5.1-next.1",
-    "@backstage/backend-test-utils": "1.0.1-next.1",
-    "@backstage/cli": "0.28.0-next.1",
+    "@backstage/backend-defaults": "^0.5.1",
+    "@backstage/backend-test-utils": "^1.0.1",
+    "@backstage/cli": "^0.28.0",
     "@types/supertest": "^2.0.8",
     "supertest": "^7.0.0"
   }

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

@@ -1 +0,0 @@
-{"version":3,"file":"router-BIXN0wtq.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  resolvePackagePath,\n  DatabaseService,\n} 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: DatabaseService;\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 { 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';\nimport {\n  DatabaseService,\n  HttpAuthService,\n} from '@backstage/backend-plugin-api';\n\n/**\n * @public\n */\nexport interface RouterOptions {\n  database: DatabaseService;\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(\n  options:\n    | {\n        identity: IdentityApi;\n        userSettingsStore: UserSettingsStore;\n        signals?: SignalsService;\n      }\n    | {\n        httpAuth: HttpAuthService;\n        userSettingsStore: UserSettingsStore;\n        signals?: SignalsService;\n      },\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    if ('httpAuth' in options) {\n      const credentials = await options.httpAuth.credentials(req, {\n        allow: ['user'],\n      });\n      return credentials.principal.userEntityRef;\n    }\n\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  return router;\n}\n"],"names":["resolvePackagePath","NotFoundError","Router","express","AuthenticationError","InputError"],"mappings":";;;;;;;;;;;;AAyBA,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;;AC5EA,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,qBACpB,OAWyB,EAAA;AACzB,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;AAChE,IAAA,IAAI,cAAc,OAAS,EAAA;AACzB,MAAA,MAAM,WAAc,GAAA,MAAM,OAAQ,CAAA,QAAA,CAAS,YAAY,GAAK,EAAA;AAAA,QAC1D,KAAA,EAAO,CAAC,MAAM,CAAA;AAAA,OACf,CAAA,CAAA;AACD,MAAA,OAAO,YAAY,SAAU,CAAA,aAAA,CAAA;AAAA,KAC/B;AAGA,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,OAAA,MAAA,CAAA;AACT;;;;;;"}