@emilgroup/api-documentation - npm Package Compare versions

Comparing version 1.18.0 to 1.19.0

dist/decorators/api-get.decorator.d.ts

@@ -21,1 +21,2 @@ import { ApiOperationOptions } from '@nestjs/swagger';
 export declare function ApiListOperation(options: ListParameters & ApiOperationOptions, paginateConfig?: PaginateFieldsConfig): MethodDecorator;
+export declare function ApiListOperationV2(options: ListParameters & ApiOperationOptions, paginateConfig?: PaginateFieldsConfig): MethodDecorator;

dist/decorators/api-get.decorator.js

@@ -10,2 +10,3 @@ "use strict";
 exports.ApiListOperation = ApiListOperation;
+exports.ApiListOperationV2 = ApiListOperationV2;
 const common_1 = require("@nestjs/common");
@@ -60,8 +61,22 @@ const swagger_1 = require("@nestjs/swagger");
 }
-function generateApiListOperationWithApiQueries(paginateConfig, options, namePlural) {
+function ApiListOperationV2(options, paginateConfig) {
+    const { namePlural } = options;
+    const opts = lodash_1.default.omit(options, ['namePlural']);
+    if (paginateConfig) {
+        return generateApiListOperationWithApiQueries(paginateConfig, opts, namePlural, { excludeLegacyFilter: true });
+    }
+    return (0, swagger_1.ApiOperation)({
+        summary: `List ${namePlural}`,
+        description: `Returns a list of ${namePlural} you have previously created.
+      The ${namePlural} are returned in sorted order, with the oldest one appearing first.
+      For more information about pagination, read the Pagination documentation.`,
+        ...opts,
+    });
+}
+function generateApiListOperationWithApiQueries(paginateConfig, options, namePlural, { excludeLegacyFilter = false } = {}) {
     const decorators = [];
     decorators.push((0, swagger_1.ApiOperation)({
         summary: `List ${namePlural}`,
-        description: `Returns a list of ${namePlural} you have previously created. 
-        The ${namePlural} are returned in sorted order, with the oldest one appearing first. 
+        description: `Returns a list of ${namePlural} you have previously created.
+        The ${namePlural} are returned in sorted order, with the oldest one appearing first.
         For more information about pagination, read the Pagination documentation.`,
@@ -72,16 +87,18 @@ ...options,
         paginateConfig.allowedFilters.length > 0) {
+        if (!excludeLegacyFilter) {
+            decorators.push((0, swagger_1.ApiQuery)({
+                name: 'filter',
+                type: 'string',
+                description: `Filter the response by one or multiple fields.
+            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>
+            <br/>
+            <i>Allowed values: ${paginateConfig.allowedFilters.join(', ')}</i>`,
+                example: `filter=${paginateConfig.allowedFilters[0]}=valueToFilter`,
+                required: false,
+            }));
+        }
         decorators.push((0, swagger_1.ApiQuery)({
-            name: 'filter',
-            type: 'string',
-            description: `Filter the response by one or multiple fields. 
-          In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>
-          <br/>
-          <i>Allowed values: ${paginateConfig.allowedFilters.join(', ')}</i>`,
-            example: `filter=${paginateConfig.allowedFilters[0]}=valueToFilter`,
-            required: false,
-        }));
-        decorators.push((0, swagger_1.ApiQuery)({
             name: 'filters',
             type: 'string',
-            description: `Filters the response by one or multiple fields. 
+            description: `Filters the response by one or multiple fields.
           Advanced filter functionality allows you to perform more complex filtering operations.<br/>
@@ -88,0 +105,0 @@ <br/>

dist/decorators/api-get.decorator.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"api-get.decorator.js","sourceRoot":"","sources":["../../lib/decorators/api-get.decorator.ts"],"names":[],"mappings":";;;;;AAwBA,0CAiBC;AAED,gEAcC;AAED,kDAiBC;AAED,4CAwBC;AAtGD,2CAAiD;AACjD,6CAA8E;AAC9E,oDAAuB;AAEvB,MAAM,wBAAwB,GAAG,gCAAgC,CAAC;AAoBlE,SAAgB,eAAe,CAC7B,OAA4C,EAC5C,cAAyB;IAEzB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvC,OAAO,IAAA,wBAAe,EACpB,IAAA,sBAAY,EAAC;QACX,OAAO,EAAE,gBAAgB,IAAI,EAAE;QAC/B,WAAW,EAAE,gCAAgC,IAAI,mDAAmD,IAAI;uFACvB,IAAI,eAAe;QACpG,GAAG,IAAI;KACR,CAAC,EACF,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED,SAAgB,0BAA0B,CACxC,OAAuD;IAEvD,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEhC,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAE9C,OAAO,IAAA,sBAAY,EAAC;QAClB,OAAO,EAAE,cAAc;QACvB,WAAW,EAAE,oCAAoC,WAAW;uEACO,WAAW;sIACoD;QAClI,GAAG,IAAI;KACR,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,mBAAmB,CACjC,OAA4C,EAC5C,cAAyB;IAEzB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvC,OAAO,IAAA,wBAAe,EACpB,IAAA,sBAAY,EAAC;QACX,OAAO,EAAE,gBAAgB,IAAI,EAAE;QAC/B,WAAW,EAAE,gCAAgC,IAAI;0BAC7B,IAAI,wFAAwF,IAAI,eAAe;QACnI,GAAG,IAAI;KACR,CAAC,EACF,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED,SAAgB,gBAAgB,CAC9B,OAA6C,EAC7C,cAAqC;IAErC,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAE/B,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAG7C,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,sCAAsC,CAC3C,cAAc,EACd,IAAI,EACJ,UAAU,CACX,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,sBAAY,EAAC;QAClB,OAAO,EAAE,QAAQ,UAAU,EAAE;QAC7B,WAAW,EAAE,qBAAqB,UAAU;YACpC,UAAU;gFAC0D;QAC5E,GAAG,IAAI;KACR,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sCAAsC,CAC7C,cAAoC,EACpC,OAA4B,EAC5B,UAAmB;IAEnB,MAAM,UAAU,GAAG,EAAE,CAAC;IAEtB,UAAU,CAAC,IAAI,CACb,IAAA,sBAAY,EAAC;QACX,OAAO,EAAE,QAAQ,UAAU,EAAE;QAC7B,WAAW,EAAE,qBAAqB,UAAU;cACpC,UAAU;kFAC0D;QAC5E,GAAG,OAAO;KACX,CAAC,CACH,CAAC;IAEF,IACE,cAAc,CAAC,cAAc;QAC7B,cAAc,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EACxC,CAAC;QACD,UAAU,CAAC,IAAI,CACb,IAAA,kBAAQ,EAAC;YACP,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;+BAGU,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YACrE,OAAO,EAAE,UAAU,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB;YACnE,QAAQ,EAAE,KAAK;SAChB,CAAC,CACH,CAAC;QAEF,UAAU,CAAC,IAAI,CACb,IAAA,kBAAQ,EAAC;YACP,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;+BAGU,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YACrE,OAAO,EAAE,WAAW,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,mBAAmB,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,oBAAoB;YAC7I,QAAQ,EAAE,KAAK;SAChB,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IACE,cAAc,CAAC,eAAe;QAC9B,cAAc,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EACzC,CAAC;QACD,UAAU,CAAC,IAAI,CACb,IAAA,kBAAQ,EAAC;YACP,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;kCAGa,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YACzE,OAAO,EAAE,qBAAqB;YAC9B,QAAQ,EAAE,KAAK;SAChB,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,cAAc,CAAC,aAAa,IAAI,cAAc,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5E,UAAU,CAAC,IAAI,CACb,IAAA,kBAAQ,EAAC;YACP,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;+BAGU,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YACpE,OAAO,EAAE,SAAS,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO;YACxD,QAAQ,EAAE,KAAK;SAChB,CAAC,CACH,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,CAAC;IAE7E,OAAO,IAAA,wBAAe,EAAC,GAAG,UAAU,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,sBAAsB,CAAC,cAAwB;IACtD,MAAM,eAAe,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;IAClD,OAAO,IAAA,kBAAQ,EAAC;QACd,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE;;;;QAIT,eAAe,CAAC,CAAC,CAAC,sBAAsB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACjF,OAAO,EAAE,eAAe;YACtB,CAAC,CAAC,UAAU,cAAc,CAAC,CAAC,CAAC,EAAE;YAC/B,CAAC,CAAC,wBAAwB;QAC5B,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"api-get.decorator.js","sourceRoot":"","sources":["../../lib/decorators/api-get.decorator.ts"],"names":[],"mappings":";;;;;AAwBA,0CAiBC;AAED,gEAcC;AAED,kDAiBC;AAED,4CAwBC;AAED,gDAwBC;AAhID,2CAAiD;AACjD,6CAA8E;AAC9E,oDAAuB;AAEvB,MAAM,wBAAwB,GAAG,gCAAgC,CAAC;AAoBlE,SAAgB,eAAe,CAC7B,OAA4C,EAC5C,cAAyB;IAEzB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvC,OAAO,IAAA,wBAAe,EACpB,IAAA,sBAAY,EAAC;QACX,OAAO,EAAE,gBAAgB,IAAI,EAAE;QAC/B,WAAW,EAAE,gCAAgC,IAAI,mDAAmD,IAAI;uFACvB,IAAI,eAAe;QACpG,GAAG,IAAI;KACR,CAAC,EACF,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED,SAAgB,0BAA0B,CACxC,OAAuD;IAEvD,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEhC,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IAE9C,OAAO,IAAA,sBAAY,EAAC;QAClB,OAAO,EAAE,cAAc;QACvB,WAAW,EAAE,oCAAoC,WAAW;uEACO,WAAW;sIACoD;QAClI,GAAG,IAAI;KACR,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,mBAAmB,CACjC,OAA4C,EAC5C,cAAyB;IAEzB,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvC,OAAO,IAAA,wBAAe,EACpB,IAAA,sBAAY,EAAC;QACX,OAAO,EAAE,gBAAgB,IAAI,EAAE;QAC/B,WAAW,EAAE,gCAAgC,IAAI;0BAC7B,IAAI,wFAAwF,IAAI,eAAe;QACnI,GAAG,IAAI;KACR,CAAC,EACF,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED,SAAgB,gBAAgB,CAC9B,OAA6C,EAC7C,cAAqC;IAErC,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAE/B,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAG7C,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,sCAAsC,CAC3C,cAAc,EACd,IAAI,EACJ,UAAU,CACX,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,sBAAY,EAAC;QAClB,OAAO,EAAE,QAAQ,UAAU,EAAE;QAC7B,WAAW,EAAE,qBAAqB,UAAU;YACpC,UAAU;gFAC0D;QAC5E,GAAG,IAAI;KACR,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,kBAAkB,CAChC,OAA6C,EAC7C,cAAqC;IAErC,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IAE/B,MAAM,IAAI,GAAG,gBAAC,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC;IAE7C,IAAI,cAAc,EAAE,CAAC;QACnB,OAAO,sCAAsC,CAC3C,cAAc,EACd,IAAI,EACJ,UAAU,EACV,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAC9B,CAAC;IACJ,CAAC;IAED,OAAO,IAAA,sBAAY,EAAC;QAClB,OAAO,EAAE,QAAQ,UAAU,EAAE;QAC7B,WAAW,EAAE,qBAAqB,UAAU;YACpC,UAAU;gFAC0D;QAC5E,GAAG,IAAI;KACR,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sCAAsC,CAC7C,cAAoC,EACpC,OAA4B,EAC5B,UAAmB,EACnB,EAAE,mBAAmB,GAAG,KAAK,KAAwC,EAAE;IAEvE,MAAM,UAAU,GAAG,EAAE,CAAC;IAEtB,UAAU,CAAC,IAAI,CACb,IAAA,sBAAY,EAAC;QACX,OAAO,EAAE,QAAQ,UAAU,EAAE;QAC7B,WAAW,EAAE,qBAAqB,UAAU;cACpC,UAAU;kFAC0D;QAC5E,GAAG,OAAO;KACX,CAAC,CACH,CAAC;IAEF,IACE,cAAc,CAAC,cAAc;QAC7B,cAAc,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EACxC,CAAC;QACD,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACzB,UAAU,CAAC,IAAI,CACb,IAAA,kBAAQ,EAAC;gBACP,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE;;;iCAGU,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;gBACrE,OAAO,EAAE,UAAU,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,gBAAgB;gBACnE,QAAQ,EAAE,KAAK;aAChB,CAAC,CACH,CAAC;QACJ,CAAC;QAED,UAAU,CAAC,IAAI,CACb,IAAA,kBAAQ,EAAC;YACP,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;+BAGU,cAAc,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YACrE,OAAO,EAAE,WAAW,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,mBAAmB,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,cAAc,oBAAoB;YAC7I,QAAQ,EAAE,KAAK;SAChB,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IACE,cAAc,CAAC,eAAe;QAC9B,cAAc,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EACzC,CAAC;QACD,UAAU,CAAC,IAAI,CACb,IAAA,kBAAQ,EAAC;YACP,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;kCAGa,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YACzE,OAAO,EAAE,qBAAqB;YAC9B,QAAQ,EAAE,KAAK;SAChB,CAAC,CACH,CAAC;IACJ,CAAC;IAED,IAAI,cAAc,CAAC,aAAa,IAAI,cAAc,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5E,UAAU,CAAC,IAAI,CACb,IAAA,kBAAQ,EAAC;YACP,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE;;;+BAGU,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM;YACpE,OAAO,EAAE,SAAS,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,OAAO;YACxD,QAAQ,EAAE,KAAK;SAChB,CAAC,CACH,CAAC;IACJ,CAAC;IAED,UAAU,CAAC,IAAI,CAAC,sBAAsB,CAAC,cAAc,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,CAAC;IAE7E,OAAO,IAAA,wBAAe,EAAC,GAAG,UAAU,CAAC,CAAC;AACxC,CAAC;AAED,SAAS,sBAAsB,CAAC,cAAwB;IACtD,MAAM,eAAe,GAAG,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC;IAClD,OAAO,IAAA,kBAAQ,EAAC;QACd,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE;;;;QAIT,eAAe,CAAC,CAAC,CAAC,sBAAsB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACjF,OAAO,EAAE,eAAe;YACtB,CAAC,CAAC,UAAU,cAAc,CAAC,CAAC,CAAC,EAAE;YAC/B,CAAC,CAAC,wBAAwB;QAC5B,QAAQ,EAAE,KAAK;KAChB,CAAC,CAAC;AACL,CAAC"}

package.json

 {
   "name": "@emilgroup/api-documentation",
-  "version": "1.18.0",
+  "version": "1.19.0",
   "description": "Helper library to simplify usage of Typescript contracts",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

New alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Fixed alerts

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

744584

0.2%

Lines of code

2101

0.86%

No dependency changes