mirror of
https://github.com/bitwarden/browser
synced 2025-12-14 15:23:33 +00:00
[PM-7289] implement generator libraries (#9549)
This is a copy of the files. The source in `@bitwarden/common` will be deleted once all of the applications have been ported to the library.
This commit is contained in:
@@ -4,9 +4,9 @@ import { PolicyService } from "../../../admin-console/abstractions/policy/policy
|
||||
import { PolicyType } from "../../../admin-console/enums";
|
||||
import { StateProvider } from "../../../platform/state";
|
||||
import { UserId } from "../../../types/guid";
|
||||
import { distinctIfShallowMatch, reduceCollection } from "../../rx";
|
||||
import { GeneratorNavigationService } from "../abstractions/generator-navigation.service.abstraction";
|
||||
import { GENERATOR_SETTINGS } from "../key-definitions";
|
||||
import { distinctIfShallowMatch, reduceCollection } from "../rx-operators";
|
||||
|
||||
import { DefaultGeneratorNavigation, GeneratorNavigation } from "./generator-navigation";
|
||||
import { GeneratorNavigationEvaluator } from "./generator-navigation-evaluator";
|
||||
|
||||
@@ -1,45 +1,10 @@
|
||||
import { distinctUntilChanged, map, OperatorFunction, pipe } from "rxjs";
|
||||
import { map, pipe } from "rxjs";
|
||||
|
||||
import { reduceCollection, distinctIfShallowMatch } from "@bitwarden/common/tools/rx";
|
||||
|
||||
import { DefaultPolicyEvaluator } from "./default-policy-evaluator";
|
||||
import { PolicyConfiguration } from "./policies";
|
||||
|
||||
/**
|
||||
* An observable operator that reduces an emitted collection to a single object,
|
||||
* returning a default if all items are ignored.
|
||||
* @param reduce The reduce function to apply to the filtered collection. The
|
||||
* first argument is the accumulator, and the second is the current item. The
|
||||
* return value is the new accumulator.
|
||||
* @param defaultValue The default value to return if the collection is empty. The
|
||||
* default value is also the initial value of the accumulator.
|
||||
*/
|
||||
export function reduceCollection<Item, Accumulator>(
|
||||
reduce: (acc: Accumulator, value: Item) => Accumulator,
|
||||
defaultValue: Accumulator,
|
||||
): OperatorFunction<Item[], Accumulator> {
|
||||
return map((values: Item[]) => {
|
||||
const reduced = (values ?? []).reduce(reduce, structuredClone(defaultValue));
|
||||
return reduced;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* An observable operator that emits distinct values by checking that all
|
||||
* values in the previous entry match the next entry. This method emits
|
||||
* when a key is added and does not when a key is removed.
|
||||
* @remarks This method checks objects. It does not check items in arrays.
|
||||
*/
|
||||
export function distinctIfShallowMatch<Item>(): OperatorFunction<Item, Item> {
|
||||
return distinctUntilChanged((previous, current) => {
|
||||
let isDistinct = true;
|
||||
|
||||
for (const key in current) {
|
||||
isDistinct &&= previous[key] === current[key];
|
||||
}
|
||||
|
||||
return isDistinct;
|
||||
});
|
||||
}
|
||||
|
||||
/** Maps an administrative console policy to a policy evaluator using the provided configuration.
|
||||
* @param configuration the configuration that constructs the evaluator.
|
||||
*/
|
||||
|
||||
@@ -2,12 +2,11 @@
|
||||
* include structuredClone in test environment.
|
||||
* @jest-environment ../../../../shared/test.environment.ts
|
||||
*/
|
||||
|
||||
import { of, firstValueFrom } from "rxjs";
|
||||
|
||||
import { awaitAsync, trackEmissions } from "../../../spec";
|
||||
import { awaitAsync, trackEmissions } from "../../spec";
|
||||
|
||||
import { distinctIfShallowMatch, reduceCollection } from "./rx-operators";
|
||||
import { distinctIfShallowMatch, reduceCollection } from "./rx";
|
||||
|
||||
describe("reduceCollection", () => {
|
||||
it.each([[null], [undefined], [[]]])(
|
||||
38
libs/common/src/tools/rx.ts
Normal file
38
libs/common/src/tools/rx.ts
Normal file
@@ -0,0 +1,38 @@
|
||||
import { map, distinctUntilChanged, OperatorFunction } from "rxjs";
|
||||
|
||||
/**
|
||||
* An observable operator that reduces an emitted collection to a single object,
|
||||
* returning a default if all items are ignored.
|
||||
* @param reduce The reduce function to apply to the filtered collection. The
|
||||
* first argument is the accumulator, and the second is the current item. The
|
||||
* return value is the new accumulator.
|
||||
* @param defaultValue The default value to return if the collection is empty. The
|
||||
* default value is also the initial value of the accumulator.
|
||||
*/
|
||||
export function reduceCollection<Item, Accumulator>(
|
||||
reduce: (acc: Accumulator, value: Item) => Accumulator,
|
||||
defaultValue: Accumulator,
|
||||
): OperatorFunction<Item[], Accumulator> {
|
||||
return map((values: Item[]) => {
|
||||
const reduced = (values ?? []).reduce(reduce, structuredClone(defaultValue));
|
||||
return reduced;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* An observable operator that emits distinct values by checking that all
|
||||
* values in the previous entry match the next entry. This method emits
|
||||
* when a key is added and does not when a key is removed.
|
||||
* @remarks This method checks objects. It does not check items in arrays.
|
||||
*/
|
||||
export function distinctIfShallowMatch<Item>(): OperatorFunction<Item, Item> {
|
||||
return distinctUntilChanged((previous, current) => {
|
||||
let isDistinct = true;
|
||||
|
||||
for (const key in current) {
|
||||
isDistinct &&= previous[key] === current[key];
|
||||
}
|
||||
|
||||
return isDistinct;
|
||||
});
|
||||
}
|
||||
Reference in New Issue
Block a user