Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| d30c9619c5 | |||
| 7344ae2db3 | |||
| 3b29a150a8 | |||
| 59186d84a9 | |||
| 7fab4e5dd0 | |||
| 0dbaa1bc5d |
1
.serena/.gitignore
vendored
Normal file
1
.serena/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
/cache
|
||||
Binary file not shown.
3
.vscode/settings.json
vendored
3
.vscode/settings.json
vendored
@@ -22,5 +22,6 @@
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
],
|
||||
"deno.enable": false
|
||||
}
|
||||
|
||||
29
changelog.md
29
changelog.md
@@ -1,5 +1,34 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-11-17 - 5.16.6 - fix(classes)
|
||||
Add Deno compatibility, prototype-safe decorators and safe collection accessor; bump a few deps
|
||||
|
||||
- Add deno.json to enable experimentalDecorators and target ES2022/DOM for Deno builds.
|
||||
- Introduce getCollectionSafe() on SmartDataDbDoc and use it for save/update/delete/findOne to avoid runtime errors when instance 'collection' is not present.
|
||||
- Change several instance properties (globalSaveableProperties, uniqueIndexes, regularIndexes, saveableProperties) to 'declare' so decorator-set prototype properties are not shadowed (Deno compatibility).
|
||||
- Enhance @Collection decorator: capture original constructor/prototype for Deno, define prototype getter for collection on decorated class, attach docCtor for searchableFields, and forward _svDbOptions to the original constructor to preserve serializer metadata.
|
||||
- Improve text/search index handling by relying on docCtor.searchableFields and guarding text index creation.
|
||||
- Bump dependencies/devDependencies: @push.rocks/smartmongo -> ^2.0.14, @git.zone/tsbuild -> ^2.7.1, @git.zone/tstest -> ^2.8.1.
|
||||
- These are non-breaking runtime compatibility and developer-experience fixes; intended as a patch release.
|
||||
|
||||
## 2025-11-16 - 5.16.5 - fix(watcher)
|
||||
Update dependencies, tooling and watcher import; add .serena cache ignore
|
||||
|
||||
- Bump runtime dependencies: @push.rocks/smartlog 3.1.8 → 3.1.10, @push.rocks/smartstring 4.0.15 → 4.1.0, @push.rocks/taskbuffer 3.1.7 → 3.4.0, @tsclass/tsclass 9.2.0 → 9.3.0, mongodb 6.18.0 → 6.20.0
|
||||
- Bump devDependencies: @git.zone/tsbuild 2.6.7 → 2.6.8, @git.zone/tsrun 1.2.44 → 1.6.2, @git.zone/tstest 2.3.5 → 2.6.2
|
||||
- Switch EventEmitter import to node:events in ts/classes.watcher.ts to use the namespaced Node import
|
||||
- Add .serena/.gitignore to ignore /cache
|
||||
|
||||
## 2025-08-18 - 5.16.4 - fix(classes.doc (convertFilterForMongoDb))
|
||||
Improve filter conversion: handle logical operators, merge operator objects, add nested filter tests and docs, and fix test script
|
||||
|
||||
- Fix package.json test script: remove stray dot in tstest --verbose argument to ensure tests run correctly
|
||||
- Enhance convertFilterForMongoDb in ts/classes.doc.ts to properly handle logical operators ($and, $or, $nor, $not) and return them recursively
|
||||
- Merge operator objects for the same field path (e.g. combining $gte and $lte) to avoid overwriting operator clauses when object and dot-notation are mixed
|
||||
- Add validation/guards for operator argument types (e.g. $in, $nin, $all must be arrays; $size must be numeric) and preserve existing behavior blocking $where for security
|
||||
- Add comprehensive nested filter tests in test/test.filters.ts to cover deep nested object queries, $elemMatch, array size, $all, $in on nested fields and more
|
||||
- Expand README filtering section with detailed examples for basic filtering, deep nested filters, comparison operators, array operations, logical and element operators, and advanced patterns
|
||||
|
||||
## 2025-08-18 - 5.16.3 - fix(docs)
|
||||
Add local Claude settings and remove outdated codex.md
|
||||
|
||||
|
||||
11
deno.json
Normal file
11
deno.json
Normal file
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"lib": [
|
||||
"ES2022",
|
||||
"DOM"
|
||||
]
|
||||
},
|
||||
"nodeModulesDir": "auto",
|
||||
"version": "5.16.6"
|
||||
}
|
||||
22
package.json
22
package.json
@@ -1,13 +1,13 @@
|
||||
{
|
||||
"name": "@push.rocks/smartdata",
|
||||
"version": "5.16.3",
|
||||
"version": "5.16.6",
|
||||
"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",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "tstest test/ --verbose. --logfile --timeout 120",
|
||||
"test": "tstest test/ --verbose --logfile --timeout 120",
|
||||
"testSearch": "tsx test/test.search.ts",
|
||||
"build": "tsbuild --web --allowimplicitany",
|
||||
"buildDocs": "tsdoc"
|
||||
@@ -25,21 +25,21 @@
|
||||
"dependencies": {
|
||||
"@push.rocks/lik": "^6.2.2",
|
||||
"@push.rocks/smartdelay": "^3.0.1",
|
||||
"@push.rocks/smartlog": "^3.1.8",
|
||||
"@push.rocks/smartmongo": "^2.0.12",
|
||||
"@push.rocks/smartlog": "^3.1.10",
|
||||
"@push.rocks/smartmongo": "^2.0.14",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"@push.rocks/smartrx": "^3.0.10",
|
||||
"@push.rocks/smartstring": "^4.0.15",
|
||||
"@push.rocks/smartstring": "^4.1.0",
|
||||
"@push.rocks/smarttime": "^4.0.6",
|
||||
"@push.rocks/smartunique": "^3.0.8",
|
||||
"@push.rocks/taskbuffer": "^3.1.7",
|
||||
"@tsclass/tsclass": "^9.2.0",
|
||||
"mongodb": "^6.18.0"
|
||||
"@push.rocks/taskbuffer": "^3.4.0",
|
||||
"@tsclass/tsclass": "^9.3.0",
|
||||
"mongodb": "^6.20.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.6.7",
|
||||
"@git.zone/tsrun": "^1.2.44",
|
||||
"@git.zone/tstest": "^2.3.5",
|
||||
"@git.zone/tsbuild": "^2.7.1",
|
||||
"@git.zone/tsrun": "^1.6.2",
|
||||
"@git.zone/tstest": "^2.8.1",
|
||||
"@push.rocks/qenv": "^6.1.3",
|
||||
"@push.rocks/tapbundle": "^6.0.3",
|
||||
"@types/node": "^22.15.2"
|
||||
|
||||
3942
pnpm-lock.yaml
generated
3942
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
202
readme.md
202
readme.md
@@ -144,40 +144,130 @@ await foundUser.delete();
|
||||
|
||||
SmartData provides the most advanced type-safe filtering system for MongoDB, supporting all operators while maintaining full IntelliSense:
|
||||
|
||||
#### Basic Filtering
|
||||
|
||||
```typescript
|
||||
// Simple equality
|
||||
const john = await User.getInstances({ name: 'John Doe' });
|
||||
|
||||
// Multiple fields (implicit AND)
|
||||
const activeAdults = await User.getInstances({
|
||||
status: 'active',
|
||||
age: { $gte: 18 }
|
||||
});
|
||||
|
||||
// Union types work perfectly
|
||||
const users = await User.getInstances({
|
||||
status: { $in: ['active', 'pending'] } // TypeScript validates these values!
|
||||
});
|
||||
```
|
||||
|
||||
// Comparison operators with type checking
|
||||
#### Deep Nested Object Filtering
|
||||
|
||||
SmartData supports **both** nested object notation and dot notation for querying nested fields, with intelligent merging when both are used:
|
||||
|
||||
```typescript
|
||||
// Nested object notation - natural TypeScript syntax
|
||||
const users = await User.getInstances({
|
||||
metadata: {
|
||||
loginCount: { $gte: 5 }
|
||||
}
|
||||
});
|
||||
|
||||
// Dot notation - MongoDB style
|
||||
const sameUsers = await User.getInstances({
|
||||
'metadata.loginCount': { $gte: 5 }
|
||||
});
|
||||
|
||||
// POWERFUL: Combine both notations - operators are merged!
|
||||
const filtered = await User.getInstances({
|
||||
metadata: { loginCount: { $gte: 3 } }, // Object notation
|
||||
'metadata.loginCount': { $lte: 10 } // Dot notation
|
||||
// Result: metadata.loginCount between 3 and 10
|
||||
});
|
||||
|
||||
// Deep nesting with full type safety
|
||||
const deepQuery = await User.getInstances({
|
||||
profile: {
|
||||
settings: {
|
||||
notifications: {
|
||||
email: true,
|
||||
frequency: { $in: ['daily', 'weekly'] }
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Mix styles for complex queries
|
||||
const advanced = await User.getInstances({
|
||||
// Object notation for structure
|
||||
profile: {
|
||||
age: { $gte: 21 },
|
||||
verified: true
|
||||
},
|
||||
// Dot notation for specific overrides
|
||||
'profile.settings.theme': 'dark',
|
||||
'profile.lastSeen': { $gte: new Date('2024-01-01') }
|
||||
});
|
||||
```
|
||||
|
||||
#### Comparison Operators
|
||||
|
||||
```typescript
|
||||
// Numeric comparisons with type checking
|
||||
const adults = await User.getInstances({
|
||||
age: { $gte: 18, $lt: 65 } // Type-safe numeric comparisons
|
||||
});
|
||||
|
||||
// Date comparisons
|
||||
const recentUsers = await User.getInstances({
|
||||
createdAt: { $gte: new Date('2024-01-01') }
|
||||
});
|
||||
|
||||
// Not equal
|
||||
const nonAdmins = await User.getInstances({
|
||||
role: { $ne: 'admin' }
|
||||
});
|
||||
```
|
||||
|
||||
#### Array Operations
|
||||
|
||||
```typescript
|
||||
// Array operations with full type safety
|
||||
const experts = await User.getInstances({
|
||||
tags: { $all: ['typescript', 'mongodb'] }, // Must have all tags
|
||||
skills: { $size: 5 } // Exactly 5 skills
|
||||
});
|
||||
|
||||
// Complex nested queries
|
||||
// Array element matching
|
||||
const results = await Order.getInstances({
|
||||
items: {
|
||||
$elemMatch: { // Match array elements
|
||||
product: 'laptop',
|
||||
quantity: { $gte: 2 }
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Check if value exists in array field
|
||||
const nodeUsers = await User.getInstances({
|
||||
skills: { $in: ['nodejs'] } // Has nodejs in skills array
|
||||
});
|
||||
```
|
||||
|
||||
#### Logical Operators
|
||||
|
||||
```typescript
|
||||
// Complex nested queries with $and
|
||||
const results = await Order.getInstances({
|
||||
$and: [
|
||||
{ status: { $in: ['pending', 'processing'] } },
|
||||
{ 'items.price': { $gte: 100 } }, // Dot notation for nested fields
|
||||
{
|
||||
items: {
|
||||
$elemMatch: { // Array element matching
|
||||
product: 'laptop',
|
||||
quantity: { $gte: 2 }
|
||||
}
|
||||
}
|
||||
}
|
||||
{ 'items.price': { $gte: 100 } },
|
||||
{ customer: { verified: true } }
|
||||
]
|
||||
});
|
||||
|
||||
// Logical operators
|
||||
// $or operator
|
||||
const urgentOrHighValue = await Order.getInstances({
|
||||
$or: [
|
||||
{ priority: 'urgent' },
|
||||
@@ -185,8 +275,94 @@ const urgentOrHighValue = await Order.getInstances({
|
||||
]
|
||||
});
|
||||
|
||||
// Security: $where is automatically blocked
|
||||
// $nor operator - none of the conditions
|
||||
const excluded = await User.getInstances({
|
||||
$nor: [
|
||||
{ status: 'banned' },
|
||||
{ role: 'guest' }
|
||||
]
|
||||
});
|
||||
|
||||
// Combine logical operators
|
||||
const complex = await Order.getInstances({
|
||||
$and: [
|
||||
{ status: 'active' },
|
||||
{
|
||||
$or: [
|
||||
{ priority: 'high' },
|
||||
{ value: { $gte: 1000 } }
|
||||
]
|
||||
}
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
#### Element Operators
|
||||
|
||||
```typescript
|
||||
// Check field existence
|
||||
const withEmail = await User.getInstances({
|
||||
email: { $exists: true }
|
||||
});
|
||||
|
||||
// Check for null or missing nested fields
|
||||
const noPreferences = await User.getInstances({
|
||||
'profile.preferences': { $exists: false }
|
||||
});
|
||||
```
|
||||
|
||||
#### Text and Pattern Matching
|
||||
|
||||
```typescript
|
||||
// Regex patterns
|
||||
const gmailUsers = await User.getInstances({
|
||||
email: { $regex: '@gmail\\.com$', $options: 'i' }
|
||||
});
|
||||
|
||||
// Starts with pattern
|
||||
const johnUsers = await User.getInstances({
|
||||
name: { $regex: '^John' }
|
||||
});
|
||||
```
|
||||
|
||||
#### Security Features
|
||||
|
||||
```typescript
|
||||
// Security: $where is automatically blocked for injection protection
|
||||
// await User.getInstances({ $where: '...' }); // ❌ Throws security error
|
||||
|
||||
// Invalid operators are caught
|
||||
// await User.getInstances({ $badOp: 'value' }); // ⚠️ Warning logged
|
||||
```
|
||||
|
||||
#### Advanced Patterns
|
||||
|
||||
```typescript
|
||||
// Combine multiple filtering approaches
|
||||
const advancedQuery = await User.getInstances({
|
||||
// Direct field matching
|
||||
status: 'active',
|
||||
|
||||
// Nested object with operators
|
||||
profile: {
|
||||
age: { $gte: 18, $lte: 65 },
|
||||
verified: true
|
||||
},
|
||||
|
||||
// Dot notation for deep paths
|
||||
'settings.notifications.email': true,
|
||||
'metadata.lastLogin': { $gte: new Date(Date.now() - 30*24*60*60*1000) },
|
||||
|
||||
// Array operations
|
||||
roles: { $in: ['admin', 'moderator'] },
|
||||
tags: { $all: ['verified', 'premium'] },
|
||||
|
||||
// Logical grouping
|
||||
$or: [
|
||||
{ 'subscription.plan': 'premium' },
|
||||
{ 'subscription.trial': true }
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
### 🔎 Powerful Search Engine
|
||||
|
||||
255
test/test.deno.ts
Normal file
255
test/test.deno.ts
Normal file
@@ -0,0 +1,255 @@
|
||||
// TODO: Decorator support during testing for bun and deno in @git.zone/tstest
|
||||
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { Qenv } from '@push.rocks/qenv';
|
||||
import * as smartmongo from '@push.rocks/smartmongo';
|
||||
import { smartunique } from '../ts/plugins.js';
|
||||
|
||||
import * as mongodb from 'mongodb';
|
||||
|
||||
const testQenv = new Qenv(process.cwd(), process.cwd() + '/.nogit/');
|
||||
|
||||
console.log(process.memoryUsage());
|
||||
|
||||
// the tested module
|
||||
import * as smartdata from '../ts/index.js';
|
||||
|
||||
// =======================================
|
||||
// Connecting to the database server
|
||||
// =======================================
|
||||
|
||||
let smartmongoInstance: smartmongo.SmartMongo;
|
||||
let testDb: smartdata.SmartdataDb;
|
||||
|
||||
const totalCars = 2000;
|
||||
|
||||
tap.test('should create a testinstance as database', async () => {
|
||||
const databaseName = `test-smartdata-deno-${smartunique.shortId()}`;
|
||||
testDb = new smartdata.SmartdataDb({
|
||||
mongoDbUrl: await testQenv.getEnvVarOnDemand('MONGODB_URL'),
|
||||
mongoDbName: databaseName,
|
||||
});
|
||||
await testDb.init();
|
||||
});
|
||||
|
||||
// =======================================
|
||||
// The actual tests
|
||||
// =======================================
|
||||
|
||||
// ------
|
||||
// Collections
|
||||
// ------
|
||||
|
||||
@smartdata.Collection(() => {
|
||||
return testDb;
|
||||
})
|
||||
class Car extends smartdata.SmartDataDbDoc<Car, Car> {
|
||||
@smartdata.unI()
|
||||
public index: string = smartunique.shortId();
|
||||
|
||||
@smartdata.svDb()
|
||||
public color: string;
|
||||
|
||||
@smartdata.svDb()
|
||||
public brand: string;
|
||||
|
||||
@smartdata.svDb()
|
||||
public testBuffer = Buffer.from('hello');
|
||||
|
||||
@smartdata.svDb()
|
||||
deepData = {
|
||||
sodeep: 'yes',
|
||||
};
|
||||
|
||||
constructor(colorArg: string, brandArg: string) {
|
||||
super();
|
||||
this.color = colorArg;
|
||||
this.brand = brandArg;
|
||||
}
|
||||
}
|
||||
|
||||
tap.test('should create a new id', async () => {
|
||||
const newid = await Car.getNewId();
|
||||
console.log(newid);
|
||||
});
|
||||
|
||||
tap.test('should save the car to the db', async (toolsArg) => {
|
||||
const myCar = new Car('red', 'Volvo');
|
||||
console.log('Car.collection.smartdataDb:', (Car.collection as any).smartdataDb?.mongoDb?.databaseName);
|
||||
console.log('Car.collection.collectionName:', (Car.collection as any).collectionName);
|
||||
console.log('testDb.mongoDb.databaseName:', testDb.mongoDb.databaseName);
|
||||
await myCar.save();
|
||||
|
||||
const myCar2 = new Car('red', 'Volvo');
|
||||
await myCar2.save();
|
||||
|
||||
let counter = 0;
|
||||
|
||||
const gottenCarInstance = await Car.getInstance({});
|
||||
console.log(gottenCarInstance.testBuffer instanceof mongodb.Binary);
|
||||
process.memoryUsage();
|
||||
do {
|
||||
const myCar3 = new Car('red', 'Renault');
|
||||
await myCar3.save();
|
||||
counter++;
|
||||
if (counter % 100 === 0) {
|
||||
console.log(
|
||||
`Filled database with ${counter} of ${totalCars} Cars and memory usage ${
|
||||
process.memoryUsage().rss / 1e6
|
||||
} MB`,
|
||||
);
|
||||
}
|
||||
} while (counter < totalCars);
|
||||
console.log(process.memoryUsage());
|
||||
|
||||
// DEBUG: Check what's actually in the database
|
||||
const savedCount = await Car.getCount({});
|
||||
console.log('Total cars saved in DB:', savedCount);
|
||||
const renaultCount = await Car.getCount({ brand: 'Renault' });
|
||||
console.log('Renault cars in DB:', renaultCount);
|
||||
|
||||
// Check what's actually in the first saved car
|
||||
const firstCar = await Car.getInstance({});
|
||||
console.log('First car data:', JSON.stringify({
|
||||
color: firstCar?.color,
|
||||
brand: firstCar?.brand,
|
||||
index: firstCar?.index
|
||||
}));
|
||||
});
|
||||
|
||||
tap.test('expect to get instance of Car with shallow match', async () => {
|
||||
console.log('Before query - testDb.mongoDb.databaseName:', testDb.mongoDb.databaseName);
|
||||
console.log('Before query - Car.collection.smartdataDb:', (Car.collection as any).smartdataDb?.mongoDb?.databaseName);
|
||||
console.log('Before query - Car.collection.collectionName:', (Car.collection as any).collectionName);
|
||||
|
||||
const totalQueryCycles = totalCars / 2;
|
||||
let counter = 0;
|
||||
do {
|
||||
const timeStart = Date.now();
|
||||
const myCars = await Car.getInstances({
|
||||
brand: 'Renault',
|
||||
});
|
||||
if (counter % 10 === 0) {
|
||||
console.log(
|
||||
`performed ${counter} of ${totalQueryCycles} total query cycles: took ${
|
||||
Date.now() - timeStart
|
||||
}ms to query a set of 2000 with memory footprint ${process.memoryUsage().rss / 1e6} MB`,
|
||||
);
|
||||
console.log('myCars.length:', myCars.length);
|
||||
console.log('myCars[0]:', myCars[0]);
|
||||
}
|
||||
expect(myCars[0].deepData.sodeep).toEqual('yes');
|
||||
expect(myCars[0].brand).toEqual('Renault');
|
||||
counter++;
|
||||
} while (counter < totalQueryCycles);
|
||||
});
|
||||
|
||||
tap.test('expect to get instance of Car with deep match', async () => {
|
||||
const totalQueryCycles = totalCars / 6;
|
||||
let counter = 0;
|
||||
do {
|
||||
const timeStart = Date.now();
|
||||
const myCars2 = await Car.getInstances({
|
||||
deepData: {
|
||||
sodeep: 'yes',
|
||||
},
|
||||
});
|
||||
if (counter % 10 === 0) {
|
||||
console.log(
|
||||
`performed ${counter} of ${totalQueryCycles} total query cycles: took ${
|
||||
Date.now() - timeStart
|
||||
}ms to deep query a set of 2000 with memory footprint ${process.memoryUsage().rss / 1e6} MB`,
|
||||
);
|
||||
}
|
||||
expect(myCars2[0].deepData.sodeep).toEqual('yes');
|
||||
expect(myCars2[0].brand).toEqual('Volvo');
|
||||
counter++;
|
||||
} while (counter < totalQueryCycles);
|
||||
});
|
||||
|
||||
tap.test('expect to get instance of Car and update it', async () => {
|
||||
const myCar = await Car.getInstance<Car>({
|
||||
brand: 'Volvo',
|
||||
});
|
||||
expect(myCar.color).toEqual('red');
|
||||
myCar.color = 'blue';
|
||||
await myCar.save();
|
||||
});
|
||||
|
||||
tap.test('should be able to delete an instance of car', async () => {
|
||||
const myCars = await Car.getInstances({
|
||||
brand: 'Volvo',
|
||||
color: 'blue',
|
||||
});
|
||||
console.log(myCars);
|
||||
expect(myCars[0].color).toEqual('blue');
|
||||
for (const myCar of myCars) {
|
||||
await myCar.delete();
|
||||
}
|
||||
|
||||
const myCar2 = await Car.getInstance<Car>({
|
||||
brand: 'Volvo',
|
||||
});
|
||||
expect(myCar2.color).toEqual('red');
|
||||
});
|
||||
|
||||
// tslint:disable-next-line: max-classes-per-file
|
||||
@smartdata.Collection(() => {
|
||||
return testDb;
|
||||
})
|
||||
class Truck extends smartdata.SmartDataDbDoc<Car, Car> {
|
||||
@smartdata.unI()
|
||||
public id: string = smartunique.shortId();
|
||||
|
||||
@smartdata.svDb()
|
||||
public color: string;
|
||||
|
||||
@smartdata.svDb()
|
||||
public brand: string;
|
||||
|
||||
constructor(colorArg: string, brandArg: string) {
|
||||
super();
|
||||
this.color = colorArg;
|
||||
this.brand = brandArg;
|
||||
}
|
||||
}
|
||||
|
||||
tap.test('should store a new Truck', async () => {
|
||||
const truck = new Truck('blue', 'MAN');
|
||||
await truck.save();
|
||||
const myTruck2 = await Truck.getInstance({ color: 'blue' });
|
||||
expect(myTruck2.color).toEqual('blue');
|
||||
myTruck2.color = 'red';
|
||||
await myTruck2.save();
|
||||
const myTruck3 = await Truck.getInstance({ color: 'blue' });
|
||||
expect(myTruck3).toBeNull();
|
||||
});
|
||||
|
||||
tap.test('should return a count', async () => {
|
||||
const truckCount = await Truck.getCount();
|
||||
expect(truckCount).toEqual(1);
|
||||
});
|
||||
|
||||
tap.test('should use a cursor', async () => {
|
||||
const cursor = await Car.getCursor({});
|
||||
let counter = 0;
|
||||
await cursor.forEach(async (carArg) => {
|
||||
counter++;
|
||||
counter % 50 === 0 ? console.log(`50 more of ${carArg.color}`) : null;
|
||||
});
|
||||
});
|
||||
|
||||
// =======================================
|
||||
// close the database connection
|
||||
// =======================================
|
||||
tap.test('close', async () => {
|
||||
if (smartmongoInstance) {
|
||||
await smartmongoInstance.stopAndDumpToDir('./.nogit/dbdump/test.ts');
|
||||
} else {
|
||||
await testDb.mongoDb.dropDatabase();
|
||||
await testDb.close();
|
||||
}
|
||||
setTimeout(() => process.exit(), 2000);
|
||||
});
|
||||
|
||||
tap.start({ throwOnError: true });
|
||||
@@ -213,6 +213,221 @@ tap.test('should filter by nested object fields', async () => {
|
||||
expect(users[0].name).toEqual('John Doe');
|
||||
});
|
||||
|
||||
// ============= COMPREHENSIVE NESTED FILTER TESTS =============
|
||||
tap.test('should filter by nested object with direct object syntax', async () => {
|
||||
// Direct nested object matching (exact match)
|
||||
const users = await TestUser.getInstances({
|
||||
metadata: {
|
||||
loginCount: 5,
|
||||
lastLogin: (await TestUser.getInstances({}))[0].metadata.lastLogin // Get the exact date
|
||||
}
|
||||
});
|
||||
expect(users.length).toEqual(1);
|
||||
expect(users[0].name).toEqual('John Doe');
|
||||
});
|
||||
|
||||
tap.test('should filter by partial nested object match', async () => {
|
||||
// When using object syntax, only specified fields must match
|
||||
const users = await TestUser.getInstances({
|
||||
metadata: { loginCount: 5 } // Only checks loginCount, ignores other fields
|
||||
});
|
||||
expect(users.length).toEqual(1);
|
||||
expect(users[0].name).toEqual('John Doe');
|
||||
});
|
||||
|
||||
tap.test('should combine nested object and dot notation', async () => {
|
||||
const users = await TestUser.getInstances({
|
||||
metadata: { loginCount: { $gte: 3 } }, // Object syntax with operator
|
||||
'metadata.loginCount': { $lte: 10 } // Dot notation with operator
|
||||
});
|
||||
expect(users.length).toEqual(3); // Jane (3), John (5), and Alice (10) have loginCount between 3-10
|
||||
});
|
||||
|
||||
tap.test('should filter nested fields with operators using dot notation', async () => {
|
||||
const users = await TestUser.getInstances({
|
||||
'metadata.loginCount': { $gte: 5 }
|
||||
});
|
||||
expect(users.length).toEqual(2); // John (5) and Alice (10)
|
||||
const names = users.map(u => u.name).sort();
|
||||
expect(names).toEqual(['Alice Brown', 'John Doe']);
|
||||
});
|
||||
|
||||
tap.test('should filter nested fields with multiple operators', async () => {
|
||||
const users = await TestUser.getInstances({
|
||||
'metadata.loginCount': { $gte: 3, $lt: 10 }
|
||||
});
|
||||
expect(users.length).toEqual(2); // Jane (3) and John (5)
|
||||
const names = users.map(u => u.name).sort();
|
||||
expect(names).toEqual(['Jane Smith', 'John Doe']);
|
||||
});
|
||||
|
||||
tap.test('should handle deeply nested object structures', async () => {
|
||||
// First, create a user with deep nesting in preferences
|
||||
const deepUser = new TestUser({
|
||||
name: 'Deep Nester',
|
||||
age: 40,
|
||||
email: 'deep@example.com',
|
||||
roles: ['admin'],
|
||||
tags: [],
|
||||
status: 'active',
|
||||
metadata: {
|
||||
loginCount: 1,
|
||||
preferences: {
|
||||
theme: {
|
||||
colors: {
|
||||
primary: '#000000',
|
||||
secondary: '#ffffff'
|
||||
},
|
||||
fonts: {
|
||||
heading: 'Arial',
|
||||
body: 'Helvetica'
|
||||
}
|
||||
},
|
||||
notifications: {
|
||||
email: true,
|
||||
push: false
|
||||
}
|
||||
}
|
||||
},
|
||||
scores: []
|
||||
});
|
||||
await deepUser.save();
|
||||
|
||||
// Test deep nesting with dot notation
|
||||
const deepResults = await TestUser.getInstances({
|
||||
'metadata.preferences.theme.colors.primary': '#000000'
|
||||
});
|
||||
expect(deepResults.length).toEqual(1);
|
||||
expect(deepResults[0].name).toEqual('Deep Nester');
|
||||
|
||||
// Test deep nesting with operators
|
||||
const boolResults = await TestUser.getInstances({
|
||||
'metadata.preferences.notifications.email': { $eq: true }
|
||||
});
|
||||
expect(boolResults.length).toEqual(1);
|
||||
expect(boolResults[0].name).toEqual('Deep Nester');
|
||||
|
||||
// Clean up
|
||||
await deepUser.delete();
|
||||
});
|
||||
|
||||
tap.test('should filter arrays of nested objects using $elemMatch', async () => {
|
||||
const orders = await TestOrder.getInstances({
|
||||
items: {
|
||||
$elemMatch: {
|
||||
product: 'laptop',
|
||||
price: { $gte: 1000 }
|
||||
}
|
||||
}
|
||||
});
|
||||
expect(orders.length).toEqual(2); // Both laptop orders have price >= 1000
|
||||
});
|
||||
|
||||
tap.test('should filter nested arrays with dot notation', async () => {
|
||||
// Query for any order that has an item with specific product
|
||||
const orders = await TestOrder.getInstances({
|
||||
'items.product': 'laptop'
|
||||
});
|
||||
expect(orders.length).toEqual(2); // Two orders contain laptops
|
||||
});
|
||||
|
||||
tap.test('should combine nested object filters with logical operators', async () => {
|
||||
const users = await TestUser.getInstances({
|
||||
$or: [
|
||||
{ 'metadata.loginCount': { $gte: 10 } }, // Alice has 10
|
||||
{
|
||||
$and: [
|
||||
{ 'metadata.loginCount': { $lt: 5 } }, // Jane has 3, Bob has 0, Charlie has 1
|
||||
{ status: 'active' } // Jane is active, Bob is inactive, Charlie is pending
|
||||
]
|
||||
}
|
||||
]
|
||||
});
|
||||
expect(users.length).toEqual(2); // Alice (loginCount >= 10), Jane (loginCount < 5 AND active)
|
||||
const names = users.map(u => u.name).sort();
|
||||
expect(names).toEqual(['Alice Brown', 'Jane Smith']);
|
||||
});
|
||||
|
||||
tap.test('should handle null and undefined in nested fields', async () => {
|
||||
// Users without lastLogin
|
||||
const noLastLogin = await TestUser.getInstances({
|
||||
'metadata.lastLogin': { $exists: false }
|
||||
});
|
||||
expect(noLastLogin.length).toEqual(4); // Everyone except John
|
||||
|
||||
// Users with preferences (none have it set)
|
||||
const withPreferences = await TestUser.getInstances({
|
||||
'metadata.preferences': { $exists: true }
|
||||
});
|
||||
expect(withPreferences.length).toEqual(0);
|
||||
});
|
||||
|
||||
tap.test('should filter nested arrays by size', async () => {
|
||||
// Create an order with specific number of items
|
||||
const multiItemOrder = new TestOrder({
|
||||
userId: 'test-user',
|
||||
items: [
|
||||
{ product: 'item1', quantity: 1, price: 10 },
|
||||
{ product: 'item2', quantity: 2, price: 20 },
|
||||
{ product: 'item3', quantity: 3, price: 30 },
|
||||
{ product: 'item4', quantity: 4, price: 40 }
|
||||
],
|
||||
totalAmount: 100,
|
||||
status: 'pending',
|
||||
tags: ['test']
|
||||
});
|
||||
await multiItemOrder.save();
|
||||
|
||||
const fourItemOrders = await TestOrder.getInstances({
|
||||
items: { $size: 4 }
|
||||
});
|
||||
expect(fourItemOrders.length).toEqual(1);
|
||||
|
||||
// Clean up
|
||||
await multiItemOrder.delete();
|
||||
});
|
||||
|
||||
tap.test('should handle nested field comparison between documents', async () => {
|
||||
// Find users where loginCount equals their age divided by 6 (John: 30/6=5)
|
||||
const users = await TestUser.getInstances({
|
||||
$and: [
|
||||
{ 'metadata.loginCount': 5 },
|
||||
{ age: 30 }
|
||||
]
|
||||
});
|
||||
expect(users.length).toEqual(1);
|
||||
expect(users[0].name).toEqual('John Doe');
|
||||
});
|
||||
|
||||
tap.test('should filter using $in on nested fields', async () => {
|
||||
const users = await TestUser.getInstances({
|
||||
'metadata.loginCount': { $in: [0, 1, 5] }
|
||||
});
|
||||
expect(users.length).toEqual(3); // Bob (0), Charlie (1), John (5)
|
||||
const names = users.map(u => u.name).sort();
|
||||
expect(names).toEqual(['Bob Johnson', 'Charlie Wilson', 'John Doe']);
|
||||
});
|
||||
|
||||
tap.test('should filter nested arrays with $all', async () => {
|
||||
// Create an order with multiple tags
|
||||
const taggedOrder = new TestOrder({
|
||||
userId: 'test-user',
|
||||
items: [{ product: 'test', quantity: 1, price: 10 }],
|
||||
totalAmount: 10,
|
||||
status: 'completed',
|
||||
tags: ['urgent', 'priority', 'electronics']
|
||||
});
|
||||
await taggedOrder.save();
|
||||
|
||||
const priorityElectronics = await TestOrder.getInstances({
|
||||
tags: { $all: ['priority', 'electronics'] }
|
||||
});
|
||||
expect(priorityElectronics.length).toEqual(2); // Original order and new one
|
||||
|
||||
// Clean up
|
||||
await taggedOrder.delete();
|
||||
});
|
||||
|
||||
// ============= COMPARISON OPERATOR TESTS =============
|
||||
tap.test('should filter using $gt operator', async () => {
|
||||
const users = await TestUser.getInstances({
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
// TODO: Decorator support during testing for bun and deno in @git.zone/tstest
|
||||
|
||||
import { tap, expect } from '@push.rocks/tapbundle';
|
||||
import { Qenv } from '@push.rocks/qenv';
|
||||
import * as smartmongo from '@push.rocks/smartmongo';
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartdata',
|
||||
version: '5.16.3',
|
||||
version: '5.16.6',
|
||||
description: 'An advanced library for NoSQL data organization and manipulation using TypeScript with support for MongoDB, data validation, collections, and custom data types.'
|
||||
}
|
||||
|
||||
@@ -27,30 +27,51 @@ const collectionFactory = new CollectionFactory();
|
||||
*/
|
||||
export function Collection(dbArg: SmartdataDb | TDelayed<SmartdataDb>) {
|
||||
return function classDecorator<T extends { new (...args: any[]): {} }>(constructor: T) {
|
||||
// Capture original constructor's prototype in closure for Deno compatibility
|
||||
const originalPrototype = constructor.prototype;
|
||||
const originalConstructor = constructor as any;
|
||||
|
||||
const getCollection = () => {
|
||||
if (!(dbArg instanceof SmartdataDb)) {
|
||||
dbArg = dbArg();
|
||||
}
|
||||
const coll = collectionFactory.getCollection(constructor.name, dbArg);
|
||||
// Attach document constructor for searchableFields lookup
|
||||
if (!(coll as any).docCtor) {
|
||||
(coll as any).docCtor = decoratedClass;
|
||||
}
|
||||
return coll;
|
||||
};
|
||||
|
||||
const decoratedClass = class extends constructor {
|
||||
public static className = constructor.name;
|
||||
public static get collection() {
|
||||
if (!(dbArg instanceof SmartdataDb)) {
|
||||
dbArg = dbArg();
|
||||
}
|
||||
const coll = collectionFactory.getCollection(constructor.name, dbArg);
|
||||
// Attach document constructor for searchableFields lookup
|
||||
if (!(coll as any).docCtor) {
|
||||
(coll as any).docCtor = decoratedClass;
|
||||
}
|
||||
return coll;
|
||||
return getCollection();
|
||||
}
|
||||
public get collection() {
|
||||
if (!(dbArg instanceof SmartdataDb)) {
|
||||
dbArg = dbArg();
|
||||
}
|
||||
const coll = collectionFactory.getCollection(constructor.name, dbArg);
|
||||
if (!(coll as any).docCtor) {
|
||||
(coll as any).docCtor = decoratedClass;
|
||||
}
|
||||
return coll;
|
||||
return getCollection();
|
||||
}
|
||||
};
|
||||
|
||||
// Ensure instance getter works in Deno by defining it on the prototype
|
||||
Object.defineProperty(decoratedClass.prototype, 'collection', {
|
||||
get: getCollection,
|
||||
enumerable: false,
|
||||
configurable: true
|
||||
});
|
||||
|
||||
// Deno compatibility note: Property decorators set properties on the prototype.
|
||||
// Since we removed instance property declarations from SmartDataDbDoc,
|
||||
// the decorator-set prototype properties are now accessible without shadowing.
|
||||
// No manual forwarding needed - natural prototype inheritance works!
|
||||
|
||||
// Point to original constructor's _svDbOptions
|
||||
Object.defineProperty(decoratedClass, '_svDbOptions', {
|
||||
get() { return originalConstructor._svDbOptions; },
|
||||
set(value) { originalConstructor._svDbOptions = value; },
|
||||
configurable: true
|
||||
});
|
||||
|
||||
return decoratedClass;
|
||||
};
|
||||
}
|
||||
|
||||
@@ -199,21 +199,51 @@ export const convertFilterForMongoDb = (filterArg: { [key: string]: any }) => {
|
||||
throw new Error('$where operator is not allowed for security reasons');
|
||||
}
|
||||
|
||||
// Special case: detect MongoDB operators and pass them through directly
|
||||
const topLevelOperators = ['$and', '$or', '$nor', '$not', '$text', '$regex'];
|
||||
// Handle logical operators recursively
|
||||
const logicalOperators = ['$and', '$or', '$nor', '$not'];
|
||||
const processedFilter: { [key: string]: any } = {};
|
||||
|
||||
for (const key of Object.keys(filterArg)) {
|
||||
if (topLevelOperators.includes(key)) {
|
||||
return filterArg; // Return the filter as-is for MongoDB operators
|
||||
if (logicalOperators.includes(key)) {
|
||||
if (key === '$not') {
|
||||
processedFilter[key] = convertFilterForMongoDb(filterArg[key]);
|
||||
} else if (Array.isArray(filterArg[key])) {
|
||||
processedFilter[key] = filterArg[key].map((subFilter: any) => convertFilterForMongoDb(subFilter));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If only logical operators, return them
|
||||
const hasOnlyLogicalOperators = Object.keys(filterArg).every(key => logicalOperators.includes(key));
|
||||
if (hasOnlyLogicalOperators) {
|
||||
return processedFilter;
|
||||
}
|
||||
|
||||
// Original conversion logic for non-MongoDB query objects
|
||||
const convertedFilter: { [key: string]: any } = {};
|
||||
|
||||
// Helper to merge operator objects
|
||||
const mergeIntoConverted = (path: string, value: any) => {
|
||||
const existing = convertedFilter[path];
|
||||
if (!existing) {
|
||||
convertedFilter[path] = value;
|
||||
} else if (
|
||||
typeof existing === 'object' && !Array.isArray(existing) &&
|
||||
typeof value === 'object' && !Array.isArray(value) &&
|
||||
(Object.keys(existing).some(k => k.startsWith('$')) || Object.keys(value).some(k => k.startsWith('$')))
|
||||
) {
|
||||
// Both have operators, merge them
|
||||
convertedFilter[path] = { ...existing, ...value };
|
||||
} else {
|
||||
// Otherwise later wins
|
||||
convertedFilter[path] = value;
|
||||
}
|
||||
};
|
||||
|
||||
const convertFilterArgument = (keyPathArg2: string, filterArg2: any) => {
|
||||
if (Array.isArray(filterArg2)) {
|
||||
// Arrays are typically used as values for operators like $in or as direct equality matches
|
||||
convertedFilter[keyPathArg2] = filterArg2;
|
||||
mergeIntoConverted(keyPathArg2, filterArg2);
|
||||
return;
|
||||
} else if (typeof filterArg2 === 'object' && filterArg2 !== null) {
|
||||
// Check if this is an object with MongoDB operators
|
||||
@@ -264,8 +294,8 @@ export const convertFilterForMongoDb = (filterArg: { [key: string]: any }) => {
|
||||
throw new Error('$size operator requires a numeric value');
|
||||
}
|
||||
|
||||
// Pass the operator object through
|
||||
convertedFilter[keyPathArg2] = filterArg2;
|
||||
// Use merge helper to handle duplicate paths
|
||||
mergeIntoConverted(keyPathArg2, filterArg2);
|
||||
return;
|
||||
}
|
||||
|
||||
@@ -282,13 +312,20 @@ export const convertFilterForMongoDb = (filterArg: { [key: string]: any }) => {
|
||||
}
|
||||
} else {
|
||||
// Primitive values
|
||||
convertedFilter[keyPathArg2] = filterArg2;
|
||||
mergeIntoConverted(keyPathArg2, filterArg2);
|
||||
}
|
||||
};
|
||||
|
||||
for (const key of Object.keys(filterArg)) {
|
||||
convertFilterArgument(key, filterArg[key]);
|
||||
// Skip logical operators, they were already processed
|
||||
if (!logicalOperators.includes(key)) {
|
||||
convertFilterArgument(key, filterArg[key]);
|
||||
}
|
||||
}
|
||||
|
||||
// Add back processed logical operators
|
||||
Object.assign(convertedFilter, processedFilter);
|
||||
|
||||
return convertedFilter;
|
||||
};
|
||||
|
||||
@@ -302,6 +339,13 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
public static manager;
|
||||
public manager: TManager;
|
||||
|
||||
/**
|
||||
* Helper to get collection with fallback to static for Deno compatibility
|
||||
*/
|
||||
private getCollectionSafe(): SmartdataCollection<any> {
|
||||
return this.collection || (this.constructor as any).collection;
|
||||
}
|
||||
|
||||
// STATIC
|
||||
public static createInstanceFromMongoDbNativeDoc<T>(
|
||||
this: plugins.tsclass.typeFest.Class<T>,
|
||||
@@ -661,23 +705,28 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
|
||||
/**
|
||||
* an array of saveable properties of ALL doc
|
||||
* Note: Set by decorators on prototype - NOT declared as instance property to avoid shadowing in Deno
|
||||
* Declared with definite assignment assertion to satisfy TypeScript without creating instance property
|
||||
*/
|
||||
public globalSaveableProperties: string[];
|
||||
declare globalSaveableProperties: string[];
|
||||
|
||||
/**
|
||||
* unique indexes
|
||||
* Note: Set by decorators on prototype - NOT declared as instance property to avoid shadowing in Deno
|
||||
*/
|
||||
public uniqueIndexes: string[];
|
||||
declare uniqueIndexes: string[];
|
||||
|
||||
/**
|
||||
* regular indexes with their options
|
||||
* Note: Set by decorators on prototype - NOT declared as instance property to avoid shadowing in Deno
|
||||
*/
|
||||
public regularIndexes: Array<{field: string, options: IIndexOptions}> = [];
|
||||
declare regularIndexes: Array<{field: string, options: IIndexOptions}>;
|
||||
|
||||
/**
|
||||
* an array of saveable properties of a specific doc
|
||||
* Note: Set by decorators on prototype - NOT declared as instance property to avoid shadowing in Deno
|
||||
*/
|
||||
public saveableProperties: string[];
|
||||
declare saveableProperties: string[];
|
||||
|
||||
/**
|
||||
* name
|
||||
@@ -710,10 +759,10 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
// perform insert or update
|
||||
switch (this.creationStatus) {
|
||||
case 'db':
|
||||
dbResult = await this.collection.update(self, { session: opts?.session });
|
||||
dbResult = await this.getCollectionSafe().update(self, { session: opts?.session });
|
||||
break;
|
||||
case 'new':
|
||||
dbResult = await this.collection.insert(self, { session: opts?.session });
|
||||
dbResult = await this.getCollectionSafe().insert(self, { session: opts?.session });
|
||||
this.creationStatus = 'db';
|
||||
break;
|
||||
default:
|
||||
@@ -735,7 +784,7 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
await (this as any).beforeDelete();
|
||||
}
|
||||
// perform deletion
|
||||
const result = await this.collection.delete(this, { session: opts?.session });
|
||||
const result = await this.getCollectionSafe().delete(this, { session: opts?.session });
|
||||
// allow hook after delete
|
||||
if (typeof (this as any).afterDelete === 'function') {
|
||||
await (this as any).afterDelete();
|
||||
@@ -765,7 +814,7 @@ export class SmartDataDbDoc<T extends TImplements, TImplements, TManager extends
|
||||
* updates an object from db
|
||||
*/
|
||||
public async updateFromDb(): Promise<boolean> {
|
||||
const mongoDbNativeDoc = await this.collection.findOne(await this.createIdentifiableObject());
|
||||
const mongoDbNativeDoc = await this.getCollectionSafe().findOne(await this.createIdentifiableObject());
|
||||
if (!mongoDbNativeDoc) {
|
||||
return false; // Document not found in database
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { SmartDataDbDoc } from './classes.doc.js';
|
||||
import * as plugins from './plugins.js';
|
||||
import { EventEmitter } from 'events';
|
||||
import { EventEmitter } from 'node:events';
|
||||
|
||||
/**
|
||||
* a wrapper for the native mongodb cursor. Exposes better
|
||||
|
||||
Reference in New Issue
Block a user