Refactor on and

Author: tolyo

@types/interface.d.ts

@@ -4,6 +4,8 @@ export * from "./core/di/ng-module.js";
 export * from "./services/http/interface.ts";
 export * from "./services/log/interface.ts";
 export * from "./services/log/log.js";
+export * from "./services/location/interface.ts";
+export * from "./services/location/location.js";
 export * from "./services/pubsub/pubsub.js";
 export * from "./services/template-cache/interface.ts";
 export * from "./services/template-cache/template-cache.js";

@types/router/url/url-matcher.d.ts

@@ -112,8 +112,8 @@ export class UrlMatcher {
    * // returns { id: 'bob', q: 'hello', r: null }
    * ```
    *
-   * @param path    The URL path to match, e.g. `$location.path()`.
-   * @param search  URL search parameters, e.g. `$location.search()`.
+   * @param path    The URL path to match, e.g. `$location.getPath()`.
+   * @param search  URL search parameters, e.g. `$location.getSearch()`.
    * @param hash    URL hash e.g. `$location.getHash()`.
    *
    * @returns The captured parameter values.

@types/router/url/url-rules.d.ts

@@ -6,7 +6,7 @@
  *
  * The most commonly used methods are [[otherwise]] and [[when]].
  *
- * This API is found at `$urlService.rules` (see: [[UIRouter.urlService]], [[URLService.rules]])
+ * This API is found at `$url.rules` (see: [[UIRouter.urlService]], [[URLService.rules]])
  */
 export class UrlRules {
   constructor(urlRuleFactory: any);

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

@@ -33,31 +33,31 @@ export class UrlService {
   config: import("./url-config.js").UrlConfigProvider;
   /** Creates a new [[Param]] for a given location (DefType) */
   paramFactory: ParamFactory;
+  _urlListeners: any[];
   /**
    * Gets the path part of the current url
    *
    * If the current URL is `/some/path?query=value#anchor`, this returns `/some/path`
    *
-   * @return the path portion of the url
+   * @return {string} the path portion of the url
    */
-  path: () => any;
+  getPath(): string;
   /**
    * Gets the search part of the current url as an object
    *
    * If the current URL is `/some/path?query=value#anchor`, this returns `{ query: 'value' }`
    *
-   * @return the search (query) portion of the url, as an object
+   * @return {Object} the search (query) portion of the url, as an object
    */
-  search: () => any;
+  getSearch(): any;
   /**
    * Gets the hash part of the current url
    *
    * If the current URL is `/some/path?query=value#anchor`, this returns `anchor`
    *
-   * @return the hash (anchor) portion of the url
+   * @return {string} the hash (anchor) portion of the url
    */
-  hash: () => any;
-  _urlListeners: any[];
+  getHash(): string;
   $get: (
     | string
     | ((
@@ -69,6 +69,9 @@ export class UrlService {
    * @returns {boolean}
    */
   html5Mode(): boolean;
+  /**
+   * @returns {string}
+   */
   baseHref(): string;
   _baseHref: string;
   /**
@@ -124,7 +127,7 @@ export class UrlService {
    */
   url(newUrl?: string, state?: any): any;
   /**
-   * @internal
+   * @private
    *
    * Registers a low level url change handler
    *
@@ -135,10 +138,10 @@ export class UrlService {
    * let deregisterFn = locationServices.onChange((evt) => console.log("url change", evt));
    * ```
    *
-   * @param callback a function that will be called when the url is changing
-   * @return a function that de-registers the callback
+   * @param {Function} callback a function that will be called when the url is changing
+   * @return {Function} a function that de-registers the callback
    */
-  onChange(callback: any): () => any;
+  private onChange;
   /**
    * Gets the current URL parts.
    *
@@ -219,7 +222,7 @@ export class UrlService {
    * ```js
    * matcher = $umf.compile("/about/:person");
    * params = { person: "bob" };
-   * $bob = $urlService.href(matcher, params);
+   * $bob = $url.href(matcher, params);
    * // $bob == "/about/bob";
    * ```
    *

@types/services/location/location.d.ts

@@ -211,6 +211,11 @@ export class Location {
    * @type {string}
    */
   $$path: string;
+  /**
+   * Current url
+   * @type {string}
+   */
+  $$url: string;
   /**
    * The hash string, minus the hash symbol
    * @type {string}
@@ -243,28 +248,6 @@ export class Location {
    * @return {string} url
    */
   getUrl(): string;
-  /**
-   * @deprecated
-   * This method is getter / setter.
-   *
-   * Return path of current URL when called without any parameter.
-   *
-   * Change path when called with parameter and return `$location`.
-   *
-   * Note: Path should always begin with forward slash (/), this method will add the forward slash
-   * if it is missing.
-   *
-   *
-   * ```js
-   * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo
-   * let path = $location.path();
-   * // => "/some/path"
-   * ```
-   *
-   * @param {(string|number)=} path New path
-   * @return {(string|object)} path if called with no parameters, or `$location` if called with a parameter
-   */
-  path(path?: (string | number) | undefined): string | object;
   /**
    * Change path parameter and return `$location`.
    *
@@ -274,30 +257,11 @@ export class Location {
   setPath(path: string | number): Location;
   /**
    *
-   * Return path of current URL when called without any parameter.
-   *
-   * @return {(string|object)} path if called with no parameters, or `$location` if called with a parameter
-   */
-  getPath(): string | object;
-  /**
-   * @deprecated
-   * This method is getter / setter.
+   * Return path of current URL
    *
-   * Returns the hash fragment when called without any parameters.
-   *
-   * Changes the hash fragment when called with a parameter and returns `$location`.
-   *
-   *
-   * ```js
-   * // given URL http://example.com/#/some/path?foo=bar&baz=xoxo#hashValue
-   * let hash = $location.getHash();
-   * // => "hashValue"
-   * ```
-   *
-   * @param {(string|number)=} hash New hash fragment
-   * @return {string|Location} hash
+   * @return {string}
    */
-  hash(hash?: (string | number) | undefined): string | Location;
+  getPath(): string;
   /**
    * Changes the hash fragment when called with a parameter and returns `$location`.
    * @param {(string|number)} hash New hash fragment
@@ -341,25 +305,29 @@ export class Location {
    * @returns {Object} Search object or Location object
    */
   getSearch(): any;
-  $$url: string;
   /**
-   * This method is getter / setter.
-   *
-   * Return the history state object when called without any parameter.
-   *
+   * Compose url and update `url` and `absUrl` property
+   * @returns {void}
+   */
+  $$compose(): void;
+  /**
    * Change the history state object when called with one parameter and return `$location`.
    * The state object is later passed to `pushState` or `replaceState`.
    * See {@link https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#state|History.state}
    *
    * NOTE: This method is supported only in HTML5 mode and only in browsers supporting
    * the HTML5 History API (i.e. methods `pushState` and `replaceState`). If you need to support
    * older browsers (like IE9 or Android < 4.0), don't use this method.
-   *
-   * @param {any} state State object for pushState or replaceState
-   * @return {any} state
+   * @param {any} state
+   * @returns {Location}
    */
-  state(state: any, ...args: any[]): any;
+  setState(state: any): Location;
   $$state: any;
+  /**
+   * Return the history state object
+   * @returns {any}
+   */
+  getState(): any;
   /**
    * @param {string} url
    * @param {string} relHref
@@ -371,7 +339,6 @@ export class Location {
    * @param {string} url HTML5 URL
    */
   parse(url: string): void;
-  #private;
 }
 export class LocationProvider {
   /** @type {string} */
@@ -383,8 +350,8 @@ export class LocationProvider {
   urlChangeInit: boolean;
   /** @type {History['state']} */
   cachedState: History["state"];
-  /** @typeof {History.state} */
-  lastHistoryState: any;
+  /** @type {History['state']} */
+  lastHistoryState: History["state"];
   /** @type {string} */
   lastBrowserUrl: string;
   /**

docs/content/docs/provider/locationProvider.md

@@ -0,0 +1,26 @@
+---
+title: $locationProvider
+description: >
+  Configuration provider for `$location` service.
+---
+
+### Description
+
+Use the `$locationProvider` to configure how the application deep linking paths
+are stored.
+
+### Properties
+
+---
+
+#### $locationProvider.html5ModeConf
+
+- **Type:** Html5Mode
+- **Default:** `{ enabled: true, requireBase: false, rewriteLinks: true }`
+- **Example:**
+
+  ```js
+  angular.module('demo', []).config(($locationProvider) => {
+    $locationProvider.enabled = false;
+  });
+  ```

docs/content/docs/service/location.md

@@ -0,0 +1,5 @@
+---
+title: $location
+description: >
+  URL normalization for HTML5/hashbang modes
+---

docs/content/docs/service/url.md

@@ -0,0 +1,5 @@
+---
+title: $url
+description: >
+  URL management for state transitions
+---

docs/static/typedoc/assets/highlight.css

@@ -1,20 +1,26 @@
 :root {
-    --light-hl-0: #000000;
-    --dark-hl-0: #D4D4D4;
-    --light-hl-1: #A31515;
-    --dark-hl-1: #CE9178;
-    --light-hl-2: #0000FF;
-    --dark-hl-2: #569CD6;
+    --light-hl-0: #008000;
+    --dark-hl-0: #6A9955;
+    --light-hl-1: #0000FF;
+    --dark-hl-1: #569CD6;
+    --light-hl-2: #000000;
+    --dark-hl-2: #D4D4D4;
     --light-hl-3: #001080;
     --dark-hl-3: #9CDCFE;
-    --light-hl-4: #800000;
-    --dark-hl-4: #808080;
+    --light-hl-4: #A31515;
+    --dark-hl-4: #CE9178;
     --light-hl-5: #800000;
-    --dark-hl-5: #569CD6;
-    --light-hl-6: #E50000;
-    --dark-hl-6: #9CDCFE;
-    --light-hl-7: #0000FF;
-    --dark-hl-7: #CE9178;
+    --dark-hl-5: #808080;
+    --light-hl-6: #800000;
+    --dark-hl-6: #569CD6;
+    --light-hl-7: #E50000;
+    --dark-hl-7: #9CDCFE;
+    --light-hl-8: #0000FF;
+    --dark-hl-8: #CE9178;
+    --light-hl-9: #795E26;
+    --dark-hl-9: #DCDCAA;
+    --light-hl-10: #098658;
+    --dark-hl-10: #B5CEA8;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -28,6 +34,9 @@
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 } }
 
@@ -40,6 +49,9 @@
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 } }
 
@@ -52,6 +64,9 @@
     --hl-5: var(--light-hl-5);
     --hl-6: var(--light-hl-6);
     --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
     --code-background: var(--light-code-background);
 }
 
@@ -64,6 +79,9 @@
     --hl-5: var(--dark-hl-5);
     --hl-6: var(--dark-hl-6);
     --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
     --code-background: var(--dark-code-background);
 }
 
@@ -75,4 +93,7 @@
 .hl-5 { color: var(--hl-5); }
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
 pre, code { background: var(--code-background); }