nicot 1.1.9 → 1.1.11

package/dist/src/utility/cursor-pagination-utils.js

@@ -0,0 +1,158 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPaginatedResult = exports.extractValueFromOrderByKey = void 0;
+const typeorm_1 = require("typeorm");
+const lodash_1 = __importDefault(require("lodash"));
+const superjson_1 = __importDefault(require("superjson"));
+function getValueFromOrderBy(orderBy) {
+    return typeof orderBy === 'string' ? orderBy : orderBy.order;
+}
+function getOperator(type, orderBy) {
+    const value = getValueFromOrderBy(orderBy);
+    const isBackwards = (type === 'prev') !== (value === 'DESC');
+    return isBackwards ? '<' : '>';
+}
+function getReversedTypeormOrderBy(orderBy) {
+    if (typeof orderBy === 'string') {
+        return {
+            order: orderBy === 'ASC' ? 'DESC' : 'ASC',
+            nulls: undefined,
+        };
+    }
+    return {
+        order: orderBy.order === 'ASC' ? 'DESC' : 'ASC',
+        nulls: orderBy.nulls
+            ? orderBy.nulls === 'NULLS FIRST'
+                ? 'NULLS LAST'
+                : 'NULLS FIRST'
+            : undefined,
+    };
+}
+function reverseQueryOrderBy(qb) {
+    const orderBys = getTypeormOrderBy(qb);
+    orderBys.forEach(({ key, direction }, i) => {
+        const reversed = getReversedTypeormOrderBy(direction);
+        if (i === 0) {
+            qb.orderBy(key, reversed.order, reversed.nulls);
+        }
+        else {
+            qb.addOrderBy(key, reversed.order, reversed.nulls);
+        }
+    });
+}
+function getTypeormOrderBy(qb) {
+    const orderBy = qb.expressionMap.allOrderBys;
+    const orderByEntrys = Object.entries(orderBy);
+    return orderByEntrys.map(([key, value]) => ({
+        key,
+        direction: value,
+    }));
+}
+function extractValueFromOrderByKey(obj, key, entityAliasName) {
+    const getField = (obj, key) => {
+        const value = obj[key];
+        if (!value)
+            return undefined;
+        if (Array.isArray(value)) {
+            if (!value.length) {
+                return undefined;
+            }
+            return value[value.length - 1];
+        }
+        return value;
+    };
+    const [alias, field] = key.split('.');
+    if (alias === entityAliasName) {
+        return getField(obj, field);
+    }
+    const aliasParts = alias.split('_');
+    if (aliasParts.length === 1) {
+        const value = getField(obj, alias);
+        if (!value)
+            return undefined;
+        return getField(value, field);
+    }
+    const value = getField(obj, aliasParts[0]);
+    if (!value)
+        return undefined;
+    return extractValueFromOrderByKey(value, `${aliasParts.slice(1).join('_')}.${field}`);
+}
+exports.extractValueFromOrderByKey = extractValueFromOrderByKey;
+function encodeBase64Url(str) {
+    return Buffer.from(str)
+        .toString('base64')
+        .replace(/\+/g, '-')
+        .replace(/\//g, '_')
+        .replace(/=+$/, '');
+}
+function decodeBase64Url(str) {
+    str = str.replace(/-/g, '+').replace(/_/g, '/');
+    while (str.length % 4)
+        str += '=';
+    return Buffer.from(str, 'base64').toString();
+}
+async function getPaginatedResult(qb, entityAliasName, take, cursor) {
+    const orderBys = getTypeormOrderBy(qb);
+    qb.take(take + 1);
+    let type = 'next';
+    if (cursor) {
+        // cursor is base64url encoded string
+        const data = superjson_1.default.parse(decodeBase64Url(cursor));
+        type = data.type;
+        const keys = Object.keys(data.payload).filter((k) => qb.expressionMap.orderBys[k]);
+        if (keys.length) {
+            const staircasedKeys = keys.map((key, i) => lodash_1.default.range(i + 1).map((j) => keys[j]));
+            const cursorKey = (key) => `_cursor_${key.replace(/\./g, '__')}`;
+            qb.andWhere(new typeorm_1.Brackets((sqb) => {
+                const brackets = staircasedKeys.map((keys, i) => new typeorm_1.Brackets((ssqb) => {
+                    const expressions = keys.map((key, j) => {
+                        const paramKey = cursorKey(key);
+                        const operator = j === keys.length - 1
+                            ? `${getOperator(data.type, qb.expressionMap.orderBys[key])}`
+                            : '=';
+                        return `${key} ${operator} :${paramKey}`;
+                    });
+                    const [firstExpression, ...restExpressions] = expressions;
+                    ssqb.where(firstExpression);
+                    restExpressions.forEach((expression) => ssqb.andWhere(expression));
+                }));
+                const [firstBrackets, ...restBrackets] = brackets;
+                sqb.where(firstBrackets);
+                restBrackets.forEach((brackets) => sqb.orWhere(brackets));
+            })).setParameters(lodash_1.default.mapKeys(data.payload, (_, key) => cursorKey(key)));
+        }
+        if (data.type === 'prev') {
+            reverseQueryOrderBy(qb);
+        }
+    }
+    const data = await qb.getMany();
+    const enough = data.length > take;
+    const hasNext = enough || type === 'prev';
+    const hasPrev = cursor && (enough || type === 'next');
+    if (enough) {
+        data.pop();
+    }
+    if (type === 'prev') {
+        data.reverse();
+    }
+    const generateCursor = (type, data) => {
+        const targetObject = type === 'prev' ? data[0] : data[data.length - 1];
+        const payload = Object.fromEntries(orderBys.map(({ key }) => {
+            const value = extractValueFromOrderByKey(targetObject, key, entityAliasName);
+            return [key, value];
+        }));
+        return encodeBase64Url(superjson_1.default.stringify({ type, payload }));
+    };
+    return {
+        data,
+        paginatedResult: {
+            nextCursor: hasNext ? generateCursor('next', data) : undefined,
+            previousCursor: hasPrev ? generateCursor('prev', data) : undefined,
+        },
+    };
+}
+exports.getPaginatedResult = getPaginatedResult;
+//# sourceMappingURL=cursor-pagination-utils.js.map

package/dist/src/utility/cursor-pagination-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cursor-pagination-utils.js","sourceRoot":"","sources":["../../../src/utility/cursor-pagination-utils.ts"],"names":[],"mappings":";;;;;;AAAA,qCAAuD;AACvD,oDAAuB;AACvB,0DAA8B;AAS9B,SAAS,mBAAmB,CAAC,OAAuB;IAClD,OAAO,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC;AAC/D,CAAC;AAED,SAAS,WAAW,CAAC,IAAqB,EAAE,OAAuB;IACjE,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC3C,MAAM,WAAW,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC;IAC7D,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;AACjC,CAAC;AAED,SAAS,yBAAyB,CAChC,OAAgC;IAEhC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;QAC/B,OAAO;YACL,KAAK,EAAE,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK;YACzC,KAAK,EAAE,SAAS;SACjB,CAAC;KACH;IACD,OAAO;QACL,KAAK,EAAE,OAAO,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK;QAC/C,KAAK,EAAE,OAAO,CAAC,KAAK;YAClB,CAAC,CAAC,OAAO,CAAC,KAAK,KAAK,aAAa;gBAC/B,CAAC,CAAC,YAAY;gBACd,CAAC,CAAC,aAAa;YACjB,CAAC,CAAC,SAAS;KACd,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,EAA2B;IACtD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;IACvC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,EAAE,CAAC,EAAE,EAAE;QACzC,MAAM,QAAQ,GAAG,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,KAAK,CAAC,EAAE;YACX,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;SACjD;aAAM;YACL,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;SACpD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CACxB,EAA2B;IAE3B,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,WAAW,CAAC;IAC7C,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9C,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;QAC1C,GAAG;QACH,SAAS,EAAE,KAAK;KACjB,CAAC,CAAC,CAAC;AACN,CAAC;AAED,SAAgB,0BAA0B,CACxC,GAAQ,EACR,GAAW,EACX,eAAwB;IAExB,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC5B,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAC7B,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;gBACjB,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;SAChC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IACF,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,KAAK,KAAK,eAAe,EAAE;QAC7B,OAAO,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;KAC7B;IACD,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAEpC,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;QAC3B,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK;YAAE,OAAO,SAAS,CAAC;QAC7B,OAAO,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;KAC/B;IACD,MAAM,KAAK,GAAG,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK;QAAE,OAAO,SAAS,CAAC;IAC7B,OAAO,0BAA0B,CAC/B,KAAK,EACL,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAC5C,CAAC;AACJ,CAAC;AAjCD,gEAiCC;AAED,SAAS,eAAe,CAAC,GAAW;IAClC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;SACpB,QAAQ,CAAC,QAAQ,CAAC;SAClB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;SACnB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AACxB,CAAC;AAED,SAAS,eAAe,CAAC,GAAW;IAClC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAChD,OAAO,GAAG,CAAC,MAAM,GAAG,CAAC;QAAE,GAAG,IAAI,GAAG,CAAC;IAClC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC/C,CAAC;AAEM,KAAK,UAAU,kBAAkB,CACtC,EAAyB,EACzB,eAAuB,EACvB,IAAY,EACZ,MAAe;IAEf,MAAM,QAAQ,GAAG,iBAAiB,CAAC,EAAE,CAAC,CAAC;IACvC,EAAE,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC;IAElB,IAAI,IAAI,GAAoB,MAAM,CAAC;IACnC,IAAI,MAAM,EAAE;QACV,qCAAqC;QACrC,MAAM,IAAI,GAAG,mBAAK,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAG/C,CAAC;QAEF,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAEjB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAC3C,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CACpC,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CACzC,gBAAC,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CACnC,CAAC;YAEF,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,EAAE,CAAC,WAAW,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;YAEzE,EAAE,CAAC,QAAQ,CACT,IAAI,kBAAQ,CAAC,CAAC,GAAG,EAAE,EAAE;gBACnB,MAAM,QAAQ,GAAG,cAAc,CAAC,GAAG,CACjC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CACV,IAAI,kBAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;oBACpB,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;wBACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;wBAChC,MAAM,QAAQ,GACZ,CAAC,KAAK,IAAI,CAAC,MAAM,GAAG,CAAC;4BACnB,CAAC,CAAC,GAAG,WAAW,CACZ,IAAI,CAAC,IAAI,EACT,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,CAC/B,EAAE;4BACL,CAAC,CAAC,GAAG,CAAC;wBACV,OAAO,GAAG,GAAG,IAAI,QAAQ,KAAK,QAAQ,EAAE,CAAC;oBAC3C,CAAC,CAAC,CAAC;oBACH,MAAM,CAAC,eAAe,EAAE,GAAG,eAAe,CAAC,GAAG,WAAW,CAAC;oBAC1D,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;oBAC5B,eAAe,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE,CACrC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAC1B,CAAC;gBACJ,CAAC,CAAC,CACL,CAAC;gBACF,MAAM,CAAC,aAAa,EAAE,GAAG,YAAY,CAAC,GAAG,QAAQ,CAAC;gBAClD,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBACzB,YAAY,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC5D,CAAC,CAAC,CACH,CAAC,aAAa,CAAC,gBAAC,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;SACtE;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;YACxB,mBAAmB,CAAC,EAAE,CAAC,CAAC;SACzB;KACF;IAED,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;IAEhC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IAClC,MAAM,OAAO,GAAG,MAAM,IAAI,IAAI,KAAK,MAAM,CAAC;IAC1C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,IAAI,IAAI,KAAK,MAAM,CAAC,CAAC;IACtD,IAAI,MAAM,EAAE;QACV,IAAI,CAAC,GAAG,EAAE,CAAC;KACZ;IACD,IAAI,IAAI,KAAK,MAAM,EAAE;QACnB,IAAI,CAAC,OAAO,EAAE,CAAC;KAChB;IAED,MAAM,cAAc,GAAG,CAAC,IAAqB,EAAE,IAAS,EAAE,EAAE;QAC1D,MAAM,YAAY,GAAG,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QACvE,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;YACvB,MAAM,KAAK,GAAG,0BAA0B,CACtC,YAAY,EACZ,GAAG,EACH,eAAe,CAChB,CAAC;YACF,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACtB,CAAC,CAAC,CACH,CAAC;QACF,OAAO,eAAe,CAAC,mBAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAC;IAEF,OAAO;QACL,IAAI;QACJ,eAAe,EAAE;YACf,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC9D,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;SACnE;KACF,CAAC;AACJ,CAAC;AAjGD,gDAiGC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nicot",
   "description": "Nest.js interacting with class-validator + OpenAPI + TypeORM for Nest.js Restful API development.",
-  "version": "1.1.9",
+  "version": "1.1.11",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -12,15 +12,15 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://code.mycard.moe/3rdeye/nicot.git"
+    "url": "https://github.com/purerosefallen/nicot.git"
   },
   "author": "Nanahira <nanahira@momobako.com>",
   "license": "MIT",
   "keywords": [],
   "bugs": {
-    "url": "https://code.mycard.moe/3rdeye/nicot/issues"
+    "url": "https://github.com/purerosefallen/nicot/issues"
   },
-  "homepage": "https://code.mycard.moe/3rdeye/nicot",
+  "homepage": "https://github.com/purerosefallen/nicot",
   "jest": {
     "moduleFileExtensions": [
       "js",
@@ -61,15 +61,17 @@
     "typescript": "^4.7.4"
   },
   "peerDependencies": {
-    "@nestjs/common": "^9.4.0 || ^10.0.0 || ^11.0.14",
-    "@nestjs/swagger": "^7.1.8 || ^6.3.0 || ^11.1.1",
+    "@nestjs/common": "^11.0.0 || ^9.4.0 || ^10.0.0",
+    "@nestjs/config": "^4.0.0 || ^3.0.0",
+    "@nestjs/swagger": "^11.0.0 || ^7.1.8 || ^6.3.0",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
     "typeorm": "^0.3.16"
   },
   "dependencies": {
     "lodash": "^4.17.21",
-    "nesties": "^1.1.1",
+    "nesties": "^1.1.2",
+    "superjson": "1.13.3",
     "typed-reflector": "^1.0.11"
   }
 }