@sprucelabs/data-stores 11.1.0 → 11.2.2

package/build/{CursorPager.d.ts → cursors/CursorPager.d.ts}

@@ -1,16 +1,16 @@
-import { QueryOptions } from './types/query.types';
+import { QueryOptions } from '../types/query.types';
 export interface CursorQueryOptions extends Omit<QueryOptions, 'skip'> {
     limit: number;
     next: string | null;
     previous: string | null;
 }
-interface Cursor<Response extends Record<string, any>[] = Record<string, any>[]> {
+export interface RecordsWithCursors<Response extends Record<string, any>[] = Record<string, any>[]> {
     records: Response;
     next: string | null;
     previous: string | null;
 }
 export default class CursorPager {
-    static find<S extends SimpleStore, Find extends S['find'] = S['find'], Query extends Parameters<Find>[0] = Parameters<Find>[0], PromisedResponse extends ReturnType<Find> = ReturnType<Find>, Response extends UnPromisify<PromisedResponse> = UnPromisify<PromisedResponse>>(store: S, query: Query, options: CursorQueryOptions): Promise<Cursor<Response>>;
+    static find<S extends SimpleStore, Find extends S['find'] = S['find'], Query extends Parameters<Find>[0] = Parameters<Find>[0], PromisedResponse extends ReturnType<Find> = ReturnType<Find>, Response extends UnPromisify<PromisedResponse> = UnPromisify<PromisedResponse>>(store: S, query: Query, options: CursorQueryOptions): Promise<RecordsWithCursors<Response>>;
     private static getSortFieldValuesFromRecord;
     private static trackNewest;
     private static parseCursor;
@@ -21,7 +21,7 @@ export default class CursorPager {
         sort: NonNullable<O['sort']>;
     };
 }
-interface SimpleStore {
+export interface SimpleStore {
     find: (...args: any[]) => Promise<any>;
 }
 declare type UnPromisify<T> = T extends Promise<infer U> ? U : T;

package/build/{CursorPager.js → cursors/CursorPager.js}

@@ -104,7 +104,14 @@ class CursorPager {
         return JSON.stringify(cursor);
     }
     static prepareQueryOptions(options) {
-        const { previous, sort = [] } = (0, just_clone_1.default)((0, schema_1.assertOptions)(options, ['limit']));
+        const { previous, sort = [], limit, } = (0, just_clone_1.default)((0, schema_1.assertOptions)(options, ['limit']));
+        if (limit < 1) {
+            throw new schema_1.SchemaError({
+                code: 'INVALID_PARAMETERS',
+                parameters: ['limit'],
+                friendlyMessage: 'Your limit must be above zero!',
+            });
+        }
         if (!sort.find((p) => p.field === 'id')) {
             sort.push({
                 field: 'id',
@@ -116,7 +123,7 @@ class CursorPager {
                 s.direction = s.direction === 'asc' ? 'desc' : 'asc';
             }
         }
-        return Object.assign(Object.assign({}, options), { limit: options.limit + 1, sort });
+        return Object.assign(Object.assign({}, options), { limit: limit + 1, sort });
     }
 }
 exports.default = CursorPager;

package/build/cursors/CursorPagerFaker.d.ts

@@ -0,0 +1,6 @@
+import { CursorQueryOptions, RecordsWithCursors, SimpleStore } from './CursorPager';
+export default class CursorPagerFaker {
+    private static originalFind;
+    static setResponse(response: (store: SimpleStore, query: Record<string, any>, options: CursorQueryOptions) => Promise<Partial<RecordsWithCursors<Record<string, any>[]>>>): void;
+    static beforeEach(): Promise<void>;
+}

package/build/cursors/CursorPagerFaker.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CursorPager_1 = __importDefault(require("./CursorPager"));
+class CursorPagerFaker {
+    static setResponse(response) {
+        //@ts-ignore
+        CursorPager_1.default.find = async (...args) => {
+            //@ts-ignore
+            const results = await response(...args);
+            return Object.assign({ next: null, previous: null, records: [] }, results);
+        };
+    }
+    static async beforeEach() {
+        if (!this.originalFind) {
+            this.originalFind = CursorPager_1.default.find.bind(CursorPager_1.default);
+        }
+        else {
+            CursorPager_1.default.find = this.originalFind;
+        }
+    }
+}
+exports.default = CursorPagerFaker;

package/build/esm/{CursorPager.d.ts → cursors/CursorPager.d.ts}

@@ -1,16 +1,16 @@
-import { QueryOptions } from './types/query.types';
+import { QueryOptions } from '../types/query.types';
 export interface CursorQueryOptions extends Omit<QueryOptions, 'skip'> {
     limit: number;
     next: string | null;
     previous: string | null;
 }
-interface Cursor<Response extends Record<string, any>[] = Record<string, any>[]> {
+export interface RecordsWithCursors<Response extends Record<string, any>[] = Record<string, any>[]> {
     records: Response;
     next: string | null;
     previous: string | null;
 }
 export default class CursorPager {
-    static find<S extends SimpleStore, Find extends S['find'] = S['find'], Query extends Parameters<Find>[0] = Parameters<Find>[0], PromisedResponse extends ReturnType<Find> = ReturnType<Find>, Response extends UnPromisify<PromisedResponse> = UnPromisify<PromisedResponse>>(store: S, query: Query, options: CursorQueryOptions): Promise<Cursor<Response>>;
+    static find<S extends SimpleStore, Find extends S['find'] = S['find'], Query extends Parameters<Find>[0] = Parameters<Find>[0], PromisedResponse extends ReturnType<Find> = ReturnType<Find>, Response extends UnPromisify<PromisedResponse> = UnPromisify<PromisedResponse>>(store: S, query: Query, options: CursorQueryOptions): Promise<RecordsWithCursors<Response>>;
     private static getSortFieldValuesFromRecord;
     private static trackNewest;
     private static parseCursor;
@@ -21,7 +21,7 @@ export default class CursorPager {
         sort: NonNullable<O['sort']>;
     };
 }
-interface SimpleStore {
+export interface SimpleStore {
     find: (...args: any[]) => Promise<any>;
 }
 declare type UnPromisify<T> = T extends Promise<infer U> ? U : T;

package/build/esm/{CursorPager.js → cursors/CursorPager.js}

@@ -18,7 +18,7 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-import { assertOptions } from '@sprucelabs/schema';
+import { assertOptions, SchemaError } from '@sprucelabs/schema';
 import clone from 'just-clone';
 export default class CursorPager {
     static find(store, query, options) {
@@ -110,7 +110,14 @@ export default class CursorPager {
         return JSON.stringify(cursor);
     }
     static prepareQueryOptions(options) {
-        const { previous, sort = [] } = clone(assertOptions(options, ['limit']));
+        const { previous, sort = [], limit, } = clone(assertOptions(options, ['limit']));
+        if (limit < 1) {
+            throw new SchemaError({
+                code: 'INVALID_PARAMETERS',
+                parameters: ['limit'],
+                friendlyMessage: 'Your limit must be above zero!',
+            });
+        }
         if (!sort.find((p) => p.field === 'id')) {
             sort.push({
                 field: 'id',
@@ -122,6 +129,6 @@ export default class CursorPager {
                 s.direction = s.direction === 'asc' ? 'desc' : 'asc';
             }
         }
-        return Object.assign(Object.assign({}, options), { limit: options.limit + 1, sort });
+        return Object.assign(Object.assign({}, options), { limit: limit + 1, sort });
     }
 }

package/build/esm/cursors/CursorPagerFaker.d.ts

@@ -0,0 +1,6 @@
+import { CursorQueryOptions, RecordsWithCursors, SimpleStore } from './CursorPager';
+export default class CursorPagerFaker {
+    private static originalFind;
+    static setResponse(response: (store: SimpleStore, query: Record<string, any>, options: CursorQueryOptions) => Promise<Partial<RecordsWithCursors<Record<string, any>[]>>>): void;
+    static beforeEach(): Promise<void>;
+}

package/build/esm/cursors/CursorPagerFaker.js

@@ -0,0 +1,30 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import CursorPager from './CursorPager.js';
+export default class CursorPagerFaker {
+    static setResponse(response) {
+        //@ts-ignore
+        CursorPager.find = (...args) => __awaiter(this, void 0, void 0, function* () {
+            //@ts-ignore
+            const results = yield response(...args);
+            return Object.assign({ next: null, previous: null, records: [] }, results);
+        });
+    }
+    static beforeEach() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.originalFind) {
+                this.originalFind = CursorPager.find.bind(CursorPager);
+            }
+            else {
+                CursorPager.find = this.originalFind;
+            }
+        });
+    }
+}

package/build/esm/index.d.ts

@@ -15,5 +15,7 @@ export * from './types/query.types';
 export * from './types/stores.types';
 export * from './constants';
 export { default as generateId } from './utilities/generateId';
-export { default as CursorPager } from './CursorPager';
-export * from './CursorPager';
+export { default as CursorPager } from './cursors/CursorPager';
+export * from './cursors/CursorPager';
+export { default as CursorPagerFaker } from './cursors/CursorPagerFaker';
+export * from './cursors/CursorPager';

package/build/esm/index.js

@@ -15,5 +15,7 @@ export * from './types/query.types.js';
 export * from './types/stores.types.js';
 export * from './constants.js';
 export { default as generateId } from './utilities/generateId.js';
-export { default as CursorPager } from './CursorPager.js';
-export * from './CursorPager.js';
+export { default as CursorPager } from './cursors/CursorPager.js';
+export * from './cursors/CursorPager.js';
+export { default as CursorPagerFaker } from './cursors/CursorPagerFaker.js';
+export * from './cursors/CursorPager.js';

package/build/index.d.ts

@@ -15,5 +15,7 @@ export * from './types/query.types';
 export * from './types/stores.types';
 export * from './constants';
 export { default as generateId } from './utilities/generateId';
-export { default as CursorPager } from './CursorPager';
-export * from './CursorPager';
+export { default as CursorPager } from './cursors/CursorPager';
+export * from './cursors/CursorPager';
+export { default as CursorPagerFaker } from './cursors/CursorPagerFaker';
+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.CursorPager = exports.generateId = exports.mongoUtil = exports.NeDbDatabase = exports.MongoDatabase = exports.StoreLoader = exports.DatabaseFactory = exports.StoreFactory = exports.AbstractStore = exports.DatabaseFixture = exports.AbstractDatabaseTest = void 0;
+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;
 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");
@@ -45,6 +45,9 @@ __exportStar(require("./types/stores.types"), exports);
 __exportStar(require("./constants"), exports);
 var generateId_1 = require("./utilities/generateId");
 Object.defineProperty(exports, "generateId", { enumerable: true, get: function () { return __importDefault(generateId_1).default; } });
-var CursorPager_1 = require("./CursorPager");
+var CursorPager_1 = require("./cursors/CursorPager");
 Object.defineProperty(exports, "CursorPager", { enumerable: true, get: function () { return __importDefault(CursorPager_1).default; } });
-__exportStar(require("./CursorPager"), exports);
+__exportStar(require("./cursors/CursorPager"), exports);
+var CursorPagerFaker_1 = require("./cursors/CursorPagerFaker");
+Object.defineProperty(exports, "CursorPagerFaker", { enumerable: true, get: function () { return __importDefault(CursorPagerFaker_1).default; } });
+__exportStar(require("./cursors/CursorPager"), exports);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "11.1.0",
+  "version": "11.2.2",
   "files": [
     "build/**/*",
     "!build/__tests__",