@singularsystems/neo-core 0.10.66 → 0.10.67

package/dist/AppServices/Config/ConfigModel.d.ts

@@ -1,5 +1,5 @@
 export interface IConfigModel {
-    baseUrl: string;
+    readonly baseUrl: string;
     /**
      * True by default if the NODE_ENV environment variable is "development".
      **/
@@ -12,9 +12,10 @@ export interface IConfigModel {
     initialise(): void;
 }
 export default class ConfigModel implements IConfigModel {
-    baseUrl: string;
+    private _baseUrl;
     isDevelopment: boolean;
     isTest: boolean;
     get isTestOrDevelopment(): boolean;
+    get baseUrl(): string;
     initialise(): void;
 }

package/dist/AppServices/Config/ConfigModel.js

@@ -10,6 +10,17 @@ var ConfigModel = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(ConfigModel.prototype, "baseUrl", {
+        get: function () {
+            if (!this._baseUrl) {
+                var baseTag = document.getElementsByTagName('base')[0];
+                this._baseUrl = baseTag ? baseTag.getAttribute("href") || "" : "";
+            }
+            return this._baseUrl;
+        },
+        enumerable: false,
+        configurable: true
+    });
     ConfigModel.prototype.initialise = function () {
     };
     return ConfigModel;

package/dist/AppServices/Config/ConfigService.js

@@ -8,13 +8,11 @@ var ConfigService = /** @class */ (function () {
     }
     ConfigService.prototype.loadConfig = function (path) {
         return __awaiter(this, void 0, void 0, function () {
-            var baseTag, baseUrl, timestamp, response, error_1;
+            var timestamp, response, error_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        baseTag = document.getElementsByTagName('base')[0];
-                        baseUrl = baseTag ? baseTag.getAttribute("href") || "" : "";
-                        path = path !== null && path !== void 0 ? path : "".concat(baseUrl, "/config.json");
+                        path = path !== null && path !== void 0 ? path : "".concat(this.config.baseUrl, "/config.json");
                         _a.label = 1;
                     case 1:
                         _a.trys.push([1, 3, , 4]);
@@ -25,7 +23,6 @@ var ConfigService = /** @class */ (function () {
                         // The raw parsed json objects properties are copied into the config model.
                         // It is up to the config model to transform its properties if required (in the initialise method). 
                         Object.assign(this.config, response.data);
-                        this.config.baseUrl = baseUrl;
                         this.config.initialise();
                         return [2 /*return*/, this.config];
                     case 3:

package/dist/Security/IAuthenticationService.d.ts

@@ -9,6 +9,11 @@ export default interface IAuthenticationService {
      * Load a user from session storage if there is a stored token.
      */
     loadUserFromSession(): Promise<IUser | null>;
+    /**
+     * Checks if the user is signed in, and if not, redirects to login.
+     * Returns true if the user is logged in.
+     */
+    ensureSignedIn(redirectLocal?: string): boolean;
     /**
      * Starts the sign in process
      * @param redirectLocal The path to redirect to after calling endSignIn

package/dist/Security/Oidc/OidcAuthService.d.ts

@@ -20,6 +20,7 @@ export default abstract class OidcAuthService<TUser extends OidcUser = OidcUser>
     constructor(userManager: IUserManager, axios: AxiosInstance);
     loadUserFromToken(): Promise<TUser | null>;
     loadUserFromSession(): Promise<TUser | null>;
+    ensureSignedIn(redirectLocal?: string): boolean;
     /**
      * Redirect to identity server to get the auth token.
      * @param redirectPath Local path to redirect to once login is complete.
@@ -40,7 +41,7 @@ export default abstract class OidcAuthService<TUser extends OidcUser = OidcUser>
     protected createUser(user: IOidcUser): OidcUser;
     private onUserUnloaded;
     private setUser;
-    signinSilent(): Promise<IOidcUser>;
+    signinSilent(): Promise<IOidcUser | null>;
     beginSignOut(): void;
     endSignOut(): Promise<any>;
     signOutLocal(): void;
@@ -57,4 +58,10 @@ export default abstract class OidcAuthService<TUser extends OidcUser = OidcUser>
         revocation_endpoint: string;
         introspection_endpoint: string;
     };
+    /**
+     * If this is a silent sign in (based on the current uri), `endSignInSilent()` is called on the oidc client, and this method returns true.
+     * This should be called on startup of your app. If this returns true, don't continue with startup, since this iframe will be shortly disposed.
+     * @param silentRedirectRoute The app relative path used for silent sign in callbacks.
+     */
+    static isSilentSignIn(silentRedirectRoute: string): boolean;
 }

package/dist/Security/Oidc/OidcAuthService.js

@@ -21,7 +21,10 @@ var OidcAuthService = /** @class */ (function () {
         this.userManager = userManager;
         this.userManager.events.addUserLoaded(this.onUserLoaded.bind(this));
         this.userManager.events.addUserUnloaded(this.onUserUnloaded.bind(this));
-        this.userManager.events.addAccessTokenExpiring(this.signinSilent.bind(this));
+        if (!this.userManager.settings.automaticSilentRenew) {
+            // If automaticSilentRenew is set to true, then the user manager will handle automatic renewal.
+            this.userManager.events.addAccessTokenExpiring(this.signinSilent.bind(this));
+        }
     }
     OidcAuthService.prototype.loadUserFromToken = function () {
         return this.loadUserFromSession();
@@ -43,6 +46,16 @@ var OidcAuthService = /** @class */ (function () {
             });
         });
     };
+    OidcAuthService.prototype.ensureSignedIn = function (redirectLocal) {
+        var settings = this.userManager.settings;
+        if (!this.isAuthenticated &&
+            (!settings.redirect_uri || !window.location.href.startsWith(settings.redirect_uri)) &&
+            (!settings.silent_redirect_uri || !window.location.href.startsWith(settings.silent_redirect_uri))) {
+            this.beginSignIn(redirectLocal);
+            return false;
+        }
+        return true;
+    };
     /**
      * Redirect to identity server to get the auth token.
      * @param redirectPath Local path to redirect to once login is complete.
@@ -175,6 +188,20 @@ var OidcAuthService = /** @class */ (function () {
             introspection_endpoint: identityServerUrl + "/connect/introspect"
         };
     };
+    /**
+     * If this is a silent sign in (based on the current uri), `endSignInSilent()` is called on the oidc client, and this method returns true.
+     * This should be called on startup of your app. If this returns true, don't continue with startup, since this iframe will be shortly disposed.
+     * @param silentRedirectRoute The app relative path used for silent sign in callbacks.
+     */
+    OidcAuthService.isSilentSignIn = function (silentRedirectRoute) {
+        var config = Misc.Globals.appService.get(NeoTypes.Config.ConfigModel);
+        var silentRedirectUri = "".concat(window.location.origin).concat(config.baseUrl).concat(silentRedirectRoute);
+        if (window.location.href.startsWith(silentRedirectUri)) {
+            Misc.Globals.appService.get(NeoTypes.Security.AuthenticationService).endSignInSilent();
+            return true;
+        }
+        return false;
+    };
     __decorate([
         Observable(),
         __metadata("design:type", Object)

package/dist/Security/Oidc/OidcTypes.d.ts

@@ -1,26 +1,43 @@
 export interface IOidcUser {
-    id_token: string;
+    /**
+     * A JSON Web Token (JWT). Only provided if `openid` scope was requested.
+     * The application can access the data decoded by using the `profile` property.
+     */
+    id_token?: string;
+    /** Typically "Bearer" */
     token_type: string;
+    /**
+     * The requested access token returned from the OIDC provider. The application can use this token to
+     * authenticate itself to the secured resource.
+     */
     access_token: string;
+    /** The scopes that the requested access token is valid for. */
+    scope?: string;
     profile: any;
-    expires_at: number;
+    expires_at?: number;
     /** State passed to IDS which is returned to us. */
     state: any;
     readonly expired: boolean | undefined;
 }
 export interface IUserManager {
     events: IUserManagerEvents;
+    settings: IUserManagerSettings;
     signinRedirect(args?: any): Promise<any>;
     signinRedirectCallback(url?: string): Promise<IOidcUser>;
     signoutRedirect(args?: any): Promise<any>;
     signoutRedirectCallback(url?: string): Promise<any>;
-    signinSilent(args?: any): Promise<IOidcUser>;
+    signinSilent(args?: any): Promise<IOidcUser | null>;
     signinSilentCallback(url?: string): Promise<any>;
     clearStaleState(): Promise<void>;
     getUser(): Promise<IOidcUser | null>;
-    createSigninRequest(args?: any): Promise<{
-        url: string;
-    }>;
+}
+export interface IUserManagerSettings {
+    /** The redirect URI of your client application to receive a response from the OIDC/OAuth2 provider */
+    redirect_uri?: string;
+    /** Flag to indicate if there should be an automatic attempt to renew the access token prior to its expiration */
+    automaticSilentRenew?: boolean;
+    /** The URL for the page containing the code handling the silent renew */
+    silent_redirect_uri?: string;
 }
 export interface IUserManagerEvents {
     addUserLoaded(callback: (...ev: any[]) => void): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@singularsystems/neo-core",
-  "version": "0.10.66",
+  "version": "0.10.67",
   "description": "Core functionality for the Neo client library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",