Compare commits
16 Commits
Author | SHA1 | Date | |
---|---|---|---|
0806d3749b | |||
f5d5e20a97 | |||
db2767010d | |||
e2dc094afd | |||
39d2957b7d | |||
490524516e | |||
ccd4b9e1ec | |||
9c6d6d9f2c | |||
e4d787096e | |||
2bf923b4f1 | |||
0ca1d452b4 | |||
436311ab06 | |||
498f586ddb | |||
6c50bd23ec | |||
419eb163f4 | |||
75aeb12e81 |
60
changelog.md
60
changelog.md
@ -1,5 +1,65 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-04-23 - 5.14.0 - feat(doc)
|
||||
Implement support for beforeSave, afterSave, beforeDelete, and afterDelete lifecycle hooks in document save and delete operations to allow custom logic execution during these critical moments.
|
||||
|
||||
- Calls beforeSave hook if defined before performing insert or update.
|
||||
- Calls afterSave hook after a document is saved.
|
||||
- Calls beforeDelete hook before deletion and afterDelete hook afterward.
|
||||
- Ensures _updatedAt timestamp is refreshed during save operations.
|
||||
|
||||
## 2025-04-22 - 5.13.1 - fix(search)
|
||||
Improve search query parsing for implicit AND queries by preserving quoted substrings and better handling free terms, quoted phrases, and field:value tokens.
|
||||
|
||||
- Replace previous implicit AND logic with tokenization that preserves quoted substrings
|
||||
- Support both free term and field:value tokens with wildcards inside quotes
|
||||
- Ensure errors are thrown for non-searchable fields in field-specific queries
|
||||
|
||||
## 2025-04-22 - 5.13.0 - feat(search)
|
||||
Improve search query handling and update documentation
|
||||
|
||||
- Added 'codex.md' providing a high-level project overview and detailed search API documentation.
|
||||
- Enhanced search parsing in SmartDataDbDoc to support combined free-term and quoted field phrase queries.
|
||||
- Introduced a new fallback branch in the search method to handle free term with quoted field input.
|
||||
- Updated tests in test/test.search.ts to cover new combined query scenarios and ensure robust behavior.
|
||||
|
||||
## 2025-04-22 - 5.12.2 - fix(search)
|
||||
Fix handling of quoted wildcard patterns in field-specific search queries and add tests for location-based wildcard phrase searches
|
||||
|
||||
- Strip surrounding quotes from wildcard patterns in field queries to correctly transform them to regex
|
||||
- Introduce new tests in test/test.search.ts to validate exact quoted and unquoted wildcard searches on a location field
|
||||
|
||||
## 2025-04-22 - 5.12.1 - fix(search)
|
||||
Improve implicit AND logic for mixed free term and field queries in search and enhance wildcard field handling.
|
||||
|
||||
- Updated regex for field:value parsing to capture full value with wildcards.
|
||||
- Added explicit handling for free terms by converting to regex across searchable fields.
|
||||
- Improved error messaging for attempts to search non-searchable fields.
|
||||
- Extended tests to cover combined free term and wildcard field searches, including error cases.
|
||||
|
||||
## 2025-04-22 - 5.12.0 - feat(doc/search)
|
||||
Enhance search functionality with filter and validate options for advanced query control
|
||||
|
||||
- Added 'filter' option to merge additional MongoDB query constraints in search
|
||||
- Introduced 'validate' hook to post-process and filter fetched documents
|
||||
- Refactored underlying execQuery function to support additional search options
|
||||
- Updated tests to cover new search scenarios and fallback mechanisms
|
||||
|
||||
## 2025-04-22 - 5.11.4 - fix(search)
|
||||
Implement implicit AND logic for mixed simple term and field:value queries in search
|
||||
|
||||
- Added a new branch to detect and handle search queries that mix field:value pairs with plain terms without explicit operators
|
||||
- Builds an implicit $and filter when query parts contain colon(s) but lack explicit boolean operators or quotes
|
||||
- Ensures proper parsing and improved robustness of search filters
|
||||
|
||||
## 2025-04-22 - 5.11.3 - fix(lucene adapter and search tests)
|
||||
Improve range query parsing in Lucene adapter and expand search test coverage
|
||||
|
||||
- Added a new 'testSearch' script in package.json to run search tests.
|
||||
- Introduced advanced search tests for range queries and combined field filters in test/search.advanced.ts.
|
||||
- Enhanced robustness tests in test/search.ts for wildcard and empty query scenarios.
|
||||
- Fixed token validation in the parseRange method of the Lucene adapter to ensure proper error handling.
|
||||
|
||||
## 2025-04-21 - 5.11.2 - fix(readme)
|
||||
Update readme to clarify usage of searchable fields retrieval
|
||||
|
||||
|
77
codex.md
Normal file
77
codex.md
Normal file
@ -0,0 +1,77 @@
|
||||
# SmartData Project Overview
|
||||
|
||||
This document provides a high-level overview of the SmartData library (`@push.rocks/smartdata`), its architecture, core components, and key features—including recent enhancements to the search API.
|
||||
|
||||
## 1. Project Purpose
|
||||
- A TypeScript‑first wrapper around MongoDB that supplies:
|
||||
- Strongly‑typed document & collection classes
|
||||
- Decorator‑based schema definition (no external schema files)
|
||||
- Advanced search capabilities with Lucene‑style queries
|
||||
- Built‑in support for real‑time data sync, distributed coordination, and key‑value EasyStore
|
||||
|
||||
## 2. Core Concepts & Components
|
||||
- **SmartDataDb**: Manages the MongoDB connection, pooling, and initialization of collections.
|
||||
- **SmartDataDbDoc**: Base class for all document models; provides CRUD, upsert, and cursor APIs.
|
||||
- **Decorators**:
|
||||
- `@Collection`: Associates a class with a MongoDB collection
|
||||
- `@svDb()`: Marks a field as persisted to the DB
|
||||
- `@unI()`: Marks a field as a unique index
|
||||
- `@index()`: Adds a regular index
|
||||
- `@searchable()`: Marks a field for inclusion in text searches or regex queries
|
||||
- **SmartdataCollection**: Wraps a MongoDB collection; auto‑creates indexes based on decorators.
|
||||
- **Lucene Adapter**: Parses a Lucene query string into an AST and transforms it to a MongoDB filter object.
|
||||
- **EasyStore**: A simple, schema‑less key‑value store built on top of MongoDB for sharing ephemeral data.
|
||||
- **Distributed Coordinator**: Leader election and task‑distribution API for building resilient, multi‑instance systems.
|
||||
- **Watcher**: Listens to change streams for real‑time updates and integrates with RxJS.
|
||||
|
||||
## 3. Search API
|
||||
SmartData provides a unified `.search(query[, opts])` method on all models with `@searchable()` fields:
|
||||
|
||||
- **Supported Syntax**:
|
||||
1. Exact field:value (e.g. `field:Value`)
|
||||
2. Quoted phrases (e.g. `"exact phrase"` or `'exact phrase'`)
|
||||
3. Wildcards: `*` (zero or more chars) and `?` (single char)
|
||||
4. Boolean operators: `AND`, `OR`, `NOT`
|
||||
5. Grouping: parenthesis `(A OR B) AND C`
|
||||
6. Range queries: `[num TO num]`, `{num TO num}`
|
||||
7. Multi‑term unquoted: terms AND’d across all searchable fields
|
||||
8. Empty query returns all documents
|
||||
|
||||
- **Fallback Mechanisms**:
|
||||
1. Text index based `$text` search (if supported)
|
||||
2. Field‑scoped and multi‑field regex queries
|
||||
3. In‑memory filtering for complex or unsupported cases
|
||||
|
||||
### New Security & Extensibility Hooks
|
||||
The `.search(query, opts?)` signature now accepts a `SearchOptions<T>` object:
|
||||
```ts
|
||||
interface SearchOptions<T> {
|
||||
filter?: Record<string, any>; // Additional MongoDB filter AND‑merged
|
||||
validate?: (doc: T) => boolean; // Post‑fetch hook to drop results
|
||||
}
|
||||
```
|
||||
- **filter**: Enforces mandatory constraints (e.g. multi‑tenant isolation) directly in the Mongo query.
|
||||
- **validate**: An async function that runs after fetching; return `false` to exclude a document.
|
||||
|
||||
## 4. Testing Strategy
|
||||
- Unit tests in `test/test.search.ts` cover basic search functionality and new options:
|
||||
- Exact, wildcard, phrase, boolean and grouping cases
|
||||
- Implicit AND and mixed free‑term + field searches
|
||||
- Edge cases (non‑searchable fields, quoted wildcards, no matches)
|
||||
- `filter` and `validate` tests ensure security hooks work as intended
|
||||
- Advanced search scenarios are covered in `test/test.search.advanced.ts`.
|
||||
|
||||
## 5. Usage Example
|
||||
```ts
|
||||
// Basic search
|
||||
const prods = await Product.search('wireless earbuds');
|
||||
|
||||
// Scoped search (only your organization’s items)
|
||||
const myItems = await Product.search('book', { filter: { ownerId } });
|
||||
|
||||
// Post‑search validation (only cheap items)
|
||||
const cheapItems = await Product.search('', { validate: p => p.price < 50 });
|
||||
```
|
||||
|
||||
---
|
||||
Last updated: 2025-04-22
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@push.rocks/smartdata",
|
||||
"version": "5.11.2",
|
||||
"version": "5.14.0",
|
||||
"private": false,
|
||||
"description": "An advanced library for NoSQL data organization and manipulation using TypeScript with support for MongoDB, data validation, collections, and custom data types.",
|
||||
"main": "dist_ts/index.js",
|
||||
@ -8,6 +8,7 @@
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "tstest test/",
|
||||
"testSearch": "tsx test/test.search.ts",
|
||||
"build": "tsbuild --web --allowimplicitany",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
|
@ -225,6 +225,10 @@ await Product.search('TypeScript Aufgabe');
|
||||
|
||||
// 7: Empty query returns all documents
|
||||
await Product.search('');
|
||||
// 8: Scoped search with additional filter (e.g. multi-tenant isolation)
|
||||
await Product.search('book', { filter: { ownerId: currentUserId } });
|
||||
// 9: Post-search validation hook to drop unwanted results (e.g. price check)
|
||||
await Product.search('', { validate: (p) => p.price < 100 });
|
||||
```
|
||||
|
||||
The search functionality includes:
|
||||
|
@ -172,6 +172,21 @@ tap.test('grouping: (Furniture OR Electronics) AND Chair', async () => {
|
||||
expect(names).toEqual(['Gaming Chair', 'Office Chair']);
|
||||
});
|
||||
|
||||
// Additional range and combined query tests
|
||||
tap.test('range query price:[30 TO 300] returns expected products', async () => {
|
||||
const res = await Product.search('price:[30 TO 300]');
|
||||
// Expect products with price between 30 and 300 inclusive: Day Light Lamp, Gaming Chair, Office Chair, AirPods
|
||||
expect(res.length).toEqual(4);
|
||||
const names = res.map((r) => r.name).sort();
|
||||
expect(names).toEqual(['AirPods', 'Day Light Lamp', 'Gaming Chair', 'Office Chair']);
|
||||
});
|
||||
|
||||
tap.test('should filter category and price range', async () => {
|
||||
const res = await Product.search('category:Lighting AND price:[30 TO 40]');
|
||||
expect(res.length).toEqual(1);
|
||||
expect(res[0].name).toEqual('Day Light Lamp');
|
||||
});
|
||||
|
||||
// Teardown
|
||||
tap.test('cleanup advanced search database', async () => {
|
||||
await testDb.mongoDb.dropDatabase();
|
||||
|
@ -9,6 +9,8 @@ import { searchable } from '../ts/classes.doc.js';
|
||||
// Set up database connection
|
||||
let smartmongoInstance: smartmongo.SmartMongo;
|
||||
let testDb: smartdata.SmartdataDb;
|
||||
// Class for location-based wildcard/phrase tests
|
||||
let LocationDoc: any;
|
||||
|
||||
// Define a test class with searchable fields using the standard SmartDataDbDoc
|
||||
@smartdata.Collection(() => testDb)
|
||||
@ -257,6 +259,143 @@ tap.test('should search hyphenated terms "E-reader"', async () => {
|
||||
expect(ereaderResults[0].name).toEqual('Kindle Paperwhite');
|
||||
});
|
||||
|
||||
// Additional robustness tests
|
||||
tap.test('should return all products for empty search', async () => {
|
||||
const searchResults = await Product.search('');
|
||||
const allProducts = await Product.getInstances({});
|
||||
expect(searchResults.length).toEqual(allProducts.length);
|
||||
});
|
||||
|
||||
tap.test('should support wildcard plain term across all fields', async () => {
|
||||
const results = await Product.search('*book*');
|
||||
const names = results.map((r) => r.name).sort();
|
||||
expect(names).toEqual(['Harry Potter', 'Kindle Paperwhite', 'MacBook Pro']);
|
||||
});
|
||||
|
||||
tap.test('should support wildcard plain term with question mark pattern', async () => {
|
||||
const results = await Product.search('?one?');
|
||||
const names = results.map((r) => r.name).sort();
|
||||
expect(names).toEqual(['Galaxy S21', 'iPhone 12']);
|
||||
});
|
||||
|
||||
// Filter and Validation tests
|
||||
tap.test('should apply filter option to restrict results', async () => {
|
||||
// search term 'book' across all fields but restrict to Books category
|
||||
const bookFiltered = await Product.search('book', { filter: { category: 'Books' } });
|
||||
expect(bookFiltered.length).toEqual(2);
|
||||
bookFiltered.forEach((p) => expect(p.category).toEqual('Books'));
|
||||
});
|
||||
tap.test('should apply validate hook to post-filter results', async () => {
|
||||
// return only products with price > 500
|
||||
const expensive = await Product.search('', { validate: (p) => p.price > 500 });
|
||||
expect(expensive.length).toBeGreaterThan(0);
|
||||
expensive.forEach((p) => expect(p.price).toBeGreaterThan(500));
|
||||
});
|
||||
|
||||
// Tests for quoted and wildcard field-specific phrases
|
||||
tap.test('setup location test products', async () => {
|
||||
@smartdata.Collection(() => testDb)
|
||||
class LD extends smartdata.SmartDataDbDoc<LD, LD> {
|
||||
@smartdata.unI() public id: string = smartunique.shortId();
|
||||
@smartdata.svDb() @searchable() public location: string;
|
||||
constructor(loc: string) { super(); this.location = loc; }
|
||||
}
|
||||
// Assign to outer variable for subsequent tests
|
||||
LocationDoc = LD;
|
||||
const locations = ['Berlin', 'Frankfurt am Main', 'Frankfurt am Oder', 'London'];
|
||||
for (const loc of locations) {
|
||||
await new LocationDoc(loc).save();
|
||||
}
|
||||
});
|
||||
tap.test('should search exact quoted field phrase', async () => {
|
||||
const results = await (LocationDoc as any).search('location:"Frankfurt am Main"');
|
||||
expect(results.length).toEqual(1);
|
||||
expect(results[0].location).toEqual('Frankfurt am Main');
|
||||
});
|
||||
tap.test('should search wildcard quoted field phrase', async () => {
|
||||
const results = await (LocationDoc as any).search('location:"Frankfurt am *"');
|
||||
const names = results.map((d: any) => d.location).sort();
|
||||
expect(names).toEqual(['Frankfurt am Main', 'Frankfurt am Oder']);
|
||||
});
|
||||
tap.test('should search unquoted wildcard field', async () => {
|
||||
const results = await (LocationDoc as any).search('location:Frankfurt*');
|
||||
const names = results.map((d: any) => d.location).sort();
|
||||
expect(names).toEqual(['Frankfurt am Main', 'Frankfurt am Oder']);
|
||||
});
|
||||
|
||||
// Combined free-term + field phrase/wildcard tests
|
||||
let CombinedDoc: any;
|
||||
tap.test('setup combined docs for free-term and location tests', async () => {
|
||||
@smartdata.Collection(() => testDb)
|
||||
class CD extends smartdata.SmartDataDbDoc<CD, CD> {
|
||||
@smartdata.unI() public id: string = smartunique.shortId();
|
||||
@smartdata.svDb() @searchable() public name: string;
|
||||
@smartdata.svDb() @searchable() public location: string;
|
||||
constructor(name: string, location: string) { super(); this.name = name; this.location = location; }
|
||||
}
|
||||
CombinedDoc = CD;
|
||||
const docs = [
|
||||
new CombinedDoc('TypeScript', 'Berlin'),
|
||||
new CombinedDoc('TypeScript', 'Frankfurt am Main'),
|
||||
new CombinedDoc('TypeScript', 'Frankfurt am Oder'),
|
||||
new CombinedDoc('JavaScript', 'Berlin'),
|
||||
];
|
||||
for (const d of docs) await d.save();
|
||||
});
|
||||
tap.test('should search free term and exact quoted field phrase', async () => {
|
||||
const res = await CombinedDoc.search('TypeScript location:"Berlin"');
|
||||
expect(res.length).toEqual(1);
|
||||
expect(res[0].location).toEqual('Berlin');
|
||||
});
|
||||
tap.test('should not match free term with non-matching quoted field phrase', async () => {
|
||||
const res = await CombinedDoc.search('TypeScript location:"Frankfurt d"');
|
||||
expect(res.length).toEqual(0);
|
||||
});
|
||||
tap.test('should search free term with quoted wildcard field phrase', async () => {
|
||||
const res = await CombinedDoc.search('TypeScript location:"Frankfurt am *"');
|
||||
const locs = res.map((r: any) => r.location).sort();
|
||||
expect(locs).toEqual(['Frankfurt am Main', 'Frankfurt am Oder']);
|
||||
});
|
||||
// Quoted exact field phrase without wildcard should return no matches if no exact match
|
||||
tap.test('should not match location:"Frankfurt d"', async () => {
|
||||
const results = await (LocationDoc as any).search('location:"Frankfurt d"');
|
||||
expect(results.length).toEqual(0);
|
||||
});
|
||||
|
||||
// Combined free-term and field wildcard tests
|
||||
tap.test('should combine free term and wildcard field search', async () => {
|
||||
const results = await Product.search('book category:Book*');
|
||||
expect(results.length).toEqual(2);
|
||||
results.forEach((p) => expect(p.category).toEqual('Books'));
|
||||
});
|
||||
tap.test('should not match when free term matches but wildcard field does not', async () => {
|
||||
const results = await Product.search('book category:Kitchen*');
|
||||
expect(results.length).toEqual(0);
|
||||
});
|
||||
|
||||
// Non-searchable field should cause an error for combined queries
|
||||
tap.test('should throw when combining term with non-searchable field', async () => {
|
||||
let error: Error;
|
||||
try {
|
||||
await Product.search('book location:Berlin');
|
||||
} catch (e) {
|
||||
error = e as Error;
|
||||
}
|
||||
expect(error).toBeTruthy();
|
||||
expect(error.message).toMatch(/not searchable/);
|
||||
});
|
||||
tap.test('should throw when combining term with non-searchable wildcard field', async () => {
|
||||
let error: Error;
|
||||
try {
|
||||
await Product.search('book location:Berlin*');
|
||||
} catch (e) {
|
||||
error = e as Error;
|
||||
}
|
||||
expect(error).toBeTruthy();
|
||||
expect(error.message).toMatch(/not searchable/);
|
||||
});
|
||||
|
||||
// Close database connection
|
||||
tap.test('close database connection', async () => {
|
||||
await testDb.mongoDb.dropDatabase();
|
||||
await testDb.close();
|
||||
|
@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartdata',
|
||||
version: '5.11.2',
|
||||
version: '5.14.0',
|
||||
description: 'An advanced library for NoSQL data organization and manipulation using TypeScript with support for MongoDB, data validation, collections, and custom data types.'
|
||||
}
|
||||
|
@ -5,6 +5,15 @@ import { SmartdataDbCursor } from './classes.cursor.js';
|
||||
import { type IManager, SmartdataCollection } from './classes.collection.js';
|
||||
import { SmartdataDbWatcher } from './classes.watcher.js';
|
||||
import { SmartdataLuceneAdapter } from './classes.lucene.adapter.js';
|
||||
/**
|
||||
* Search options for `.search()`:
|
||||
* - filter: additional MongoDB query to AND-merge
|
||||
* - validate: post-fetch validator, return true to keep a doc
|
||||
*/
|
||||
export interface SearchOptions<T> {
|
||||
filter?: Record<string, any>;
|
||||
validate?: (doc: T) => Promise<boolean> | boolean;
|
||||
}
|
||||
|
||||
export type TDocCreation = 'db' | 'new' | 'mixed';
|
||||
|
||||
@ -318,15 +327,40 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
const ctor = this as any;
|
||||
return Array.isArray(ctor.searchableFields) ? ctor.searchableFields : [];
|
||||
}
|
||||
/**
|
||||
* Execute a query with optional hard filter and post-fetch validation
|
||||
*/
|
||||
private static async execQuery<T>(
|
||||
this: plugins.tsclass.typeFest.Class<T>,
|
||||
baseFilter: Record<string, any>,
|
||||
opts?: SearchOptions<T>
|
||||
): Promise<T[]> {
|
||||
let mongoFilter = baseFilter || {};
|
||||
if (opts?.filter) {
|
||||
mongoFilter = { $and: [mongoFilter, opts.filter] };
|
||||
}
|
||||
let docs: T[] = await (this as any).getInstances(mongoFilter);
|
||||
if (opts?.validate) {
|
||||
const out: T[] = [];
|
||||
for (const d of docs) {
|
||||
if (await opts.validate(d)) out.push(d);
|
||||
}
|
||||
docs = out;
|
||||
}
|
||||
return docs;
|
||||
}
|
||||
|
||||
/**
|
||||
* Search documents by text or field:value syntax, with safe regex fallback
|
||||
* Supports additional filtering and post-fetch validation via opts
|
||||
* @param query A search term or field:value expression
|
||||
* @param opts Optional filter and validate hooks
|
||||
* @returns Array of matching documents
|
||||
*/
|
||||
public static async search<T>(
|
||||
this: plugins.tsclass.typeFest.Class<T>,
|
||||
query: string,
|
||||
opts?: SearchOptions<T>,
|
||||
): Promise<T[]> {
|
||||
const searchableFields = (this as any).getSearchableFields();
|
||||
if (searchableFields.length === 0) {
|
||||
@ -335,7 +369,8 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
// empty query -> return all
|
||||
const q = query.trim();
|
||||
if (!q) {
|
||||
return await (this as any).getInstances({});
|
||||
// empty query: fetch all, apply opts
|
||||
return await (this as any).execQuery({}, opts);
|
||||
}
|
||||
// simple exact field:value (no spaces, no wildcards, no quotes)
|
||||
// simple exact field:value (no spaces, wildcards, quotes)
|
||||
@ -346,30 +381,35 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
if (!searchableFields.includes(field)) {
|
||||
throw new Error(`Field '${field}' is not searchable for class ${this.name}`);
|
||||
}
|
||||
return await (this as any).getInstances({ [field]: value });
|
||||
// simple field:value search
|
||||
return await (this as any).execQuery({ [field]: value }, opts);
|
||||
}
|
||||
// quoted phrase across all searchable fields: exact match of phrase
|
||||
const quoted = q.match(/^"(.+)"$|^'(.+)'$/);
|
||||
if (quoted) {
|
||||
const phrase = quoted[1] || quoted[2] || '';
|
||||
// build regex that matches the exact phrase (allowing flexible whitespace)
|
||||
const parts = phrase.split(/\s+/).map((t) => escapeForRegex(t));
|
||||
const pattern = parts.join('\\s+');
|
||||
const orConds = searchableFields.map((f) => ({ [f]: { $regex: pattern, $options: 'i' } }));
|
||||
return await (this as any).getInstances({ $or: orConds });
|
||||
return await (this as any).execQuery({ $or: orConds }, opts);
|
||||
}
|
||||
// wildcard field:value (supports * and ?) -> direct regex on that field
|
||||
const wildcardField = q.match(/^(\w+):(.+[*?].*)$/);
|
||||
if (wildcardField) {
|
||||
const field = wildcardField[1];
|
||||
const pattern = wildcardField[2];
|
||||
// Support quoted wildcard patterns: strip surrounding quotes
|
||||
let pattern = wildcardField[2];
|
||||
if ((pattern.startsWith('"') && pattern.endsWith('"')) ||
|
||||
(pattern.startsWith("'") && pattern.endsWith("'"))) {
|
||||
pattern = pattern.slice(1, -1);
|
||||
}
|
||||
if (!searchableFields.includes(field)) {
|
||||
throw new Error(`Field '${field}' is not searchable for class ${this.name}`);
|
||||
}
|
||||
// escape regex special chars except * and ?, then convert wildcards
|
||||
const escaped = pattern.replace(/([.+^${}()|[\\]\\])/g, '\\$1');
|
||||
const regexPattern = escaped.replace(/\*/g, '.*').replace(/\?/g, '.');
|
||||
return await (this as any).getInstances({ [field]: { $regex: regexPattern, $options: 'i' } });
|
||||
return await (this as any).execQuery({ [field]: { $regex: regexPattern, $options: 'i' } }, opts);
|
||||
}
|
||||
// wildcard plain term across all fields (supports * and ?)
|
||||
if (!q.includes(':') && (q.includes('*') || q.includes('?'))) {
|
||||
@ -377,13 +417,60 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
const escaped = q.replace(/([.+^${}()|[\\]\\])/g, '\\$1');
|
||||
const pattern = escaped.replace(/\*/g, '.*').replace(/\?/g, '.');
|
||||
const orConds = searchableFields.map((f) => ({ [f]: { $regex: pattern, $options: 'i' } }));
|
||||
return await (this as any).getInstances({ $or: orConds });
|
||||
return await (this as any).execQuery({ $or: orConds }, opts);
|
||||
}
|
||||
// implicit AND for multiple tokens: free terms, quoted phrases, and field:values
|
||||
{
|
||||
// Split query into tokens, preserving quoted substrings
|
||||
const rawTokens = q.match(/(?:[^\s"']+|"[^"]*"|'[^']*')+/g) || [];
|
||||
// Only apply when more than one token and no boolean operators or grouping
|
||||
if (
|
||||
rawTokens.length > 1 &&
|
||||
!/(\bAND\b|\bOR\b|\bNOT\b|\(|\))/i.test(q) &&
|
||||
!/\[|\]/.test(q)
|
||||
) {
|
||||
const andConds: any[] = [];
|
||||
for (let token of rawTokens) {
|
||||
// field:value token
|
||||
const fv = token.match(/^(\w+):(.+)$/);
|
||||
if (fv) {
|
||||
const field = fv[1];
|
||||
let value = fv[2];
|
||||
if (!searchableFields.includes(field)) {
|
||||
throw new Error(`Field '${field}' is not searchable for class ${this.name}`);
|
||||
}
|
||||
// Strip surrounding quotes if present
|
||||
if ((value.startsWith('"') && value.endsWith('"')) || (value.startsWith("'") && value.endsWith("'"))) {
|
||||
value = value.slice(1, -1);
|
||||
}
|
||||
// Wildcard search?
|
||||
if (value.includes('*') || value.includes('?')) {
|
||||
const escaped = value.replace(/([.+^${}()|[\\]\\])/g, '\\$1');
|
||||
const pattern = escaped.replace(/\*/g, '.*').replace(/\?/g, '.');
|
||||
andConds.push({ [field]: { $regex: pattern, $options: 'i' } });
|
||||
} else {
|
||||
andConds.push({ [field]: value });
|
||||
}
|
||||
} else if ((token.startsWith('"') && token.endsWith('"')) || (token.startsWith("'") && token.endsWith("'"))) {
|
||||
// Quoted free phrase across all fields
|
||||
const phrase = token.slice(1, -1);
|
||||
const parts = phrase.split(/\s+/).map((t) => escapeForRegex(t));
|
||||
const pattern = parts.join('\\s+');
|
||||
andConds.push({ $or: searchableFields.map((f) => ({ [f]: { $regex: pattern, $options: 'i' } })) });
|
||||
} else {
|
||||
// Free term across all fields
|
||||
const esc = escapeForRegex(token);
|
||||
andConds.push({ $or: searchableFields.map((f) => ({ [f]: { $regex: esc, $options: 'i' } })) });
|
||||
}
|
||||
}
|
||||
return await (this as any).execQuery({ $and: andConds }, opts);
|
||||
}
|
||||
}
|
||||
// detect advanced Lucene syntax: field:value, wildcards, boolean, grouping
|
||||
const luceneSyntax = /(\w+:[^\s]+)|\*|\?|\bAND\b|\bOR\b|\bNOT\b|\(|\)/;
|
||||
if (luceneSyntax.test(q)) {
|
||||
const filter = (this as any).createSearchFilter(q);
|
||||
return await (this as any).getInstances(filter);
|
||||
return await (this as any).execQuery(filter, opts);
|
||||
}
|
||||
// multi-term unquoted -> AND of regex across fields for each term
|
||||
const terms = q.split(/\s+/);
|
||||
@ -393,12 +480,12 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
const ors = searchableFields.map((f) => ({ [f]: { $regex: esc, $options: 'i' } }));
|
||||
return { $or: ors };
|
||||
});
|
||||
return await (this as any).getInstances({ $and: andConds });
|
||||
return await (this as any).execQuery({ $and: andConds }, opts);
|
||||
}
|
||||
// single term -> regex across all searchable fields
|
||||
const esc = escapeForRegex(q);
|
||||
const orConds = searchableFields.map((f) => ({ [f]: { $regex: esc, $options: 'i' } }));
|
||||
return await (this as any).getInstances({ $or: orConds });
|
||||
return await (this as any).execQuery({ $or: orConds }, opts);
|
||||
}
|
||||
|
||||
|
||||
@ -463,12 +550,16 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
* may lead to data inconsistencies, but is faster
|
||||
*/
|
||||
public async save() {
|
||||
// allow hook before saving
|
||||
if (typeof (this as any).beforeSave === 'function') {
|
||||
await (this as any).beforeSave();
|
||||
}
|
||||
// tslint:disable-next-line: no-this-assignment
|
||||
const self: any = this;
|
||||
let dbResult: any;
|
||||
|
||||
// update timestamp
|
||||
this._updatedAt = new Date().toISOString();
|
||||
|
||||
// perform insert or update
|
||||
switch (this.creationStatus) {
|
||||
case 'db':
|
||||
dbResult = await this.collection.update(self);
|
||||
@ -480,6 +571,10 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
default:
|
||||
console.error('neither new nor in db?');
|
||||
}
|
||||
// allow hook after saving
|
||||
if (typeof (this as any).afterSave === 'function') {
|
||||
await (this as any).afterSave();
|
||||
}
|
||||
return dbResult;
|
||||
}
|
||||
|
||||
@ -487,7 +582,17 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
* deletes a document from the database
|
||||
*/
|
||||
public async delete() {
|
||||
await this.collection.delete(this);
|
||||
// allow hook before deleting
|
||||
if (typeof (this as any).beforeDelete === 'function') {
|
||||
await (this as any).beforeDelete();
|
||||
}
|
||||
// perform deletion
|
||||
const result = await this.collection.delete(this);
|
||||
// allow hook after delete
|
||||
if (typeof (this as any).afterDelete === 'function') {
|
||||
await (this as any).afterDelete();
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -290,11 +290,11 @@ export class LuceneParser {
|
||||
const includeLower = this.tokens[this.pos] === '[';
|
||||
const includeUpper = this.tokens[this.pos + 4] === ']';
|
||||
|
||||
this.pos++; // Skip open bracket
|
||||
|
||||
// Ensure tokens for lower, TO, upper, and closing bracket exist
|
||||
if (this.pos + 4 >= this.tokens.length) {
|
||||
throw new Error('Invalid range query syntax');
|
||||
}
|
||||
this.pos++; // Skip open bracket
|
||||
|
||||
const lower = this.tokens[this.pos];
|
||||
this.pos++;
|
||||
|
Reference in New Issue
Block a user