@futdevpro/nts-dynamo 1.5.77 → 1.5.83

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 (227) hide show
  1. package/LICENSE +2 -2
  2. package/lib/_constants/dynamo-nts-global-settings.d.ts +2 -2
  3. package/lib/_constants/dynamo-nts-global-settings.js +17 -17
  4. package/lib/_constants/index.d.ts +1 -1
  5. package/lib/_constants/index.js +4 -4
  6. package/lib/_enums/data-model-type.enum.d.ts +12 -12
  7. package/lib/_enums/data-model-type.enum.js +16 -16
  8. package/lib/_enums/data-model-type.enum.js.map +1 -1
  9. package/lib/_enums/dynamo-nts-data-service-function.enum.d.ts +12 -12
  10. package/lib/_enums/dynamo-nts-data-service-function.enum.js +18 -18
  11. package/lib/_enums/dynamo-nts-data-service-function.enum.js.map +1 -1
  12. package/lib/_enums/dynamo-nts-route-security.enum.d.ts +11 -11
  13. package/lib/_enums/dynamo-nts-route-security.enum.js +15 -15
  14. package/lib/_enums/dynamo-nts-route-security.enum.js.map +1 -1
  15. package/lib/_enums/dynamo-nts-socket-security.enum.d.ts +10 -10
  16. package/lib/_enums/dynamo-nts-socket-security.enum.js +14 -14
  17. package/lib/_enums/dynamo-nts-socket-security.enum.js.map +1 -1
  18. package/lib/_enums/http/http-call-type.enum.d.ts +11 -11
  19. package/lib/_enums/http/http-call-type.enum.js +15 -15
  20. package/lib/_enums/http/http-call-type.enum.js.map +1 -1
  21. package/lib/_enums/http/http-response-type.enum.d.ts +6 -6
  22. package/lib/_enums/http/http-response-type.enum.js +10 -10
  23. package/lib/_enums/http/http-response-type.enum.js.map +1 -1
  24. package/lib/_enums/http/socket-event.enum.d.ts +9 -8
  25. package/lib/_enums/http/socket-event.enum.d.ts.map +1 -1
  26. package/lib/_enums/http/socket-event.enum.js +13 -12
  27. package/lib/_enums/http/socket-event.enum.js.map +1 -1
  28. package/lib/_enums/index.d.ts +8 -8
  29. package/lib/_enums/index.js +13 -13
  30. package/lib/_enums/predefined-data-types.enum.d.ts +10 -10
  31. package/lib/_enums/predefined-data-types.enum.js +14 -14
  32. package/lib/_enums/predefined-data-types.enum.js.map +1 -1
  33. package/lib/_interfaces/certification-settings.interface.d.ts +7 -0
  34. package/lib/_interfaces/certification-settings.interface.d.ts.map +1 -0
  35. package/lib/_interfaces/certification-settings.interface.js +3 -0
  36. package/lib/_interfaces/certification-settings.interface.js.map +1 -0
  37. package/lib/_interfaces/global-service-settings.interface.d.ts +18 -0
  38. package/lib/_interfaces/global-service-settings.interface.d.ts.map +1 -0
  39. package/lib/_interfaces/global-service-settings.interface.js +3 -0
  40. package/lib/_interfaces/global-service-settings.interface.js.map +1 -0
  41. package/lib/_interfaces/index.d.ts +1 -0
  42. package/lib/_interfaces/index.d.ts.map +1 -0
  43. package/lib/_interfaces/index.js +4 -0
  44. package/lib/_interfaces/index.js.map +1 -0
  45. package/lib/_interfaces/port-settings.interface.d.ts +5 -0
  46. package/lib/_interfaces/port-settings.interface.d.ts.map +1 -0
  47. package/lib/_interfaces/port-settings.interface.js +3 -0
  48. package/lib/_interfaces/port-settings.interface.js.map +1 -0
  49. package/lib/_models/dynamo-nts-api-call-params.d.ts +95 -95
  50. package/lib/_models/dynamo-nts-api-call-params.js +47 -47
  51. package/lib/_models/dynamo-nts-app-params.d.ts +49 -49
  52. package/lib/_models/dynamo-nts-app-params.js +17 -17
  53. package/lib/_models/dynamo-nts-endpoint-params.d.ts +80 -80
  54. package/lib/_models/dynamo-nts-endpoint-params.js +139 -139
  55. package/lib/_models/dynamo-nts-global-settings.d.ts +53 -53
  56. package/lib/_models/dynamo-nts-global-settings.js +2 -2
  57. package/lib/_models/dynamo-nts-routing-module-settings.d.ts +19 -19
  58. package/lib/_models/dynamo-nts-routing-module-settings.js +2 -2
  59. package/lib/_models/dynamo-nts-socket-event-params.d.ts +32 -30
  60. package/lib/_models/dynamo-nts-socket-event-params.d.ts.map +1 -1
  61. package/lib/_models/dynamo-nts-socket-event-params.js +80 -79
  62. package/lib/_models/dynamo-nts-socket-event-params.js.map +1 -1
  63. package/lib/_models/dynamo-nts-socket-presence.d.ts +21 -0
  64. package/lib/_models/dynamo-nts-socket-presence.d.ts.map +1 -0
  65. package/lib/_models/dynamo-nts-socket-presence.js +45 -0
  66. package/lib/_models/dynamo-nts-socket-presence.js.map +1 -0
  67. package/lib/_models/dynamo-nts-socket-service-params.d.ts +18 -18
  68. package/lib/_models/dynamo-nts-socket-service-params.d.ts.map +1 -1
  69. package/lib/_models/dynamo-nts-socket-service-params.js +26 -26
  70. package/lib/_models/dynamo-nts-socket-service-params.js.map +1 -1
  71. package/lib/_models/index.d.ts +7 -8
  72. package/lib/_models/index.d.ts.map +1 -1
  73. package/lib/_models/index.js +12 -12
  74. package/lib/_models/index.js.map +1 -1
  75. package/lib/_modules/api-service.index.d.ts +5 -5
  76. package/lib/_modules/api-service.index.js +11 -11
  77. package/lib/_modules/app-extended.index.d.ts +15 -12
  78. package/lib/_modules/app-extended.index.d.ts.map +1 -1
  79. package/lib/_modules/app-extended.index.js +23 -19
  80. package/lib/_modules/app-extended.index.js.map +1 -1
  81. package/lib/_modules/app.index.d.ts +13 -10
  82. package/lib/_modules/app.index.d.ts.map +1 -1
  83. package/lib/_modules/app.index.js +21 -17
  84. package/lib/_modules/app.index.js.map +1 -1
  85. package/lib/_modules/auth.index.d.ts +3 -3
  86. package/lib/_modules/auth.index.js +8 -8
  87. package/lib/_modules/constants.index.d.ts +1 -1
  88. package/lib/_modules/constants.index.js +4 -4
  89. package/lib/_modules/controller.index.d.ts +4 -4
  90. package/lib/_modules/controller.index.js +10 -10
  91. package/lib/_modules/custom-data/custom-data.controller.d.ts +5 -5
  92. package/lib/_modules/custom-data/custom-data.controller.js +55 -55
  93. package/lib/_modules/custom-data/custom-data.service.d.ts +5 -5
  94. package/lib/_modules/custom-data/custom-data.service.js +11 -11
  95. package/lib/_modules/custom-data/get-custom-data-routing-module.d.ts +3 -3
  96. package/lib/_modules/custom-data/get-custom-data-routing-module.js +17 -17
  97. package/lib/_modules/custom-data/index.d.ts +4 -4
  98. package/lib/_modules/custom-data/index.js +8 -8
  99. package/lib/_modules/custom-data-module.index.d.ts +1 -1
  100. package/lib/_modules/custom-data-module.index.js +4 -4
  101. package/lib/_modules/data-service.index.d.ts +5 -5
  102. package/lib/_modules/data-service.index.js +10 -10
  103. package/lib/_modules/email.index.d.ts +3 -3
  104. package/lib/_modules/email.index.js +8 -8
  105. package/lib/_modules/enums.index.d.ts +1 -1
  106. package/lib/_modules/enums.index.js +4 -4
  107. package/lib/_modules/models.index.d.ts +1 -1
  108. package/lib/_modules/models.index.js +4 -4
  109. package/lib/_modules/services.index.d.ts +1 -1
  110. package/lib/_modules/services.index.js +4 -4
  111. package/lib/_modules/test/get-test-routing-module.d.ts +3 -3
  112. package/lib/_modules/test/get-test-routing-module.js +17 -17
  113. package/lib/_modules/test/index.d.ts +3 -3
  114. package/lib/_modules/test/index.js +7 -7
  115. package/lib/_modules/test/test.controller.d.ts +5 -5
  116. package/lib/_modules/test/test.controller.js +104 -104
  117. package/lib/_modules/test-module.index.d.ts +1 -1
  118. package/lib/_modules/test-module.index.js +4 -4
  119. package/lib/_modules/usage/get-usage-routing-module.d.ts +3 -3
  120. package/lib/_modules/usage/get-usage-routing-module.js +17 -17
  121. package/lib/_modules/usage/index.d.ts +4 -4
  122. package/lib/_modules/usage/index.js +8 -8
  123. package/lib/_modules/usage/usage-controller.d.ts +6 -6
  124. package/lib/_modules/usage/usage-controller.js +88 -88
  125. package/lib/_modules/usage/usage.service.d.ts +16 -16
  126. package/lib/_modules/usage/usage.service.js +132 -132
  127. package/lib/_modules/usage-module.index.d.ts +1 -1
  128. package/lib/_modules/usage-module.index.js +4 -4
  129. package/lib/_services/dynamo-nts-api.service.d.ts +34 -34
  130. package/lib/_services/dynamo-nts-api.service.js +188 -188
  131. package/lib/_services/dynamo-nts-app-extended.d.ts +128 -128
  132. package/lib/_services/dynamo-nts-app-extended.d.ts.map +1 -1
  133. package/lib/_services/dynamo-nts-app-extended.js +212 -212
  134. package/lib/_services/dynamo-nts-app-extended.js.map +1 -1
  135. package/lib/_services/dynamo-nts-app.d.ts +270 -278
  136. package/lib/_services/dynamo-nts-app.d.ts.map +1 -1
  137. package/lib/_services/dynamo-nts-app.js +371 -371
  138. package/lib/_services/dynamo-nts-app.js.map +1 -1
  139. package/lib/_services/dynamo-nts-app.spec.d.ts +1 -0
  140. package/lib/_services/dynamo-nts-app.spec.d.ts.map +1 -0
  141. package/lib/_services/dynamo-nts-app.spec.js +10 -0
  142. package/lib/_services/dynamo-nts-app.spec.js.map +1 -0
  143. package/lib/_services/dynamo-nts-auth.service.d.ts +127 -127
  144. package/lib/_services/dynamo-nts-auth.service.d.ts.map +1 -1
  145. package/lib/_services/dynamo-nts-auth.service.js +53 -53
  146. package/lib/_services/dynamo-nts-auth.service.js.map +1 -1
  147. package/lib/_services/dynamo-nts-controller.service.d.ts +105 -105
  148. package/lib/_services/dynamo-nts-controller.service.d.ts.map +1 -1
  149. package/lib/_services/dynamo-nts-controller.service.js +57 -57
  150. package/lib/_services/dynamo-nts-controller.service.js.map +1 -1
  151. package/lib/_services/dynamo-nts-data.service.d.ts +230 -230
  152. package/lib/_services/dynamo-nts-data.service.d.ts.map +1 -1
  153. package/lib/_services/dynamo-nts-data.service.js +689 -689
  154. package/lib/_services/dynamo-nts-data.service.js.map +1 -1
  155. package/lib/_services/dynamo-nts-db-service-collection.service.d.ts +8 -8
  156. package/lib/_services/dynamo-nts-db-service-collection.service.js +10 -10
  157. package/lib/_services/dynamo-nts-db.service.d.ts +386 -312
  158. package/lib/_services/dynamo-nts-db.service.d.ts.map +1 -1
  159. package/lib/_services/dynamo-nts-db.service.js +856 -856
  160. package/lib/_services/dynamo-nts-db.service.js.map +1 -1
  161. package/lib/_services/dynamo-nts-email-service-collection.service.d.ts +18 -18
  162. package/lib/_services/dynamo-nts-email-service-collection.service.js +20 -20
  163. package/lib/_services/dynamo-nts-email.service.d.ts +56 -56
  164. package/lib/_services/dynamo-nts-email.service.d.ts.map +1 -1
  165. package/lib/_services/dynamo-nts-email.service.js +203 -203
  166. package/lib/_services/dynamo-nts-email.service.js.map +1 -1
  167. package/lib/_services/dynamo-nts-global.service.d.ts +71 -84
  168. package/lib/_services/dynamo-nts-global.service.d.ts.map +1 -1
  169. package/lib/_services/dynamo-nts-global.service.js +156 -156
  170. package/lib/_services/dynamo-nts-global.service.js.map +1 -1
  171. package/lib/_services/dynamo-nts-routing-module.service.d.ts +76 -76
  172. package/lib/_services/dynamo-nts-routing-module.service.d.ts.map +1 -1
  173. package/lib/_services/dynamo-nts-routing-module.service.js +191 -191
  174. package/lib/_services/dynamo-nts-routing-module.service.js.map +1 -1
  175. package/lib/_services/dynamo-nts-shared.service.d.ts +31 -31
  176. package/lib/_services/dynamo-nts-shared.service.d.ts.map +1 -1
  177. package/lib/_services/dynamo-nts-shared.service.js +70 -70
  178. package/lib/_services/dynamo-nts-shared.service.js.map +1 -1
  179. package/lib/_services/dynamo-nts-shared.service.spec.d.ts +2 -0
  180. package/lib/_services/dynamo-nts-shared.service.spec.d.ts.map +1 -0
  181. package/lib/_services/dynamo-nts-shared.service.spec.js +12 -0
  182. package/lib/_services/dynamo-nts-shared.service.spec.js.map +1 -0
  183. package/lib/_services/dynamo-nts-singleton.service.d.ts +8 -8
  184. package/lib/_services/dynamo-nts-singleton.service.js +18 -18
  185. package/lib/_services/dynamo-nts-singleton.service.js.map +1 -1
  186. package/lib/_services/dynamo-nts-socket-service-collection.service.d.ts +9 -9
  187. package/lib/_services/dynamo-nts-socket-service-collection.service.js +13 -13
  188. package/lib/_services/dynamo-nts-socket.service.d.ts +57 -45
  189. package/lib/_services/dynamo-nts-socket.service.d.ts.map +1 -1
  190. package/lib/_services/dynamo-nts-socket.service.js +188 -165
  191. package/lib/_services/dynamo-nts-socket.service.js.map +1 -1
  192. package/lib/_services/index.d.ts +14 -16
  193. package/lib/_services/index.d.ts.map +1 -1
  194. package/lib/_services/index.js +20 -20
  195. package/lib/_services/index.js.map +1 -1
  196. package/lib/index.d.ts +6 -6
  197. package/lib/index.js +14 -14
  198. package/lib/tsconfig.tsbuildinfo +1 -1
  199. package/package SAVE.json +216 -0
  200. package/package-NEW with test but not working.json +228 -0
  201. package/package.json +14 -8
  202. package/spec/support/jasmine.json +14 -0
  203. package/src/_enums/http/socket-event.enum.ts +2 -1
  204. package/src/_interfaces/certification-settings.interface.ts +7 -0
  205. package/src/_interfaces/global-service-settings.interface.ts +23 -0
  206. package/src/_interfaces/index.ts +5 -0
  207. package/src/_interfaces/port-settings.interface.ts +5 -0
  208. package/src/_models/dynamo-nts-socket-event-params.ts +23 -21
  209. package/src/_models/{dynamo-nts-socket-dictionary.ts → dynamo-nts-socket-presence.ts} +21 -5
  210. package/src/_models/dynamo-nts-socket-service-params.ts +1 -0
  211. package/src/_models/index.ts +2 -2
  212. package/src/_modules/app-extended.index.ts +7 -2
  213. package/src/_modules/app.index.ts +5 -0
  214. package/src/_services/dynamo-nts-app-extended.ts +6 -2
  215. package/src/_services/dynamo-nts-app.spec.ts +14 -0
  216. package/src/_services/dynamo-nts-app.ts +8 -14
  217. package/src/_services/dynamo-nts-auth.service.ts +1 -0
  218. package/src/_services/dynamo-nts-controller.service.ts +2 -1
  219. package/src/_services/dynamo-nts-data.service.ts +19 -19
  220. package/src/_services/dynamo-nts-db.service.ts +195 -115
  221. package/src/_services/dynamo-nts-email.service.ts +1 -0
  222. package/src/_services/dynamo-nts-global.service.ts +3 -18
  223. package/src/_services/dynamo-nts-routing-module.service.ts +1 -0
  224. package/src/_services/dynamo-nts-shared.service.spec.ts +10 -0
  225. package/src/_services/dynamo-nts-shared.service.ts +2 -1
  226. package/src/_services/dynamo-nts-socket.service.ts +80 -41
  227. package/src/_services/index.ts +2 -2
@@ -0,0 +1 @@
1
+ {"version":3,"file":"certification-settings.interface.js","sourceRoot":"","sources":["../../src/_interfaces/certification-settings.interface.ts"],"names":[],"mappings":""}
@@ -0,0 +1,18 @@
1
+ import { Dynamo_DataParams } from '@futdevpro/fsm-dynamo';
2
+ import { DynamoNTS_AuthService } from '../_services/dynamo-nts-auth.service';
3
+ import { DynamoNTS_EmailServiceCollection } from '../_services/dynamo-nts-email-service-collection.service';
4
+ export interface DynamoNTS_GlobalServiceSettings {
5
+ /**
6
+ * You need to setup your Own Auth Service extending the DynamoBEAuthService class
7
+ */
8
+ authService?: DynamoNTS_AuthService;
9
+ /**
10
+ * You can setup your Own Email Service extending the DynamoBEEmailServiceCollection class
11
+ */
12
+ emailServiceCollection?: DynamoNTS_EmailServiceCollection;
13
+ /**
14
+ * you can setup data tables by passing a DynamoBEDataParams list at this point
15
+ */
16
+ dbModels: Dynamo_DataParams[];
17
+ }
18
+ //# sourceMappingURL=global-service-settings.interface.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"global-service-settings.interface.d.ts","sourceRoot":"","sources":["../../src/_interfaces/global-service-settings.interface.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAC7E,OAAO,EAAE,gCAAgC,EAAE,MAAM,0DAA0D,CAAC;AAE5G,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,WAAW,CAAC,EAAE,qBAAqB,CAAC;IAEpC;;OAEG;IACH,sBAAsB,CAAC,EAAE,gCAAgC,CAAC;IAE1D;;OAEG;IACH,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=global-service-settings.interface.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"global-service-settings.interface.js","sourceRoot":"","sources":["../../src/_interfaces/global-service-settings.interface.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/_interfaces/index.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ //export * from './global-service-settings.interface';
2
+ //export * from './port-settings.interface';
3
+ //export * from './certification-settings.interface';
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/_interfaces/index.ts"],"names":[],"mappings":"AAEA,sDAAsD;AACtD,4CAA4C;AAC5C,qDAAqD"}
@@ -0,0 +1,5 @@
1
+ export interface DynamoNTS_PortSettings {
2
+ httpPort?: number;
3
+ httpsPort?: number;
4
+ }
5
+ //# sourceMappingURL=port-settings.interface.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"port-settings.interface.d.ts","sourceRoot":"","sources":["../../src/_interfaces/port-settings.interface.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=port-settings.interface.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"port-settings.interface.js","sourceRoot":"","sources":["../../src/_interfaces/port-settings.interface.ts"],"names":[],"mappings":""}
@@ -1,96 +1,96 @@
1
- import { HttpCallType } from "../_enums/http/http-call-type.enum";
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
- */
10
- export declare class DynamoNTS_ApiCallParams {
11
- /**
12
- * name the call to be able to identify it when debugging
13
- */
14
- name: string;
15
- /**
16
- * type of the call as; HttpCallType .get, .post, ...ect
17
- */
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
- */
24
- baseUrl: string;
25
- /**
26
- * baseUrl of the API;
27
- * 'https://futdevpro.hu/api'
28
- */
29
- endPoint: string;
30
- /**
31
- * if this value is true, the call will return the full HTTP call response in raw
32
- */
33
- getFullResponse: boolean;
34
- /**
35
- * this setting will be passed to the axios http call
36
- */
37
- httpOptions: any;
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
- */
46
- name: string;
47
- /**
48
- * set type as; HttpCallType .get, .post, ...ect
49
- */
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
- */
56
- endPoint: string;
57
- /**
58
- * baseUrl of the API;
59
- * 'https://futdevpro.hu/api'
60
- */
61
- baseUrl: string;
62
- /**
63
- * setting this value to true, will return the full HTTP call response in raw
64
- */
65
- getFullResponse?: boolean;
66
- /**
67
- * this setting will pass any kind of http setting used by the axios http messaging package
68
- */
69
- httpOptions?: HttpOptions;
70
- });
71
- }
72
- /**
73
- * basic axios HttpsOptions,
74
- *
75
- * learn more on axios package....
76
- * TOD: link package documentations
77
- */
78
- export declare class HttpOptions {
79
- responseType?: HttpResponseType;
80
- headers?: {
81
- [header: string]: string | string[];
82
- };
83
- observe?: 'body';
84
- reportProgress?: boolean;
85
- withCredentials?: boolean;
86
- constructor(set: {
87
- responseType?: HttpResponseType;
88
- headers?: {
89
- [header: string]: string | string[];
90
- };
91
- observe?: 'body';
92
- reportProgress?: boolean;
93
- withCredentials?: boolean;
94
- });
95
- }
1
+ import { HttpCallType } from "../_enums/http/http-call-type.enum";
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
+ */
10
+ export declare class DynamoNTS_ApiCallParams {
11
+ /**
12
+ * name the call to be able to identify it when debugging
13
+ */
14
+ name: string;
15
+ /**
16
+ * type of the call as; HttpCallType .get, .post, ...ect
17
+ */
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
+ */
24
+ baseUrl: string;
25
+ /**
26
+ * baseUrl of the API;
27
+ * 'https://futdevpro.hu/api'
28
+ */
29
+ endPoint: string;
30
+ /**
31
+ * if this value is true, the call will return the full HTTP call response in raw
32
+ */
33
+ getFullResponse: boolean;
34
+ /**
35
+ * this setting will be passed to the axios http call
36
+ */
37
+ httpOptions: any;
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
+ */
46
+ name: string;
47
+ /**
48
+ * set type as; HttpCallType .get, .post, ...ect
49
+ */
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
+ */
56
+ endPoint: string;
57
+ /**
58
+ * baseUrl of the API;
59
+ * 'https://futdevpro.hu/api'
60
+ */
61
+ baseUrl: string;
62
+ /**
63
+ * setting this value to true, will return the full HTTP call response in raw
64
+ */
65
+ getFullResponse?: boolean;
66
+ /**
67
+ * this setting will pass any kind of http setting used by the axios http messaging package
68
+ */
69
+ httpOptions?: HttpOptions;
70
+ });
71
+ }
72
+ /**
73
+ * basic axios HttpsOptions,
74
+ *
75
+ * learn more on axios package....
76
+ * TOD: link package documentations
77
+ */
78
+ export declare class HttpOptions {
79
+ responseType?: HttpResponseType;
80
+ headers?: {
81
+ [header: string]: string | string[];
82
+ };
83
+ observe?: 'body';
84
+ reportProgress?: boolean;
85
+ withCredentials?: boolean;
86
+ constructor(set: {
87
+ responseType?: HttpResponseType;
88
+ headers?: {
89
+ [header: string]: string | string[];
90
+ };
91
+ observe?: 'body';
92
+ reportProgress?: boolean;
93
+ withCredentials?: boolean;
94
+ });
95
+ }
96
96
  //# sourceMappingURL=dynamo-nts-api-call-params.d.ts.map
@@ -1,48 +1,48 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.HttpOptions = exports.DynamoNTS_ApiCallParams = void 0;
4
- const fsm_dynamo_1 = require("@futdevpro/fsm-dynamo");
5
- /**
6
- * API call params,
7
- * such as
8
- * type (HttpCallType),
9
- * endpoint,
10
- * and other options as httpOptions
11
- */
12
- class DynamoNTS_ApiCallParams {
13
- constructor(
14
- /**
15
- * set of options necessary for setting up an API call
16
- */
17
- set) {
18
- this.name = set.name;
19
- this.type = set.type;
20
- if (set.endPoint.includes('{')) {
21
- fsm_dynamo_1.Dynamo_Log.warn(`using {param} bracets in endpoint definitions will be deprecated... (${set.endPoint})` +
22
- 'use :param instead ({pathparam} --> :pathparam)');
23
- set.endPoint.replace(/{/g, ':').replace(/}/g, '');
24
- }
25
- this.endPoint = set.endPoint;
26
- this.baseUrl = set.baseUrl;
27
- this.getFullResponse = !!set.getFullResponse;
28
- this.httpOptions = set.httpOptions ? set.httpOptions : {};
29
- }
30
- }
31
- exports.DynamoNTS_ApiCallParams = DynamoNTS_ApiCallParams;
32
- /**
33
- * basic axios HttpsOptions,
34
- *
35
- * learn more on axios package....
36
- * TOD: link package documentations
37
- */
38
- class HttpOptions {
39
- constructor(set) {
40
- this.responseType = set.responseType;
41
- this.headers = set.headers;
42
- this.observe = set.observe;
43
- this.reportProgress = set.reportProgress;
44
- this.withCredentials = set.withCredentials;
45
- }
46
- }
47
- exports.HttpOptions = HttpOptions;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.HttpOptions = exports.DynamoNTS_ApiCallParams = void 0;
4
+ const fsm_dynamo_1 = require("@futdevpro/fsm-dynamo");
5
+ /**
6
+ * API call params,
7
+ * such as
8
+ * type (HttpCallType),
9
+ * endpoint,
10
+ * and other options as httpOptions
11
+ */
12
+ class DynamoNTS_ApiCallParams {
13
+ constructor(
14
+ /**
15
+ * set of options necessary for setting up an API call
16
+ */
17
+ set) {
18
+ this.name = set.name;
19
+ this.type = set.type;
20
+ if (set.endPoint.includes('{')) {
21
+ fsm_dynamo_1.Dynamo_Log.warn(`using {param} bracets in endpoint definitions will be deprecated... (${set.endPoint})` +
22
+ 'use :param instead ({pathparam} --> :pathparam)');
23
+ set.endPoint.replace(/{/g, ':').replace(/}/g, '');
24
+ }
25
+ this.endPoint = set.endPoint;
26
+ this.baseUrl = set.baseUrl;
27
+ this.getFullResponse = !!set.getFullResponse;
28
+ this.httpOptions = set.httpOptions ? set.httpOptions : {};
29
+ }
30
+ }
31
+ exports.DynamoNTS_ApiCallParams = DynamoNTS_ApiCallParams;
32
+ /**
33
+ * basic axios HttpsOptions,
34
+ *
35
+ * learn more on axios package....
36
+ * TOD: link package documentations
37
+ */
38
+ class HttpOptions {
39
+ constructor(set) {
40
+ this.responseType = set.responseType;
41
+ this.headers = set.headers;
42
+ this.observe = set.observe;
43
+ this.reportProgress = set.reportProgress;
44
+ this.withCredentials = set.withCredentials;
45
+ }
46
+ }
47
+ exports.HttpOptions = HttpOptions;
48
48
  //# sourceMappingURL=dynamo-nts-api-call-params.js.map
@@ -1,50 +1,50 @@
1
- /**
2
- * This will hold and set the basic settings of an application
3
- */
4
- export declare class DynamoNTS_AppParams {
5
- /**
6
- * name of the application
7
- */
8
- name: string;
9
- /**
10
- * title will be shown on the start of the application
11
- */
12
- title: string;
13
- /**
14
- * version of the application
15
- */
16
- version: string;
17
- /**
18
- * name of your MongoDB table
19
- */
20
- dbUri: string;
21
- /**
22
- * mongoDB uri, by default, its: `mongodb://localhost:27017/${this.dbName}`
23
- */
24
- dbName: string;
25
- constructor(set: {
26
- /**
27
- * name the application
28
- */
29
- name: string;
30
- /**
31
- * you can set a big f*in title to show on the start of the application
32
- */
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
- */
39
- version: string;
40
- /**
41
- * You need to name your MongoDB table
42
- */
43
- dbName: string;
44
- /**
45
- * you can change the mongoDB uri here. by default, its: `mongodb://localhost:27017/${this.dbName}`
46
- */
47
- dbUri?: string;
48
- });
49
- }
1
+ /**
2
+ * This will hold and set the basic settings of an application
3
+ */
4
+ export declare class DynamoNTS_AppParams {
5
+ /**
6
+ * name of the application
7
+ */
8
+ name: string;
9
+ /**
10
+ * title will be shown on the start of the application
11
+ */
12
+ title: string;
13
+ /**
14
+ * version of the application
15
+ */
16
+ version: string;
17
+ /**
18
+ * name of your MongoDB table
19
+ */
20
+ dbUri: string;
21
+ /**
22
+ * mongoDB uri, by default, its: `mongodb://localhost:27017/${this.dbName}`
23
+ */
24
+ dbName: string;
25
+ constructor(set: {
26
+ /**
27
+ * name the application
28
+ */
29
+ name: string;
30
+ /**
31
+ * you can set a big f*in title to show on the start of the application
32
+ */
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
+ */
39
+ version: string;
40
+ /**
41
+ * You need to name your MongoDB table
42
+ */
43
+ dbName: string;
44
+ /**
45
+ * you can change the mongoDB uri here. by default, its: `mongodb://localhost:27017/${this.dbName}`
46
+ */
47
+ dbUri?: string;
48
+ });
49
+ }
50
50
  //# sourceMappingURL=dynamo-nts-app-params.d.ts.map
@@ -1,18 +1,18 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DynamoNTS_AppParams = void 0;
4
- /**
5
- * This will hold and set the basic settings of an application
6
- */
7
- class DynamoNTS_AppParams {
8
- constructor(set) {
9
- var _a, _b;
10
- this.name = set.name;
11
- this.title = (_a = set.title) !== null && _a !== void 0 ? _a : '';
12
- this.version = set.version;
13
- this.dbName = set.dbName;
14
- this.dbUri = (_b = set.dbUri) !== null && _b !== void 0 ? _b : `mongodb://localhost:27017/${this.dbName}`;
15
- }
16
- }
17
- exports.DynamoNTS_AppParams = DynamoNTS_AppParams;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DynamoNTS_AppParams = void 0;
4
+ /**
5
+ * This will hold and set the basic settings of an application
6
+ */
7
+ class DynamoNTS_AppParams {
8
+ constructor(set) {
9
+ var _a, _b;
10
+ this.name = set.name;
11
+ this.title = (_a = set.title) !== null && _a !== void 0 ? _a : '';
12
+ this.version = set.version;
13
+ this.dbName = set.dbName;
14
+ this.dbUri = (_b = set.dbUri) !== null && _b !== void 0 ? _b : `mongodb://localhost:27017/${this.dbName}`;
15
+ }
16
+ }
17
+ exports.DynamoNTS_AppParams = DynamoNTS_AppParams;
18
18
  //# sourceMappingURL=dynamo-nts-app-params.js.map
@@ -1,81 +1,81 @@
1
- import { NextFunction, Request, Response } from 'express';
2
- import { HttpCallType } from '../_enums/http/http-call-type.enum';
3
- import { DynamoNTS_RouteSecurity } from '../_enums/dynamo-nts-route-security.enum';
4
- /**
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
8
- */
9
- export declare class DynamoNTS_EndpointParams {
10
- name: string;
11
- security: DynamoNTS_RouteSecurity;
12
- type: HttpCallType;
13
- endpoint: string;
14
- pathParams: string[];
15
- preProcessess: ((req: Request, res: Response, next: NextFunction) => Promise<void>)[];
16
- tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[];
17
- logRequest: boolean;
18
- logRequestsContent: boolean;
19
- logResponseContent: boolean;
20
- constructor(set: {
21
- /**
22
- * naming the endpoint will help to follow events on service
23
- */
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
- */
30
- security?: DynamoNTS_RouteSecurity;
31
- /**
32
- * define basic Http Call Type such as; get, post, put, patch, delete
33
- */
34
- type: HttpCallType;
35
- /**
36
- * set endpoint here, without baseUrl and route module path
37
- *
38
- * like: '/get-user/:userId'
39
- */
40
- endpoint: string;
41
- /**
42
- * preprocesses are the functions you need to run before the actual function,
43
- * such as authentications
44
- */
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
- */
50
- tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[];
51
- /**
52
- * this flag will enable the debug logs on this endpoint
53
- */
54
- logRequest?: boolean;
55
- /**
56
- * this flag will enable the debug logs on this endpoint's requests
57
- */
58
- logRequestsContent?: boolean;
59
- /**
60
- * this flag will enable detailed debug logs on this endpoint's requests
61
- */
62
- logResponseContent?: boolean;
63
- });
64
- /**
65
- *
66
- * @returns
67
- */
68
- getPreLog(): (req: Request, res: Response, next: NextFunction) => Promise<void>;
69
- /**
70
- *
71
- * @returns
72
- */
73
- getTasksExecution(): (req: Request, res: Response) => Promise<void>;
74
- /**
75
- *
76
- * @param res
77
- * @param error
78
- */
79
- error(res: Response, error: any): void;
80
- }
1
+ import { NextFunction, Request, Response } from 'express';
2
+ import { HttpCallType } from '../_enums/http/http-call-type.enum';
3
+ import { DynamoNTS_RouteSecurity } from '../_enums/dynamo-nts-route-security.enum';
4
+ /**
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
8
+ */
9
+ export declare class DynamoNTS_EndpointParams {
10
+ name: string;
11
+ security: DynamoNTS_RouteSecurity;
12
+ type: HttpCallType;
13
+ endpoint: string;
14
+ pathParams: string[];
15
+ preProcessess: ((req: Request, res: Response, next: NextFunction) => Promise<void>)[];
16
+ tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[];
17
+ logRequest: boolean;
18
+ logRequestsContent: boolean;
19
+ logResponseContent: boolean;
20
+ constructor(set: {
21
+ /**
22
+ * naming the endpoint will help to follow events on service
23
+ */
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
+ */
30
+ security?: DynamoNTS_RouteSecurity;
31
+ /**
32
+ * define basic Http Call Type such as; get, post, put, patch, delete
33
+ */
34
+ type: HttpCallType;
35
+ /**
36
+ * set endpoint here, without baseUrl and route module path
37
+ *
38
+ * like: '/get-user/:userId'
39
+ */
40
+ endpoint: string;
41
+ /**
42
+ * preprocesses are the functions you need to run before the actual function,
43
+ * such as authentications
44
+ */
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
+ */
50
+ tasks: ((req: Request, res: Response, issuer?: string) => Promise<void>)[];
51
+ /**
52
+ * this flag will enable the debug logs on this endpoint
53
+ */
54
+ logRequest?: boolean;
55
+ /**
56
+ * this flag will enable the debug logs on this endpoint's requests
57
+ */
58
+ logRequestsContent?: boolean;
59
+ /**
60
+ * this flag will enable detailed debug logs on this endpoint's requests
61
+ */
62
+ logResponseContent?: boolean;
63
+ });
64
+ /**
65
+ *
66
+ * @returns
67
+ */
68
+ getPreLog(): (req: Request, res: Response, next: NextFunction) => Promise<void>;
69
+ /**
70
+ *
71
+ * @returns
72
+ */
73
+ getTasksExecution(): (req: Request, res: Response) => Promise<void>;
74
+ /**
75
+ *
76
+ * @param res
77
+ * @param error
78
+ */
79
+ error(res: Response, error: any): void;
80
+ }
81
81
  //# sourceMappingURL=dynamo-nts-endpoint-params.d.ts.map