@breautek/storm 4.6.2 → 4.6.3

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 (69) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/docs/README.md +5 -5
  3. package/docs/classes/Application.md +53 -53
  4. package/docs/classes/BackendAuthenticationMiddleware.md +2 -2
  5. package/docs/classes/CORSMiddleware.md +6 -6
  6. package/docs/classes/ConfigLoader.md +1 -1
  7. package/docs/classes/Database.md +12 -12
  8. package/docs/classes/DatabaseCastObject.md +3 -3
  9. package/docs/classes/DatabaseConnection.md +19 -19
  10. package/docs/classes/DatabaseQueryError.md +16 -16
  11. package/docs/classes/DeadLockError.md +16 -16
  12. package/docs/classes/DiskSpaceError.md +16 -16
  13. package/docs/classes/DropTemporaryTableQuery.md +8 -8
  14. package/docs/classes/DumpStream.md +1 -1
  15. package/docs/classes/DuplicateEntryError.md +16 -16
  16. package/docs/classes/EntityNotFoundError.md +16 -16
  17. package/docs/classes/ExpiredTokenError.md +16 -16
  18. package/docs/classes/Handler.md +14 -14
  19. package/docs/classes/InternalError.md +16 -16
  20. package/docs/classes/InvalidCredentialsError.md +16 -16
  21. package/docs/classes/InvalidValueError.md +16 -16
  22. package/docs/classes/LineString.md +4 -4
  23. package/docs/classes/ManagedDatabaseConnection.md +19 -19
  24. package/docs/classes/Middleware.md +3 -3
  25. package/docs/classes/MissingConfigError.md +16 -16
  26. package/docs/classes/MissingParameterError.md +16 -16
  27. package/docs/classes/MySQLConnection.md +20 -20
  28. package/docs/classes/MySQLDatabase.md +13 -13
  29. package/docs/classes/NotImplementedError.md +16 -16
  30. package/docs/classes/Point.md +4 -4
  31. package/docs/classes/Polygon.md +4 -4
  32. package/docs/classes/Query.md +8 -8
  33. package/docs/classes/RawError.md +16 -16
  34. package/docs/classes/RawQuery.md +8 -8
  35. package/docs/classes/Request.md +18 -18
  36. package/docs/classes/Response.md +11 -11
  37. package/docs/classes/ResponseData.md +7 -7
  38. package/docs/classes/ServiceProvider.md +15 -15
  39. package/docs/classes/ServiceResponse.md +4 -4
  40. package/docs/classes/SetSessionVariableQuery.md +8 -8
  41. package/docs/classes/StormError.md +16 -16
  42. package/docs/classes/TemporaryTableQuery.md +8 -8
  43. package/docs/classes/Token.md +2 -2
  44. package/docs/classes/TokenManager.md +4 -4
  45. package/docs/classes/UnauthorizedAccessError.md +16 -16
  46. package/docs/enums/ErrorCode.md +9 -9
  47. package/docs/enums/ExitCode.md +2 -2
  48. package/docs/enums/HTTPMethod.md +4 -4
  49. package/docs/enums/IsolationLevel.md +4 -4
  50. package/docs/enums/JWTError.md +2 -2
  51. package/docs/enums/StatusCode.md +48 -48
  52. package/docs/interfaces/IConfig.md +8 -8
  53. package/docs/interfaces/IDatabaseConfig.md +6 -6
  54. package/docs/interfaces/IDatabaseConnection.md +14 -14
  55. package/docs/interfaces/IErrorResponse.md +5 -5
  56. package/docs/interfaces/IFormData.md +2 -2
  57. package/docs/interfaces/IHandler.md +1 -1
  58. package/docs/interfaces/IInsertQueryResult.md +3 -3
  59. package/docs/interfaces/IJWTVerifyOptions.md +1 -1
  60. package/docs/interfaces/IRequestResponse.md +2 -2
  61. package/docs/interfaces/ISetSessionVariableQueryInput.md +2 -2
  62. package/docs/interfaces/ITemporaryTableQueryInput.md +2 -2
  63. package/docs/interfaces/IUpdateQueryResult.md +2 -2
  64. package/docs/interfaces/formidable.Part.md +17 -17
  65. package/lib/Handler.d.ts +2 -2
  66. package/lib/IDeleteQueryResult.d.ts +1 -1
  67. package/lib/Response.d.ts +1 -1
  68. package/lib/TCoordinate.d.ts +1 -1
  69. package/package.json +18 -18
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/IFormData.ts:20](https://github.com/breautek/storm/blob/4b2254f/src/IFormData.ts#L20)
20
+ [src/IFormData.ts:20](https://github.com/breautek/storm/blob/5fbba2d/src/IFormData.ts#L20)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/IFormData.ts:21](https://github.com/breautek/storm/blob/4b2254f/src/IFormData.ts#L21)
30
+ [src/IFormData.ts:21](https://github.com/breautek/storm/blob/5fbba2d/src/IFormData.ts#L21)
@@ -28,4 +28,4 @@
28
28
 
29
29
  #### Defined in
30
30
 
31
- [src/IHandler.ts:21](https://github.com/breautek/storm/blob/4b2254f/src/IHandler.ts#L21)
31
+ [src/IHandler.ts:21](https://github.com/breautek/storm/blob/5fbba2d/src/IHandler.ts#L21)
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [src/IInsertQueryResult.ts:19](https://github.com/breautek/storm/blob/4b2254f/src/IInsertQueryResult.ts#L19)
21
+ [src/IInsertQueryResult.ts:19](https://github.com/breautek/storm/blob/5fbba2d/src/IInsertQueryResult.ts#L19)
22
22
 
23
23
  ___
24
24
 
@@ -28,7 +28,7 @@ ___
28
28
 
29
29
  #### Defined in
30
30
 
31
- [src/IInsertQueryResult.ts:20](https://github.com/breautek/storm/blob/4b2254f/src/IInsertQueryResult.ts#L20)
31
+ [src/IInsertQueryResult.ts:20](https://github.com/breautek/storm/blob/5fbba2d/src/IInsertQueryResult.ts#L20)
32
32
 
33
33
  ___
34
34
 
@@ -38,4 +38,4 @@ ___
38
38
 
39
39
  #### Defined in
40
40
 
41
- [src/IInsertQueryResult.ts:18](https://github.com/breautek/storm/blob/4b2254f/src/IInsertQueryResult.ts#L18)
41
+ [src/IInsertQueryResult.ts:18](https://github.com/breautek/storm/blob/5fbba2d/src/IInsertQueryResult.ts#L18)
@@ -16,4 +16,4 @@
16
16
 
17
17
  #### Defined in
18
18
 
19
- [src/IJWTVerifyOptions.ts:18](https://github.com/breautek/storm/blob/4b2254f/src/IJWTVerifyOptions.ts#L18)
19
+ [src/IJWTVerifyOptions.ts:18](https://github.com/breautek/storm/blob/5fbba2d/src/IJWTVerifyOptions.ts#L18)
@@ -24,7 +24,7 @@
24
24
 
25
25
  #### Defined in
26
26
 
27
- [src/IRequestResponse.ts:21](https://github.com/breautek/storm/blob/4b2254f/src/IRequestResponse.ts#L21)
27
+ [src/IRequestResponse.ts:21](https://github.com/breautek/storm/blob/5fbba2d/src/IRequestResponse.ts#L21)
28
28
 
29
29
  ___
30
30
 
@@ -34,4 +34,4 @@ ___
34
34
 
35
35
  #### Defined in
36
36
 
37
- [src/IRequestResponse.ts:22](https://github.com/breautek/storm/blob/4b2254f/src/IRequestResponse.ts#L22)
37
+ [src/IRequestResponse.ts:22](https://github.com/breautek/storm/blob/5fbba2d/src/IRequestResponse.ts#L22)
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/SetSessionVariableQuery.ts:7](https://github.com/breautek/storm/blob/4b2254f/src/SetSessionVariableQuery.ts#L7)
20
+ [src/SetSessionVariableQuery.ts:7](https://github.com/breautek/storm/blob/5fbba2d/src/SetSessionVariableQuery.ts#L7)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/SetSessionVariableQuery.ts:8](https://github.com/breautek/storm/blob/4b2254f/src/SetSessionVariableQuery.ts#L8)
30
+ [src/SetSessionVariableQuery.ts:8](https://github.com/breautek/storm/blob/5fbba2d/src/SetSessionVariableQuery.ts#L8)
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/TemporaryTableQuery.ts:22](https://github.com/breautek/storm/blob/4b2254f/src/TemporaryTableQuery.ts#L22)
20
+ [src/TemporaryTableQuery.ts:22](https://github.com/breautek/storm/blob/5fbba2d/src/TemporaryTableQuery.ts#L22)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/TemporaryTableQuery.ts:21](https://github.com/breautek/storm/blob/4b2254f/src/TemporaryTableQuery.ts#L21)
30
+ [src/TemporaryTableQuery.ts:21](https://github.com/breautek/storm/blob/5fbba2d/src/TemporaryTableQuery.ts#L21)
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [src/IUpdateQueryResult.ts:18](https://github.com/breautek/storm/blob/4b2254f/src/IUpdateQueryResult.ts#L18)
20
+ [src/IUpdateQueryResult.ts:18](https://github.com/breautek/storm/blob/5fbba2d/src/IUpdateQueryResult.ts#L18)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [src/IUpdateQueryResult.ts:19](https://github.com/breautek/storm/blob/4b2254f/src/IUpdateQueryResult.ts#L19)
30
+ [src/IUpdateQueryResult.ts:19](https://github.com/breautek/storm/blob/5fbba2d/src/IUpdateQueryResult.ts#L19)
@@ -107,13 +107,13 @@ Stream.addListener
107
107
 
108
108
  #### Defined in
109
109
 
110
- node_modules/@types/node/ts4.8/events.d.ts:354
110
+ node_modules/@types/node/events.d.ts:354
111
111
 
112
112
  ___
113
113
 
114
114
  ### emit
115
115
 
116
- ▸ **emit**(`eventName`, ...`args`): `boolean`
116
+ ▸ **emit**(`eventName`, `...args`): `boolean`
117
117
 
118
118
  Synchronously calls each of the listeners registered for the event named`eventName`, in the order they were registered, passing the supplied arguments
119
119
  to each.
@@ -174,7 +174,7 @@ Stream.emit
174
174
 
175
175
  #### Defined in
176
176
 
177
- node_modules/@types/node/ts4.8/events.d.ts:610
177
+ node_modules/@types/node/events.d.ts:610
178
178
 
179
179
  ___
180
180
 
@@ -212,7 +212,7 @@ Stream.eventNames
212
212
 
213
213
  #### Defined in
214
214
 
215
- node_modules/@types/node/ts4.8/events.d.ts:669
215
+ node_modules/@types/node/events.d.ts:669
216
216
 
217
217
  ___
218
218
 
@@ -237,7 +237,7 @@ Stream.getMaxListeners
237
237
 
238
238
  #### Defined in
239
239
 
240
- node_modules/@types/node/ts4.8/events.d.ts:526
240
+ node_modules/@types/node/events.d.ts:526
241
241
 
242
242
  ___
243
243
 
@@ -267,7 +267,7 @@ Stream.listenerCount
267
267
 
268
268
  #### Defined in
269
269
 
270
- node_modules/@types/node/ts4.8/events.d.ts:616
270
+ node_modules/@types/node/events.d.ts:616
271
271
 
272
272
  ___
273
273
 
@@ -305,7 +305,7 @@ Stream.listeners
305
305
 
306
306
  #### Defined in
307
307
 
308
- node_modules/@types/node/ts4.8/events.d.ts:539
308
+ node_modules/@types/node/events.d.ts:539
309
309
 
310
310
  ___
311
311
 
@@ -336,7 +336,7 @@ Stream.off
336
336
 
337
337
  #### Defined in
338
338
 
339
- node_modules/@types/node/ts4.8/events.d.ts:499
339
+ node_modules/@types/node/events.d.ts:499
340
340
 
341
341
  ___
342
342
 
@@ -391,7 +391,7 @@ Stream.on
391
391
 
392
392
  #### Defined in
393
393
 
394
- node_modules/@types/node/ts4.8/events.d.ts:385
394
+ node_modules/@types/node/events.d.ts:385
395
395
 
396
396
  ___
397
397
 
@@ -444,7 +444,7 @@ Stream.once
444
444
 
445
445
  #### Defined in
446
446
 
447
- node_modules/@types/node/ts4.8/events.d.ts:414
447
+ node_modules/@types/node/events.d.ts:414
448
448
 
449
449
  ___
450
450
 
@@ -476,7 +476,7 @@ Stream.pipe
476
476
 
477
477
  #### Defined in
478
478
 
479
- node_modules/@types/node/ts4.8/stream.d.ts:26
479
+ node_modules/@types/node/stream.d.ts:26
480
480
 
481
481
  ___
482
482
 
@@ -518,7 +518,7 @@ Stream.prependListener
518
518
 
519
519
  #### Defined in
520
520
 
521
- node_modules/@types/node/ts4.8/events.d.ts:634
521
+ node_modules/@types/node/events.d.ts:634
522
522
 
523
523
  ___
524
524
 
@@ -558,7 +558,7 @@ Stream.prependOnceListener
558
558
 
559
559
  #### Defined in
560
560
 
561
- node_modules/@types/node/ts4.8/events.d.ts:650
561
+ node_modules/@types/node/events.d.ts:650
562
562
 
563
563
  ___
564
564
 
@@ -613,7 +613,7 @@ Stream.rawListeners
613
613
 
614
614
  #### Defined in
615
615
 
616
- node_modules/@types/node/ts4.8/events.d.ts:569
616
+ node_modules/@types/node/events.d.ts:569
617
617
 
618
618
  ___
619
619
 
@@ -649,7 +649,7 @@ Stream.removeAllListeners
649
649
 
650
650
  #### Defined in
651
651
 
652
- node_modules/@types/node/ts4.8/events.d.ts:510
652
+ node_modules/@types/node/events.d.ts:510
653
653
 
654
654
  ___
655
655
 
@@ -755,7 +755,7 @@ Stream.removeListener
755
755
 
756
756
  #### Defined in
757
757
 
758
- node_modules/@types/node/ts4.8/events.d.ts:494
758
+ node_modules/@types/node/events.d.ts:494
759
759
 
760
760
  ___
761
761
 
@@ -790,4 +790,4 @@ Stream.setMaxListeners
790
790
 
791
791
  #### Defined in
792
792
 
793
- node_modules/@types/node/ts4.8/events.d.ts:520
793
+ node_modules/@types/node/events.d.ts:520
package/lib/Handler.d.ts CHANGED
@@ -17,7 +17,7 @@ import { ReadStream } from 'fs';
17
17
  * - Buffers will be passed through
18
18
  * - Any other object will be passed through JSON.stringify
19
19
  */
20
- export declare type IHandlerResponse = ResponseData | ReadableStream | ReadStream | any | void;
20
+ export type IHandlerResponse = ResponseData | ReadableStream | ReadStream | any | void;
21
21
  /**
22
22
  * Like IHandlerResponse, an IHandlerError can be any arbitrary type of object,
23
23
  * however it's recommended that the type be of a StormError.
@@ -25,7 +25,7 @@ export declare type IHandlerResponse = ResponseData | ReadableStream | ReadStrea
25
25
  * If the type is not a StormError, the error will be wrapped in an InternalError object.
26
26
  * This is to avoid accidental leakage of privilege data (e.g. snippets of database queries with sensitive information)
27
27
  */
28
- export declare type IHandlerError = StormError | Error | any;
28
+ export type IHandlerError = StormError | Error | any;
29
29
  export declare class Handler<TApplication extends Application = Application, TGetRequest = any, TGetResponse = IHandlerResponse, TPostRequest = any, TPostResponse = IHandlerResponse, TPutRequest = any, TPutResponse = IHandlerResponse, TDeleteRequest = any, TDeleteResponse = IHandlerResponse> {
30
30
  private $app;
31
31
  private $middlewares;
@@ -1,2 +1,2 @@
1
1
  import { IUpdateQueryResult } from './IUpdateQueryResult';
2
- export declare type IDeleteQueryResult = IUpdateQueryResult;
2
+ export type IDeleteQueryResult = IUpdateQueryResult;
package/lib/Response.d.ts CHANGED
@@ -4,7 +4,7 @@ import { StatusCode } from './StatusCode';
4
4
  import { ResponseData } from './ResponseData';
5
5
  import { StormError, IErrorResponse } from './StormError';
6
6
  import * as express from 'express';
7
- export declare type SendableData = ResponseData | Error | IErrorResponse | Buffer | any;
7
+ export type SendableData = ResponseData | Error | IErrorResponse | Buffer | any;
8
8
  export interface IHeaderKeyValuePair {
9
9
  [key: string]: string;
10
10
  }
@@ -1 +1 @@
1
- export declare type TCoordinate = [x: number, y: number];
1
+ export type TCoordinate = [x: number, y: number];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@breautek/storm",
3
- "version": "4.6.2",
3
+ "version": "4.6.3",
4
4
  "description": "Object-Oriented REST API framework",
5
5
  "main": "lib/api.js",
6
6
  "types": "lib/api.d.ts",
@@ -46,22 +46,22 @@
46
46
  "@arashi/token": "1.0.1",
47
47
  "@breautek/merge-change": "1.0.0",
48
48
  "@types/body-parser": "1.19.2",
49
- "@types/express": "4.17.14",
49
+ "@types/express": "4.17.15",
50
50
  "@types/formidable": "1.2.3",
51
- "@types/jsonwebtoken": "8.5.9",
51
+ "@types/jsonwebtoken": "9.0.0",
52
52
  "@types/mysql": "2.15.21",
53
- "@types/node": "18.11.7",
54
- "@types/uuid": "8.3.4",
55
- "ajv": "8.11.0",
53
+ "@types/node": "18.11.18",
54
+ "@types/uuid": "9.0.0",
55
+ "ajv": "8.12.0",
56
56
  "body-parser": "1.20.1",
57
57
  "commander": "8.3.0",
58
58
  "express": "4.18.2",
59
59
  "form-data": "4.0.0",
60
60
  "formidable": "1.2.2",
61
- "jsonwebtoken": "8.5.1",
61
+ "jsonwebtoken": "9.0.0",
62
62
  "mysql": "2.18.1",
63
63
  "sql-formatter": "4.0.2",
64
- "tslib": "2.4.0",
64
+ "tslib": "2.4.1",
65
65
  "uuid": "9.0.0"
66
66
  },
67
67
  "peerDependencies": {
@@ -69,18 +69,18 @@
69
69
  },
70
70
  "devDependencies": {
71
71
  "@arashi/logger": "2.1.0",
72
- "@totalpave/eslint-plugin": "6.0.4",
73
- "@types/jest": "29.2.0",
74
- "@typescript-eslint/eslint-plugin": "5.41.0",
75
- "@typescript-eslint/parser": "5.41.0",
72
+ "@totalpave/eslint-plugin": "6.0.6",
73
+ "@types/jest": "29.2.5",
74
+ "@typescript-eslint/eslint-plugin": "5.48.0",
75
+ "@typescript-eslint/parser": "5.48.0",
76
76
  "auto-changelog": "2.4.0",
77
- "eslint": "8.26.0",
78
- "jest": "29.2.2",
79
- "jest-jasmine2": "29.2.2",
77
+ "eslint": "8.31.0",
78
+ "jest": "29.3.1",
79
+ "jest-jasmine2": "29.3.1",
80
80
  "ts-jest": "29.0.3",
81
81
  "ts-node": "10.9.1",
82
- "typedoc": "0.23.18",
83
- "typedoc-plugin-markdown": "3.13.6",
84
- "typescript": "4.8.4"
82
+ "typedoc": "0.23.23",
83
+ "typedoc-plugin-markdown": "3.14.0",
84
+ "typescript": "4.9.4"
85
85
  }
86
86
  }