@nx/angular 21.0.0-beta.3 → 21.0.0-beta.5

package/src/runtime/nx/data-persistence.d.ts

@@ -1,276 +0,0 @@
-import type { Type } from '@angular/core';
-import type { ActivatedRouteSnapshot } from '@angular/router';
-import type { Action } from '@ngrx/store';
-import type { Observable } from 'rxjs';
-export interface PessimisticUpdateOpts<T extends Array<unknown>, A> {
-    run(a: A, ...slices: [...T]): Observable<Action> | Action | void;
-    onError(a: A, e: any): Observable<any> | any;
-}
-export interface OptimisticUpdateOpts<T extends Array<unknown>, A> {
-    run(a: A, ...slices: [...T]): Observable<Action> | Action | void;
-    undoAction(a: A, e: any): Observable<Action> | Action;
-}
-export interface FetchOpts<T extends Array<unknown>, A> {
-    id?(a: A, ...slices: [...T]): any;
-    run(a: A, ...slices: [...T]): Observable<Action> | Action | void;
-    onError?(a: A, e: any): Observable<any> | any;
-}
-export interface HandleNavigationOpts<T extends Array<unknown>> {
-    run(a: ActivatedRouteSnapshot, ...slices: [...T]): Observable<Action> | Action | void;
-    onError?(a: ActivatedRouteSnapshot, e: any): Observable<any> | any;
-}
-export type ActionOrActionWithStates<T extends Array<unknown>, A> = A | [A, ...T];
-export type ActionOrActionWithState<T, A> = ActionOrActionWithStates<[T], A>;
-export type ActionStatesStream<T extends Array<unknown>, A> = Observable<ActionOrActionWithStates<T, A>>;
-export type ActionStateStream<T, A> = Observable<ActionOrActionWithStates<[T], A>>;
-/**
- * @whatItDoes Handles pessimistic updates (updating the server first).
- *
- * Updating the server, when implemented naively, suffers from race conditions and poor error handling.
- *
- * `pessimisticUpdate` addresses these problems. It runs all fetches in order, which removes race conditions
- * and forces the developer to handle errors.
- *
- * ## Example:
- *
- * ```typescript
- * @Injectable()
- * class TodoEffects {
- *   updateTodo$ = createEffect(() =>
- *     this.actions$.pipe(
- *       ofType('UPDATE_TODO'),
- *       pessimisticUpdate({
- *         // provides an action
- *         run: (action: UpdateTodo) => {
- *           // update the backend first, and then dispatch an action that will
- *           // update the client side
- *           return this.backend.updateTodo(action.todo.id, action.todo).pipe(
- *             map((updated) => ({
- *               type: 'UPDATE_TODO_SUCCESS',
- *               todo: updated,
- *             }))
- *           );
- *         },
- *         onError: (action: UpdateTodo, error: any) => {
- *           // we don't need to undo the changes on the client side.
- *           // we can dispatch an error, or simply log the error here and return `null`
- *           return null;
- *         },
- *       })
- *     )
- *   );
- *
- *   constructor(private actions$: Actions, private backend: Backend) {}
- * }
- * ```
- *
- * Note that if you don't return a new action from the run callback, you must set the dispatch property
- * of the effect to false, like this:
- *
- * ```typescript
- * class TodoEffects {
- *   updateTodo$ = createEffect(() =>
- *     this.actions$.pipe(
- *       //...
- *     ), { dispatch: false }
- *   );
- * }
- * ```
- *
- * @param opts
- *
- * @deprecated This will be removed in Nx v21. Import `pessimisticUpdate` from `@ngrx/router-store/data-persistence` instead.
- */
-export declare function pessimisticUpdate<T extends Array<unknown>, A extends Action>(opts: PessimisticUpdateOpts<T, A>): (source: ActionStatesStream<T, A>) => Observable<Action>;
-/**
- * @whatItDoes Handles optimistic updates (updating the client first).
- *
- * It runs all fetches in order, which removes race conditions and forces the developer to handle errors.
- *
- * When using `optimisticUpdate`, in case of a failure, the developer has already updated the state locally,
- * so the developer must provide an undo action.
- *
- * The error handling must be done in the callback, or by means of the undo action.
- *
- * ## Example:
- *
- * ```typescript
- * @Injectable()
- * class TodoEffects {
- *   updateTodo$ = createEffect(() =>
- *     this.actions$.pipe(
- *       ofType('UPDATE_TODO'),
- *       optimisticUpdate({
- *         // provides an action
- *         run: (action: UpdateTodo) => {
- *           return this.backend.updateTodo(action.todo.id, action.todo).pipe(
- *             mapTo({
- *               type: 'UPDATE_TODO_SUCCESS',
- *             })
- *           );
- *         },
- *         undoAction: (action: UpdateTodo, error: any) => {
- *           // dispatch an undo action to undo the changes in the client state
- *           return {
- *             type: 'UNDO_TODO_UPDATE',
- *             todo: action.todo,
- *           };
- *         },
- *       })
- *     )
- *   );
- *
- *   constructor(private actions$: Actions, private backend: Backend) {}
- * }
- * ```
- *
- * Note that if you don't return a new action from the run callback, you must set the dispatch property
- * of the effect to false, like this:
- *
- * ```typescript
- * class TodoEffects {
- *   updateTodo$ = createEffect(() =>
- *     this.actions$.pipe(
- *       //...
- *     ), { dispatch: false }
- *   );
- * }
- * ```
- *
- * @param opts
- *
- * @deprecated This will be removed in Nx v21. Import `optimisticUpdate` from `@ngrx/router-store/data-persistence` instead.
- */
-export declare function optimisticUpdate<T extends Array<unknown>, A extends Action>(opts: OptimisticUpdateOpts<T, A>): (source: ActionStatesStream<T, A>) => Observable<Action>;
-/**
- * @whatItDoes Handles data fetching.
- *
- * Data fetching implemented naively suffers from race conditions and poor error handling.
- *
- * `fetch` addresses these problems. It runs all fetches in order, which removes race conditions
- * and forces the developer to handle errors.
- *
- * ## Example:
- *
- * ```typescript
- * @Injectable()
- * class TodoEffects {
- *   loadTodos$ = createEffect(() =>
- *     this.actions$.pipe(
- *       ofType('GET_TODOS'),
- *       fetch({
- *         // provides an action
- *         run: (a: GetTodos) => {
- *           return this.backend.getAll().pipe(
- *             map((response) => ({
- *               type: 'TODOS',
- *               todos: response.todos,
- *             }))
- *           );
- *         },
- *         onError: (action: GetTodos, error: any) => {
- *           // dispatch an undo action to undo the changes in the client state
- *           return null;
- *         },
- *       })
- *     )
- *   );
- *
- *   constructor(private actions$: Actions, private backend: Backend) {}
- * }
- * ```
- *
- * This is correct, but because it set the concurrency to 1, it may not be performant.
- *
- * To fix that, you can provide the `id` function, like this:
- *
- * ```typescript
- * @Injectable()
- * class TodoEffects {
- *   loadTodo$ = createEffect(() =>
- *     this.actions$.pipe(
- *       ofType('GET_TODO'),
- *       fetch({
- *         id: (todo: GetTodo) => {
- *           return todo.id;
- *         },
- *         // provides an action
- *         run: (todo: GetTodo) => {
- *           return this.backend.getTodo(todo.id).map((response) => ({
- *             type: 'LOAD_TODO_SUCCESS',
- *             todo: response.todo,
- *           }));
- *         },
- *         onError: (action: GetTodo, error: any) => {
- *           // dispatch an undo action to undo the changes in the client state
- *           return null;
- *         },
- *       })
- *     )
- *   );
- *
- *   constructor(private actions$: Actions, private backend: Backend) {}
- * }
- * ```
- *
- * With this setup, the requests for Todo 1 will run concurrently with the requests for Todo 2.
- *
- * In addition, if there are multiple requests for Todo 1 scheduled, it will only run the last one.
- *
- * @param opts
- *
- * @deprecated This will be removed in Nx v21. Import `fetch` from `@ngrx/router-store/data-persistence` instead.
- */
-export declare function fetch<T extends Array<unknown>, A extends Action>(opts: FetchOpts<T, A>): (source: ActionStatesStream<T, A>) => Observable<Action>;
-/**
- * @whatItDoes Handles data fetching as part of router navigation.
- *
- * Data fetching implemented naively suffers from race conditions and poor error handling.
- *
- * `navigation` addresses these problems.
- *
- * It checks if an activated router state contains the passed in component type, and, if it does, runs the `run`
- * callback. It provides the activated snapshot associated with the component and the current state. And it only runs
- * the last request.
- *
- * ## Example:
- *
- * ```typescript
- * @Injectable()
- * class TodoEffects {
- *   loadTodo$ = createEffect(() =>
- *     this.actions$.pipe(
- *       // listens for the routerNavigation action from @ngrx/router-store
- *       navigation(TodoComponent, {
- *         run: (activatedRouteSnapshot: ActivatedRouteSnapshot) => {
- *           return this.backend
- *             .fetchTodo(activatedRouteSnapshot.params['id'])
- *             .pipe(
- *               map((todo) => ({
- *                 type: 'LOAD_TODO_SUCCESS',
- *                 todo: todo,
- *               }))
- *             );
- *         },
- *         onError: (
- *           activatedRouteSnapshot: ActivatedRouteSnapshot,
- *           error: any
- *         ) => {
- *           // we can log and error here and return null
- *           // we can also navigate back
- *           return null;
- *         },
- *       })
- *     )
- *   );
- *
- *   constructor(private actions$: Actions, private backend: Backend) {}
- * }
- * ```
- *
- * @param component
- * @param opts
- *
- * @deprecated This will be removed in Nx v21. Import `navigation` from `@ngrx/router-store/data-persistence` instead.
- */
-export declare function navigation<T extends Array<unknown>, A extends Action>(component: Type<any>, opts: HandleNavigationOpts<T>): (source: ActionStatesStream<T, A>) => Observable<Action<string>>;

package/testing/index.d.ts

@@ -1 +0,0 @@
-export { readAll, readFirst } from './src/testing-utils';

package/testing/ng-package.json

@@ -1,6 +0,0 @@
-{
-  "$schema": "../../../node_modules/ng-packagr/ng-package.schema.json",
-  "lib": {
-    "entryFile": "index.ts"
-  }
-}

package/testing/src/testing-utils.d.ts

@@ -1,33 +0,0 @@
-import type { Observable } from 'rxjs';
-/**
- * @deprecated This will be removed in Nx v21. If using RxJS 7, use `firstValueFrom(obs$.pipe(toArray()))`
- * or `lastValueFrom(obs$.pipe(toArray()))`. If using RxJS 6, use `obs$.pipe(toArray()).toPromise()`.
- *
- * @whatItDoes reads all the values from an observable and returns a promise
- * with an array of all values. This should be used in combination with async/await.
- *
- * ## Example
- *
- * ```typescript
- * const obs = of(1, 2, 3, 4);
- * const res = await readAll(obs)
- * expect(res).toEqual([1, 2, 3, 4]);
- * ```
- */
-export declare function readAll<T>(o: Observable<T>): Promise<T[]>;
-/**
- * @deprecated This will be removed in Nx v21. Since RxJS 7, use `firstValueFrom(obs$)`. If using RxJS 6,
- * use `obs$.pipe(first()).toPromise()`.
- *
- * @whatItDoes reads the first value from an observable and returns a promise
- * with it. This should be used in combination with async/await.
- *
- * ## Example
- *
- * ```typescript
- * const obs = of(1, 2, 3, 4);
- * const res = await readFirst(obs)
- * expect(res).toEqual(1);
- * ```
- */
-export declare function readFirst<T>(o: Observable<T>): Promise<T>;