@rsdk/common 2.4.2 → 2.6.0-next.12

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 (80) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/dist/functions/misc.d.ts +0 -16
  3. package/dist/functions/misc.js +1 -30
  4. package/dist/functions/misc.js.map +1 -1
  5. package/dist/index.d.ts +1 -4
  6. package/dist/index.js +1 -17
  7. package/dist/index.js.map +1 -1
  8. package/dist/size/size.class.js +2 -2
  9. package/dist/size/size.class.js.map +1 -1
  10. package/dist/strings/capitalize.fn.d.ts +7 -0
  11. package/dist/{functions/capitalize.js → strings/capitalize.fn.js} +7 -1
  12. package/dist/strings/capitalize.fn.js.map +1 -0
  13. package/dist/strings/case.d.ts +15 -0
  14. package/dist/strings/case.js +24 -0
  15. package/dist/strings/case.js.map +1 -0
  16. package/dist/strings/index.d.ts +3 -0
  17. package/dist/{serialization/errors → strings}/index.js +3 -3
  18. package/dist/strings/index.js.map +1 -0
  19. package/dist/strings/text.fn.d.ts +10 -0
  20. package/dist/strings/text.fn.js +21 -0
  21. package/dist/strings/text.fn.js.map +1 -0
  22. package/dist/time/timespan.class.d.ts +12 -5
  23. package/dist/time/timespan.class.js +32 -19
  24. package/dist/time/timespan.class.js.map +1 -1
  25. package/package.json +4 -6
  26. package/src/functions/misc.ts +0 -40
  27. package/src/index.ts +1 -5
  28. package/src/size/size.class.ts +1 -1
  29. package/src/strings/capitalize.fn.ts +8 -0
  30. package/src/strings/case.ts +20 -0
  31. package/src/strings/index.ts +3 -0
  32. package/src/strings/text.fn.ts +21 -0
  33. package/src/time/timespan.class.ts +35 -29
  34. package/src/time/timespan.spec.ts +28 -1
  35. package/dist/functions/capitalize.d.ts +0 -1
  36. package/dist/functions/capitalize.js.map +0 -1
  37. package/dist/serialization/errors/index.d.ts +0 -3
  38. package/dist/serialization/errors/index.js.map +0 -1
  39. package/dist/serialization/errors/not-absolute-path.error.d.ts +0 -3
  40. package/dist/serialization/errors/not-absolute-path.error.js +0 -10
  41. package/dist/serialization/errors/not-absolute-path.error.js.map +0 -1
  42. package/dist/serialization/errors/unknown-file-ext.error.d.ts +0 -3
  43. package/dist/serialization/errors/unknown-file-ext.error.js +0 -10
  44. package/dist/serialization/errors/unknown-file-ext.error.js.map +0 -1
  45. package/dist/serialization/errors/unknown-format.error.d.ts +0 -5
  46. package/dist/serialization/errors/unknown-format.error.js +0 -11
  47. package/dist/serialization/errors/unknown-format.error.js.map +0 -1
  48. package/dist/serialization/index.d.ts +0 -5
  49. package/dist/serialization/index.js +0 -22
  50. package/dist/serialization/index.js.map +0 -1
  51. package/dist/serialization/read-obj-sync.d.ts +0 -9
  52. package/dist/serialization/read-obj-sync.js +0 -25
  53. package/dist/serialization/read-obj-sync.js.map +0 -1
  54. package/dist/serialization/read-obj.d.ts +0 -8
  55. package/dist/serialization/read-obj.js +0 -24
  56. package/dist/serialization/read-obj.js.map +0 -1
  57. package/dist/serialization/reviving-serializer.d.ts +0 -8
  58. package/dist/serialization/reviving-serializer.js +0 -30
  59. package/dist/serialization/reviving-serializer.js.map +0 -1
  60. package/dist/serialization/save-obj.d.ts +0 -10
  61. package/dist/serialization/save-obj.js +0 -25
  62. package/dist/serialization/save-obj.js.map +0 -1
  63. package/dist/serialization/serializer.class.d.ts +0 -14
  64. package/dist/serialization/serializer.class.js +0 -65
  65. package/dist/serialization/serializer.class.js.map +0 -1
  66. package/dist/types/nest-module-definition.d.ts +0 -3
  67. package/dist/types/nest-module-definition.js +0 -3
  68. package/dist/types/nest-module-definition.js.map +0 -1
  69. package/src/functions/capitalize.ts +0 -2
  70. package/src/serialization/errors/index.ts +0 -3
  71. package/src/serialization/errors/not-absolute-path.error.ts +0 -5
  72. package/src/serialization/errors/unknown-file-ext.error.ts +0 -5
  73. package/src/serialization/errors/unknown-format.error.ts +0 -9
  74. package/src/serialization/index.ts +0 -5
  75. package/src/serialization/read-obj-sync.ts +0 -24
  76. package/src/serialization/read-obj.ts +0 -23
  77. package/src/serialization/reviving-serializer.ts +0 -32
  78. package/src/serialization/save-obj.ts +0 -31
  79. package/src/serialization/serializer.class.ts +0 -85
  80. package/src/types/nest-module-definition.ts +0 -5
@@ -1,41 +1,38 @@
1
1
  /* eslint-disable @typescript-eslint/no-non-null-assertion */
2
2
 
3
- import { text } from '../functions';
3
+ import { Convert } from '../convert';
4
+ import { text } from '../strings';
4
5
 
5
- type Unit = 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days';
6
- type UnitAlias = 'd' | 'h' | 'm' | 's' | 'ms';
7
- type TimespanString = `${number}${Unit | UnitAlias}`;
6
+ export type Unit = 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days';
7
+ export type UnitAlias = 'd' | 'h' | 'm' | 's' | 'ms';
8
+ export type TimespanString = `${number}${Unit | UnitAlias}`;
8
9
 
9
10
  const factors: Record<Unit, number> = {
10
11
  milliseconds: 1,
11
- seconds: 1_000,
12
-
13
- minutes: 1_000 * 60,
14
-
15
- hours: 1_000 * 60 * 60,
16
-
17
- days: 1_000 * 60 * 60 * 24,
12
+ seconds: 1 * 1_000,
13
+ minutes: 1 * 1_000 * 60,
14
+ hours: 1 * 1_000 * 60 * 60,
15
+ days: 1 * 1_000 * 60 * 60 * 24,
18
16
  };
19
17
 
20
18
  const aliasesToUnits: Record<UnitAlias, Unit> = {
21
- d: 'days',
22
- h: 'hours',
23
- m: 'minutes',
24
- s: 'seconds',
25
-
26
19
  ms: 'milliseconds',
20
+ s: 'seconds',
21
+ m: 'minutes',
22
+ h: 'hours',
23
+ d: 'days',
27
24
  };
28
25
 
29
26
  export const unitsToAliases: Record<Unit, UnitAlias> = {
30
- days: 'd',
31
- hours: 'h',
32
- minutes: 'm',
33
- seconds: 's',
34
-
35
27
  milliseconds: 'ms',
28
+ seconds: 's',
29
+ minutes: 'm',
30
+ hours: 'h',
31
+ days: 'd',
36
32
  };
37
33
 
38
- export const TIMESPAN_STRING_PATTERN = /^(\d{1,10})(h|m|s|ms|d)$/i;
34
+ // Exported pattern should be string to easier serialization
35
+ export const TIMESPAN_STRING_PATTERN = /^(-?\d{1,10}(\.\d{1,10})?)(h|H|m|M|s|S|ms|MS|d|D)$/;
39
36
 
40
37
  class InvalidTimespan extends Error {
41
38
  constructor(str: string) {
@@ -43,7 +40,7 @@ class InvalidTimespan extends Error {
43
40
  Invalid timespan string: <${str}>.
44
41
  Timespan string should contain numeric and unit parts.
45
42
  Acceptable units: D, H, M, S, MS (case doesn't matter).
46
- Ex: "30D, 10H, 2M, 100MS"
43
+ Ex: "30D, 10H, 2M, 100MS, 0.1s, -5d"
47
44
  `);
48
45
  }
49
46
  }
@@ -52,12 +49,22 @@ class InvalidTimespan extends Error {
52
49
  * Represents time period (duration)
53
50
  */
54
51
  export class Timespan {
52
+ /**
53
+ * Time in milliseconds
54
+ */
55
55
  private readonly _millis: number;
56
56
 
57
+ /**
58
+ * Original unit that was passed to
59
+ * constructor
60
+ */
61
+ private readonly _unit: Unit;
62
+
57
63
  constructor(value: number, u: Unit | UnitAlias) {
58
64
  const unit = this.isUnit(u) ? u : aliasesToUnits[u];
59
65
 
60
66
  this._millis = value * factors[unit];
67
+ this._unit = unit;
61
68
  }
62
69
 
63
70
  static parse(str: string): Timespan {
@@ -67,9 +74,10 @@ export class Timespan {
67
74
  throw new InvalidTimespan(str);
68
75
  }
69
76
 
70
- const [, rawValue, rawUnit] = match;
77
+ const rawValue = match[1];
78
+ const rawUnit = match[3] || match[2]; // Will be 3 if value has decimal point
71
79
 
72
- const value = Number.parseInt(rawValue, 10);
80
+ const value = Convert.number(rawValue);
73
81
  const unit = aliasesToUnits[rawUnit.toLowerCase() as UnitAlias];
74
82
 
75
83
  return new Timespan(value, unit);
@@ -126,18 +134,16 @@ export class Timespan {
126
134
  * Subtract time from timespan
127
135
  */
128
136
  subtract(value: number, unit: Unit): Timespan;
129
-
130
137
  subtract(value: string): Timespan;
131
-
132
138
  subtract(timespan: Timespan): Timespan;
133
-
134
139
  subtract(value: number | string | Timespan, unit?: Unit): Timespan {
135
140
  const subtraction = this.parseSubstraction(value, unit);
136
141
 
137
142
  return new Timespan(this._millis - subtraction, 'milliseconds');
138
143
  }
139
144
 
140
- toString(u: Unit | UnitAlias = 's'): string {
145
+ toString(useUnit?: Unit | UnitAlias): string {
146
+ const u = useUnit || this._unit;
141
147
  const unit = this.isUnit(u) ? u : aliasesToUnits[u];
142
148
  const value = this._millis / factors[unit];
143
149
 
@@ -1,7 +1,7 @@
1
1
  /* eslint-disable sort-keys */
2
2
  /* eslint-disable prettier/prettier */
3
3
 
4
- import { Timespan } from './timespan.class';
4
+ import { Timespan, Unit, UnitAlias } from './timespan.class';
5
5
 
6
6
  describe('Timespan', () => {
7
7
  describe('Casting', () => {
@@ -63,6 +63,8 @@ describe('Timespan', () => {
63
63
  { str: '1h', correct: true, ms: 3_600_000 },
64
64
  { str: '1m', correct: true, ms: 60_000 },
65
65
  { str: '1s', correct: true, ms: 1_000 },
66
+ { str: '0.1s', correct: true, ms: 100 },
67
+ { str: '-1h', correct: true, ms: -3_600_000 },
66
68
  { str: '1ms', correct: true, ms: 1 },
67
69
  { str: '1me', correct: false, ms: null },
68
70
  { str: 'Time', correct: false, ms: null },
@@ -78,4 +80,29 @@ describe('Timespan', () => {
78
80
  });
79
81
  }
80
82
  });
83
+
84
+ describe('Serialization', () => {
85
+ interface TestCase {
86
+ timespan: Timespan;
87
+ useUnit: Unit | UnitAlias | undefined;
88
+ expected: string;
89
+ }
90
+
91
+ const tt: TestCase[] = [
92
+ { timespan: new Timespan(1, 'd'), useUnit: undefined, expected: '1d' },
93
+ { timespan: new Timespan(1, 'h'), useUnit: undefined, expected: '1h', },
94
+ { timespan: new Timespan(1, 'm'), useUnit: undefined, expected: '1m', },
95
+ { timespan: new Timespan(1, 's'), useUnit: undefined, expected: '1s', },
96
+ { timespan: new Timespan(0.1, 's'), useUnit: undefined, expected: '0.1s', },
97
+ { timespan: new Timespan(-1, 'h'), useUnit: undefined, expected: '-1h', },
98
+ { timespan: new Timespan(1, 'ms'), useUnit: undefined, expected: '1ms', },
99
+ { timespan: new Timespan(10, 'ms'), useUnit: 's', expected: '0.01s' },
100
+ ];
101
+
102
+ for (const { timespan, useUnit, expected } of tt) {
103
+ it(expected, () => {
104
+ expect(timespan.toString(useUnit)).toBe(expected);
105
+ });
106
+ }
107
+ })
81
108
  });
@@ -1 +0,0 @@
1
- export declare const capitalize: (word: string) => string;
@@ -1 +0,0 @@
1
- {"version":3,"file":"capitalize.js","sourceRoot":"","sources":["../../src/functions/capitalize.ts"],"names":[],"mappings":";;;AAAO,MAAM,UAAU,GAAG,CAAC,IAAY,EAAU,EAAE,CACjD,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AADlC,QAAA,UAAU,cACwB"}
@@ -1,3 +0,0 @@
1
- export * from './not-absolute-path.error';
2
- export * from './unknown-file-ext.error';
3
- export * from './unknown-format.error';
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/serialization/errors/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,2DAAyC;AACzC,yDAAuC"}
@@ -1,3 +0,0 @@
1
- export declare class NotAbsolutePathError extends Error {
2
- constructor(path: string);
3
- }
@@ -1,10 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.NotAbsolutePathError = void 0;
4
- class NotAbsolutePathError extends Error {
5
- constructor(path) {
6
- super(`Path = <${path}> is not absolute! Please use absolute path.`);
7
- }
8
- }
9
- exports.NotAbsolutePathError = NotAbsolutePathError;
10
- //# sourceMappingURL=not-absolute-path.error.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"not-absolute-path.error.js","sourceRoot":"","sources":["../../../src/serialization/errors/not-absolute-path.error.ts"],"names":[],"mappings":";;;AAAA,MAAa,oBAAqB,SAAQ,KAAK;IAC7C,YAAY,IAAY;QACtB,KAAK,CAAC,WAAW,IAAI,8CAA8C,CAAC,CAAC;IACvE,CAAC;CACF;AAJD,oDAIC"}
@@ -1,3 +0,0 @@
1
- export declare class UnknownFileExtensionError extends Error {
2
- constructor(ext: string);
3
- }
@@ -1,10 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.UnknownFileExtensionError = void 0;
4
- class UnknownFileExtensionError extends Error {
5
- constructor(ext) {
6
- super(`Unknown file extension: <${ext}>.`);
7
- }
8
- }
9
- exports.UnknownFileExtensionError = UnknownFileExtensionError;
10
- //# sourceMappingURL=unknown-file-ext.error.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"unknown-file-ext.error.js","sourceRoot":"","sources":["../../../src/serialization/errors/unknown-file-ext.error.ts"],"names":[],"mappings":";;;AAAA,MAAa,yBAA0B,SAAQ,KAAK;IAClD,YAAY,GAAW;QACrB,KAAK,CAAC,4BAA4B,GAAG,IAAI,CAAC,CAAC;IAC7C,CAAC;CACF;AAJD,8DAIC"}
@@ -1,5 +0,0 @@
1
- import type { Format } from '../serializer.class';
2
- export declare class UnknownFormatError {
3
- message: string;
4
- constructor(format: Format);
5
- }
@@ -1,11 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.UnknownFormatError = void 0;
4
- class UnknownFormatError {
5
- message;
6
- constructor(format) {
7
- this.message = `Format <${format} is not recognized by the serializer.>`;
8
- }
9
- }
10
- exports.UnknownFormatError = UnknownFormatError;
11
- //# sourceMappingURL=unknown-format.error.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"unknown-format.error.js","sourceRoot":"","sources":["../../../src/serialization/errors/unknown-format.error.ts"],"names":[],"mappings":";;;AAEA,MAAa,kBAAkB;IAC7B,OAAO,CAAS;IAEhB,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,WAAW,MAAM,wCAAwC,CAAC;IAC3E,CAAC;CACF;AAND,gDAMC"}
@@ -1,5 +0,0 @@
1
- export * from './read-obj';
2
- export * from './read-obj-sync';
3
- export * from './serializer.class';
4
- export * from './save-obj';
5
- export * from './reviving-serializer';
@@ -1,22 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./read-obj"), exports);
18
- __exportStar(require("./read-obj-sync"), exports);
19
- __exportStar(require("./serializer.class"), exports);
20
- __exportStar(require("./save-obj"), exports);
21
- __exportStar(require("./reviving-serializer"), exports);
22
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/serialization/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,kDAAgC;AAChC,qDAAmC;AACnC,6CAA2B;AAC3B,wDAAsC"}
@@ -1,9 +0,0 @@
1
- /**
2
- * Reads file into an object.
3
- * Can be used in constructors where you can't perform async operations.
4
- * Supported formats: json, yaml, yml, .env
5
- *
6
- * @param {string} pathToFile Absolute path to file.
7
- * @returns {any}
8
- */
9
- export declare const readObjSync: (pathToFile: string) => unknown;
@@ -1,25 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.readObjSync = void 0;
4
- const node_fs_1 = require("node:fs");
5
- const node_path_1 = require("node:path");
6
- const errors_1 = require("./errors");
7
- const serializer_class_1 = require("./serializer.class");
8
- /**
9
- * Reads file into an object.
10
- * Can be used in constructors where you can't perform async operations.
11
- * Supported formats: json, yaml, yml, .env
12
- *
13
- * @param {string} pathToFile Absolute path to file.
14
- * @returns {any}
15
- */
16
- const readObjSync = (pathToFile) => {
17
- if (!(0, node_path_1.isAbsolute)(pathToFile)) {
18
- throw new errors_1.NotAbsolutePathError(pathToFile);
19
- }
20
- const content = (0, node_fs_1.readFileSync)(pathToFile).toString();
21
- const format = serializer_class_1.Serializer.getFormat(pathToFile);
22
- return serializer_class_1.Serializer.parse(content, format);
23
- };
24
- exports.readObjSync = readObjSync;
25
- //# sourceMappingURL=read-obj-sync.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"read-obj-sync.js","sourceRoot":"","sources":["../../src/serialization/read-obj-sync.ts"],"names":[],"mappings":";;;AAAA,qCAAuC;AACvC,yCAAuC;AAEvC,qCAAgD;AAChD,yDAAgD;AAEhD;;;;;;;GAOG;AACI,MAAM,WAAW,GAAG,CAAC,UAAkB,EAAW,EAAE;IACzD,IAAI,CAAC,IAAA,sBAAU,EAAC,UAAU,CAAC,EAAE;QAC3B,MAAM,IAAI,6BAAoB,CAAC,UAAU,CAAC,CAAC;KAC5C;IAED,MAAM,OAAO,GAAG,IAAA,sBAAY,EAAC,UAAU,CAAC,CAAC,QAAQ,EAAE,CAAC;IACpD,MAAM,MAAM,GAAG,6BAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAEhD,OAAO,6BAAU,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAC3C,CAAC,CAAC;AATW,QAAA,WAAW,eAStB"}
@@ -1,8 +0,0 @@
1
- /**
2
- * Reads file into an object.
3
- * Supported formats: json, yaml, yml, .env
4
- *
5
- * @param {string} pathToFile Absolute path to file.
6
- * @returns {any}
7
- */
8
- export declare const readObj: (pathToFile: string) => Promise<unknown>;
@@ -1,24 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.readObj = void 0;
4
- const node_fs_1 = require("node:fs");
5
- const node_path_1 = require("node:path");
6
- const errors_1 = require("./errors");
7
- const serializer_class_1 = require("./serializer.class");
8
- /**
9
- * Reads file into an object.
10
- * Supported formats: json, yaml, yml, .env
11
- *
12
- * @param {string} pathToFile Absolute path to file.
13
- * @returns {any}
14
- */
15
- const readObj = async (pathToFile) => {
16
- if (!(0, node_path_1.isAbsolute)(pathToFile)) {
17
- throw new errors_1.NotAbsolutePathError(pathToFile);
18
- }
19
- const format = serializer_class_1.Serializer.getFormat(pathToFile);
20
- const content = await node_fs_1.promises.readFile(pathToFile);
21
- return serializer_class_1.Serializer.parse(content.toString(), format);
22
- };
23
- exports.readObj = readObj;
24
- //# sourceMappingURL=read-obj.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"read-obj.js","sourceRoot":"","sources":["../../src/serialization/read-obj.ts"],"names":[],"mappings":";;;AAAA,qCAAyC;AACzC,yCAAuC;AAEvC,qCAAgD;AAChD,yDAAgD;AAEhD;;;;;;GAMG;AACI,MAAM,OAAO,GAAG,KAAK,EAAE,UAAkB,EAAoB,EAAE;IACpE,IAAI,CAAC,IAAA,sBAAU,EAAC,UAAU,CAAC,EAAE;QAC3B,MAAM,IAAI,6BAAoB,CAAC,UAAU,CAAC,CAAC;KAC5C;IAED,MAAM,MAAM,GAAG,6BAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAChD,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAE9C,OAAO,6BAAU,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,CAAC,CAAC;AACtD,CAAC,CAAC;AATW,QAAA,OAAO,WASlB"}
@@ -1,8 +0,0 @@
1
- /**
2
- * For serializing and deserializing objects with methods.
3
- * See more in https://clck.ru/Qc3e4
4
- * */
5
- export declare class RevivingSerializer {
6
- static serialize<T>(obj: T): string;
7
- static deserialize<T>(serializedObject: string): T;
8
- }
@@ -1,30 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.RevivingSerializer = void 0;
4
- /**
5
- * For serializing and deserializing objects with methods.
6
- * See more in https://clck.ru/Qc3e4
7
- * */
8
- class RevivingSerializer {
9
- static serialize(obj) {
10
- return JSON.stringify(obj, (_key, value) => {
11
- if (typeof value === 'function') {
12
- return value.toString();
13
- }
14
- return value;
15
- });
16
- }
17
- static deserialize(serializedObject) {
18
- return JSON.parse(serializedObject, (_key, value) => {
19
- if (typeof value === 'string' && value.startsWith('function')) {
20
- const functionTemplate = `(${value})`;
21
- // eval is the best the best way to revive function from serialized object.
22
- // eslint-disable-next-line no-eval
23
- return eval(functionTemplate);
24
- }
25
- return value;
26
- });
27
- }
28
- }
29
- exports.RevivingSerializer = RevivingSerializer;
30
- //# sourceMappingURL=reviving-serializer.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"reviving-serializer.js","sourceRoot":"","sources":["../../src/serialization/reviving-serializer.ts"],"names":[],"mappings":";;;AAAA;;;KAGK;AACL,MAAa,kBAAkB;IAC7B,MAAM,CAAC,SAAS,CAAI,GAAM;QACxB,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,IAAY,EAAE,KAAc,EAAW,EAAE;YACnE,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;gBAC/B,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;aACzB;YAED,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,WAAW,CAAI,gBAAwB;QAC5C,OAAO,IAAI,CAAC,KAAK,CACf,gBAAgB,EAChB,CAAC,IAAY,EAAE,KAAc,EAAW,EAAE;YACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;gBAC7D,MAAM,gBAAgB,GAAG,IAAI,KAAK,GAAG,CAAC;gBAEtC,2EAA2E;gBAC3E,mCAAmC;gBACnC,OAAO,IAAI,CAAC,gBAAgB,CAAY,CAAC;aAC1C;YAED,OAAO,KAAK,CAAC;QACf,CAAC,CACG,CAAC;IACT,CAAC;CACF;AA3BD,gDA2BC"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Saves object into file.
3
- * Supported formats: json, yaml, yml, .env
4
- *
5
- * @param {*} obj
6
- * @param {string} filename Absolute path to file.
7
- * @param {string} [format] If not specified serializer will try
8
- * to recognize it by file extension.
9
- */
10
- export declare const saveObj: (obj: Record<string, unknown>, filename: string, format?: string) => Promise<void>;
@@ -1,25 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.saveObj = void 0;
4
- const node_fs_1 = require("node:fs");
5
- const node_path_1 = require("node:path");
6
- const errors_1 = require("./errors");
7
- const serializer_class_1 = require("./serializer.class");
8
- /**
9
- * Saves object into file.
10
- * Supported formats: json, yaml, yml, .env
11
- *
12
- * @param {*} obj
13
- * @param {string} filename Absolute path to file.
14
- * @param {string} [format] If not specified serializer will try
15
- * to recognize it by file extension.
16
- */
17
- const saveObj = async (obj, filename, format) => {
18
- if (!(0, node_path_1.isAbsolute)(filename)) {
19
- throw new errors_1.NotAbsolutePathError(filename);
20
- }
21
- const text = serializer_class_1.Serializer.stringify(obj, format || serializer_class_1.Serializer.getFormat(filename));
22
- await node_fs_1.promises.writeFile(filename, `${text}\n`);
23
- };
24
- exports.saveObj = saveObj;
25
- //# sourceMappingURL=save-obj.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"save-obj.js","sourceRoot":"","sources":["../../src/serialization/save-obj.ts"],"names":[],"mappings":";;;AAAA,qCAAyC;AACzC,yCAAuC;AAEvC,qCAAgD;AAChD,yDAAgD;AAEhD;;;;;;;;GAQG;AACI,MAAM,OAAO,GAAG,KAAK,EAC1B,GAA4B,EAC5B,QAAgB,EAChB,MAAe,EACA,EAAE;IACjB,IAAI,CAAC,IAAA,sBAAU,EAAC,QAAQ,CAAC,EAAE;QACzB,MAAM,IAAI,6BAAoB,CAAC,QAAQ,CAAC,CAAC;KAC1C;IAED,MAAM,IAAI,GAAG,6BAAU,CAAC,SAAS,CAC/B,GAAG,EACH,MAAM,IAAI,6BAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CACzC,CAAC;IAEF,MAAM,kBAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,IAAI,IAAI,CAAC,CAAC;AAC5C,CAAC,CAAC;AAfW,QAAA,OAAO,WAelB"}
@@ -1,14 +0,0 @@
1
- export type Parser = (text: string) => unknown;
2
- export type Stringifier = (obj: Record<string, unknown>) => string;
3
- export type Format = string;
4
- export type Extension = string;
5
- export declare class Serializer {
6
- private static readonly parsers;
7
- private static readonly stringifiers;
8
- private static readonly extensions;
9
- static getFormat(filename: string): Format;
10
- static stringify(obj: Record<string, unknown>, format: Format): string;
11
- static parse(text: string, format: Format): unknown;
12
- static useParser(format: Format, parser: Parser): void;
13
- static useStringifier(format: Format, stringifier: Stringifier): void;
14
- }
@@ -1,65 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.Serializer = void 0;
7
- const dotenv_1 = __importDefault(require("dotenv"));
8
- const node_path_1 = require("node:path");
9
- const toml_1 = __importDefault(require("toml"));
10
- const yaml_1 = __importDefault(require("yaml"));
11
- const errors_1 = require("./errors");
12
- const INDENT = 2;
13
- const stringifyEnv = (obj) => Object.entries(obj)
14
- .map(([key, value]) => `${key}=${typeof value === 'object' ? JSON.stringify(obj) : value}`)
15
- .join('\n');
16
- class Serializer {
17
- static parsers = new Map()
18
- .set('json', (text) => JSON.parse(text))
19
- .set('yaml', (text) => yaml_1.default.parse(text))
20
- .set('toml', (text) => toml_1.default.parse(text))
21
- .set('env', dotenv_1.default.parse);
22
- static stringifiers = new Map()
23
- .set('json', (obj) => JSON.stringify(obj, null, INDENT))
24
- .set('yaml', (obj) => yaml_1.default.stringify(obj))
25
- .set('env', stringifyEnv);
26
- static extensions = new Map()
27
- .set('.json', 'json')
28
- .set('.yaml', 'yaml')
29
- .set('.yml', 'yaml')
30
- .set('.toml', 'toml')
31
- .set('.env', 'env');
32
- static getFormat(filename) {
33
- let ext = (0, node_path_1.extname)(filename);
34
- if (!ext && filename.includes('.env')) {
35
- ext = '.env';
36
- }
37
- const format = Serializer.extensions.get(ext);
38
- if (!format) {
39
- throw new errors_1.UnknownFileExtensionError(ext);
40
- }
41
- return format;
42
- }
43
- static stringify(obj, format) {
44
- const stringifier = Serializer.stringifiers.get(format);
45
- if (!stringifier) {
46
- throw new errors_1.UnknownFormatError(format);
47
- }
48
- return stringifier(obj);
49
- }
50
- static parse(text, format) {
51
- const parser = Serializer.parsers.get(format);
52
- if (!parser) {
53
- throw new errors_1.UnknownFormatError(format);
54
- }
55
- return parser(text);
56
- }
57
- static useParser(format, parser) {
58
- Serializer.parsers.set(format, parser);
59
- }
60
- static useStringifier(format, stringifier) {
61
- Serializer.stringifiers.set(format, stringifier);
62
- }
63
- }
64
- exports.Serializer = Serializer;
65
- //# sourceMappingURL=serializer.class.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"serializer.class.js","sourceRoot":"","sources":["../../src/serialization/serializer.class.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,yCAAoC;AACpC,gDAAwB;AACxB,gDAAwB;AAExB,qCAAyE;AAOzE,MAAM,MAAM,GAAG,CAAC,CAAC;AAEjB,MAAM,YAAY,GAAG,CAAC,GAAG,EAAU,EAAE,CACnC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;KAChB,GAAG,CACF,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CACf,GAAG,GAAG,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CACtE;KACA,IAAI,CAAC,IAAI,CAAC,CAAC;AAEhB,MAAa,UAAU;IACb,MAAM,CAAU,OAAO,GAAG,IAAI,GAAG,EAAkB;SACxD,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACvC,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACvC,GAAG,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SACvC,GAAG,CAAC,KAAK,EAAE,gBAAM,CAAC,KAAK,CAAC,CAAC;IAEpB,MAAM,CAAU,YAAY,GAAG,IAAI,GAAG,EAAuB;SAClE,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;SACvD,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,cAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;SACzC,GAAG,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAEpB,MAAM,CAAU,UAAU,GAAG,IAAI,GAAG,EAAqB;SAC9D,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC;SACpB,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC;SACpB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;SACnB,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC;SACpB,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAEtB,MAAM,CAAC,SAAS,CAAC,QAAgB;QAC/B,IAAI,GAAG,GAAG,IAAA,mBAAO,EAAC,QAAQ,CAAC,CAAC;QAE5B,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;YACrC,GAAG,GAAG,MAAM,CAAC;SACd;QAED,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAE9C,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,kCAAyB,CAAC,GAAG,CAAC,CAAC;SAC1C;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,GAA4B,EAAE,MAAc;QAC3D,MAAM,WAAW,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAExD,IAAI,CAAC,WAAW,EAAE;YAChB,MAAM,IAAI,2BAAkB,CAAC,MAAM,CAAC,CAAC;SACtC;QAED,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;IAC1B,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,IAAY,EAAE,MAAc;QACvC,MAAM,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAE9C,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,2BAAkB,CAAC,MAAM,CAAC,CAAC;SACtC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAED,MAAM,CAAC,SAAS,CAAC,MAAc,EAAE,MAAc;QAC7C,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAc,EAAE,WAAwB;QAC5D,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IACnD,CAAC;;AA7DU,gCAAU"}
@@ -1,3 +0,0 @@
1
- import type { DynamicModule } from '@nestjs/common';
2
- import type { Constructor } from './constructor.type';
3
- export type NestModuleDefinition = DynamicModule | Constructor;
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=nest-module-definition.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"nest-module-definition.js","sourceRoot":"","sources":["../../src/types/nest-module-definition.ts"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- export const capitalize = (word: string): string =>
2
- word.charAt(0).toUpperCase() + word.slice(1);
@@ -1,3 +0,0 @@
1
- export * from './not-absolute-path.error';
2
- export * from './unknown-file-ext.error';
3
- export * from './unknown-format.error';
@@ -1,5 +0,0 @@
1
- export class NotAbsolutePathError extends Error {
2
- constructor(path: string) {
3
- super(`Path = <${path}> is not absolute! Please use absolute path.`);
4
- }
5
- }
@@ -1,5 +0,0 @@
1
- export class UnknownFileExtensionError extends Error {
2
- constructor(ext: string) {
3
- super(`Unknown file extension: <${ext}>.`);
4
- }
5
- }
@@ -1,9 +0,0 @@
1
- import type { Format } from '../serializer.class';
2
-
3
- export class UnknownFormatError {
4
- message: string;
5
-
6
- constructor(format: Format) {
7
- this.message = `Format <${format} is not recognized by the serializer.>`;
8
- }
9
- }
@@ -1,5 +0,0 @@
1
- export * from './read-obj';
2
- export * from './read-obj-sync';
3
- export * from './serializer.class';
4
- export * from './save-obj';
5
- export * from './reviving-serializer';
@@ -1,24 +0,0 @@
1
- import { readFileSync } from 'node:fs';
2
- import { isAbsolute } from 'node:path';
3
-
4
- import { NotAbsolutePathError } from './errors';
5
- import { Serializer } from './serializer.class';
6
-
7
- /**
8
- * Reads file into an object.
9
- * Can be used in constructors where you can't perform async operations.
10
- * Supported formats: json, yaml, yml, .env
11
- *
12
- * @param {string} pathToFile Absolute path to file.
13
- * @returns {any}
14
- */
15
- export const readObjSync = (pathToFile: string): unknown => {
16
- if (!isAbsolute(pathToFile)) {
17
- throw new NotAbsolutePathError(pathToFile);
18
- }
19
-
20
- const content = readFileSync(pathToFile).toString();
21
- const format = Serializer.getFormat(pathToFile);
22
-
23
- return Serializer.parse(content, format);
24
- };