1.5.0 (#233)

1.5.0

Author: eromano

.npmignore

@@ -17,6 +17,5 @@
 *.DS_Store
 /package/
 /webpack-bundle-test.js
-/webpack.config.js
 /.github/
 /.babelrc

CHANGELOG.md

@@ -2,7 +2,12 @@
   <img title="alfresco" alt='alfresco' src='assets/alfresco.png'  width="280px" height="150px"></img>
 </p>
 
-Alfresco JS API
+# Alfresco JS API
+
+<a name="1.5.0"></a>
+# [1.5.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.5.0) (25-05-2017)
+## Features
+- [Ability to remember/forget username upon login/logout](https://github.com/Alfresco/alfresco-js-api/pull/225)
 
 <a name="1.4.0"></a>
 # [1.4.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.4.0) (27-04-2017)

index.d.ts

@@ -543,6 +543,7 @@ declare namespace AlfrescoApi {
     export interface AuthApi {
         new(config: AlfrescoApiConfig): AuthApi;
 
+        username: string;
         changeHost(host: string): void;
         login(username: string, password: string): Promise<string>;
         logout(): Promise<string>;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "alfresco-js-api",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "JavaScript client library for the Alfresco REST API",
   "author": "Alfresco Software, Ltd.",
   "main": "main.js",
@@ -17,7 +17,8 @@
     "generate": "mvn clean generate-sources",
     "watchify": "watchify -s AlfrescoApi main.js -o dist/alfresco-js-api.js",
     "tslint": "tslint -c tslint.json index.d.ts",
-    "toc": "markdown-toc -i README.md && markdown-toc -i test/mockObjects/README.md"
+    "toc": "markdown-toc -i README.md && markdown-toc -i test/mockObjects/README.md",
+    "prepublish" : "npm run webpack"
   },
   "repository": {
     "type": "git",

src/alfrescoApi.js

@@ -81,6 +81,18 @@ class AlfrescoApi {
             this.invalidateSession();
         });
 
+        this.ecmClient.on('unauthorized', ()=> {
+            this.invalidateSession();
+        });
+
+        this.ecmPrivateClient.on('unauthorized', ()=> {
+            this.invalidateSession();
+        });
+
+        this.bpmClient.on('unauthorized', ()=> {
+            this.invalidateSession();
+        });
+
         if (this.config.provider === 'OAUTH') {
             this.oauth2Auth = new Oauth2Auth(this.config);
             this.setAuthenticationClientECMBPM(this.oauth2Auth.getAuthentication(), this.oauth2Auth.getAuthentication());

src/bpmAuth.js

@@ -10,6 +10,8 @@ class BpmAuth extends AlfrescoApiClient {
      */
     constructor(config) {
         super();
+
+        this.username = '';
         this.config = config;
         this.ticket = undefined;
 
@@ -43,6 +45,7 @@ class BpmAuth extends AlfrescoApiClient {
      * @returns {Promise} A promise that returns {new authentication ticket} if resolved and {error} if rejected.
      * */
     login(username, password) {
+        this.username = username;
         this.authentications.basicAuth.username = username;
         this.authentications.basicAuth.password = password;
 
@@ -98,6 +101,7 @@ class BpmAuth extends AlfrescoApiClient {
      * @returns {Promise} A promise that returns {new authentication ticket} if resolved and {error} if rejected.
      * */
     logout() {
+        this.username = '';
         var postBody = {}, pathParams = {}, queryParams = {}, headerParams = {}, formParams = {};
 
         var authNames = [];

src/ecmAuth.js

@@ -12,6 +12,7 @@ class EcmAuth extends AlfrescoApiClient {
     constructor(config) {
         super();
 
+        this.username = '';
         this.config = config;
 
         this.basePath = this.config.hostEcm + '/' + this.config.contextRoot + '/api/-default-/public/authentication/versions/1'; //Auth Call
@@ -36,6 +37,7 @@ class EcmAuth extends AlfrescoApiClient {
      * @returns {Promise} A promise that returns {new authentication ticket} if resolved and {error} if rejected.
      * */
     login(username, password) {
+        this.username = username;
         this.authentications.basicAuth.username = username;
         this.authentications.basicAuth.password = password;
 
@@ -104,6 +106,7 @@ class EcmAuth extends AlfrescoApiClient {
      * @returns {Promise} A promise that returns { authentication ticket} if resolved and {error} if rejected.
      * */
     logout() {
+        this.username = '';
         var authApi = new AlfrescoAuthRestApi.AuthenticationApi(this);
 
         this.promise = new Promise((resolve, reject) => {

test/bpmAuth.spec.js

@@ -12,6 +12,22 @@ describe('Bpm Auth test', function () {
         this.authBpmMock = new AuthBpmMock(this.hostBpm);
     });
 
+    it('should remember username on login', () => {
+        const auth = new BpmAuth({});
+        auth.login('johndoe', 'password');
+        expect(auth.username).to.be.equal('johndoe');
+    });
+
+    it('should forget username on logout', () => {
+        const auth = new BpmAuth({});
+
+        auth.login('johndoe', 'password');
+        expect(auth.username).to.be.equal('johndoe');
+
+        auth.logout();
+        expect(auth.username).to.be.equal('');
+    });
+
     describe('With Authentication', function () {
 
         it('login should return the Ticket if all is ok', function (done) {

test/ecmAuth.spec.js

@@ -11,6 +11,22 @@ describe('Ecm Auth test', function () {
         this.authEcmMock = new AuthEcmMock(this.hostEcm);
     });
 
+    it('should remember username on login', () => {
+        const auth = new EcmAuth({});
+        auth.login('johndoe', 'password');
+        expect(auth.username).to.be.equal('johndoe');
+    });
+
+    it('should forget username on logout', () => {
+        const auth = new EcmAuth({});
+
+        auth.login('johndoe', 'password');
+        expect(auth.username).to.be.equal('johndoe');
+
+        auth.logout();
+        expect(auth.username).to.be.equal('');
+    });
+
     describe('With Authentication', function () {
 
         it('login should return the Ticket if all is ok', function (done) {