@futdevpro/nts-dynamo 1.5.55 → 1.5.60

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 (127) hide show
  1. package/README.md +123 -0
  2. package/lib/_enums/data-model-type.enum.d.ts +7 -0
  3. package/lib/_enums/data-model-type.enum.d.ts.map +1 -1
  4. package/lib/_enums/data-model-type.enum.js +7 -0
  5. package/lib/_enums/data-model-type.enum.js.map +1 -1
  6. package/lib/_enums/dynamo-nts-data-service-function.enum.d.ts +5 -0
  7. package/lib/_enums/dynamo-nts-data-service-function.enum.d.ts.map +1 -1
  8. package/lib/_enums/dynamo-nts-data-service-function.enum.js +5 -1
  9. package/lib/_enums/dynamo-nts-data-service-function.enum.js.map +1 -1
  10. package/lib/_enums/dynamo-nts-route-security.enum.d.ts +6 -0
  11. package/lib/_enums/dynamo-nts-route-security.enum.d.ts.map +1 -1
  12. package/lib/_enums/dynamo-nts-route-security.enum.js +6 -0
  13. package/lib/_enums/dynamo-nts-route-security.enum.js.map +1 -1
  14. package/lib/_enums/dynamo-nts-socket-security.enum.d.ts +6 -0
  15. package/lib/_enums/dynamo-nts-socket-security.enum.d.ts.map +1 -1
  16. package/lib/_enums/dynamo-nts-socket-security.enum.js +6 -0
  17. package/lib/_enums/dynamo-nts-socket-security.enum.js.map +1 -1
  18. package/lib/_enums/http/http-call-type.enum.d.ts +4 -0
  19. package/lib/_enums/http/http-call-type.enum.d.ts.map +1 -1
  20. package/lib/_enums/http/http-call-type.enum.js +4 -0
  21. package/lib/_enums/http/http-call-type.enum.js.map +1 -1
  22. package/lib/_enums/predefined-data-types.enum.d.ts +3 -0
  23. package/lib/_enums/predefined-data-types.enum.d.ts.map +1 -1
  24. package/lib/_enums/predefined-data-types.enum.js +3 -0
  25. package/lib/_enums/predefined-data-types.enum.js.map +1 -1
  26. package/lib/_models/dynamo-nts-api-call-params.d.ts +61 -2
  27. package/lib/_models/dynamo-nts-api-call-params.d.ts.map +1 -1
  28. package/lib/_models/dynamo-nts-api-call-params.js +24 -7
  29. package/lib/_models/dynamo-nts-api-call-params.js.map +1 -1
  30. package/lib/_models/dynamo-nts-app-params.d.ts +33 -1
  31. package/lib/_models/dynamo-nts-app-params.d.ts.map +1 -1
  32. package/lib/_models/dynamo-nts-app-params.js +1 -1
  33. package/lib/_models/dynamo-nts-app-params.js.map +1 -1
  34. package/lib/_models/dynamo-nts-endpoint-params.d.ts +36 -1
  35. package/lib/_models/dynamo-nts-endpoint-params.d.ts.map +1 -1
  36. package/lib/_models/dynamo-nts-endpoint-params.js +15 -13
  37. package/lib/_models/dynamo-nts-endpoint-params.js.map +1 -1
  38. package/lib/_models/dynamo-nts-global-settings.d.ts +31 -0
  39. package/lib/_models/dynamo-nts-global-settings.d.ts.map +1 -1
  40. package/lib/_models/dynamo-nts-routing-module-settings.d.ts +10 -1
  41. package/lib/_models/dynamo-nts-routing-module-settings.d.ts.map +1 -1
  42. package/lib/_models/dynamo-nts-socket-dictionary.d.ts +3 -0
  43. package/lib/_models/dynamo-nts-socket-dictionary.d.ts.map +1 -1
  44. package/lib/_models/dynamo-nts-socket-dictionary.js +3 -0
  45. package/lib/_models/dynamo-nts-socket-dictionary.js.map +1 -1
  46. package/lib/_models/dynamo-nts-socket-event-params.d.ts +1 -1
  47. package/lib/_models/dynamo-nts-socket-event-params.d.ts.map +1 -1
  48. package/lib/_models/dynamo-nts-socket-event-params.js +3 -3
  49. package/lib/_models/dynamo-nts-socket-event-params.js.map +1 -1
  50. package/lib/_models/dynamo-nts-socket-service-params.d.ts +1 -1
  51. package/lib/_models/dynamo-nts-socket-service-params.d.ts.map +1 -1
  52. package/lib/_models/dynamo-nts-socket-service-params.js +3 -3
  53. package/lib/_models/dynamo-nts-socket-service-params.js.map +1 -1
  54. package/lib/_modules/usage/usage.service.js +1 -1
  55. package/lib/_modules/usage/usage.service.js.map +1 -1
  56. package/lib/_services/dynamo-nts-api.service.d.ts +17 -2
  57. package/lib/_services/dynamo-nts-api.service.d.ts.map +1 -1
  58. package/lib/_services/dynamo-nts-api.service.js +21 -12
  59. package/lib/_services/dynamo-nts-api.service.js.map +1 -1
  60. package/lib/_services/dynamo-nts-app-extended.d.ts +10 -1
  61. package/lib/_services/dynamo-nts-app-extended.d.ts.map +1 -1
  62. package/lib/_services/dynamo-nts-app-extended.js +8 -8
  63. package/lib/_services/dynamo-nts-app-extended.js.map +1 -1
  64. package/lib/_services/dynamo-nts-app.d.ts +30 -3
  65. package/lib/_services/dynamo-nts-app.d.ts.map +1 -1
  66. package/lib/_services/dynamo-nts-app.js +19 -19
  67. package/lib/_services/dynamo-nts-app.js.map +1 -1
  68. package/lib/_services/dynamo-nts-auth.service.d.ts +4 -4
  69. package/lib/_services/dynamo-nts-auth.service.d.ts.map +1 -1
  70. package/lib/_services/dynamo-nts-auth.service.js +2 -1
  71. package/lib/_services/dynamo-nts-auth.service.js.map +1 -1
  72. package/lib/_services/dynamo-nts-controller.service.d.ts +55 -0
  73. package/lib/_services/dynamo-nts-controller.service.d.ts.map +1 -1
  74. package/lib/_services/dynamo-nts-controller.service.js +2 -2
  75. package/lib/_services/dynamo-nts-controller.service.js.map +1 -1
  76. package/lib/_services/dynamo-nts-data.service.d.ts +13 -1
  77. package/lib/_services/dynamo-nts-data.service.d.ts.map +1 -1
  78. package/lib/_services/dynamo-nts-data.service.js +23 -9
  79. package/lib/_services/dynamo-nts-data.service.js.map +1 -1
  80. package/lib/_services/dynamo-nts-db.service.d.ts.map +1 -1
  81. package/lib/_services/dynamo-nts-db.service.js +2 -1
  82. package/lib/_services/dynamo-nts-db.service.js.map +1 -1
  83. package/lib/_services/dynamo-nts-email.service.d.ts.map +1 -1
  84. package/lib/_services/dynamo-nts-email.service.js +28 -23
  85. package/lib/_services/dynamo-nts-email.service.js.map +1 -1
  86. package/lib/_services/dynamo-nts-global.service.d.ts.map +1 -1
  87. package/lib/_services/dynamo-nts-global.service.js +3 -3
  88. package/lib/_services/dynamo-nts-global.service.js.map +1 -1
  89. package/lib/_services/dynamo-nts-routing-module.service.d.ts.map +1 -1
  90. package/lib/_services/dynamo-nts-routing-module.service.js +3 -3
  91. package/lib/_services/dynamo-nts-routing-module.service.js.map +1 -1
  92. package/lib/_services/dynamo-nts-socket.service.d.ts.map +1 -1
  93. package/lib/_services/dynamo-nts-socket.service.js +3 -3
  94. package/lib/_services/dynamo-nts-socket.service.js.map +1 -1
  95. package/lib/tsconfig.tsbuildinfo +1 -1
  96. package/package.json +13 -13
  97. package/src/_assets/dynamo-nts-128.png +0 -0
  98. package/src/_assets/dynamo-nts-256.png +0 -0
  99. package/src/_assets/dynamo-nts-512.png +0 -0
  100. package/src/_assets/dynamo-nts-64.png +0 -0
  101. package/src/_enums/data-model-type.enum.ts +7 -0
  102. package/src/_enums/dynamo-nts-data-service-function.enum.ts +5 -1
  103. package/src/_enums/dynamo-nts-route-security.enum.ts +6 -0
  104. package/src/_enums/dynamo-nts-socket-security.enum.ts +6 -0
  105. package/src/_enums/http/http-call-type.enum.ts +4 -0
  106. package/src/_enums/predefined-data-types.enum.ts +3 -0
  107. package/src/_models/dynamo-nts-api-call-params.ts +74 -14
  108. package/src/_models/dynamo-nts-app-params.ts +33 -1
  109. package/src/_models/dynamo-nts-endpoint-params.ts +49 -14
  110. package/src/_models/dynamo-nts-global-settings.ts +31 -0
  111. package/src/_models/dynamo-nts-routing-module-settings.ts +10 -1
  112. package/src/_models/dynamo-nts-socket-dictionary.ts +3 -0
  113. package/src/_models/dynamo-nts-socket-event-params.ts +3 -3
  114. package/src/_models/dynamo-nts-socket-service-params.ts +3 -3
  115. package/src/_modules/usage/usage.service.ts +2 -2
  116. package/src/_services/dynamo-nts-api.service.ts +26 -13
  117. package/src/_services/dynamo-nts-app-extended.ts +17 -8
  118. package/src/_services/dynamo-nts-app.ts +47 -20
  119. package/src/_services/dynamo-nts-auth.service.ts +7 -5
  120. package/src/_services/dynamo-nts-controller.service.ts +57 -2
  121. package/src/_services/dynamo-nts-data.service.ts +22 -10
  122. package/src/_services/dynamo-nts-db.service.ts +3 -1
  123. package/src/_services/dynamo-nts-email.service.ts +36 -24
  124. package/src/_services/dynamo-nts-global.service.ts +3 -4
  125. package/src/_services/dynamo-nts-routing-module.service.ts +5 -4
  126. package/src/_services/dynamo-nts-socket.service.ts +5 -4
  127. package/src/version.json +0 -2
package/README.md CHANGED
@@ -13,5 +13,128 @@ This interface can help juniors and people unfamiliar with development to easily
13
13
 
14
14
  more documentation and description soon...
15
15
 
16
+ ...
17
+
16
18
  support out projects to make it happen sooner!
17
19
  https://futdevpro.hu/support/dynamo
20
+
21
+
22
+
23
+
24
+
25
+
26
+ Development notes...:
27
+
28
+ # Hashtag1
29
+ ## Hashtag2
30
+ ### Hashtag3
31
+ #### Hashtag4
32
+ ##### Hashtag5
33
+ ###### Hashtag6
34
+
35
+ ____________________________________
36
+
37
+
38
+ - LINE
39
+ - LINES
40
+ - MORE LINES
41
+
42
+ * star line
43
+ * star lines
44
+ * more star lines
45
+
46
+ 1. num1
47
+ 2. num2
48
+ 3. num3
49
+
50
+ **STARS**
51
+ **[STARS-N-BRACET]**
52
+
53
+ EZMIEZ
54
+ Standard [VajonE](https://futdevpro.hu)
55
+ Standard [Jinja2](https://jinja.palletsprojects.com/en/2.10.x/templates/)
56
+
57
+ check ✓
58
+ cross ✗
59
+
60
+ ```
61
+ valami
62
+ ```
63
+
64
+
65
+ ```xml
66
+ <asd>
67
+ <fgh>
68
+ <id>central-mirror</id>
69
+ <name>AAFK {projektname} repo</name>
70
+ <url>https://futdevpro.hu</url>
71
+ </fgh>
72
+ </asd>
73
+ ```
74
+
75
+ ```yaml
76
+ web:
77
+ ports:
78
+ - number: 1234
79
+ protocol: TCP
80
+ - number: 2345
81
+ protocol: UDP
82
+ ```
83
+
84
+
85
+ ```json
86
+ {
87
+ "name": "@futdevpro/nts-dynamo",
88
+ "version": "01.05.57",
89
+ "description": "Dynamic NodeTS (NodeJS-Typescript), MongoDB Backend System Framework by Future Development Program Ltd.",
90
+ "scripts": {
91
+ "test": "echo \"Error: no test specified\" && exit 1",
92
+
93
+ "build": "npm run install-n-build",
94
+ }
95
+ }
96
+ ```
97
+
98
+ ```ts
99
+ export class App extends DynamoNTS_AppExtended {
100
+
101
+ ...
102
+
103
+ // Setting up App params, and preparing project global settings
104
+ setupAppParams(): void {
105
+ this.params = new DynamoNTS_AppParams({
106
+ name: 'Warbots Server',
107
+ title: warbotsTitleLog,
108
+ version: version,
109
+ dbName: 'warbots',
110
+ });
111
+
112
+ // dynamoNTS_GlobalSettings.logRequestsContent = false;
113
+ }
114
+
115
+ ...
116
+ ```
117
+
118
+ ```scss
119
+ @import '@futdevpro/ngx-dynamo';
120
+ ```
121
+
122
+ ```shell script
123
+ npm run start
124
+ ```
125
+
126
+ ```html
127
+ <dynamo-form [params]="newFeedbackFormParams"></dynamo-form>
128
+ ```
129
+
130
+ ![NTS](/src/_assets/dynamo-nts-512.png)
131
+
132
+
133
+ - [![dependency - npm](../../svg/dependency_npm.svg)](https://www.npmjs.com/package/font-awesome) font-awesome 4.7.0
134
+
135
+ | Dynamo verzió | Angular verzió |
136
+ | :-----: | :------------: |
137
+ | 01.01.x | 11.00.x |
138
+ | 01.05.x | 13.00.x |
139
+
140
+ ...
@@ -1,3 +1,10 @@
1
+ /**
2
+ * DataModelType is declaring where the data type is used
3
+ *
4
+ * dataModel: used in DB
5
+ * controlModel: used only in runtime
6
+ * interfaceModel: used only in runtime and doesnt need constructor
7
+ */
1
8
  export declare enum DataModelType {
2
9
  dataModel = "data-model",
3
10
  controlModel = "control-model",
@@ -1 +1 @@
1
- {"version":3,"file":"data-model-type.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/data-model-type.enum.ts"],"names":[],"mappings":"AACA,oBAAY,aAAa;IACvB,SAAS,eAAe;IACxB,YAAY,kBAAkB;IAC9B,cAAc,oBAAoB;CACnC"}
1
+ {"version":3,"file":"data-model-type.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/data-model-type.enum.ts"],"names":[],"mappings":"AACA;;;;;;GAMG;AACH,oBAAY,aAAa;IACvB,SAAS,eAAe;IACxB,YAAY,kBAAkB;IAC9B,cAAc,oBAAoB;CACnC"}
@@ -1,6 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.DataModelType = void 0;
4
+ /**
5
+ * DataModelType is declaring where the data type is used
6
+ *
7
+ * dataModel: used in DB
8
+ * controlModel: used only in runtime
9
+ * interfaceModel: used only in runtime and doesnt need constructor
10
+ */
4
11
  var DataModelType;
5
12
  (function (DataModelType) {
6
13
  DataModelType["dataModel"] = "data-model";
@@ -1 +1 @@
1
- {"version":3,"file":"data-model-type.enum.js","sourceRoot":"","sources":["../../src/_enums/data-model-type.enum.ts"],"names":[],"mappings":";;;AACA,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,yCAAwB,CAAA;IACxB,+CAA8B,CAAA;IAC9B,mDAAkC,CAAA;AACpC,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB"}
1
+ {"version":3,"file":"data-model-type.enum.js","sourceRoot":"","sources":["../../src/_enums/data-model-type.enum.ts"],"names":[],"mappings":";;;AACA;;;;;;GAMG;AACH,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,yCAAwB,CAAA;IACxB,+CAA8B,CAAA;IAC9B,mDAAkC,CAAA;AACpC,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB"}
@@ -1,3 +1,8 @@
1
+ /**
2
+ * DataServiceFunctions
3
+ *
4
+ * #unconnected TODO
5
+ */
1
6
  export declare enum DynamoNTS_DSF {
2
7
  getAll = "getAll",
3
8
  getDataById = "getDataById",
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-data-service-function.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-data-service-function.enum.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAG3B,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,eAAe,oBAAoB;CACpC"}
1
+ {"version":3,"file":"dynamo-nts-data-service-function.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-data-service-function.enum.ts"],"names":[],"mappings":"AACA;;;;GAIG;AACH,oBAAY,aAAa;IACvB,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAG3B,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,eAAe,oBAAoB;CACpC"}
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.DynamoNTS_DSF = void 0;
4
- /* DataServiceFunction */
4
+ /**
5
+ * DataServiceFunctions
6
+ *
7
+ * #unconnected TODO
8
+ */
5
9
  var DynamoNTS_DSF;
6
10
  (function (DynamoNTS_DSF) {
7
11
  DynamoNTS_DSF["getAll"] = "getAll";
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-data-service-function.enum.js","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-data-service-function.enum.ts"],"names":[],"mappings":";;;AACA,yBAAyB;AACzB,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,4CAA2B,CAAA;IAC3B;oCACgC;IAChC,0CAAyB,CAAA;IACzB,0CAAyB,CAAA;IACzB,oDAAmC,CAAA;AACrC,CAAC,EARW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQxB"}
1
+ {"version":3,"file":"dynamo-nts-data-service-function.enum.js","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-data-service-function.enum.ts"],"names":[],"mappings":";;;AACA;;;;GAIG;AACH,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,4CAA2B,CAAA;IAC3B;oCACgC;IAChC,0CAAyB,CAAA;IACzB,0CAAyB,CAAA;IACzB,oDAAmC,CAAA;AACrC,CAAC,EARW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQxB"}
@@ -1,3 +1,9 @@
1
+ /**
2
+ * security settings for API,
3
+ * different security paths will need different handlers
4
+ *
5
+ * open; http, secure; https or both,
6
+ */
1
7
  export declare enum DynamoNTS_RouteSecurity {
2
8
  open = "open",
3
9
  secure = "secure",
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-route-security.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-route-security.enum.ts"],"names":[],"mappings":"AACA,oBAAY,uBAAuB;IACjC,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,IAAI,SAAS;CACd"}
1
+ {"version":3,"file":"dynamo-nts-route-security.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-route-security.enum.ts"],"names":[],"mappings":"AACA;;;;;GAKG;AACH,oBAAY,uBAAuB;IACjC,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,IAAI,SAAS;CACd"}
@@ -1,6 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.DynamoNTS_RouteSecurity = void 0;
4
+ /**
5
+ * security settings for API,
6
+ * different security paths will need different handlers
7
+ *
8
+ * open; http, secure; https or both,
9
+ */
4
10
  var DynamoNTS_RouteSecurity;
5
11
  (function (DynamoNTS_RouteSecurity) {
6
12
  DynamoNTS_RouteSecurity["open"] = "open";
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-route-security.enum.js","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-route-security.enum.ts"],"names":[],"mappings":";;;AACA,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,wCAAa,CAAA;IACb,4CAAiB,CAAA;IACjB,wCAAa,CAAA;AACf,CAAC,EAJW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAIlC"}
1
+ {"version":3,"file":"dynamo-nts-route-security.enum.js","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-route-security.enum.ts"],"names":[],"mappings":";;;AACA;;;;;GAKG;AACH,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,wCAAa,CAAA;IACb,4CAAiB,CAAA;IACjB,wCAAa,CAAA;AACf,CAAC,EAJW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAIlC"}
@@ -1,3 +1,9 @@
1
+ /**
2
+ * security settings for API,
3
+ * different security paths will need different handlers
4
+ *
5
+ * open; http or secure; https
6
+ */
1
7
  export declare enum DynamoNTS_SocketSecurity {
2
8
  open = "open",
3
9
  secure = "secure"
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-socket-security.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-socket-security.enum.ts"],"names":[],"mappings":"AACA,oBAAY,wBAAwB;IAClC,IAAI,SAAS;IACb,MAAM,WAAW;CAClB"}
1
+ {"version":3,"file":"dynamo-nts-socket-security.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-socket-security.enum.ts"],"names":[],"mappings":"AACA;;;;;GAKG;AACH,oBAAY,wBAAwB;IAClC,IAAI,SAAS;IACb,MAAM,WAAW;CAClB"}
@@ -1,6 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.DynamoNTS_SocketSecurity = void 0;
4
+ /**
5
+ * security settings for API,
6
+ * different security paths will need different handlers
7
+ *
8
+ * open; http or secure; https
9
+ */
4
10
  var DynamoNTS_SocketSecurity;
5
11
  (function (DynamoNTS_SocketSecurity) {
6
12
  DynamoNTS_SocketSecurity["open"] = "open";
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-socket-security.enum.js","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-socket-security.enum.ts"],"names":[],"mappings":";;;AACA,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAClC,yCAAa,CAAA;IACb,6CAAiB,CAAA;AACnB,CAAC,EAHW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAGnC"}
1
+ {"version":3,"file":"dynamo-nts-socket-security.enum.js","sourceRoot":"","sources":["../../src/_enums/dynamo-nts-socket-security.enum.ts"],"names":[],"mappings":";;;AACA;;;;;GAKG;AACH,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IAClC,yCAAa,CAAA;IACb,6CAAiB,CAAA;AACnB,CAAC,EAHW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAGnC"}
@@ -1,3 +1,7 @@
1
+ /**
2
+ * basic Http Call Types such as;
3
+ * get, post, put, patch, delete
4
+ */
1
5
  export declare enum HttpCallType {
2
6
  get = "get",
3
7
  post = "post",
@@ -1 +1 @@
1
- {"version":3,"file":"http-call-type.enum.d.ts","sourceRoot":"","sources":["../../../src/_enums/http/http-call-type.enum.ts"],"names":[],"mappings":"AACA,oBAAY,YAAY;IACtB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,MAAM,WAAW;CAClB"}
1
+ {"version":3,"file":"http-call-type.enum.d.ts","sourceRoot":"","sources":["../../../src/_enums/http/http-call-type.enum.ts"],"names":[],"mappings":"AACA;;;GAGG;AACH,oBAAY,YAAY;IACtB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,MAAM,WAAW;CAClB"}
@@ -1,6 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.HttpCallType = void 0;
4
+ /**
5
+ * basic Http Call Types such as;
6
+ * get, post, put, patch, delete
7
+ */
4
8
  var HttpCallType;
5
9
  (function (HttpCallType) {
6
10
  HttpCallType["get"] = "get";
@@ -1 +1 @@
1
- {"version":3,"file":"http-call-type.enum.js","sourceRoot":"","sources":["../../../src/_enums/http/http-call-type.enum.ts"],"names":[],"mappings":";;;AACA,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,6BAAa,CAAA;IACb,2BAAW,CAAA;IACX,+BAAe,CAAA;IACf,iCAAiB,CAAA;AACnB,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB"}
1
+ {"version":3,"file":"http-call-type.enum.js","sourceRoot":"","sources":["../../../src/_enums/http/http-call-type.enum.ts"],"names":[],"mappings":";;;AACA;;;GAGG;AACH,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,6BAAa,CAAA;IACb,2BAAW,CAAA;IACX,+BAAe,CAAA;IACf,iCAAiB,CAAA;AACnB,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB"}
@@ -1,3 +1,6 @@
1
+ /**
2
+ * the most basic data types
3
+ */
1
4
  export declare enum PredefinedDataTypes {
2
5
  'string' = 0,
3
6
  'number' = 1,
@@ -1 +1 @@
1
- {"version":3,"file":"predefined-data-types.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/predefined-data-types.enum.ts"],"names":[],"mappings":"AACA,oBAAY,mBAAmB;IAC7B,QAAQ,IAAA;IACR,QAAQ,IAAA;IACR,SAAS,IAAA;IACT,MAAM,IAAA;IACN,QAAQ,IAAA;CACT"}
1
+ {"version":3,"file":"predefined-data-types.enum.d.ts","sourceRoot":"","sources":["../../src/_enums/predefined-data-types.enum.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,QAAQ,IAAA;IACR,QAAQ,IAAA;IACR,SAAS,IAAA;IACT,MAAM,IAAA;IACN,QAAQ,IAAA;CACT"}
@@ -1,6 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.PredefinedDataTypes = void 0;
4
+ /**
5
+ * the most basic data types
6
+ */
4
7
  var PredefinedDataTypes;
5
8
  (function (PredefinedDataTypes) {
6
9
  PredefinedDataTypes[PredefinedDataTypes["string"] = 0] = "string";
@@ -1 +1 @@
1
- {"version":3,"file":"predefined-data-types.enum.js","sourceRoot":"","sources":["../../src/_enums/predefined-data-types.enum.ts"],"names":[],"mappings":";;;AACA,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,iEAAQ,CAAA;IACR,iEAAQ,CAAA;IACR,mEAAS,CAAA;IACT,6DAAM,CAAA;IACN,iEAAQ,CAAA;AACV,CAAC,EANW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAM9B"}
1
+ {"version":3,"file":"predefined-data-types.enum.js","sourceRoot":"","sources":["../../src/_enums/predefined-data-types.enum.ts"],"names":[],"mappings":";;;AACA;;GAEG;AACH,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,iEAAQ,CAAA;IACR,iEAAQ,CAAA;IACR,mEAAS,CAAA;IACT,6DAAM,CAAA;IACN,iEAAQ,CAAA;AACV,CAAC,EANW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAM9B"}
@@ -1,21 +1,80 @@
1
1
  import { HttpCallType } from "../_enums/http/http-call-type.enum";
2
2
  import { HttpResponseType } from "../_enums/http/http-response-type.enum";
3
+ /**
4
+ * API call params,
5
+ * such as
6
+ * type (HttpCallType),
7
+ * endpoint,
8
+ * and other options as httpOptions
9
+ */
3
10
  export declare class DynamoNTS_ApiCallParams {
11
+ /**
12
+ * name the call to be able to identify it when debugging
13
+ */
4
14
  name: string;
15
+ /**
16
+ * type of the call as; HttpCallType .get, .post, ...ect
17
+ */
5
18
  type: HttpCallType;
19
+ /**
20
+ * the endpoint of the API, without the baseUrl:
21
+ * '/user/get/:userId',
22
+ * where the parts starting with ':', will be used as pathParam
23
+ */
6
24
  baseUrl: string;
25
+ /**
26
+ * baseUrl of the API;
27
+ * 'https://futdevpro.hu/api'
28
+ */
7
29
  endPoint: string;
30
+ /**
31
+ * if this value is true, the call will return the full HTTP call response in raw
32
+ */
8
33
  getFullResponse: boolean;
34
+ /**
35
+ * this setting will be passed to the axios http call
36
+ */
9
37
  httpOptions: any;
10
- constructor(set: {
38
+ constructor(
39
+ /**
40
+ * set of options necessary for setting up an API call
41
+ */
42
+ set: {
43
+ /**
44
+ * name the call to be able to identify it when debugging
45
+ */
11
46
  name: string;
47
+ /**
48
+ * set type as; HttpCallType .get, .post, ...ect
49
+ */
12
50
  type: HttpCallType;
51
+ /**
52
+ * the endpoint of the API, without the baseUrl:
53
+ * '/user/get/:userId',
54
+ * where the parts starting with ':', will be used as pathParam
55
+ */
13
56
  endPoint: string;
57
+ /**
58
+ * baseUrl of the API;
59
+ * 'https://futdevpro.hu/api'
60
+ */
14
61
  baseUrl: string;
62
+ /**
63
+ * setting this value to true, will return the full HTTP call response in raw
64
+ */
15
65
  getFullResponse?: boolean;
66
+ /**
67
+ * this setting will pass any kind of http setting used by the axios http messaging package
68
+ */
16
69
  httpOptions?: HttpOptions;
17
70
  });
18
71
  }
72
+ /**
73
+ * basic axios HttpsOptions,
74
+ *
75
+ * learn more on axios package....
76
+ * TOD: link package documentations
77
+ */
19
78
  export declare class HttpOptions {
20
79
  responseType?: HttpResponseType;
21
80
  headers?: {
@@ -24,7 +83,7 @@ export declare class HttpOptions {
24
83
  observe?: 'body';
25
84
  reportProgress?: boolean;
26
85
  withCredentials?: boolean;
27
- constructor(options: {
86
+ constructor(set: {
28
87
  responseType?: HttpResponseType;
29
88
  headers?: {
30
89
  [header: string]: string | string[];
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-api-call-params.d.ts","sourceRoot":"","sources":["../../src/_models/dynamo-nts-api-call-params.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAE1E,qBAAa,uBAAuB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IAEjB,eAAe,EAAE,OAAO,CAAC;IACzB,WAAW,EAAE,GAAG,CAAC;gBAGf,GAAG,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,YAAY,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B;CAaJ;AAED,qBAAa,WAAW;IACtB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,OAAO,CAAC,EAAE;QACR,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;KACrC,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAC;gBAEd,OAAO,EAAE;QACnB,YAAY,CAAC,EAAE,gBAAgB,CAAC;QAChC,OAAO,CAAC,EAAE;YACR,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;SACrC,CAAC;QACF,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,eAAe,CAAC,EAAE,OAAO,CAAA;KAC1B;CAOF"}
1
+ {"version":3,"file":"dynamo-nts-api-call-params.d.ts","sourceRoot":"","sources":["../../src/_models/dynamo-nts-api-call-params.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAE1E;;;;;;GAMG;AACH,qBAAa,uBAAuB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IACnB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,WAAW,EAAE,GAAG,CAAC;;IAGf;;OAEG;IACH,GAAG,EAAE;QACH;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;QACnB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;;WAGG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,eAAe,CAAC,EAAE,OAAO,CAAC;QAC1B;;WAEG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B;CAaJ;AAED;;;;;GAKG;AACH,qBAAa,WAAW;IACtB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,OAAO,CAAC,EAAE;QACR,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;KACrC,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,CAAC;gBAGxB,GAAG,EAAE;QACH,YAAY,CAAC,EAAE,gBAAgB,CAAC;QAChC,OAAO,CAAC,EAAE;YACR,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;SACrC,CAAC;QACF,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,cAAc,CAAC,EAAE,OAAO,CAAC;QACzB,eAAe,CAAC,EAAE,OAAO,CAAA;KAC1B;CAQJ"}
@@ -1,8 +1,19 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.HttpOptions = exports.DynamoNTS_ApiCallParams = void 0;
4
+ /**
5
+ * API call params,
6
+ * such as
7
+ * type (HttpCallType),
8
+ * endpoint,
9
+ * and other options as httpOptions
10
+ */
4
11
  class DynamoNTS_ApiCallParams {
5
- constructor(set) {
12
+ constructor(
13
+ /**
14
+ * set of options necessary for setting up an API call
15
+ */
16
+ set) {
6
17
  this.name = set.name;
7
18
  this.type = set.type;
8
19
  if (set.endPoint.includes('{')) {
@@ -16,13 +27,19 @@ class DynamoNTS_ApiCallParams {
16
27
  }
17
28
  }
18
29
  exports.DynamoNTS_ApiCallParams = DynamoNTS_ApiCallParams;
30
+ /**
31
+ * basic axios HttpsOptions,
32
+ *
33
+ * learn more on axios package....
34
+ * TOD: link package documentations
35
+ */
19
36
  class HttpOptions {
20
- constructor(options) {
21
- this.responseType = options.responseType;
22
- this.headers = options.headers;
23
- this.observe = options.observe;
24
- this.reportProgress = options.reportProgress;
25
- this.withCredentials = options.withCredentials;
37
+ constructor(set) {
38
+ this.responseType = set.responseType;
39
+ this.headers = set.headers;
40
+ this.observe = set.observe;
41
+ this.reportProgress = set.reportProgress;
42
+ this.withCredentials = set.withCredentials;
26
43
  }
27
44
  }
28
45
  exports.HttpOptions = HttpOptions;
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-api-call-params.js","sourceRoot":"","sources":["../../src/_models/dynamo-nts-api-call-params.ts"],"names":[],"mappings":";;;AAIA,MAAa,uBAAuB;IASlC,YACE,GAOC;QAED,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9B,OAAO,CAAC,GAAG,CAAC,qHAAqH,CAAC,CAAC;YACnI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5D,CAAC;CACF;AA9BD,0DA8BC;AAED,MAAa,WAAW;IAStB,YAAY,OAQX;QACC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IACjD,CAAC;CACF;AAxBD,kCAwBC"}
1
+ {"version":3,"file":"dynamo-nts-api-call-params.js","sourceRoot":"","sources":["../../src/_models/dynamo-nts-api-call-params.ts"],"names":[],"mappings":";;;AAIA;;;;;;GAMG;AACH,MAAa,uBAAuB;IA8BlC;IACE;;OAEG;IACH,GA4BC;QAED,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YAC9B,OAAO,CAAC,GAAG,CAAC,qHAAqH,CAAC,CAAC;YACnI,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;SACnD;QACD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC;QAC7C,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5D,CAAC;CACF;AA3ED,0DA2EC;AAED;;;;;GAKG;AACH,MAAa,WAAW;IAStB,YACE,GAQC;QAED,IAAI,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC;QACrC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,cAAc,CAAC;QACzC,IAAI,CAAC,eAAe,GAAG,GAAG,CAAC,eAAe,CAAC;IAC7C,CAAC;CACF;AA1BD,kCA0BC"}
@@ -1,17 +1,49 @@
1
1
  /**
2
- *
2
+ * This will hold and set the basic settings of an application
3
3
  */
4
4
  export declare class DynamoNTS_AppParams {
5
+ /**
6
+ * name of the application
7
+ */
5
8
  name: string;
9
+ /**
10
+ * title will be shown on the start of the application
11
+ */
6
12
  title: string;
13
+ /**
14
+ * version of the application
15
+ */
7
16
  version: string;
17
+ /**
18
+ * name of your MongoDB table
19
+ */
8
20
  dbUri: string;
21
+ /**
22
+ * mongoDB uri, by default, its: `mongodb://localhost:27017/${this.dbName}`
23
+ */
9
24
  dbName: string;
10
25
  constructor(set: {
26
+ /**
27
+ * name the application
28
+ */
11
29
  name: string;
30
+ /**
31
+ * you can set a big f*in title to show on the start of the application
32
+ */
12
33
  title?: string;
34
+ /**
35
+ * you should set the version,
36
+ * probably, you should set from the package.json as follows:
37
+ * import { version } from '../package.json';
38
+ */
13
39
  version: string;
40
+ /**
41
+ * You need to name your MongoDB table
42
+ */
14
43
  dbName: string;
44
+ /**
45
+ * you can change the mongoDB uri here. by default, its: `mongodb://localhost:27017/${this.dbName}`
46
+ */
15
47
  dbUri?: string;
16
48
  });
17
49
  }
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-app-params.d.ts","sourceRoot":"","sources":["../../src/_models/dynamo-nts-app-params.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;gBAGb,GAAG,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CAQJ"}
1
+ {"version":3,"file":"dynamo-nts-app-params.d.ts","sourceRoot":"","sources":["../../src/_models/dynamo-nts-app-params.ts"],"names":[],"mappings":"AACA;;GAEG;AACH,qBAAa,mBAAmB;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;gBAGb,GAAG,EAAE;QACH;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QACf;;;;WAIG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,MAAM,EAAE,MAAM,CAAC;QACf;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;CAQJ"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.DynamoNTS_AppParams = void 0;
4
4
  /**
5
- *
5
+ * This will hold and set the basic settings of an application
6
6
  */
7
7
  class DynamoNTS_AppParams {
8
8
  constructor(set) {
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-app-params.js","sourceRoot":"","sources":["../../src/_models/dynamo-nts-app-params.ts"],"names":[],"mappings":";;;AACA;;GAEG;AACH,MAAa,mBAAmB;IAO9B,YACE,GAMC;QAED,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,6BAA6B,IAAI,CAAC,MAAM,EAAE,CAAC;IAClF,CAAC;CACF;AAtBD,kDAsBC"}
1
+ {"version":3,"file":"dynamo-nts-app-params.js","sourceRoot":"","sources":["../../src/_models/dynamo-nts-app-params.ts"],"names":[],"mappings":";;;AACA;;GAEG;AACH,MAAa,mBAAmB;IAsB9B,YACE,GAuBC;QAED,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,6BAA6B,IAAI,CAAC,MAAM,EAAE,CAAC;IAClF,CAAC;CACF;AAtDD,kDAsDC"}
@@ -2,7 +2,9 @@ import { NextFunction, Request, Response } from 'express';
2
2
  import { HttpCallType } from '../_enums/http/http-call-type.enum';
3
3
  import { DynamoNTS_RouteSecurity } from '../_enums/dynamo-nts-route-security.enum';
4
4
  /**
5
- *
5
+ * High level endpoint for API
6
+ * used for specific events such as saving or getting data,
7
+ * triggering events, logging in or out, and much more
6
8
  */
7
9
  export declare class DynamoNTS_EndpointParams {
8
10
  name: string;
@@ -16,14 +18,47 @@ export declare class DynamoNTS_EndpointParams {
16
18
  logRequestsContent: boolean;
17
19
  logResponseContent: boolean;
18
20
  constructor(set: {
21
+ /**
22
+ * naming the endpoint will help to follow events on service
23
+ */
19
24
  name: string;
25
+ /**
26
+ * security settings for API, different security paths will need different handlers
27
+ *
28
+ * open; http, secure; https or both
29
+ */
20
30
  security?: DynamoNTS_RouteSecurity;
31
+ /**
32
+ * define basic Http Call Type such as; get, post, put, patch, delete
33
+ */
21
34
  type: HttpCallType;
35
+ /**
36
+ * set endpoint here, without baseUrl and route module path
37
+ *
38
+ * like: '/get-user/:userId'
39
+ */
22
40
  endpoint: string;
41
+ /**
42
+ * preprocesses are the functions you need to run before the actual function,
43
+ * such as authentications
44
+ */
23
45
  preProcessess?: ((req: Request, res: Response, next: NextFunction) => Promise<void>)[];
46
+ /**
47
+ * the actual tasks to run,
48
+ * the last one should contain the res.send(); execution to send response on API requests
49
+ */
24
50
  tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[];
51
+ /**
52
+ * this flag will enable the debug logs on this endpoint
53
+ */
25
54
  logRequest?: boolean;
55
+ /**
56
+ * this flag will enable the debug logs on this endpoint's requests
57
+ */
26
58
  logRequestsContent?: boolean;
59
+ /**
60
+ * this flag will enable detailed debug logs on this endpoint's requests
61
+ */
27
62
  logResponseContent?: boolean;
28
63
  });
29
64
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"dynamo-nts-endpoint-params.d.ts","sourceRoot":"","sources":["../../src/_models/dynamo-nts-endpoint-params.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AAMnF;;GAEG;AACH,qBAAa,wBAAwB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,uBAAuB,CAAC;IAElC,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAA;IACrF,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;IAE3E,UAAU,EAAE,OAAO,CAAC;IACpB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,kBAAkB,EAAE,OAAO,CAAC;gBAG1B,GAAG,EAAE;QACH,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,uBAAuB,CAAC;QAEnC,IAAI,EAAE,YAAY,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QAEjB,aAAa,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACvF,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAE3E,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;IAwCH;;;OAGG;IACH,SAAS,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC;IA8B/E;;;OAGG;IACH,iBAAiB,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC;IAuBnE;;;;OAIG;IACH,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,KAAA,GAAG,IAAI;CAclC"}
1
+ {"version":3,"file":"dynamo-nts-endpoint-params.d.ts","sourceRoot":"","sources":["../../src/_models/dynamo-nts-endpoint-params.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AAClE,OAAO,EAAE,uBAAuB,EAAE,MAAM,0CAA0C,CAAC;AAKnF;;;;GAIG;AACH,qBAAa,wBAAwB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,uBAAuB,CAAC;IAElC,IAAI,EAAE,YAAY,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB,aAAa,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAA;IACrF,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;IAE3E,UAAU,EAAE,OAAO,CAAC;IACpB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,kBAAkB,EAAE,OAAO,CAAC;gBAG1B,GAAG,EAAE;QACH;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QACb;;;;WAIG;QACH,QAAQ,CAAC,EAAE,uBAAuB,CAAC;QAEnC;;WAEG;QACH,IAAI,EAAE,YAAY,CAAC;QACnB;;;;WAIG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,aAAa,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACvF;;;WAGG;QACH,KAAK,EAAE,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QAE3E;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B;IAyCH;;;OAGG;IACH,SAAS,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC;IA8B/E;;;OAGG;IACH,iBAAiB,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,KAAK,OAAO,CAAC,IAAI,CAAC;IAuBnE;;;;OAIG;IACH,KAAK,CAAC,GAAG,EAAE,QAAQ,EAAE,KAAK,KAAA,GAAG,IAAI;CAclC"}