@inrupt/solid-client-authn-browser 1.13.4 → 1.14.0

package/src/defaultSession.spec.ts

@@ -19,6 +19,7 @@
 // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //
 
+import { EVENTS } from "@inrupt/solid-client-authn-core";
 import { jest, it, expect } from "@jest/globals";
 import {
   fetch,
@@ -29,33 +30,34 @@ import {
   onLogin,
   onSessionRestore,
   onLogout,
+  events,
 } from "./defaultSession";
-import type * as SessionModuleType from "./Session";
-
-jest.mock("../src/Session.ts");
-
-it("does not instantiate a Session without calling one of its methods", () => {
-  const mockedSession = jest.requireMock(
-    "../src/Session.ts"
-  ) as typeof SessionModuleType;
-
-  expect(mockedSession.Session).not.toHaveBeenCalled();
+import * as SessionModule from "./Session";
+
+it("instantiates the default session lazily", () => {
+  const singletonSession = new SessionModule.Session();
+  const spiedConstructor = jest
+    .spyOn(SessionModule, "Session")
+    .mockImplementation(() => singletonSession);
+  expect(spiedConstructor).not.toHaveBeenCalled();
+  events().on(EVENTS.LOGIN, jest.fn());
+  expect(spiedConstructor).toHaveBeenCalled();
 });
 
 it("re-uses the same Session when calling multiple methods", () => {
-  const mockedSession = jest.requireMock(
-    "../src/Session.ts"
-  ) as typeof SessionModuleType;
+  const singletonSession = new SessionModule.Session();
+  const spiedConstructor = jest
+    .spyOn(SessionModule, "Session")
+    .mockImplementation(() => singletonSession);
 
-  expect(mockedSession.Session).not.toHaveBeenCalled();
+  events().on(EVENTS.LOGIN, jest.fn());
 
-  onLogin(jest.fn());
+  expect(spiedConstructor).toHaveBeenCalledTimes(1);
 
-  expect(mockedSession.Session).toHaveBeenCalledTimes(1);
+  events().on(EVENTS.LOGOUT, jest.fn());
 
-  onLogout(jest.fn());
-
-  expect(mockedSession.Session).toHaveBeenCalledTimes(1);
+  // No new session has been instantiated.
+  expect(spiedConstructor).toHaveBeenCalledTimes(1);
 });
 
 it("all functions pass on their arguments to the default session", () => {
@@ -73,6 +75,7 @@ it("all functions pass on their arguments to the default session", () => {
   const onLoginSpy = jest.spyOn(defaultSession, "onLogin");
   const onLogoutSpy = jest.spyOn(defaultSession, "onLogout");
   const onSessionRestoreSpy = jest.spyOn(defaultSession, "onSessionRestore");
+  const eventsOnSpy = jest.spyOn(defaultSession.events, "on");
 
   expect(fetchSpy).not.toHaveBeenCalled();
   // eslint-disable-next-line @typescript-eslint/no-floating-promises
@@ -94,6 +97,12 @@ it("all functions pass on their arguments to the default session", () => {
   handleIncomingRedirect("https://example.com");
   expect(handleIncomingRedirectSpy).toHaveBeenCalledTimes(1);
 
+  // onLogin will internall call events.on(...), so the following test
+  // must come first.
+  expect(eventsOnSpy).not.toHaveBeenCalled();
+  events().on(EVENTS.LOGIN, jest.fn());
+  expect(eventsOnSpy).toHaveBeenCalledTimes(1);
+
   expect(onLoginSpy).not.toHaveBeenCalled();
   onLogin(jest.fn());
   expect(onLoginSpy).toHaveBeenCalledTimes(1);

package/src/defaultSession.ts

@@ -21,7 +21,7 @@
 
 import { Session } from "./Session";
 
-let defaultSession: Session;
+let defaultSession: Session | undefined;
 
 /**
  * Obtain the {@link Session} used when not explicitly instantiating one yourself.
@@ -97,6 +97,8 @@ export const handleIncomingRedirect: Session["handleIncomingRedirect"] = (
  * @since 1.3.0
  *
  * @param callback The function called when a user completes login.
+ * @deprecated Prefer events.on(EVENTS.LOGIN, callback)
+
  */
 export const onLogin: Session["onLogin"] = (...args) => {
   const session = getDefaultSession();
@@ -108,6 +110,8 @@ export const onLogin: Session["onLogin"] = (...args) => {
  *
  * @param callback The function called when a user completes logout.
  * @since 1.3.0
+ * @deprecated Prefer events.on(EVENTS.LOGOUT, callback)
+
  */
 export const onLogout: Session["onLogout"] = (...args) => {
   const session = getDefaultSession();
@@ -119,8 +123,18 @@ export const onLogout: Session["onLogout"] = (...args) => {
  *
  * @param callback The function called when a session is restored.
  * @since 1.3.0
+ * @deprecated Prefer events.on(EVENTS.SESSION_RESTORED, callback)
  */
 export const onSessionRestore: Session["onSessionRestore"] = (...args) => {
   const session = getDefaultSession();
   return session.onSessionRestore(...args);
 };
+
+/**
+ * {@link SessionEventEmitter} instance to subscribe to events by the default session.
+ *
+ * @since Unreleased
+ */
+export const events = (): Session["events"] => {
+  return getDefaultSession().events;
+};

package/src/index.ts

@@ -34,4 +34,5 @@ export {
   NotImplementedError,
   ConfigurationError,
   InMemoryStorage,
+  EVENTS,
 } from "@inrupt/solid-client-authn-core";