cry-search 1.0.7 → 2.0.0

package/dist/common/string/updateSearchMetadata.d.ts

@@ -1,103 +0,0 @@
-import type { Id, SearchMetadata, SearchableObject, SearchableObjectSpec, UpdateSearchMetadataBatchItem } from '../../types';
-export type { UpdateSearchMetadataBatchItem } from '../../types';
-/**
- * Updates search metadata for a single object.
- *
- * This function handles updates, additions, and removals:
- * - If the object is `null` or `undefined`, removes it from metadata
- * - If the object is `_deleted` or `_blocked`, removes it from metadata
- * - Otherwise, computes new tokens and updates/adds to metadata
- *
- * The metadata map is mutated in place for efficiency.
- *
- * @typeParam T - Type of the searchable object
- * @typeParam C - Type of the search context
- *
- * @param metadata - The SearchMetadata map to update (mutated in place)
- * @param objectId - The ID of the object to update
- * @param obj - The object (may be null, undefined, deleted, or blocked)
- * @param spec - Optional specification for how to extract searchable text
- * @returns true if metadata was added/updated, false if removed
- *
- * @example
- * ```typescript
- * // Update an existing item
- * const product = { _id: '1', name: 'Updated Product' };
- * updateSearchMetadata(metadata, '1', product, spec);
- *
- * // Mark an item as deleted (removes from search)
- * const deletedProduct = { _id: '1', name: 'Product', _deleted: new Date() };
- * updateSearchMetadata(metadata, '1', deletedProduct, spec);  // returns false
- *
- * // Remove by passing null/undefined
- * updateSearchMetadata(metadata, '1', null, spec);  // returns false
- * ```
- */
-export declare function updateSearchMetadata<T extends SearchableObject, C = unknown>(metadata: SearchMetadata, objectId: Id, obj: T | null | undefined, spec?: SearchableObjectSpec<T, C>): boolean;
-/**
- * Updates search metadata for multiple objects in a batch.
- *
- * More efficient than calling {@link updateSearchMetadata} repeatedly
- * when you have multiple objects to update at once.
- *
- * - For objects that are `_deleted` or `_blocked`, removes them from metadata
- * - For other objects, updates or adds their tokens to metadata
- *
- * @typeParam T - Type of the searchable objects
- * @typeParam C - Type of the search context
- *
- * @param metadata - The SearchMetadata map to update (mutated in place)
- * @param batch - Array of objects to update
- * @param spec - Optional specification for how to extract searchable text
- * @returns Object with counts of added/updated and removed items
- *
- * @example
- * ```typescript
- * const batch = [
- *   { objectId: '1', obj: { _id: '1', name: 'Product 1' } },
- *   { objectId: '2', obj: { _id: '2', name: 'Product 2', _deleted: new Date() } },
- * ];
- *
- * const result = updateSearchMetadataBatch(metadata, batch, spec);
- * // result: { updated: 1, removed: 1 }
- * ```
- */
-export declare function updateSearchMetadataBatch<T extends SearchableObject, C = unknown>(metadata: SearchMetadata, batch: UpdateSearchMetadataBatchItem<T>[], spec?: SearchableObjectSpec<T, C>): {
-    updated: number;
-    removed: number;
-};
-/**
- * Removes an object from search metadata by ID.
- *
- * Use this when you want to explicitly remove an object without having the full object.
- * For updates where you have the object (including deleting by setting `_deleted`),
- * use {@link updateSearchMetadata} instead.
- *
- * @param metadata - The SearchMetadata map to update (mutated in place)
- * @param objectId - The ID of the object to remove
- * @returns true if the object was found and removed, false if it wasn't in metadata
- *
- * @example
- * ```typescript
- * removeFromSearchMetadata(metadata, 'object-id-to-remove');
- * ```
- */
-export declare function removeFromSearchMetadata(metadata: SearchMetadata, objectId: Id): boolean;
-/**
- * Removes multiple objects from search metadata by IDs.
- *
- * More efficient than calling {@link removeFromSearchMetadata} repeatedly
- * when you have multiple IDs to remove.
- *
- * @param metadata - The SearchMetadata map to update (mutated in place)
- * @param objectIds - Array of IDs to remove
- * @returns Number of objects that were actually removed (may be less than objectIds.length)
- *
- * @example
- * ```typescript
- * const removed = removeFromSearchMetadataBatch(metadata, ['id1', 'id2', 'id3']);
- * console.log(`Removed ${removed} items from metadata`);
- * ```
- */
-export declare function removeFromSearchMetadataBatch(metadata: SearchMetadata, objectIds: Id[]): number;
-//# sourceMappingURL=updateSearchMetadata.d.ts.map

package/dist/common/string/updateSearchMetadata.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"updateSearchMetadata.d.ts","sourceRoot":"","sources":["../../../src/common/string/updateSearchMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,EAAE,EACF,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,6BAA6B,EAC9B,MAAM,aAAa,CAAC;AAIrB,YAAY,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,EAAE,CAAC,GAAG,OAAO,EAC1E,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,EAAE,EACZ,GAAG,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EACzB,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAChC,OAAO,CAYT;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,yBAAyB,CAAC,CAAC,SAAS,gBAAgB,EAAE,CAAC,GAAG,OAAO,EAC/E,QAAQ,EAAE,cAAc,EACxB,KAAK,EAAE,6BAA6B,CAAC,CAAC,CAAC,EAAE,EACzC,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAChC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAkBtC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,wBAAwB,CACtC,QAAQ,EAAE,cAAc,EACxB,QAAQ,EAAE,EAAE,GACX,OAAO,CAET;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,cAAc,EACxB,SAAS,EAAE,EAAE,EAAE,GACd,MAAM,CAYR"}

package/dist/common/syncSearchArrayMetadata.d.ts

@@ -1,68 +0,0 @@
-import type { SearchMetadata, SearchableData, SearchableObject, SearchableObjectSpec, SyncResult, SyncOptions } from '../types';
-export type { SyncResult, SyncOptions } from '../types';
-/**
- * Syncs string-based search metadata with new data.
- *
- * LEGACY: Use syncSearchArrayMetadataNumeric for new code.
- *
- * This function performs a full sync of metadata against the provided data:
- * - Adds metadata for new items
- * - Removes metadata for items no longer in data (or marked `_deleted`/`_blocked`)
- * - Updates metadata for items whose tokens have changed
- *
- * Use this when you have completely new data to sync with. If you have both
- * previous and new data available, use {@link syncSearchArrayMetadataStringWithPrevious}
- * for more efficient diffing.
- *
- * @typeParam T - Type of the searchable objects
- * @typeParam C - Type of the search context
- *
- * @param metadata - The SearchMetadata map to update (mutated in place)
- * @param newData - The new data to sync with
- * @param spec - Optional specification for how to extract searchable text
- * @returns SyncResult with counts and IDs of added/updated/removed items
- *
- * @example
- * ```typescript
- * const newProducts = arrayToSearchableData(freshProductsFromServer);
- * const result = syncSearchArrayMetadataString(metadata, newProducts, spec);
- *
- * console.log(`Added: ${result.added}, Updated: ${result.updated}, Removed: ${result.removed}`);
- * ```
- */
-export declare function syncSearchArrayMetadataString<T extends SearchableObject, C = unknown>(metadata: SearchMetadata, newData: SearchableData<T>, spec?: SearchableObjectSpec<T, C>): SyncResult;
-/**
- * Syncs string-based search metadata using previous and new data for efficient diffing.
- *
- * LEGACY: Use syncSearchArrayMetadataNumericWithPrevious for new code.
- *
- * More efficient than {@link syncSearchArrayMetadataString} when you have both the
- * previous and new data available. Uses the previous data to determine
- * what was removed without iterating through all metadata keys.
- *
- * @typeParam T - Type of the searchable objects
- * @typeParam C - Type of the search context
- *
- * @param metadata - The SearchMetadata map to update (mutated in place)
- * @param previousData - The previous data (used to determine what was removed)
- * @param newData - The new data to sync with
- * @param options - Optional sync options (e.g., skipUpdateCheck)
- * @param spec - Optional specification for how to extract searchable text
- * @returns SyncResult with counts and IDs of added/updated/removed items
- *
- * @example
- * ```typescript
- * const previousProducts = currentData;
- * const newProducts = arrayToSearchableData(freshProductsFromServer);
- *
- * const result = syncSearchArrayMetadataStringWithPrevious(
- *   metadata,
- *   previousProducts,
- *   newProducts,
- *   { skipUpdateCheck: false },
- *   spec
- * );
- * ```
- */
-export declare function syncSearchArrayMetadataStringWithPrevious<T extends SearchableObject, C = unknown>(metadata: SearchMetadata, previousData: SearchableData<T>, newData: SearchableData<T>, options?: SyncOptions, spec?: SearchableObjectSpec<T, C>): SyncResult;
-//# sourceMappingURL=syncSearchArrayMetadata.d.ts.map

package/dist/common/syncSearchArrayMetadata.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"syncSearchArrayMetadata.d.ts","sourceRoot":"","sources":["../../src/common/syncSearchArrayMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EAEpB,UAAU,EACV,WAAW,EACZ,MAAM,UAAU,CAAC;AAIlB,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAkBxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,6BAA6B,CAAC,CAAC,SAAS,gBAAgB,EAAE,CAAC,GAAG,OAAO,EACnF,QAAQ,EAAE,cAAc,EACxB,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,EAC1B,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAChC,UAAU,CAiDZ;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,yCAAyC,CAAC,CAAC,SAAS,gBAAgB,EAAE,CAAC,GAAG,OAAO,EAC/F,QAAQ,EAAE,cAAc,EACxB,YAAY,EAAE,cAAc,CAAC,CAAC,CAAC,EAC/B,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,EAC1B,OAAO,CAAC,EAAE,WAAW,EACrB,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAChC,UAAU,CAmDZ"}

package/dist/common/updateSearchLinkedMetadata.d.ts

@@ -1,139 +0,0 @@
-import type { Id, SearchableData, SearchableObject, SearchableObjectSpec, SearchLinkedMetadataWithData, UpsertResult, SyncLinkedResult } from '../types';
-export type { UpsertResult, SyncLinkedResult } from '../types';
-/**
- * Upserts a primary item into the linked metadata (string-based).
- *
- * LEGACY: Use upsertPrimaryItemNumeric for new code.
- *
- * - If the item doesn't exist, adds it to data, metadata, and initializes primaryToLinked index
- * - If the item exists, updates data and metadata
- * - Handles `_deleted`/`_blocked` items by removing their metadata
- *
- * @typeParam TPrimary - Type of primary items
- * @typeParam TLinked - Type of linked items
- * @typeParam C - Type of the search context
- *
- * @param linked - The linked metadata to update (mutated in place)
- * @param item - The primary item to upsert
- * @param spec - Optional specification for how to extract searchable text
- * @returns UpsertResult indicating if item was added or updated
- *
- * @example
- * ```typescript
- * const stranka = { _id: 's1', ime: 'Janez', priimek: 'Novak' };
- * const result = upsertPrimaryItemString(linkedMeta, stranka, spec);
- * // result.added === true if stranka was new
- * ```
- */
-export declare function upsertPrimaryItemString<TPrimary extends SearchableObject, TLinked extends SearchableObject, C = unknown>(linked: SearchLinkedMetadataWithData<TPrimary, TLinked>, item: TPrimary, spec?: SearchableObjectSpec<TPrimary, C>): UpsertResult;
-/**
- * Removes a primary item from the linked metadata (string-based).
- *
- * LEGACY: Use removePrimaryItemNumeric for new code.
- *
- * Removes the item from data, metadata, and the primaryToLinked index.
- * Note: This does NOT automatically remove linked items - they will become orphans.
- * If you want to also remove linked items, call {@link removeLinkedItemString} for each.
- *
- * @typeParam TPrimary - Type of primary items
- * @typeParam TLinked - Type of linked items
- *
- * @param linked - The linked metadata to update (mutated in place)
- * @param primaryId - The ID of the primary item to remove
- * @returns true if item was found and removed, false if not found
- */
-export declare function removePrimaryItemString<TPrimary extends SearchableObject, TLinked extends SearchableObject>(linked: SearchLinkedMetadataWithData<TPrimary, TLinked>, primaryId: Id): boolean;
-/**
- * Upserts a linked item into the linked metadata (string-based).
- *
- * LEGACY: Use upsertLinkedItemNumeric for new code.
- *
- * - If the item doesn't exist, adds it
- * - If the item exists, updates it
- * - Handles foreign key changes by updating the primaryToLinked index
- *   (removes from old primary's list, adds to new primary's list)
- * - Handles `_deleted`/`_blocked` items by removing their metadata
- *
- * @typeParam TPrimary - Type of primary items
- * @typeParam TLinked - Type of linked items
- * @typeParam C - Type of the search context
- *
- * @param linked - The linked metadata to update (mutated in place)
- * @param item - The linked item to upsert
- * @param foreignKeyGetter - Function to get the primary ID from a linked item
- * @param spec - Optional specification for how to extract searchable text
- * @returns UpsertResult indicating if item was added or updated, and previous primary ID if FK changed
- *
- * @example
- * ```typescript
- * const pacient = { _id: 'p1', ime: 'Rex', stranka_id: 's1' };
- * const result = upsertLinkedItemString(linkedMeta, pacient, (p) => p.stranka_id, spec);
- *
- * // If the pacient moved to a different stranka:
- * pacient.stranka_id = 's2';
- * const result2 = upsertLinkedItemString(linkedMeta, pacient, (p) => p.stranka_id, spec);
- * // result2.previousPrimaryId === 's1'
- * ```
- */
-export declare function upsertLinkedItemString<TPrimary extends SearchableObject, TLinked extends SearchableObject, C = unknown>(linked: SearchLinkedMetadataWithData<TPrimary, TLinked>, item: TLinked, foreignKeyGetter: (item: TLinked) => Id | undefined, spec?: SearchableObjectSpec<TLinked, C>): UpsertResult;
-/**
- * Removes a linked item from the linked metadata (string-based).
- *
- * LEGACY: Use removeLinkedItemNumeric for new code.
- *
- * Removes the item from data, metadata, and the primaryToLinked index.
- *
- * @typeParam TPrimary - Type of primary items
- * @typeParam TLinked - Type of linked items
- *
- * @param linked - The linked metadata to update (mutated in place)
- * @param linkedId - The ID of the linked item to remove
- * @param foreignKeyGetter - Function to get the primary ID from a linked item
- * @returns true if item was found and removed, false if not found
- *
- * @example
- * ```typescript
- * removeLinkedItemString(linkedMeta, 'pacient-id', (p) => p.stranka_id);
- * ```
- */
-export declare function removeLinkedItemString<TPrimary extends SearchableObject, TLinked extends SearchableObject>(linked: SearchLinkedMetadataWithData<TPrimary, TLinked>, linkedId: Id, foreignKeyGetter: (item: TLinked) => Id | undefined): boolean;
-/**
- * Syncs all linked items for a specific primary item (string-based).
- *
- * LEGACY: Use syncLinkedItemsForPrimaryNumeric for new code.
- *
- * This function performs a full sync of linked items belonging to a single primary:
- * - Removes linked items that are no longer in the new data
- * - Updates existing linked items if their tokens changed
- * - Adds new linked items
- * - Only processes items whose foreign key points to the given primary
- *
- * Use this when you have a complete new set of linked items for a primary
- * and want to update the metadata to match.
- *
- * @typeParam TPrimary - Type of primary items
- * @typeParam TLinked - Type of linked items
- * @typeParam C - Type of the search context
- *
- * @param linked - The linked metadata to update (mutated in place)
- * @param primaryId - The primary ID to sync linked items for
- * @param newLinkedItems - The new linked items (only items with matching FK will be processed)
- * @param foreignKeyGetter - Function to get the primary ID from a linked item
- * @param spec - Optional specification for how to extract searchable text
- * @returns SyncLinkedResult with counts of added/updated/removed items
- *
- * @example
- * ```typescript
- * const newPacienti = arrayToSearchableData(freshPacientiFromServer);
- * const result = syncLinkedItemsForPrimaryString(
- *   linkedMeta,
- *   'stranka-1',
- *   newPacienti,
- *   (p) => p.stranka_id,
- *   spec
- * );
- * console.log(`Added: ${result.added}, Updated: ${result.updated}, Removed: ${result.removed}`);
- * ```
- */
-export declare function syncLinkedItemsForPrimaryString<TPrimary extends SearchableObject, TLinked extends SearchableObject, C = unknown>(linked: SearchLinkedMetadataWithData<TPrimary, TLinked>, primaryId: Id, newLinkedItems: SearchableData<TLinked>, foreignKeyGetter: (item: TLinked) => Id | undefined, spec?: SearchableObjectSpec<TLinked, C>): SyncLinkedResult;
-//# sourceMappingURL=updateSearchLinkedMetadata.d.ts.map

package/dist/common/updateSearchLinkedMetadata.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"updateSearchLinkedMetadata.d.ts","sourceRoot":"","sources":["../../src/common/updateSearchLinkedMetadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,EAAE,EACF,cAAc,EACd,gBAAgB,EAChB,oBAAoB,EACpB,4BAA4B,EAC5B,YAAY,EACZ,gBAAgB,EACjB,MAAM,UAAU,CAAC;AAIlB,YAAY,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAkB/D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,SAAS,gBAAgB,EACjC,OAAO,SAAS,gBAAgB,EAChC,CAAC,GAAG,OAAO,EAEX,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE,OAAO,CAAC,EACvD,IAAI,EAAE,QAAQ,EACd,IAAI,CAAC,EAAE,oBAAoB,CAAC,QAAQ,EAAE,CAAC,CAAC,GACvC,YAAY,CAqBd;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,SAAS,gBAAgB,EACjC,OAAO,SAAS,gBAAgB,EAChC,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,SAAS,EAAE,EAAE,GAAG,OAAO,CAUjF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,SAAS,gBAAgB,EACjC,OAAO,SAAS,gBAAgB,EAChC,CAAC,GAAG,OAAO,EAEX,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE,OAAO,CAAC,EACvD,IAAI,EAAE,OAAO,EACb,gBAAgB,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,EAAE,GAAG,SAAS,EACnD,IAAI,CAAC,EAAE,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,GACtC,YAAY,CAuDd;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,SAAS,gBAAgB,EACjC,OAAO,SAAS,gBAAgB,EAEhC,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE,OAAO,CAAC,EACvD,QAAQ,EAAE,EAAE,EACZ,gBAAgB,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,EAAE,GAAG,SAAS,GAClD,OAAO,CAyBT;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,+BAA+B,CAC7C,QAAQ,SAAS,gBAAgB,EACjC,OAAO,SAAS,gBAAgB,EAChC,CAAC,GAAG,OAAO,EAEX,MAAM,EAAE,4BAA4B,CAAC,QAAQ,EAAE,OAAO,CAAC,EACvD,SAAS,EAAE,EAAE,EACb,cAAc,EAAE,cAAc,CAAC,OAAO,CAAC,EACvC,gBAAgB,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,EAAE,GAAG,SAAS,EACnD,IAAI,CAAC,EAAE,oBAAoB,CAAC,OAAO,EAAE,CAAC,CAAC,GACtC,gBAAgB,CA2DlB"}