@bymax-one/nest-notification 1.4.8 → 1.4.9
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.
- package/CHANGELOG.md +121 -3
- package/README.md +66 -51
- package/dist/server/index.cjs +594 -112
- package/dist/server/index.d.cts +132 -4
- package/dist/server/index.d.ts +132 -4
- package/dist/server/index.mjs +594 -112
- package/dist/shared/index.cjs +1 -0
- package/dist/shared/index.d.cts +1 -0
- package/dist/shared/index.d.ts +1 -0
- package/dist/shared/index.mjs +1 -0
- package/dist/testing/index.cjs +76 -1
- package/dist/testing/index.d.cts +21 -0
- package/dist/testing/index.d.ts +21 -0
- package/dist/testing/index.mjs +76 -1
- package/package.json +2 -2
package/dist/shared/index.cjs
CHANGED
|
@@ -18,6 +18,7 @@ var NOTIFICATION_ERROR_CODES = {
|
|
|
18
18
|
OTP_EXPIRED: "notification.otp_expired",
|
|
19
19
|
OTP_MAX_ATTEMPTS_EXCEEDED: "notification.otp_max_attempts_exceeded",
|
|
20
20
|
OTP_INVALID_CODE: "notification.otp_invalid_code",
|
|
21
|
+
OTP_STORAGE_UNAVAILABLE: "notification.otp_storage_unavailable",
|
|
21
22
|
OTP_INVALID_LENGTH: "notification.otp_invalid_length",
|
|
22
23
|
SMS_PROVIDER_NOT_CONFIGURED: "notification.sms_provider_not_configured",
|
|
23
24
|
SMS_SEND_FAILED: "notification.sms_send_failed",
|
package/dist/shared/index.d.cts
CHANGED
|
@@ -94,6 +94,7 @@ declare const NOTIFICATION_ERROR_CODES: {
|
|
|
94
94
|
readonly OTP_EXPIRED: "notification.otp_expired";
|
|
95
95
|
readonly OTP_MAX_ATTEMPTS_EXCEEDED: "notification.otp_max_attempts_exceeded";
|
|
96
96
|
readonly OTP_INVALID_CODE: "notification.otp_invalid_code";
|
|
97
|
+
readonly OTP_STORAGE_UNAVAILABLE: "notification.otp_storage_unavailable";
|
|
97
98
|
readonly OTP_INVALID_LENGTH: "notification.otp_invalid_length";
|
|
98
99
|
readonly SMS_PROVIDER_NOT_CONFIGURED: "notification.sms_provider_not_configured";
|
|
99
100
|
readonly SMS_SEND_FAILED: "notification.sms_send_failed";
|
package/dist/shared/index.d.ts
CHANGED
|
@@ -94,6 +94,7 @@ declare const NOTIFICATION_ERROR_CODES: {
|
|
|
94
94
|
readonly OTP_EXPIRED: "notification.otp_expired";
|
|
95
95
|
readonly OTP_MAX_ATTEMPTS_EXCEEDED: "notification.otp_max_attempts_exceeded";
|
|
96
96
|
readonly OTP_INVALID_CODE: "notification.otp_invalid_code";
|
|
97
|
+
readonly OTP_STORAGE_UNAVAILABLE: "notification.otp_storage_unavailable";
|
|
97
98
|
readonly OTP_INVALID_LENGTH: "notification.otp_invalid_length";
|
|
98
99
|
readonly SMS_PROVIDER_NOT_CONFIGURED: "notification.sms_provider_not_configured";
|
|
99
100
|
readonly SMS_SEND_FAILED: "notification.sms_send_failed";
|
package/dist/shared/index.mjs
CHANGED
|
@@ -16,6 +16,7 @@ var NOTIFICATION_ERROR_CODES = {
|
|
|
16
16
|
OTP_EXPIRED: "notification.otp_expired",
|
|
17
17
|
OTP_MAX_ATTEMPTS_EXCEEDED: "notification.otp_max_attempts_exceeded",
|
|
18
18
|
OTP_INVALID_CODE: "notification.otp_invalid_code",
|
|
19
|
+
OTP_STORAGE_UNAVAILABLE: "notification.otp_storage_unavailable",
|
|
19
20
|
OTP_INVALID_LENGTH: "notification.otp_invalid_length",
|
|
20
21
|
SMS_PROVIDER_NOT_CONFIGURED: "notification.sms_provider_not_configured",
|
|
21
22
|
SMS_SEND_FAILED: "notification.sms_send_failed",
|
package/dist/testing/index.cjs
CHANGED
|
@@ -17,6 +17,79 @@ function wait(ms) {
|
|
|
17
17
|
});
|
|
18
18
|
}
|
|
19
19
|
|
|
20
|
+
// src/testing/otp-storage-contract.consume.ts
|
|
21
|
+
var STORED = "stored-value-1";
|
|
22
|
+
var REGENERATED = "stored-value-2";
|
|
23
|
+
function entryOf(code) {
|
|
24
|
+
return { code, expiresAt: Date.now() + 6e4, attempts: 0, maxAttempts: 5 };
|
|
25
|
+
}
|
|
26
|
+
function deleteIfCodeCase({ scope, withStorage }) {
|
|
27
|
+
return {
|
|
28
|
+
name: "deleteIfCode removes only the stored value it is given (optional)",
|
|
29
|
+
run: () => withStorage(async (storage) => {
|
|
30
|
+
if (storage.deleteIfCode === void 0) {
|
|
31
|
+
return;
|
|
32
|
+
}
|
|
33
|
+
await storage.set(scope.tenantA, scope.recipient, scope.purpose, entryOf(STORED));
|
|
34
|
+
const other = await storage.deleteIfCode(
|
|
35
|
+
scope.tenantA,
|
|
36
|
+
scope.recipient,
|
|
37
|
+
scope.purpose,
|
|
38
|
+
REGENERATED
|
|
39
|
+
);
|
|
40
|
+
const kept = await storage.get(scope.tenantA, scope.recipient, scope.purpose);
|
|
41
|
+
const match = await storage.deleteIfCode(
|
|
42
|
+
scope.tenantA,
|
|
43
|
+
scope.recipient,
|
|
44
|
+
scope.purpose,
|
|
45
|
+
STORED
|
|
46
|
+
);
|
|
47
|
+
const gone = await storage.get(scope.tenantA, scope.recipient, scope.purpose);
|
|
48
|
+
const absent = await storage.deleteIfCode(
|
|
49
|
+
scope.tenantA,
|
|
50
|
+
scope.recipient,
|
|
51
|
+
scope.purpose,
|
|
52
|
+
STORED
|
|
53
|
+
);
|
|
54
|
+
check(
|
|
55
|
+
other === false && kept?.code === STORED,
|
|
56
|
+
"deleteIfCode removed an entry whose stored value differs from the one it was given, so a code regenerated after the read is destroyed by the verification that read the old one"
|
|
57
|
+
);
|
|
58
|
+
check(
|
|
59
|
+
match === true && gone === null,
|
|
60
|
+
"deleteIfCode did not remove the entry whose stored value it was given"
|
|
61
|
+
);
|
|
62
|
+
check(absent === false, "deleteIfCode reported true for an entry that was not there");
|
|
63
|
+
})
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
function deleteIfCodeAtomicCase({
|
|
67
|
+
scope,
|
|
68
|
+
withStorage
|
|
69
|
+
}) {
|
|
70
|
+
return {
|
|
71
|
+
name: "deleteIfCode is ATOMIC under concurrency (optional)",
|
|
72
|
+
run: () => withStorage(async (storage) => {
|
|
73
|
+
if (storage.deleteIfCode === void 0) {
|
|
74
|
+
return;
|
|
75
|
+
}
|
|
76
|
+
const { deleteIfCode } = storage;
|
|
77
|
+
await storage.set(scope.tenantA, scope.recipient, scope.purpose, entryOf(STORED));
|
|
78
|
+
const results = await Promise.all(
|
|
79
|
+
Array.from(
|
|
80
|
+
{ length: RACERS },
|
|
81
|
+
() => deleteIfCode.call(storage, scope.tenantA, scope.recipient, scope.purpose, STORED)
|
|
82
|
+
)
|
|
83
|
+
);
|
|
84
|
+
const winners = results.filter(Boolean).length;
|
|
85
|
+
check(
|
|
86
|
+
winners === 1,
|
|
87
|
+
`${String(winners)} of ${String(RACERS)} concurrent deleteIfCode calls reported removing the same entry \u2014 the comparison and the delete are not one indivisible operation, so a one-time code is accepted more than once`
|
|
88
|
+
);
|
|
89
|
+
})
|
|
90
|
+
};
|
|
91
|
+
}
|
|
92
|
+
|
|
20
93
|
// src/testing/otp-storage-contract.failures.ts
|
|
21
94
|
function hasFailureMethods(storage) {
|
|
22
95
|
return storage.getFailures !== void 0 && storage.recordFailure !== void 0 && storage.clearFailures !== void 0;
|
|
@@ -631,7 +704,9 @@ var CASE_BUILDERS = [
|
|
|
631
704
|
failureBoundaryCase,
|
|
632
705
|
failureClearCase,
|
|
633
706
|
failureTtlCase,
|
|
634
|
-
failureAtomicCase
|
|
707
|
+
failureAtomicCase,
|
|
708
|
+
deleteIfCodeCase,
|
|
709
|
+
deleteIfCodeAtomicCase
|
|
635
710
|
];
|
|
636
711
|
function otpStorageContract(factory, options = {}) {
|
|
637
712
|
const scope = makeScope();
|
package/dist/testing/index.d.cts
CHANGED
|
@@ -87,6 +87,27 @@ interface IOtpStorage {
|
|
|
87
87
|
update(tenantId: string, recipient: string, purpose: string, entry: OtpEntry): Promise<void>;
|
|
88
88
|
/** Removes the OTP entry. Idempotent. */
|
|
89
89
|
delete(tenantId: string, recipient: string, purpose: string): Promise<void>;
|
|
90
|
+
/**
|
|
91
|
+
* Atomic compare-and-delete: removes the entry only when the value it still stores equals
|
|
92
|
+
* `expectedStored`, and reports whether this call removed it. Of N concurrent calls for one
|
|
93
|
+
* stored value, exactly one returns `true`.
|
|
94
|
+
*
|
|
95
|
+
* `expectedStored` is the exact STORED `code` the service read from the entry (the keyed
|
|
96
|
+
* digest when `otp.codeSecret` is set), never the guess a user typed: no plaintext guess
|
|
97
|
+
* reaches the storage. The service has already compared the guess in constant time; this
|
|
98
|
+
* only makes the one-time property hold when several verifications of the right code run
|
|
99
|
+
* at once. A code regenerated in between stores a different value, so it is left alone and
|
|
100
|
+
* the call returns `false`.
|
|
101
|
+
*
|
|
102
|
+
* Required when `otp.consumeOnVerify` is `true`: the service refuses to start without it,
|
|
103
|
+
* so a storage that cannot do this atomically never silently keeps the race.
|
|
104
|
+
*
|
|
105
|
+
* MUST be atomic.
|
|
106
|
+
*
|
|
107
|
+
* @param expectedStored - The stored code value the caller read.
|
|
108
|
+
* @returns `true` when this call deleted the entry, `false` when it was absent or changed.
|
|
109
|
+
*/
|
|
110
|
+
deleteIfCode?(tenantId: string, recipient: string, purpose: string, expectedStored: string): Promise<boolean>;
|
|
90
111
|
/**
|
|
91
112
|
* Atomic cooldown acquire for `(tenant, recipient, purpose)`. Sets the cooldown
|
|
92
113
|
* key only if it does not already exist (Redis: `SET NX EX`). Returns `true`
|
package/dist/testing/index.d.ts
CHANGED
|
@@ -87,6 +87,27 @@ interface IOtpStorage {
|
|
|
87
87
|
update(tenantId: string, recipient: string, purpose: string, entry: OtpEntry): Promise<void>;
|
|
88
88
|
/** Removes the OTP entry. Idempotent. */
|
|
89
89
|
delete(tenantId: string, recipient: string, purpose: string): Promise<void>;
|
|
90
|
+
/**
|
|
91
|
+
* Atomic compare-and-delete: removes the entry only when the value it still stores equals
|
|
92
|
+
* `expectedStored`, and reports whether this call removed it. Of N concurrent calls for one
|
|
93
|
+
* stored value, exactly one returns `true`.
|
|
94
|
+
*
|
|
95
|
+
* `expectedStored` is the exact STORED `code` the service read from the entry (the keyed
|
|
96
|
+
* digest when `otp.codeSecret` is set), never the guess a user typed: no plaintext guess
|
|
97
|
+
* reaches the storage. The service has already compared the guess in constant time; this
|
|
98
|
+
* only makes the one-time property hold when several verifications of the right code run
|
|
99
|
+
* at once. A code regenerated in between stores a different value, so it is left alone and
|
|
100
|
+
* the call returns `false`.
|
|
101
|
+
*
|
|
102
|
+
* Required when `otp.consumeOnVerify` is `true`: the service refuses to start without it,
|
|
103
|
+
* so a storage that cannot do this atomically never silently keeps the race.
|
|
104
|
+
*
|
|
105
|
+
* MUST be atomic.
|
|
106
|
+
*
|
|
107
|
+
* @param expectedStored - The stored code value the caller read.
|
|
108
|
+
* @returns `true` when this call deleted the entry, `false` when it was absent or changed.
|
|
109
|
+
*/
|
|
110
|
+
deleteIfCode?(tenantId: string, recipient: string, purpose: string, expectedStored: string): Promise<boolean>;
|
|
90
111
|
/**
|
|
91
112
|
* Atomic cooldown acquire for `(tenant, recipient, purpose)`. Sets the cooldown
|
|
92
113
|
* key only if it does not already exist (Redis: `SET NX EX`). Returns `true`
|
package/dist/testing/index.mjs
CHANGED
|
@@ -15,6 +15,79 @@ function wait(ms) {
|
|
|
15
15
|
});
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
+
// src/testing/otp-storage-contract.consume.ts
|
|
19
|
+
var STORED = "stored-value-1";
|
|
20
|
+
var REGENERATED = "stored-value-2";
|
|
21
|
+
function entryOf(code) {
|
|
22
|
+
return { code, expiresAt: Date.now() + 6e4, attempts: 0, maxAttempts: 5 };
|
|
23
|
+
}
|
|
24
|
+
function deleteIfCodeCase({ scope, withStorage }) {
|
|
25
|
+
return {
|
|
26
|
+
name: "deleteIfCode removes only the stored value it is given (optional)",
|
|
27
|
+
run: () => withStorage(async (storage) => {
|
|
28
|
+
if (storage.deleteIfCode === void 0) {
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
await storage.set(scope.tenantA, scope.recipient, scope.purpose, entryOf(STORED));
|
|
32
|
+
const other = await storage.deleteIfCode(
|
|
33
|
+
scope.tenantA,
|
|
34
|
+
scope.recipient,
|
|
35
|
+
scope.purpose,
|
|
36
|
+
REGENERATED
|
|
37
|
+
);
|
|
38
|
+
const kept = await storage.get(scope.tenantA, scope.recipient, scope.purpose);
|
|
39
|
+
const match = await storage.deleteIfCode(
|
|
40
|
+
scope.tenantA,
|
|
41
|
+
scope.recipient,
|
|
42
|
+
scope.purpose,
|
|
43
|
+
STORED
|
|
44
|
+
);
|
|
45
|
+
const gone = await storage.get(scope.tenantA, scope.recipient, scope.purpose);
|
|
46
|
+
const absent = await storage.deleteIfCode(
|
|
47
|
+
scope.tenantA,
|
|
48
|
+
scope.recipient,
|
|
49
|
+
scope.purpose,
|
|
50
|
+
STORED
|
|
51
|
+
);
|
|
52
|
+
check(
|
|
53
|
+
other === false && kept?.code === STORED,
|
|
54
|
+
"deleteIfCode removed an entry whose stored value differs from the one it was given, so a code regenerated after the read is destroyed by the verification that read the old one"
|
|
55
|
+
);
|
|
56
|
+
check(
|
|
57
|
+
match === true && gone === null,
|
|
58
|
+
"deleteIfCode did not remove the entry whose stored value it was given"
|
|
59
|
+
);
|
|
60
|
+
check(absent === false, "deleteIfCode reported true for an entry that was not there");
|
|
61
|
+
})
|
|
62
|
+
};
|
|
63
|
+
}
|
|
64
|
+
function deleteIfCodeAtomicCase({
|
|
65
|
+
scope,
|
|
66
|
+
withStorage
|
|
67
|
+
}) {
|
|
68
|
+
return {
|
|
69
|
+
name: "deleteIfCode is ATOMIC under concurrency (optional)",
|
|
70
|
+
run: () => withStorage(async (storage) => {
|
|
71
|
+
if (storage.deleteIfCode === void 0) {
|
|
72
|
+
return;
|
|
73
|
+
}
|
|
74
|
+
const { deleteIfCode } = storage;
|
|
75
|
+
await storage.set(scope.tenantA, scope.recipient, scope.purpose, entryOf(STORED));
|
|
76
|
+
const results = await Promise.all(
|
|
77
|
+
Array.from(
|
|
78
|
+
{ length: RACERS },
|
|
79
|
+
() => deleteIfCode.call(storage, scope.tenantA, scope.recipient, scope.purpose, STORED)
|
|
80
|
+
)
|
|
81
|
+
);
|
|
82
|
+
const winners = results.filter(Boolean).length;
|
|
83
|
+
check(
|
|
84
|
+
winners === 1,
|
|
85
|
+
`${String(winners)} of ${String(RACERS)} concurrent deleteIfCode calls reported removing the same entry \u2014 the comparison and the delete are not one indivisible operation, so a one-time code is accepted more than once`
|
|
86
|
+
);
|
|
87
|
+
})
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
18
91
|
// src/testing/otp-storage-contract.failures.ts
|
|
19
92
|
function hasFailureMethods(storage) {
|
|
20
93
|
return storage.getFailures !== void 0 && storage.recordFailure !== void 0 && storage.clearFailures !== void 0;
|
|
@@ -629,7 +702,9 @@ var CASE_BUILDERS = [
|
|
|
629
702
|
failureBoundaryCase,
|
|
630
703
|
failureClearCase,
|
|
631
704
|
failureTtlCase,
|
|
632
|
-
failureAtomicCase
|
|
705
|
+
failureAtomicCase,
|
|
706
|
+
deleteIfCodeCase,
|
|
707
|
+
deleteIfCodeAtomicCase
|
|
633
708
|
];
|
|
634
709
|
function otpStorageContract(factory, options = {}) {
|
|
635
710
|
const scope = makeScope();
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bymax-one/nest-notification",
|
|
3
|
-
"version": "1.4.
|
|
3
|
+
"version": "1.4.9",
|
|
4
4
|
"description": "Multi-channel notification library for NestJS — email, OTP, SMS, push — with pluggable providers and storage, multi-tenant by design, zero runtime dependencies.",
|
|
5
5
|
"author": "Bymax One <support@bymax.one>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
"eslint": "^10.9.1",
|
|
155
155
|
"eslint-config-prettier": "^10.1.8",
|
|
156
156
|
"eslint-import-resolver-typescript": "^4.4.4",
|
|
157
|
-
"eslint-plugin-import-x": "^4.
|
|
157
|
+
"eslint-plugin-import-x": "^4.18.1",
|
|
158
158
|
"eslint-plugin-prettier": "^5.5.5",
|
|
159
159
|
"eslint-plugin-security": "^4.0.0",
|
|
160
160
|
"globals": "^17.6.0",
|