@sprucelabs/data-stores 28.0.26 → 28.1.1

package/build/databases/MongoDatabase.d.ts

@@ -1,5 +1,5 @@
 import { MongoClientOptions, MongoClient } from 'mongodb';
-import { Database, DatabaseOptions } from '../types/database.types';
+import { Database, DatabaseOptions, IndexWithFilter, UniqueIndex } from '../types/database.types';
 import { QueryOptions } from '../types/query.types';
 export declare const MONGO_TEST_URI = "mongodb://localhost:27017";
 export default class MongoDatabase implements Database {
@@ -33,8 +33,9 @@ export default class MongoDatabase implements Database {
     private assertIndexDoesNotExist;
     private doesIndexExist;
     syncIndexes(collectionName: string, indexes: string[][]): Promise<void>;
-    createUniqueIndex(collection: string, fields: string[]): Promise<void>;
-    syncUniqueIndexes(collectionName: string, indexes: string[][]): Promise<void>;
+    createUniqueIndex(collection: string, index: string[] | IndexWithFilter): Promise<void>;
+    private normalizeIndex;
+    syncUniqueIndexes(collectionName: string, indexes: UniqueIndex[]): Promise<void>;
     update(collection: string, query: Record<string, any>, updates: Record<string, any>): Promise<number>;
     updateOne(collection: string, query: Record<string, any>, updates: Record<string, any>): Promise<Record<string, any>>;
     upsertOne(collection: string, query: Record<string, any>, updates: Record<string, any>): Promise<Record<string, any>>;

package/build/databases/MongoDatabase.js

@@ -22,6 +22,7 @@ const mongodb_1 = require("mongodb");
 const SpruceError_1 = __importDefault(require("../errors/SpruceError"));
 const generateId_1 = __importDefault(require("../utilities/generateId"));
 const mongo_utility_1 = __importDefault(require("../utilities/mongo.utility"));
+const normalizeIndex_1 = __importDefault(require("./normalizeIndex"));
 exports.MONGO_TEST_URI = 'mongodb://localhost:27017';
 class MongoDatabase {
     constructor(url, options) {
@@ -321,7 +322,8 @@ class MongoDatabase {
     }
     doesIndexExist(currentIndexes, fields) {
         for (const index of currentIndexes !== null && currentIndexes !== void 0 ? currentIndexes : []) {
-            if ((0, isEqual_1.default)(index, fields)) {
+            const { fields: normalizedFields } = this.normalizeIndex(index);
+            if ((0, isEqual_1.default)(normalizedFields, fields)) {
                 return true;
             }
         }
@@ -339,17 +341,22 @@ class MongoDatabase {
             await this.dropIndex(collectionName, extra);
         }
     }
-    async createUniqueIndex(collection, fields) {
+    async createUniqueIndex(collection, index) {
         const currentIndexes = await this.getUniqueIndexes(collection);
-        await this.assertIndexDoesNotExist(currentIndexes, fields, collection);
-        const index = {};
+        const { fields, filter } = this.normalizeIndex(index);
+        this.assertIndexDoesNotExist(currentIndexes, fields, collection);
+        const created = {};
         fields.forEach((name) => {
-            index[name] = 1;
+            created[name] = 1;
         });
         try {
+            const options = { unique: true };
+            if (filter) {
+                options.partialFilterExpression = filter;
+            }
             await this.assertDbWhileAttempingTo('create a unique index.', collection)
                 .collection(collection)
-                .createIndex(index, { unique: true });
+                .createIndex(created, options);
         }
         catch (err) {
             if ((err === null || err === void 0 ? void 0 : err.code) === 11000) {
@@ -363,12 +370,25 @@ class MongoDatabase {
             }
         }
     }
+    normalizeIndex(index) {
+        const { fields, filter } = (0, normalizeIndex_1.default)(index);
+        return { fields, filter };
+    }
     async syncUniqueIndexes(collectionName, indexes) {
+        var _a;
         const currentIndexes = await this.getUniqueIndexes(collectionName);
         const extraIndexes = (0, differenceWith_1.default)(currentIndexes, indexes, isEqual_1.default);
         for (const index of indexes) {
-            if (!this.doesIndexExist(currentIndexes, index)) {
-                await this.createUniqueIndex(collectionName, index);
+            const { fields } = this.normalizeIndex(index);
+            if (!this.doesIndexExist(currentIndexes, fields)) {
+                try {
+                    await this.createUniqueIndex(collectionName, index);
+                }
+                catch (err) {
+                    if (((_a = err.options) === null || _a === void 0 ? void 0 : _a.code) !== 'INDEX_EXISTS') {
+                        throw err;
+                    }
+                }
             }
         }
         for (const extra of extraIndexes) {

package/build/databases/NeDbDatabase.d.ts

@@ -1,5 +1,5 @@
 import AbstractMutexer from '../mutexers/AbstractMutexer';
-import { CreateOptions, Database, DatabaseInternalOptions } from '../types/database.types';
+import { CreateOptions, Database, DatabaseInternalOptions, UniqueIndex } from '../types/database.types';
 import { QueryOptions } from '../types/query.types';
 export default class NeDbDatabase extends AbstractMutexer implements Database {
     private collections;
@@ -31,14 +31,14 @@ export default class NeDbDatabase extends AbstractMutexer implements Database {
     delete(collection: string, query: Record<string, any>): Promise<number>;
     deleteOne(collection: string, query: Record<string, any>): Promise<number>;
     private assertPassesUniqueIndexes;
-    getUniqueIndexes(collection: string): Promise<string[][]>;
-    getIndexes(collection: string, shouldIncludeUnique?: boolean): Promise<string[][]>;
-    dropIndex(collection: string, fields: string[]): Promise<void>;
+    getUniqueIndexes(collection: string): Promise<UniqueIndex[]>;
+    getIndexes(collection: string, shouldIncludeUnique?: boolean): Promise<UniqueIndex[]>;
+    dropIndex(collection: string, index: UniqueIndex): Promise<void>;
     private assertIndexDoesNotExist;
     private doesIndexExist;
-    createUniqueIndex(collection: string, fields: string[]): Promise<void>;
+    createUniqueIndex(collection: string, index: UniqueIndex): Promise<void>;
     createIndex(collection: string, fields: string[]): Promise<void>;
-    syncUniqueIndexes(collectionName: string, indexes: string[][]): Promise<void>;
+    syncUniqueIndexes(collectionName: string, indexes: UniqueIndex[]): Promise<void>;
     syncIndexes(collectionName: string, indexes: string[][]): Promise<void>;
     query<T>(query: string, params?: any[]): Promise<T[]>;
     private queryToKey;

package/build/databases/NeDbDatabase.js

@@ -26,6 +26,7 @@ const SpruceError_1 = __importDefault(require("../errors/SpruceError"));
 const AbstractMutexer_1 = __importDefault(require("../mutexers/AbstractMutexer"));
 const generateId_1 = __importDefault(require("../utilities/generateId"));
 const mongo_utility_1 = __importDefault(require("../utilities/mongo.utility"));
+const normalizeIndex_1 = __importDefault(require("./normalizeIndex"));
 dotenv_1.default.config();
 const NULL_PLACEHOLDER = '_____NULL_____';
 const UNDEFINED_PLACEHOLDER = '_____UNDEFINED_____';
@@ -292,7 +293,11 @@ class NeDbDatabase extends AbstractMutexer_1.default {
         const col = this.loadCollection(collection);
         await this.randomDelay();
         if (col._uniqueIndexes) {
-            for (const fields of col._uniqueIndexes) {
+            for (const index of col._uniqueIndexes) {
+                const { fields, filter } = (0, normalizeIndex_1.default)(index);
+                if (filter) {
+                    return;
+                }
                 const existing = query
                     ? await this.findOne(collection, query)
                     : null;
@@ -333,9 +338,10 @@ class NeDbDatabase extends AbstractMutexer_1.default {
         }
         return (_c = col._indexes) !== null && _c !== void 0 ? _c : [];
     }
-    async dropIndex(collection, fields) {
+    async dropIndex(collection, index) {
         var _a, _b;
         const col = this.loadCollection(collection);
+        const { fields } = (0, normalizeIndex_1.default)(index);
         await this.randomDelay();
         let found = false;
         let newIndexes = [];
@@ -389,18 +395,20 @@ class NeDbDatabase extends AbstractMutexer_1.default {
         }
         return false;
     }
-    async createUniqueIndex(collection, fields) {
+    async createUniqueIndex(collection, index) {
         const col = this.loadCollection(collection);
         if (!col._uniqueIndexes) {
             col._uniqueIndexes = [];
         }
+        const { fields, filter } = (0, normalizeIndex_1.default)(index);
         await this.randomDelay();
         this.assertIndexDoesNotExist(col._uniqueIndexes, fields, collection);
-        if (col._uniqueIndexes) {
+        if (col._uniqueIndexes && !filter) {
             const tempUniqueIndexes = [...col._uniqueIndexes];
             tempUniqueIndexes.push(fields);
-            const documents = (await this.find(collection, {})) || [];
-            for (const uniqueFields of tempUniqueIndexes) {
+            const documents = (await this.find(collection)) || [];
+            for (const index of tempUniqueIndexes) {
+                const { fields: uniqueFields } = (0, normalizeIndex_1.default)(index);
                 let parsedExisting = [];
                 for (const doc of documents) {
                     const tempDoc = {};
@@ -413,12 +421,12 @@ class NeDbDatabase extends AbstractMutexer_1.default {
                 if (parsedExisting.length != uniqued.length) {
                     throw new SpruceError_1.default({
                         code: 'DUPLICATE_KEY',
-                        friendlyMessage: `Could not create index! Unique index on '${collection}' has duplicate key for "${fields.join(',')}"`,
+                        friendlyMessage: `Could not create index! Unique index on '${collection}' has duplicate key for "${uniqueFields.join(',')}"`,
                     });
                 }
             }
         }
-        col._uniqueIndexes.push(fields);
+        col._uniqueIndexes.push(index);
     }
     async createIndex(collection, fields) {
         const col = this.loadCollection(collection);
@@ -434,7 +442,8 @@ class NeDbDatabase extends AbstractMutexer_1.default {
         const currentIndexes = await this.getUniqueIndexes(collectionName);
         const extraIndexes = (0, differenceWith_1.default)(currentIndexes, indexes, isEqual_1.default);
         for (const index of indexes) {
-            if (!this.doesIndexExist(currentIndexes, index)) {
+            const { fields } = (0, normalizeIndex_1.default)(index);
+            if (!this.doesIndexExist(currentIndexes, fields)) {
                 try {
                     await this.createUniqueIndex(collectionName, index);
                 }

package/build/databases/normalizeIndex.d.ts

@@ -0,0 +1,5 @@
+import { IndexWithFilter } from '../types/database.types';
+export default function normalizeIndex(index: string[] | IndexWithFilter): {
+    fields: string[];
+    filter: Record<string, any> | undefined;
+};

package/build/databases/normalizeIndex.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function normalizeIndex(index) {
+    const fields = Array.isArray(index) ? index : index.fields;
+    const filter = Array.isArray(index) ? undefined : index.filter;
+    return { fields, filter };
+}
+exports.default = normalizeIndex;

package/build/errors/SpruceError.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const error_1 = __importDefault(require("@sprucelabs/error"));
 class SpruceError extends error_1.default {
     friendlyMessage() {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const { options } = this;
         let message;
         switch (options === null || options === void 0 ? void 0 : options.code) {
@@ -25,7 +25,7 @@ class SpruceError extends error_1.default {
                 return `One or more ${options.collectionName} already have the ${duplicates.join(' and ')} you provided.`;
             }
             case 'UNKNOWN_STORE_ERROR':
-                message = `An unknown error occurred in the ${options.storeName} store. The original error is: \n\n${(_a = options.originalError) === null || _a === void 0 ? void 0 : _a.stack}`;
+                message = `An unknown error occurred in the ${options.storeName} store. The original error is: \n\n${(_b = (_a = options.originalError) === null || _a === void 0 ? void 0 : _a.stack) !== null && _b !== void 0 ? _b : (_c = options.originalError) === null || _c === void 0 ? void 0 : _c.message}`;
                 break;
             case 'RECORD_NOT_FOUND':
                 message = `I looked through all ${options.storeName} and couldn't find what you're looking for.`;
@@ -38,7 +38,7 @@ class SpruceError extends error_1.default {
                 break;
             case 'INVALID_STORE':
                 message =
-                    (_b = options.friendlyMessage) !== null && _b !== void 0 ? _b : `The store you passed does not extend AbstractStore!`;
+                    (_d = options.friendlyMessage) !== null && _d !== void 0 ? _d : `The store you passed does not extend AbstractStore!`;
                 break;
             case 'INVALID_STORE_NAME':
                 message = `I couldn't find a store named '${options.suppliedName}'. `;
@@ -98,7 +98,7 @@ If you are on a mac, using brew is recommended: https://brew.sh`;
                 message = 'Unknown error!';
                 break;
             case 'DUPLICATE_KEY':
-                message = `An index was trying to be created that exists. Original error is:\n\n${(_c = options.friendlyMessage) !== null && _c !== void 0 ? _c : '**missing**'}`;
+                message = `An index was trying to be created that exists. Original error is:\n\n${(_g = (_e = options.friendlyMessage) !== null && _e !== void 0 ? _e : (_f = options.originalError) === null || _f === void 0 ? void 0 : _f.stack) !== null && _g !== void 0 ? _g : (_h = options.originalError) === null || _h === void 0 ? void 0 : _h.message}`;
                 break;
             case 'INVALID_CONNECTION_STRING_SCHEME':
                 message = `There is no database adapter setup for: ${options.connectionString.split('://')[0]}`;
@@ -115,7 +115,7 @@ If you are on a mac, using brew is recommended: https://brew.sh`;
             default:
                 message = super.friendlyMessage();
         }
-        const fullMessage = (_d = options.friendlyMessage) !== null && _d !== void 0 ? _d : message;
+        const fullMessage = (_j = options.friendlyMessage) !== null && _j !== void 0 ? _j : message;
         return fullMessage;
     }
 }

package/build/esm/databases/MongoDatabase.d.ts

@@ -1,5 +1,5 @@
 import { MongoClientOptions, MongoClient } from 'mongodb';
-import { Database, DatabaseOptions } from '../types/database.types';
+import { Database, DatabaseOptions, IndexWithFilter, UniqueIndex } from '../types/database.types';
 import { QueryOptions } from '../types/query.types';
 export declare const MONGO_TEST_URI = "mongodb://localhost:27017";
 export default class MongoDatabase implements Database {
@@ -33,8 +33,9 @@ export default class MongoDatabase implements Database {
     private assertIndexDoesNotExist;
     private doesIndexExist;
     syncIndexes(collectionName: string, indexes: string[][]): Promise<void>;
-    createUniqueIndex(collection: string, fields: string[]): Promise<void>;
-    syncUniqueIndexes(collectionName: string, indexes: string[][]): Promise<void>;
+    createUniqueIndex(collection: string, index: string[] | IndexWithFilter): Promise<void>;
+    private normalizeIndex;
+    syncUniqueIndexes(collectionName: string, indexes: UniqueIndex[]): Promise<void>;
     update(collection: string, query: Record<string, any>, updates: Record<string, any>): Promise<number>;
     updateOne(collection: string, query: Record<string, any>, updates: Record<string, any>): Promise<Record<string, any>>;
     upsertOne(collection: string, query: Record<string, any>, updates: Record<string, any>): Promise<Record<string, any>>;

package/build/esm/databases/MongoDatabase.js

@@ -21,10 +21,11 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { buildLog } from '@sprucelabs/spruce-skill-utils';
 import differenceWith from 'lodash/differenceWith.js';
 import isEqual from 'lodash/isEqual.js';
-import { MongoClient, MongoError } from 'mongodb';
+import { MongoClient, MongoError, } from 'mongodb';
 import SpruceError from '../errors/SpruceError.js';
 import generateId from '../utilities/generateId.js';
 import mongoUtil from '../utilities/mongo.utility.js';
+import normalizeIndex from './normalizeIndex.js';
 export const MONGO_TEST_URI = 'mongodb://localhost:27017';
 export default class MongoDatabase {
     constructor(url, options) {
@@ -354,7 +355,8 @@ export default class MongoDatabase {
     }
     doesIndexExist(currentIndexes, fields) {
         for (const index of currentIndexes !== null && currentIndexes !== void 0 ? currentIndexes : []) {
-            if (isEqual(index, fields)) {
+            const { fields: normalizedFields } = this.normalizeIndex(index);
+            if (isEqual(normalizedFields, fields)) {
                 return true;
             }
         }
@@ -374,18 +376,23 @@ export default class MongoDatabase {
             }
         });
     }
-    createUniqueIndex(collection, fields) {
+    createUniqueIndex(collection, index) {
         return __awaiter(this, void 0, void 0, function* () {
             const currentIndexes = yield this.getUniqueIndexes(collection);
-            yield this.assertIndexDoesNotExist(currentIndexes, fields, collection);
-            const index = {};
+            const { fields, filter } = this.normalizeIndex(index);
+            this.assertIndexDoesNotExist(currentIndexes, fields, collection);
+            const created = {};
             fields.forEach((name) => {
-                index[name] = 1;
+                created[name] = 1;
             });
             try {
+                const options = { unique: true };
+                if (filter) {
+                    options.partialFilterExpression = filter;
+                }
                 yield this.assertDbWhileAttempingTo('create a unique index.', collection)
                     .collection(collection)
-                    .createIndex(index, { unique: true });
+                    .createIndex(created, options);
             }
             catch (err) {
                 if ((err === null || err === void 0 ? void 0 : err.code) === 11000) {
@@ -400,13 +407,26 @@ export default class MongoDatabase {
             }
         });
     }
+    normalizeIndex(index) {
+        const { fields, filter } = normalizeIndex(index);
+        return { fields, filter };
+    }
     syncUniqueIndexes(collectionName, indexes) {
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             const currentIndexes = yield this.getUniqueIndexes(collectionName);
             const extraIndexes = differenceWith(currentIndexes, indexes, isEqual);
             for (const index of indexes) {
-                if (!this.doesIndexExist(currentIndexes, index)) {
-                    yield this.createUniqueIndex(collectionName, index);
+                const { fields } = this.normalizeIndex(index);
+                if (!this.doesIndexExist(currentIndexes, fields)) {
+                    try {
+                        yield this.createUniqueIndex(collectionName, index);
+                    }
+                    catch (err) {
+                        if (((_a = err.options) === null || _a === void 0 ? void 0 : _a.code) !== 'INDEX_EXISTS') {
+                            throw err;
+                        }
+                    }
                 }
             }
             for (const extra of extraIndexes) {

package/build/esm/databases/NeDbDatabase.d.ts

@@ -1,5 +1,5 @@
 import AbstractMutexer from '../mutexers/AbstractMutexer';
-import { CreateOptions, Database, DatabaseInternalOptions } from '../types/database.types';
+import { CreateOptions, Database, DatabaseInternalOptions, UniqueIndex } from '../types/database.types';
 import { QueryOptions } from '../types/query.types';
 export default class NeDbDatabase extends AbstractMutexer implements Database {
     private collections;
@@ -31,14 +31,14 @@ export default class NeDbDatabase extends AbstractMutexer implements Database {
     delete(collection: string, query: Record<string, any>): Promise<number>;
     deleteOne(collection: string, query: Record<string, any>): Promise<number>;
     private assertPassesUniqueIndexes;
-    getUniqueIndexes(collection: string): Promise<string[][]>;
-    getIndexes(collection: string, shouldIncludeUnique?: boolean): Promise<string[][]>;
-    dropIndex(collection: string, fields: string[]): Promise<void>;
+    getUniqueIndexes(collection: string): Promise<UniqueIndex[]>;
+    getIndexes(collection: string, shouldIncludeUnique?: boolean): Promise<UniqueIndex[]>;
+    dropIndex(collection: string, index: UniqueIndex): Promise<void>;
     private assertIndexDoesNotExist;
     private doesIndexExist;
-    createUniqueIndex(collection: string, fields: string[]): Promise<void>;
+    createUniqueIndex(collection: string, index: UniqueIndex): Promise<void>;
     createIndex(collection: string, fields: string[]): Promise<void>;
-    syncUniqueIndexes(collectionName: string, indexes: string[][]): Promise<void>;
+    syncUniqueIndexes(collectionName: string, indexes: UniqueIndex[]): Promise<void>;
     syncIndexes(collectionName: string, indexes: string[][]): Promise<void>;
     query<T>(query: string, params?: any[]): Promise<T[]>;
     private queryToKey;

package/build/esm/databases/NeDbDatabase.js

@@ -30,6 +30,7 @@ import SpruceError from '../errors/SpruceError.js';
 import AbstractMutexer from '../mutexers/AbstractMutexer.js';
 import generateId from '../utilities/generateId.js';
 import mongoUtil from '../utilities/mongo.utility.js';
+import normalizeIndex from './normalizeIndex.js';
 dotenv.config();
 const NULL_PLACEHOLDER = '_____NULL_____';
 const UNDEFINED_PLACEHOLDER = '_____UNDEFINED_____';
@@ -327,7 +328,11 @@ export default class NeDbDatabase extends AbstractMutexer {
             const col = this.loadCollection(collection);
             yield this.randomDelay();
             if (col._uniqueIndexes) {
-                for (const fields of col._uniqueIndexes) {
+                for (const index of col._uniqueIndexes) {
+                    const { fields, filter } = normalizeIndex(index);
+                    if (filter) {
+                        return;
+                    }
                     const existing = query
                         ? yield this.findOne(collection, query)
                         : null;
@@ -373,10 +378,11 @@ export default class NeDbDatabase extends AbstractMutexer {
             return (_c = col._indexes) !== null && _c !== void 0 ? _c : [];
         });
     }
-    dropIndex(collection, fields) {
+    dropIndex(collection, index) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b;
             const col = this.loadCollection(collection);
+            const { fields } = normalizeIndex(index);
             yield this.randomDelay();
             let found = false;
             let newIndexes = [];
@@ -431,19 +437,21 @@ export default class NeDbDatabase extends AbstractMutexer {
         }
         return false;
     }
-    createUniqueIndex(collection, fields) {
+    createUniqueIndex(collection, index) {
         return __awaiter(this, void 0, void 0, function* () {
             const col = this.loadCollection(collection);
             if (!col._uniqueIndexes) {
                 col._uniqueIndexes = [];
             }
+            const { fields, filter } = normalizeIndex(index);
             yield this.randomDelay();
             this.assertIndexDoesNotExist(col._uniqueIndexes, fields, collection);
-            if (col._uniqueIndexes) {
+            if (col._uniqueIndexes && !filter) {
                 const tempUniqueIndexes = [...col._uniqueIndexes];
                 tempUniqueIndexes.push(fields);
-                const documents = (yield this.find(collection, {})) || [];
-                for (const uniqueFields of tempUniqueIndexes) {
+                const documents = (yield this.find(collection)) || [];
+                for (const index of tempUniqueIndexes) {
+                    const { fields: uniqueFields } = normalizeIndex(index);
                     let parsedExisting = [];
                     for (const doc of documents) {
                         const tempDoc = {};
@@ -456,12 +464,12 @@ export default class NeDbDatabase extends AbstractMutexer {
                     if (parsedExisting.length != uniqued.length) {
                         throw new SpruceError({
                             code: 'DUPLICATE_KEY',
-                            friendlyMessage: `Could not create index! Unique index on '${collection}' has duplicate key for "${fields.join(',')}"`,
+                            friendlyMessage: `Could not create index! Unique index on '${collection}' has duplicate key for "${uniqueFields.join(',')}"`,
                         });
                     }
                 }
             }
-            col._uniqueIndexes.push(fields);
+            col._uniqueIndexes.push(index);
         });
     }
     createIndex(collection, fields) {
@@ -481,7 +489,8 @@ export default class NeDbDatabase extends AbstractMutexer {
             const currentIndexes = yield this.getUniqueIndexes(collectionName);
             const extraIndexes = differenceWith(currentIndexes, indexes, isEqual);
             for (const index of indexes) {
-                if (!this.doesIndexExist(currentIndexes, index)) {
+                const { fields } = normalizeIndex(index);
+                if (!this.doesIndexExist(currentIndexes, fields)) {
                     try {
                         yield this.createUniqueIndex(collectionName, index);
                     }

package/build/esm/databases/normalizeIndex.d.ts

@@ -0,0 +1,5 @@
+import { IndexWithFilter } from '../types/database.types';
+export default function normalizeIndex(index: string[] | IndexWithFilter): {
+    fields: string[];
+    filter: Record<string, any> | undefined;
+};

package/build/esm/databases/normalizeIndex.js

@@ -0,0 +1,5 @@
+export default function normalizeIndex(index) {
+    const fields = Array.isArray(index) ? index : index.fields;
+    const filter = Array.isArray(index) ? undefined : index.filter;
+    return { fields, filter };
+}

package/build/esm/errors/SpruceError.js

@@ -1,7 +1,7 @@
 import AbstractSpruceError from '@sprucelabs/error';
 export default class SpruceError extends AbstractSpruceError {
     friendlyMessage() {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const { options } = this;
         let message;
         switch (options === null || options === void 0 ? void 0 : options.code) {
@@ -20,7 +20,7 @@ export default class SpruceError extends AbstractSpruceError {
                 return `One or more ${options.collectionName} already have the ${duplicates.join(' and ')} you provided.`;
             }
             case 'UNKNOWN_STORE_ERROR':
-                message = `An unknown error occurred in the ${options.storeName} store. The original error is: \n\n${(_a = options.originalError) === null || _a === void 0 ? void 0 : _a.stack}`;
+                message = `An unknown error occurred in the ${options.storeName} store. The original error is: \n\n${(_b = (_a = options.originalError) === null || _a === void 0 ? void 0 : _a.stack) !== null && _b !== void 0 ? _b : (_c = options.originalError) === null || _c === void 0 ? void 0 : _c.message}`;
                 break;
             case 'RECORD_NOT_FOUND':
                 message = `I looked through all ${options.storeName} and couldn't find what you're looking for.`;
@@ -33,7 +33,7 @@ export default class SpruceError extends AbstractSpruceError {
                 break;
             case 'INVALID_STORE':
                 message =
-                    (_b = options.friendlyMessage) !== null && _b !== void 0 ? _b : `The store you passed does not extend AbstractStore!`;
+                    (_d = options.friendlyMessage) !== null && _d !== void 0 ? _d : `The store you passed does not extend AbstractStore!`;
                 break;
             case 'INVALID_STORE_NAME':
                 message = `I couldn't find a store named '${options.suppliedName}'. `;
@@ -93,7 +93,7 @@ If you are on a mac, using brew is recommended: https://brew.sh`;
                 message = 'Unknown error!';
                 break;
             case 'DUPLICATE_KEY':
-                message = `An index was trying to be created that exists. Original error is:\n\n${(_c = options.friendlyMessage) !== null && _c !== void 0 ? _c : '**missing**'}`;
+                message = `An index was trying to be created that exists. Original error is:\n\n${(_g = (_e = options.friendlyMessage) !== null && _e !== void 0 ? _e : (_f = options.originalError) === null || _f === void 0 ? void 0 : _f.stack) !== null && _g !== void 0 ? _g : (_h = options.originalError) === null || _h === void 0 ? void 0 : _h.message}`;
                 break;
             case 'INVALID_CONNECTION_STRING_SCHEME':
                 message = `There is no database adapter setup for: ${options.connectionString.split('://')[0]}`;
@@ -110,7 +110,7 @@ If you are on a mac, using brew is recommended: https://brew.sh`;
             default:
                 message = super.friendlyMessage();
         }
-        const fullMessage = (_d = options.friendlyMessage) !== null && _d !== void 0 ? _d : message;
+        const fullMessage = (_j = options.friendlyMessage) !== null && _j !== void 0 ? _j : message;
         return fullMessage;
     }
 }

package/build/esm/tests/databaseAssertUtil.d.ts

@@ -3,7 +3,7 @@ import { DataStore } from '../types/stores.types';
 declare const databaseAssertUtil: {
     collectionName: string;
     runSuite(connect: TestConnect, tests?: string[]): Promise<void>;
-    _getFilteredIndexes(db: Database): Promise<UniqueIndex[] | Index[]>;
+    _getFilteredIndexes(db: Database): Promise<string[][]>;
     _filterIdIndex(allIndexes: UniqueIndex[] | Index[]): UniqueIndex[] | Index[];
     _assertUpdateUpdatedRightNumberOfRecords(db: Database, search: Record<string, any>, updates: Record<string, any>, expectedUpdateCount: number): Promise<void>;
     generateIdDifferentEachTime(connect: TestConnect): Promise<void>;
@@ -63,6 +63,7 @@ declare const databaseAssertUtil: {
     assertCanUpsertNull(connect: TestConnect): Promise<void>;
     assertCanSaveAndGetNullAndUndefined(connect: TestConnect): Promise<void>;
     assertSyncIndexesDoesNotRemoveExisting(connect: TestConnect): Promise<void>;
+    assertCanSyncUniqueIndexesWithFilterExpression(connect: TestConnect): Promise<void>;
     assertSyncIndexesRemovesExtraIndexes(connect: TestConnect): Promise<void>;
     assertSyncIndexesSkipsExisting(connect: TestConnect): Promise<void>;
     assertCantDropCompoundIndexThatDoesNotExist(connect: TestConnect): Promise<void>;

package/build/esm/tests/databaseAssertUtil.js

@@ -49,6 +49,7 @@ const databaseAssertUtil = {
                 'assertCanUpsertOne',
                 'assertCanUpsertNull',
                 'assertCanPushToArrayOnUpsert',
+                'assertCanSyncUniqueIndexesWithFilterExpression',
                 //finding
                 'assertEmptyDatabaseReturnsEmptyArray',
                 'assertFindOneOnEmptyDatabaseReturnsNull',
@@ -122,6 +123,7 @@ const databaseAssertUtil = {
         });
     },
     _filterIdIndex(allIndexes) {
+        //@ts-ignore
         return allIndexes.filter((i) => i[0] !== '_id');
     },
     _assertUpdateUpdatedRightNumberOfRecords(db, search, updates, expectedUpdateCount) {
@@ -243,19 +245,19 @@ const databaseAssertUtil = {
         return __awaiter(this, void 0, void 0, function* () {
             const db = yield connectToDabatase(connect);
             yield db.createUniqueIndex(this.collectionName, ['uniqueField']);
-            let indexes = yield db.getUniqueIndexes(this.collectionName);
+            let indexes = (yield db.getUniqueIndexes(this.collectionName));
             assert.isLength(indexes, 1, 'getUniqueIndexes() did not return the unique index I tried to create!');
             assert.isLength(indexes[0], 1, 'getUniqueIndexes() needs to return an array of arrays. Each item in the array should be an array of fields that make up the unique index.');
             assert.isEqual(indexes[0][0].toLowerCase(), 'uniqueField'.toLowerCase(), 'getUniqueIndexes() did not add the expected field to the first unique index.');
             yield db.createUniqueIndex(this.collectionName, ['uniqueField2']);
-            indexes = yield db.getUniqueIndexes(this.collectionName);
+            indexes = (yield db.getUniqueIndexes(this.collectionName));
             assert.isLength(indexes, 2);
             assert.isEqual(indexes[1][0].toLowerCase(), 'uniqueField2'.toLowerCase());
             yield db.createUniqueIndex(this.collectionName, [
                 'uniqueField3',
                 'uniqueField4',
             ]);
-            indexes = yield db.getUniqueIndexes(this.collectionName);
+            indexes = (yield db.getUniqueIndexes(this.collectionName));
             assert.isLength(indexes, 3);
             assert.isEqual(indexes[2][0].toLowerCase(), 'uniqueField3'.toLowerCase());
             assert.isEqual(indexes[2][1].toLowerCase(), 'uniqueField4'.toLowerCase());
@@ -745,10 +747,10 @@ const databaseAssertUtil = {
                 ['someField'],
                 ['otherField', 'otherField2'],
             ]);
-            let indexes = yield db.getUniqueIndexes(this.collectionName);
+            let indexes = (yield db.getUniqueIndexes(this.collectionName));
             assert.isLength(indexes, 3, 'syncUniqueIndexes() should have created 3 indexes.');
             yield db.syncUniqueIndexes(this.collectionName, [['uniqueField']]);
-            indexes = yield db.getUniqueIndexes(this.collectionName);
+            indexes = (yield db.getUniqueIndexes(this.collectionName));
             assert.isLength(indexes, 1);
             assert.isEqual(indexes[0][0].toLowerCase(), 'uniquefield');
             yield this.shutdown(db);
@@ -1446,6 +1448,87 @@ const databaseAssertUtil = {
             yield this.shutdown(db);
         });
     },
+    assertCanSyncUniqueIndexesWithFilterExpression(connect) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const db = yield connectToDabatase(connect);
+            try {
+                yield db.syncUniqueIndexes(this.collectionName, [
+                    {
+                        fields: ['username', 'dateScrambled'],
+                        filter: {
+                            username: { $exists: true },
+                        },
+                    },
+                ]);
+            }
+            catch (err) {
+                assert.fail((_a = `syncUniqueIndexes() should not have thrown an error when syncing a unique index with a filter expression.\n\n` +
+                    err.stack) !== null && _a !== void 0 ? _a : err.message);
+            }
+            try {
+                yield db.createOne(this.collectionName, {
+                    username: 'test',
+                    phone: null,
+                    dateScrambled: 'test',
+                });
+            }
+            catch (err) {
+                assert.fail((_b = `Creating a record should not have thrown an error after syncing a unique index with a filter expression.\n\n` +
+                    err.stack) !== null && _b !== void 0 ? _b : err.message);
+            }
+            yield assert.doesThrowAsync(() => db.createOne(this.collectionName, {
+                username: 'test',
+                phone: null,
+                dateScrambled: 'test',
+            }));
+            yield db.createOne(this.collectionName, {
+                phone: '555-000-0000',
+                dateScrambled: 'test',
+            });
+            yield db.createOne(this.collectionName, {
+                phone: '555-000-0001',
+                dateScrambled: 'test',
+            });
+            try {
+                yield db.syncUniqueIndexes(this.collectionName, [
+                    {
+                        fields: ['username', 'dateScrambled'],
+                        filter: {
+                            username: { $exists: true },
+                        },
+                    },
+                    {
+                        fields: ['phone', 'dateScrambled'],
+                        filter: {
+                            phone: { $exists: true, $type: 'string' },
+                        },
+                    },
+                ]);
+            }
+            catch (err) {
+                assert.fail((_c = `syncUniqueIndexes() should not have thrown an error when syncing multiple unique indexes with filter expressions.\n\n` +
+                    err.stack) !== null && _c !== void 0 ? _c : err.message);
+            }
+            yield db.createOne(this.collectionName, {
+                username: 'test',
+                phone: null,
+                dateScrambled: 'next',
+            });
+            try {
+                yield db.createOne(this.collectionName, {
+                    username: 'test2',
+                    phone: null,
+                    dateScrambled: 'next',
+                });
+            }
+            catch (err) {
+                assert.fail((_d = `createOne() should not throw if index has filter { \$exists: true, \$type: 'string' }.\n\n` +
+                    err.stack) !== null && _d !== void 0 ? _d : err.message);
+            }
+            yield this.shutdown(db);
+        });
+    },
     assertSyncIndexesRemovesExtraIndexes(connect) {
         return __awaiter(this, void 0, void 0, function* () {
             const db = yield connectToDabatase(connect);

package/build/esm/tests/pluckAssertionMethods.d.ts

@@ -1,2 +1,2 @@
 import databaseAssertUtil from './databaseAssertUtil';
-export default function pluckAssertionMethods(util: typeof databaseAssertUtil): ("collectionName" | "assertThrowsWithInvalidConnectionString" | "assertThrowsWhenCantConnect" | "assertThrowsWithBadDatabaseName" | "assertEmptyDatabaseReturnsEmptyArray" | "assertKnowsIfConnectionClosed" | "assertFindOneOnEmptyDatabaseReturnsNull" | "assertCanSortDesc" | "assertCanSortAsc" | "assertCanSortById" | "assertCanQueryWithOr" | "generateIdDifferentEachTime" | "assertInsertingGeneratesId" | "assertCanCreateMany" | "assertCanLimitResults" | "assertCanCreateWithObjectField" | "assertCanCountOnId" | "assertCanCount" | "assertThrowsWhenUpdatingRecordNotFound" | "assertCanUpdate" | "assertCanUpdateMany" | "assertCanPushOntoArrayValue" | "assertCanUpdateWithObjectField" | "assertCanUpdateFieldInObjectFieldWithTargettedWhere" | "assertCanSaveAndGetNullAndUndefined" | "assertCanUpsertOne" | "assertCanUpsertNull" | "assertCanPushToArrayOnUpsert" | "assertCanLimitResultsToZero" | "assertCanFindWithBooleanField" | "assertCanQueryByGtLtGteLteNe" | "assertCanQueryPathWithDotSyntax" | "assertCanReturnOnlySelectFields" | "assertCanSearchByRegex" | "assertCanFindWithNe" | "assertCanFindWithIn" | "assertCanDeleteRecord" | "assertCanDeleteOne" | "assertHasNoUniqueIndexToStart" | "assertCanCreateUniqueIndex" | "assertCanCreateMultiFieldUniqueIndex" | "assertCantCreateUniqueIndexTwice" | "assertCanDropUniqueIndex" | "assertCanDropCompoundUniqueIndex" | "assertCantDropUniqueIndexThatDoesntExist" | "assertCantDropIndexWhenNoIndexExists" | "assertCantDropCompoundUniqueIndexThatDoesntExist" | "assertSyncingUniqueIndexsAddsMissingIndexes" | "assertSyncingUniqueIndexsSkipsExistingIndexs" | "assertSyncingUniqueIndexesRemovesExtraIndexes" | "assertSyncingUniqueIndexesIsRaceProof" | "assertSyncingIndexesDoesNotAddAndRemove" | "assertUniqueIndexBlocksDuplicates" | "assertDuplicateKeyThrowsOnInsert" | "assertSettingUniqueIndexViolationThrowsSpruceError" | "assertCanCreateUniqueIndexOnNestedField" | "assertUpsertWithUniqueIndex" | "assertNestedFieldIndexUpdates" | "assertHasNoIndexToStart" | "assertCanCreateIndex" | "assertCantCreateSameIndexTwice" | "assertCanCreateMultiFieldIndex" | "assertCanDropIndex" | "assertCanDropCompoundIndex" | "assertCantDropCompoundIndexThatDoesNotExist" | "assertSyncIndexesSkipsExisting" | "assertSyncIndexesRemovesExtraIndexes" | "assertSyncIndexesHandlesRaceConditions" | "assertSyncIndexesDoesNotRemoveExisting" | "assertDuplicateFieldsWithMultipleUniqueIndexesWorkAsExpected" | "runSuite" | "_getFilteredIndexes" | "_filterIdIndex" | "_assertUpdateUpdatedRightNumberOfRecords" | "shutdown" | "_assertThrowsExpectedNotFoundOnUpdateOne" | "_assert$orReturnsExpectedTotalRecords" | "_assertCanCreateMultiFieldIndex" | "assertHasLowerCaseToCamelCaseMappingEnabled")[];
+export default function pluckAssertionMethods(util: typeof databaseAssertUtil): ("collectionName" | "assertThrowsWithInvalidConnectionString" | "assertThrowsWhenCantConnect" | "assertThrowsWithBadDatabaseName" | "assertEmptyDatabaseReturnsEmptyArray" | "assertKnowsIfConnectionClosed" | "assertFindOneOnEmptyDatabaseReturnsNull" | "assertCanSortDesc" | "assertCanSortAsc" | "assertCanSortById" | "assertCanQueryWithOr" | "generateIdDifferentEachTime" | "assertInsertingGeneratesId" | "assertCanCreateMany" | "assertCanLimitResults" | "assertCanCreateWithObjectField" | "assertCanCountOnId" | "assertCanCount" | "assertThrowsWhenUpdatingRecordNotFound" | "assertCanUpdate" | "assertCanUpdateMany" | "assertCanPushOntoArrayValue" | "assertCanUpdateWithObjectField" | "assertCanUpdateFieldInObjectFieldWithTargettedWhere" | "assertCanSaveAndGetNullAndUndefined" | "assertCanUpsertOne" | "assertCanUpsertNull" | "assertCanPushToArrayOnUpsert" | "assertCanSyncUniqueIndexesWithFilterExpression" | "assertCanLimitResultsToZero" | "assertCanFindWithBooleanField" | "assertCanQueryByGtLtGteLteNe" | "assertCanQueryPathWithDotSyntax" | "assertCanReturnOnlySelectFields" | "assertCanSearchByRegex" | "assertCanFindWithNe" | "assertCanFindWithIn" | "assertCanDeleteRecord" | "assertCanDeleteOne" | "assertHasNoUniqueIndexToStart" | "assertCanCreateUniqueIndex" | "assertCanCreateMultiFieldUniqueIndex" | "assertCantCreateUniqueIndexTwice" | "assertCanDropUniqueIndex" | "assertCanDropCompoundUniqueIndex" | "assertCantDropUniqueIndexThatDoesntExist" | "assertCantDropIndexWhenNoIndexExists" | "assertCantDropCompoundUniqueIndexThatDoesntExist" | "assertSyncingUniqueIndexsAddsMissingIndexes" | "assertSyncingUniqueIndexsSkipsExistingIndexs" | "assertSyncingUniqueIndexesRemovesExtraIndexes" | "assertSyncingUniqueIndexesIsRaceProof" | "assertSyncingIndexesDoesNotAddAndRemove" | "assertUniqueIndexBlocksDuplicates" | "assertDuplicateKeyThrowsOnInsert" | "assertSettingUniqueIndexViolationThrowsSpruceError" | "assertCanCreateUniqueIndexOnNestedField" | "assertUpsertWithUniqueIndex" | "assertNestedFieldIndexUpdates" | "assertHasNoIndexToStart" | "assertCanCreateIndex" | "assertCantCreateSameIndexTwice" | "assertCanCreateMultiFieldIndex" | "assertCanDropIndex" | "assertCanDropCompoundIndex" | "assertCantDropCompoundIndexThatDoesNotExist" | "assertSyncIndexesSkipsExisting" | "assertSyncIndexesRemovesExtraIndexes" | "assertSyncIndexesHandlesRaceConditions" | "assertSyncIndexesDoesNotRemoveExisting" | "assertDuplicateFieldsWithMultipleUniqueIndexesWorkAsExpected" | "runSuite" | "_getFilteredIndexes" | "_filterIdIndex" | "_assertUpdateUpdatedRightNumberOfRecords" | "shutdown" | "_assertThrowsExpectedNotFoundOnUpdateOne" | "_assert$orReturnsExpectedTotalRecords" | "_assertCanCreateMultiFieldIndex" | "assertHasLowerCaseToCamelCaseMappingEnabled")[];

package/build/esm/types/database.types.d.ts

@@ -38,7 +38,11 @@ export type TestConnect = (connectionString?: string, dbName?: string) => Promis
     connectionStringWithRandomBadDatabaseName: string;
     badDatabaseName: string;
 }>;
-export type UniqueIndex = string[];
+export interface IndexWithFilter {
+    fields: string[];
+    filter: Record<string, any>;
+}
+export type UniqueIndex = string[] | IndexWithFilter;
 export type Index = string[];
 export interface CreateOptions extends DatabaseInternalOptions {
 }

package/build/tests/databaseAssertUtil.d.ts

@@ -3,7 +3,7 @@ import { DataStore } from '../types/stores.types';
 declare const databaseAssertUtil: {
     collectionName: string;
     runSuite(connect: TestConnect, tests?: string[]): Promise<void>;
-    _getFilteredIndexes(db: Database): Promise<UniqueIndex[] | Index[]>;
+    _getFilteredIndexes(db: Database): Promise<string[][]>;
     _filterIdIndex(allIndexes: UniqueIndex[] | Index[]): UniqueIndex[] | Index[];
     _assertUpdateUpdatedRightNumberOfRecords(db: Database, search: Record<string, any>, updates: Record<string, any>, expectedUpdateCount: number): Promise<void>;
     generateIdDifferentEachTime(connect: TestConnect): Promise<void>;
@@ -63,6 +63,7 @@ declare const databaseAssertUtil: {
     assertCanUpsertNull(connect: TestConnect): Promise<void>;
     assertCanSaveAndGetNullAndUndefined(connect: TestConnect): Promise<void>;
     assertSyncIndexesDoesNotRemoveExisting(connect: TestConnect): Promise<void>;
+    assertCanSyncUniqueIndexesWithFilterExpression(connect: TestConnect): Promise<void>;
     assertSyncIndexesRemovesExtraIndexes(connect: TestConnect): Promise<void>;
     assertSyncIndexesSkipsExisting(connect: TestConnect): Promise<void>;
     assertCantDropCompoundIndexThatDoesNotExist(connect: TestConnect): Promise<void>;

package/build/tests/databaseAssertUtil.js

@@ -44,6 +44,7 @@ const databaseAssertUtil = {
             'assertCanUpsertOne',
             'assertCanUpsertNull',
             'assertCanPushToArrayOnUpsert',
+            'assertCanSyncUniqueIndexesWithFilterExpression',
             //finding
             'assertEmptyDatabaseReturnsEmptyArray',
             'assertFindOneOnEmptyDatabaseReturnsNull',
@@ -114,6 +115,7 @@ const databaseAssertUtil = {
         return this._filterIdIndex(await db.getIndexes(this.collectionName));
     },
     _filterIdIndex(allIndexes) {
+        //@ts-ignore
         return allIndexes.filter((i) => i[0] !== '_id');
     },
     async _assertUpdateUpdatedRightNumberOfRecords(db, search, updates, expectedUpdateCount) {
@@ -220,19 +222,19 @@ const databaseAssertUtil = {
     async assertCanCreateUniqueIndex(connect) {
         const db = await connectToDabatase(connect);
         await db.createUniqueIndex(this.collectionName, ['uniqueField']);
-        let indexes = await db.getUniqueIndexes(this.collectionName);
+        let indexes = (await db.getUniqueIndexes(this.collectionName));
         test_utils_1.assert.isLength(indexes, 1, 'getUniqueIndexes() did not return the unique index I tried to create!');
         test_utils_1.assert.isLength(indexes[0], 1, 'getUniqueIndexes() needs to return an array of arrays. Each item in the array should be an array of fields that make up the unique index.');
         test_utils_1.assert.isEqual(indexes[0][0].toLowerCase(), 'uniqueField'.toLowerCase(), 'getUniqueIndexes() did not add the expected field to the first unique index.');
         await db.createUniqueIndex(this.collectionName, ['uniqueField2']);
-        indexes = await db.getUniqueIndexes(this.collectionName);
+        indexes = (await db.getUniqueIndexes(this.collectionName));
         test_utils_1.assert.isLength(indexes, 2);
         test_utils_1.assert.isEqual(indexes[1][0].toLowerCase(), 'uniqueField2'.toLowerCase());
         await db.createUniqueIndex(this.collectionName, [
             'uniqueField3',
             'uniqueField4',
         ]);
-        indexes = await db.getUniqueIndexes(this.collectionName);
+        indexes = (await db.getUniqueIndexes(this.collectionName));
         test_utils_1.assert.isLength(indexes, 3);
         test_utils_1.assert.isEqual(indexes[2][0].toLowerCase(), 'uniqueField3'.toLowerCase());
         test_utils_1.assert.isEqual(indexes[2][1].toLowerCase(), 'uniqueField4'.toLowerCase());
@@ -678,10 +680,10 @@ const databaseAssertUtil = {
             ['someField'],
             ['otherField', 'otherField2'],
         ]);
-        let indexes = await db.getUniqueIndexes(this.collectionName);
+        let indexes = (await db.getUniqueIndexes(this.collectionName));
         test_utils_1.assert.isLength(indexes, 3, 'syncUniqueIndexes() should have created 3 indexes.');
         await db.syncUniqueIndexes(this.collectionName, [['uniqueField']]);
-        indexes = await db.getUniqueIndexes(this.collectionName);
+        indexes = (await db.getUniqueIndexes(this.collectionName));
         test_utils_1.assert.isLength(indexes, 1);
         test_utils_1.assert.isEqual(indexes[0][0].toLowerCase(), 'uniquefield');
         await this.shutdown(db);
@@ -1322,6 +1324,85 @@ const databaseAssertUtil = {
         ]);
         await this.shutdown(db);
     },
+    async assertCanSyncUniqueIndexesWithFilterExpression(connect) {
+        var _a, _b, _c, _d;
+        const db = await connectToDabatase(connect);
+        try {
+            await db.syncUniqueIndexes(this.collectionName, [
+                {
+                    fields: ['username', 'dateScrambled'],
+                    filter: {
+                        username: { $exists: true },
+                    },
+                },
+            ]);
+        }
+        catch (err) {
+            test_utils_1.assert.fail((_a = `syncUniqueIndexes() should not have thrown an error when syncing a unique index with a filter expression.\n\n` +
+                err.stack) !== null && _a !== void 0 ? _a : err.message);
+        }
+        try {
+            await db.createOne(this.collectionName, {
+                username: 'test',
+                phone: null,
+                dateScrambled: 'test',
+            });
+        }
+        catch (err) {
+            test_utils_1.assert.fail((_b = `Creating a record should not have thrown an error after syncing a unique index with a filter expression.\n\n` +
+                err.stack) !== null && _b !== void 0 ? _b : err.message);
+        }
+        await test_utils_1.assert.doesThrowAsync(() => db.createOne(this.collectionName, {
+            username: 'test',
+            phone: null,
+            dateScrambled: 'test',
+        }));
+        await db.createOne(this.collectionName, {
+            phone: '555-000-0000',
+            dateScrambled: 'test',
+        });
+        await db.createOne(this.collectionName, {
+            phone: '555-000-0001',
+            dateScrambled: 'test',
+        });
+        try {
+            await db.syncUniqueIndexes(this.collectionName, [
+                {
+                    fields: ['username', 'dateScrambled'],
+                    filter: {
+                        username: { $exists: true },
+                    },
+                },
+                {
+                    fields: ['phone', 'dateScrambled'],
+                    filter: {
+                        phone: { $exists: true, $type: 'string' },
+                    },
+                },
+            ]);
+        }
+        catch (err) {
+            test_utils_1.assert.fail((_c = `syncUniqueIndexes() should not have thrown an error when syncing multiple unique indexes with filter expressions.\n\n` +
+                err.stack) !== null && _c !== void 0 ? _c : err.message);
+        }
+        await db.createOne(this.collectionName, {
+            username: 'test',
+            phone: null,
+            dateScrambled: 'next',
+        });
+        try {
+            await db.createOne(this.collectionName, {
+                username: 'test2',
+                phone: null,
+                dateScrambled: 'next',
+            });
+        }
+        catch (err) {
+            test_utils_1.assert.fail((_d = `createOne() should not throw if index has filter { \$exists: true, \$type: 'string' }.\n\n` +
+                err.stack) !== null && _d !== void 0 ? _d : err.message);
+        }
+        await this.shutdown(db);
+    },
     async assertSyncIndexesRemovesExtraIndexes(connect) {
         const db = await connectToDabatase(connect);
         await db.syncIndexes(this.collectionName, [

package/build/tests/pluckAssertionMethods.d.ts

@@ -1,2 +1,2 @@
 import databaseAssertUtil from './databaseAssertUtil';
-export default function pluckAssertionMethods(util: typeof databaseAssertUtil): ("collectionName" | "assertThrowsWithInvalidConnectionString" | "assertThrowsWhenCantConnect" | "assertThrowsWithBadDatabaseName" | "assertEmptyDatabaseReturnsEmptyArray" | "assertKnowsIfConnectionClosed" | "assertFindOneOnEmptyDatabaseReturnsNull" | "assertCanSortDesc" | "assertCanSortAsc" | "assertCanSortById" | "assertCanQueryWithOr" | "generateIdDifferentEachTime" | "assertInsertingGeneratesId" | "assertCanCreateMany" | "assertCanLimitResults" | "assertCanCreateWithObjectField" | "assertCanCountOnId" | "assertCanCount" | "assertThrowsWhenUpdatingRecordNotFound" | "assertCanUpdate" | "assertCanUpdateMany" | "assertCanPushOntoArrayValue" | "assertCanUpdateWithObjectField" | "assertCanUpdateFieldInObjectFieldWithTargettedWhere" | "assertCanSaveAndGetNullAndUndefined" | "assertCanUpsertOne" | "assertCanUpsertNull" | "assertCanPushToArrayOnUpsert" | "assertCanLimitResultsToZero" | "assertCanFindWithBooleanField" | "assertCanQueryByGtLtGteLteNe" | "assertCanQueryPathWithDotSyntax" | "assertCanReturnOnlySelectFields" | "assertCanSearchByRegex" | "assertCanFindWithNe" | "assertCanFindWithIn" | "assertCanDeleteRecord" | "assertCanDeleteOne" | "assertHasNoUniqueIndexToStart" | "assertCanCreateUniqueIndex" | "assertCanCreateMultiFieldUniqueIndex" | "assertCantCreateUniqueIndexTwice" | "assertCanDropUniqueIndex" | "assertCanDropCompoundUniqueIndex" | "assertCantDropUniqueIndexThatDoesntExist" | "assertCantDropIndexWhenNoIndexExists" | "assertCantDropCompoundUniqueIndexThatDoesntExist" | "assertSyncingUniqueIndexsAddsMissingIndexes" | "assertSyncingUniqueIndexsSkipsExistingIndexs" | "assertSyncingUniqueIndexesRemovesExtraIndexes" | "assertSyncingUniqueIndexesIsRaceProof" | "assertSyncingIndexesDoesNotAddAndRemove" | "assertUniqueIndexBlocksDuplicates" | "assertDuplicateKeyThrowsOnInsert" | "assertSettingUniqueIndexViolationThrowsSpruceError" | "assertCanCreateUniqueIndexOnNestedField" | "assertUpsertWithUniqueIndex" | "assertNestedFieldIndexUpdates" | "assertHasNoIndexToStart" | "assertCanCreateIndex" | "assertCantCreateSameIndexTwice" | "assertCanCreateMultiFieldIndex" | "assertCanDropIndex" | "assertCanDropCompoundIndex" | "assertCantDropCompoundIndexThatDoesNotExist" | "assertSyncIndexesSkipsExisting" | "assertSyncIndexesRemovesExtraIndexes" | "assertSyncIndexesHandlesRaceConditions" | "assertSyncIndexesDoesNotRemoveExisting" | "assertDuplicateFieldsWithMultipleUniqueIndexesWorkAsExpected" | "runSuite" | "_getFilteredIndexes" | "_filterIdIndex" | "_assertUpdateUpdatedRightNumberOfRecords" | "shutdown" | "_assertThrowsExpectedNotFoundOnUpdateOne" | "_assert$orReturnsExpectedTotalRecords" | "_assertCanCreateMultiFieldIndex" | "assertHasLowerCaseToCamelCaseMappingEnabled")[];
+export default function pluckAssertionMethods(util: typeof databaseAssertUtil): ("collectionName" | "assertThrowsWithInvalidConnectionString" | "assertThrowsWhenCantConnect" | "assertThrowsWithBadDatabaseName" | "assertEmptyDatabaseReturnsEmptyArray" | "assertKnowsIfConnectionClosed" | "assertFindOneOnEmptyDatabaseReturnsNull" | "assertCanSortDesc" | "assertCanSortAsc" | "assertCanSortById" | "assertCanQueryWithOr" | "generateIdDifferentEachTime" | "assertInsertingGeneratesId" | "assertCanCreateMany" | "assertCanLimitResults" | "assertCanCreateWithObjectField" | "assertCanCountOnId" | "assertCanCount" | "assertThrowsWhenUpdatingRecordNotFound" | "assertCanUpdate" | "assertCanUpdateMany" | "assertCanPushOntoArrayValue" | "assertCanUpdateWithObjectField" | "assertCanUpdateFieldInObjectFieldWithTargettedWhere" | "assertCanSaveAndGetNullAndUndefined" | "assertCanUpsertOne" | "assertCanUpsertNull" | "assertCanPushToArrayOnUpsert" | "assertCanSyncUniqueIndexesWithFilterExpression" | "assertCanLimitResultsToZero" | "assertCanFindWithBooleanField" | "assertCanQueryByGtLtGteLteNe" | "assertCanQueryPathWithDotSyntax" | "assertCanReturnOnlySelectFields" | "assertCanSearchByRegex" | "assertCanFindWithNe" | "assertCanFindWithIn" | "assertCanDeleteRecord" | "assertCanDeleteOne" | "assertHasNoUniqueIndexToStart" | "assertCanCreateUniqueIndex" | "assertCanCreateMultiFieldUniqueIndex" | "assertCantCreateUniqueIndexTwice" | "assertCanDropUniqueIndex" | "assertCanDropCompoundUniqueIndex" | "assertCantDropUniqueIndexThatDoesntExist" | "assertCantDropIndexWhenNoIndexExists" | "assertCantDropCompoundUniqueIndexThatDoesntExist" | "assertSyncingUniqueIndexsAddsMissingIndexes" | "assertSyncingUniqueIndexsSkipsExistingIndexs" | "assertSyncingUniqueIndexesRemovesExtraIndexes" | "assertSyncingUniqueIndexesIsRaceProof" | "assertSyncingIndexesDoesNotAddAndRemove" | "assertUniqueIndexBlocksDuplicates" | "assertDuplicateKeyThrowsOnInsert" | "assertSettingUniqueIndexViolationThrowsSpruceError" | "assertCanCreateUniqueIndexOnNestedField" | "assertUpsertWithUniqueIndex" | "assertNestedFieldIndexUpdates" | "assertHasNoIndexToStart" | "assertCanCreateIndex" | "assertCantCreateSameIndexTwice" | "assertCanCreateMultiFieldIndex" | "assertCanDropIndex" | "assertCanDropCompoundIndex" | "assertCantDropCompoundIndexThatDoesNotExist" | "assertSyncIndexesSkipsExisting" | "assertSyncIndexesRemovesExtraIndexes" | "assertSyncIndexesHandlesRaceConditions" | "assertSyncIndexesDoesNotRemoveExisting" | "assertDuplicateFieldsWithMultipleUniqueIndexesWorkAsExpected" | "runSuite" | "_getFilteredIndexes" | "_filterIdIndex" | "_assertUpdateUpdatedRightNumberOfRecords" | "shutdown" | "_assertThrowsExpectedNotFoundOnUpdateOne" | "_assert$orReturnsExpectedTotalRecords" | "_assertCanCreateMultiFieldIndex" | "assertHasLowerCaseToCamelCaseMappingEnabled")[];

package/build/types/database.types.d.ts

@@ -38,7 +38,11 @@ export type TestConnect = (connectionString?: string, dbName?: string) => Promis
     connectionStringWithRandomBadDatabaseName: string;
     badDatabaseName: string;
 }>;
-export type UniqueIndex = string[];
+export interface IndexWithFilter {
+    fields: string[];
+    filter: Record<string, any>;
+}
+export type UniqueIndex = string[] | IndexWithFilter;
 export type Index = string[];
 export interface CreateOptions extends DatabaseInternalOptions {
 }

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "28.0.26",
+  "version": "28.1.1",
   "files": [
     "build/**/*",
     "!build/__tests__",
@@ -68,24 +68,24 @@
   },
   "dependencies": {
     "@sprucelabs/error": "^6.0.34",
-    "@sprucelabs/globby": "^2.0.15",
-    "@sprucelabs/schema": "^30.0.61",
-    "@sprucelabs/spruce-skill-utils": "^31.0.66",
+    "@sprucelabs/globby": "^2.0.16",
+    "@sprucelabs/schema": "^30.0.62",
+    "@sprucelabs/spruce-skill-utils": "^31.0.67",
     "just-clone": "^6.2.0",
     "lodash": "^4.17.21",
-    "mongodb": "^6.6.2",
+    "mongodb": "^6.7.0",
     "nedb": "^1.8.0"
   },
   "devDependencies": {
-    "@sprucelabs/esm-postbuild": "^6.0.26",
-    "@sprucelabs/jest-json-reporter": "^8.0.37",
-    "@sprucelabs/resolve-path-aliases": "^2.0.27",
+    "@sprucelabs/esm-postbuild": "^6.0.27",
+    "@sprucelabs/jest-json-reporter": "^8.0.38",
+    "@sprucelabs/resolve-path-aliases": "^2.0.28",
     "@sprucelabs/semantic-release": "^5.0.1",
     "@sprucelabs/test": "^9.0.18",
-    "@sprucelabs/test-utils": "^5.0.50",
+    "@sprucelabs/test-utils": "^5.0.51",
     "@types/lodash": "^4.17.4",
     "@types/nedb": "^1.8.16",
-    "@types/node": "^20.12.12",
+    "@types/node": "^20.12.13",
     "chokidar-cli": "^3.0.0",
     "concurrently": "^8.2.2",
     "dotenv": "^16.4.5",