Additional validation functions

Author: tolyo

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

@@ -38,16 +38,16 @@ export class NgModule {
   restDefinitions: any[];
   /**
    * @param {string} name
-   * @param {any} object
+   * @param {any} object - Allows undefined
    * @returns {NgModule}
    */
   value(name: string, object: any): NgModule;
   /**
    * @param {string} name
-   * @param {any} object
+   * @param {Object|string|number} object
    * @returns {NgModule}
    */
-  constant(name: string, object: any): NgModule;
+  constant(name: string, object: any | string | number): NgModule;
   /**
    *
    * @param {ng.Injectable<any>} configFn

@types/namespace.d.ts

@@ -51,7 +51,10 @@ import {
   SseService as TSseService,
   SseConfig as TSseConfig,
 } from "./services/sse/interface.ts";
-import type { ErrorHandlingConfig as TErrorHandlingConfig } from "./shared/interface.ts";
+import type {
+  ErrorHandlingConfig as TErrorHandlingConfig,
+  Validator as TValidator,
+} from "./shared/interface.ts";
 import {
   BoundTranscludeFn as TBoundTranscludeFn,
   CompileFn as TCompileFn,
@@ -175,5 +178,6 @@ declare global {
     type ServiceProvider = TServiceProvider;
     type Expression = TExpression;
     type NgModelController = TNgModelController;
+    type Validator = TValidator;
   }
 }

@types/shared/interface.d.ts

@@ -17,3 +17,4 @@ export interface ErrorHandlingConfig {
    */
   urlErrorParamsEnabled?: boolean;
 }
+export type Validator = (value: unknown) => boolean;

@types/shared/utils.d.ts

@@ -57,13 +57,7 @@ export function isObject(value: any): boolean;
  * @returns {boolean} True if `value` is an `Object` with a null prototype
  */
 export function isBlankObject(value: any): boolean;
-/**
- * Determines if a reference is a `String`.
- *
- * @param {*} value Reference to check.
- * @returns {boolean} True if `value` is a `String`.
- */
-export function isString(value: any): boolean;
+export function isString(value: unknown): boolean;
 /**
  * Determines if a reference is a null.
  *
@@ -78,6 +72,13 @@ export function isNull(value: any): boolean;
  * @returns {boolean} True if `value` is null or undefined.
  */
 export function isNullOrUndefined(obj: any): boolean;
+/**
+ * Determines if a reference is not null or undefined.
+ *
+ * @param {*} obj Reference to check.
+ * @returns {boolean} True if `value` is null or undefined.
+ */
+export function notNullOrUndefined(obj: any): boolean;
 /**
  * Determines if a reference is a `Number`.
  *
@@ -434,9 +435,30 @@ export function shallowCopy(src: any, dst: any): any;
  */
 export function assert(argument: boolean, errorMsg?: string): void;
 /**
- * Throw error if the argument is falsy.
+ * Validate a value using a predicate function.
+ * Throws if the predicate returns false.
+ *
+ * @param {ng.Validator} fn - Predicate validator function.
+ * @param {*} arg - The value to validate.
+ * @param {string} name - Parameter name (included in error message).
+ * @returns {*} The validated value.
+ * @throws {TypeError} If the value does not satisfy the validator.
+ */
+export function validate(fn: ng.Validator, arg: any, name: string): any;
+/**
+ * @param {*} arg - The value to validate.
+ * @param {string} name - Parameter name (included in error message).
+ * @returns {*} The validated value.
+ * @throws {TypeError} If the value does not satisfy the validator.
+ */
+export function validateRequired(arg: any, name: string): any;
+/**
+ * @param {*} arg - The value to validate.
+ * @param {string} name - Parameter name (included in error message).
+ * @returns {*} The validated value.
+ * @throws {TypeError} If the value does not satisfy the validator.
  */
-export function validate(fn: any, arg: any, name: any): any;
+export function validateArray(arg: any, name: string): any;
 /**
  * Throw error if the argument is falsy.
  */
@@ -452,12 +474,12 @@ export function assertArgFn(
  *
  * Omitted or undefined options will leave the corresponding configuration values unchanged.
  *
- * @param {import("./interface.ts").ErrorHandlingConfig} [config]
- * @returns {import("./interface.ts").ErrorHandlingConfig}
+ * @param {ng.ErrorHandlingConfig} [config]
+ * @returns {ng.ErrorHandlingConfig}
  */
 export function errorHandlingConfig(
-  config?: import("./interface.ts").ErrorHandlingConfig,
-): import("./interface.ts").ErrorHandlingConfig;
+  config?: ng.ErrorHandlingConfig,
+): ng.ErrorHandlingConfig;
 /**
  * This object provides a utility for producing rich Error messages within
  * AngularTS. It can be called as follows:

src/angular.spec.js

@@ -350,9 +350,15 @@ describe("module loader", () => {
 
   it("should record calls", () => {
     const otherModule = angular.module("other", []);
-    otherModule.config("otherInit");
 
-    const myModule = angular.module("my", ["other"], "config");
+    const init = () => {};
+    const config = () => {};
+    const init2 = () => {};
+    const run = () => {};
+
+    otherModule.config(init);
+
+    const myModule = angular.module("my", ["other"], config);
     const filterFn = () => () => "filterFn";
     expect(
       myModule
@@ -365,9 +371,9 @@ describe("module loader", () => {
         .directive("d", "dd")
         .component("c", "cc")
         .controller("ctrl", "ccc")
-        .config("init2")
+        .config(init2)
         .constant("abc", 123)
-        .run("runBlock"),
+        .run(run),
     ).toBe(myModule);
 
     expect(myModule.requires).toEqual(["other"]);
@@ -391,11 +397,11 @@ describe("module loader", () => {
       ],
     ]);
     expect(myModule.configBlocks).toEqual([
-      ["$injector", "invoke", jasmine.objectContaining(["config"])],
+      ["$injector", "invoke", jasmine.objectContaining([config])],
       ["$provide", "decorator", jasmine.objectContaining(["dk", "dv"])],
-      ["$injector", "invoke", jasmine.objectContaining(["init2"])],
+      ["$injector", "invoke", jasmine.objectContaining([init2])],
     ]);
-    expect(myModule.runBlocks).toEqual(["runBlock"]);
+    expect(myModule.runBlocks).toEqual([run]);
   });
 
   it("should not throw error when `module.decorator` is declared before provider that it decorates", () => {

src/core/compile/compile.spec.js

@@ -15396,7 +15396,6 @@ describe("$compile", () => {
     it("should return the module", () => {
       const myModule = module;
       expect(myModule.component("myComponent", {})).toBe(myModule);
-      expect(myModule.component({})).toBe(myModule);
     });
 
     it("should register a directive", () => {
@@ -15412,34 +15411,6 @@ describe("$compile", () => {
       expect(log[0]).toEqual("OK");
     });
 
-    it("should register multiple directives when object passed as first parameter", async () => {
-      module.component({
-        fooComponent: {
-          template: "<div>FOO SUCCESS</div>",
-          controller() {
-            log.push("FOO:OK");
-          },
-        },
-        barComponent: {
-          template: "<div>BAR SUCCESS</div>",
-          controller() {
-            log.push("BAR:OK");
-          },
-        },
-      });
-      initInjector("test1");
-      const fooElement = $compile("<foo-component></foo-component>")(
-        $rootScope,
-      );
-      const barElement = $compile("<bar-component></bar-component>")(
-        $rootScope,
-      );
-      await wait();
-      expect(fooElement.children[0].innerText).toEqual("FOO SUCCESS");
-      expect(barElement.children[0].innerText).toEqual("BAR SUCCESS");
-      expect(log.join("")).toEqual("FOO:OKBAR:OK");
-    });
-
     it("should register a directive via $compileProvider.component()", () => {
       module.component("myComponent", {
         template: "<div>SUCCESS</div>",

src/core/di/injector.js

@@ -1,6 +1,5 @@
 import {
   assert,
-  assertArg,
   assertArgFn,
   assertNotHasOwnProperty,
   isFunction,
@@ -9,6 +8,7 @@ import {
   isString,
   isUndefined,
   minErr,
+  validateArray,
 } from "../../shared/utils.js";
 import { InjectorService, ProviderInjector } from "./internal-injector.js";
 import { createPersistentProxy } from "../../services/storage/storage.js";
@@ -282,11 +282,7 @@ export function createInjector(modulesToLoad, strictDi = false) {
    * @returns
    */
   function loadModules(modules) {
-    assertArg(
-      isUndefined(modules) || Array.isArray(modules),
-      "modulesToLoad",
-      "not an array",
-    );
+    validateArray(modules, "modules");
     let moduleRunBlocks = [];
 
     modules.forEach((module) => {

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

@@ -4,9 +4,10 @@ import {
   instantiateWasm,
   isFunction,
   isString,
-  assertArg,
   validate,
+  isDefined,
 } from "../../../shared/utils.js";
+import { isInjectable } from "../../../shared/predicates.js";
 
 /**
  * Modules are collections of application configuration information for components:
@@ -22,7 +23,7 @@ export class NgModule {
    */
   constructor(name, requires, configFn) {
     validate(isString, name, "name");
-    validate(Array.isArray, requires, "not array");
+    validate(Array.isArray, requires, "requires");
     /**
      * Name of the current module.
      * @type {string}
@@ -58,21 +59,26 @@ export class NgModule {
 
   /**
    * @param {string} name
-   * @param {any} object
+   * @param {any} object - Allows undefined
    * @returns {NgModule}
    */
   value(name, object) {
+    validate(isString, name, "name");
+
     this.invokeQueue.push([$t.$provide, "value", [name, object]]);
 
     return this;
   }
 
   /**
    * @param {string} name
-   * @param {any} object
+   * @param {Object|string|number} object
    * @returns {NgModule}
    */
   constant(name, object) {
+    validate(isString, name, "name");
+    validate(isDefined, object, "object");
+
     this.invokeQueue.unshift([$t.$provide, "constant", [name, object]]);
 
     return this;
@@ -84,6 +90,8 @@ export class NgModule {
    * @returns {NgModule}
    */
   config(configFn) {
+    validate(isInjectable, configFn, "configFn");
+
     this.configBlocks.push([$t.$injector, "invoke", [configFn]]);
 
     return this;
@@ -94,6 +102,8 @@ export class NgModule {
    * @returns {NgModule}
    */
   run(block) {
+    validate(isInjectable, block, "block");
+
     this.runBlocks.push(block);
 
     return this;
@@ -105,6 +115,9 @@ export class NgModule {
    * @returns {NgModule}
    */
   component(name, options) {
+    validate(isString, name, "name");
+    validate(isDefined, options, "object");
+
     this.invokeQueue.push([$t.$compileProvider, "component", [name, options]]);
 
     return this;
@@ -197,8 +210,8 @@ export class NgModule {
    * @return {NgModule}
    */
   filter(name, filterFn) {
-    assertArg(isString(name), "name");
-    assertArg(isFunction(filterFn), `filterFn`);
+    validate(isString, name, "name");
+    validate(isFunction, filterFn, `filterFn`);
     this.invokeQueue.push([$t.$filterProvider, "register", [name, filterFn]]);
 
     return this;

src/directive/options/options.js

@@ -1,13 +1,13 @@
 import { emptyElement, removeElement, startingTag } from "../../shared/dom.js";
 import {
-  assertArg,
   equals,
   hasOwn,
   hashKey,
   includes,
   isArrayLike,
   isDefined,
   minErr,
+  validateRequired,
 } from "../../shared/utils.js";
 
 const ngOptionsMinErr = minErr("ngOptions");
@@ -420,7 +420,7 @@ export function ngOptionsDirective($compile, $parse) {
       // compile the element since there might be bindings in it
       const linkFn = $compile(selectCtrl.emptyOption);
 
-      assertArg(linkFn, "LinkFn required");
+      validateRequired(linkFn, "linkFn");
       selectElement.prepend(selectCtrl.emptyOption);
       linkFn(scope);
 

src/namespace.ts

@@ -55,7 +55,10 @@ import {
   SseService as TSseService,
   SseConfig as TSseConfig,
 } from "./services/sse/interface.ts";
-import type { ErrorHandlingConfig as TErrorHandlingConfig } from "./shared/interface.ts";
+import type {
+  ErrorHandlingConfig as TErrorHandlingConfig,
+  Validator as TValidator,
+} from "./shared/interface.ts";
 import {
   BoundTranscludeFn as TBoundTranscludeFn,
   CompileFn as TCompileFn,
@@ -188,5 +191,6 @@ declare global {
     export type ServiceProvider = TServiceProvider;
     export type Expression = TExpression;
     export type NgModelController = TNgModelController;
+    export type Validator = TValidator;
   }
 }