Type improvements on url service

Author: tolyo

@types/namespace.d.ts

@@ -130,6 +130,7 @@ import {
 import { AnimateRunner as TAnimateRunner } from "./animations/runner/animate-runner.js";
 import { Transition as TTransition } from "./router/transition/transition.js";
 import { TemplateFactoryProvider as TTemplateFactoryProvider } from "./router/template-factory.js";
+import { TransitionProviderService as TTransitionProviderService } from "./router/transition/interface.ts";
 declare global {
   interface Function {
     $inject?: readonly string[] | undefined;
@@ -166,6 +167,7 @@ declare global {
     type SceProvider = TSceProvider;
     type SceDelegateProvider = TSceDelegateProvider;
     type TransitionProvider = TTransitionProvider;
+    type TransitionProviderService = TTransitionProviderService;
     type RouterProvider = TRouterProvider;
     type TemplateFactoryProvider = TTemplateFactoryProvider;
     type AnchorScrollService = TAnchorScrollService;

@types/router/hooks/url.d.ts

@@ -23,7 +23,11 @@ export class StateQueueManager {
    * @type {Array<StateObject>}
    */
   queue: Array<StateObject>;
-  register(stateDecl: any): StateObject;
+  /**
+   * @param {ng.StateDeclaration} stateDecl
+   * @returns {StateObject}
+   */
+  register(stateDecl: ng.StateDeclaration): StateObject;
   flush(): import("./interface.ts").StateStore;
   /**
    *

@types/router/state/state-queue-manager.d.ts

@@ -25,14 +25,10 @@ export class StateProvider {
   get params(): import("../params/state-params.js").StateParams;
   /**
    * The current [[StateDeclaration]]
-   *
-   * @deprecated This is a passthrough through to [[Router.current]]
    */
   get current(): import("./interface.ts").StateDeclaration;
   /**
    * The current [[StateObject]] (an internal API)
-   *
-   * @deprecated This is a passthrough through to [[Router.$current]]
    */
   get $current(): import("./state-object.js").StateObject;
   /**

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

@@ -834,3 +834,61 @@ export interface IMatchingNodes {
  * Or, `true` to always match
  */
 export type HookMatchCriterion = string | IStateMatch | boolean;
+/**
+ * The runtime service instance returned from `TransitionProvider.$get`.
+ *
+ * Note: In this codebase, `$get` returns the provider instance (`return this;`),
+ * so the "service" surface includes both the public HookRegistry API and
+ * a set of internal fields/methods used by built-in hook registrations/plugins.
+ */
+export interface TransitionProviderService {
+  onBefore(
+    matchCriteria: HookMatchCriteria,
+    callback: (transition: Transition) => any,
+    options?: HookRegOptions,
+  ): Function;
+  onStart(
+    matchCriteria: HookMatchCriteria,
+    callback: (transition: Transition) => any,
+    options?: HookRegOptions,
+  ): Function;
+  onFinish(
+    matchCriteria: HookMatchCriteria,
+    callback: (transition: Transition) => any,
+    options?: HookRegOptions,
+  ): Function;
+  onSuccess(
+    matchCriteria: HookMatchCriteria,
+    callback: (transition: Transition) => any,
+    options?: HookRegOptions,
+  ): Function;
+  onError(
+    matchCriteria: HookMatchCriteria,
+    callback: (transition: Transition) => any,
+    options?: HookRegOptions,
+  ): Function;
+  onEnter(
+    matchCriteria: HookMatchCriteria,
+    callback: (...injectables: any[]) => any,
+    options?: HookRegOptions,
+  ): Function;
+  onRetain(
+    matchCriteria: HookMatchCriteria,
+    callback: (...injectables: any[]) => any,
+    options?: HookRegOptions,
+  ): Function;
+  onExit(
+    matchCriteria: HookMatchCriteria,
+    callback: (...injectables: any[]) => any,
+    options?: HookRegOptions,
+  ): Function;
+  /**
+   * Returns the registered hooks for a hook name.
+   * (This is also part of the HookRegistry interface in your types.)
+   */
+  getHooks(hookName: string): RegisteredHook[];
+  /**
+   * Internal factory used by StateService.
+   */
+  create(fromPath: PathNode[], targetState: TargetState): Transition;
+}

@types/router/transition/interface.d.ts

@@ -1,14 +1,12 @@
-export namespace defaultTransOpts {
-  let location: boolean;
-  let relative: any;
-  let inherit: boolean;
-  let notify: boolean;
-  let reload: boolean;
-  let supercede: boolean;
-  let custom: {};
-  function current(): any;
-  let source: string;
-}
+/**
+ * The default [[Transition]] options.
+ *
+ * Include this object when applying custom defaults:
+ * let reloadOpts = { reload: true, notify: true }
+ * let options = defaults(theirOpts, customDefaults, defaultOptions);
+ * @type {import("./interface.js").TransitionOptions}
+ */
+export const defaultTransOpts: import("./interface.js").TransitionOptions;
 /**
  * This class provides services related to Transitions.
  *
@@ -47,11 +45,11 @@ export class TransitionProvider {
   $get: (
     | string
     | ((
-        stateService: any,
-        urlService: any,
-        stateRegistry: any,
-        viewService: any,
-      ) => this)
+        stateService: ng.StateService,
+        urlService: ng.UrlService,
+        stateRegistry: ng.StateRegistryService,
+        viewService: ng.ViewService,
+      ) => ng.TransitionProviderService)
   )[];
   /**
    * Registers a [[TransitionHookFn]], called *while a transition is being constructed*.
@@ -90,10 +88,16 @@ export class TransitionProvider {
   create(fromPath: any, targetState: any): Transition;
   _defineCoreEvents(): void;
   _defineCorePaths(): void;
+  /**
+   * @param {string} name
+   * @param {number} hookPhase
+   * @param {number} hookOrder
+   * @param {any} criteriaMatchPath
+   */
   _defineEvent(
-    name: any,
-    hookPhase: any,
-    hookOrder: any,
+    name: string,
+    hookPhase: number,
+    hookOrder: number,
     criteriaMatchPath: any,
     reverseSort?: boolean,
     getResultHandler?: (hook: any) => (result: any) => any,
@@ -115,10 +119,11 @@ export class TransitionProvider {
    * Another example: the `to` path in [[HookMatchCriteria]] is a TRANSITION scoped path.
    * It was defined by calling `defineTreeChangesCriterion('to', TransitionHookScope.TRANSITION)`
    * Only the tail of the `to` path is checked against the criteria and returned as part of the match.
-   *
    * @internal
+   * @param {string} name
+   * @param {number} hookScope
    */
-  _definePathType(name: any, hookScope: any): void;
+  _definePathType(name: string, hookScope: number): void;
   _getPathTypes(): {};
   getHooks(hookName: any): any;
   _registerCoreTransitionHooks(): void;

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

@@ -49,14 +49,6 @@ export class Transition {
   _options: any;
   $id: number;
   _treeChanges: import("./interface.ts").TreeChanges;
-  onStart: any;
-  onBefore: any;
-  onSuccess: any;
-  onEnter: any;
-  onRetain: any;
-  onExit: any;
-  onFinish: any;
-  onError: any;
   /**
    * Creates the transition-level hook registration functions
    * (which can then be used to register hooks)

@types/router/transition/transition.d.ts

@@ -17,11 +17,11 @@ export class UrlRuleFactory {
   routerGlobals: ng.RouterService;
   /**
    *
-   * @param {*} what
-   * @param {*} handler
+   * @param {StateObject} what
+   * @param {*} [handler]
    * @returns {BaseUrlRule}
    */
-  create(what: any, handler: any): BaseUrlRule;
+  create(what: StateObject, handler?: any): BaseUrlRule;
   /**
    * A UrlRule which matches based on a UrlMatcher
    *
@@ -152,3 +152,4 @@ export class BaseUrlRule {
    */
   matchPriority(params?: any): number;
 }
+import { StateObject } from "../state/state-object.js";

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

@@ -15,12 +15,15 @@ export class UrlService {
     globals: import("../router.js").RouterProvider,
     urlConfigProvider: import("../../router/url/url-config.js").UrlConfigProvider,
   );
-  /** @type {ng.LocationService} */
-  $location: ng.LocationService;
+  /** @type {ng.LocationService | undefined} */
+  $location: ng.LocationService | undefined;
   /** @private */
   private _locationProvider;
   stateService: import("../../router/state/state-service.js").StateProvider;
-  /** @type {UrlRuleFactory} Provides services related to the URL */
+  /**
+   * @type {UrlRuleFactory} Provides services related to the URL
+   * @ignore
+   */
   _urlRuleFactory: UrlRuleFactory;
   /**
    * The nested [[UrlRules]] API for managing URL rules and rewrites
@@ -30,12 +33,20 @@ export class UrlService {
   _rules: UrlRules;
   /**
    * The nested [[UrlConfig]] API to configure the URL and retrieve URL information
+   * @ignore
    * @type {import("./url-config.js").UrlConfigProvider}
    */
   _config: import("./url-config.js").UrlConfigProvider;
-  /** @type {ParamFactory} Creates a new [[Param]] for a given location (DefType) */
+  /**
+   * @type {ParamFactory} Creates a new [[Param]] for a given location (DefType)
+   * @ignore
+   */
   _paramFactory: ParamFactory;
-  _urlListeners: any[];
+  /**
+   * @type {((evt: ng.ScopeEvent) => void)[]}
+   * @ignore
+   */
+  _urlListeners: ((evt: ng.ScopeEvent) => void)[];
   /**
    * Gets the path part of the current url
    *
@@ -136,8 +147,8 @@ export class UrlService {
    * let deregisterFn = locationServices.onChange((evt) => console.log("url change", evt));
    * ```
    *
-   * @param {Function} callback a function that will be called when the url is changing
-   * @return {Function} a function that de-registers the callback
+   * @param {(evt: ng.ScopeEvent) => void} callback a function that will be called when the url is changing
+   * @return {() => void} a function that de-registers the callback
    */
   private onChange;
   /**
@@ -236,19 +247,19 @@ export class UrlService {
   /**
    * Creates a [[UrlMatcher]] for the specified pattern.
    *
-   * @param urlPattern  The URL pattern.
-   * @param config  The config object hash.
+   * @param {string} urlPattern  The URL pattern.
+   * @param {*} [config]  The config object hash.
    * @returns The UrlMatcher.
    */
-  compile(urlPattern: any, config: any): UrlMatcher;
+  compile(urlPattern: string, config?: any): UrlMatcher;
   /**
    * Returns true if the specified object is a [[UrlMatcher]], or false otherwise.
    *
-   * @param object  The object to perform the type check against.
+   * @param {UrlMatcher & Record<string, any>} object  The object to perform the type check against.
    * @returns `true` if the object matches the `UrlMatcher` interface, by
    *          implementing all the same methods.
    */
-  isMatcher(object: any): boolean;
+  isMatcher(object: UrlMatcher & Record<string, any>): boolean;
 }
 import { UrlRuleFactory } from "./url-rule.js";
 import { UrlRules } from "./url-rules.js";

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

@@ -52,10 +52,7 @@ export interface UrlParts {
    * The parsed query string as an object.
    * Mirrors AngularJS’s `$location.setSearch()` format.
    */
-  search: Record<
-    string,
-    string | number | boolean | (string | number | boolean)[]
-  >;
+  search: Object;
   /**
    * The fragment identifier (everything after `#`, not including the `#` itself).
    */