@heavybit/ecommerce-contracts 0.3.13 → 0.3.16

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 (57) hide show
  1. package/dist/cjs/events/base.js +1 -1
  2. package/dist/cjs/events/base.js.map +1 -1
  3. package/dist/cjs/events/engagement.js +52 -0
  4. package/dist/cjs/events/engagement.js.map +1 -0
  5. package/dist/cjs/events/index.js +3 -0
  6. package/dist/cjs/events/index.js.map +1 -1
  7. package/dist/cjs/events/notification.js +9 -2
  8. package/dist/cjs/events/notification.js.map +1 -1
  9. package/dist/cjs/internal/catalog.js +2 -0
  10. package/dist/cjs/internal/catalog.js.map +1 -1
  11. package/dist/cjs/internal/index.js +2 -0
  12. package/dist/cjs/internal/index.js.map +1 -1
  13. package/dist/cjs/internal/moderation.js +20 -0
  14. package/dist/cjs/internal/moderation.js.map +1 -0
  15. package/dist/cjs/internal/reviews.js +26 -0
  16. package/dist/cjs/internal/reviews.js.map +1 -0
  17. package/dist/cjs/permissions.js +2 -0
  18. package/dist/cjs/permissions.js.map +1 -1
  19. package/dist/esm/events/base.js +1 -1
  20. package/dist/esm/events/base.js.map +1 -1
  21. package/dist/esm/events/engagement.js +49 -0
  22. package/dist/esm/events/engagement.js.map +1 -0
  23. package/dist/esm/events/index.js +3 -0
  24. package/dist/esm/events/index.js.map +1 -1
  25. package/dist/esm/events/notification.js +8 -1
  26. package/dist/esm/events/notification.js.map +1 -1
  27. package/dist/esm/internal/catalog.js +2 -0
  28. package/dist/esm/internal/catalog.js.map +1 -1
  29. package/dist/esm/internal/index.js +2 -0
  30. package/dist/esm/internal/index.js.map +1 -1
  31. package/dist/esm/internal/moderation.js +17 -0
  32. package/dist/esm/internal/moderation.js.map +1 -0
  33. package/dist/esm/internal/reviews.js +23 -0
  34. package/dist/esm/internal/reviews.js.map +1 -0
  35. package/dist/esm/permissions.js +2 -0
  36. package/dist/esm/permissions.js.map +1 -1
  37. package/dist/types/events/audit.d.ts +3 -1
  38. package/dist/types/events/audit.d.ts.map +1 -1
  39. package/dist/types/events/base.d.ts +1 -1
  40. package/dist/types/events/base.d.ts.map +1 -1
  41. package/dist/types/events/engagement.d.ts +161 -0
  42. package/dist/types/events/engagement.d.ts.map +1 -0
  43. package/dist/types/events/index.d.ts +494 -1
  44. package/dist/types/events/index.d.ts.map +1 -1
  45. package/dist/types/events/notification.d.ts +41 -1
  46. package/dist/types/events/notification.d.ts.map +1 -1
  47. package/dist/types/internal/catalog.d.ts +24 -0
  48. package/dist/types/internal/catalog.d.ts.map +1 -1
  49. package/dist/types/internal/index.d.ts +2 -0
  50. package/dist/types/internal/index.d.ts.map +1 -1
  51. package/dist/types/internal/moderation.d.ts +38 -0
  52. package/dist/types/internal/moderation.d.ts.map +1 -0
  53. package/dist/types/internal/reviews.d.ts +54 -0
  54. package/dist/types/internal/reviews.d.ts.map +1 -0
  55. package/dist/types/permissions.d.ts +2 -0
  56. package/dist/types/permissions.d.ts.map +1 -1
  57. package/package.json +1 -1
@@ -1 +1 @@
1
- {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/events/base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAY,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAGnD,gEAAgE;AAChE,eAAO,MAAM,aAAa,EAAG,CAAU,CAAC;AAExC,2BAA2B;AAC3B,eAAO,MAAM,EAAE,aAAW,CAAC;AAE3B,+GAA+G;AAC/G,eAAO,MAAM,MAAM,aAAwF,CAAC;AAE5G,wDAAwD;AACxD,eAAO,MAAM,QAAQ,qBAAsB,CAAC;AAE5C,kEAAkE;AAClE,eAAO,MAAM,SAAS,aAAwC,CAAC;AAE/D,uDAAuD;AACvD,eAAO,MAAM,MAAM,aAA6B,CAAC;AAEjD,6DAA6D;AAC7D,eAAO,MAAM,aAAa,iCAAsC,CAAC;AAEjE,uGAAuG;AACvG,eAAO,MAAM,KAAK,2FAAkG,CAAC;AAErH;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC;;;;;;qCAE9D;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC;;;;;;qCAEtE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC,sJAE5D;AAED,6EAA6E;AAC7E,eAAO,MAAM,cAAc;;;IAGzB,oFAAoF;;CAErF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;;;IAT7D,oFAAoF;;;;;;;;;;IAWrF;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,gIAAiI,CAAC;AAE/J,8BAA8B;AAC9B,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG;IAAE,QAAQ,EAAE,CAAC,IAAI,cAAc,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE;CAAE,CAE/G;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE;IAAE,QAAQ,EAAE,CAAC,IAAI,cAAc,GAAG,CAAC;CAAE,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEpH"}
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/events/base.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAY,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAGnD,gEAAgE;AAChE,eAAO,MAAM,aAAa,EAAG,CAAU,CAAC;AAExC,2BAA2B;AAC3B,eAAO,MAAM,EAAE,aAAW,CAAC;AAE3B,+GAA+G;AAC/G,eAAO,MAAM,MAAM,aAAwF,CAAC;AAE5G,wDAAwD;AACxD,eAAO,MAAM,QAAQ,qBAAsB,CAAC;AAE5C,kEAAkE;AAClE,eAAO,MAAM,SAAS,aAAwC,CAAC;AAE/D,uDAAuD;AACvD,eAAO,MAAM,MAAM,aAA6B,CAAC;AAEjD,6DAA6D;AAC7D,eAAO,MAAM,aAAa,iCAAsC,CAAC;AAEjE,uGAAuG;AACvG,eAAO,MAAM,KAAK,2FAAkG,CAAC;AAErH;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC;;;;;;qCAE9D;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC;;;;;;qCAEtE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,CAAC,sJAE5D;AAED,6EAA6E;AAC7E,eAAO,MAAM,cAAc;;;IAGzB,oFAAoF;;CAErF,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;;;IAT7D,oFAAoF;;;;;;;;;;IAWrF;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,2JAA4J,CAAC;AAE1L,8BAA8B;AAC9B,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/D;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG;IAAE,QAAQ,EAAE,CAAC,IAAI,cAAc,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE;CAAE,CAE/G;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE;IAAE,QAAQ,EAAE,CAAC,IAAI,cAAc,GAAG,CAAC;CAAE,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAEpH"}
@@ -0,0 +1,161 @@
1
+ /** engagement-service events: the per-company customer list built from order events, and reviews with their rating snapshot (Phase 22). */
2
+ import { z } from '@heavybit/shared-lib';
3
+ /** Routing keys published by engagement-service. */
4
+ export declare const ENGAGEMENT_KEYS: {
5
+ readonly customer: {
6
+ readonly created: "engagement.customer.created";
7
+ };
8
+ readonly consent: {
9
+ readonly changed: "engagement.consent.changed";
10
+ };
11
+ readonly report: {
12
+ readonly decided: "engagement.report.decided";
13
+ };
14
+ readonly review: {
15
+ readonly created: "engagement.review.created";
16
+ readonly hidden: "engagement.review.hidden";
17
+ readonly ratingChanged: "engagement.review.rating_changed";
18
+ };
19
+ };
20
+ /** v1 payload schemas of the engagement events. `userId` is the shopper's account; no contact details travel in events. */
21
+ export declare const ENGAGEMENT_EVENTS: {
22
+ readonly "engagement.customer.created": z.ZodObject<{
23
+ companyId: z.ZodString;
24
+ } & {
25
+ customerId: z.ZodString;
26
+ userId: z.ZodString;
27
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
28
+ companyId: z.ZodString;
29
+ } & {
30
+ customerId: z.ZodString;
31
+ userId: z.ZodString;
32
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
33
+ companyId: z.ZodString;
34
+ } & {
35
+ customerId: z.ZodString;
36
+ userId: z.ZodString;
37
+ }, z.ZodTypeAny, "passthrough">>;
38
+ /**
39
+ * A shopper's marketing consent for one shop changed (opt-in, withdrawal, newsletter confirmation or an unsubscribe link). The
40
+ * single source of truth is engagement-service; Phase 24's sender reads it. No contact details travel (PRV-2).
41
+ */
42
+ readonly "engagement.consent.changed": z.ZodObject<{
43
+ companyId: z.ZodString;
44
+ } & {
45
+ userId: z.ZodString;
46
+ channel: z.ZodLiteral<"email">;
47
+ granted: z.ZodBoolean;
48
+ source: z.ZodEnum<["account", "newsletter", "unsubscribe_link"]>;
49
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
50
+ companyId: z.ZodString;
51
+ } & {
52
+ userId: z.ZodString;
53
+ channel: z.ZodLiteral<"email">;
54
+ granted: z.ZodBoolean;
55
+ source: z.ZodEnum<["account", "newsletter", "unsubscribe_link"]>;
56
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
57
+ companyId: z.ZodString;
58
+ } & {
59
+ userId: z.ZodString;
60
+ channel: z.ZodLiteral<"email">;
61
+ granted: z.ZodBoolean;
62
+ source: z.ZodEnum<["account", "newsletter", "unsubscribe_link"]>;
63
+ }, z.ZodTypeAny, "passthrough">>;
64
+ /** The platform decided a content report. `action` says what happened to the target (`none` when it was dismissed). */
65
+ readonly "engagement.report.decided": z.ZodObject<{
66
+ companyId: z.ZodString;
67
+ } & {
68
+ reportId: z.ZodString;
69
+ targetType: z.ZodEnum<["review", "product"]>;
70
+ targetId: z.ZodString;
71
+ decision: z.ZodEnum<["upheld", "dismissed"]>;
72
+ action: z.ZodEnum<["hide_review", "disable_product", "none"]>;
73
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
74
+ companyId: z.ZodString;
75
+ } & {
76
+ reportId: z.ZodString;
77
+ targetType: z.ZodEnum<["review", "product"]>;
78
+ targetId: z.ZodString;
79
+ decision: z.ZodEnum<["upheld", "dismissed"]>;
80
+ action: z.ZodEnum<["hide_review", "disable_product", "none"]>;
81
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
82
+ companyId: z.ZodString;
83
+ } & {
84
+ reportId: z.ZodString;
85
+ targetType: z.ZodEnum<["review", "product"]>;
86
+ targetId: z.ZodString;
87
+ decision: z.ZodEnum<["upheld", "dismissed"]>;
88
+ action: z.ZodEnum<["hide_review", "disable_product", "none"]>;
89
+ }, z.ZodTypeAny, "passthrough">>;
90
+ /** A shopper reviewed a delivered item (tells the shop's managers). The text itself never travels. */
91
+ readonly "engagement.review.created": z.ZodObject<{
92
+ companyId: z.ZodString;
93
+ } & {
94
+ reviewId: z.ZodString;
95
+ productId: z.ZodString;
96
+ userId: z.ZodString;
97
+ rating: z.ZodNumber;
98
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
99
+ companyId: z.ZodString;
100
+ } & {
101
+ reviewId: z.ZodString;
102
+ productId: z.ZodString;
103
+ userId: z.ZodString;
104
+ rating: z.ZodNumber;
105
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
106
+ companyId: z.ZodString;
107
+ } & {
108
+ reviewId: z.ZodString;
109
+ productId: z.ZodString;
110
+ userId: z.ZodString;
111
+ rating: z.ZodNumber;
112
+ }, z.ZodTypeAny, "passthrough">>;
113
+ /** A shop hid (or un-hid) a review; `hidden` says which. */
114
+ readonly "engagement.review.hidden": z.ZodObject<{
115
+ companyId: z.ZodString;
116
+ } & {
117
+ reviewId: z.ZodString;
118
+ productId: z.ZodString;
119
+ hidden: z.ZodBoolean;
120
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
121
+ companyId: z.ZodString;
122
+ } & {
123
+ reviewId: z.ZodString;
124
+ productId: z.ZodString;
125
+ hidden: z.ZodBoolean;
126
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
127
+ companyId: z.ZodString;
128
+ } & {
129
+ reviewId: z.ZodString;
130
+ productId: z.ZodString;
131
+ hidden: z.ZodBoolean;
132
+ }, z.ZodTypeAny, "passthrough">>;
133
+ /**
134
+ * Absolute rating of a product after any change to its published reviews (D31). `ratingVersion` grows by one on every
135
+ * recomputation, so catalog applies a snapshot only when it is newer than the one it holds (out-of-order safe, replay safe).
136
+ * `ratingAvg` is a decimal string with 2 dp (`"4.33"`, `"0.00"` without reviews).
137
+ */
138
+ readonly "engagement.review.rating_changed": z.ZodObject<{
139
+ companyId: z.ZodString;
140
+ } & {
141
+ productId: z.ZodString;
142
+ ratingAvg: z.ZodString;
143
+ ratingCount: z.ZodNumber;
144
+ ratingVersion: z.ZodNumber;
145
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
146
+ companyId: z.ZodString;
147
+ } & {
148
+ productId: z.ZodString;
149
+ ratingAvg: z.ZodString;
150
+ ratingCount: z.ZodNumber;
151
+ ratingVersion: z.ZodNumber;
152
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
153
+ companyId: z.ZodString;
154
+ } & {
155
+ productId: z.ZodString;
156
+ ratingAvg: z.ZodString;
157
+ ratingCount: z.ZodNumber;
158
+ ratingVersion: z.ZodNumber;
159
+ }, z.ZodTypeAny, "passthrough">>;
160
+ };
161
+ //# sourceMappingURL=engagement.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"engagement.d.ts","sourceRoot":"","sources":["../../../src/events/engagement.ts"],"names":[],"mappings":"AAAA,2IAA2I;AAC3I,OAAO,EAAE,CAAC,EAAE,MAAM,sBAAsB,CAAC;AAGzC,oDAAoD;AACpD,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;CAKlB,CAAC;AAIX,2HAA2H;AAC3H,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;IAE5B;;;OAGG;;;;;;;;;;;;;;;;;;;;;;;IAOH,uHAAuH;;;;;;;;;;;;;;;;;;;;;;;;;;IAQvH,sGAAsG;;;;;;;;;;;;;;;;;;;;;;;IAEtG,4DAA4D;;;;;;;;;;;;;;;;;;;;IAE5D;;;;OAIG;;;;;;;;;;;;;;;;;;;;;;;CAOK,CAAC"}