@heavybit/ecommerce-contracts 0.0.0-stage → 0.2.1
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/README.md +158 -2
- package/dist/cjs/app.js +38 -0
- package/dist/cjs/app.js.map +1 -0
- package/dist/cjs/bindings.js +127 -0
- package/dist/cjs/bindings.js.map +1 -0
- package/dist/cjs/events/audit.js +26 -0
- package/dist/cjs/events/audit.js.map +1 -0
- package/dist/cjs/events/auth.js +68 -0
- package/dist/cjs/events/auth.js.map +1 -0
- package/dist/cjs/events/base.js +99 -0
- package/dist/cjs/events/base.js.map +1 -0
- package/dist/cjs/events/cart.js +15 -0
- package/dist/cjs/events/cart.js.map +1 -0
- package/dist/cjs/events/catalog.js +24 -0
- package/dist/cjs/events/catalog.js.map +1 -0
- package/dist/cjs/events/gateway.js +24 -0
- package/dist/cjs/events/gateway.js.map +1 -0
- package/dist/cjs/events/index.js +131 -0
- package/dist/cjs/events/index.js.map +1 -0
- package/dist/cjs/events/media.js +17 -0
- package/dist/cjs/events/media.js.map +1 -0
- package/dist/cjs/events/notification.js +43 -0
- package/dist/cjs/events/notification.js.map +1 -0
- package/dist/cjs/events/order.js +45 -0
- package/dist/cjs/events/order.js.map +1 -0
- package/dist/cjs/events/payment.js +34 -0
- package/dist/cjs/events/payment.js.map +1 -0
- package/dist/cjs/events/security.js +36 -0
- package/dist/cjs/events/security.js.map +1 -0
- package/dist/cjs/events/shipping.js +25 -0
- package/dist/cjs/events/shipping.js.map +1 -0
- package/dist/cjs/events/store.js +25 -0
- package/dist/cjs/events/store.js.map +1 -0
- package/dist/cjs/events/usage.js +17 -0
- package/dist/cjs/events/usage.js.map +1 -0
- package/dist/cjs/identity.js +50 -0
- package/dist/cjs/identity.js.map +1 -0
- package/dist/cjs/index.js +27 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/permissions.js +10 -0
- package/dist/cjs/permissions.js.map +1 -0
- package/dist/cjs/scopes.js +57 -0
- package/dist/cjs/scopes.js.map +1 -0
- package/dist/esm/app.js +35 -0
- package/dist/esm/app.js.map +1 -0
- package/dist/esm/bindings.js +115 -0
- package/dist/esm/bindings.js.map +1 -0
- package/dist/esm/events/audit.js +23 -0
- package/dist/esm/events/audit.js.map +1 -0
- package/dist/esm/events/auth.js +65 -0
- package/dist/esm/events/auth.js.map +1 -0
- package/dist/esm/events/base.js +90 -0
- package/dist/esm/events/base.js.map +1 -0
- package/dist/esm/events/cart.js +12 -0
- package/dist/esm/events/cart.js.map +1 -0
- package/dist/esm/events/catalog.js +21 -0
- package/dist/esm/events/catalog.js.map +1 -0
- package/dist/esm/events/gateway.js +21 -0
- package/dist/esm/events/gateway.js.map +1 -0
- package/dist/esm/events/index.js +100 -0
- package/dist/esm/events/index.js.map +1 -0
- package/dist/esm/events/media.js +14 -0
- package/dist/esm/events/media.js.map +1 -0
- package/dist/esm/events/notification.js +40 -0
- package/dist/esm/events/notification.js.map +1 -0
- package/dist/esm/events/order.js +42 -0
- package/dist/esm/events/order.js.map +1 -0
- package/dist/esm/events/payment.js +31 -0
- package/dist/esm/events/payment.js.map +1 -0
- package/dist/esm/events/security.js +33 -0
- package/dist/esm/events/security.js.map +1 -0
- package/dist/esm/events/shipping.js +22 -0
- package/dist/esm/events/shipping.js.map +1 -0
- package/dist/esm/events/store.js +22 -0
- package/dist/esm/events/store.js.map +1 -0
- package/dist/esm/events/usage.js +14 -0
- package/dist/esm/events/usage.js.map +1 -0
- package/dist/esm/identity.js +47 -0
- package/dist/esm/identity.js.map +1 -0
- package/dist/esm/index.js +11 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/package.json +1 -0
- package/dist/esm/permissions.js +7 -0
- package/dist/esm/permissions.js.map +1 -0
- package/dist/esm/scopes.js +52 -0
- package/dist/esm/scopes.js.map +1 -0
- package/dist/types/app.d.ts +40 -0
- package/dist/types/app.d.ts.map +1 -0
- package/dist/types/bindings.d.ts +88 -0
- package/dist/types/bindings.d.ts.map +1 -0
- package/dist/types/events/audit.d.ts +86 -0
- package/dist/types/events/audit.d.ts.map +1 -0
- package/dist/types/events/auth.d.ts +357 -0
- package/dist/types/events/auth.d.ts.map +1 -0
- package/dist/types/events/base.d.ts +108 -0
- package/dist/types/events/base.d.ts.map +1 -0
- package/dist/types/events/cart.d.ts +37 -0
- package/dist/types/events/cart.d.ts.map +1 -0
- package/dist/types/events/catalog.d.ts +126 -0
- package/dist/types/events/catalog.d.ts.map +1 -0
- package/dist/types/events/gateway.d.ts +77 -0
- package/dist/types/events/gateway.d.ts.map +1 -0
- package/dist/types/events/index.d.ts +4333 -0
- package/dist/types/events/index.d.ts.map +1 -0
- package/dist/types/events/media.d.ts +51 -0
- package/dist/types/events/media.d.ts.map +1 -0
- package/dist/types/events/notification.d.ts +270 -0
- package/dist/types/events/notification.d.ts.map +1 -0
- package/dist/types/events/order.d.ts +289 -0
- package/dist/types/events/order.d.ts.map +1 -0
- package/dist/types/events/payment.d.ts +228 -0
- package/dist/types/events/payment.d.ts.map +1 -0
- package/dist/types/events/security.d.ts +201 -0
- package/dist/types/events/security.d.ts.map +1 -0
- package/dist/types/events/shipping.d.ts +91 -0
- package/dist/types/events/shipping.d.ts.map +1 -0
- package/dist/types/events/store.d.ts +134 -0
- package/dist/types/events/store.d.ts.map +1 -0
- package/dist/types/events/usage.d.ts +59 -0
- package/dist/types/events/usage.d.ts.map +1 -0
- package/dist/types/identity.d.ts +22 -0
- package/dist/types/identity.d.ts.map +1 -0
- package/dist/types/index.d.ts +11 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/permissions.d.ts +7 -0
- package/dist/types/permissions.d.ts.map +1 -0
- package/dist/types/scopes.d.ts +57 -0
- package/dist/types/scopes.d.ts.map +1 -0
- package/package.json +44 -4
package/dist/esm/app.js
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* E-commerce app settings (D40). These are the values `@heavybit/shared-lib` takes as parameters:
|
|
3
|
+
* services pass them in (`createRedisKeyspace({ app: APP_SLUG, … })`, `createMessaging({ app: APP_SLUG, … })`,
|
|
4
|
+
* `Money`/phone helpers, socket tickets) instead of writing literals.
|
|
5
|
+
*/
|
|
6
|
+
import { createNotificationDispatchSchema, } from '@heavybit/shared-lib';
|
|
7
|
+
/** Infra slug for containers, databases, Redis keys and exchanges (D15). */
|
|
8
|
+
export const APP_SLUG = 'ecommerce';
|
|
9
|
+
/** The only currency in P1 (D5: money travels as decimal strings with this code). */
|
|
10
|
+
export const CURRENCY = 'KES';
|
|
11
|
+
/** Region for phone parsing and normalisation (`2547XXXXXXXX`). */
|
|
12
|
+
export const PHONE_REGION = 'KE';
|
|
13
|
+
/** IANA zone used when neither the shop nor the user has one (reports, business days, emails). */
|
|
14
|
+
export const DEFAULT_TIME_ZONE = 'Africa/Nairobi';
|
|
15
|
+
/** Domain separator for socket handshake tickets, so a ticket from another app or purpose never verifies. */
|
|
16
|
+
export const SOCKET_TICKET_DOMAIN = 'ecommerce-socket-ticket:v1';
|
|
17
|
+
/** Prefix of every internal (service-to-service) route; passed to `createInternalCallerGuards({ pathPrefix })`. */
|
|
18
|
+
export const INTERNAL_PATH_PREFIX = '/api/v1/internal';
|
|
19
|
+
/** Prefix of the public API behind the gateway. */
|
|
20
|
+
export const PUBLIC_API_PREFIX = '/api/v1';
|
|
21
|
+
/** What a notification is about; drives preferences and templates in the notification-service. */
|
|
22
|
+
export const NOTIFICATION_CATEGORIES = ['security', 'account', 'order', 'payment', 'shipping', 'support', 'staff', 'store', 'billing'];
|
|
23
|
+
/** Delivery channels the notification-service supports (D20: email via SendGrid, SMS provider with a `log` driver in dev). */
|
|
24
|
+
export const NOTIFICATION_CHANNELS = ['email', 'sms', 'in_app'];
|
|
25
|
+
/**
|
|
26
|
+
* Schema of a notification dispatch in this app's vocabulary. Producers stage it with the
|
|
27
|
+
* `notification.send.requested` command; the notification-service validates with the same schema.
|
|
28
|
+
*
|
|
29
|
+
* @example notificationDispatchSchema.parse({ template: 'login-otp', category: 'security', recipient: { email }, channels: ['email'], data: { code }, secretKeys: ['code'] })
|
|
30
|
+
*/
|
|
31
|
+
export const notificationDispatchSchema = createNotificationDispatchSchema({
|
|
32
|
+
categories: NOTIFICATION_CATEGORIES,
|
|
33
|
+
channels: NOTIFICATION_CHANNELS,
|
|
34
|
+
});
|
|
35
|
+
//# sourceMappingURL=app.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/app.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EACL,gCAAgC,GAIjC,MAAM,sBAAsB,CAAC;AAE9B,4EAA4E;AAC5E,MAAM,CAAC,MAAM,QAAQ,GAAG,WAAoB,CAAC;AAE7C,qFAAqF;AACrF,MAAM,CAAC,MAAM,QAAQ,GAAG,KAAc,CAAC;AAEvC,mEAAmE;AACnE,MAAM,CAAC,MAAM,YAAY,GAAG,IAAa,CAAC;AAE1C,kGAAkG;AAClG,MAAM,CAAC,MAAM,iBAAiB,GAAG,gBAAyB,CAAC;AAE3D,6GAA6G;AAC7G,MAAM,CAAC,MAAM,oBAAoB,GAAG,4BAAqC,CAAC;AAE1E,mHAAmH;AACnH,MAAM,CAAC,MAAM,oBAAoB,GAAG,kBAA2B,CAAC;AAEhE,mDAAmD;AACnD,MAAM,CAAC,MAAM,iBAAiB,GAAG,SAAkB,CAAC;AAEpD,kGAAkG;AAClG,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,CAAU,CAAC;AAEhJ,8HAA8H;AAC9H,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAU,CAAC;AAOzE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAA0E,gCAAgC,CAAC;IAChJ,UAAU,EAAE,uBAAuB;IACnC,QAAQ,EAAE,qBAAqB;CAChC,CAAC,CAAC"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Thin e-commerce bindings of shared-lib's generic helpers (D40): money in KES, Kenyan mobile numbers,
|
|
3
|
+
* business days in the shop's zone, the approval policy, audit payloads and socket tickets. No business
|
|
4
|
+
* logic — only app values plugged into the generic code.
|
|
5
|
+
*/
|
|
6
|
+
import { canJoinScopeRoom, createApprovalPolicy, Money, scopeRoom, signSocketTicket, toMsisdn, verifySocketTicket, zonedDayBounds, } from '@heavybit/shared-lib';
|
|
7
|
+
import { CURRENCY, DEFAULT_TIME_ZONE, PHONE_REGION, SOCKET_TICKET_DOMAIN } from './app.js';
|
|
8
|
+
import { APPROVAL_DECIDE_PERMISSION } from './permissions.js';
|
|
9
|
+
import { COMPANY_SCOPE_KEY } from './scopes.js';
|
|
10
|
+
// ── Money ────────────────────────────────────────────────────────────────────────────────────────────
|
|
11
|
+
/**
|
|
12
|
+
* A KES amount from its decimal string (strict: at most 2 decimals, no separators).
|
|
13
|
+
*
|
|
14
|
+
* @param amount e.g. `"1250.00"`.
|
|
15
|
+
* @returns The amount.
|
|
16
|
+
* @example money('1250').add(money('99.50')).toDecimalString() // '1349.50'
|
|
17
|
+
*/
|
|
18
|
+
export function money(amount) {
|
|
19
|
+
return Money.fromDecimalString(amount, CURRENCY);
|
|
20
|
+
}
|
|
21
|
+
/** Zero shillings. */
|
|
22
|
+
export const zeroMoney = () => Money.zero(CURRENCY);
|
|
23
|
+
// ── Phones ───────────────────────────────────────────────────────────────────────────────────────────
|
|
24
|
+
/**
|
|
25
|
+
* Normalises a Kenyan mobile number to `2547XXXXXXXX` / `2541XXXXXXXX` (the form M-Pesa and SMS use).
|
|
26
|
+
* Accepts `07…`, `01…`, `7…`, `+254…` and `254…` with spaces or dashes; rejects landlines and foreign numbers.
|
|
27
|
+
*
|
|
28
|
+
* @param phone Number as typed.
|
|
29
|
+
* @returns The MSISDN.
|
|
30
|
+
* @throws BadRequestError `INVALID_PHONE`.
|
|
31
|
+
* @example normalisePhone('0712 345 678') // '254712345678'
|
|
32
|
+
*/
|
|
33
|
+
export function normalisePhone(phone) {
|
|
34
|
+
return toMsisdn(phone, PHONE_REGION, { mobileOnly: true, regionOnly: true });
|
|
35
|
+
}
|
|
36
|
+
// ── Time ─────────────────────────────────────────────────────────────────────────────────────────────
|
|
37
|
+
/**
|
|
38
|
+
* The business day containing `at`, in the company's zone (default: the app's `DEFAULT_TIME_ZONE`).
|
|
39
|
+
*
|
|
40
|
+
* @param at Any instant in the day.
|
|
41
|
+
* @param zone The shop's IANA zone when it has one.
|
|
42
|
+
* @returns Half-open `[start, end)` UTC range.
|
|
43
|
+
*/
|
|
44
|
+
export function companyDayBounds(at, zone = DEFAULT_TIME_ZONE) {
|
|
45
|
+
return zonedDayBounds(at, zone);
|
|
46
|
+
}
|
|
47
|
+
// ── Approvals ────────────────────────────────────────────────────────────────────────────────────────
|
|
48
|
+
/** How long a pending approval stays decidable. */
|
|
49
|
+
export const APPROVAL_TTL_HOURS = 72;
|
|
50
|
+
/**
|
|
51
|
+
* The approval rules with `APPROVAL_DECIDE_PERMISSION` and an `APPROVAL_TTL_HOURS` TTL.
|
|
52
|
+
*
|
|
53
|
+
* @example approvalPolicy.assertCanDecide(approval, req.user); approval.expiresAt = approvalPolicy.expiresAt();
|
|
54
|
+
*/
|
|
55
|
+
export const approvalPolicy = createApprovalPolicy({
|
|
56
|
+
decidePermission: APPROVAL_DECIDE_PERMISSION,
|
|
57
|
+
ttlSeconds: APPROVAL_TTL_HOURS * 3600,
|
|
58
|
+
});
|
|
59
|
+
/**
|
|
60
|
+
* Maps a shared-lib audit event to this app's `{publisher}.audit.recorded` payload. The company comes from
|
|
61
|
+
* the event's `company` scope; changed field names (never values) go in `metadata.changedFields`; `ip` and
|
|
62
|
+
* `userAgent` are extra (passed-through) fields for audit-service.
|
|
63
|
+
* Stage it with `enqueueOutbox(tx, AUDIT_RECORDED_KEYS.order, toAuditRecordedPayload(event), { actorUserId: event.actorUserId })`.
|
|
64
|
+
*
|
|
65
|
+
* @param event From `buildAuditEvent`.
|
|
66
|
+
* @returns The payload.
|
|
67
|
+
*/
|
|
68
|
+
export function toAuditRecordedPayload(event) {
|
|
69
|
+
const changed = [...Object.keys(event.changes), ...event.redactedFields].sort();
|
|
70
|
+
return {
|
|
71
|
+
companyId: event.scope?.key === COMPANY_SCOPE_KEY ? event.scope.id : null,
|
|
72
|
+
action: event.action,
|
|
73
|
+
entityType: event.entityType,
|
|
74
|
+
entityId: event.entityId,
|
|
75
|
+
outcome: event.outcome,
|
|
76
|
+
occurredAt: event.occurredAt,
|
|
77
|
+
metadata: { changedFields: changed.join(',').slice(0, 500) },
|
|
78
|
+
// Request facts ride as extra payload fields (the schema passes them through), not in `metadata`.
|
|
79
|
+
ip: event.ip,
|
|
80
|
+
userAgent: event.userAgent,
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
// ── Sockets ──────────────────────────────────────────────────────────────────────────────────────────
|
|
84
|
+
/**
|
|
85
|
+
* Signs a socket ticket under this app's domain separator (`SOCKET_TICKET_DOMAIN`).
|
|
86
|
+
*
|
|
87
|
+
* @param input User, audience (the front-end app), company scope ids and permissions.
|
|
88
|
+
* @param secret The ticket signing secret.
|
|
89
|
+
* @param ttlSeconds 1–60 (default 60).
|
|
90
|
+
*/
|
|
91
|
+
export function signAppSocketTicket(input, secret, ttlSeconds) {
|
|
92
|
+
return signSocketTicket(input, { secret, domain: SOCKET_TICKET_DOMAIN, ttlSeconds });
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Verifies a socket ticket under this app's domain separator.
|
|
96
|
+
*
|
|
97
|
+
* @param ticket From the handshake.
|
|
98
|
+
* @param secret The ticket signing secret.
|
|
99
|
+
* @param audience Accepted audience(s).
|
|
100
|
+
*/
|
|
101
|
+
export function verifyAppSocketTicket(ticket, secret, audience) {
|
|
102
|
+
return verifySocketTicket(ticket, { secret, domain: SOCKET_TICKET_DOMAIN, audience });
|
|
103
|
+
}
|
|
104
|
+
/** Room for one company's live updates: `company:{companyId}`. */
|
|
105
|
+
export const companyRoom = (companyId) => scopeRoom(COMPANY_SCOPE_KEY, companyId);
|
|
106
|
+
/**
|
|
107
|
+
* True when the ticket holder may join `companyRoom(companyId)` (member of that company, or super admin)
|
|
108
|
+
* and holds `permission` when one is given.
|
|
109
|
+
*
|
|
110
|
+
* @example if (canJoinCompanyRoom(socket.data.identity, companyId, 'order:view')) socket.join(companyRoom(companyId));
|
|
111
|
+
*/
|
|
112
|
+
export function canJoinCompanyRoom(claims, companyId, permission) {
|
|
113
|
+
return canJoinScopeRoom(claims, COMPANY_SCOPE_KEY, companyId, permission);
|
|
114
|
+
}
|
|
115
|
+
//# sourceMappingURL=bindings.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bindings.js","sourceRoot":"","sources":["../../src/bindings.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EACL,gBAAgB,EAChB,oBAAoB,EACpB,KAAK,EACL,SAAS,EACT,gBAAgB,EAChB,QAAQ,EACR,kBAAkB,EAClB,cAAc,GAMf,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAE3F,OAAO,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAGhD,wGAAwG;AAExG;;;;;;GAMG;AACH,MAAM,UAAU,KAAK,CAAC,MAAc;IAClC,OAAO,KAAK,CAAC,iBAAiB,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACnD,CAAC;AAED,sBAAsB;AACtB,MAAM,CAAC,MAAM,SAAS,GAAG,GAAU,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AAE3D,wGAAwG;AAExG;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,KAAa;IAC1C,OAAO,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;AAC/E,CAAC;AAED,wGAAwG;AAExG;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAAC,EAAQ,EAAE,OAAe,iBAAiB;IACzE,OAAO,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC;AAED,wGAAwG;AAExG,mDAAmD;AACnD,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAW,CAAC;AAE9C;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAmB,oBAAoB,CAAC;IACjE,gBAAgB,EAAE,0BAA0B;IAC5C,UAAU,EAAE,kBAAkB,GAAG,IAAI;CACtC,CAAC,CAAC;AAOH;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAiB;IACtD,MAAM,OAAO,GAAG,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,GAAG,KAAK,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,CAAC;IAChF,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,KAAK,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;QACzE,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,UAAU,EAAE,KAAK,CAAC,UAAU;QAC5B,QAAQ,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE;QAC5D,kGAAkG;QAClG,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,SAAS,EAAE,KAAK,CAAC,SAAS;KAC3B,CAAC;AACJ,CAAC;AAED,wGAAwG;AAExG;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAwB,EAAE,MAAc,EAAE,UAAmB;IAC/F,OAAO,gBAAgB,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,UAAU,EAAE,CAAC,CAAC;AACvF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CAAC,MAAe,EAAE,MAAc,EAAE,QAAoC;IACzG,OAAO,kBAAkB,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,QAAQ,EAAE,CAAC,CAAC;AACxF,CAAC;AAED,kEAAkE;AAClE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,SAAiB,EAAU,EAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;AAElG;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAA0B,EAAE,SAAiB,EAAE,UAAmB;IACnG,OAAO,gBAAgB,CAAC,MAAM,EAAE,iBAAiB,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;AAC5E,CAAC"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `{publisher}.audit.recorded`: business audit entries each service stages through its outbox for
|
|
3
|
+
* audit-service. Metadata holds small facts only — never secrets, tokens or contact details.
|
|
4
|
+
*/
|
|
5
|
+
import { z } from '@heavybit/shared-lib';
|
|
6
|
+
import { facts, forEachKey, id, optionalTenantPayload, perPublisher, timestamp } from './base.js';
|
|
7
|
+
/** Binding pattern for audit-service: every publisher's audit entries. */
|
|
8
|
+
export const AUDIT_RECORDED_PATTERN = '*.audit.recorded';
|
|
9
|
+
/** `{publisher}.audit.recorded` for each publisher, e.g. `AUDIT_RECORDED_KEYS.order`. */
|
|
10
|
+
export const AUDIT_RECORDED_KEYS = perPublisher('audit.recorded');
|
|
11
|
+
/** v1 payload of an audit entry. `companyId` is null for platform-level actions. */
|
|
12
|
+
export const auditRecordedSchema = optionalTenantPayload({
|
|
13
|
+
/** What happened, e.g. `order.refund.approved`. */
|
|
14
|
+
action: z.string().min(1).max(100),
|
|
15
|
+
entityType: z.string().min(1).max(64),
|
|
16
|
+
entityId: id.nullable(),
|
|
17
|
+
outcome: z.enum(['success', 'failure']),
|
|
18
|
+
occurredAt: timestamp,
|
|
19
|
+
metadata: facts.optional(),
|
|
20
|
+
});
|
|
21
|
+
/** Every audit routing key with its schema. */
|
|
22
|
+
export const AUDIT_EVENTS = forEachKey(AUDIT_RECORDED_KEYS, auditRecordedSchema);
|
|
23
|
+
//# sourceMappingURL=audit.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"audit.js","sourceRoot":"","sources":["../../../src/events/audit.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,EAAE,qBAAqB,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAElG,0EAA0E;AAC1E,MAAM,CAAC,MAAM,sBAAsB,GAAG,kBAA2B,CAAC;AAElE,yFAAyF;AACzF,MAAM,CAAC,MAAM,mBAAmB,GAAG,YAAY,CAAC,gBAAgB,CAAC,CAAC;AAElE,oFAAoF;AACpF,MAAM,CAAC,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;IACvD,mDAAmD;IACnD,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAClC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE;IACvB,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACvC,UAAU,EAAE,SAAS;IACrB,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE;CAC3B,CAAC,CAAC;AAEH,+CAA+C;AAC/C,MAAM,CAAC,MAAM,YAAY,GAAG,UAAU,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/** auth-admin-service events: users, companies, staff, memberships, roles, approvals, security (§7). */
|
|
2
|
+
import { z } from '@heavybit/shared-lib';
|
|
3
|
+
import { changedFields, id, optionalTenantPayload, reason, tenantPayload, timestamp, userPayload } from './base.js';
|
|
4
|
+
/** Routing keys published by auth-admin-service. */
|
|
5
|
+
export const AUTH_KEYS = {
|
|
6
|
+
user: {
|
|
7
|
+
registered: 'auth.user.registered',
|
|
8
|
+
verified: 'auth.user.verified',
|
|
9
|
+
passwordResetRequested: 'auth.user.password_reset_requested',
|
|
10
|
+
passwordChanged: 'auth.user.password_changed',
|
|
11
|
+
emailChanged: 'auth.user.email_changed',
|
|
12
|
+
deleted: 'auth.user.deleted',
|
|
13
|
+
authzChanged: 'auth.user.authz_changed',
|
|
14
|
+
},
|
|
15
|
+
company: {
|
|
16
|
+
created: 'auth.company.created',
|
|
17
|
+
updated: 'auth.company.updated',
|
|
18
|
+
suspended: 'auth.company.suspended',
|
|
19
|
+
reactivated: 'auth.company.reactivated',
|
|
20
|
+
closed: 'auth.company.closed',
|
|
21
|
+
},
|
|
22
|
+
staff: { invited: 'auth.staff.invited', joined: 'auth.staff.joined', removed: 'auth.staff.removed' },
|
|
23
|
+
membership: { changed: 'auth.membership.changed' },
|
|
24
|
+
role: { changed: 'auth.role.changed' },
|
|
25
|
+
approval: {
|
|
26
|
+
requested: 'auth.approval.requested',
|
|
27
|
+
approved: 'auth.approval.approved',
|
|
28
|
+
rejected: 'auth.approval.rejected',
|
|
29
|
+
expired: 'auth.approval.expired',
|
|
30
|
+
executed: 'auth.approval.executed',
|
|
31
|
+
failed: 'auth.approval.failed',
|
|
32
|
+
},
|
|
33
|
+
};
|
|
34
|
+
/** Approval type, e.g. `refund.large`, `payout.destination.change` (§7.4). */
|
|
35
|
+
const approvalAction = z.string().min(1).max(100);
|
|
36
|
+
const k = AUTH_KEYS;
|
|
37
|
+
/** v1 payload schemas of the auth user/company/staff/role/approval events. */
|
|
38
|
+
export const AUTH_EVENTS = {
|
|
39
|
+
[k.user.registered]: userPayload({ userId: id }),
|
|
40
|
+
[k.user.verified]: userPayload({ userId: id, channel: z.enum(['email', 'phone']) }),
|
|
41
|
+
[k.user.passwordResetRequested]: userPayload({ userId: id }),
|
|
42
|
+
[k.user.passwordChanged]: userPayload({ userId: id }),
|
|
43
|
+
[k.user.emailChanged]: userPayload({ userId: id }),
|
|
44
|
+
[k.user.deleted]: userPayload({ userId: id }),
|
|
45
|
+
/** Roles, permissions or memberships changed: drop cached permissions for this user (and company, when given). */
|
|
46
|
+
[k.user.authzChanged]: optionalTenantPayload({ userId: id }),
|
|
47
|
+
[k.company.created]: tenantPayload({ ownerUserId: id, slug: z.string().max(120), name: z.string().max(200) }),
|
|
48
|
+
[k.company.updated]: tenantPayload({ changedFields }),
|
|
49
|
+
[k.company.suspended]: tenantPayload({ reason }),
|
|
50
|
+
[k.company.reactivated]: tenantPayload({}),
|
|
51
|
+
[k.company.closed]: tenantPayload({}),
|
|
52
|
+
[k.staff.invited]: tenantPayload({ invitationId: id, roleId: id }),
|
|
53
|
+
[k.staff.joined]: tenantPayload({ userId: id, membershipId: id }),
|
|
54
|
+
[k.staff.removed]: tenantPayload({ userId: id, membershipId: id }),
|
|
55
|
+
[k.membership.changed]: tenantPayload({ membershipId: id, userId: id, roleIds: z.array(id).max(50) }),
|
|
56
|
+
/** Company roles carry a company; platform roles do not. */
|
|
57
|
+
[k.role.changed]: optionalTenantPayload({ roleId: id, change: z.enum(['created', 'updated', 'deleted', 'permissions_changed']) }),
|
|
58
|
+
[k.approval.requested]: optionalTenantPayload({ approvalId: id, action: approvalAction, requestedBy: id, expiresAt: timestamp }),
|
|
59
|
+
[k.approval.approved]: optionalTenantPayload({ approvalId: id, action: approvalAction, decidedBy: id }),
|
|
60
|
+
[k.approval.rejected]: optionalTenantPayload({ approvalId: id, action: approvalAction, decidedBy: id }),
|
|
61
|
+
[k.approval.expired]: optionalTenantPayload({ approvalId: id, action: approvalAction }),
|
|
62
|
+
[k.approval.executed]: optionalTenantPayload({ approvalId: id, action: approvalAction }),
|
|
63
|
+
[k.approval.failed]: optionalTenantPayload({ approvalId: id, action: approvalAction, reason }),
|
|
64
|
+
};
|
|
65
|
+
//# sourceMappingURL=auth.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../src/events/auth.ts"],"names":[],"mappings":"AAAA,wGAAwG;AACxG,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,EAAE,EAAE,qBAAqB,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAEpH,oDAAoD;AACpD,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE;QACJ,UAAU,EAAE,sBAAsB;QAClC,QAAQ,EAAE,oBAAoB;QAC9B,sBAAsB,EAAE,oCAAoC;QAC5D,eAAe,EAAE,4BAA4B;QAC7C,YAAY,EAAE,yBAAyB;QACvC,OAAO,EAAE,mBAAmB;QAC5B,YAAY,EAAE,yBAAyB;KACxC;IACD,OAAO,EAAE;QACP,OAAO,EAAE,sBAAsB;QAC/B,OAAO,EAAE,sBAAsB;QAC/B,SAAS,EAAE,wBAAwB;QACnC,WAAW,EAAE,0BAA0B;QACvC,MAAM,EAAE,qBAAqB;KAC9B;IACD,KAAK,EAAE,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,EAAE,oBAAoB,EAAE;IACpG,UAAU,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE;IAClD,IAAI,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE;IACtC,QAAQ,EAAE;QACR,SAAS,EAAE,yBAAyB;QACpC,QAAQ,EAAE,wBAAwB;QAClC,QAAQ,EAAE,wBAAwB;QAClC,OAAO,EAAE,uBAAuB;QAChC,QAAQ,EAAE,wBAAwB;QAClC,MAAM,EAAE,sBAAsB;KAC/B;CACO,CAAC;AAEX,8EAA8E;AAC9E,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAElD,MAAM,CAAC,GAAG,SAAS,CAAC;AAEpB,8EAA8E;AAC9E,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAChD,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;IACnF,CAAC,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAClD,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC7C,kHAAkH;IAClH,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAC5D,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,WAAW,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;IAC7G,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAChD,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC;IAC1C,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,EAAE,CAAC;IACrC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;IAClE,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;IACjE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;IAClE,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;IACrG,4DAA4D;IAC5D,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC,EAAE,CAAC;IACjI,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,qBAAqB,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,WAAW,EAAE,EAAE,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;IAChI,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IACvG,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IACvG,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,qBAAqB,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;IACvF,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,qBAAqB,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;IACxF,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,qBAAqB,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC;CACtF,CAAC"}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Building blocks for v1 event payload schemas.
|
|
3
|
+
*
|
|
4
|
+
* A payload schema describes the envelope `data` **without** the reserved fields (`eventId`, `version`,
|
|
5
|
+
* `actorUserId`), because shared-lib's `enqueueOutbox` adds them and `MessageConsumer` strips them before
|
|
6
|
+
* validating. {@link withEventMeta} adds them back for checks of a complete `data` object.
|
|
7
|
+
*
|
|
8
|
+
* Every payload is `.passthrough()` (MSG-3): a consumer on an older version keeps fields it does not know.
|
|
9
|
+
* Payloads carry ids and small facts only — never an email, phone or address when a user id will do.
|
|
10
|
+
*/
|
|
11
|
+
import { idSchema, z } from '@heavybit/shared-lib';
|
|
12
|
+
import { CURRENCY } from '../app.js';
|
|
13
|
+
/** Payload schema version for every event in this catalogue. */
|
|
14
|
+
export const EVENT_VERSION = 1;
|
|
15
|
+
/** Canonical ULID (D7). */
|
|
16
|
+
export const id = idSchema;
|
|
17
|
+
/** Money amount as a decimal string with exactly 2 dp, as `DECIMAL(12,2)` stores it (D5), e.g. `"1250.00"`. */
|
|
18
|
+
export const amount = z.string().regex(/^-?\d{1,10}\.\d{2}$/, 'Use a decimal string with 2 decimal places');
|
|
19
|
+
/** The currency code that travels with every amount. */
|
|
20
|
+
export const currency = z.literal(CURRENCY);
|
|
21
|
+
/** ISO-8601 timestamp with an offset (`toISOString()` output). */
|
|
22
|
+
export const timestamp = z.string().datetime({ offset: true });
|
|
23
|
+
/** Short machine reason, e.g. `insufficient_funds`. */
|
|
24
|
+
export const reason = z.string().min(1).max(100);
|
|
25
|
+
/** Names of the fields that changed (never their values). */
|
|
26
|
+
export const changedFields = z.array(z.string().max(64)).max(50);
|
|
27
|
+
/** Small string-to-scalar map for facts that do not deserve their own field (never secrets or PII). */
|
|
28
|
+
export const facts = z.record(z.string().max(64), z.union([z.string().max(500), z.number(), z.boolean(), z.null()]));
|
|
29
|
+
/**
|
|
30
|
+
* Payload of an event about one company's data: `companyId` is required (TEN-7).
|
|
31
|
+
*
|
|
32
|
+
* @example tenantPayload({ orderId: id })
|
|
33
|
+
*/
|
|
34
|
+
export function tenantPayload(shape) {
|
|
35
|
+
return z.object({ companyId: id, ...shape }).passthrough();
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Payload of an event that may or may not concern a company (e.g. a platform-level approval or a
|
|
39
|
+
* security event before a company is chosen): `companyId` is a ULID or null.
|
|
40
|
+
*
|
|
41
|
+
* @example optionalTenantPayload({ approvalId: id })
|
|
42
|
+
*/
|
|
43
|
+
export function optionalTenantPayload(shape) {
|
|
44
|
+
return z.object({ companyId: id.nullable().optional(), ...shape }).passthrough();
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Payload of an event about a user account, not a company (e.g. `auth.user.registered`).
|
|
48
|
+
*
|
|
49
|
+
* @example userPayload({ userId: id })
|
|
50
|
+
*/
|
|
51
|
+
export function userPayload(shape) {
|
|
52
|
+
return z.object(shape).passthrough();
|
|
53
|
+
}
|
|
54
|
+
/** The reserved envelope fields as validated in a complete `data` object. */
|
|
55
|
+
export const eventMetaShape = {
|
|
56
|
+
eventId: id,
|
|
57
|
+
version: z.literal(EVENT_VERSION),
|
|
58
|
+
/** The acting user; `null` for the system. Producers in this app always pass it. */
|
|
59
|
+
actorUserId: id.nullable(),
|
|
60
|
+
};
|
|
61
|
+
/**
|
|
62
|
+
* Adds the reserved envelope fields to a payload schema, for validating a complete envelope `data`.
|
|
63
|
+
*
|
|
64
|
+
* @example withEventMeta(schema).parse(envelope.data)
|
|
65
|
+
*/
|
|
66
|
+
export function withEventMeta(schema) {
|
|
67
|
+
return schema.and(z.object(eventMetaShape));
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Services that publish the per-publisher families `{publisher}.audit.recorded` and
|
|
71
|
+
* `{publisher}.security.socket_rejected` (the first routing-key segment of each service).
|
|
72
|
+
*/
|
|
73
|
+
export const EVENT_PUBLISHERS = ['auth', 'gateway', 'store', 'catalog', 'media', 'cart', 'order', 'payment', 'shipping', 'notification', 'reporting'];
|
|
74
|
+
/**
|
|
75
|
+
* Builds one routing key per publisher for a per-publisher family, e.g. `order.audit.recorded`.
|
|
76
|
+
*
|
|
77
|
+
* @example perPublisher('audit.recorded').order === 'order.audit.recorded'
|
|
78
|
+
*/
|
|
79
|
+
export function perPublisher(suffix) {
|
|
80
|
+
return Object.freeze(Object.fromEntries(EVENT_PUBLISHERS.map((p) => [p, `${p}.${suffix}`])));
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* The same schema under every key of a per-publisher family.
|
|
84
|
+
*
|
|
85
|
+
* @example forEachKey(AUDIT_RECORDED_KEYS, auditRecordedSchema)
|
|
86
|
+
*/
|
|
87
|
+
export function forEachKey(keys, schema) {
|
|
88
|
+
return Object.fromEntries(Object.values(keys).map((key) => [key, schema]));
|
|
89
|
+
}
|
|
90
|
+
//# sourceMappingURL=base.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/events/base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAErC,gEAAgE;AAChE,MAAM,CAAC,MAAM,aAAa,GAAG,CAAU,CAAC;AAExC,2BAA2B;AAC3B,MAAM,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC;AAE3B,+GAA+G;AAC/G,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,qBAAqB,EAAE,4CAA4C,CAAC,CAAC;AAE5G,wDAAwD;AACxD,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;AAE5C,kEAAkE;AAClE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;AAE/D,uDAAuD;AACvD,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEjD,6DAA6D;AAC7D,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAEjE,uGAAuG;AACvG,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAErH;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAA0B,KAAQ;IAC7D,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAA0B,KAAQ;IACrE,OAAO,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;AACnF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAA0B,KAAQ;IAC3D,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AACvC,CAAC;AAED,6EAA6E;AAC7E,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IACjC,oFAAoF;IACpF,WAAW,EAAE,EAAE,CAAC,QAAQ,EAAE;CAC3B,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAyB,MAAS;IAC7D,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,CAAU,CAAC;AAK/J;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAyB,MAAS;IAC5D,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,MAAM,EAAE,CAAC,CAAC,CAAC,CAAoD,CAAC;AAClJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAsB,IAA2C,EAAE,MAAS;IACpG,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAI,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAiB,CAAC;AAChG,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/** cart-service events. */
|
|
2
|
+
import { z } from '@heavybit/shared-lib';
|
|
3
|
+
import { amount, currency, id, tenantPayload } from './base.js';
|
|
4
|
+
/** Routing keys published by cart-service. */
|
|
5
|
+
export const CART_KEYS = {
|
|
6
|
+
cart: { updated: 'cart.cart.updated' },
|
|
7
|
+
};
|
|
8
|
+
/** v1 payload schemas of the cart events. `userId` is null for a guest cart. */
|
|
9
|
+
export const CART_EVENTS = {
|
|
10
|
+
[CART_KEYS.cart.updated]: tenantPayload({ cartId: id, userId: id.nullable(), itemCount: z.number().int().min(0), subtotal: amount, currency }),
|
|
11
|
+
};
|
|
12
|
+
//# sourceMappingURL=cart.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cart.js","sourceRoot":"","sources":["../../../src/events/cart.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEhE,8CAA8C;AAC9C,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,EAAE,OAAO,EAAE,mBAAmB,EAAE;CAC9B,CAAC;AAEX,gFAAgF;AAChF,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;CACtI,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/** catalog-service events: products, categories, inventory. */
|
|
2
|
+
import { z } from '@heavybit/shared-lib';
|
|
3
|
+
import { changedFields, id, reason, tenantPayload } from './base.js';
|
|
4
|
+
/** Routing keys published by catalog-service. */
|
|
5
|
+
export const CATALOG_KEYS = {
|
|
6
|
+
product: { created: 'catalog.product.created', updated: 'catalog.product.updated', deleted: 'catalog.product.deleted' },
|
|
7
|
+
category: { updated: 'catalog.category.updated' },
|
|
8
|
+
inventory: { adjusted: 'catalog.inventory.adjusted', lowStock: 'catalog.inventory.low_stock' },
|
|
9
|
+
};
|
|
10
|
+
const quantity = z.number().int();
|
|
11
|
+
const k = CATALOG_KEYS;
|
|
12
|
+
/** v1 payload schemas of the catalog events. */
|
|
13
|
+
export const CATALOG_EVENTS = {
|
|
14
|
+
[k.product.created]: tenantPayload({ productId: id, status: z.string().max(32) }),
|
|
15
|
+
[k.product.updated]: tenantPayload({ productId: id, changedFields }),
|
|
16
|
+
[k.product.deleted]: tenantPayload({ productId: id }),
|
|
17
|
+
[k.category.updated]: tenantPayload({ categoryId: id }),
|
|
18
|
+
[k.inventory.adjusted]: tenantPayload({ productId: id, variantId: id.nullable(), delta: quantity, onHand: quantity, reason }),
|
|
19
|
+
[k.inventory.lowStock]: tenantPayload({ productId: id, variantId: id.nullable(), onHand: quantity, threshold: quantity }),
|
|
20
|
+
};
|
|
21
|
+
//# sourceMappingURL=catalog.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../../../src/events/catalog.ts"],"names":[],"mappings":"AAAA,+DAA+D;AAC/D,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,aAAa,EAAE,EAAE,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAErE,iDAAiD;AACjD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,OAAO,EAAE,EAAE,OAAO,EAAE,yBAAyB,EAAE,OAAO,EAAE,yBAAyB,EAAE,OAAO,EAAE,yBAAyB,EAAE;IACvH,QAAQ,EAAE,EAAE,OAAO,EAAE,0BAA0B,EAAE;IACjD,SAAS,EAAE,EAAE,QAAQ,EAAE,4BAA4B,EAAE,QAAQ,EAAE,6BAA6B,EAAE;CACtF,CAAC;AAEX,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;AAClC,MAAM,CAAC,GAAG,YAAY,CAAC;AAEvB,gDAAgD;AAChD,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;IACjF,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC;IACpE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;IACvD,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;IAC7H,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;CACjH,CAAC"}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/** api-gateway security events (rejected requests). Route and method only — no headers, bodies or IPs. */
|
|
2
|
+
import { z } from '@heavybit/shared-lib';
|
|
3
|
+
import { id, optionalTenantPayload, reason } from './base.js';
|
|
4
|
+
/** Routing keys published by api-gateway. */
|
|
5
|
+
export const GATEWAY_KEYS = {
|
|
6
|
+
security: {
|
|
7
|
+
accessDenied: 'gateway.security.access_denied',
|
|
8
|
+
rateLimited: 'gateway.security.rate_limited',
|
|
9
|
+
badSignature: 'gateway.security.bad_signature',
|
|
10
|
+
},
|
|
11
|
+
};
|
|
12
|
+
const route = z.string().max(200);
|
|
13
|
+
const method = z.string().max(10);
|
|
14
|
+
const k = GATEWAY_KEYS.security;
|
|
15
|
+
/** v1 payload schemas of the gateway events. */
|
|
16
|
+
export const GATEWAY_EVENTS = {
|
|
17
|
+
[k.accessDenied]: optionalTenantPayload({ userId: id.nullable(), route, method, code: z.string().max(64) }),
|
|
18
|
+
[k.rateLimited]: optionalTenantPayload({ userId: id.nullable(), route, method, limiter: z.string().max(64) }),
|
|
19
|
+
[k.badSignature]: optionalTenantPayload({ route, method, reason }),
|
|
20
|
+
};
|
|
21
|
+
//# sourceMappingURL=gateway.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"gateway.js","sourceRoot":"","sources":["../../../src/events/gateway.ts"],"names":[],"mappings":"AAAA,0GAA0G;AAC1G,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,EAAE,EAAE,qBAAqB,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAE9D,6CAA6C;AAC7C,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,QAAQ,EAAE;QACR,YAAY,EAAE,gCAAgC;QAC9C,WAAW,EAAE,+BAA+B;QAC5C,YAAY,EAAE,gCAAgC;KAC/C;CACO,CAAC;AAEX,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAClC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;AAClC,MAAM,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC;AAEhC,gDAAgD;AAChD,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;IAC3G,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,qBAAqB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;IAC7G,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,qBAAqB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;CAC1D,CAAC"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { AUDIT_EVENTS, AUDIT_RECORDED_KEYS, AUDIT_RECORDED_PATTERN } from './audit.js';
|
|
2
|
+
import { AUTH_EVENTS, AUTH_KEYS } from './auth.js';
|
|
3
|
+
import { withEventMeta } from './base.js';
|
|
4
|
+
import { CART_EVENTS, CART_KEYS } from './cart.js';
|
|
5
|
+
import { CATALOG_EVENTS, CATALOG_KEYS } from './catalog.js';
|
|
6
|
+
import { GATEWAY_EVENTS, GATEWAY_KEYS } from './gateway.js';
|
|
7
|
+
import { MEDIA_EVENTS, MEDIA_KEYS } from './media.js';
|
|
8
|
+
import { NOTIFICATION_COMMAND_KEYS, NOTIFICATION_COMMANDS, SOCKET_REJECTED_EVENTS, SOCKET_REJECTED_KEYS, SOCKET_REJECTED_PATTERN, } from './notification.js';
|
|
9
|
+
import { ORDER_EVENTS, ORDER_KEYS } from './order.js';
|
|
10
|
+
import { PAYMENT_EVENTS, PAYMENT_KEYS } from './payment.js';
|
|
11
|
+
import { SECURITY_EVENTS, SECURITY_KEYS } from './security.js';
|
|
12
|
+
import { SHIPPING_EVENTS, SHIPPING_KEYS } from './shipping.js';
|
|
13
|
+
import { STORE_EVENTS, STORE_KEYS } from './store.js';
|
|
14
|
+
import { USAGE_EVENTS, USAGE_KEYS } from './usage.js';
|
|
15
|
+
export * from './base.js';
|
|
16
|
+
export { AUDIT_RECORDED_KEYS, AUDIT_RECORDED_PATTERN, auditRecordedSchema } from './audit.js';
|
|
17
|
+
export { COMMAND_EXCHANGE, EVENT_EXCHANGE, NOTIFICATION_COMMAND_KEYS, SOCKET_REJECTED_KEYS, SOCKET_REJECTED_PATTERN, notificationSendRequestedSchema, socketRejectedSchema, } from './notification.js';
|
|
18
|
+
/**
|
|
19
|
+
* Every routing key, grouped as `{domain}.{entity}.{action}`.
|
|
20
|
+
*
|
|
21
|
+
* @example enqueueOutbox(tx, ROUTING_KEYS.order.order.paid, payload)
|
|
22
|
+
* @example ROUTING_KEYS.audit.recorded.order === 'order.audit.recorded'
|
|
23
|
+
*/
|
|
24
|
+
export const ROUTING_KEYS = Object.freeze({
|
|
25
|
+
auth: { ...AUTH_KEYS, security: SECURITY_KEYS },
|
|
26
|
+
gateway: GATEWAY_KEYS,
|
|
27
|
+
store: STORE_KEYS,
|
|
28
|
+
catalog: CATALOG_KEYS,
|
|
29
|
+
media: MEDIA_KEYS,
|
|
30
|
+
cart: CART_KEYS,
|
|
31
|
+
order: ORDER_KEYS,
|
|
32
|
+
payment: PAYMENT_KEYS,
|
|
33
|
+
shipping: SHIPPING_KEYS,
|
|
34
|
+
usage: USAGE_KEYS,
|
|
35
|
+
notification: NOTIFICATION_COMMAND_KEYS,
|
|
36
|
+
audit: { recorded: AUDIT_RECORDED_KEYS, pattern: AUDIT_RECORDED_PATTERN },
|
|
37
|
+
socketRejected: { keys: SOCKET_REJECTED_KEYS, pattern: SOCKET_REJECTED_PATTERN },
|
|
38
|
+
});
|
|
39
|
+
/** Payload schemas of every event (topic exchange `events`). */
|
|
40
|
+
export const EVENT_SCHEMAS = Object.freeze({
|
|
41
|
+
...AUTH_EVENTS,
|
|
42
|
+
...SECURITY_EVENTS,
|
|
43
|
+
...GATEWAY_EVENTS,
|
|
44
|
+
...STORE_EVENTS,
|
|
45
|
+
...CATALOG_EVENTS,
|
|
46
|
+
...MEDIA_EVENTS,
|
|
47
|
+
...CART_EVENTS,
|
|
48
|
+
...ORDER_EVENTS,
|
|
49
|
+
...PAYMENT_EVENTS,
|
|
50
|
+
...SHIPPING_EVENTS,
|
|
51
|
+
...USAGE_EVENTS,
|
|
52
|
+
...AUDIT_EVENTS,
|
|
53
|
+
...SOCKET_REJECTED_EVENTS,
|
|
54
|
+
});
|
|
55
|
+
/** Payload schemas of every command (direct exchange `commands`). */
|
|
56
|
+
export const COMMAND_SCHEMAS = Object.freeze({ ...NOTIFICATION_COMMANDS });
|
|
57
|
+
/** Every catalogued message: events and commands. */
|
|
58
|
+
export const MESSAGE_SCHEMAS = Object.freeze({ ...EVENT_SCHEMAS, ...COMMAND_SCHEMAS });
|
|
59
|
+
/** Every catalogued routing key. */
|
|
60
|
+
export const ALL_ROUTING_KEYS = Object.freeze(Object.keys(MESSAGE_SCHEMAS));
|
|
61
|
+
/**
|
|
62
|
+
* True when `key` is in the catalogue.
|
|
63
|
+
*
|
|
64
|
+
* @example isRoutingKey(msg.routingKey)
|
|
65
|
+
*/
|
|
66
|
+
export function isRoutingKey(key) {
|
|
67
|
+
return Object.prototype.hasOwnProperty.call(MESSAGE_SCHEMAS, key);
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* The payload schema of a routing key, as producers and consumers use it (envelope fields excluded).
|
|
71
|
+
*
|
|
72
|
+
* @throws Error for a key that is not in the catalogue (a wiring bug, caught at startup or in tests).
|
|
73
|
+
* @example messaging.consumer.subscribe({ queue: 'order-paid', bindings, schema: schemaFor('order.order.paid'), … })
|
|
74
|
+
*/
|
|
75
|
+
export function schemaFor(routingKey) {
|
|
76
|
+
if (!isRoutingKey(routingKey))
|
|
77
|
+
throw new Error(`Unknown routing key "${routingKey}"`);
|
|
78
|
+
return MESSAGE_SCHEMAS[routingKey];
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Schema of a complete envelope `data`: the payload plus `eventId` (ULID), `version` (1) and
|
|
82
|
+
* `actorUserId` (ULID or null).
|
|
83
|
+
*
|
|
84
|
+
* @example envelopeDataSchemaFor('order.order.paid').parse(envelope.data)
|
|
85
|
+
*/
|
|
86
|
+
export function envelopeDataSchemaFor(routingKey) {
|
|
87
|
+
return withEventMeta(schemaFor(routingKey));
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* True when every message of `routingKey` belongs to one company (`companyId` required), so its
|
|
91
|
+
* consumer must restore the company scope with `scopeFrom: companyScopeFrom` (TEN-7).
|
|
92
|
+
*
|
|
93
|
+
* @example isCompanyScopedEvent('order.order.paid') === true
|
|
94
|
+
*/
|
|
95
|
+
export function isCompanyScopedEvent(routingKey) {
|
|
96
|
+
const schema = schemaFor(routingKey);
|
|
97
|
+
const shape = 'shape' in schema ? schema.shape : undefined;
|
|
98
|
+
return !!shape?.companyId && !shape.companyId.isOptional() && !shape.companyId.isNullable();
|
|
99
|
+
}
|
|
100
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/events/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAC;AACvF,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EACL,yBAAyB,EACzB,qBAAqB,EACrB,sBAAsB,EACtB,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAEtD,cAAc,WAAW,CAAC;AAC1B,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAC9F,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,EACvB,+BAA+B,EAC/B,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAE3B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,EAAE,GAAG,SAAS,EAAE,QAAQ,EAAE,aAAa,EAAE;IAC/C,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,UAAU;IACjB,OAAO,EAAE,YAAY;IACrB,KAAK,EAAE,UAAU;IACjB,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,UAAU;IACjB,OAAO,EAAE,YAAY;IACrB,QAAQ,EAAE,aAAa;IACvB,KAAK,EAAE,UAAU;IACjB,YAAY,EAAE,yBAAyB;IACvC,KAAK,EAAE,EAAE,QAAQ,EAAE,mBAAmB,EAAE,OAAO,EAAE,sBAAsB,EAAE;IACzE,cAAc,EAAE,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,uBAAuB,EAAE;CACxE,CAAC,CAAC;AAEZ,gEAAgE;AAChE,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC;IACzC,GAAG,WAAW;IACd,GAAG,eAAe;IAClB,GAAG,cAAc;IACjB,GAAG,YAAY;IACf,GAAG,cAAc;IACjB,GAAG,YAAY;IACf,GAAG,WAAW;IACd,GAAG,YAAY;IACf,GAAG,cAAc;IACjB,GAAG,eAAe;IAClB,GAAG,YAAY;IACf,GAAG,YAAY;IACf,GAAG,sBAAsB;CAC1B,CAAC,CAAC;AAEH,qEAAqE;AACrE,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,qBAAqB,EAAE,CAAC,CAAC;AAE3E,qDAAqD;AACrD,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,GAAG,aAAa,EAAE,GAAG,eAAe,EAAE,CAAC,CAAC;AAkBvF,oCAAoC;AACpC,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAiB,CAAC,CAAC;AAE5F;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAuB,UAAa;IAC3D,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,UAAU,GAAG,CAAC,CAAC;IACtF,OAAO,eAAe,CAAC,UAAU,CAAC,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAuB,UAAa;IACvE,OAAO,aAAa,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,UAAsB;IACzD,MAAM,MAAM,GAAG,SAAS,CAAC,UAAU,CAAiB,CAAC;IACrD,MAAM,KAAK,GAAG,OAAO,IAAI,MAAM,CAAC,CAAC,CAAE,MAAyB,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/E,OAAO,CAAC,CAAC,KAAK,EAAE,SAAS,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;AAC9F,CAAC"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/** media-service events: uploads and image processing. */
|
|
2
|
+
import { z } from '@heavybit/shared-lib';
|
|
3
|
+
import { id, tenantPayload } from './base.js';
|
|
4
|
+
/** Routing keys published by media-service. */
|
|
5
|
+
export const MEDIA_KEYS = {
|
|
6
|
+
file: { uploaded: 'media.file.uploaded', processed: 'media.file.processed' },
|
|
7
|
+
};
|
|
8
|
+
const k = MEDIA_KEYS.file;
|
|
9
|
+
/** v1 payload schemas of the media events. */
|
|
10
|
+
export const MEDIA_EVENTS = {
|
|
11
|
+
[k.uploaded]: tenantPayload({ fileId: id, purpose: z.string().max(64), contentType: z.string().max(100), sizeBytes: z.number().int().min(0) }),
|
|
12
|
+
[k.processed]: tenantPayload({ fileId: id, status: z.enum(['ready', 'failed']) }),
|
|
13
|
+
};
|
|
14
|
+
//# sourceMappingURL=media.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"media.js","sourceRoot":"","sources":["../../../src/events/media.ts"],"names":[],"mappings":"AAAA,0DAA0D;AAC1D,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,EAAE,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE9C,+CAA+C;AAC/C,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,IAAI,EAAE,EAAE,QAAQ,EAAE,qBAAqB,EAAE,SAAS,EAAE,sBAAsB,EAAE;CACpE,CAAC;AAEX,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;AAE1B,8CAA8C;AAC9C,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9I,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC;CACzE,CAAC"}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The notification command and socket security events.
|
|
3
|
+
*
|
|
4
|
+
* `notification.send.requested` is a **command** on the `commands` exchange (one owner:
|
|
5
|
+
* notification-service). It is the only message that carries a recipient's address, because the
|
|
6
|
+
* notification-service needs it to deliver; domain events carry user ids instead.
|
|
7
|
+
*/
|
|
8
|
+
import { z } from '@heavybit/shared-lib';
|
|
9
|
+
import { notificationDispatchSchema } from '../app.js';
|
|
10
|
+
import { forEachKey, id, optionalTenantPayload, perPublisher, reason } from './base.js';
|
|
11
|
+
/** Command routing keys (published with `enqueueOutbox(tx, key, data, { exchange: 'commands' })`). */
|
|
12
|
+
export const NOTIFICATION_COMMAND_KEYS = {
|
|
13
|
+
send: { requested: 'notification.send.requested' },
|
|
14
|
+
};
|
|
15
|
+
/** Exchange kind of every key in {@link NOTIFICATION_COMMAND_KEYS} (`enqueueOutbox(..., { exchange })`, consumer bindings). */
|
|
16
|
+
export const COMMAND_EXCHANGE = 'commands';
|
|
17
|
+
/** Exchange kind of every event in the catalogue (topic fan-out). */
|
|
18
|
+
export const EVENT_EXCHANGE = 'events';
|
|
19
|
+
/**
|
|
20
|
+
* v1 payload of `notification.send.requested`: a dispatch in the app's vocabulary plus the company it
|
|
21
|
+
* concerns (null for account-level mail such as a sign-up code). Unknown fields pass through.
|
|
22
|
+
*/
|
|
23
|
+
export const notificationSendRequestedSchema = z.object({ companyId: id.nullable() }).passthrough().and(notificationDispatchSchema);
|
|
24
|
+
/** Commands with their schemas. */
|
|
25
|
+
export const NOTIFICATION_COMMANDS = {
|
|
26
|
+
[NOTIFICATION_COMMAND_KEYS.send.requested]: notificationSendRequestedSchema,
|
|
27
|
+
};
|
|
28
|
+
/** Binding pattern for security monitoring: every publisher's rejected socket handshakes. */
|
|
29
|
+
export const SOCKET_REJECTED_PATTERN = '*.security.socket_rejected';
|
|
30
|
+
/** `{publisher}.security.socket_rejected` for each publisher. */
|
|
31
|
+
export const SOCKET_REJECTED_KEYS = perPublisher('security.socket_rejected');
|
|
32
|
+
/** v1 payload of a rejected socket handshake (no ticket, IP or headers). */
|
|
33
|
+
export const socketRejectedSchema = optionalTenantPayload({
|
|
34
|
+
userId: id.nullable(),
|
|
35
|
+
namespace: z.string().max(100),
|
|
36
|
+
reason,
|
|
37
|
+
});
|
|
38
|
+
/** Every socket-rejected routing key with its schema. */
|
|
39
|
+
export const SOCKET_REJECTED_EVENTS = forEachKey(SOCKET_REJECTED_KEYS, socketRejectedSchema);
|
|
40
|
+
//# sourceMappingURL=notification.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"notification.js","sourceRoot":"","sources":["../../../src/events/notification.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AACzC,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,EAAE,EAAE,qBAAqB,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAExF,sGAAsG;AACtG,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,IAAI,EAAE,EAAE,SAAS,EAAE,6BAA6B,EAAE;CAC1C,CAAC;AAEX,+HAA+H;AAC/H,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAmB,CAAC;AAEpD,qEAAqE;AACrE,MAAM,CAAC,MAAM,cAAc,GAAG,QAAiB,CAAC;AAEhD;;;GAGG;AACH,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;AAEpI,mCAAmC;AACnC,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,CAAC,yBAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,+BAA+B;CACnE,CAAC;AAEX,6FAA6F;AAC7F,MAAM,CAAC,MAAM,uBAAuB,GAAG,4BAAqC,CAAC;AAE7E,iEAAiE;AACjE,MAAM,CAAC,MAAM,oBAAoB,GAAG,YAAY,CAAC,0BAA0B,CAAC,CAAC;AAE7E,4EAA4E;AAC5E,MAAM,CAAC,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;IACxD,MAAM,EAAE,EAAE,CAAC,QAAQ,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;IAC9B,MAAM;CACP,CAAC,CAAC;AAEH,yDAAyD;AACzD,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAC,oBAAoB,EAAE,oBAAoB,CAAC,CAAC"}
|