nestjs-paginate 8.1.7 → 8.2.0

package/README.md

@@ -458,6 +458,43 @@ is resolved to:
 
 `WHERE ... AND (id = 5 OR id = 7) AND name = 'Milo' AND ...`
 
+## Swagger
+
+You can use two default decorators @ApiOkResponsePaginated and @ApiPagination to generate swagger documentation for your endpoints
+
+`@ApiOkPaginatedResponse` is for response body, return http[](https://) status is 200
+
+`@ApiPaginationQuery` is for query params
+
+
+```typescript
+  @Get()
+  @ApiOkPaginatedResponse(
+    UserDto,
+    USER_PAGINATION_CONFIG,
+  )
+  @ApiPaginationQuery(USER_PAGINATION_CONFIG)
+  async findAll(
+    @Paginate()
+    query: PaginateQuery,
+  ): Promise<Paginated<UserEntity>> {
+
+  }
+```
+
+There is also some syntax sugar for this, and you can use only one decorator `@PaginatedSwaggerDocs` for both response body and query params
+
+```typescript
+  @Get()
+  @PaginatedSwaggerDocs(UserDto, USER_PAGINATION_CONFIG)
+  async findAll(
+    @Paginate()
+    query: PaginateQuery,
+  ): Promise<Paginated<UserEntity>> {
+
+  }
+```
+
 ## Troubleshooting
 
 The package does not report error reasons in the response bodies. They are instead

package/lib/index.d.ts

@@ -1,2 +1,3 @@
 export * from './decorator';
 export * from './paginate';
+export * from './swagger';

package/lib/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./decorator"), exports);
 __exportStar(require("./paginate"), exports);
+__exportStar(require("./swagger"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,6CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,6CAA0B;AAC1B,4CAAyB"}

package/lib/swagger/api-ok-paginated-response.decorator.d.ts

@@ -0,0 +1,3 @@
+import { Type } from '@nestjs/common';
+import { PaginateConfig } from '../paginate';
+export declare const ApiOkPaginatedResponse: <DTO extends Type<unknown>>(dataDto: DTO, paginatedConfig: PaginateConfig<any>) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/lib/swagger/api-ok-paginated-response.decorator.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiOkPaginatedResponse = void 0;
+const common_1 = require("@nestjs/common");
+const swagger_1 = require("@nestjs/swagger");
+const paginated_swagger_type_1 = require("./paginated-swagger.type");
+const ApiOkPaginatedResponse = (dataDto, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+paginatedConfig) => {
+    const cols = (paginatedConfig === null || paginatedConfig === void 0 ? void 0 : paginatedConfig.filterableColumns) || {};
+    return (0, common_1.applyDecorators)((0, swagger_1.ApiExtraModels)(paginated_swagger_type_1.PaginatedDocumented, dataDto), (0, swagger_1.ApiOkResponse)({
+        schema: {
+            allOf: [
+                { $ref: (0, swagger_1.getSchemaPath)(paginated_swagger_type_1.PaginatedDocumented) },
+                {
+                    properties: {
+                        data: {
+                            type: 'array',
+                            items: { $ref: (0, swagger_1.getSchemaPath)(dataDto) },
+                        },
+                        meta: {
+                            properties: {
+                                select: {
+                                    type: 'array',
+                                    items: {
+                                        type: 'string',
+                                        enum: paginatedConfig === null || paginatedConfig === void 0 ? void 0 : paginatedConfig.select,
+                                    },
+                                },
+                                filter: {
+                                    type: 'object',
+                                    properties: Object.keys(cols).reduce((acc, key) => {
+                                        acc[key] = {
+                                            oneOf: [
+                                                {
+                                                    type: 'string',
+                                                },
+                                                {
+                                                    type: 'array',
+                                                    items: {
+                                                        type: 'string',
+                                                    },
+                                                },
+                                            ],
+                                        };
+                                        return acc;
+                                    }, {}),
+                                },
+                            },
+                        },
+                    },
+                },
+            ],
+        },
+    }));
+};
+exports.ApiOkPaginatedResponse = ApiOkPaginatedResponse;
+//# sourceMappingURL=api-ok-paginated-response.decorator.js.map

package/lib/swagger/api-ok-paginated-response.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-ok-paginated-response.decorator.js","sourceRoot":"","sources":["../../src/swagger/api-ok-paginated-response.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AACtD,6CAA8E;AAG9E,qEAA8D;AAEvD,MAAM,sBAAsB,GAAG,CAClC,OAAY;AACZ,8DAA8D;AAC9D,eAAoC,EACtC,EAAE;IACA,MAAM,IAAI,GAAG,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,iBAAiB,KAAI,EAAE,CAAA;IAErD,OAAO,IAAA,wBAAe,EAClB,IAAA,wBAAc,EAAC,4CAAmB,EAAE,OAAO,CAAC,EAC5C,IAAA,uBAAa,EAAC;QACV,MAAM,EAAE;YACJ,KAAK,EAAE;gBACH,EAAE,IAAI,EAAE,IAAA,uBAAa,EAAC,4CAAmB,CAAC,EAAE;gBAC5C;oBACI,UAAU,EAAE;wBACR,IAAI,EAAE;4BACF,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,EAAE,IAAI,EAAE,IAAA,uBAAa,EAAC,OAAO,CAAC,EAAE;yBAC1C;wBACD,IAAI,EAAE;4BACF,UAAU,EAAE;gCACR,MAAM,EAAE;oCACJ,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE;wCACH,IAAI,EAAE,QAAQ;wCACd,IAAI,EAAE,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,MAAM;qCAChC;iCACJ;gCACD,MAAM,EAAE;oCACJ,IAAI,EAAE,QAAQ;oCACd,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;wCACT,GAAG,CAAC,GAAG,CAAC,GAAG;4CACP,KAAK,EAAE;gDACH;oDACI,IAAI,EAAE,QAAQ;iDACjB;gDACD;oDACI,IAAI,EAAE,OAAO;oDACb,KAAK,EAAE;wDACH,IAAI,EAAE,QAAQ;qDACjB;iDACJ;6CACJ;yCACJ,CAAA;wCACD,OAAO,GAAG,CAAA;oCACd,CAAC,EACD,EAAoD,CACvD;iCACJ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ,CAAC,CACL,CAAA;AACL,CAAC,CAAA;AA1DY,QAAA,sBAAsB,0BA0DlC"}

package/lib/swagger/api-paginated-query.decorator.d.ts

@@ -0,0 +1,3 @@
+import { PaginateConfig } from '../paginate';
+export declare function SortBy(paginationConfig: PaginateConfig<any>): MethodDecorator;
+export declare const ApiPaginationQuery: (paginationConfig: PaginateConfig<any>) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/lib/swagger/api-paginated-query.decorator.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiPaginationQuery = exports.SortBy = void 0;
+const paginate_1 = require("../paginate");
+const swagger_1 = require("@nestjs/swagger");
+const filter_1 = require("../filter");
+const common_1 = require("@nestjs/common");
+const DEFAULT_VALUE_KEY = 'Default Value';
+function p(key, value) {
+    return `<p>
+             <b>${key}: </b> ${value}
+          </p>`;
+}
+function li(key, values) {
+    return `<h4>${key}</h4><ul>${values.map((v) => `<li>${v}</li>`).join('\n')}</ul>`;
+}
+function SortBy(paginationConfig) {
+    const defaultSortMessage = paginationConfig.defaultSortBy
+        ? paginationConfig.defaultSortBy.map(([col, order]) => `${col}:${order}`).join(',')
+        : 'No default sorting specified, the result order is not guaranteed';
+    return (0, swagger_1.ApiQuery)({
+        name: 'sortBy',
+        isArray: true,
+        description: `Parameter to sort by.
+      <p>To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting</p>
+      ${p('Format', 'fieldName:DIRECTION')}
+      ${p('Example', 'sortBy=id:DESC&sortBy=createdAt:ASC')}
+      ${p('Default Value', defaultSortMessage)}
+      ${li('Available Fields', paginationConfig.sortableColumns)}
+      `,
+        required: false,
+        type: 'string',
+    });
+}
+exports.SortBy = SortBy;
+function Limit(paginationConfig) {
+    var _a, _b;
+    return (0, swagger_1.ApiQuery)({
+        name: 'limit',
+        description: `Number of records per page.
+      ${p('Example', '20')}
+      ${p(DEFAULT_VALUE_KEY, ((_a = paginationConfig === null || paginationConfig === void 0 ? void 0 : paginationConfig.defaultLimit) === null || _a === void 0 ? void 0 : _a.toString()) || paginate_1.DEFAULT_LIMIT.toString())}
+      ${p('Max Value', ((_b = paginationConfig.maxLimit) === null || _b === void 0 ? void 0 : _b.toString()) || paginate_1.DEFAULT_MAX_LIMIT.toString())}
+
+      If provided value is greater than max value, max value will be applied.
+      `,
+        required: false,
+        type: 'number',
+    });
+}
+function Select(paginationConfig) {
+    if (!paginationConfig.select) {
+        return;
+    }
+    return (0, swagger_1.ApiQuery)({
+        name: 'select',
+        description: `List of fields to select.
+      ${p('Example', paginationConfig.select.slice(0, Math.min(5, paginationConfig.select.length)).join(','))}
+      ${p(DEFAULT_VALUE_KEY, 'By default all fields returns. If you want to select only some fields, provide them in query param')}
+      `,
+        required: false,
+        type: 'string',
+    });
+}
+function Where(paginationConfig) {
+    if (!paginationConfig.filterableColumns)
+        return;
+    const allColumnsDecorators = Object.entries(paginationConfig.filterableColumns)
+        .map(([fieldName, filterOperations]) => {
+        const operations = filterOperations === true || filterOperations === undefined
+            ? [
+                ...Object.values(filter_1.FilterComparator),
+                ...Object.values(paginate_1.FilterSuffix),
+                ...Object.values(paginate_1.FilterOperator),
+            ]
+            : filterOperations.map((fo) => fo.toString());
+        return (0, swagger_1.ApiQuery)({
+            name: `filter.${fieldName}`,
+            description: `Filter by ${fieldName} query param.
+          ${p('Format', `filter.${fieldName}={$not}:OPERATION:VALUE`)}
+          ${p('Example', `filter.${fieldName}=$not:$like:John Doe&filter.${fieldName}=like:John`)}
+          ${li('Available Operations', operations)}`,
+            required: false,
+            type: 'string',
+            isArray: true,
+        });
+    })
+        .filter((v) => v !== undefined);
+    return (0, common_1.applyDecorators)(...allColumnsDecorators);
+}
+function Page() {
+    return (0, swagger_1.ApiQuery)({
+        name: 'page',
+        description: `Page number to retrieve.If you provide invalid value the default page number will applied
+        ${p('Example', '1')}
+        ${p(DEFAULT_VALUE_KEY, '1')}
+        `,
+        required: false,
+        type: 'number',
+    });
+}
+function Search(paginateConfig) {
+    if (!paginateConfig.searchableColumns)
+        return;
+    return (0, swagger_1.ApiQuery)({
+        name: 'search',
+        description: `Search term to filter result values
+        ${p('Example', 'John')}
+        ${p(DEFAULT_VALUE_KEY, 'No default value')}
+        `,
+        required: false,
+        type: 'string',
+    });
+}
+function SearchBy(paginateConfig) {
+    if (!paginateConfig.searchableColumns)
+        return;
+    return (0, swagger_1.ApiQuery)({
+        name: 'searchBy',
+        description: `List of fields to search by term to filter result values
+        ${p('Example', paginateConfig.searchableColumns.slice(0, Math.min(5, paginateConfig.searchableColumns.length)).join(','))}
+        ${p(DEFAULT_VALUE_KEY, 'By default all fields mentioned below will be used to search by term')}
+        ${li('Available Fields', paginateConfig.searchableColumns)}
+        `,
+        required: false,
+        type: 'string',
+    });
+}
+const ApiPaginationQuery = (paginationConfig) => {
+    return (0, common_1.applyDecorators)(...[
+        Page(),
+        Limit(paginationConfig),
+        Where(paginationConfig),
+        SortBy(paginationConfig),
+        Search(paginationConfig),
+        SearchBy(paginationConfig),
+        Select(paginationConfig),
+    ].filter((v) => v !== undefined));
+};
+exports.ApiPaginationQuery = ApiPaginationQuery;
+//# sourceMappingURL=api-paginated-query.decorator.js.map

package/lib/swagger/api-paginated-query.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-paginated-query.decorator.js","sourceRoot":"","sources":["../../src/swagger/api-paginated-query.decorator.ts"],"names":[],"mappings":";;;AAAA,0CAA4G;AAC5G,6CAA0C;AAC1C,sCAA4C;AAC5C,2CAAgD;AAEhD,MAAM,iBAAiB,GAAG,eAAe,CAAA;AAEzC,SAAS,CAAC,CAAC,GAAkE,EAAE,KAAa;IACxF,OAAO;kBACO,GAAG,UAAU,KAAK;eACrB,CAAA;AACf,CAAC;AAED,SAAS,EAAE,CAAC,GAAgC,EAAE,MAAgB;IAC1D,OAAO,OAAO,GAAG,YAAY,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;AACrF,CAAC;AAED,SAAgB,MAAM,CAAC,gBAAqC;IACxD,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,aAAa;QACrD,CAAC,CAAC,gBAAgB,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;QACnF,CAAC,CAAC,kEAAkE,CAAA;IAExE,OAAO,IAAA,kBAAQ,EAAC;QACZ,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,IAAI;QACb,WAAW,EAAE;;QAEb,CAAC,CAAC,QAAQ,EAAE,qBAAqB,CAAC;QAClC,CAAC,CAAC,SAAS,EAAE,qCAAqC,CAAC;QACnD,CAAC,CAAC,eAAe,EAAE,kBAAkB,CAAC;QACtC,EAAE,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,eAAe,CAAC;OACzD;QACC,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC,CAAA;AACN,CAAC;AAlBD,wBAkBC;AAED,SAAS,KAAK,CAAC,gBAAqC;;IAChD,OAAO,IAAA,kBAAQ,EAAC;QACZ,IAAI,EAAE,OAAO;QACb,WAAW,EAAE;QACb,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC;QAClB,CAAC,CAAC,iBAAiB,EAAE,CAAA,MAAA,gBAAgB,aAAhB,gBAAgB,uBAAhB,gBAAgB,CAAE,YAAY,0CAAE,QAAQ,EAAE,KAAI,wBAAa,CAAC,QAAQ,EAAE,CAAC;QAC5F,CAAC,CAAC,WAAW,EAAE,CAAA,MAAA,gBAAgB,CAAC,QAAQ,0CAAE,QAAQ,EAAE,KAAI,4BAAiB,CAAC,QAAQ,EAAE,CAAC;;;OAGtF;QACC,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC,CAAA;AACN,CAAC;AAED,SAAS,MAAM,CAAC,gBAAqC;IACjD,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE;QAC1B,OAAM;KACT;IAED,OAAO,IAAA,kBAAQ,EAAC;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE;QACb,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrG,CAAC,CACC,iBAAiB,EACjB,oGAAoG,CACvG;OACA;QACC,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC,CAAA;AACN,CAAC;AAED,SAAS,KAAK,CAAC,gBAAqC;IAChD,IAAI,CAAC,gBAAgB,CAAC,iBAAiB;QAAE,OAAM;IAE/C,MAAM,oBAAoB,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,iBAAiB,CAAC;SAC1E,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,gBAAgB,CAAC,EAAE,EAAE;QACnC,MAAM,UAAU,GACZ,gBAAgB,KAAK,IAAI,IAAI,gBAAgB,KAAK,SAAS;YACvD,CAAC,CAAC;gBACI,GAAG,MAAM,CAAC,MAAM,CAAC,yBAAgB,CAAC;gBAClC,GAAG,MAAM,CAAC,MAAM,CAAC,uBAAY,CAAC;gBAC9B,GAAG,MAAM,CAAC,MAAM,CAAC,yBAAc,CAAC;aACnC;YACH,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;QAErD,OAAO,IAAA,kBAAQ,EAAC;YACZ,IAAI,EAAE,UAAU,SAAS,EAAE;YAC3B,WAAW,EAAE,aAAa,SAAS;YACvC,CAAC,CAAC,QAAQ,EAAE,UAAU,SAAS,yBAAyB,CAAC;YACzD,CAAC,CAAC,SAAS,EAAE,UAAU,SAAS,+BAA+B,SAAS,YAAY,CAAC;YACrF,EAAE,CAAC,sBAAsB,EAAE,UAAU,CAAC,EAAE;YACpC,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,IAAI;SAChB,CAAC,CAAA;IACN,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAA;IAEnC,OAAO,IAAA,wBAAe,EAAC,GAAG,oBAAoB,CAAC,CAAA;AACnD,CAAC;AAED,SAAS,IAAI;IACT,OAAO,IAAA,kBAAQ,EAAC;QACZ,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE;UACX,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC;UACjB,CAAC,CAAC,iBAAiB,EAAE,GAAG,CAAC;SAC1B;QACD,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC,CAAA;AACN,CAAC;AAED,SAAS,MAAM,CAAC,cAAmC;IAC/C,IAAI,CAAC,cAAc,CAAC,iBAAiB;QAAE,OAAM;IAE7C,OAAO,IAAA,kBAAQ,EAAC;QACZ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE;UACX,CAAC,CAAC,SAAS,EAAE,MAAM,CAAC;UACpB,CAAC,CAAC,iBAAiB,EAAE,kBAAkB,CAAC;SACzC;QACD,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC,CAAA;AACN,CAAC;AAED,SAAS,QAAQ,CAAC,cAAmC;IACjD,IAAI,CAAC,cAAc,CAAC,iBAAiB;QAAE,OAAM;IAE7C,OAAO,IAAA,kBAAQ,EAAC;QACZ,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE;UACX,CAAC,CACC,SAAS,EACT,cAAc,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAC5G;UACC,CAAC,CAAC,iBAAiB,EAAE,sEAAsE,CAAC;UAC5F,EAAE,CAAC,kBAAkB,EAAE,cAAc,CAAC,iBAAiB,CAAC;SACzD;QACD,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC,CAAA;AACN,CAAC;AAEM,MAAM,kBAAkB,GAAG,CAAC,gBAAqC,EAAE,EAAE;IACxE,OAAO,IAAA,wBAAe,EAClB,GAAG;QACC,IAAI,EAAE;QACN,KAAK,CAAC,gBAAgB,CAAC;QACvB,KAAK,CAAC,gBAAgB,CAAC;QACvB,MAAM,CAAC,gBAAgB,CAAC;QACxB,MAAM,CAAC,gBAAgB,CAAC;QACxB,QAAQ,CAAC,gBAAgB,CAAC;QAC1B,MAAM,CAAC,gBAAgB,CAAC;KAC3B,CAAC,MAAM,CAAC,CAAC,CAAC,EAAwB,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CACzD,CAAA;AACL,CAAC,CAAA;AAZY,QAAA,kBAAkB,sBAY9B"}

package/lib/swagger/api-paginated-swagger-docs.decorator.d.ts

@@ -0,0 +1,3 @@
+import { Type } from '@nestjs/common';
+import { PaginateConfig } from '../paginate';
+export declare function PaginatedSwaggerDocs<DTO extends Type<unknown>>(dto: DTO, paginatedConfig: PaginateConfig<any>): <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/lib/swagger/api-paginated-swagger-docs.decorator.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginatedSwaggerDocs = void 0;
+const common_1 = require("@nestjs/common");
+const api_paginated_query_decorator_1 = require("./api-paginated-query.decorator");
+const api_ok_paginated_response_decorator_1 = require("./api-ok-paginated-response.decorator");
+function PaginatedSwaggerDocs(dto, paginatedConfig) {
+    return (0, common_1.applyDecorators)((0, api_ok_paginated_response_decorator_1.ApiOkPaginatedResponse)(dto, paginatedConfig), (0, api_paginated_query_decorator_1.ApiPaginationQuery)(paginatedConfig));
+}
+exports.PaginatedSwaggerDocs = PaginatedSwaggerDocs;
+//# sourceMappingURL=api-paginated-swagger-docs.decorator.js.map

package/lib/swagger/api-paginated-swagger-docs.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-paginated-swagger-docs.decorator.js","sourceRoot":"","sources":["../../src/swagger/api-paginated-swagger-docs.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAsD;AAEtD,mFAAoE;AACpE,+FAA8E;AAE9E,SAAgB,oBAAoB,CAA4B,GAAQ,EAAE,eAAoC;IAC1G,OAAO,IAAA,wBAAe,EAAC,IAAA,4DAAsB,EAAC,GAAG,EAAE,eAAe,CAAC,EAAE,IAAA,kDAAkB,EAAC,eAAe,CAAC,CAAC,CAAA;AAC7G,CAAC;AAFD,oDAEC"}

package/lib/swagger/index.d.ts

@@ -0,0 +1,4 @@
+export * from './api-paginated-query.decorator';
+export * from './api-ok-paginated-response.decorator';
+export * from './paginated-swagger.type';
+export * from './api-paginated-swagger-docs.decorator';

package/lib/swagger/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-paginated-query.decorator"), exports);
+__exportStar(require("./api-ok-paginated-response.decorator"), exports);
+__exportStar(require("./paginated-swagger.type"), exports);
+__exportStar(require("./api-paginated-swagger-docs.decorator"), exports);
+//# sourceMappingURL=index.js.map

package/lib/swagger/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/swagger/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kEAA+C;AAC/C,wEAAqD;AACrD,2DAAwC;AACxC,yEAAsD"}

package/lib/swagger/paginated-swagger.type.d.ts

@@ -0,0 +1,28 @@
+import { Column, SortBy } from '../helper';
+import { Paginated } from '../paginate';
+declare class PaginatedLinksDocumented {
+    first?: string;
+    previous?: string;
+    current: string;
+    next?: string;
+    last?: string;
+}
+export declare class PaginatedMetaDocumented<T> {
+    itemsPerPage: number;
+    totalItems: number;
+    currentPage: number;
+    totalPages: number;
+    sortBy: SortBy<T>;
+    searchBy: Column<T>[];
+    search: string;
+    select: string[];
+    filter?: {
+        [p: string]: string | string[];
+    };
+}
+export declare class PaginatedDocumented<T> extends Paginated<T> {
+    data: T[];
+    meta: PaginatedMetaDocumented<T>;
+    links: PaginatedLinksDocumented;
+}
+export {};

package/lib/swagger/paginated-swagger.type.js

@@ -0,0 +1,174 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaginatedDocumented = exports.PaginatedMetaDocumented = void 0;
+const swagger_1 = require("@nestjs/swagger");
+const paginate_1 = require("../paginate");
+class PaginatedLinksDocumented {
+}
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Link to first page',
+        required: false,
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], PaginatedLinksDocumented.prototype, "first", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Link to previous page',
+        required: false,
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], PaginatedLinksDocumented.prototype, "previous", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Link to current page',
+        required: false,
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], PaginatedLinksDocumented.prototype, "current", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Link to next page',
+        required: false,
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], PaginatedLinksDocumented.prototype, "next", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Link to last page',
+        required: false,
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], PaginatedLinksDocumented.prototype, "last", void 0);
+class PaginatedMetaDocumented {
+}
+exports.PaginatedMetaDocumented = PaginatedMetaDocumented;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Number of items per page',
+        required: true,
+        type: 'number',
+    }),
+    __metadata("design:type", Number)
+], PaginatedMetaDocumented.prototype, "itemsPerPage", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Total number of items',
+        required: true,
+        type: 'number',
+    }),
+    __metadata("design:type", Number)
+], PaginatedMetaDocumented.prototype, "totalItems", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Current requested page',
+        required: true,
+        type: 'number',
+    }),
+    __metadata("design:type", Number)
+], PaginatedMetaDocumented.prototype, "currentPage", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Total number of pages',
+        required: true,
+        type: 'number',
+    }),
+    __metadata("design:type", Number)
+], PaginatedMetaDocumented.prototype, "totalPages", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Sorting by columns',
+        required: false,
+        type: 'array',
+        items: {
+            type: 'array',
+            items: {
+                oneOf: [
+                    {
+                        type: 'string',
+                    },
+                    {
+                        type: 'string',
+                        enum: ['ASC', 'DESC'],
+                    },
+                ],
+            },
+        },
+    }),
+    __metadata("design:type", Array)
+], PaginatedMetaDocumented.prototype, "sortBy", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Search by fields',
+        required: false,
+        isArray: true,
+        type: 'string',
+    }),
+    __metadata("design:type", Array)
+], PaginatedMetaDocumented.prototype, "searchBy", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Search term',
+        required: false,
+        type: 'string',
+    }),
+    __metadata("design:type", String)
+], PaginatedMetaDocumented.prototype, "search", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'List of selected fields',
+        required: false,
+        isArray: true,
+        type: 'string',
+    }),
+    __metadata("design:type", Array)
+], PaginatedMetaDocumented.prototype, "select", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Filters that applied to the query',
+        required: false,
+        isArray: false,
+        type: 'object',
+    }),
+    __metadata("design:type", Object)
+], PaginatedMetaDocumented.prototype, "filter", void 0);
+class PaginatedDocumented extends paginate_1.Paginated {
+}
+exports.PaginatedDocumented = PaginatedDocumented;
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        isArray: true,
+        required: true,
+        title: 'Array of entities',
+    }),
+    __metadata("design:type", Array)
+], PaginatedDocumented.prototype, "data", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Pagination Metadata',
+        required: true,
+    }),
+    __metadata("design:type", PaginatedMetaDocumented)
+], PaginatedDocumented.prototype, "meta", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({
+        title: 'Links to pages',
+        required: true,
+    }),
+    __metadata("design:type", PaginatedLinksDocumented)
+], PaginatedDocumented.prototype, "links", void 0);
+//# sourceMappingURL=paginated-swagger.type.js.map

package/lib/swagger/paginated-swagger.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paginated-swagger.type.js","sourceRoot":"","sources":["../../src/swagger/paginated-swagger.type.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6CAA6C;AAE7C,0CAAuC;AAEvC,MAAM,wBAAwB;CAmC7B;AA7BG;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,oBAAoB;QAC3B,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC;;uDACY;AAOd;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,uBAAuB;QAC9B,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC;;0DACe;AAOjB;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,sBAAsB;QAC7B,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC;;yDACc;AAOhB;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,mBAAmB;QAC1B,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC;;sDACW;AAOb;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,mBAAmB;QAC1B,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC;;sDACW;AAGjB,MAAa,uBAAuB;CAkFnC;AAlFD,0DAkFC;AA5EG;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,0BAA0B;QACjC,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,QAAQ;KACjB,CAAC;;6DACmB;AAOrB;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,uBAAuB;QAC9B,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,QAAQ;KACjB,CAAC;;2DACiB;AAOnB;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,wBAAwB;QAC/B,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,QAAQ;KACjB,CAAC;;4DACkB;AAOpB;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,uBAAuB;QAC9B,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,QAAQ;KACjB,CAAC;;2DACiB;AAqBnB;IAnBC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,oBAAoB;QAC3B,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,OAAO;QACb,KAAK,EAAE;YACH,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,KAAK,EAAE;oBACH;wBACI,IAAI,EAAE,QAAQ;qBACjB;oBACD;wBACI,IAAI,EAAE,QAAQ;wBACd,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;qBACxB;iBACJ;aACJ;SACJ;KACJ,CAAC;;uDACgB;AAQlB;IANC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,kBAAkB;QACzB,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,QAAQ;KACjB,CAAC;;yDACoB;AAOtB;IALC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,aAAa;QACpB,QAAQ,EAAE,KAAK;QACf,IAAI,EAAE,QAAQ;KACjB,CAAC;;uDACa;AAQf;IANC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,yBAAyB;QAChC,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,QAAQ;KACjB,CAAC;;uDACe;AAQjB;IANC,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,mCAAmC;QAC1C,QAAQ,EAAE,KAAK;QACf,OAAO,EAAE,KAAK;QACd,IAAI,EAAE,QAAQ;KACjB,CAAC;;uDAGD;AAGL,MAAa,mBAAuB,SAAQ,oBAAY;CAmBvD;AAnBD,kDAmBC;AAbY;IALR,IAAA,qBAAW,EAAC;QACT,OAAO,EAAE,IAAI;QACb,QAAQ,EAAE,IAAI;QACd,KAAK,EAAE,mBAAmB;KAC7B,CAAC;;iDACiB;AAMV;IAJR,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,qBAAqB;QAC5B,QAAQ,EAAE,IAAI;KACjB,CAAC;8BACc,uBAAuB;iDAAG;AAMjC;IAJR,IAAA,qBAAW,EAAC;QACT,KAAK,EAAE,gBAAgB;QACvB,QAAQ,EAAE,IAAI;KACjB,CAAC;8BACe,wBAAwB;kDAAA"}

package/lib/swagger/pagination-docs.spec.d.ts

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