@orion-js/paginated-mongodb 3.11.15 → 3.12.0

package/package.json

@@ -1,41 +1,45 @@
 {
   "name": "@orion-js/paginated-mongodb",
-  "version": "3.11.15",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "version": "3.12.0",
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.ts",
   "files": [
-    "/lib"
+    "dist"
   ],
   "author": "nicolaslopezj",
   "license": "MIT",
   "scripts": {
-    "test": "jest",
+    "test": "bun test",
     "prepare": "yarn run build",
-    "clean": "rm -rf ./lib",
-    "build": "yarn run clean && tsc",
+    "clean": "rm -rf ./dist",
+    "build": "bun run build.ts",
     "watch": "tsc -w",
-    "upgrade-interactive": "yarn upgrade-interactive"
+    "upgrade-interactive": "yarn upgrade-interactive",
+    "dev": "bun --watch src/index.ts"
   },
   "dependencies": {
-    "@orion-js/helpers": "^3.11.15",
-    "@orion-js/models": "^3.11.15",
-    "@orion-js/mongodb": "^3.11.15",
-    "@orion-js/resolvers": "^3.11.15",
-    "@orion-js/schema": "^3.11.8",
-    "@orion-js/services": "^3.11.15",
-    "@orion-js/typed-model": "^3.11.15"
+    "@orion-js/helpers": "3.12.0",
+    "@orion-js/models": "3.12.0",
+    "@orion-js/mongodb": "3.12.0",
+    "@orion-js/resolvers": "3.12.0",
+    "@orion-js/schema": "3.12.0",
+    "@orion-js/services": "3.12.0",
+    "@orion-js/typed-model": "3.12.0"
   },
   "devDependencies": {
-    "@shelf/jest-mongodb": "^4.3.2",
-    "@types/jest": "^29.5.12",
     "@types/lodash": "4.14.176",
-    "@types/node": "16.11.7",
-    "jest": "29.7.0",
-    "ts-jest": "29.1.2",
-    "typescript": "^4.4.4"
+    "typescript": "^5.4.5",
+    "@types/bun": "^1.2.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "a5c95d9fd18f779c834644eb757928cdb840643c"
-}
+  "gitHead": "9fd28b6f6b348cebc9f0dc207805647969277372",
+  "type": "module",
+  "module": "./dist/index.js",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs"
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022 Orionjs Team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/lib/index.d.ts

@@ -1,4 +0,0 @@
-import paginatedResolver from './paginatedResolver';
-import tokenPaginatedResolver from './tokenPaginatedResolver';
-export { paginatedResolver, tokenPaginatedResolver };
-export * from './service';

package/lib/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.tokenPaginatedResolver = exports.paginatedResolver = void 0;
-const paginatedResolver_1 = __importDefault(require("./paginatedResolver"));
-exports.paginatedResolver = paginatedResolver_1.default;
-const tokenPaginatedResolver_1 = __importDefault(require("./tokenPaginatedResolver"));
-exports.tokenPaginatedResolver = tokenPaginatedResolver_1.default;
-__exportStar(require("./service"), exports);

package/lib/paginatedResolver/getModel.d.ts

@@ -1,5 +0,0 @@
-declare const _default: ({ returns, modelName }: {
-    returns: any;
-    modelName: any;
-}) => import("@orion-js/models").Model<any>;
-export default _default;

package/lib/paginatedResolver/getModel.js

@@ -1,77 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const models_1 = require("@orion-js/models");
-const hash_1 = __importDefault(require("./hash"));
-const resolvers_1 = require("@orion-js/resolvers");
-exports.default = ({ returns, modelName }) => {
-    const getTotalCount = async function (paginated) {
-        if (typeof paginated.count === 'undefined') {
-            paginated.count = await paginated.cursor.count();
-        }
-        return paginated.count;
-    };
-    const _id = (0, resolvers_1.modelResolver)({
-        returns: 'ID',
-        async resolve(paginated, p, viewer) {
-            const { params } = paginated;
-            const num = (0, hash_1.default)({
-                modelName: modelName,
-                typename: returns.name,
-                userId: viewer.userId,
-                params: params
-            });
-            return String(Math.abs(num));
-        }
-    });
-    const totalCount = (0, resolvers_1.modelResolver)({
-        returns: 'integer',
-        resolve: getTotalCount
-    });
-    const totalPages = (0, resolvers_1.modelResolver)({
-        returns: 'integer',
-        async resolve(paginated) {
-            const count = await getTotalCount(paginated);
-            if (!paginated.options.limit)
-                return 1;
-            return Math.ceil(count / paginated.options.limit);
-        }
-    });
-    const hasNextPage = (0, resolvers_1.modelResolver)({
-        returns: Boolean,
-        async resolve(paginated) {
-            const count = await getTotalCount(paginated);
-            const { skip, limit } = paginated.options;
-            if (!limit)
-                return false;
-            return skip + limit < count;
-        }
-    });
-    const hasPreviousPage = (0, resolvers_1.modelResolver)({
-        returns: Boolean,
-        async resolve(paginated) {
-            const count = await getTotalCount(paginated);
-            const { skip } = paginated.options;
-            return count && skip !== 0;
-        }
-    });
-    const items = (0, resolvers_1.modelResolver)({
-        returns: [returns],
-        async resolve({ cursor }) {
-            return await cursor.toArray();
-        }
-    });
-    return (0, models_1.createModel)({
-        name: modelName || `Paginated${returns.name}`,
-        resolvers: {
-            _id,
-            totalCount,
-            totalPages,
-            hasNextPage,
-            hasPreviousPage,
-            items
-        }
-    });
-};

package/lib/paginatedResolver/hash.d.ts

@@ -1 +0,0 @@
-export default function (obj?: object): number;

package/lib/paginatedResolver/hash.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function default_1(obj = {}) {
-    return JSON.stringify(obj)
-        .split('')
-        .reduce((prevHash, currVal) => (prevHash << 5) - prevHash + currVal.charCodeAt(0), 0);
-}
-exports.default = default_1;

package/lib/paginatedResolver/index.d.ts

@@ -1,36 +0,0 @@
-export interface PaginatedCursor {
-    count?: () => Promise<number> | number;
-    toArray: () => Promise<any[]>;
-    limit?: (newLimit: number) => void;
-    skip?: (newSkip: number) => void;
-    sort?: (newSort: {
-        [key: string]: 1 | -1;
-    }) => void;
-}
-export declare type PaginatedResolverGetCursorResultWithCount = {
-    count: () => Promise<number> | number;
-    cursor: PaginatedCursor;
-};
-export declare type PaginatedResolverGetCursorResult = PaginatedCursor | PaginatedResolverGetCursorResultWithCount;
-export interface PaginatedResolverOpts {
-    returns: any;
-    getCursor: (params?: any, viewer?: any) => Promise<PaginatedResolverGetCursorResult>;
-    allowedSorts?: string[];
-    defaultSortBy?: string;
-    defaultSortType?: 'asc' | 'desc';
-    params?: any;
-    modelName?: string;
-    permissionsOptions?: any;
-}
-export default function paginatedResolver({ returns, params, allowedSorts, defaultSortBy, defaultSortType, getCursor, getCursorAndCount, modelName, ...otherOptions }: PaginatedResolverOpts & {
-    [key: string]: any;
-}): import("@orion-js/resolvers").Resolver<(params: any, viewer: any, info?: any) => Promise<{
-    cursor: PaginatedCursor;
-    params: any;
-    viewer: any;
-    options: {
-        skip: number;
-        limit: any;
-    };
-    count: number;
-}>, undefined>;

package/lib/paginatedResolver/index.js

@@ -1,44 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const resolvers_1 = require("@orion-js/resolvers");
-const getModel_1 = __importDefault(require("./getModel"));
-const params_1 = __importDefault(require("./params"));
-const setOptions_1 = __importDefault(require("./setOptions"));
-const getArgs_1 = require("@orion-js/resolvers/lib/resolver/getArgs");
-function paginatedResolver({ returns, params, allowedSorts, defaultSortBy, defaultSortType, getCursor, getCursorAndCount, modelName, ...otherOptions }) {
-    const getCursorResult = async (...args) => {
-        const result = await getCursor(...args);
-        if (result.cursor) {
-            const resultWithCount = result;
-            return { cursor: resultWithCount.cursor, getCount: () => resultWithCount.count() };
-        }
-        else {
-            const resultWithoutCount = result;
-            return { cursor: resultWithoutCount, getCount: () => resultWithoutCount.count() };
-        }
-    };
-    return (0, resolvers_1.resolver)({
-        params: (0, params_1.default)({ params, allowedSorts, defaultSortBy, defaultSortType }),
-        returns: (0, getModel_1.default)({ modelName, returns }),
-        async resolve(...args) {
-            const { params, viewer } = (0, getArgs_1.getArgs)(...args);
-            const { cursor, getCount } = await getCursorResult(...args);
-            /* counting the total number of elements of this cursor, so we make sure
-             that it is going to be computed only once */
-            const count = await getCount();
-            const options = (0, setOptions_1.default)(params, cursor);
-            return {
-                cursor,
-                params,
-                viewer,
-                options,
-                count
-            };
-        },
-        ...otherOptions
-    });
-}
-exports.default = paginatedResolver;

package/lib/paginatedResolver/index.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/paginatedResolver/index.test.js

@@ -1,127 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const models_1 = require("@orion-js/models");
-const helpers_1 = require("@orion-js/helpers");
-const _1 = __importDefault(require("."));
-const typed_model_1 = require("@orion-js/typed-model");
-const mongodb_1 = require("@orion-js/mongodb");
-describe('Full example of paginated resolver', () => {
-    const createResolver = async () => {
-        let ItemSchema = class ItemSchema {
-        };
-        __decorate([
-            (0, typed_model_1.Prop)(),
-            __metadata("design:type", String)
-        ], ItemSchema.prototype, "_id", void 0);
-        __decorate([
-            (0, typed_model_1.Prop)(),
-            __metadata("design:type", String)
-        ], ItemSchema.prototype, "name", void 0);
-        __decorate([
-            (0, typed_model_1.Prop)(),
-            __metadata("design:type", Number)
-        ], ItemSchema.prototype, "index", void 0);
-        ItemSchema = __decorate([
-            (0, typed_model_1.TypedSchema)()
-        ], ItemSchema);
-        const collection = (0, mongodb_1.createCollection)({
-            name: (0, helpers_1.generateId)(),
-            schema: ItemSchema
-        });
-        await collection.insertMany([
-            { name: `Number 1`, index: 1 },
-            { name: `Number 2`, index: 2 },
-            { name: `Number 3`, index: 3 },
-            { name: `Number 4`, index: 4 },
-            { name: `Number 5`, index: 5 },
-            { name: `Number 6`, index: 6 }
-        ]);
-        let Params = class Params {
-        };
-        __decorate([
-            (0, typed_model_1.Prop)({ optional: true }),
-            __metadata("design:type", String)
-        ], Params.prototype, "filter", void 0);
-        Params = __decorate([
-            (0, typed_model_1.TypedSchema)()
-        ], Params);
-        return (0, _1.default)({
-            returns: ItemSchema,
-            params: Params,
-            allowedSorts: ['index'],
-            async getCursor(params) {
-                const query = {};
-                if (params.filter) {
-                    query.name = params.filter;
-                }
-                return collection.find(query);
-            }
-        });
-    };
-    it('should work passing custom params', async () => {
-        const resolver = await createResolver();
-        const result = (await resolver.resolve({
-            filter: `Number 1`
-        }, {}));
-        const items = await result.items();
-        const count = await result.totalCount();
-        expect(items.length).toBe(1);
-        expect(items[0].index).toBe(1);
-        expect(count).toBe(1);
-    });
-    it('should using sorts', async () => {
-        const resolver = await createResolver();
-        const result = (await resolver.resolve({
-            sortBy: 'index',
-            sortType: 'asc'
-        }, {}));
-        const items = await result.items();
-        const count = await result.totalCount();
-        expect(items.map(item => item.index)).toEqual([1, 2, 3, 4, 5, 6]);
-        expect(count).toBe(6);
-    });
-});
-describe('Cursors with count', () => {
-    const createResolver = async () => {
-        const cursor = {
-            count: () => 100,
-            toArray: async () => [{ hello: 'foo' }]
-        };
-        return (0, _1.default)({
-            returns: (0, models_1.createModel)({
-                name: 'Hello',
-                schema: {
-                    hello: {
-                        type: String
-                    }
-                }
-            }),
-            async getCursor() {
-                return {
-                    cursor: cursor,
-                    count: () => 10
-                };
-            }
-        });
-    };
-    it('should not call cursor.count', async () => {
-        const resolver = await createResolver();
-        const result = (await resolver.resolve({}, {}));
-        const items = await result.items();
-        const count = await result.totalCount();
-        expect(items.length).toBe(1);
-        expect(count).toBe(10);
-    });
-});

package/lib/paginatedResolver/params.d.ts

@@ -1,5 +0,0 @@
-import { Schema } from '@orion-js/schema';
-import { PaginatedResolverOpts } from '.';
-declare type OptionsKeys = 'params' | 'allowedSorts' | 'defaultSortBy' | 'defaultSortType';
-export default function getParams(options: Pick<PaginatedResolverOpts, OptionsKeys>): Schema;
-export {};

package/lib/paginatedResolver/params.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const lodash_1 = require("lodash");
-function getParams(options) {
-    const { params, allowedSorts, defaultSortBy, defaultSortType } = options;
-    const schema = {
-        page: {
-            type: 'integer',
-            defaultValue: 1,
-            min: 1
-        },
-        limit: {
-            type: 'integer',
-            defaultValue: 0,
-            min: 0,
-            max: 200
-        }
-    };
-    if (allowedSorts && allowedSorts.length) {
-        schema.sortBy = {
-            type: String,
-            allowedValues: allowedSorts,
-            optional: true
-        };
-        if (defaultSortBy) {
-            schema.sortBy.defaultValue = defaultSortBy;
-        }
-        schema.sortType = {
-            type: String,
-            allowedValues: ['asc', 'desc'],
-            optional: true
-        };
-        if (defaultSortType) {
-            schema.sortType.defaultValue = defaultSortType;
-        }
-    }
-    if (params) {
-        if (typeof params === 'function' && params.getModel && params.__schemaId) {
-            const modelSchema = params.getModel().getSchema();
-            Object.assign(schema, (0, lodash_1.omit)(modelSchema, '__model'));
-        }
-        else if (params.__isModel) {
-            const modelSchema = params.getSchema();
-            Object.assign(schema, (0, lodash_1.omit)(modelSchema, '__model'));
-        }
-        else {
-            Object.assign(schema, params);
-        }
-    }
-    return schema;
-}
-exports.default = getParams;

package/lib/paginatedResolver/params.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/paginatedResolver/params.test.js

@@ -1,149 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const models_1 = require("@orion-js/models");
-const params_1 = __importDefault(require("./params"));
-const typed_model_1 = require("@orion-js/typed-model");
-describe('Get params', () => {
-    it('should return the params', () => {
-        const params = (0, params_1.default)({
-            params: { foo: 'bar' }
-        });
-        expect(params).toEqual({
-            page: {
-                type: 'integer',
-                defaultValue: 1,
-                min: 1
-            },
-            limit: {
-                type: 'integer',
-                defaultValue: 0,
-                min: 0,
-                max: 200
-            },
-            foo: 'bar'
-        });
-    });
-    it('should return the params with allowed sort', () => {
-        const params = (0, params_1.default)({
-            params: { foo: 'bar' },
-            allowedSorts: ['foo']
-        });
-        expect(params).toEqual({
-            page: {
-                type: 'integer',
-                defaultValue: 1,
-                min: 1
-            },
-            limit: {
-                type: 'integer',
-                defaultValue: 0,
-                min: 0,
-                max: 200
-            },
-            sortBy: {
-                type: String,
-                allowedValues: ['foo'],
-                optional: true
-            },
-            sortType: {
-                type: String,
-                allowedValues: ['asc', 'desc'],
-                optional: true
-            },
-            foo: 'bar'
-        });
-    });
-    it('should return the params correctly if we pass a model', () => {
-        const model = (0, models_1.createModel)({
-            name: 'Params',
-            schema: {
-                foo: {
-                    type: 'string'
-                }
-            }
-        });
-        const params = (0, params_1.default)({
-            params: model,
-            allowedSorts: ['foo']
-        });
-        expect(params).toEqual({
-            page: {
-                type: 'integer',
-                defaultValue: 1,
-                min: 1
-            },
-            limit: {
-                type: 'integer',
-                defaultValue: 0,
-                min: 0,
-                max: 200
-            },
-            sortBy: {
-                type: String,
-                allowedValues: ['foo'],
-                optional: true
-            },
-            sortType: {
-                type: String,
-                allowedValues: ['asc', 'desc'],
-                optional: true
-            },
-            foo: {
-                type: 'string'
-            }
-        });
-    });
-    it('should return the params correctly if we pass a typed schema', () => {
-        let Schema = class Schema {
-        };
-        __decorate([
-            (0, typed_model_1.Prop)(),
-            __metadata("design:type", String)
-        ], Schema.prototype, "foo", void 0);
-        Schema = __decorate([
-            (0, typed_model_1.TypedSchema)()
-        ], Schema);
-        const params = (0, params_1.default)({
-            params: Schema,
-            allowedSorts: ['foo']
-        });
-        expect(params).toEqual({
-            page: {
-                type: 'integer',
-                defaultValue: 1,
-                min: 1
-            },
-            limit: {
-                type: 'integer',
-                defaultValue: 0,
-                min: 0,
-                max: 200
-            },
-            sortBy: {
-                type: String,
-                allowedValues: ['foo'],
-                optional: true
-            },
-            sortType: {
-                type: String,
-                allowedValues: ['asc', 'desc'],
-                optional: true
-            },
-            foo: {
-                type: String
-            }
-        });
-    });
-});

package/lib/paginatedResolver/setOptions.d.ts

@@ -1,10 +0,0 @@
-import { PaginatedCursor } from './index';
-export default function ({ page, limit, sortBy, sortType }: {
-    page: any;
-    limit: any;
-    sortBy: any;
-    sortType: any;
-}, cursor: PaginatedCursor): {
-    skip: number;
-    limit: any;
-};

package/lib/paginatedResolver/setOptions.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function default_1({ page, limit, sortBy, sortType }, cursor) {
-    const skip = limit * (page - 1);
-    if (limit && cursor.limit) {
-        cursor.limit(limit);
-    }
-    if (skip && cursor.skip) {
-        cursor.skip(skip);
-    }
-    if (sortBy && sortType && cursor.sort) {
-        cursor.sort({
-            [`${sortBy}`]: sortType === 'asc' ? 1 : -1
-        });
-    }
-    return {
-        skip,
-        limit
-    };
-}
-exports.default = default_1;