@sprucelabs/data-stores 19.3.3 → 20.0.0

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

@@ -1,2 +1,2 @@
 import databaseAssertUtil from './databaseAssertUtil';
-export default function pluckAssertionMethods(util: typeof databaseAssertUtil): ("collectionName" | "runSuite" | "_getFilteredIndexes" | "_filterIdIndex" | "_assertUpdateUpdatedRightNumberOfRecords" | "assertCanSortDesc" | "assertCanSortAsc" | "assertInsertingGeneratesId" | "assertThrowsWhenUpdatingRecordNotFound" | "shutdown" | "assertCanCreateUniqueIndex" | "assertHasNoUniqueIndexToStart" | "assertCanShutdown" | "assertCanDeleteOne" | "assertCanDeleteRecord" | "assertCanLimitResultsToZero" | "assertCanLimitResults" | "assertFindOneOnEmptyDatabaseReturnsNull" | "assertEmptyDatabaseReturnsEmptyArray" | "assertCanPushOntoArrayValue" | "assertCanCreateMany" | "assertCanUpdateMany" | "assertCanQueryWithOr" | "assertCanUpdate" | "assertCanSortById" | "assertCanCreateMultiFieldUniqueIndex" | "assertSettingUniqueIndexViolationThrowsSpruceError" | "assertDuplicateKeyThrowsOnInsert" | "assertSyncingIndexesDoesNotAddAndRemove" | "assertSyncingUniqueIndexesRemovesExtraIndexes" | "assertSyncingUniqueIndexsSkipsExistingIndexs" | "assertSyncingUniqueIndexsAddsMissingIndexes" | "assertCantDropCompoundUniqueIndexThatDoesntExist" | "assertCantDropIndexWhenNoIndexExists" | "assertCantDropUniqueIndexThatDoesntExist" | "assertCanDropCompoundUniqueIndex" | "assertCanDropUniqueIndex" | "assertCantCreateUniqueIndexTwice" | "assertSyncingUniqueIndexesIsRaceProof" | "assertUniqueIndexBlocksDuplicates" | "assertCanCreateUniqueIndexOnNestedField" | "assertCanPushToArrayOnUpsert" | "assertCanSearchByRegex" | "assertCanReturnOnlySelectFields" | "assertThrowsWithoutDatabaseName" | "assertThrowsWhenCantConnect" | "assertThrowsWithInvalidConnectionString" | "assertKnowsIfConnectionClosed" | "assertCanQueryPathWithDotSyntax" | "assertCanQueryByGtLtGteLte" | "assertCanFindWithNe" | "assertCanFindWithIn" | "assertCanCountOnId" | "assertCanCount" | "assertCanUpsertNull" | "assertCanSaveAndGetNullAndUndefined" | "assertSyncIndexesDoesNotRemoveExisting" | "assertSyncIndexesRemovesExtraIndexes" | "assertSyncIndexesSkipsExisting" | "assertCantDropCompoundIndexThatDoesNotExist" | "assertCanDropCompoundIndex" | "assertCanDropIndex" | "assertCanCreateMultiFieldIndex" | "assertCantCreateSameIndexTwice" | "assertCanCreateIndex" | "assertHasNoIndexToStart" | "assertNestedFieldIndexUpdates" | "assertUpsertWithUniqueIndex" | "assertSyncIndexesHandlesRaceConditions" | "assertDuplicateFieldsWithMultipleUniqueIndexesWorkAsExpected")[];
+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" | "canUpdateWithObjectField" | "canUpdateFieldInObjectFieldWithTargettedWhere" | "assertCanSaveAndGetNullAndUndefined" | "assertCanUpsertOne" | "assertCanUpsertNull" | "assertCanPushToArrayOnUpsert" | "assertCanLimitResultsToZero" | "assertCanFindWithBooleanField" | "assertCanQueryByGtLtGteLte" | "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")[];

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

@@ -32,3 +32,9 @@ export interface DatabaseOptions {
     dbName?: string;
     log?: Log;
 }
+export type TestConnect = (connectionString?: string, dbName?: string) => Promise<{
+    db: Database;
+    scheme: string;
+    connectionStringWithRandomBadDatabaseName: string;
+    badDatabaseName: string;
+}>;

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

@@ -6,13 +6,14 @@ export type QueryBuilder<Query> = {
 } & {
     id?: string | QuerySelector<string>;
 };
+export interface QuerySortField {
+    field: string;
+    direction: 'asc' | 'desc';
+}
 export interface QueryOptions {
     skip?: number;
     limit?: number;
-    sort?: {
-        field: string;
-        direction: 'asc' | 'desc';
-    }[];
+    sort?: QuerySortField[];
     includeFields?: string[];
 }
 export type FlattenAndPathKeys<O extends Obj, T extends Obj = PathKeys<O>> = Flatten<T>;

package/build/index.d.ts

@@ -14,6 +14,7 @@ export * from './types/database.types';
 export * from './types/query.types';
 export * from './types/stores.types';
 export * from './constants';
+export { default as DataStoresError } from './errors/SpruceError';
 export { default as generateId } from './utilities/generateIdDeprecated';
 export { default as CursorPager } from './cursors/CursorPager';
 export * from './cursors/CursorPager';

package/build/index.js

@@ -17,7 +17,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.databaseAssertUtil = exports.CursorPagerFaker = exports.CursorPager = exports.generateId = exports.mongoUtil = exports.NeDbDatabase = exports.MongoDatabase = exports.StoreLoader = exports.DatabaseFactory = exports.StoreFactory = exports.AbstractStore = exports.DatabaseFixture = exports.AbstractDatabaseTest = void 0;
+exports.databaseAssertUtil = exports.CursorPagerFaker = exports.CursorPager = exports.generateId = exports.DataStoresError = exports.mongoUtil = exports.NeDbDatabase = exports.MongoDatabase = exports.StoreLoader = exports.DatabaseFactory = exports.StoreFactory = exports.AbstractStore = exports.DatabaseFixture = exports.AbstractDatabaseTest = void 0;
 var AbstractDatabaseTest_1 = require("./tests/AbstractDatabaseTest");
 Object.defineProperty(exports, "AbstractDatabaseTest", { enumerable: true, get: function () { return __importDefault(AbstractDatabaseTest_1).default; } });
 var DatabaseFixture_1 = require("./fixtures/DatabaseFixture");
@@ -43,6 +43,8 @@ __exportStar(require("./types/database.types"), exports);
 __exportStar(require("./types/query.types"), exports);
 __exportStar(require("./types/stores.types"), exports);
 __exportStar(require("./constants"), exports);
+var SpruceError_1 = require("./errors/SpruceError");
+Object.defineProperty(exports, "DataStoresError", { enumerable: true, get: function () { return __importDefault(SpruceError_1).default; } });
 var generateIdDeprecated_1 = require("./utilities/generateIdDeprecated");
 Object.defineProperty(exports, "generateId", { enumerable: true, get: function () { return __importDefault(generateIdDeprecated_1).default; } });
 var CursorPager_1 = require("./cursors/CursorPager");

package/build/tests/databaseAssertUtil.d.ts

@@ -1,75 +1,82 @@
-import { Connect } from '../__tests__/behavioral/database/Database.test';
-import { Database, Index, UniqueIndex } from '../types/database.types';
+import { Database, Index, TestConnect, UniqueIndex } from '../types/database.types';
 declare const databaseAssertUtil: {
     collectionName: string;
-    runSuite(connect: Connect): Promise<void>;
+    runSuite(connect: TestConnect, tests?: string[]): Promise<void>;
     _getFilteredIndexes(db: Database): Promise<UniqueIndex[] | Index[]>;
     _filterIdIndex(allIndexes: UniqueIndex[] | Index[]): UniqueIndex[] | Index[];
     _assertUpdateUpdatedRightNumberOfRecords(db: Database, search: Record<string, any>, updates: Record<string, any>, expectedUpdateCount: number): Promise<void>;
-    assertCanSortDesc(connect: Connect): Promise<void>;
-    assertCanSortAsc(connect: Connect): Promise<void>;
-    assertInsertingGeneratesId(connect: Connect): Promise<void>;
-    assertThrowsWhenUpdatingRecordNotFound(connect: Connect): Promise<void>;
+    generateIdDifferentEachTime(connect: TestConnect): Promise<void>;
+    assertCanSortDesc(connect: TestConnect): Promise<void>;
+    assertCanSortAsc(connect: TestConnect): Promise<void>;
+    assertInsertingGeneratesId(connect: TestConnect): Promise<void>;
+    assertThrowsWhenUpdatingRecordNotFound(connect: TestConnect): Promise<void>;
     shutdown(db: Database): Promise<void>;
-    assertCanCreateUniqueIndex(connect: Connect): Promise<void>;
-    assertHasNoUniqueIndexToStart(connect: Connect): Promise<void>;
-    assertCanShutdown(connect: Connect): Promise<void>;
-    assertCanDeleteOne(connect: Connect): Promise<void>;
-    assertCanDeleteRecord(connect: Connect): Promise<void>;
-    assertCanLimitResultsToZero(connect: Connect): Promise<void>;
-    assertCanLimitResults(connect: Connect): Promise<void>;
-    assertFindOneOnEmptyDatabaseReturnsNull(connect: Connect): Promise<void>;
-    assertEmptyDatabaseReturnsEmptyArray(connect: Connect): Promise<void>;
-    assertCanPushOntoArrayValue(connect: Connect): Promise<void>;
-    assertCanCreateMany(connect: Connect): Promise<void>;
-    assertCanUpdateMany(connect: Connect): Promise<void>;
-    assertCanQueryWithOr(connect: Connect): Promise<void>;
-    assertCanUpdate(connect: Connect): Promise<void>;
-    assertCanSortById(connect: Connect): Promise<void>;
-    assertCanCreateMultiFieldUniqueIndex(connect: Connect): Promise<void>;
-    assertSettingUniqueIndexViolationThrowsSpruceError(connect: Connect): Promise<void>;
-    assertDuplicateKeyThrowsOnInsert(connect: Connect): Promise<void>;
-    assertSyncingIndexesDoesNotAddAndRemove(connect: Connect): Promise<void>;
-    assertSyncingUniqueIndexesRemovesExtraIndexes(connect: Connect): Promise<void>;
-    assertSyncingUniqueIndexsSkipsExistingIndexs(connect: Connect): Promise<void>;
-    assertSyncingUniqueIndexsAddsMissingIndexes(connect: Connect): Promise<void>;
-    assertCantDropCompoundUniqueIndexThatDoesntExist(connect: Connect): Promise<void>;
-    assertCantDropIndexWhenNoIndexExists(connect: Connect): Promise<void>;
-    assertCantDropUniqueIndexThatDoesntExist(connect: Connect): Promise<void>;
-    assertCanDropCompoundUniqueIndex(connect: Connect): Promise<void>;
-    assertCanDropUniqueIndex(connect: Connect): Promise<void>;
-    assertCantCreateUniqueIndexTwice(connect: Connect): Promise<void>;
-    assertSyncingUniqueIndexesIsRaceProof(connect: Connect): Promise<void>;
-    assertUniqueIndexBlocksDuplicates(connect: Connect): Promise<void>;
-    assertCanCreateUniqueIndexOnNestedField(connect: Connect): Promise<void>;
-    assertCanPushToArrayOnUpsert(connect: Connect): Promise<void>;
-    assertCanSearchByRegex(connect: Connect): Promise<void>;
-    assertCanReturnOnlySelectFields(connect: Connect): Promise<void>;
-    assertThrowsWithoutDatabaseName(connect: Connect): Promise<void>;
-    assertThrowsWhenCantConnect(connect: Connect): Promise<void>;
-    assertThrowsWithInvalidConnectionString(connect: Connect): Promise<void>;
-    assertKnowsIfConnectionClosed(connect: Connect): Promise<void>;
-    assertCanQueryPathWithDotSyntax(connect: Connect): Promise<void>;
-    assertCanQueryByGtLtGteLte(connect: Connect): Promise<void>;
-    assertCanFindWithNe(connect: Connect): Promise<void>;
-    assertCanFindWithIn(connect: Connect): Promise<void>;
-    assertCanCountOnId(connect: Connect): Promise<void>;
-    assertCanCount(connect: Connect): Promise<void>;
-    assertCanUpsertNull(connect: Connect): Promise<void>;
-    assertCanSaveAndGetNullAndUndefined(connect: Connect): Promise<void>;
-    assertSyncIndexesDoesNotRemoveExisting(connect: Connect): Promise<void>;
-    assertSyncIndexesRemovesExtraIndexes(connect: Connect): Promise<void>;
-    assertSyncIndexesSkipsExisting(connect: Connect): Promise<void>;
-    assertCantDropCompoundIndexThatDoesNotExist(connect: Connect): Promise<void>;
-    assertCanDropCompoundIndex(connect: Connect): Promise<void>;
-    assertCanDropIndex(connect: Connect): Promise<void>;
-    assertCanCreateMultiFieldIndex(connect: Connect, fields: any): Promise<void>;
-    assertCantCreateSameIndexTwice(connect: Connect): Promise<void>;
-    assertCanCreateIndex(connect: Connect): Promise<void>;
-    assertHasNoIndexToStart(connect: Connect): Promise<void>;
-    assertNestedFieldIndexUpdates(connect: Connect): Promise<void>;
-    assertUpsertWithUniqueIndex(connect: Connect): Promise<void>;
-    assertSyncIndexesHandlesRaceConditions(connect: Connect): Promise<void>;
-    assertDuplicateFieldsWithMultipleUniqueIndexesWorkAsExpected(connect: Connect): Promise<void>;
+    assertCanCreateUniqueIndex(connect: TestConnect): Promise<void>;
+    assertHasNoUniqueIndexToStart(connect: TestConnect): Promise<void>;
+    assertCanUpsertOne(connect: TestConnect): Promise<void>;
+    assertCanDeleteOne(connect: TestConnect): Promise<void>;
+    assertCanDeleteRecord(connect: TestConnect): Promise<void>;
+    assertCanLimitResultsToZero(connect: TestConnect): Promise<void>;
+    assertCanLimitResults(connect: TestConnect): Promise<void>;
+    assertFindOneOnEmptyDatabaseReturnsNull(connect: TestConnect): Promise<void>;
+    assertEmptyDatabaseReturnsEmptyArray(connect: TestConnect): Promise<void>;
+    assertCanPushOntoArrayValue(connect: TestConnect): Promise<void>;
+    assertCanCreateWithObjectField(connect: TestConnect): Promise<void>;
+    canUpdateWithObjectField(connect: TestConnect): Promise<void>;
+    canUpdateFieldInObjectFieldWithTargettedWhere(connect: TestConnect): Promise<void>;
+    assertCanCreateMany(connect: TestConnect): Promise<void>;
+    assertCanUpdateMany(connect: TestConnect): Promise<void>;
+    assertCanQueryWithOr(connect: TestConnect): Promise<void>;
+    assertCanUpdate(connect: TestConnect): Promise<void>;
+    assertCanSortById(connect: TestConnect): Promise<void>;
+    assertCanCreateMultiFieldUniqueIndex(connect: TestConnect): Promise<void>;
+    assertSettingUniqueIndexViolationThrowsSpruceError(connect: TestConnect): Promise<void>;
+    assertDuplicateKeyThrowsOnInsert(connect: TestConnect): Promise<void>;
+    assertSyncingIndexesDoesNotAddAndRemove(connect: TestConnect): Promise<void>;
+    assertSyncingUniqueIndexesRemovesExtraIndexes(connect: TestConnect): Promise<void>;
+    assertSyncingUniqueIndexsSkipsExistingIndexs(connect: TestConnect): Promise<void>;
+    assertSyncingUniqueIndexsAddsMissingIndexes(connect: TestConnect): Promise<void>;
+    assertCantDropCompoundUniqueIndexThatDoesntExist(connect: TestConnect): Promise<void>;
+    assertCantDropIndexWhenNoIndexExists(connect: TestConnect): Promise<void>;
+    assertCantDropUniqueIndexThatDoesntExist(connect: TestConnect): Promise<void>;
+    assertCanDropCompoundUniqueIndex(connect: TestConnect): Promise<void>;
+    assertCanDropUniqueIndex(connect: TestConnect): Promise<void>;
+    assertCantCreateUniqueIndexTwice(connect: TestConnect): Promise<void>;
+    assertSyncingUniqueIndexesIsRaceProof(connect: TestConnect): Promise<void>;
+    assertUniqueIndexBlocksDuplicates(connect: TestConnect): Promise<void>;
+    assertCanCreateUniqueIndexOnNestedField(connect: TestConnect): Promise<void>;
+    assertCanPushToArrayOnUpsert(connect: TestConnect): Promise<void>;
+    assertCanSearchByRegex(connect: TestConnect): Promise<void>;
+    assertCanReturnOnlySelectFields(connect: TestConnect): Promise<void>;
+    assertThrowsWithBadDatabaseName(connect: TestConnect): Promise<void>;
+    assertThrowsWhenCantConnect(connect: TestConnect): Promise<void>;
+    assertThrowsWithInvalidConnectionString(connect: TestConnect): Promise<void>;
+    assertKnowsIfConnectionClosed(connect: TestConnect): Promise<void>;
+    assertCanQueryPathWithDotSyntax(connect: TestConnect): Promise<void>;
+    assertCanQueryByGtLtGteLte(connect: TestConnect): Promise<void>;
+    assertCanFindWithNe(connect: TestConnect): Promise<void>;
+    assertCanFindWithIn(connect: TestConnect): Promise<void>;
+    assertCanFindWithBooleanField(connect: TestConnect): Promise<void>;
+    assertCanCountOnId(connect: TestConnect): Promise<void>;
+    assertCanCount(connect: TestConnect): Promise<void>;
+    assertCanUpsertNull(connect: TestConnect): Promise<void>;
+    assertCanSaveAndGetNullAndUndefined(connect: TestConnect): Promise<void>;
+    assertSyncIndexesDoesNotRemoveExisting(connect: TestConnect): Promise<void>;
+    assertSyncIndexesRemovesExtraIndexes(connect: TestConnect): Promise<void>;
+    assertSyncIndexesSkipsExisting(connect: TestConnect): Promise<void>;
+    assertCantDropCompoundIndexThatDoesNotExist(connect: TestConnect): Promise<void>;
+    assertCanDropCompoundIndex(connect: TestConnect): Promise<void>;
+    assertCanDropIndex(connect: TestConnect): Promise<void>;
+    assertCanCreateMultiFieldIndex(connect: TestConnect): Promise<void>;
+    assertCantCreateSameIndexTwice(connect: TestConnect): Promise<void>;
+    assertCanCreateIndex(connect: TestConnect): Promise<void>;
+    assertHasNoIndexToStart(connect: TestConnect): Promise<void>;
+    assertNestedFieldIndexUpdates(connect: TestConnect): Promise<void>;
+    assertUpsertWithUniqueIndex(connect: TestConnect): Promise<void>;
+    assertSyncIndexesHandlesRaceConditions(connect: TestConnect): Promise<void>;
+    assertDuplicateFieldsWithMultipleUniqueIndexesWorkAsExpected(connect: TestConnect): Promise<void>;
+    _assertThrowsExpectedNotFoundOnUpdateOne(db: Database, query: Record<string, any>): Promise<void>;
+    _assert$orReturnsExpectedTotalRecords(db: Database, $or: Record<string, any>[], expected: number): Promise<void>;
+    _assertCanCreateMultiFieldIndex(connect: TestConnect, fields: string[]): Promise<void>;
 };
 export default databaseAssertUtil;