@jetbrains/ring-ui-built 6.0.1

package/components/auth/request-builder.js

@@ -0,0 +1,104 @@
+import { _ as _defineProperty, d as _createClass, c as _classCallCheck, h as _asyncToGenerator, i as _regeneratorRuntime } from '../_helpers/_rollupPluginBabelHelpers.js';
+import 'core-js/modules/es.array.map.js';
+import 'core-js/modules/es.object.assign.js';
+import uuid from 'simply-uuid';
+import { encodeURL } from '../global/url.js';
+import 'core-js/modules/es.array.concat.js';
+import 'core-js/modules/es.regexp.exec.js';
+import 'core-js/modules/es.string.match.js';
+import 'core-js/modules/es.array.index-of.js';
+import 'core-js/modules/es.string.replace.js';
+
+var AuthRequestBuilder = /*#__PURE__*/function () {
+  /**
+   * @param {{
+   *   authorization: string,
+   *   redirectUri: string?,
+   *   requestCredentials: string?,
+   *   clientId: string?,
+   *   scopes: string[]
+   * }} config
+   * @param {AuthStorage} storage
+   */
+  function AuthRequestBuilder(config, storage) {
+    _classCallCheck(this, AuthRequestBuilder);
+    _defineProperty(this, "config", void 0);
+    _defineProperty(this, "storage", void 0);
+    this.config = config;
+    this.storage = storage;
+  }
+  /**
+   * @return {string} random string used for state
+   */
+  _createClass(AuthRequestBuilder, [{
+    key: "prepareAuthRequest",
+    value: (
+    /**
+     * Save state and build an auth server redirect URL.
+     *
+     * @param {object=} extraParams additional query parameters for auth request
+     * @param {object=} extraState additional state parameters to save
+     * @return {Promise.<string>} promise that is resolved to authURL
+     */
+    function () {
+      var _prepareAuthRequest = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(extraParams, extraState) {
+        var stateId, scopes, request, authURL, state;
+        return _regeneratorRuntime().wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              stateId = AuthRequestBuilder._uuid();
+              scopes = this.config.scopes.map(function (scope) {
+                return encodeURIComponent(scope);
+              });
+              /* eslint-disable camelcase */
+              request = Object.assign({
+                response_type: 'token',
+                state: stateId,
+                redirect_uri: this.config.redirectUri,
+                request_credentials: this.config.requestCredentials,
+                client_id: this.config.clientId,
+                scope: scopes.join(' ')
+              }, extraParams || {});
+              /* eslint-enable camelcase */
+              authURL = encodeURL(this.config.authorization, request);
+              state = Object.assign({
+                restoreLocation: window.location.href,
+                scopes: this.config.scopes
+              }, extraState || {});
+              _context.next = 7;
+              return this._saveState(stateId, state);
+            case 7:
+              return _context.abrupt("return", {
+                url: authURL,
+                stateId
+              });
+            case 8:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function prepareAuthRequest(_x, _x2) {
+        return _prepareAuthRequest.apply(this, arguments);
+      }
+      return prepareAuthRequest;
+    }()
+    /**
+     * @param {string} id
+     * @param {StoredState} storedState
+     * @return {Promise}
+     * @private
+     */
+    )
+  }, {
+    key: "_saveState",
+    value: function _saveState(id, storedState) {
+      var _this$storage;
+      return (_this$storage = this.storage) === null || _this$storage === void 0 ? void 0 : _this$storage.saveState(id, storedState);
+    }
+  }]);
+  return AuthRequestBuilder;
+}();
+_defineProperty(AuthRequestBuilder, "_uuid", uuid.generate);
+
+export { AuthRequestBuilder as default };

package/components/auth/response-parser.d.ts

@@ -0,0 +1,70 @@
+import ExtendableError from 'es6-error';
+export interface AuthResponse {
+    accessToken?: string;
+    state?: string;
+    token_type?: string;
+    expiresIn?: string;
+    scope?: string;
+    error?: string | Error;
+    errorDescription?: string;
+    errorUri?: string;
+    restoreAuthState?: string;
+}
+export declare class AuthError extends ExtendableError {
+    code: string | Error | AuthError | undefined;
+    uri: string | undefined;
+    stateId: string | undefined;
+    constructor(authResponse?: AuthResponse);
+}
+/**
+ * @typedef {Object} AuthResponse
+ * @property {?string} accessToken
+ * @property {?string} state
+ * @property {?string} token_type
+ * @property {?string} expiresIn
+ * @property {?string} scope
+ * @property {?string} error
+ */
+export default class AuthResponseParser {
+    readonly _authResponse: AuthResponse;
+    constructor();
+    static AuthError: typeof AuthError;
+    static convertKey(key: string): string;
+    /**
+     * Check if the hash contains an access token.
+     * If it does, return auth response. Otherwise return undefined.
+     * Always clears the hash part of the URL.
+     *
+     * @throws {Error} if the auth server returned an error
+     * @return {?AuthResponse}
+     */
+    getAuthResponseFromURL(): AuthResponse | null;
+    /**
+     * Validates given authResponse.
+     * If it contains a token - returns the token, if an error is found - throws the error,
+     * otherwise - null
+     * Always clears the hash part of the URL.
+     *
+     * @param authResponse {AuthResponse} parsed authResponse
+     * @throws {Error} if the auth server returned an error
+     * @return {?AuthResponse}
+     */
+    validateAuthResponse(authResponse: AuthResponse): AuthResponse | null;
+    /**
+     * Reads the current accessToken from the URL.
+     * Doesn't modify URL
+     *
+     * @return {AuthResponse}
+     */
+    readAuthResponseFromURL(): AuthResponse;
+    /**
+     * @return {string} part of the URL after # sign.
+     * @private
+     */
+    getHash(): string | null;
+    /**
+     * Current page location.
+     * @return {string}
+     */
+    getLocation(): string | null;
+}

package/components/auth/response-parser.js

@@ -0,0 +1,138 @@
+import { _ as _defineProperty, a as _inherits, b as _createSuper, c as _classCallCheck, k as _assertThisInitialized, d as _createClass, g as _objectSpread2 } from '../_helpers/_rollupPluginBabelHelpers.js';
+import 'core-js/modules/es.object.to-string.js';
+import 'core-js/modules/web.dom-collections.for-each.js';
+import 'core-js/modules/es.array.index-of.js';
+import 'core-js/modules/es.regexp.exec.js';
+import 'core-js/modules/es.string.replace.js';
+import 'core-js/modules/es.regexp.to-string.js';
+import ExtendableError from 'es6-error';
+import { parseQueryString } from '../global/url.js';
+import 'core-js/modules/es.array.concat.js';
+import 'core-js/modules/es.string.match.js';
+
+var AuthError = /*#__PURE__*/function (_ExtendableError) {
+  _inherits(AuthError, _ExtendableError);
+  var _super = _createSuper(AuthError);
+  // Supports weird IE 11 failing test issue
+  function AuthError() {
+    var _this;
+    var authResponse = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    _classCallCheck(this, AuthError);
+    _this = _super.call(this, authResponse.errorDescription);
+    _defineProperty(_assertThisInitialized(_this), "code", void 0);
+    _defineProperty(_assertThisInitialized(_this), "uri", void 0);
+    _defineProperty(_assertThisInitialized(_this), "stateId", void 0);
+    _this.code = authResponse.error;
+    _this.uri = authResponse.errorUri;
+    _this.stateId = authResponse.state;
+    return _this;
+  }
+  return _createClass(AuthError);
+}(ExtendableError);
+/**
+ * @typedef {Object} AuthResponse
+ * @property {?string} accessToken
+ * @property {?string} state
+ * @property {?string} token_type
+ * @property {?string} expiresIn
+ * @property {?string} scope
+ * @property {?string} error
+ */
+var AuthResponseParser = /*#__PURE__*/function () {
+  function AuthResponseParser() {
+    _classCallCheck(this, AuthResponseParser);
+    _defineProperty(this, "_authResponse", void 0);
+    this._authResponse = this.readAuthResponseFromURL();
+  }
+  _createClass(AuthResponseParser, [{
+    key: "getAuthResponseFromURL",
+    value:
+    /**
+     * Check if the hash contains an access token.
+     * If it does, return auth response. Otherwise return undefined.
+     * Always clears the hash part of the URL.
+     *
+     * @throws {Error} if the auth server returned an error
+     * @return {?AuthResponse}
+     */
+    function getAuthResponseFromURL() {
+      return this.validateAuthResponse(this._authResponse);
+    }
+    /**
+     * Validates given authResponse.
+     * If it contains a token - returns the token, if an error is found - throws the error,
+     * otherwise - null
+     * Always clears the hash part of the URL.
+     *
+     * @param authResponse {AuthResponse} parsed authResponse
+     * @throws {Error} if the auth server returned an error
+     * @return {?AuthResponse}
+     */
+  }, {
+    key: "validateAuthResponse",
+    value: function validateAuthResponse(authResponse) {
+      // Check for errors
+      if (authResponse.error) {
+        throw new AuthResponseParser.AuthError(authResponse);
+      }
+      // If there is no token in the hash
+      if (!authResponse.accessToken) {
+        return null;
+      }
+      return _objectSpread2(_objectSpread2({}, authResponse), {}, {
+        accessToken: authResponse.accessToken
+      });
+    }
+    /**
+     * Reads the current accessToken from the URL.
+     * Doesn't modify URL
+     *
+     * @return {AuthResponse}
+     */
+  }, {
+    key: "readAuthResponseFromURL",
+    value: function readAuthResponseFromURL() {
+      var authResponse = {};
+      var rawAuthResponse = parseQueryString(this.getHash());
+      Object.keys(rawAuthResponse).forEach(function (key) {
+        if (key.indexOf('_') !== -1) {
+          authResponse[AuthResponseParser.convertKey(key)] = rawAuthResponse[key];
+          return;
+        }
+        authResponse[key] = rawAuthResponse[key];
+      });
+      return authResponse;
+    }
+    /**
+     * @return {string} part of the URL after # sign.
+     * @private
+     */
+  }, {
+    key: "getHash",
+    value: function getHash() {
+      // Because of stupid Firefox bug — https://bugzilla.mozilla.org/show_bug.cgi?id=483304
+      var location = this.getLocation();
+      return location && location.replace(/^[^#]*#?/, '');
+    }
+    /**
+     * Current page location.
+     * @return {string}
+     */
+  }, {
+    key: "getLocation",
+    value: function getLocation() {
+      return window.location.toString();
+    }
+  }], [{
+    key: "convertKey",
+    value: function convertKey(key) {
+      return key.replace(/_([a-z])/g, function (_, letter) {
+        return letter.toUpperCase();
+      });
+    }
+  }]);
+  return AuthResponseParser;
+}();
+_defineProperty(AuthResponseParser, "AuthError", AuthError);
+
+export { AuthError, AuthResponseParser as default };

package/components/auth/storage.d.ts

@@ -0,0 +1,112 @@
+import { StorageClass, StorageInterface } from '../storage/storage';
+import { AuthUser } from './auth__core';
+import { AuthResponse } from './response-parser';
+export interface StoredToken {
+    accessToken: string;
+    scopes?: string[];
+    expires?: number;
+    lifeTime?: number;
+    waitForRedirectTimeout?: number;
+}
+export interface AuthState extends AuthResponse {
+    restoreLocation?: string;
+    scopes?: string[];
+    nonRedirect?: boolean | null | undefined;
+    created?: number;
+}
+export interface AuthStorageConfig {
+    stateKeyPrefix?: string | null | undefined;
+    tokenKey?: string | null | undefined;
+    messagePrefix?: string | null | undefined;
+    userKey?: string | null | undefined;
+    stateTTL?: number | null | undefined;
+    storage?: StorageClass | null | undefined;
+    stateQuota?: number | null | undefined;
+}
+export default class AuthStorage<M = unknown> {
+    messagePrefix: string;
+    stateKeyPrefix: string;
+    tokenKey: string;
+    userKey: string;
+    stateTTL: number;
+    stateQuota: number;
+    private _lastMessage;
+    _stateStorage: StorageInterface;
+    _tokenStorage: StorageInterface;
+    _messagesStorage: StorageInterface;
+    private _currentUserStorage;
+    /**
+     * Custom storage for Auth
+     * @param {{stateKeyPrefix: string, tokenKey: string, onTokenRemove: Function}} config
+     */
+    constructor(config: AuthStorageConfig);
+    /**
+     * Add token change listener
+     * @param {function(string)} fn Token change listener
+     * @return {function()} remove listener function
+     */
+    onTokenChange(fn: (token: StoredToken | null) => void): () => void;
+    /**
+     * Add state change listener
+     * @param {string} stateKey State key
+     * @param {function(string)} fn State change listener
+     * @return {function()} remove listener function
+     */
+    onStateChange(stateKey: string, fn: (state: AuthState | null) => void): () => void;
+    /**
+     * Add state change listener
+     * @param {string} key State key
+     * @param {function(string)} fn State change listener
+     * @return {function()} remove listener function
+     */
+    onMessage(key: string, fn: (message: M | null) => void): () => void;
+    sendMessage(key: string, message?: M | null): void;
+    /**
+     * Save authentication request state.
+     *
+     * @param {string} id Unique state identifier
+     * @param {StoredState} state State to store
+     * @param {boolean=} dontCleanAndRetryOnFail If falsy then remove all stored states and try again to save state
+     */
+    saveState(id: string, state: AuthState, dontCleanAndRetryOnFail?: boolean): Promise<void>;
+    /**
+     * Remove all stored states
+     *
+     * @return {Promise} promise that is resolved when OLD states [and some selected] are removed
+     */
+    cleanStates(removeStateId?: string): Promise<0 | void[] | undefined>;
+    /**
+     * Get state by id and remove stored states from the storage.
+     *
+     * @param {string} id unique state identifier
+     * @return {Promise.<StoredState>}
+     */
+    getState(id: string): Promise<AuthState | null>;
+    /**
+     * @param {StoredToken} token
+     * @return {Promise} promise that is resolved when the token is saved
+     */
+    saveToken(token: StoredToken): Promise<StoredToken | null>;
+    /**
+     * @return {Promise.<StoredToken>} promise that is resolved to the stored token
+     */
+    getToken(): Promise<StoredToken | null>;
+    /**
+     * Remove stored token if any.
+     * @return {Promise} promise that is resolved when the token is wiped.
+     */
+    wipeToken(): Promise<void>;
+    /**
+     * @param {function} loadUser user loader
+     * @return {Promise.<object>>} promise that is resolved to stored current user
+     */
+    getCachedUser(loadUser: () => Promise<AuthUser | null>): Promise<AuthUser | null>;
+    /**
+     * Remove cached user if any
+     */
+    wipeCachedCurrentUser(): Promise<void>;
+    /**
+     * Wipes cache if user has changed
+     */
+    onUserChanged(): void;
+}