@angular-wave/angular.ts 0.5.0 → 0.6.0

package/src/router/url/url-service.js

@@ -21,6 +21,9 @@ export class UrlService {
 
   /**
    * @param {import("../../core/location/location").LocationProvider} $locationProvider
+   * @param {import("../../router/state/state-service.js").StateProvider} stateService
+   * @param globals
+   * @param {import("../../router/url/url-config.js").UrlConfigProvider} urlConfigProvider
    */
   constructor($locationProvider, stateService, globals, urlConfigProvider) {
     this.stateService = stateService;
@@ -30,9 +33,6 @@ export class UrlService {
     this.$location = undefined;
     this.$browser = undefined;
 
-    /** @type {boolean} */
-    this.interceptDeferred = false;
-
     /** Provides services related to the URL */
     this.urlRuleFactory = new UrlRuleFactory(this, this.stateService, globals);
 
@@ -91,7 +91,7 @@ export class UrlService {
      * @param {import('../../core/location/location').Location} $location
      * @param {import('../../services/browser').Browser} $browser
      * @param {import('../../core/scope/scope').Scope} $rootScope
-     * @returns
+     * @returns {UrlService}
      */
     ($location, $browser, $rootScope) => {
       this.$location = $location;
@@ -104,10 +104,14 @@ export class UrlService {
     },
   ];
 
+  /**
+   * @returns {boolean}
+   */
   html5Mode() {
-    let html5Mode = this.$locationProvider.html5Mode();
-    html5Mode = isObject(html5Mode) ? html5Mode.enabled : html5Mode;
-    return html5Mode && typeof history !== "undefined";
+    return (
+      this.$locationProvider.getHtml5Mode().enabled &&
+      typeof history !== "undefined"
+    );
   }
 
   baseHref() {
@@ -214,7 +218,6 @@ export class UrlService {
    *
    * #### Example:
    * ```js
-   * urlService.deferIntercept();
    *
    * fetch('/states.json').then(resp => resp.json()).then(data => {
    *   data.forEach(state => $stateRegistry.register(state));
@@ -261,7 +264,6 @@ export class UrlService {
    *
    * #### Example:
    * ```js
-   * urlService.deferIntercept();
    *
    * fetch('/states.json').then(resp => resp.json()).then(data => {
    *   data.forEach(state => $stateRegistry.register(state));
@@ -282,34 +284,7 @@ export class UrlService {
         this._stopListeningFn || this.onChange((evt) => this.sync(evt)));
     }
   }
-  /**
-   * Disables monitoring of the URL.
-   *
-   * Call this method before ng-router has bootstrapped.
-   * It will stop ng-router from performing the initial url sync.
-   *
-   * This can be useful to perform some asynchronous initialization before the router starts.
-   * Once the initialization is complete, call [[listen]] to tell ng-router to start watching and synchronizing the URL.
-   *
-   * #### Example:
-   * ```js
-   * // Prevent ng-router from automatically intercepting URL changes when it starts;
-   * urlService.deferIntercept();
-   *
-   * fetch('/states.json').then(resp => resp.json()).then(data => {
-   *   data.forEach(state => $stateRegistry.register(state));
-   *   urlService.listen();
-   *   urlService.sync();
-   * });
-   * ```
-   *
-   * @param defer Indicates whether to defer location change interception.
-   *        Passing no parameter is equivalent to `true`.
-   */
-  deferIntercept(defer) {
-    if (defer === undefined) defer = true;
-    this.interceptDeferred = defer;
-  }
+
   /**
    * Matches a URL
    *
@@ -394,7 +369,7 @@ export class UrlService {
     options = options || { absolute: false };
     const isHtml5 = this.html5Mode();
     if (!isHtml5 && url !== null) {
-      url = "#" + this.$locationProvider.hashPrefix() + url;
+      url = "#" + this.$locationProvider.getHashPrefix() + url;
     }
     url = appendBasePath(url, isHtml5, options.absolute, this.baseHref());
     if (!options.absolute || !url) {

package/types/core/location/location.d.ts

@@ -244,39 +244,33 @@ export class LocationHashbangUrl extends Location {
     $$parseLinkUrl(url: string): boolean;
 }
 export class LocationProvider {
-    hashPrefixValue: string;
-    html5ModeConfig: {
-        enabled: boolean;
-        requireBase: boolean;
-        rewriteLinks: boolean;
-    };
+    /** @type {string} */
+    hashPrefixConf: string;
+    /** @type {Html5Mode} */
+    html5ModeConf: Html5Mode;
     /**
      * The default value for the prefix is `'!'`.
-     * @param {string=} prefix - Prefix for hash part (containing path and search)
-     * @returns {string|LocationProvider} current value if used as getter or itself (chaining) if used as setter
-     */
-    hashPrefix(prefix?: string | undefined): string | LocationProvider;
-    /**
-     * @param {(boolean|Object)=} mode If boolean, sets `html5Mode.enabled` to value.
-     *   If object, sets `enabled`, `requireBase` and `rewriteLinks` to respective values. Supported
-     *   properties:
-     *   - **enabled** – `{boolean}` – (default: false) If true, will rely on `history.pushState` to
-     *     change urls where supported. Will fall back to hash-prefixed paths in browsers that do not
-     *     support `pushState`.
-     *   - **requireBase** - `{boolean}` - (default: `true`) When html5Mode is enabled, specifies
-     *     whether or not a <base> tag is required to be present. If `enabled` and `requireBase` are
-     *     true, and a base tag is not present, an error will be thrown when `$location` is injected.
-     *     See the {@link guide/$location $location guide for more information}
-     *   - **rewriteLinks** - `{boolean|string}` - (default: `true`) When html5Mode is enabled,
-     *     enables/disables URL rewriting for relative links. If set to a string, URL rewriting will
-     *     only happen on links with an attribute that matches the given string. For example, if set
-     *     to `'internal-link'`, then the URL will only be rewritten for `<a internal-link>` links.
-     *     Note that [attribute name normalization](guide/directive#normalization) does not apply
-     *     here, so `'internalLink'` will **not** match `'internal-link'`.
+     * @param {string=} prefix Prefix for hash part (containing path and search)
+     * @returns {void}
+     */
+    setHashPrefix(prefix?: string | undefined): void;
+    /**
+     * Current hash prefix
+     * @returns {string}
+     */
+    getHashPrefix(): string;
+    /**
+     * Configures html5 mode
+     * @param {(boolean|Html5Mode)=} mode If boolean, sets `html5Mode.enabled` to value. Otherwise, accepts html5Mode object
      *
-     * @returns {Object} html5Mode object if used as getter or itself (chaining) if used as setter
+     * @returns {void}
+     */
+    setHtml5Mode(mode?: (boolean | Html5Mode) | undefined): void;
+    /**
+     * Returns html5 mode cofiguration
+     * @returns {Html5Mode}
      */
-    html5Mode(mode?: (boolean | any) | undefined): any;
+    getHtml5Mode(): Html5Mode;
     $get: (string | (($rootScope: import("../scope/scope").Scope, $browser: import("../../services/browser").Browser, $rootElement: JQLite) => Location))[];
 }
 export type DefaultPorts = {
@@ -284,9 +278,30 @@ export type DefaultPorts = {
     https: number;
     ftp: number;
 };
+/**
+ * Represents the configuration options for HTML5 mode.
+ */
 export type Html5Mode = {
+    /**
+     * - (default: false) If true, will rely on `history.pushState` to
+     * change URLs where supported. Falls back to hash-prefixed paths in browsers that do not
+     * support `pushState`.
+     */
     enabled: boolean;
+    /**
+     * - (default: `true`) When html5Mode is enabled, specifies
+     * whether or not a `<base>` tag is required to be present. If both `enabled` and `requireBase`
+     * are true, and a `<base>` tag is not present, an error will be thrown when `$location` is injected.
+     * See the {@link guide /$location $location guide} for more information.
+     */
     requireBase: boolean;
+    /**
+     * - (default: `true`) When html5Mode is enabled, enables or
+     * disables URL rewriting for relative links. If set to a string, URL rewriting will only apply to links
+     * with an attribute that matches the given string. For example, if set to `'internal-link'`, URL rewriting
+     * will only occur for `<a internal-link>` links. Note that [attribute name normalization](guide/directive#normalization)
+     * does not apply here, so `'internalLink'` will **not** match `'internal-link'`.
+     */
     rewriteLinks: boolean | string;
 };
 import { JQLite } from "../../shared/jqlite/jqlite";

package/types/directive/observe/observe.d.ts

@@ -1,4 +1,6 @@
 /**
- * @returns {import("../../types").Directive}
+ * @param {string} source - the name of the attribute to be observed
+ * @param {string} prop - the scope property to be updated with attribute value
+ * @returns {import("../../types.js").Directive}
  */
-export function ngObserveDirective(): import("../../types").Directive;
+export function ngObserveDirective(source: string, prop: string): import("../../types.js").Directive;

package/types/router/url/url-service.d.ts

@@ -5,14 +5,15 @@ export class UrlService {
     static $inject: string[];
     /**
      * @param {import("../../core/location/location").LocationProvider} $locationProvider
+     * @param {import("../../router/state/state-service.js").StateProvider} stateService
+     * @param globals
+     * @param {import("../../router/url/url-config.js").UrlConfigProvider} urlConfigProvider
      */
-    constructor($locationProvider: import("../../core/location/location").LocationProvider, stateService: any, globals: any, urlConfigProvider: any);
-    stateService: any;
+    constructor($locationProvider: import("../../core/location/location").LocationProvider, stateService: import("../../router/state/state-service.js").StateProvider, globals: any, urlConfigProvider: import("../../router/url/url-config.js").UrlConfigProvider);
+    stateService: import("../../router/state/state-service.js").StateProvider;
     $locationProvider: import("../../core/location/location").LocationProvider;
     $location: import("../../core/location/location").Location;
     $browser: import("../../services/browser").Browser;
-    /** @type {boolean} */
-    interceptDeferred: boolean;
     /** Provides services related to the URL */
     urlRuleFactory: UrlRuleFactory;
     /**
@@ -56,7 +57,10 @@ export class UrlService {
      */
     hash: () => string | import("../../core/location/location").Location;
     _urlListeners: any[];
-    $get: (string | (($location: import("../../core/location/location").Location, $browser: import("../../services/browser").Browser, $rootScope: import("../../core/scope/scope").Scope) => this))[];
+    $get: (string | (($location: import("../../core/location/location").Location, $browser: import("../../services/browser").Browser, $rootScope: import("../../core/scope/scope").Scope) => UrlService))[];
+    /**
+     * @returns {boolean}
+     */
     html5Mode(): boolean;
     baseHref(): string;
     _baseHref: string;
@@ -149,7 +153,6 @@ export class UrlService {
      *
      * #### Example:
      * ```js
-     * urlService.deferIntercept();
      *
      * fetch('/states.json').then(resp => resp.json()).then(data => {
      *   data.forEach(state => $stateRegistry.register(state));
@@ -170,7 +173,6 @@ export class UrlService {
      *
      * #### Example:
      * ```js
-     * urlService.deferIntercept();
      *
      * fetch('/states.json').then(resp => resp.json()).then(data => {
      *   data.forEach(state => $stateRegistry.register(state));
@@ -184,31 +186,6 @@ export class UrlService {
      */
     listen(enabled: any): any;
     _stopListeningFn: any;
-    /**
-     * Disables monitoring of the URL.
-     *
-     * Call this method before ng-router has bootstrapped.
-     * It will stop ng-router from performing the initial url sync.
-     *
-     * This can be useful to perform some asynchronous initialization before the router starts.
-     * Once the initialization is complete, call [[listen]] to tell ng-router to start watching and synchronizing the URL.
-     *
-     * #### Example:
-     * ```js
-     * // Prevent ng-router from automatically intercepting URL changes when it starts;
-     * urlService.deferIntercept();
-     *
-     * fetch('/states.json').then(resp => resp.json()).then(data => {
-     *   data.forEach(state => $stateRegistry.register(state));
-     *   urlService.listen();
-     *   urlService.sync();
-     * });
-     * ```
-     *
-     * @param defer Indicates whether to defer location change interception.
-     *        Passing no parameter is equivalent to `true`.
-     */
-    deferIntercept(defer: any): void;
     /**
      * Matches a URL
      *

package/src/core/cookie-reader.spec.js

@@ -1,98 +0,0 @@
-import { Angular } from "../loader";
-import { createInjector } from "./di/injector";
-
-describe("$$cookieReader", () => {
-  let $$cookieReader;
-  let document;
-
-  describe("with access to `document.cookie`", () => {
-    function deleteAllCookies() {
-      const cookies = document.cookie.split(";");
-      const path = window.location.pathname;
-
-      for (let i = 0; i < cookies.length; i++) {
-        const cookie = cookies[i];
-        const eqPos = cookie.indexOf("=");
-        const name = eqPos > -1 ? cookie.substring(0, eqPos) : cookie;
-        const parts = path.split("/");
-        while (parts.length) {
-          document.cookie = `${name}=;path=${parts.join("/") || "/"};expires=Thu, 01 Jan 1970 00:00:00 GMT`;
-          parts.pop();
-        }
-      }
-    }
-
-    beforeEach(() => {
-      document = window.document;
-      deleteAllCookies();
-      expect(document.cookie).toEqual("");
-
-      window.angular = new Angular();
-      const injector = createInjector(["ng"]);
-      $$cookieReader = injector.get("$$cookieReader");
-    });
-
-    afterEach(() => {
-      deleteAllCookies();
-      expect(document.cookie).toEqual("");
-    });
-
-    describe("get via $$cookieReader()[cookieName]", () => {
-      it("should return undefined for nonexistent cookie", () => {
-        expect($$cookieReader().nonexistent).not.toBeDefined();
-      });
-
-      it("should return a value for an existing cookie", () => {
-        document.cookie = "foo=bar=baz;path=/";
-        expect($$cookieReader().foo).toEqual("bar=baz");
-      });
-
-      it("should return the the first value provided for a cookie", () => {
-        // For a cookie that has different values that differ by path, the
-        // value for the most specific path appears first.  $$cookieReader()
-        // should provide that value for the cookie.
-        document.cookie = 'foo="first"; foo="second"';
-        expect($$cookieReader().foo).toBe('"first"');
-      });
-
-      it("should decode cookie values that were encoded by puts", () => {
-        document.cookie = "cookie2%3Dbar%3Bbaz=val%3Due;path=/";
-        expect($$cookieReader()["cookie2=bar;baz"]).toEqual("val=ue");
-      });
-
-      it("should preserve leading & trailing spaces in names and values", () => {
-        document.cookie = "%20cookie%20name%20=%20cookie%20value%20";
-        expect($$cookieReader()[" cookie name "]).toEqual(" cookie value ");
-        expect($$cookieReader()["cookie name"]).not.toBeDefined();
-      });
-
-      it("should decode special characters in cookie values", () => {
-        document.cookie = "cookie_name=cookie_value_%E2%82%AC";
-        expect($$cookieReader().cookie_name).toEqual("cookie_value_€");
-      });
-
-      it("should not decode cookie values that do not appear to be encoded", () => {
-        // see #9211 - sometimes cookies contain a value that causes decodeURIComponent to throw
-        document.cookie = "cookie_name=cookie_value_%XX";
-        expect($$cookieReader().cookie_name).toEqual("cookie_value_%XX");
-      });
-    });
-
-    describe("getAll via $$cookieReader()", () => {
-      it("should return cookies as hash", () => {
-        document.cookie = "foo1=bar1;path=/";
-        document.cookie = "foo2=bar2;path=/";
-        expect($$cookieReader()).toEqual({ foo1: "bar1", foo2: "bar2" });
-      });
-
-      it("should return empty hash if no cookies exist", () => {
-        expect($$cookieReader()).toEqual({});
-      });
-    });
-
-    it("should initialize cookie cache with existing cookies", () => {
-      document.cookie = "existingCookie=existingValue;path=/";
-      expect($$cookieReader()).toEqual({ existingCookie: "existingValue" });
-    });
-  });
-});