View scroll types

Author: tolyo

@types/core/controller/controller.d.ts

@@ -1,4 +1,4 @@
-export function identifierForController(controller: any, ident: any): any;
+export function identifierForController(controller: any, ident: any): string;
 /**
  * The {@link ng.$controller $controller service} is used by AngularTS to create new
  * controllers.

@types/directive/include/include.d.ts

@@ -1,14 +1,14 @@
 /**
  *
  * @param {ng.TemplateRequestService} $templateRequest
- * @param {import("../../services/anchor-scroll/anchor-scroll.js").AnchorScrollFunction} $anchorScroll
+ * @param {ng.AnchorScrollService} $anchorScroll
  * @param {ng.AnimateService} $animate
  * @param {ng.ExceptionHandlerService} $exceptionHandler
  * @returns {ng.Directive}
  */
 export function ngIncludeDirective(
   $templateRequest: ng.TemplateRequestService,
-  $anchorScroll: import("../../services/anchor-scroll/anchor-scroll.js").AnchorScrollFunction,
+  $anchorScroll: ng.AnchorScrollService,
   $animate: ng.AnimateService,
   $exceptionHandler: ng.ExceptionHandlerService,
 ): ng.Directive;

@types/namespace.d.ts

@@ -8,10 +8,12 @@ import {
 } from "./core/scope/interface.ts";
 import { NgModule as TNgModule } from "./core/di/ng-module/ng-module.js";
 import { InjectorService as TInjectorService } from "./core/di/internal-injector.js";
+import { AnchorScrollProvider as TAnchorScrollProvider } from "./services/anchor-scroll/anchor-scroll.js";
 import {
-  AnchorScrollProvider as TAnchorScrollProvider,
+  AnchorScrollFunction as TAnchorScrollFunction,
   AnchorScrollService as TAnchorScrollService,
-} from "./services/anchor-scroll/anchor-scroll.js";
+  AnchorScrollObject as TAnchorScrollObject,
+} from "./services/anchor-scroll/interface.ts";
 import { ControllerService as TControllerService } from "./core/controller/interface.ts";
 import { ExceptionHandler as TExceptionHandler } from "./services/exception/interface.ts";
 import { ParseService as TParseService } from "./core/parse/interface.ts";
@@ -101,6 +103,7 @@ import {
 } from "./router/state/interface.ts";
 import { StateObject as TStateObject } from "./router/state/state-object.js";
 import { StateRegistryProvider as TStateRegistryProvider } from "./router/state/state-registry.js";
+import { IViewScrollService } from "./router/scroll/interface.ts";
 declare global {
   interface Function {
     $inject?: readonly string[] | undefined;
@@ -165,6 +168,7 @@ declare global {
     type TemplateRequestService = TTemplateRequestService;
     type UrlService = TUrlService;
     type ViewService = TViewService;
+    type ViewScrollService = IViewScrollService;
     type ErrorHandlingConfig = TErrorHandlingConfig;
     type ListenerFn = TListenerFn;
     type Listener = TListener;
@@ -193,5 +197,7 @@ declare global {
     type StateDeclaration = TStateDeclaration;
     type BuiltStateDeclaration = TBuiltStateDeclaration;
     type StateObject = TStateObject;
+    type AnchorScrollFunction = TAnchorScrollFunction;
+    type AnchorScrollObject = TAnchorScrollObject;
   }
 }

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

@@ -0,0 +1,3 @@
+export type IViewScrollService =
+  | ng.AnchorScrollService
+  | ((el: Element) => void | Promise<void>);

@types/router/scroll/view-scroll.d.ts

@@ -0,0 +1,8 @@
+export class ViewScrollProvider {
+  enabled: boolean;
+  useAnchorScroll(): void;
+  $get: (
+    | string
+    | (($anchorScroll: ng.AnchorScrollObject) => ng.ViewScrollService)
+  )[];
+}

@types/router/view-scroll.d.ts

@@ -1,25 +1,10 @@
-/**
- * @typedef {Object} AnchorScrollObject
- * @property {number|function|Element} yOffset
- */
-/**
- * @typedef {(string) => void} AnchorScrollFunction
- */
-/**
- * @typedef {AnchorScrollFunction | AnchorScrollObject} AnchorScrollService
- */
 export class AnchorScrollProvider {
   autoScrollingEnabled: boolean;
   $get: (
     | string
     | ((
-        $location: import("../../services/location/location.js").Location,
+        $location: ng.LocationService,
         $rootScope: ng.Scope,
-      ) => AnchorScrollFunction)
+      ) => import("./interface.ts").AnchorScrollFunction)
   )[];
 }
-export type AnchorScrollObject = {
-  yOffset: number | Function | Element;
-};
-export type AnchorScrollFunction = (string: any) => void;
-export type AnchorScrollService = AnchorScrollFunction | AnchorScrollObject;

@types/services/anchor-scroll/anchor-scroll.d.ts

@@ -0,0 +1,15 @@
+export interface AnchorScrollObject {
+  /**
+   * Vertical scroll offset.
+   * Can be a number, a function returning a number,
+   * or an Element whose offsetTop will be used.
+   */
+  yOffset?: number | (() => number) | Element;
+}
+export type AnchorScrollFunction = (hash?: string) => void;
+/**
+ * AngularJS $anchorScroll service
+ *
+ * Callable as a function and also exposes properties.
+ */
+export type AnchorScrollService = AnchorScrollFunction | AnchorScrollObject;

@types/services/anchor-scroll/interface.d.ts

@@ -91,11 +91,10 @@ export function isBlankObject(value: any): boolean;
 /**
  * Determines if a reference is a `string`.
  *
- * @template T
- * @param {T} value - The value to check.
- * @returns {value is T & string} True if `value` is a string.
+ * @param value - The value to check.
+ * @returns {value is string} True if `value` is a string.
  */
-export function isString<T>(value: T): value is T & string;
+export function isString(value: any): value is string;
 /**
  * Determines if a reference is a null.
  *

@types/shared/utils.d.ts

@@ -11,7 +11,7 @@ ngIncludeDirective.$inject = [
 /**
  *
  * @param {ng.TemplateRequestService} $templateRequest
- * @param {import("../../services/anchor-scroll/anchor-scroll.js").AnchorScrollFunction} $anchorScroll
+ * @param {ng.AnchorScrollService} $anchorScroll
  * @param {ng.AnimateService} $animate
  * @param {ng.ExceptionHandlerService} $exceptionHandler
  * @returns {ng.Directive}
@@ -42,7 +42,7 @@ export function ngIncludeDirective(
             isDefined(autoScrollExp) &&
             (!autoScrollExp || scope.$eval(autoScrollExp))
           ) {
-            $anchorScroll();
+            /** @type {ng.AnchorScrollFunction} */ ($anchorScroll)();
           }
         }