Remove object registration from filterProvider

Author: Anatoly Ostrovsky

@types/core/di/ng-module/ng-module.d.ts

@@ -3,8 +3,6 @@ export const COMPILE_LITERAL: "$compileProvider";
 /** @private */
 export const ANIMATION_LITERAL: "$animateProvider";
 /** @private */
-export const FILTER_LITERAL: "$filterProvider";
-/** @private */
 export const CONTROLLER_LITERAL: "$controllerProvider";
 /**
  * Modules are collections of application configuration information for components:
@@ -111,10 +109,10 @@ export class NgModule {
   animation(name: string, animationFactory: ng.Injectable<any>): NgModule;
   /**
    * @param {string} name
-   * @param {ng.Injectable<any>} filterFn
+   * @param {ng.Injectable<ng.FilterFactory>} filterFn
    * @return {NgModule}
    */
-  filter(name: string, filterFn: ng.Injectable<any>): NgModule;
+  filter(name: string, filterFn: ng.Injectable<ng.FilterFactory>): NgModule;
   /**
    * The $controller service is used by Angular to create new controllers.
    * This provider allows controller registration via the register method.

@types/core/filter/filter.d.ts

@@ -1,3 +1,9 @@
+/**
+ * $filterProvider - $filter - provider in module ng
+ *
+ * Filters are just functions which transform input to an output. However filters need to be Dependency Injected. To achieve this a filter definition consists of a factory function which is annotated with dependencies and is responsible for creating a filter function.
+ * @extends {ng.ServiceProvider}
+ */
 export class FilterProvider {
   static $inject: string[];
   /**
@@ -6,18 +12,14 @@ export class FilterProvider {
   constructor($provide: ng.ProvideService);
   $provide: import("../../interface.ts").Provider;
   /**
-   * @param {string|Record<string, ng.FilterFn>} name
-   * @param {ng.FilterService} [factory]
-   * @return {import('../../interface.ts').Provider}
+   * Register a filter a config phase;
+   * @param {string} name
+   * @param {ng.Injectable<ng.FilterFactory>} factory
+   * @return {ng.FilterProvider}
    */
   register(
-    name: string | Record<string, ng.FilterFn>,
-    factory?: ng.FilterService,
-  ): import("../../interface.ts").Provider;
-  $get: (
-    | string
-    | ((
-        $injector: import("../../core/di/internal-injector.js").InjectorService,
-      ) => ng.FilterService)
-  )[];
+    name: string,
+    factory: ng.Injectable<ng.FilterFactory>,
+  ): ng.FilterProvider;
+  $get: (string | (($injector: ng.InjectorService) => ng.FilterFactory))[];
 }

@types/directive/input/input.d.ts

@@ -45,12 +45,12 @@ export function rangeInputType(
   ctrl: any,
 ): void;
 /**
- * @param {ng.FilterService} $filter
+ * @param {ng.FilterFactory} $filter
  * @param {ng.ParseService} $parse
  * @returns {ng.Directive}
  */
 export function inputDirective(
-  $filter: ng.FilterService,
+  $filter: ng.FilterFactory,
   $parse: ng.ParseService,
 ): ng.Directive;
 export namespace inputDirective {

@types/namespace.d.ts

@@ -22,6 +22,7 @@ import {
   FilterFactory as TFilterFactory,
   FilterFn as TFilterFn,
 } from "./filters/interface.ts";
+import { FilterProvider as TFilterProvider } from "./core/filter/filter.js";
 import { InterpolateService as TInterpolateService } from "./core/interpolate/interface.ts";
 import { InterpolateProvider as TInterpolateProvider } from "./core/interpolate/interpolate.js";
 import {
@@ -99,7 +100,6 @@ declare global {
     type Scope = TScope;
     type NgModule = TNgModule;
     type PubSubProvider = TPubSubProvider;
-    type FilterFn = TFilterFn;
     type CompositeLinkFn = TCompositeLinkFn;
     type PublicLinkFn = TPublicLinkFn;
     type NodeLinkFn = TNodeLinkFn;
@@ -112,13 +112,15 @@ declare global {
     type HttpParamSerializerProvider = THttpParamSerializerProvider;
     type SceProvider = TSceProvider;
     type SceDelegateProvider = TSceDelegateProvider;
+    type FilterProvider = TFilterProvider;
     type AnchorScrollService = TAnchorScrollService;
     type AnimateService = TAnimateService;
     type CompileService = TCompileFn;
     type ControllerService = TControllerService;
     type CookieService = TCookieService;
     type ExceptionHandlerService = TExceptionHandler;
-    type FilterService = TFilterFactory;
+    type FilterFn = TFilterFn;
+    type FilterFactory = TFilterFactory;
     type HttpParamSerializerSerService = THttpParamSerializer;
     type HttpService = THttpService;
     type InterpolateService = TInterpolateService;

legacy.d.ts

@@ -339,192 +339,6 @@ declare namespace legacy {
     defaultPrevented: boolean;
   }
 
-  /**
-   * $filter - $filterProvider - service in module ng
-   *
-   * Filters are used for formatting data displayed to the user.
-   *
-   * see https://docs.angularjs.org/api/ng/service/$filter
-   */
-  interface IFilterService {
-    (name: "filter"): IFilterFilter;
-    (name: "currency"): IFilterCurrency;
-    (name: "number"): IFilterNumber;
-    (name: "date"): IFilterDate;
-    (name: "json"): IFilterJson;
-    (name: "lowercase"): IFilterLowercase;
-    (name: "uppercase"): IFilterUppercase;
-    (name: "limitTo"): IFilterLimitTo;
-    (name: "orderBy"): IFilterOrderBy;
-    /**
-     * Usage:
-     * $filter(name);
-     *
-     * @param name Name of the filter function to retrieve
-     */
-    <T>(name: string): T;
-  }
-
-  interface IFilterFilter {
-    <T>(
-      array: T[],
-      expression:
-        | string
-        | IFilterFilterPatternObject
-        | IFilterFilterPredicateFunc<T>,
-      comparator?: IFilterFilterComparatorFunc<T> | boolean,
-    ): T[];
-  }
-
-  interface IFilterFilterPatternObject {
-    [name: string]: any;
-  }
-
-  interface IFilterFilterPredicateFunc<T> {
-    (value: T, index: number, array: T[]): boolean;
-  }
-
-  interface IFilterFilterComparatorFunc<T> {
-    (actual: T, expected: T): boolean;
-  }
-
-  interface IFilterOrderByItem {
-    value: any;
-    type: string;
-    index: any;
-  }
-
-  interface IFilterOrderByComparatorFunc {
-    (left: IFilterOrderByItem, right: IFilterOrderByItem): -1 | 0 | 1;
-  }
-
-  interface IFilterCurrency {
-    /**
-     * Formats a number as a currency (ie $1,234.56). When no currency symbol is provided, default symbol for current locale is used.
-     * @param amount Input to filter.
-     * @param symbol Currency symbol or identifier to be displayed.
-     * @param fractionSize Number of decimal places to round the amount to, defaults to default max fraction size for current locale
-     * @return Formatted number
-     */
-    (amount: number, symbol?: string, fractionSize?: number): string;
-  }
-
-  interface IFilterNumber {
-    /**
-     * Formats a number as text.
-     * @param number Number to format.
-     * @param fractionSize Number of decimal places to round the number to. If this is not provided then the fraction size is computed from the current locale's number formatting pattern. In the case of the default locale, it will be 3.
-     * @return Number rounded to decimalPlaces and places a “,” after each third digit.
-     */
-    (value: number | string, fractionSize?: number | string): string;
-  }
-
-  interface IFilterDate {
-    /**
-     * Formats date to a string based on the requested format.
-     *
-     * @param date Date to format either as Date object, milliseconds (string or number) or various ISO 8601 datetime string formats (e.g. yyyy-MM-ddTHH:mm:ss.sssZ and its shorter versions like yyyy-MM-ddTHH:mmZ, yyyy-MM-dd or yyyyMMddTHHmmssZ). If no timezone is specified in the string input, the time is considered to be in the local timezone.
-     * @param format Formatting rules (see Description). If not specified, mediumDate is used.
-     * @param timezone Timezone to be used for formatting. It understands UTC/GMT and the continental US time zone abbreviations, but for general use, use a time zone offset, for example, '+0430' (4 hours, 30 minutes east of the Greenwich meridian) If not specified, the timezone of the browser will be used.
-     * @return Formatted string or the input if input is not recognized as date/millis.
-     */
-    (date: Date | number | string, format?: string, timezone?: string): string;
-  }
-
-  interface IFilterJson {
-    /**
-     * Allows you to convert a JavaScript object into JSON string.
-     * @param object Any JavaScript object (including arrays and primitive types) to filter.
-     * @param spacing The number of spaces to use per indentation, defaults to 2.
-     * @return JSON string.
-     */
-    (object: any, spacing?: number): string;
-  }
-
-  interface IFilterLowercase {
-    /**
-     * Converts string to lowercase.
-     */
-    (value: string): string;
-  }
-
-  interface IFilterUppercase {
-    /**
-     * Converts string to uppercase.
-     */
-    (value: string): string;
-  }
-
-  interface IFilterLimitTo {
-    /**
-     * Creates a new array containing only a specified number of elements. The elements are taken from either the beginning or the end of the source array, string or number, as specified by the value and sign (positive or negative) of limit.
-     * @param input Source array to be limited.
-     * @param limit The length of the returned array. If the limit number is positive, limit number of items from the beginning of the source array/string are copied. If the number is negative, limit number of items from the end of the source array are copied. The limit will be trimmed if it exceeds array.length. If limit is undefined, the input will be returned unchanged.
-     * @param begin Index at which to begin limitation. As a negative index, begin indicates an offset from the end of input. Defaults to 0.
-     * @return A new sub-array of length limit or less if input array had less than limit elements.
-     */
-    <T>(input: T[], limit: string | number, begin?: string | number): T[];
-    /**
-     * Creates a new string containing only a specified number of elements. The elements are taken from either the beginning or the end of the source string or number, as specified by the value and sign (positive or negative) of limit. If a number is used as input, it is converted to a string.
-     * @param input Source string or number to be limited.
-     * @param limit The length of the returned string. If the limit number is positive, limit number of items from the beginning of the source string are copied. If the number is negative, limit number of items from the end of the source string are copied. The limit will be trimmed if it exceeds input.length. If limit is undefined, the input will be returned unchanged.
-     * @param begin Index at which to begin limitation. As a negative index, begin indicates an offset from the end of input. Defaults to 0.
-     * @return A new substring of length limit or less if input had less than limit elements.
-     */
-    (
-      input: string | number,
-      limit: string | number,
-      begin?: string | number,
-    ): string;
-  }
-
-  interface IFilterOrderBy {
-    /**
-     * Orders a specified array by the expression predicate. It is ordered alphabetically for strings and numerically for numbers. Note: if you notice numbers are not being sorted as expected, make sure they are actually being saved as numbers and not strings.
-     * @param array The array to sort.
-     * @param expression A predicate to be used by the comparator to determine the order of elements.
-     * @param reverse Reverse the order of the array.
-     * @param comparator Function used to determine the relative order of value pairs.
-     * @return An array containing the items from the specified collection, ordered by a comparator function based on the values computed using the expression predicate.
-     */
-    <T>(
-      array: T[],
-      expression:
-        | string
-        | ((value: T) => any)
-        | Array<((value: T) => any) | string>,
-      reverse?: boolean,
-      comparator?: IFilterOrderByComparatorFunc,
-    ): T[];
-  }
-
-  /**
-   * $filterProvider - $filter - provider in module ng
-   *
-   * Filters are just functions which transform input to an output. However filters need to be Dependency Injected. To achieve this a filter definition consists of a factory function which is annotated with dependencies and is responsible for creating a filter function.
-   *
-   * see https://docs.angularjs.org/api/ng/provider/$filterProvider
-   */
-  interface IFilterProvider extends IServiceProvider {
-    /**
-     * register(name);
-     *
-     * @param name Name of the filter function, or an object map of filters where the keys are the filter names and the values are the filter factories. Note: Filter names must be valid angular Expressions identifiers, such as uppercase or orderBy. Names with special characters, such as hyphens and dots, are not allowed. If you wish to namespace your filters, then you can use capitalization (myappSubsectionFilterx) or underscores (myapp_subsection_filterx).
-     */
-    register(name: string | {}): IServiceProvider;
-  }
-
-  interface ILogProvider extends IServiceProvider {
-    debugEnabled(): boolean;
-    debugEnabled(enabled: boolean): ILogProvider;
-  }
-
-  // We define this as separate interface so we can reopen it later for
-  // the ngMock module.
-  interface ILogCall {
-    (...args: any[]): void;
-  }
-
   ///////////////////////////////////////////////////////////////////////////
   // ParseService
   // see http://docs.angularjs.org/api/ng/service/$parse

src/core/di/ng-module/ng-module.js

@@ -12,8 +12,6 @@ export const COMPILE_LITERAL = "$compileProvider";
 /** @private */
 export const ANIMATION_LITERAL = "$animateProvider";
 /** @private */
-export const FILTER_LITERAL = "$filterProvider";
-/** @private */
 export const CONTROLLER_LITERAL = "$controllerProvider";
 
 /**
@@ -205,14 +203,14 @@ export class NgModule {
 
   /**
    * @param {string} name
-   * @param {ng.Injectable<any>} filterFn
+   * @param {ng.Injectable<ng.FilterFactory>} filterFn
    * @return {NgModule}
    */
   filter(name, filterFn) {
-    if (filterFn && isFunction(filterFn)) {
+    if (isFunction(filterFn)) {
       filterFn["$$moduleName"] = name;
     }
-    this.invokeQueue.push([FILTER_LITERAL, "register", [name, filterFn]]);
+    this.invokeQueue.push([$t.$filterProvider, "register", [name, filterFn]]);
     return this;
   }
 

src/core/di/ng-module/ng-module.spec.js

@@ -2,7 +2,6 @@ import {
   NgModule,
   COMPILE_LITERAL,
   ANIMATION_LITERAL,
-  FILTER_LITERAL,
   CONTROLLER_LITERAL,
 } from "./ng-module.js";
 import { $injectTokens } from "../../../injection-tokens.js";
@@ -228,12 +227,12 @@ describe("NgModule", () => {
   it("can store filters", () => {
     ngModule.filter("aFilter", a).filter("bFilter", b);
     expect(ngModule.invokeQueue[0]).toEqual([
-      FILTER_LITERAL,
+      injectTokens.$filterProvider,
       "register",
       ["aFilter", a],
     ]);
     expect(ngModule.invokeQueue[1]).toEqual([
-      FILTER_LITERAL,
+      $injectTokens.$filterProvider,
       "register",
       ["bFilter", b],
     ]);