ngx-transforms 0.1.0 → 0.2.0

package/types/ngx-transforms.d.ts

@@ -193,22 +193,6 @@ declare class MorseCodePipe implements PipeTransform {
  * @param {boolean} [isReplace=true] - Whether to perform replacement (true) or only highlight matches (false).
  *
  * @returns {string | SafeHtml} - Returns the transformed string or SafeHtml with highlights.
- *
- * @example
- * {{ 'Hello World' | replace:'World':'Universe' }}
- * // Output: Hello Universe
- *
- * {{ 'test123' | replace:/\d+/g:'X':'highlight' }}
- * // Output: test<span class="highlight">X</span>
- *
- * {{ 'Angular is great' | replace:'great':'awesome':'highlight':true }}
- * // Output: Angular is <span class="highlight">awesome</span>
- *
- * {{ 'Angular is great' | replace:'great':'awesome':'highlight':false }}
- * // Output: Angular is <span class="highlight">great</span>
- *
- * <div [innerHTML]="'Angular is great' | replace:'great':'awesome':'highlight':false"></div>
- * // Renders: Angular is <span class="highlight">great</span>
  */
 declare class ReplacePipe implements PipeTransform {
     private sanitizer;
@@ -639,6 +623,93 @@ declare class TimeAgoPipePipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<TimeAgoPipePipe, "timeAgo", true>;
 }
 
+/**
+ * DiffPipe: Returns elements present in the first array but not in the second.
+ *
+ * Supports primitives and objects by property key with dot notation.
+ *
+ * @param {unknown[]} value - The source array.
+ * @param {unknown[]} compared - The array to compare against.
+ * @param {string} [key] - Optional property path for object comparison (supports dot notation).
+ *
+ * @returns {unknown[]} - Elements in value that are not in compared.
+ *
+ * @example
+ * {{ [1, 2, 3, 4, 5] | diff:[3, 4, 5, 6] }}              // [1, 2]
+ * {{ allUsers | diff:activeUsers:'id' }}                    // inactive users
+ * {{ orders | diff:shipped:'meta.trackingId' }}             // unshipped orders
+ */
+declare class DiffPipe implements PipeTransform {
+    transform(value: unknown[], compared: unknown[], key?: string): unknown[];
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<DiffPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<DiffPipe, "diff", true>;
+}
+
+/**
+ * EveryPipe: Checks if all elements in an array satisfy a condition.
+ *
+ * Supports primitives (equality check) and objects by property key with dot notation.
+ *
+ * @param {unknown[]} value - The array to check.
+ * @param {unknown} match - The value to match against.
+ * @param {string} [key] - Optional property path to check (supports dot notation).
+ *
+ * @returns {boolean} - True if all elements match, false otherwise.
+ *
+ * @example
+ * {{ [true, true, true] | every:true }}                     // true
+ * {{ users | every:'active':'status' }}                     // are all users active?
+ * {{ orders | every:'shipped':'meta.state' }}               // are all orders shipped?
+ */
+declare class EveryPipe implements PipeTransform {
+    transform(value: unknown[], match: unknown, key?: string): boolean;
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EveryPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<EveryPipe, "every", true>;
+}
+
+/**
+ * IntersectionPipe: Returns elements common to both arrays.
+ *
+ * Supports primitives and objects by property key with dot notation.
+ *
+ * @param {unknown[]} value - The first array.
+ * @param {unknown[]} compared - The second array.
+ * @param {string} [key] - Optional property path for object comparison (supports dot notation).
+ *
+ * @returns {unknown[]} - Elements present in both arrays.
+ *
+ * @example
+ * {{ [1, 2, 3, 4] | intersection:[3, 4, 5, 6] }}              // [3, 4]
+ * {{ teamA | intersection:teamB:'id' }}                         // shared members
+ * {{ required | intersection:granted:'meta.scope' }}            // matched permissions
+ */
+declare class IntersectionPipe implements PipeTransform {
+    transform(value: unknown[], compared: unknown[], key?: string): unknown[];
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IntersectionPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<IntersectionPipe, "intersection", true>;
+}
+
+/**
+ * ChunkPipe: Splits an array into smaller arrays of a specified size.
+ *
+ * @param {unknown[]} value - The array to split.
+ * @param {number} [size=1] - The size of each chunk.
+ *
+ * @returns {unknown[][]} - An array of chunks.
+ *
+ * @example
+ * {{ [1, 2, 3, 4, 5] | chunk:2 }}     // [[1, 2], [3, 4], [5]]
+ * {{ [1, 2, 3, 4, 5, 6] | chunk:3 }}  // [[1, 2, 3], [4, 5, 6]]
+ */
+declare class ChunkPipe implements PipeTransform {
+    transform(value: unknown[], size?: number): unknown[][];
+    static ɵfac: i0.ɵɵFactoryDeclaration<ChunkPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<ChunkPipe, "chunk", true>;
+}
+
 /**
  * FlattenPipe: Flattens nested arrays to a specified depth.
  *
@@ -658,6 +729,25 @@ declare class Flatten implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<Flatten, "flatten", true>;
 }
 
+/**
+ * GroupByPipe: Groups array elements by a property value.
+ *
+ * @param {unknown[]} value - The array to group.
+ * @param {string} key - Property path to group by (supports dot notation).
+ *
+ * @returns {Record<string, unknown[]>} - An object where keys are group names and values are arrays.
+ *
+ * @example
+ * {{ users | groupBy:'role' }}              // { admin: [...], editor: [...] }
+ * {{ orders | groupBy:'customer.city' }}    // { 'New York': [...], 'London': [...] }
+ */
+declare class GroupByPipe implements PipeTransform {
+    transform(value: unknown[], key: string): Record<string, unknown[]>;
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<GroupByPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<GroupByPipe, "groupBy", true>;
+}
+
 /**
  * InitialPipe: Returns all elements except the last n.
  *
@@ -677,6 +767,66 @@ declare class InitialPipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<InitialPipe, "initial", true>;
 }
 
+/**
+ * OrderByPipe: Sorts an array by a property value.
+ *
+ * @param {unknown[]} value - The array to sort.
+ * @param {string} key - Property path to sort by (supports dot notation).
+ * @param {string} [direction='asc'] - Sort direction: 'asc' or 'desc'.
+ *
+ * @returns {unknown[]} - A new sorted array.
+ *
+ * @example
+ * {{ users | orderBy:'name' }}            // sorted A-Z
+ * {{ users | orderBy:'name':'desc' }}     // sorted Z-A
+ * {{ users | orderBy:'age':'asc' }}       // sorted by age
+ */
+declare class OrderByPipe implements PipeTransform {
+    transform(value: unknown[], key: string, direction?: 'asc' | 'desc'): unknown[];
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OrderByPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<OrderByPipe, "orderBy", true>;
+}
+
+/**
+ * PluckPipe: Extracts a property value from every object in an array.
+ *
+ * @param {unknown[]} value - The array of objects.
+ * @param {string} key - Property path to extract (supports dot notation).
+ *
+ * @returns {unknown[]} - An array of the extracted values.
+ *
+ * @example
+ * {{ users | pluck:'name' }}                // ['Alice', 'Bob', 'Carol']
+ * {{ orders | pluck:'customer.email' }}     // ['a@test.com', 'b@test.com']
+ */
+declare class PluckPipe implements PipeTransform {
+    transform(value: unknown[], key: string): unknown[];
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PluckPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<PluckPipe, "pluck", true>;
+}
+
+/**
+ * RangePipe: Generates a numeric sequence array.
+ *
+ * @param {number} value - The number of items to generate (or the end value when start is provided).
+ * @param {number} [start=0] - The starting number.
+ * @param {number} [step=1] - The increment between each number.
+ *
+ * @returns {number[]} - An array of sequential numbers.
+ *
+ * @example
+ * {{ 5 | range }}            // [0, 1, 2, 3, 4]
+ * {{ 5 | range:1 }}          // [1, 2, 3, 4, 5]
+ * {{ 10 | range:0:2 }}       // [0, 2, 4, 6, 8]
+ */
+declare class RangePipe implements PipeTransform {
+    transform(value: number, start?: number, step?: number): number[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<RangePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<RangePipe, "range", true>;
+}
+
 /**
  * ReversePipe: Reverses the characters in a string.
  *
@@ -805,7 +955,100 @@ declare class UniquePipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<UniquePipe, "unique", true>;
 }
 
+/**
+ * WithoutPipe: Excludes specified elements from an array.
+ *
+ * Supports primitives and objects by property key with dot notation.
+ *
+ * @param {unknown[]} value - The array to filter.
+ * @param {unknown[]} excludes - Values to exclude.
+ * @param {string} [key] - Optional property path for object comparison (supports dot notation).
+ *
+ * @returns {unknown[]} - A new array without the excluded elements.
+ *
+ * @example
+ * {{ [1, 2, 3, 4, 5] | without:[2, 4] }}                   // [1, 3, 5]
+ * {{ users | without:['banned']:'status' }}                  // active users
+ * {{ orders | without:['cancelled']:'meta.status' }}         // non-cancelled orders
+ */
+declare class WithoutPipe implements PipeTransform {
+    transform(value: unknown[], excludes: unknown[], key?: string): unknown[];
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<WithoutPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<WithoutPipe, "without", true>;
+}
+
+/**
+ * SomePipe: Checks if at least one element in an array satisfies a condition.
+ *
+ * Supports primitives (equality check) and objects by property key with dot notation.
+ *
+ * @param {unknown[]} value - The array to check.
+ * @param {unknown} match - The value to match against.
+ * @param {string} [key] - Optional property path to check (supports dot notation).
+ *
+ * @returns {boolean} - True if at least one element matches, false otherwise.
+ *
+ * @example
+ * {{ [false, false, true] | some:true }}                    // true
+ * {{ users | some:'admin':'role' }}                          // any admins?
+ * {{ orders | some:'failed':'meta.status' }}                 // any failures?
+ */
+declare class SomePipe implements PipeTransform {
+    transform(value: unknown[], match: unknown, key?: string): boolean;
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SomePipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<SomePipe, "some", true>;
+}
+
+/**
+ * UnionPipe: Combines two arrays, keeping only unique elements.
+ *
+ * Supports primitives and objects by property key with dot notation.
+ *
+ * @param {unknown[]} value - The first array.
+ * @param {unknown[]} other - The second array.
+ * @param {string} [key] - Optional property path for uniqueness check (supports dot notation).
+ *
+ * @returns {unknown[]} - A merged array with duplicates removed.
+ *
+ * @example
+ * {{ [1, 2, 3] | union:[3, 4, 5] }}                        // [1, 2, 3, 4, 5]
+ * {{ admins | union:editors:'id' }}                          // all unique users
+ * {{ local | union:remote:'meta.uuid' }}                     // merged records
+ */
+declare class UnionPipe implements PipeTransform {
+    transform(value: unknown[], other: unknown[], key?: string): unknown[];
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<UnionPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<UnionPipe, "union", true>;
+}
+
+/**
+ * FilterByPipe: Filters an array by matching a search term against object
+ properties.
+ *
+ * @param {unknown[]} value - The array to filter.
+ * @param {string} search - The search term.
+ * @param {string} [key] - Property to search in. If omitted, searches all string
+ properties.
+ *
+ * @returns {unknown[]} - Filtered array with matching items.
+ *
+ * @example
+ * {{ users | filterBy:'alice':'name' }}     // users with 'alice' in name
+ * {{ users | filterBy:'admin':'role' }}     // users with role 'admin'
+ * {{ users | filterBy:'bob' }}              // search all properties for 'bob'
+ */
+declare class FilterByPipe implements PipeTransform {
+    transform(value: unknown[], search: string, key?: string): unknown[];
+    private searchObject;
+    private getNestedValue;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FilterByPipe, never>;
+    static ɵpipe: i0.ɵɵPipeDeclaration<FilterByPipe, "filterBy", true>;
+}
+
 declare const ALL_PIPES: Provider[];
 
-export { ALL_PIPES, AsciiArtPipe, BarcodePipe, CamelCasePipe, ColorConvertPipe, CountPipe, CreditCardMaskPipe, DeviceTypePipe, EmailMaskPipe, Flatten, GravatarPipe, HighlightPipe, HtmlEscapePipe, HtmlSanitizePipe, InitialPipe, InitialsPipe, IpAddressMaskPipe, JsonPrettyPipe, KebabCasePipe, MorseCodePipe, QrCodePipe, ReplacePipe, ReversePipe, SamplePipe, ShufflePipe, SnakeCasePipe, TailPipe, TextToSpeechPipe, TimeAgoPipePipe, TitleCasePipe, TruncatePipe, TruthifyPipe, UniquePipe };
+export { ALL_PIPES, AsciiArtPipe, BarcodePipe, CamelCasePipe, ChunkPipe, ColorConvertPipe, CountPipe, CreditCardMaskPipe, DeviceTypePipe, DiffPipe, EmailMaskPipe, EveryPipe, FilterByPipe, Flatten, GravatarPipe, GroupByPipe, HighlightPipe, HtmlEscapePipe, HtmlSanitizePipe, InitialPipe, InitialsPipe, IntersectionPipe, IpAddressMaskPipe, JsonPrettyPipe, KebabCasePipe, MorseCodePipe, OrderByPipe, PluckPipe, QrCodePipe, RangePipe, ReplacePipe, ReversePipe, SamplePipe, ShufflePipe, SnakeCasePipe, SomePipe, TailPipe, TextToSpeechPipe, TimeAgoPipePipe, TitleCasePipe, TruncatePipe, TruthifyPipe, UnionPipe, UniquePipe, WithoutPipe };
 export type { AsciiArtOptions, BarcodeElementType, BarcodeFormat, BarcodeOptions, ColorTargetType, DeviceType, QrCodeOptions };