@elsikora/nestjs-crud-automator 2.1.0 → 2.1.1-dev.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/cjs/utility/api/controller/build-route-documentation.utility.js +14 -13
  2. package/dist/cjs/utility/api/controller/build-route-documentation.utility.js.map +1 -1
  3. package/dist/esm/utility/api/controller/build-route-documentation.utility.js +14 -13
  4. package/dist/esm/utility/api/controller/build-route-documentation.utility.js.map +1 -1
  5. package/package.json +1 -1
package/dist/cjs/utility/api/controller/build-route-documentation.utility.js CHANGED
@@ -29,38 +29,39 @@ var routeType_enum = require('../../../enum/decorator/api/route-type.enum.js');
29
29
  * @returns {IApiRouteDocumentationProperties} Documentation metadata for ApiMethod.
30
30
  */
31
31
  function ApiControllerBuildRouteDocumentation(options) {
32
- const resourceName = pluralizer.pluralizer.toPlural(options.resourceName);
32
+ const pluralResourceName = pluralizer.pluralizer.toPlural(options.resourceName);
33
+ const singularResourceName = pluralizer.pluralizer.toSingular(options.resourceName);
33
34
  let summary;
34
35
  let description;
35
36
  switch (options.routeType) {
36
37
  case routeType_enum.EApiRouteType.CREATE: {
37
- summary = `Creating \`${resourceName}\``;
38
- description = `This method is used for creating \`${resourceName}\``;
38
+ summary = `Create \`${singularResourceName}\``;
39
+ description = `Creates a new \`${singularResourceName}\` resource.`;
39
40
  break;
40
41
  }
41
42
  case routeType_enum.EApiRouteType.DELETE: {
42
- summary = `Deleting \`${resourceName}\``;
43
- description = `This method is used for deleting \`${resourceName}\``;
43
+ summary = `Delete \`${singularResourceName}\``;
44
+ description = `Deletes an existing \`${singularResourceName}\` resource.`;
44
45
  break;
45
46
  }
46
47
  case routeType_enum.EApiRouteType.GET: {
47
- summary = `Fetching \`${resourceName}\``;
48
- description = `This method is used for fetching \`${resourceName}\``;
48
+ summary = `Get \`${singularResourceName}\``;
49
+ description = `Returns a single \`${singularResourceName}\` resource by its identifier.`;
49
50
  break;
50
51
  }
51
52
  case routeType_enum.EApiRouteType.GET_LIST: {
52
- summary = `Fetching list of \`${resourceName}\``;
53
- description = `This method is used for fetching list of \`${resourceName}\``;
53
+ summary = `List \`${pluralResourceName}\``;
54
+ description = `Returns a paginated list of \`${pluralResourceName}\` resources.`;
54
55
  break;
55
56
  }
56
57
  case routeType_enum.EApiRouteType.PARTIAL_UPDATE: {
57
- summary = `Partially updating \`${resourceName}\``;
58
- description = `This method is used for partially updating \`${resourceName}\``;
58
+ summary = `Partially update \`${singularResourceName}\``;
59
+ description = `Partially updates an existing \`${singularResourceName}\` resource.`;
59
60
  break;
60
61
  }
61
62
  case routeType_enum.EApiRouteType.UPDATE: {
62
- summary = `Updating \`${resourceName}\``;
63
- description = `This method is used for updating \`${resourceName}\``;
63
+ summary = `Update \`${singularResourceName}\``;
64
+ description = `Replaces an existing \`${singularResourceName}\` resource.`;
64
65
  break;
65
66
  }
66
67
  }
package/dist/cjs/utility/api/controller/build-route-documentation.utility.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"build-route-documentation.utility.js","sources":["../../../../../../src/utility/api/controller/build-route-documentation.utility.ts"],"sourcesContent":[null],"names":["pluralizer","EApiRouteTypeValue"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAMA;;;;;;;AAOG;AACG,SAAU,oCAAoC,CAAC,OAA6G,EAAA;IACjK,MAAM,YAAY,GAAWA,qBAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC;AACtE,IAAA,IAAI,OAAe;AACnB,IAAA,IAAI,WAAmB;AAEvB,IAAA,QAAQ,OAAO,CAAC,SAAS;AACxB,QAAA,KAAKC,4BAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,WAAA,EAAc,YAAY,CAAA,EAAA,CAAI;AACxC,YAAA,WAAW,GAAG,CAAA,mCAAA,EAAsC,YAAY,CAAA,EAAA,CAAI;YAEpE;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,WAAA,EAAc,YAAY,CAAA,EAAA,CAAI;AACxC,YAAA,WAAW,GAAG,CAAA,mCAAA,EAAsC,YAAY,CAAA,EAAA,CAAI;YAEpE;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,GAAG,EAAE;AAC5B,YAAA,OAAO,GAAG,CAAA,WAAA,EAAc,YAAY,CAAA,EAAA,CAAI;AACxC,YAAA,WAAW,GAAG,CAAA,mCAAA,EAAsC,YAAY,CAAA,EAAA,CAAI;YAEpE;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,QAAQ,EAAE;AACjC,YAAA,OAAO,GAAG,CAAA,mBAAA,EAAsB,YAAY,CAAA,EAAA,CAAI;AAChD,YAAA,WAAW,GAAG,CAAA,2CAAA,EAA8C,YAAY,CAAA,EAAA,CAAI;YAE5E;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,cAAc,EAAE;AACvC,YAAA,OAAO,GAAG,CAAA,qBAAA,EAAwB,YAAY,CAAA,EAAA,CAAI;AAClD,YAAA,WAAW,GAAG,CAAA,6CAAA,EAAgD,YAAY,CAAA,EAAA,CAAI;YAE9E;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,WAAA,EAAc,YAAY,CAAA,EAAA,CAAI;AACxC,YAAA,WAAW,GAAG,CAAA,mCAAA,EAAsC,YAAY,CAAA,EAAA,CAAI;YAEpE;QACD;;IAGD,OAAO;AACN,QAAA,WAAW,EAAE,OAAO,CAAC,aAAa,EAAE,WAAW,IAAI,WAAW;AAC9D,QAAA,WAAW,EAAE,OAAO,CAAC,aAAa,EAAE,WAAW;AAC/C,QAAA,OAAO,EAAE,OAAO,CAAC,aAAa,EAAE,OAAO,IAAI,OAAO;KAClD;AACF;;;;"}
1
+ {"version":3,"file":"build-route-documentation.utility.js","sources":["../../../../../../src/utility/api/controller/build-route-documentation.utility.ts"],"sourcesContent":[null],"names":["pluralizer","EApiRouteTypeValue"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAMA;;;;;;;AAOG;AACG,SAAU,oCAAoC,CAAC,OAA6G,EAAA;IACjK,MAAM,kBAAkB,GAAWA,qBAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC;IAC5E,MAAM,oBAAoB,GAAWA,qBAAU,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC;AAChF,IAAA,IAAI,OAAe;AACnB,IAAA,IAAI,WAAmB;AAEvB,IAAA,QAAQ,OAAO,CAAC,SAAS;AACxB,QAAA,KAAKC,4BAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,SAAA,EAAY,oBAAoB,CAAA,EAAA,CAAI;AAC9C,YAAA,WAAW,GAAG,CAAA,gBAAA,EAAmB,oBAAoB,CAAA,YAAA,CAAc;YAEnE;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,SAAA,EAAY,oBAAoB,CAAA,EAAA,CAAI;AAC9C,YAAA,WAAW,GAAG,CAAA,sBAAA,EAAyB,oBAAoB,CAAA,YAAA,CAAc;YAEzE;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,GAAG,EAAE;AAC5B,YAAA,OAAO,GAAG,CAAA,MAAA,EAAS,oBAAoB,CAAA,EAAA,CAAI;AAC3C,YAAA,WAAW,GAAG,CAAA,mBAAA,EAAsB,oBAAoB,CAAA,8BAAA,CAAgC;YAExF;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,QAAQ,EAAE;AACjC,YAAA,OAAO,GAAG,CAAA,OAAA,EAAU,kBAAkB,CAAA,EAAA,CAAI;AAC1C,YAAA,WAAW,GAAG,CAAA,8BAAA,EAAiC,kBAAkB,CAAA,aAAA,CAAe;YAEhF;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,cAAc,EAAE;AACvC,YAAA,OAAO,GAAG,CAAA,mBAAA,EAAsB,oBAAoB,CAAA,EAAA,CAAI;AACxD,YAAA,WAAW,GAAG,CAAA,gCAAA,EAAmC,oBAAoB,CAAA,YAAA,CAAc;YAEnF;QACD;AAEA,QAAA,KAAKA,4BAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,SAAA,EAAY,oBAAoB,CAAA,EAAA,CAAI;AAC9C,YAAA,WAAW,GAAG,CAAA,uBAAA,EAA0B,oBAAoB,CAAA,YAAA,CAAc;YAE1E;QACD;;IAGD,OAAO;AACN,QAAA,WAAW,EAAE,OAAO,CAAC,aAAa,EAAE,WAAW,IAAI,WAAW;AAC9D,QAAA,WAAW,EAAE,OAAO,CAAC,aAAa,EAAE,WAAW;AAC/C,QAAA,OAAO,EAAE,OAAO,CAAC,aAAa,EAAE,OAAO,IAAI,OAAO;KAClD;AACF;;;;"}
package/dist/esm/utility/api/controller/build-route-documentation.utility.js CHANGED
@@ -27,38 +27,39 @@ import { EApiRouteType } from '../../../enum/decorator/api/route-type.enum.js';
27
27
  * @returns {IApiRouteDocumentationProperties} Documentation metadata for ApiMethod.
28
28
  */
29
29
  function ApiControllerBuildRouteDocumentation(options) {
30
- const resourceName = pluralizer.toPlural(options.resourceName);
30
+ const pluralResourceName = pluralizer.toPlural(options.resourceName);
31
+ const singularResourceName = pluralizer.toSingular(options.resourceName);
31
32
  let summary;
32
33
  let description;
33
34
  switch (options.routeType) {
34
35
  case EApiRouteType.CREATE: {
35
- summary = `Creating \`${resourceName}\``;
36
- description = `This method is used for creating \`${resourceName}\``;
36
+ summary = `Create \`${singularResourceName}\``;
37
+ description = `Creates a new \`${singularResourceName}\` resource.`;
37
38
  break;
38
39
  }
39
40
  case EApiRouteType.DELETE: {
40
- summary = `Deleting \`${resourceName}\``;
41
- description = `This method is used for deleting \`${resourceName}\``;
41
+ summary = `Delete \`${singularResourceName}\``;
42
+ description = `Deletes an existing \`${singularResourceName}\` resource.`;
42
43
  break;
43
44
  }
44
45
  case EApiRouteType.GET: {
45
- summary = `Fetching \`${resourceName}\``;
46
- description = `This method is used for fetching \`${resourceName}\``;
46
+ summary = `Get \`${singularResourceName}\``;
47
+ description = `Returns a single \`${singularResourceName}\` resource by its identifier.`;
47
48
  break;
48
49
  }
49
50
  case EApiRouteType.GET_LIST: {
50
- summary = `Fetching list of \`${resourceName}\``;
51
- description = `This method is used for fetching list of \`${resourceName}\``;
51
+ summary = `List \`${pluralResourceName}\``;
52
+ description = `Returns a paginated list of \`${pluralResourceName}\` resources.`;
52
53
  break;
53
54
  }
54
55
  case EApiRouteType.PARTIAL_UPDATE: {
55
- summary = `Partially updating \`${resourceName}\``;
56
- description = `This method is used for partially updating \`${resourceName}\``;
56
+ summary = `Partially update \`${singularResourceName}\``;
57
+ description = `Partially updates an existing \`${singularResourceName}\` resource.`;
57
58
  break;
58
59
  }
59
60
  case EApiRouteType.UPDATE: {
60
- summary = `Updating \`${resourceName}\``;
61
- description = `This method is used for updating \`${resourceName}\``;
61
+ summary = `Update \`${singularResourceName}\``;
62
+ description = `Replaces an existing \`${singularResourceName}\` resource.`;
62
63
  break;
63
64
  }
64
65
  }
package/dist/esm/utility/api/controller/build-route-documentation.utility.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"build-route-documentation.utility.js","sources":["../../../../../../src/utility/api/controller/build-route-documentation.utility.ts"],"sourcesContent":[null],"names":["EApiRouteTypeValue"],"mappings":";;;;;;;;;;;;;;;;;;;;AAMA;;;;;;;AAOG;AACG,SAAU,oCAAoC,CAAC,OAA6G,EAAA;IACjK,MAAM,YAAY,GAAW,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC;AACtE,IAAA,IAAI,OAAe;AACnB,IAAA,IAAI,WAAmB;AAEvB,IAAA,QAAQ,OAAO,CAAC,SAAS;AACxB,QAAA,KAAKA,aAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,WAAA,EAAc,YAAY,CAAA,EAAA,CAAI;AACxC,YAAA,WAAW,GAAG,CAAA,mCAAA,EAAsC,YAAY,CAAA,EAAA,CAAI;YAEpE;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,WAAA,EAAc,YAAY,CAAA,EAAA,CAAI;AACxC,YAAA,WAAW,GAAG,CAAA,mCAAA,EAAsC,YAAY,CAAA,EAAA,CAAI;YAEpE;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,GAAG,EAAE;AAC5B,YAAA,OAAO,GAAG,CAAA,WAAA,EAAc,YAAY,CAAA,EAAA,CAAI;AACxC,YAAA,WAAW,GAAG,CAAA,mCAAA,EAAsC,YAAY,CAAA,EAAA,CAAI;YAEpE;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,QAAQ,EAAE;AACjC,YAAA,OAAO,GAAG,CAAA,mBAAA,EAAsB,YAAY,CAAA,EAAA,CAAI;AAChD,YAAA,WAAW,GAAG,CAAA,2CAAA,EAA8C,YAAY,CAAA,EAAA,CAAI;YAE5E;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,cAAc,EAAE;AACvC,YAAA,OAAO,GAAG,CAAA,qBAAA,EAAwB,YAAY,CAAA,EAAA,CAAI;AAClD,YAAA,WAAW,GAAG,CAAA,6CAAA,EAAgD,YAAY,CAAA,EAAA,CAAI;YAE9E;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,WAAA,EAAc,YAAY,CAAA,EAAA,CAAI;AACxC,YAAA,WAAW,GAAG,CAAA,mCAAA,EAAsC,YAAY,CAAA,EAAA,CAAI;YAEpE;QACD;;IAGD,OAAO;AACN,QAAA,WAAW,EAAE,OAAO,CAAC,aAAa,EAAE,WAAW,IAAI,WAAW;AAC9D,QAAA,WAAW,EAAE,OAAO,CAAC,aAAa,EAAE,WAAW;AAC/C,QAAA,OAAO,EAAE,OAAO,CAAC,aAAa,EAAE,OAAO,IAAI,OAAO;KAClD;AACF;;;;"}
1
+ {"version":3,"file":"build-route-documentation.utility.js","sources":["../../../../../../src/utility/api/controller/build-route-documentation.utility.ts"],"sourcesContent":[null],"names":["EApiRouteTypeValue"],"mappings":";;;;;;;;;;;;;;;;;;;;AAMA;;;;;;;AAOG;AACG,SAAU,oCAAoC,CAAC,OAA6G,EAAA;IACjK,MAAM,kBAAkB,GAAW,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC;IAC5E,MAAM,oBAAoB,GAAW,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC;AAChF,IAAA,IAAI,OAAe;AACnB,IAAA,IAAI,WAAmB;AAEvB,IAAA,QAAQ,OAAO,CAAC,SAAS;AACxB,QAAA,KAAKA,aAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,SAAA,EAAY,oBAAoB,CAAA,EAAA,CAAI;AAC9C,YAAA,WAAW,GAAG,CAAA,gBAAA,EAAmB,oBAAoB,CAAA,YAAA,CAAc;YAEnE;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,SAAA,EAAY,oBAAoB,CAAA,EAAA,CAAI;AAC9C,YAAA,WAAW,GAAG,CAAA,sBAAA,EAAyB,oBAAoB,CAAA,YAAA,CAAc;YAEzE;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,GAAG,EAAE;AAC5B,YAAA,OAAO,GAAG,CAAA,MAAA,EAAS,oBAAoB,CAAA,EAAA,CAAI;AAC3C,YAAA,WAAW,GAAG,CAAA,mBAAA,EAAsB,oBAAoB,CAAA,8BAAA,CAAgC;YAExF;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,QAAQ,EAAE;AACjC,YAAA,OAAO,GAAG,CAAA,OAAA,EAAU,kBAAkB,CAAA,EAAA,CAAI;AAC1C,YAAA,WAAW,GAAG,CAAA,8BAAA,EAAiC,kBAAkB,CAAA,aAAA,CAAe;YAEhF;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,cAAc,EAAE;AACvC,YAAA,OAAO,GAAG,CAAA,mBAAA,EAAsB,oBAAoB,CAAA,EAAA,CAAI;AACxD,YAAA,WAAW,GAAG,CAAA,gCAAA,EAAmC,oBAAoB,CAAA,YAAA,CAAc;YAEnF;QACD;AAEA,QAAA,KAAKA,aAAkB,CAAC,MAAM,EAAE;AAC/B,YAAA,OAAO,GAAG,CAAA,SAAA,EAAY,oBAAoB,CAAA,EAAA,CAAI;AAC9C,YAAA,WAAW,GAAG,CAAA,uBAAA,EAA0B,oBAAoB,CAAA,YAAA,CAAc;YAE1E;QACD;;IAGD,OAAO;AACN,QAAA,WAAW,EAAE,OAAO,CAAC,aAAa,EAAE,WAAW,IAAI,WAAW;AAC9D,QAAA,WAAW,EAAE,OAAO,CAAC,aAAa,EAAE,WAAW;AAC/C,QAAA,OAAO,EAAE,OAAO,CAAC,aAAa,EAAE,OAAO,IAAI,OAAO;KAClD;AACF;;;;"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@elsikora/nestjs-crud-automator",
3
- "version": "2.1.0",
3
+ "version": "2.1.1-dev.1",
4
4
  "description": "A library for automating the creation of CRUD operations in NestJS.",
5
5
  "keywords": [
6
6
  "NestJS",