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

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @backstage/plugin-user-settings-backend
 
+## 0.1.6-next.2
+
+### Patch Changes
+
+- 0ff03319be: Updated usage of `createBackendPlugin`.
+- 4a6f38a535: Added a Backend System plugin feature
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.4.0-next.2
+  - @backstage/backend-common@0.18.2-next.2
+  - @backstage/catalog-model@1.2.0-next.1
+  - @backstage/plugin-auth-node@0.2.11-next.2
+  - @backstage/errors@1.1.4
+  - @backstage/types@1.0.2
+
 ## 0.1.6-next.1
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/index.alpha.d.ts

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

package/dist/index.beta.d.ts

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

package/dist/index.cjs.js

@@ -6,6 +6,7 @@ var backendCommon = require('@backstage/backend-common');
 var errors = require('@backstage/errors');
 var express = require('express');
 var Router = require('express-promise-router');
+var backendPluginApi = require('@backstage/backend-plugin-api');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -124,5 +125,22 @@ async function createRouterInternal(options) {
   return router;
 }
 
+const userSettingsPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "userSettings",
+  register(env) {
+    env.registerInit({
+      deps: {
+        database: backendPluginApi.coreServices.database,
+        identity: backendPluginApi.coreServices.identity,
+        httpRouter: backendPluginApi.coreServices.httpRouter
+      },
+      async init({ database, identity, httpRouter }) {
+        httpRouter.use(await createRouter({ database, identity }));
+      }
+    });
+  }
+});
+
 exports.createRouter = createRouter;
+exports.userSettingsPlugin = userSettingsPlugin;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +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.status(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,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;;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,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;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/database/DatabaseUserSettingsStore.ts","../src/service/router.ts","../src/plugin.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.status(204).end();\n  });\n\n  router.use(errorHandler());\n\n  return router;\n}\n","/*\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 const userSettingsPlugin = createBackendPlugin({\n  pluginId: 'userSettings',\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":["resolvePackagePath","NotFoundError","Router","express","AuthenticationError","InputError","errorHandler","createBackendPlugin","coreServices"],"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,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;;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,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;;AC/FO,MAAM,qBAAqBC,oCAAoB,CAAA;AAAA,EACpD,QAAU,EAAA,cAAA;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,MAAM,YAAA,CAAa,EAAE,QAAU,EAAA,QAAA,EAAU,CAAC,CAAA,CAAA;AAAA,OAC3D;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-user-settings-backend",
   "description": "The Backstage backend plugin to manage user settings",
-  "version": "0.1.6-next.1",
+  "version": "0.1.6-next.2",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -11,7 +11,8 @@
   "publishConfig": {
     "access": "public",
     "main": "dist/index.cjs.js",
-    "types": "dist/index.d.ts"
+    "types": "dist/index.d.ts",
+    "alphaTypes": "dist/index.alpha.d.ts"
   },
   "repository": {
     "type": "git",
@@ -20,7 +21,7 @@
   },
   "scripts": {
     "start": "backstage-cli package start",
-    "build": "backstage-cli package build",
+    "build": "backstage-cli package build --experimental-type-build",
     "lint": "backstage-cli package lint",
     "test": "backstage-cli package test",
     "prepack": "backstage-cli package prepack",
@@ -28,10 +29,11 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.18.2-next.1",
-    "@backstage/catalog-model": "^1.1.6-next.0",
+    "@backstage/backend-common": "^0.18.2-next.2",
+    "@backstage/backend-plugin-api": "^0.4.0-next.2",
+    "@backstage/catalog-model": "^1.2.0-next.1",
     "@backstage/errors": "^1.1.4",
-    "@backstage/plugin-auth-node": "^0.2.11-next.1",
+    "@backstage/plugin-auth-node": "^0.2.11-next.2",
     "@backstage/types": "^1.0.2",
     "@types/express": "^4.17.6",
     "express": "^4.17.1",
@@ -41,13 +43,14 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.34-next.1",
-    "@backstage/cli": "^0.22.2-next.0",
+    "@backstage/backend-test-utils": "^0.1.34-next.2",
+    "@backstage/cli": "^0.22.2-next.1",
     "@types/supertest": "^2.0.8",
     "supertest": "^6.1.3"
   },
   "files": [
     "dist",
-    "migrations"
+    "migrations",
+    "alpha"
   ]
 }