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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/alpha/package.json +1 -1
  3. package/dist/apis/StorageApi/UserSettingsStorage.esm.js +22 -3
  4. package/dist/apis/StorageApi/UserSettingsStorage.esm.js.map +1 -1
  5. package/dist/index.d.ts +3 -0
  6. package/package.json +18 -10
package/CHANGELOG.md CHANGED
@@ -1,5 +1,24 @@
1
1
  # @backstage/plugin-user-settings
2
2
 
3
+ ## 0.8.7-next.2
4
+
5
+ ### Patch Changes
6
+
7
+ - d44a20a: Added additional plugin metadata to `package.json`.
8
+ - e6ec179: Use signals to update user settings across sessions
9
+ - Updated dependencies
10
+ - @backstage/core-components@0.14.8-next.2
11
+ - @backstage/plugin-user-settings-common@0.0.1-next.0
12
+ - @backstage/plugin-catalog-react@1.12.1-next.2
13
+ - @backstage/plugin-signals-react@0.0.4-next.1
14
+ - @backstage/frontend-plugin-api@0.6.6-next.2
15
+ - @backstage/core-compat-api@0.2.6-next.2
16
+ - @backstage/core-app-api@1.12.6-next.0
17
+ - @backstage/core-plugin-api@1.9.3-next.0
18
+ - @backstage/errors@1.2.4
19
+ - @backstage/theme@0.5.6-next.0
20
+ - @backstage/types@1.1.1
21
+
3
22
  ## 0.8.7-next.1
4
23
 
5
24
  ### Patch Changes
package/alpha/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@backstage/plugin-user-settings",
3
- "version": "0.8.7-next.1",
3
+ "version": "0.8.7-next.2",
4
4
  "main": "../dist/alpha.esm.js",
5
5
  "module": "../dist/alpha.esm.js",
6
6
  "types": "../dist/alpha.d.ts"
package/dist/apis/StorageApi/UserSettingsStorage.esm.js CHANGED
@@ -8,13 +8,14 @@ const JSON_HEADERS = {
8
8
  };
9
9
  const buckets = /* @__PURE__ */ new Map();
10
10
  class UserSettingsStorage {
11
- constructor(namespace, fetchApi, discoveryApi, errorApi, identityApi, fallback) {
11
+ constructor(namespace, fetchApi, discoveryApi, errorApi, identityApi, fallback, signalApi) {
12
12
  this.namespace = namespace;
13
13
  this.fetchApi = fetchApi;
14
14
  this.discoveryApi = discoveryApi;
15
15
  this.errorApi = errorApi;
16
16
  this.identityApi = identityApi;
17
17
  this.fallback = fallback;
18
+ this.signalApi = signalApi;
18
19
  }
19
20
  subscribers = /* @__PURE__ */ new Set();
20
21
  observables = /* @__PURE__ */ new Map();
@@ -28,7 +29,8 @@ class UserSettingsStorage {
28
29
  WebStorage.create({
29
30
  namespace: options.namespace,
30
31
  errorApi: options.errorApi
31
- })
32
+ }),
33
+ options.signalApi
32
34
  );
33
35
  }
34
36
  forBucket(name) {
@@ -81,9 +83,26 @@ class UserSettingsStorage {
81
83
  this.observables.set(
82
84
  key,
83
85
  new ObservableImpl((subscriber) => {
86
+ let signalSubscription;
84
87
  this.subscribers.add(subscriber);
85
- Promise.resolve().then(() => this.get(key)).then((snapshot) => subscriber.next(snapshot)).catch((error) => this.errorApi.post(error));
88
+ const updateSnapshot = () => {
89
+ Promise.resolve().then(() => this.get(key)).then((snapshot) => subscriber.next(snapshot)).catch((error) => this.errorApi.post(error));
90
+ };
91
+ if (this.signalApi) {
92
+ signalSubscription = this.signalApi.subscribe(
93
+ `user-settings`,
94
+ (msg) => {
95
+ if (msg.key === key) {
96
+ updateSnapshot();
97
+ }
98
+ }
99
+ );
100
+ }
101
+ updateSnapshot();
86
102
  return () => {
103
+ if (signalSubscription) {
104
+ signalSubscription.unsubscribe();
105
+ }
87
106
  this.subscribers.delete(subscriber);
88
107
  };
89
108
  }).filter(({ key: messageKey }) => messageKey === key)
package/dist/apis/StorageApi/UserSettingsStorage.esm.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"UserSettingsStorage.esm.js","sources":["../../../src/apis/StorageApi/UserSettingsStorage.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 { WebStorage } from '@backstage/core-app-api';\nimport {\n DiscoveryApi,\n ErrorApi,\n FetchApi,\n IdentityApi,\n StorageApi,\n StorageValueSnapshot,\n} from '@backstage/core-plugin-api';\nimport { ResponseError } from '@backstage/errors';\nimport { JsonValue, Observable } from '@backstage/types';\nimport ObservableImpl from 'zen-observable';\n\nconst JSON_HEADERS = {\n 'Content-Type': 'application/json; charset=utf-8',\n Accept: 'application/json',\n};\n\nconst buckets = new Map<string, UserSettingsStorage>();\n\n/**\n * An implementation of the storage API, that uses the user-settings backend to\n * persist the data in the DB.\n *\n * @public\n */\nexport class UserSettingsStorage implements StorageApi {\n private subscribers = new Set<\n ZenObservable.SubscriptionObserver<StorageValueSnapshot<JsonValue>>\n >();\n\n private readonly observables = new Map<\n string,\n Observable<StorageValueSnapshot<JsonValue>>\n >();\n\n private constructor(\n private readonly namespace: string,\n private readonly fetchApi: FetchApi,\n private readonly discoveryApi: DiscoveryApi,\n private readonly errorApi: ErrorApi,\n private readonly identityApi: IdentityApi,\n private readonly fallback: WebStorage,\n ) {}\n\n static create(options: {\n fetchApi: FetchApi;\n discoveryApi: DiscoveryApi;\n errorApi: ErrorApi;\n identityApi: IdentityApi;\n namespace?: string;\n }): UserSettingsStorage {\n return new UserSettingsStorage(\n options.namespace ?? 'default',\n options.fetchApi,\n options.discoveryApi,\n options.errorApi,\n options.identityApi,\n WebStorage.create({\n namespace: options.namespace,\n errorApi: options.errorApi,\n }),\n );\n }\n\n forBucket(name: string): StorageApi {\n // use dot instead of slash separator to have nicer URLs\n const bucketPath = `${this.namespace}.${name}`;\n\n if (!buckets.has(bucketPath)) {\n buckets.set(\n bucketPath,\n new UserSettingsStorage(\n bucketPath,\n this.fetchApi,\n this.discoveryApi,\n this.errorApi,\n this.identityApi,\n this.fallback,\n ),\n );\n }\n\n return buckets.get(bucketPath)!;\n }\n\n async remove(key: string): Promise<void> {\n const fetchUrl = await this.getFetchUrl(key);\n\n const response = await this.fetchApi.fetch(fetchUrl, {\n method: 'DELETE',\n });\n\n if (!response.ok && response.status !== 404) {\n throw await ResponseError.fromResponse(response);\n }\n\n this.notifyChanges({ key, presence: 'absent' });\n }\n\n async set<T extends JsonValue>(key: string, data: T): Promise<void> {\n if (!(await this.isSignedIn())) {\n await this.fallback.set(key, data);\n this.notifyChanges({ key, presence: 'present', value: data });\n return;\n }\n\n const fetchUrl = await this.getFetchUrl(key);\n\n const response = await this.fetchApi.fetch(fetchUrl, {\n method: 'PUT',\n headers: JSON_HEADERS,\n body: JSON.stringify({ value: data }),\n });\n\n if (!response.ok) {\n throw await ResponseError.fromResponse(response);\n }\n\n const { value } = await response.json();\n\n this.notifyChanges({ key, value, presence: 'present' });\n }\n\n observe$<T extends JsonValue>(\n key: string,\n ): Observable<StorageValueSnapshot<T>> {\n if (!this.observables.has(key)) {\n this.observables.set(\n key,\n new ObservableImpl<StorageValueSnapshot<JsonValue>>(subscriber => {\n this.subscribers.add(subscriber);\n\n // TODO(freben): Introduce server polling or similar, to ensure that different devices update when values change\n Promise.resolve()\n .then(() => this.get(key))\n .then(snapshot => subscriber.next(snapshot))\n .catch(error => this.errorApi.post(error));\n\n return () => {\n this.subscribers.delete(subscriber);\n };\n }).filter(({ key: messageKey }) => messageKey === key),\n );\n }\n\n return this.observables.get(key) as Observable<StorageValueSnapshot<T>>;\n }\n\n snapshot<T extends JsonValue>(key: string): StorageValueSnapshot<T> {\n return { key, presence: 'unknown' };\n }\n\n private async get<T extends JsonValue>(\n key: string,\n ): Promise<StorageValueSnapshot<T>> {\n if (!(await this.isSignedIn())) {\n // This explicitly uses WebStorage, which we know is synchronous and doesn't return presence: unknown\n return this.fallback.snapshot(key);\n }\n\n const fetchUrl = await this.getFetchUrl(key);\n const response = await this.fetchApi.fetch(fetchUrl);\n\n if (response.status === 404) {\n return { key, presence: 'absent' };\n }\n\n if (!response.ok) {\n throw await ResponseError.fromResponse(response);\n }\n\n try {\n const { value: rawValue } = await response.json();\n const value = JSON.parse(JSON.stringify(rawValue), (_key, val) => {\n if (typeof val === 'object' && val !== null) {\n Object.freeze(val);\n }\n return val;\n });\n\n return { key, presence: 'present', value };\n } catch {\n // If the value is not valid JSON, we return an unknown presence. This should never happen\n return { key, presence: 'absent' };\n }\n }\n\n private async getFetchUrl(key: string) {\n const baseUrl = await this.discoveryApi.getBaseUrl('user-settings');\n const encodedNamespace = encodeURIComponent(this.namespace);\n const encodedKey = encodeURIComponent(key);\n return `${baseUrl}/buckets/${encodedNamespace}/keys/${encodedKey}`;\n }\n\n private async notifyChanges<T extends JsonValue>(\n snapshot: StorageValueSnapshot<T>,\n ) {\n for (const subscription of this.subscribers) {\n try {\n subscription.next(snapshot);\n } catch {\n // ignore\n }\n }\n }\n\n private async isSignedIn(): Promise<boolean> {\n try {\n const credentials = await this.identityApi.getCredentials();\n return credentials?.token ? true : false;\n } catch {\n return false;\n }\n }\n}\n"],"names":[],"mappings":";;;;AA6BA,MAAM,YAAe,GAAA;AAAA,EACnB,cAAgB,EAAA,iCAAA;AAAA,EAChB,MAAQ,EAAA,kBAAA;AACV,CAAA,CAAA;AAEA,MAAM,OAAA,uBAAc,GAAiC,EAAA,CAAA;AAQ9C,MAAM,mBAA0C,CAAA;AAAA,EAU7C,YACW,SACA,EAAA,QAAA,EACA,YACA,EAAA,QAAA,EACA,aACA,QACjB,EAAA;AANiB,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,YAAA,GAAA,YAAA,CAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA,CAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AAAA,GAChB;AAAA,EAhBK,WAAA,uBAAkB,GAExB,EAAA,CAAA;AAAA,EAEe,WAAA,uBAAkB,GAGjC,EAAA,CAAA;AAAA,EAWF,OAAO,OAAO,OAMU,EAAA;AACtB,IAAA,OAAO,IAAI,mBAAA;AAAA,MACT,QAAQ,SAAa,IAAA,SAAA;AAAA,MACrB,OAAQ,CAAA,QAAA;AAAA,MACR,OAAQ,CAAA,YAAA;AAAA,MACR,OAAQ,CAAA,QAAA;AAAA,MACR,OAAQ,CAAA,WAAA;AAAA,MACR,WAAW,MAAO,CAAA;AAAA,QAChB,WAAW,OAAQ,CAAA,SAAA;AAAA,QACnB,UAAU,OAAQ,CAAA,QAAA;AAAA,OACnB,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAEA,UAAU,IAA0B,EAAA;AAElC,IAAA,MAAM,UAAa,GAAA,CAAA,EAAG,IAAK,CAAA,SAAS,IAAI,IAAI,CAAA,CAAA,CAAA;AAE5C,IAAA,IAAI,CAAC,OAAA,CAAQ,GAAI,CAAA,UAAU,CAAG,EAAA;AAC5B,MAAQ,OAAA,CAAA,GAAA;AAAA,QACN,UAAA;AAAA,QACA,IAAI,mBAAA;AAAA,UACF,UAAA;AAAA,UACA,IAAK,CAAA,QAAA;AAAA,UACL,IAAK,CAAA,YAAA;AAAA,UACL,IAAK,CAAA,QAAA;AAAA,UACL,IAAK,CAAA,WAAA;AAAA,UACL,IAAK,CAAA,QAAA;AAAA,SACP;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,OAAA,CAAQ,IAAI,UAAU,CAAA,CAAA;AAAA,GAC/B;AAAA,EAEA,MAAM,OAAO,GAA4B,EAAA;AACvC,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAE3C,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,QAAA,CAAS,MAAM,QAAU,EAAA;AAAA,MACnD,MAAQ,EAAA,QAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAA,IAAI,CAAC,QAAA,CAAS,EAAM,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3C,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAAA,KACjD;AAEA,IAAA,IAAA,CAAK,aAAc,CAAA,EAAE,GAAK,EAAA,QAAA,EAAU,UAAU,CAAA,CAAA;AAAA,GAChD;AAAA,EAEA,MAAM,GAAyB,CAAA,GAAA,EAAa,IAAwB,EAAA;AAClE,IAAA,IAAI,CAAE,MAAM,IAAK,CAAA,UAAA,EAAe,EAAA;AAC9B,MAAA,MAAM,IAAK,CAAA,QAAA,CAAS,GAAI,CAAA,GAAA,EAAK,IAAI,CAAA,CAAA;AACjC,MAAA,IAAA,CAAK,cAAc,EAAE,GAAA,EAAK,UAAU,SAAW,EAAA,KAAA,EAAO,MAAM,CAAA,CAAA;AAC5D,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAE3C,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,QAAA,CAAS,MAAM,QAAU,EAAA;AAAA,MACnD,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA,YAAA;AAAA,MACT,MAAM,IAAK,CAAA,SAAA,CAAU,EAAE,KAAA,EAAO,MAAM,CAAA;AAAA,KACrC,CAAA,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAAA,KACjD;AAEA,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,SAAS,IAAK,EAAA,CAAA;AAEtC,IAAA,IAAA,CAAK,cAAc,EAAE,GAAA,EAAK,KAAO,EAAA,QAAA,EAAU,WAAW,CAAA,CAAA;AAAA,GACxD;AAAA,EAEA,SACE,GACqC,EAAA;AACrC,IAAA,IAAI,CAAC,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,GAAG,CAAG,EAAA;AAC9B,MAAA,IAAA,CAAK,WAAY,CAAA,GAAA;AAAA,QACf,GAAA;AAAA,QACA,IAAI,eAAgD,CAAc,UAAA,KAAA;AAChE,UAAK,IAAA,CAAA,WAAA,CAAY,IAAI,UAAU,CAAA,CAAA;AAG/B,UAAQ,OAAA,CAAA,OAAA,GACL,IAAK,CAAA,MAAM,KAAK,GAAI,CAAA,GAAG,CAAC,CAAA,CACxB,IAAK,CAAA,CAAA,QAAA,KAAY,WAAW,IAAK,CAAA,QAAQ,CAAC,CAC1C,CAAA,KAAA,CAAM,WAAS,IAAK,CAAA,QAAA,CAAS,IAAK,CAAA,KAAK,CAAC,CAAA,CAAA;AAE3C,UAAA,OAAO,MAAM;AACX,YAAK,IAAA,CAAA,WAAA,CAAY,OAAO,UAAU,CAAA,CAAA;AAAA,WACpC,CAAA;AAAA,SACD,EAAE,MAAO,CAAA,CAAC,EAAE,GAAK,EAAA,UAAA,EAAiB,KAAA,UAAA,KAAe,GAAG,CAAA;AAAA,OACvD,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AAAA,GACjC;AAAA,EAEA,SAA8B,GAAsC,EAAA;AAClE,IAAO,OAAA,EAAE,GAAK,EAAA,QAAA,EAAU,SAAU,EAAA,CAAA;AAAA,GACpC;AAAA,EAEA,MAAc,IACZ,GACkC,EAAA;AAClC,IAAA,IAAI,CAAE,MAAM,IAAK,CAAA,UAAA,EAAe,EAAA;AAE9B,MAAO,OAAA,IAAA,CAAK,QAAS,CAAA,QAAA,CAAS,GAAG,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAC3C,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,QAAA,CAAS,MAAM,QAAQ,CAAA,CAAA;AAEnD,IAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,MAAO,OAAA,EAAE,GAAK,EAAA,QAAA,EAAU,QAAS,EAAA,CAAA;AAAA,KACnC;AAEA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAAA,KACjD;AAEA,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,KAAO,EAAA,QAAA,EAAa,GAAA,MAAM,SAAS,IAAK,EAAA,CAAA;AAChD,MAAM,MAAA,KAAA,GAAQ,KAAK,KAAM,CAAA,IAAA,CAAK,UAAU,QAAQ,CAAA,EAAG,CAAC,IAAA,EAAM,GAAQ,KAAA;AAChE,QAAA,IAAI,OAAO,GAAA,KAAQ,QAAY,IAAA,GAAA,KAAQ,IAAM,EAAA;AAC3C,UAAA,MAAA,CAAO,OAAO,GAAG,CAAA,CAAA;AAAA,SACnB;AACA,QAAO,OAAA,GAAA,CAAA;AAAA,OACR,CAAA,CAAA;AAED,MAAA,OAAO,EAAE,GAAA,EAAK,QAAU,EAAA,SAAA,EAAW,KAAM,EAAA,CAAA;AAAA,KACnC,CAAA,MAAA;AAEN,MAAO,OAAA,EAAE,GAAK,EAAA,QAAA,EAAU,QAAS,EAAA,CAAA;AAAA,KACnC;AAAA,GACF;AAAA,EAEA,MAAc,YAAY,GAAa,EAAA;AACrC,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,eAAe,CAAA,CAAA;AAClE,IAAM,MAAA,gBAAA,GAAmB,kBAAmB,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAC1D,IAAM,MAAA,UAAA,GAAa,mBAAmB,GAAG,CAAA,CAAA;AACzC,IAAA,OAAO,CAAG,EAAA,OAAO,CAAY,SAAA,EAAA,gBAAgB,SAAS,UAAU,CAAA,CAAA,CAAA;AAAA,GAClE;AAAA,EAEA,MAAc,cACZ,QACA,EAAA;AACA,IAAW,KAAA,MAAA,YAAA,IAAgB,KAAK,WAAa,EAAA;AAC3C,MAAI,IAAA;AACF,QAAA,YAAA,CAAa,KAAK,QAAQ,CAAA,CAAA;AAAA,OACpB,CAAA,MAAA;AAAA,OAER;AAAA,KACF;AAAA,GACF;AAAA,EAEA,MAAc,UAA+B,GAAA;AAC3C,IAAI,IAAA;AACF,MAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,cAAe,EAAA,CAAA;AAC1D,MAAO,OAAA,WAAA,EAAa,QAAQ,IAAO,GAAA,KAAA,CAAA;AAAA,KAC7B,CAAA,MAAA;AACN,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAAA,GACF;AACF;;;;"}
1
+ {"version":3,"file":"UserSettingsStorage.esm.js","sources":["../../../src/apis/StorageApi/UserSettingsStorage.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 { WebStorage } from '@backstage/core-app-api';\nimport {\n DiscoveryApi,\n ErrorApi,\n FetchApi,\n IdentityApi,\n StorageApi,\n StorageValueSnapshot,\n} from '@backstage/core-plugin-api';\nimport { ResponseError } from '@backstage/errors';\nimport { JsonValue, Observable } from '@backstage/types';\nimport { SignalApi, SignalSubscriber } from '@backstage/plugin-signals-react';\nimport ObservableImpl from 'zen-observable';\nimport { UserSettingsSignal } from '@backstage/plugin-user-settings-common';\n\nconst JSON_HEADERS = {\n 'Content-Type': 'application/json; charset=utf-8',\n Accept: 'application/json',\n};\n\nconst buckets = new Map<string, UserSettingsStorage>();\n\n/**\n * An implementation of the storage API, that uses the user-settings backend to\n * persist the data in the DB.\n *\n * @public\n */\nexport class UserSettingsStorage implements StorageApi {\n private subscribers = new Set<\n ZenObservable.SubscriptionObserver<StorageValueSnapshot<JsonValue>>\n >();\n\n private readonly observables = new Map<\n string,\n Observable<StorageValueSnapshot<JsonValue>>\n >();\n\n private constructor(\n private readonly namespace: string,\n private readonly fetchApi: FetchApi,\n private readonly discoveryApi: DiscoveryApi,\n private readonly errorApi: ErrorApi,\n private readonly identityApi: IdentityApi,\n private readonly fallback: WebStorage,\n private readonly signalApi?: SignalApi,\n ) {}\n\n static create(options: {\n fetchApi: FetchApi;\n discoveryApi: DiscoveryApi;\n errorApi: ErrorApi;\n identityApi: IdentityApi;\n signalApi?: SignalApi;\n namespace?: string;\n }): UserSettingsStorage {\n return new UserSettingsStorage(\n options.namespace ?? 'default',\n options.fetchApi,\n options.discoveryApi,\n options.errorApi,\n options.identityApi,\n WebStorage.create({\n namespace: options.namespace,\n errorApi: options.errorApi,\n }),\n options.signalApi,\n );\n }\n\n forBucket(name: string): StorageApi {\n // use dot instead of slash separator to have nicer URLs\n const bucketPath = `${this.namespace}.${name}`;\n\n if (!buckets.has(bucketPath)) {\n buckets.set(\n bucketPath,\n new UserSettingsStorage(\n bucketPath,\n this.fetchApi,\n this.discoveryApi,\n this.errorApi,\n this.identityApi,\n this.fallback,\n ),\n );\n }\n\n return buckets.get(bucketPath)!;\n }\n\n async remove(key: string): Promise<void> {\n const fetchUrl = await this.getFetchUrl(key);\n\n const response = await this.fetchApi.fetch(fetchUrl, {\n method: 'DELETE',\n });\n\n if (!response.ok && response.status !== 404) {\n throw await ResponseError.fromResponse(response);\n }\n\n this.notifyChanges({ key, presence: 'absent' });\n }\n\n async set<T extends JsonValue>(key: string, data: T): Promise<void> {\n if (!(await this.isSignedIn())) {\n await this.fallback.set(key, data);\n this.notifyChanges({ key, presence: 'present', value: data });\n return;\n }\n\n const fetchUrl = await this.getFetchUrl(key);\n\n const response = await this.fetchApi.fetch(fetchUrl, {\n method: 'PUT',\n headers: JSON_HEADERS,\n body: JSON.stringify({ value: data }),\n });\n\n if (!response.ok) {\n throw await ResponseError.fromResponse(response);\n }\n\n const { value } = await response.json();\n\n this.notifyChanges({ key, value, presence: 'present' });\n }\n\n observe$<T extends JsonValue>(\n key: string,\n ): Observable<StorageValueSnapshot<T>> {\n if (!this.observables.has(key)) {\n this.observables.set(\n key,\n new ObservableImpl<StorageValueSnapshot<JsonValue>>(subscriber => {\n let signalSubscription: SignalSubscriber | undefined;\n this.subscribers.add(subscriber);\n\n const updateSnapshot = () => {\n Promise.resolve()\n .then(() => this.get(key))\n .then(snapshot => subscriber.next(snapshot))\n .catch(error => this.errorApi.post(error));\n };\n\n if (this.signalApi) {\n signalSubscription = this.signalApi.subscribe(\n `user-settings`,\n (msg: UserSettingsSignal) => {\n if (msg.key === key) {\n updateSnapshot();\n }\n },\n );\n }\n\n updateSnapshot();\n\n return () => {\n if (signalSubscription) {\n signalSubscription.unsubscribe();\n }\n this.subscribers.delete(subscriber);\n };\n }).filter(({ key: messageKey }) => messageKey === key),\n );\n }\n\n return this.observables.get(key) as Observable<StorageValueSnapshot<T>>;\n }\n\n snapshot<T extends JsonValue>(key: string): StorageValueSnapshot<T> {\n return { key, presence: 'unknown' };\n }\n\n private async get<T extends JsonValue>(\n key: string,\n ): Promise<StorageValueSnapshot<T>> {\n if (!(await this.isSignedIn())) {\n // This explicitly uses WebStorage, which we know is synchronous and doesn't return presence: unknown\n return this.fallback.snapshot(key);\n }\n\n const fetchUrl = await this.getFetchUrl(key);\n const response = await this.fetchApi.fetch(fetchUrl);\n\n if (response.status === 404) {\n return { key, presence: 'absent' };\n }\n\n if (!response.ok) {\n throw await ResponseError.fromResponse(response);\n }\n\n try {\n const { value: rawValue } = await response.json();\n const value = JSON.parse(JSON.stringify(rawValue), (_key, val) => {\n if (typeof val === 'object' && val !== null) {\n Object.freeze(val);\n }\n return val;\n });\n\n return { key, presence: 'present', value };\n } catch {\n // If the value is not valid JSON, we return an unknown presence. This should never happen\n return { key, presence: 'absent' };\n }\n }\n\n private async getFetchUrl(key: string) {\n const baseUrl = await this.discoveryApi.getBaseUrl('user-settings');\n const encodedNamespace = encodeURIComponent(this.namespace);\n const encodedKey = encodeURIComponent(key);\n return `${baseUrl}/buckets/${encodedNamespace}/keys/${encodedKey}`;\n }\n\n private async notifyChanges<T extends JsonValue>(\n snapshot: StorageValueSnapshot<T>,\n ) {\n for (const subscription of this.subscribers) {\n try {\n subscription.next(snapshot);\n } catch {\n // ignore\n }\n }\n }\n\n private async isSignedIn(): Promise<boolean> {\n try {\n const credentials = await this.identityApi.getCredentials();\n return credentials?.token ? true : false;\n } catch {\n return false;\n }\n }\n}\n"],"names":[],"mappings":";;;;AA+BA,MAAM,YAAe,GAAA;AAAA,EACnB,cAAgB,EAAA,iCAAA;AAAA,EAChB,MAAQ,EAAA,kBAAA;AACV,CAAA,CAAA;AAEA,MAAM,OAAA,uBAAc,GAAiC,EAAA,CAAA;AAQ9C,MAAM,mBAA0C,CAAA;AAAA,EAU7C,YACW,SACA,EAAA,QAAA,EACA,cACA,QACA,EAAA,WAAA,EACA,UACA,SACjB,EAAA;AAPiB,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,YAAA,GAAA,YAAA,CAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,WAAA,GAAA,WAAA,CAAA;AACA,IAAA,IAAA,CAAA,QAAA,GAAA,QAAA,CAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA,CAAA;AAAA,GAChB;AAAA,EAjBK,WAAA,uBAAkB,GAExB,EAAA,CAAA;AAAA,EAEe,WAAA,uBAAkB,GAGjC,EAAA,CAAA;AAAA,EAYF,OAAO,OAAO,OAOU,EAAA;AACtB,IAAA,OAAO,IAAI,mBAAA;AAAA,MACT,QAAQ,SAAa,IAAA,SAAA;AAAA,MACrB,OAAQ,CAAA,QAAA;AAAA,MACR,OAAQ,CAAA,YAAA;AAAA,MACR,OAAQ,CAAA,QAAA;AAAA,MACR,OAAQ,CAAA,WAAA;AAAA,MACR,WAAW,MAAO,CAAA;AAAA,QAChB,WAAW,OAAQ,CAAA,SAAA;AAAA,QACnB,UAAU,OAAQ,CAAA,QAAA;AAAA,OACnB,CAAA;AAAA,MACD,OAAQ,CAAA,SAAA;AAAA,KACV,CAAA;AAAA,GACF;AAAA,EAEA,UAAU,IAA0B,EAAA;AAElC,IAAA,MAAM,UAAa,GAAA,CAAA,EAAG,IAAK,CAAA,SAAS,IAAI,IAAI,CAAA,CAAA,CAAA;AAE5C,IAAA,IAAI,CAAC,OAAA,CAAQ,GAAI,CAAA,UAAU,CAAG,EAAA;AAC5B,MAAQ,OAAA,CAAA,GAAA;AAAA,QACN,UAAA;AAAA,QACA,IAAI,mBAAA;AAAA,UACF,UAAA;AAAA,UACA,IAAK,CAAA,QAAA;AAAA,UACL,IAAK,CAAA,YAAA;AAAA,UACL,IAAK,CAAA,QAAA;AAAA,UACL,IAAK,CAAA,WAAA;AAAA,UACL,IAAK,CAAA,QAAA;AAAA,SACP;AAAA,OACF,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,OAAA,CAAQ,IAAI,UAAU,CAAA,CAAA;AAAA,GAC/B;AAAA,EAEA,MAAM,OAAO,GAA4B,EAAA;AACvC,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAE3C,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,QAAA,CAAS,MAAM,QAAU,EAAA;AAAA,MACnD,MAAQ,EAAA,QAAA;AAAA,KACT,CAAA,CAAA;AAED,IAAA,IAAI,CAAC,QAAA,CAAS,EAAM,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3C,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAAA,KACjD;AAEA,IAAA,IAAA,CAAK,aAAc,CAAA,EAAE,GAAK,EAAA,QAAA,EAAU,UAAU,CAAA,CAAA;AAAA,GAChD;AAAA,EAEA,MAAM,GAAyB,CAAA,GAAA,EAAa,IAAwB,EAAA;AAClE,IAAA,IAAI,CAAE,MAAM,IAAK,CAAA,UAAA,EAAe,EAAA;AAC9B,MAAA,MAAM,IAAK,CAAA,QAAA,CAAS,GAAI,CAAA,GAAA,EAAK,IAAI,CAAA,CAAA;AACjC,MAAA,IAAA,CAAK,cAAc,EAAE,GAAA,EAAK,UAAU,SAAW,EAAA,KAAA,EAAO,MAAM,CAAA,CAAA;AAC5D,MAAA,OAAA;AAAA,KACF;AAEA,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAE3C,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,QAAA,CAAS,MAAM,QAAU,EAAA;AAAA,MACnD,MAAQ,EAAA,KAAA;AAAA,MACR,OAAS,EAAA,YAAA;AAAA,MACT,MAAM,IAAK,CAAA,SAAA,CAAU,EAAE,KAAA,EAAO,MAAM,CAAA;AAAA,KACrC,CAAA,CAAA;AAED,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAAA,KACjD;AAEA,IAAA,MAAM,EAAE,KAAA,EAAU,GAAA,MAAM,SAAS,IAAK,EAAA,CAAA;AAEtC,IAAA,IAAA,CAAK,cAAc,EAAE,GAAA,EAAK,KAAO,EAAA,QAAA,EAAU,WAAW,CAAA,CAAA;AAAA,GACxD;AAAA,EAEA,SACE,GACqC,EAAA;AACrC,IAAA,IAAI,CAAC,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,GAAG,CAAG,EAAA;AAC9B,MAAA,IAAA,CAAK,WAAY,CAAA,GAAA;AAAA,QACf,GAAA;AAAA,QACA,IAAI,eAAgD,CAAc,UAAA,KAAA;AAChE,UAAI,IAAA,kBAAA,CAAA;AACJ,UAAK,IAAA,CAAA,WAAA,CAAY,IAAI,UAAU,CAAA,CAAA;AAE/B,UAAA,MAAM,iBAAiB,MAAM;AAC3B,YAAQ,OAAA,CAAA,OAAA,GACL,IAAK,CAAA,MAAM,KAAK,GAAI,CAAA,GAAG,CAAC,CAAA,CACxB,IAAK,CAAA,CAAA,QAAA,KAAY,WAAW,IAAK,CAAA,QAAQ,CAAC,CAC1C,CAAA,KAAA,CAAM,WAAS,IAAK,CAAA,QAAA,CAAS,IAAK,CAAA,KAAK,CAAC,CAAA,CAAA;AAAA,WAC7C,CAAA;AAEA,UAAA,IAAI,KAAK,SAAW,EAAA;AAClB,YAAA,kBAAA,GAAqB,KAAK,SAAU,CAAA,SAAA;AAAA,cAClC,CAAA,aAAA,CAAA;AAAA,cACA,CAAC,GAA4B,KAAA;AAC3B,gBAAI,IAAA,GAAA,CAAI,QAAQ,GAAK,EAAA;AACnB,kBAAe,cAAA,EAAA,CAAA;AAAA,iBACjB;AAAA,eACF;AAAA,aACF,CAAA;AAAA,WACF;AAEA,UAAe,cAAA,EAAA,CAAA;AAEf,UAAA,OAAO,MAAM;AACX,YAAA,IAAI,kBAAoB,EAAA;AACtB,cAAA,kBAAA,CAAmB,WAAY,EAAA,CAAA;AAAA,aACjC;AACA,YAAK,IAAA,CAAA,WAAA,CAAY,OAAO,UAAU,CAAA,CAAA;AAAA,WACpC,CAAA;AAAA,SACD,EAAE,MAAO,CAAA,CAAC,EAAE,GAAK,EAAA,UAAA,EAAiB,KAAA,UAAA,KAAe,GAAG,CAAA;AAAA,OACvD,CAAA;AAAA,KACF;AAEA,IAAO,OAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,GAAG,CAAA,CAAA;AAAA,GACjC;AAAA,EAEA,SAA8B,GAAsC,EAAA;AAClE,IAAO,OAAA,EAAE,GAAK,EAAA,QAAA,EAAU,SAAU,EAAA,CAAA;AAAA,GACpC;AAAA,EAEA,MAAc,IACZ,GACkC,EAAA;AAClC,IAAA,IAAI,CAAE,MAAM,IAAK,CAAA,UAAA,EAAe,EAAA;AAE9B,MAAO,OAAA,IAAA,CAAK,QAAS,CAAA,QAAA,CAAS,GAAG,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,GAAG,CAAA,CAAA;AAC3C,IAAA,MAAM,QAAW,GAAA,MAAM,IAAK,CAAA,QAAA,CAAS,MAAM,QAAQ,CAAA,CAAA;AAEnD,IAAI,IAAA,QAAA,CAAS,WAAW,GAAK,EAAA;AAC3B,MAAO,OAAA,EAAE,GAAK,EAAA,QAAA,EAAU,QAAS,EAAA,CAAA;AAAA,KACnC;AAEA,IAAI,IAAA,CAAC,SAAS,EAAI,EAAA;AAChB,MAAM,MAAA,MAAM,aAAc,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAAA,KACjD;AAEA,IAAI,IAAA;AACF,MAAA,MAAM,EAAE,KAAO,EAAA,QAAA,EAAa,GAAA,MAAM,SAAS,IAAK,EAAA,CAAA;AAChD,MAAM,MAAA,KAAA,GAAQ,KAAK,KAAM,CAAA,IAAA,CAAK,UAAU,QAAQ,CAAA,EAAG,CAAC,IAAA,EAAM,GAAQ,KAAA;AAChE,QAAA,IAAI,OAAO,GAAA,KAAQ,QAAY,IAAA,GAAA,KAAQ,IAAM,EAAA;AAC3C,UAAA,MAAA,CAAO,OAAO,GAAG,CAAA,CAAA;AAAA,SACnB;AACA,QAAO,OAAA,GAAA,CAAA;AAAA,OACR,CAAA,CAAA;AAED,MAAA,OAAO,EAAE,GAAA,EAAK,QAAU,EAAA,SAAA,EAAW,KAAM,EAAA,CAAA;AAAA,KACnC,CAAA,MAAA;AAEN,MAAO,OAAA,EAAE,GAAK,EAAA,QAAA,EAAU,QAAS,EAAA,CAAA;AAAA,KACnC;AAAA,GACF;AAAA,EAEA,MAAc,YAAY,GAAa,EAAA;AACrC,IAAA,MAAM,OAAU,GAAA,MAAM,IAAK,CAAA,YAAA,CAAa,WAAW,eAAe,CAAA,CAAA;AAClE,IAAM,MAAA,gBAAA,GAAmB,kBAAmB,CAAA,IAAA,CAAK,SAAS,CAAA,CAAA;AAC1D,IAAM,MAAA,UAAA,GAAa,mBAAmB,GAAG,CAAA,CAAA;AACzC,IAAA,OAAO,CAAG,EAAA,OAAO,CAAY,SAAA,EAAA,gBAAgB,SAAS,UAAU,CAAA,CAAA,CAAA;AAAA,GAClE;AAAA,EAEA,MAAc,cACZ,QACA,EAAA;AACA,IAAW,KAAA,MAAA,YAAA,IAAgB,KAAK,WAAa,EAAA;AAC3C,MAAI,IAAA;AACF,QAAA,YAAA,CAAa,KAAK,QAAQ,CAAA,CAAA;AAAA,OACpB,CAAA,MAAA;AAAA,OAER;AAAA,KACF;AAAA,GACF;AAAA,EAEA,MAAc,UAA+B,GAAA;AAC3C,IAAI,IAAA;AACF,MAAA,MAAM,WAAc,GAAA,MAAM,IAAK,CAAA,WAAA,CAAY,cAAe,EAAA,CAAA;AAC1D,MAAO,OAAA,WAAA,EAAa,QAAQ,IAAO,GAAA,KAAA,CAAA;AAAA,KAC7B,CAAA,MAAA;AACN,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAAA,GACF;AACF;;;;"}
package/dist/index.d.ts CHANGED
@@ -2,6 +2,7 @@
2
2
  import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
3
3
  import { StorageApi, FetchApi, DiscoveryApi, ErrorApi, IdentityApi, StorageValueSnapshot, IconComponent, ApiRef, ProfileInfoApi, SessionApi, ProfileInfo } from '@backstage/core-plugin-api';
4
4
  import { JsonValue, Observable } from '@backstage/types';
5
+ import { SignalApi } from '@backstage/plugin-signals-react';
5
6
  import * as React from 'react';
6
7
  import React__default, { PropsWithChildren } from 'react';
7
8
  import { TabProps } from '@material-ui/core/Tab';
@@ -19,6 +20,7 @@ declare class UserSettingsStorage implements StorageApi {
19
20
  private readonly errorApi;
20
21
  private readonly identityApi;
21
22
  private readonly fallback;
23
+ private readonly signalApi?;
22
24
  private subscribers;
23
25
  private readonly observables;
24
26
  private constructor();
@@ -27,6 +29,7 @@ declare class UserSettingsStorage implements StorageApi {
27
29
  discoveryApi: DiscoveryApi;
28
30
  errorApi: ErrorApi;
29
31
  identityApi: IdentityApi;
32
+ signalApi?: SignalApi;
30
33
  namespace?: string;
31
34
  }): UserSettingsStorage;
32
35
  forBucket(name: string): StorageApi;
package/package.json CHANGED
@@ -1,9 +1,15 @@
1
1
  {
2
2
  "name": "@backstage/plugin-user-settings",
3
- "version": "0.8.7-next.1",
3
+ "version": "0.8.7-next.2",
4
4
  "description": "A Backstage plugin that provides a settings page",
5
5
  "backstage": {
6
- "role": "frontend-plugin"
6
+ "role": "frontend-plugin",
7
+ "pluginId": "user-settings",
8
+ "pluginPackages": [
9
+ "@backstage/plugin-user-settings",
10
+ "@backstage/plugin-user-settings-backend",
11
+ "@backstage/plugin-user-settings-common"
12
+ ]
7
13
  },
8
14
  "publishConfig": {
9
15
  "access": "public"
@@ -49,12 +55,14 @@
49
55
  },
50
56
  "dependencies": {
51
57
  "@backstage/core-app-api": "^1.12.6-next.0",
52
- "@backstage/core-compat-api": "^0.2.6-next.1",
53
- "@backstage/core-components": "^0.14.8-next.1",
58
+ "@backstage/core-compat-api": "^0.2.6-next.2",
59
+ "@backstage/core-components": "^0.14.8-next.2",
54
60
  "@backstage/core-plugin-api": "^1.9.3-next.0",
55
61
  "@backstage/errors": "^1.2.4",
56
- "@backstage/frontend-plugin-api": "^0.6.6-next.1",
57
- "@backstage/plugin-catalog-react": "^1.12.1-next.1",
62
+ "@backstage/frontend-plugin-api": "^0.6.6-next.2",
63
+ "@backstage/plugin-catalog-react": "^1.12.1-next.2",
64
+ "@backstage/plugin-signals-react": "^0.0.4-next.1",
65
+ "@backstage/plugin-user-settings-common": "^0.0.1-next.0",
58
66
  "@backstage/theme": "^0.5.6-next.0",
59
67
  "@backstage/types": "^1.1.1",
60
68
  "@material-ui/core": "^4.12.2",
@@ -65,10 +73,10 @@
65
73
  "zen-observable": "^0.10.0"
66
74
  },
67
75
  "devDependencies": {
68
- "@backstage/cli": "^0.26.7-next.2",
69
- "@backstage/dev-utils": "^1.0.33-next.1",
70
- "@backstage/plugin-catalog": "^1.21.0-next.2",
71
- "@backstage/test-utils": "^1.5.6-next.1",
76
+ "@backstage/cli": "^0.26.7-next.3",
77
+ "@backstage/dev-utils": "^1.0.33-next.2",
78
+ "@backstage/plugin-catalog": "^1.21.0-next.3",
79
+ "@backstage/test-utils": "^1.5.6-next.2",
72
80
  "@testing-library/dom": "^10.0.0",
73
81
  "@testing-library/jest-dom": "^6.0.0",
74
82
  "@testing-library/react": "^15.0.0",