@backstage/core-app-api 0.5.0 → 0.5.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @backstage/core-app-api
 
+## 0.5.1
+
+### Patch Changes
+
+- f959c22787: Asynchronous methods on the identity API can now reliably be called at any time, including early in the bootstrap process or prior to successful sign-in.
+
+  Previously in such situations, a `Tried to access IdentityApi before app was loaded` error would be thrown. Now, those methods will wait and resolve eventually (as soon as a concrete identity API is provided).
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/index.esm.js

@@ -2211,8 +2211,16 @@ function logDeprecation(thing) {
   console.warn(`WARNING: Call to ${thing} is deprecated and will break in the future`);
 }
 class AppIdentityProxy {
+  constructor() {
+    this.resolveTarget = () => {
+    };
+    this.waitForTarget = new Promise((resolve) => {
+      this.resolveTarget = resolve;
+    });
+  }
   setTarget(identityApi) {
     this.target = identityApi;
+    this.resolveTarget(identityApi);
   }
   getUserId() {
     if (!this.target) {
@@ -2235,42 +2243,29 @@ class AppIdentityProxy {
     return this.target.getProfile();
   }
   async getProfileInfo() {
-    if (!this.target) {
-      throw mkError("getProfileInfo");
-    }
-    return this.target.getProfileInfo();
+    return this.waitForTarget.then((target) => target.getProfileInfo());
   }
   async getBackstageIdentity() {
-    if (!this.target) {
-      throw mkError("getBackstageIdentity");
-    }
-    const identity = await this.target.getBackstageIdentity();
+    const identity = await this.waitForTarget.then((target) => target.getBackstageIdentity());
     if (!identity.userEntityRef.match(/^.*:.*\/.*$/)) {
       console.warn(`WARNING: The App IdentityApi provided an invalid userEntityRef, '${identity.userEntityRef}'. It must be a full Entity Reference of the form '<kind>:<namespace>/<name>'.`);
     }
     return identity;
   }
   async getCredentials() {
-    if (!this.target) {
-      throw mkError("getCredentials");
-    }
-    return this.target.getCredentials();
+    return this.waitForTarget.then((target) => target.getCredentials());
   }
   async getIdToken() {
-    if (!this.target) {
-      throw mkError("getIdToken");
-    }
-    if (!this.target.getIdToken) {
-      throw new Error("IdentityApi does not implement getIdToken");
-    }
-    logDeprecation("getIdToken");
-    return this.target.getIdToken();
+    return this.waitForTarget.then((target) => {
+      if (!target.getIdToken) {
+        throw new Error("IdentityApi does not implement getIdToken");
+      }
+      logDeprecation("getIdToken");
+      return target.getIdToken();
+    });
   }
   async signOut() {
-    if (!this.target) {
-      throw mkError("signOut");
-    }
-    await this.target.signOut();
+    await this.waitForTarget.then((target) => target.signOut());
     location.reload();
   }
 }