Merge pull request #4 from ChinthakaSenanayaka/dev

Added inline comments
ChinthakaSenanayaka · Jul 31, 2018 · d174172 · d174172
2 parents 306acfd + e7a7dd5
commit d174172
Show file tree

Hide file tree

Showing 6 changed files with 95 additions and 3 deletions.
diff --git a/built/pkce_code_verifier.d.ts b/built/pkce_code_verifier.d.ts
@@ -1,10 +1,26 @@
 /// <reference types="node" />
+/**
+ * class for PKCE code challenge and code verifier generation.
+ */
 export declare class CodeVerifier {
     challenge: string;
     method: string;
     verifier: string;
+    /**
+     * base64 encoding
+     *
+     * @param value text to encode
+     */
     private base64URLEncode;
+    /**
+     * Generate SHA256 code for given value
+     *
+     * @param value text to generate SHA256 code
+     */
     static sha256(value: string): Buffer;
+    /**
+     * Get PKCE code verifier code.
+     */
     private getVerifier;
     constructor();
 }
diff --git a/built/pkce_code_verifier.js b/built/pkce_code_verifier.js
diff --git a/built/pkce_token_requestor.d.ts b/built/pkce_token_requestor.d.ts
@@ -5,13 +5,28 @@ import { CodeVerifier } from './pkce_code_verifier';
 import { StorageBackend } from './storage';
 import { TokenRequest } from './token_request';
 import { TokenRequestHandler } from './token_request_handler';
+/**
+ * Handler class for PKCE related request handling.
+ */
 export declare class PKCETokenRequestHandler {
     verifier: CodeVerifier;
     authorizationHandler: AuthorizationRequestHandler;
     tokenHandler: TokenRequestHandler;
     configuration: AuthorizationServiceConfiguration;
     storageBackend: StorageBackend;
     constructor(authorizationHandler: AuthorizationRequestHandler, configuration: AuthorizationServiceConfiguration, storageBackend?: StorageBackend);
+    /**
+     * Perform PKCE authrization request
+     *
+     * @param configuration request configs
+     * @param request auth request
+     */
     performPKCEAuthorizationCodeRequest(configuration: AuthorizationServiceConfiguration, request: AuthorizationRequest): void;
+    /**
+     * Perform PKCE authrization token request
+     *
+     * @param configuration request configs
+     * @param request token request
+     */
     performPKCEAuthorizationTokenRequest(configuration: AuthorizationServiceConfiguration, request: TokenRequest): void;
 }