Merge branch 'main' into remove-let-module

ngrx · Oct 24, 2023 · a6ece02 · a6ece02
2 parents 96f7b08 + d54af4a
commit a6ece02
Show file tree

Hide file tree

Showing 24 changed files with 174 additions and 53 deletions.
diff --git a/modules/component/spec/push/push.module.spec.ts b/modules/component/spec/push/push.module.spec.ts
diff --git a/modules/component/src/index.ts b/modules/component/src/index.ts
@@ -1,4 +1,3 @@
 export { RenderScheduler } from './core/render-scheduler';
 export { LetDirective } from './let/let.directive';
 export { PushPipe } from './push/push.pipe';
-export { PushModule } from './push/push.module';
diff --git a/modules/component/src/push/push.module.ts b/modules/component/src/push/push.module.ts
diff --git a/modules/component/src/push/push.pipe.ts b/modules/component/src/push/push.pipe.ts
@@ -7,8 +7,6 @@ import { createRenderEventManager } from '../core/render-event/manager';
 type PushPipeResult<PO> = PotentialObservableResult<PO, undefined>;
 
 /**
- * @ngModule PushModule
- *
  * @description
  *
  * The `ngrxPush` pipe serves as a drop-in replacement for the `async` pipe.

diff --git a/modules/signals/rxjs-interop/spec/rx-method.spec.ts b/modules/signals/rxjs-interop/spec/rx-method.spec.ts
@@ -1,4 +1,9 @@
-import { Injectable, signal } from '@angular/core';
+import {
+  createEnvironmentInjector,
+  EnvironmentInjector,
+  Injectable,
+  signal,
+} from '@angular/core';
 import { TestBed } from '@angular/core/testing';
 import { BehaviorSubject, pipe, Subject, tap } from 'rxjs';
 import { rxMethod } from '../src';
@@ -174,4 +179,47 @@ describe('rxMethod', () => {
     tick();
     expect(results).toEqual([1, 1, 1]);
   });
+
+  it('unsubscribes from method and all instances on provided injector destroy', () => {
+    const injector = createEnvironmentInjector(
+      [],
+      TestBed.inject(EnvironmentInjector)
+    );
+    const results: number[] = [];
+    let destroyed = false;
+
+    const method = rxMethod<number>(
+      tap({
+        next: (value) => results.push(value),
+        finalize: () => (destroyed = true),
+      }),
+      { injector }
+    );
+
+    const subject$ = new BehaviorSubject(1);
+    const sig = signal(1);
+
+    method(subject$);
+    method(sig);
+    method(1);
+
+    TestBed.flushEffects();
+    expect(results).toEqual([1, 1, 1]);
+
+    injector.destroy();
+    expect(destroyed).toBe(true);
+
+    subject$.next(2);
+    sig.set(2);
+    method(2);
+
+    TestBed.flushEffects();
+    expect(results).toEqual([1, 1, 1]);
+  });
+
+  it('throws an error when it is called out of injection context', () => {
+    expect(() => rxMethod(($) => $)).toThrow(
+      /NG0203: rxMethod\(\) can only be used within an injection context/
+    );
+  });
 });
diff --git a/projects/ngrx.io/content/guide/component/push.md b/projects/ngrx.io/content/guide/component/push.md
@@ -24,14 +24,6 @@ import { PushPipe } from '@ngrx/component';
 export class MyStandaloneComponent {}
 ```
 
-<div class="alert is-critical">
-
-The `ngrxPush` pipe can be also used by importing the `PushModule`.
-However, the `PushModule` is deprecated in favor of the standalone `PushPipe`.
-See the [migration guide](guide/migration/v16#pushmodule) for more information.
-
-</div>
-
 ## Comparison with `async` Pipe
 
 The current way of binding an observable to the view looks like this:

diff --git a/projects/ngrx.io/content/guide/data/architecture-overview.md b/projects/ngrx.io/content/guide/data/architecture-overview.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Architecture overview
 
 You describe your entity model to NgRx Data in a few lines of [entity metadata](guide/data/entity-metadata) and let the library do the rest of the work.

diff --git a/projects/ngrx.io/content/guide/data/entity-actions.md b/projects/ngrx.io/content/guide/data/entity-actions.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Entity Actions
 
 The [`EntityCollectionService`](guide/data/entity-services) dispatches an `EntityAction` to the _NgRx store_ when you call one of its commands to query or update entities in a cached collection.

diff --git a/projects/ngrx.io/content/guide/data/entity-change-tracker.md b/projects/ngrx.io/content/guide/data/entity-change-tracker.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # EntityChangeTracker
 
 NgRx Data tracks entity changes that haven't yet been saved on the server.

diff --git a/projects/ngrx.io/content/guide/data/entity-collection-service.md b/projects/ngrx.io/content/guide/data/entity-collection-service.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # EntityCollectionService
 
 An **`EntityCollectionService`** is a facade over the NgRx Data **dispatcher** and **selectors$** that manages an entity `T` collection cached in the _NgRx store_.

diff --git a/projects/ngrx.io/content/guide/data/entity-collection.md b/projects/ngrx.io/content/guide/data/entity-collection.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Entity Collection
 
 The NgRx Data library maintains a _cache_ (`EntityCache`) of

diff --git a/projects/ngrx.io/content/guide/data/entity-dataservice.md b/projects/ngrx.io/content/guide/data/entity-dataservice.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Entity DataService
 
 The NgRx Data library expects to persist entity data with calls to a REST-like web api with endpoints for each entity type.

diff --git a/projects/ngrx.io/content/guide/data/entity-effects.md b/projects/ngrx.io/content/guide/data/entity-effects.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Entity Effects
 
 **Work in Progress**

diff --git a/projects/ngrx.io/content/guide/data/entity-metadata.md b/projects/ngrx.io/content/guide/data/entity-metadata.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Entity Metadata
 
 The NgRx Data library maintains a **_cache_** of entity collection data in the _NgRx store_.

diff --git a/projects/ngrx.io/content/guide/data/entity-reducer.md b/projects/ngrx.io/content/guide/data/entity-reducer.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Entity Reducer
 
 The _Entity Reducer_ is the _master reducer_ for all entity collections in the stored entity cache.

diff --git a/projects/ngrx.io/content/guide/data/entity-services.md b/projects/ngrx.io/content/guide/data/entity-services.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # EntityServices
 
 `EntityServices` is a facade over the NgRx Data services and the NgRx Data `EntityCache`.

diff --git a/projects/ngrx.io/content/guide/data/extension-points.md b/projects/ngrx.io/content/guide/data/extension-points.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Extension Points
 
 **Work in progress**

diff --git a/projects/ngrx.io/content/guide/data/faq.md b/projects/ngrx.io/content/guide/data/faq.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # NgRx Data FAQs
 
 <a id="no-boilerplate-claim"></a>

diff --git a/projects/ngrx.io/content/guide/data/index.md b/projects/ngrx.io/content/guide/data/index.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # @ngrx/data
 
 NgRx Data is an extension that offers a gentle introduction to NgRx by simplifying management of **entity data** while reducing the amount of explicitness.  

diff --git a/projects/ngrx.io/content/guide/data/install.md b/projects/ngrx.io/content/guide/data/install.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Installation
 
 ## Installing with `ng add`

diff --git a/projects/ngrx.io/content/guide/data/limitations.md b/projects/ngrx.io/content/guide/data/limitations.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # NgRx Data Limitations
 
 The NgRx Data library lacks many capabilities of a [full-featured entity management](#alternatives) system.

diff --git a/projects/ngrx.io/content/guide/data/save-entities.md b/projects/ngrx.io/content/guide/data/save-entities.md
@@ -1,3 +1,10 @@
+<div class="alert is-critical">
+
+The `@ngrx/data` package is in <a href="https://github.com/ngrx/platform/issues/4011" target="_blank">maintenance mode</a>.
+Changes to this package are limited to critical bug fixes.
+
+</div>
+
 # Saving Multiple Entities
 
 Many apps must save several entities at the same time in the same transaction.

diff --git a/projects/ngrx.io/content/guide/migration/v15.md b/projects/ngrx.io/content/guide/migration/v15.md
@@ -114,7 +114,7 @@ The `MinimalActivatedRouteSnapshot` interface contains the required `title` prop
 
 #### Removal of ReactiveComponentModule
 
-The `ReactiveComponentModule` is removed in favor of `LetModule` and [`PushModule`](/api/component/PushModule).
+The `ReactiveComponentModule` is removed in favor of `LetModule` and `PushModule`.
 
 BEFORE:
 

diff --git a/projects/ngrx.io/tools/transforms/templates/api/includes/ngmodule.html b/projects/ngrx.io/tools/transforms/templates/api/includes/ngmodule.html
@@ -1,11 +1,12 @@
-{% if doc.ngModules.length == 1 %}<h2>NgModule</h2>{% else %}<h2>NgModules</h2>{% endif %}
-<ul class="ngmodule-list">
-{% for ngModule in doc.ngModules %}
-  <li>
-    <a href="{$ ngModule.path $}">
-      <code-example language="ts" hideCopy="true" linenums="false" class="no-box">{$ ngModule.name | escape $}</code-example>
-    </a>
-  </li>
-  {% endfor %}
-</ul>
-
+{% if doc.ngModules.length %}
+  {% if doc.ngModules.length == 1 %}<h2>NgModule</h2>{% else %}<h2>NgModules</h2>{% endif %}
+  <ul class="ngmodule-list">
+  {% for ngModule in doc.ngModules %}
+    <li>
+      <a href="{$ ngModule.path $}">
+        <code-example language="ts" hideCopy="true" linenums="false" class="no-box">{$ ngModule.name | escape $}</code-example>
+      </a>
+    </li>
+    {% endfor %}
+  </ul>
+{% endif %}
-Original file line number
+Diff line change
@@ Expand Up @@
     #### Removal of ReactiveComponentModule
-    The `ReactiveComponentModule` is removed in favor of `LetModule` and [`PushModule`](/api/component/PushModule).
+    The `ReactiveComponentModule` is removed in favor of `LetModule` and `PushModule`.
     BEFORE:
@@ Expand Down @@