projection.ts

packages/plinth-client/src/projection.ts

1. /**
2. * What the sync keeps from a Plinth order.
3. *
4. * Not the Northgate rules. The agency's Plinth schema notes classify fields for a
5. * client-facing integration where an unverified caller might see the response;
6. * hence their very aggressive `strip` list. This dashboard is internal, behind
7. * auth, read by a small team who already have Plinth logins. Those constraints do
8. * not transfer.
9. *
10. * The line used here is the team's existing data-handling rule:
11. *
12. * "Client names in an order context are fine. Contact details, addresses, and
13. * payment information are not."
14. *
15. * There is a practical reason on top of the policy one. The snapshot database is
16. * a new copy of customer data in a new place. Keeping a name and a company costs
17. * nothing and makes every row readable at a glance. Keeping billing addresses,
18. * emails, and phone numbers turns this dashboard's storage into a secondary PII
19. * store that has to be secured, backed up, and eventually deleted, in exchange
20. * for fields no panel displays.
21. *
22. * If a panel ever needs a dropped field, add it here deliberately rather than
23. * widening the projection "just in case."
24. */
26. /** Order-level fields the snapshot keeps. */
27. export const ORDER_FIELDS = [
28. 'order_ref',
29. 'status_code',
30. 'status_label',
31. 'closed_on', // NOTE: order PLACED datetime, despite the name.
32. 'grand_total',
33. 'subtotal',
34. 'shipping_total',
35. 'discount_total',
36. 'ship_weight',
37. 'account_ref',
38. 'account_kind',
39. 'shop',
40. 'dept_ref',
41. 'customer_group', // Retail / Palladium Partner / ...: segment, not PII
42. 'sales_rep', // null on every order sampled so far
43. 'press_name', // the VENDOR, not a designer
44. 'production_owner', // order-level assignment
45. 'account_owner', // note the spelling; also per product line (see PRODUCT_FIELDS)
46. 'proof_approver',
47. 'tracking_no',
48. 'carier_name', // sic
49. 'purchase_order',
50. ] as const
52. /** Identifying-but-useful. Kept per the data-handling rule above: names in an order context. */
53. export const ORDER_IDENTITY_FIELDS = [
54. 'first_name',
55. 'last_name',
56. 'company_name',
57. 'ship_company',
58. ] as const
60. /** Product-line fields. Where the real design/production status lives. */
61. export const PRODUCT_FIELDS = [
62. 'line_ref',
63. 'item_ref',
64. 'line_status',
65. 'line_status_code', // preferred over the name
66. 'production_owner', // the designer
67. 'account_owner', // the CS rep (note the spelling)
68. 'item_name',
69. 'qty',
70. 'unit_price',
71. 'item_size',
72. 'kit_flag',
73. 'storage_days',
74. ] as const
76. /**
77. * Explicitly dropped. Listed rather than merely omitted so the decision is
78. * visible and reversible, and so nobody re-adds them by accident.
79. */
80. export const DROPPED_FIELDS = {
81. contact: ['email', 'phone'],
82. addresses: [
83. 'ship_name',
84. 'ship_street',
85. 'ship_district',
86. 'ship_city',
87. 'ship_postcode',
88. 'ship_region',
89. 'ship_region_code',
90. 'ship_country',
91. 'bill_name',
92. 'bill_company',
93. 'bill_street',
94. 'bill_district',
95. 'bill_city',
96. 'bill_postcode',
97. 'bill_region',
98. 'bill_region_code',
99. 'bill_country',
100. ],
101. payment: ['tax_total'],
102. /**
103. * Artwork URL sets. Dropped for size, not sensitivity: a five-panel booth
104. * carries ~36 CloudFront URLs across customer-supplied, print-ready, and
105. * thumbnail variants. Nothing on the dashboard renders them, and persisting
106. * them would multiply snapshot size for no gain. Fetch on demand from a
107. * detail view if one is ever built.
108. */
109. artwork: ['printfile_info'],
110. } as const
112. const KEEP = new Set<string>([...ORDER_FIELDS, ...ORDER_IDENTITY_FIELDS])
113. const KEEP_PRODUCT = new Set<string>(PRODUCT_FIELDS)
115. export function projectOrder(raw: Record<string, unknown>): Record<string, unknown> {
116. const out: Record<string, unknown> = {}
117. for (const k of Object.keys(raw)) if (KEEP.has(k)) out[k] = raw[k]
118. return out
119. }
121. export function projectProduct(raw: Record<string, unknown>): Record<string, unknown> {
122. const out: Record<string, unknown> = {}
123. for (const k of Object.keys(raw)) if (KEEP_PRODUCT.has(k)) out[k] = raw[k]
124. return out
125. }