@augmentcode/ag-redux-toolkit
Version:
Redux + Saga state management for Svelte apps — designed for AI agents. Includes runtime TypeScript source, AI skills, and reference documentation for robust, observable, high-performance state management.
40 lines • 4.83 kB
TypeScript
export type Collection<ITEM extends object, K extends string & keyof ITEM> = ITEM[K] extends string ? {
idField: K & string;
ids: Array<ITEM[K]>;
map: Record<ITEM[K] & string, ITEM>;
refsCount: Record<ITEM[K], number>;
} : never;
export type RefsCounter<ITEM extends object, K extends ITEM[K] extends string ? keyof ITEM : never> = ITEM[K] extends string ? Record<ITEM[K], ITEM> : never;
export declare function createCollection<ITEM extends object, K extends keyof ITEM & string>(idFieldName: K, items?: ITEM[]): Collection<ITEM, K>;
export declare const collectionFieldsSet: Set<string>;
export declare function isCollection<ITEM extends object, K extends keyof ITEM & string>(item: object): item is Collection<ITEM, K>;
export declare function purgeCollection<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>): Collection<ITEM, K>;
export declare function addItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, newItem: ITEM): Collection<ITEM, K>;
/**
* Batch add function
* @param collection - The collection to add items to
* @param newItems - Array of items to add
* @returns New collection with items added (or original if no items were added)
*/
export declare function addItems<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, newItems: ITEM[]): Collection<ITEM, K>;
export declare function addItemAt<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, index: number, newItem: ITEM): Collection<ITEM, K>;
export declare function addItemAndCountRef<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, newItem: ITEM, index?: number): Collection<ITEM, K>;
export declare function upsertItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, updatedItem: ITEM): Collection<ITEM, K>;
export declare function upsertItemAndCountRef<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, newItem: ITEM): Collection<ITEM, K>;
export declare function updateItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, updatedItem: Partial<ITEM>): Collection<ITEM, K>;
export declare function replaceItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, originalItemId: ITEM[K] & string, updatedItem: ITEM): Collection<ITEM, K>;
export declare function replaceItems<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, replaceTuples: Array<[originalItemId: ITEM[K] & string, updatedItem: ITEM]>): Collection<ITEM, K>;
export declare function removeItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, itemId: ITEM[K]): Collection<ITEM, K>;
export declare function increaseRefsCount<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, itemId: ITEM[K]): Collection<ITEM, K>;
export declare function decreaseRefsCount<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, itemId: ITEM[K]): Collection<ITEM, K>;
export declare function filterCollection<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, filterFunction: (item: ITEM) => item is ITEM): Collection<ITEM, K>;
export declare function deduplicateCollection<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>): Collection<ITEM, K>;
export declare function getItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, itemId: ITEM[K] & string): ITEM | undefined;
export declare function getLastItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>): ITEM | undefined;
export declare function getItemIndex<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, itemId: ITEM[K]): number;
export declare function getItems<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>): ITEM[];
export declare function findItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, findFunction: (item: ITEM) => boolean): ITEM | undefined;
export declare function findLastItem<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, findFunction: (item: ITEM) => boolean): ITEM | undefined;
export declare function filterItems<T extends ITEM, ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, filterFunction: (item: ITEM) => item is T): T[];
export declare function getRefsCount<ITEM extends object, K extends keyof ITEM & string>(collection: Collection<ITEM, K>, itemId: ITEM[K] & string): number;
//# sourceMappingURL=collection-utils.d.ts.map