Merge pull request #8533 from KaiWalter/master

new definition for cordova-plugin-ms-adal

cordova-plugin-ms-adal/cordova-plugin-ms-adal-tests.ts

@@ -0,0 +1,47 @@
+/// <reference path="./cordova-plugin-ms-adal.d.ts"/>
+
+function test_cordova_plugin_ms_adal() {
+
+    var testConfiguration = {
+        authority: 'https://login.microsoftonline.com/testtenant.onmicrosoft.com',
+        resourceUrl: 'https://graph.windows.net/',
+        clientId: '12345678-1234-1234-1234-123456789abc',
+        redirectUrl: 'http://app.testtenant.onmicrosoft.com'
+    };
+
+    // create AuthenticationContext
+    Microsoft.ADAL.AuthenticationContext.createAsync(testConfiguration.authority)
+        .then((context) => {
+
+            context.tokenCache.readItems().then((cacheItems) => {
+                if (cacheItems.length >= 1) {
+                    var testUserId: string;
+                    testUserId = cacheItems[0].userInfo.userId;
+
+                    context.acquireTokenSilentAsync(testConfiguration.resourceUrl, testConfiguration.clientId, testUserId).then((authResult) => {
+                        console.log("Silently acquired token successfully");
+                    }, (err) => {
+                        console.log("Failed to acquire token silently " + JSON.stringify(err));
+                    });
+                }
+                else {
+
+                    context.acquireTokenAsync(testConfiguration.resourceUrl, testConfiguration.clientId, testConfiguration.redirectUrl)
+                        .then((authResult) => {
+                            console.log("Acquired token successfully");
+                        }, (err) => {
+                            console.log("Failed to acquire token " + JSON.stringify(err));
+                        });
+                }
+            });
+            
+            // clear TokenCache
+            context.tokenCache.clear();
+
+        }, (message) => {
+            console.log(message);
+        });
+
+
+}
+

cordova-plugin-ms-adal/cordova-plugin-ms-adal.d.ts

@@ -0,0 +1,161 @@
+// Type definitions for Active Directory Authentication Library plugin for Apache Cordova
+// Project: https://github.com/AzureAD/azure-activedirectory-library-for-cordova
+// Definitions by: Kai Walter <https://github.com/KaiWalter>
+// Definitions: https://github.com/KaiWalter/DefinitelyTyped
+
+declare namespace Microsoft {
+
+    namespace ADAL {
+
+        interface UserInfo {
+            displayableId: string,
+            userId: string,
+            familyName: string,
+            givenName: string,
+            identityProvider: string,
+            passwordChangeUrl: string,
+            passwordExpiresOn: Date,
+            uniqueId: string,
+        }
+
+        interface TokenCacheItem {
+            accessToken: string,
+            authority: string,
+            clientId: string,
+            displayableId: string,
+            expiresOn: Date,
+            isMultipleResourceRefreshToken: boolean,
+            resource: string,
+            tenantId: string,
+            userInfo: UserInfo
+        }
+
+        interface Promise {
+            then(doneCallBack: () => any, failCallBack?: (message: string) => any):any;
+        }
+
+        interface PromiseTokenCacheItems {
+            then(doneCallBack: (tokenCacheItems: TokenCacheItem[]) => any, failCallBack?: (message: string) => any):any;
+        }
+
+        class TokenCache {
+            contextAuthority: string
+
+            /**
+            * Clears the cache by deleting all the items.
+            *
+            * @returns {Promise} Promise either fulfilled when operation is completed or rejected with error.
+            */
+            clear(): Promise;
+
+            /**
+            * Gets all cached items.
+            *
+            * @returns {Promise} Promise either fulfilled with array of cached items or rejected with error.
+            */
+            readItems(): PromiseTokenCacheItems;
+
+            /**
+            * Deletes cached item.
+            *
+            * @param   {TokenCacheItem}  item Cached item to delete from cache
+            *
+            * @returns {Promise} Promise either fulfilled when operation is completed or rejected with error.
+            */
+            deleteItem(item: TokenCacheItem): Promise;
+        }
+
+        class AuthenticationResult {
+            accessToken: string;
+            accessTokenType: string;
+            expiresOn: Date;
+            idToken: string;
+            isMultipleResourceRefreshToken: boolean;
+            status: string;
+            statusCode: string;
+            tenantId: string;
+            userInfo: UserInfo;
+
+            /**
+            * Creates authorization header for web requests.
+            *
+            * @returns {String} The authorization header.
+            */
+            createAuthorizationHeader(): string;
+        }
+
+        interface PromiseAuthenticationResult {
+            then(doneCallBack: (context: AuthenticationResult) => any, failCallBack?: (message: string) => any):any;
+        }
+
+        interface PromiseAuthenticationContext {
+            then(doneCallBack: (context: AuthenticationContext) => any, failCallBack?: (message: string) => any):any;
+        }
+
+        class AuthenticationContext {
+            authority: string;
+            validateAuthority: boolean;
+            tokenCache: TokenCache;
+
+            /**
+            * Constructs context to use with known authority to get the token. It reuses existing context
+            * for this authority URL in native proxy or creates a new one if it doesn't exists.
+            * Corresponding native context will be created at first time when it will be needed.
+            *
+            * @param   {String}  authority         Authority url to send code and token requests
+            * @param   {Boolean} validateAuthority Validate authority before sending token request
+            *                                      When context is being created syncronously using this constructor
+            *                                      validateAuthority in native context will be disabled to prevent
+            *                                      context initialization failure
+            *
+            * @returns {Object}  Newly created authentication context.
+            */
+            constructor(authority: string, validateAuthority?: boolean);
+
+            /**
+            * Constructs context asynchronously to use with known authority to get the token.
+            * It reuses existing context for this authority URL in native proxy or creates a new one if it doesn't exists.
+            *
+            * @param   {String}   authority         Authority url to send code and token requests
+            * @param   {Boolean}  validateAuthority Validate authority before sending token request. True by default
+            *
+            * @returns {Promise}  Promise either fulfilled with newly created authentication context or rejected with error
+            */
+            static createAsync(authority: string, validateAuthority?: boolean): PromiseAuthenticationContext;
+
+            /**
+            * Acquires token using interactive flow if needed. It checks the cache to return existing result
+            * if not expired. It tries to use refresh token if available. If it fails to get token with
+            * refresh token, it will remove this refresh token from cache and start authentication.
+            *
+            * @param   {String}  resourceUrl Resource identifier
+            * @param   {String}  clientId    Client (application) identifier
+            * @param   {String}  redirectUrl Redirect url for this application
+            * @param   {String}  userId      User identifier (optional)
+            * @param   {String}  extraQueryParameters
+            *                                Extra query parameters (optional)
+            *                                Parameters should be escaped before passing to this method (e.g. using 'encodeURI()')
+            *
+            * @returns {Promise} Promise either fulfilled with AuthenticationResult object or rejected with error
+            */
+            acquireTokenAsync(resourceUrl: string, clientId: string, redirectUrl: string, userId?: string, extraQueryParameters?: string): PromiseAuthenticationResult;
+
+            /**
+             * Acquires token WITHOUT using interactive flow. It checks the cache to return existing result
+             * if not expired. It tries to use refresh token if available. If it fails to get token without
+             * displaying UI it will fail. This method guarantees that no UI will be shown to user.
+             *
+             * @param   {String}  resourceUrl Resource identifier
+             * @param   {String}  clientId    Client (application) identifier
+             * @param   {String}  userId      User identifier (optional)
+             *
+             * @returns {Promise} Promise either fulfilled with AuthenticationResult object or rejected with error
+             */
+            acquireTokenSilentAsync(resourceUrl: string, clientId: string, userId: string): PromiseAuthenticationResult;
+
+        }
+    }
+}
+
+
+