ng-mocks 14.15.0 → 14.15.2

package/README.md

@@ -1,25 +1,27 @@
 [<img src="https://img.shields.io/gitter/room/help-me-mom/ng-mocks" alt="chat on gitter" width="90" height="20" />](https://gitter.im/ng-mocks/community)
 [<img src="https://img.shields.io/npm/v/ng-mocks" alt="npm version" width="88" height="20" />](https://www.npmjs.com/package/ng-mocks)
-[<img src="https://img.shields.io/circleci/build/github/help-me-mom/ng-mocks/master" alt="build status" width="88" height="20" />](https://app.circleci.com/pipelines/github/help-me-mom/ng-mocks?branch=master)
-[<img src="https://img.shields.io/coveralls/github/help-me-mom/ng-mocks/master" alt="coverage status" width="104" height="20" />](https://coveralls.io/github/help-me-mom/ng-mocks?branch=master)
+[<img src="https://img.shields.io/circleci/build/github/help-me-mom/ng-mocks/main" alt="build status" width="88" height="20" />](https://app.circleci.com/pipelines/github/help-me-mom/ng-mocks?branch=main)
+[<img src="https://img.shields.io/codecov/c/github/help-me-mom/ng-mocks/main" alt="coverage status" width="104" height="20" />](https://codecov.io/gh/help-me-mom/ng-mocks)
 
-# Mock components, services and more out of annoying dependencies for simplification of Angular testing
+# Mock components, services, and more to simplify Angular testing
 
-`ng-mocks` facilitates **Angular testing** and helps to:
+`ng-mocks` simplifies **Angular testing** and helps you:
 
 - **mock Components**, Directives, Pipes, Modules, Services and Tokens
 - reduce boilerplate in tests
-- access declarations via simple interface
+- access declarations through a simple interface
 
 The current version of the library **has been tested** and **can be used** with:
 
 | angular | ng-mocks | jasmine | jest | ivy | standalone | signals | defer |
 | ------: | :------: | :-----: | :--: | :-: | :--------: | :-----: | :---: |
-|      20 |  latest  |   yes   | yes  | yes |    yes     |   no    |  no   |
-|      19 |  latest  |   yes   | yes  | yes |    yes     |   no    |  no   |
-|      18 |  latest  |   yes   | yes  | yes |    yes     |   no    |  no   |
-|      17 |  latest  |   yes   | yes  | yes |    yes     |   no    |  no   |
-|      16 |  latest  |   yes   | yes  | yes |    yes     |   no    |       |
+|      22 |  latest  |   yes   | yes  | yes |    yes     |   yes   |  no   |
+|      21 |  latest  |   yes   | yes  | yes |    yes     |   yes   |  no   |
+|      20 |  latest  |   yes   | yes  | yes |    yes     |   yes   |  no   |
+|      19 |  latest  |   yes   | yes  | yes |    yes     |   yes   |  no   |
+|      18 |  latest  |   yes   | yes  | yes |    yes     |   yes   |  no   |
+|      17 |  latest  |   yes   | yes  | yes |    yes     |   yes   |  no   |
+|      16 |  latest  |   yes   | yes  | yes |    yes     |   yes   |       |
 |      15 |  latest  |   yes   | yes  | yes |    yes     |         |       |
 |      14 |  latest  |   yes   | yes  | yes |    yes     |         |       |
 |      13 |  latest  |   yes   | yes  | yes |            |         |       |
@@ -35,7 +37,7 @@ The current version of the library **has been tested** and **can be used** with:
 ## Important links
 
 - **[Documentation with examples of Angular testing](https://ng-mocks.sudo.eu)**
-- [CHANGELOG](https://github.com/help-me-mom/ng-mocks/blob/master/CHANGELOG.md)
+- [CHANGELOG](https://github.com/help-me-mom/ng-mocks/blob/main/CHANGELOG.md)
 - [GitHub repo](https://github.com/help-me-mom/ng-mocks)
 - [NPM package](https://www.npmjs.com/package/ng-mocks)
 
@@ -49,8 +51,8 @@ The current version of the library **has been tested** and **can be used** with:
 
 ## Very short introduction
 
-Global configuration for mocks in `src/test.ts`.
-In case of jest, `src/setup-jest.ts` / `src/test-setup.ts` should be used.
+Put the global configuration for mocks in `src/test.ts`.
+For Jest, use `src/setup-jest.ts` / `src/test-setup.ts`.
 
 ```ts title="src/test.ts"
 // All methods in mock declarations and providers
@@ -75,7 +77,7 @@ An example of a spec for a profile edit component.
 // and it has 3 text fields: email, firstName,
 // lastName, and a user can edit them.
 // In the following test suite, we would like to
-// cover behavior of the component.
+// cover the behavior of the component.
 describe('profile:builder', () => {
   // Helps to reset customizations after each test.
   // Alternatively, you can enable
@@ -93,7 +95,7 @@ describe('profile:builder', () => {
       ProfileComponent,
       ProfileModule,
     ).keep(ReactiveFormsModule);
-    // // or old fashion way
+    // // or the old-fashioned way
     // return TestBed.configureTestingModule({
     //   imports: [
     //     MockModule(SharedModule), // mock
@@ -126,7 +128,7 @@ describe('profile:builder', () => {
 
     expect(
       fixture.point.componentInstance,
-    ).toEqual(assertion.any(ProfileComponent));
+    ).toEqual(jasmine.any(ProfileComponent));
   });
 
   // A test to ensure that the component listens
@@ -140,7 +142,7 @@ describe('profile:builder', () => {
     };
 
     // A spy to track save calls.
-    // MockInstance helps to configure mock
+    // MockInstance helps configure mock
     // providers, declarations and modules
     // before their initialization and usage.
     // https://ng-mocks.sudo.eu/api/MockInstance
@@ -179,7 +181,7 @@ describe('profile:builder', () => {
     // https://ng-mocks.sudo.eu/api/ngMocks/trigger
     ngMocks.trigger(point, 'keyup.control.s');
 
-    // The spy should be called with the user
+    // The spy should be called with the profile
     // and the random email address.
     expect(spySave).toHaveBeenCalledWith({
       email: 'test3@em.ail',

package/example.spec.ts

@@ -17,8 +17,7 @@ import { MockBuilder, MockRender, ngMocks } from 'ng-mocks';
 
 @Pipe({
   name: 'translate',
-  ['standalone' as never /* TODO: remove after upgrade to a14 */]:
-    false,
+  ['standalone' as never /* TODO: remove after upgrade to a14 */]: false,
 })
 class TranslatePipe implements PipeTransform {
   public transform(value: string): string {
@@ -31,8 +30,7 @@ class TranslatePipe implements PipeTransform {
 // Our main component that we want to test.
 @Component({
   selector: 'app-root',
-  ['standalone' as never /* TODO: remove after upgrade to a14 */]:
-    false,
+  ['standalone' as never /* TODO: remove after upgrade to a14 */]: false,
   template: `
     <app-header
       [showLogo]="true"
@@ -64,8 +62,7 @@ class AppComponent {
 // component with a respect of its inputs, outputs and ContentChild.
 @Component({
   selector: 'app-header',
-  ['standalone' as never /* TODO: remove after upgrade to a14 */]:
-    false,
+  ['standalone' as never /* TODO: remove after upgrade to a14 */]: false,
   template: `
     <a (click)="logo.emit()">
       <img src="assets/logo.png" *ngIf="showLogo" />

package/index.d.ts

@@ -971,6 +971,20 @@ export declare function isNgDef(declaration: any): declaration is Type<any>;
  * ```
  */
 export declare const isNgInjectionToken: (token: any) => token is InjectionToken<any>;
+export type MockInstanceTokenInit<T> = (instance: T | undefined, injector: Injector | undefined) => Partial<T> | Array<Partial<T>>;
+export interface MockInstanceTokenConfig<T> {
+	/**
+	 * @deprecated please pass the callback directly instead of config.
+	 */
+	init?: MockInstanceTokenInit<T>;
+}
+export type MockInstanceClassInit<T> = (instance: T, injector: Injector | undefined) => void | Partial<T> | Array<Partial<T>>;
+export interface MockInstanceClassConfig<T> {
+	/**
+	 * @deprecated please pass the callback directly instead of config.
+	 */
+	init?: MockInstanceClassInit<T>;
+}
 /**
  * This signature of MockInstance lets customize the getter of a property.
  *
@@ -1018,11 +1032,10 @@ export declare function MockInstance<T extends object, K extends keyof T, S exte
  * MockInstance(webSocketToken, () => mockWebSocket);
  * ```
  */
-export declare function MockInstance<T>(declaration: InjectionToken<T>, init?: (instance: T | undefined, injector: Injector | undefined) => Partial<T> | Array<Partial<T>>): void;
+export declare function MockInstance<T>(declaration: InjectionToken<T>, init?: MockInstanceTokenInit<T>): void;
 /**
  * This signature of MockInstance lets customize tokens with a callback.
  *
- * @deprecated please pass the callback directly instead of config.
  * @see https://ng-mocks.sudo.eu/api/MockInstance
  *
  * ```ts
@@ -1031,9 +1044,7 @@ export declare function MockInstance<T>(declaration: InjectionToken<T>, init?: (
  * });
  * ```
  */
-export declare function MockInstance<T>(declaration: InjectionToken<T>, config?: {
-	init?: (instance: T | undefined, injector: Injector | undefined) => Partial<T> | Array<Partial<T>>;
-}): void;
+export declare function MockInstance<T>(declaration: InjectionToken<T>, config?: MockInstanceTokenConfig<T>): void;
 /**
  * This signature of MockInstance lets customize the instances of mock classes with a callback.
  * You can return a shape or change the instance.
@@ -1052,12 +1063,11 @@ export declare function MockInstance<T>(declaration: InjectionToken<T>, config?:
  * });
  * ```
  */
-export declare function MockInstance<T>(declaration: AnyType<T>, init?: (instance: T, injector: Injector | undefined) => void | Partial<T> | Array<Partial<T>>): void;
+export declare function MockInstance<T>(declaration: AnyType<T>, init?: MockInstanceClassInit<T>): void;
 /**
  * This signature of MockInstance lets customize the instances of mock classes with a callback.
  * You can return a shape or change the instance.
  *
- * @deprecated please pass the callback directly instead of config.
  * @see https://ng-mocks.sudo.eu/api/MockInstance
  *
  * ```ts
@@ -1076,9 +1086,7 @@ export declare function MockInstance<T>(declaration: AnyType<T>, init?: (instanc
  * });
  * ```
  */
-export declare function MockInstance<T>(declaration: AnyType<T>, config?: {
-	init?: (instance: T, injector: Injector | undefined) => void | Partial<T> | Array<Partial<T>>;
-}): void;
+export declare function MockInstance<T>(declaration: AnyType<T>, config?: MockInstanceClassConfig<T>): void;
 /**
  * Interface describes how to configure scopes for MockInstance.
  *
@@ -1540,6 +1548,9 @@ export interface IMockRenderFactoryOptions extends IMockRenderOptions {
  * @see https://ng-mocks.sudo.eu/api/MockRender
  */
 export interface MockedComponentFixture<C = any, F = DefaultRenderComponent<C>> extends ComponentFixture<F> {
+	componentInstance: ComponentFixture<F>["componentInstance"];
+	debugElement: ComponentFixture<F>["debugElement"] & MockedDebugElement<F>;
+	nativeElement: ComponentFixture<F>["nativeElement"];
 	point: MockedDebugElement<C>;
 }
 /**