@vrplatform/api 1.3.1-stage.4038 → 1.3.1-stage.40382932747

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 (107) hide show
  1. package/build/main/cache.js +10 -7
  2. package/build/main/cache.js.map +1 -1
  3. package/build/main/client.d.ts +6 -2
  4. package/build/main/client.js +18 -15
  5. package/build/main/client.js.map +1 -1
  6. package/build/main/control-plane-routing.d.ts +6 -0
  7. package/build/main/control-plane-routing.js +34 -0
  8. package/build/main/control-plane-routing.js.map +1 -0
  9. package/build/main/embed-lifecycle.d.ts +140 -0
  10. package/build/main/embed-lifecycle.js +126 -0
  11. package/build/main/embed-lifecycle.js.map +1 -0
  12. package/build/main/error.d.ts +31 -17
  13. package/build/main/error.js +55 -32
  14. package/build/main/error.js.map +1 -1
  15. package/build/main/generated/routing.d.ts +11 -0
  16. package/build/main/generated/routing.js +284 -0
  17. package/build/main/generated/routing.js.map +1 -0
  18. package/build/main/generated/v1.d.ts +4 -62610
  19. package/build/main/generated/v1.js.map +4 -1
  20. package/build/main/index.d.ts +8 -0
  21. package/build/main/index.js +8 -0
  22. package/build/main/index.js.map +1 -1
  23. package/build/main/is-test-team.d.ts +18 -0
  24. package/build/main/is-test-team.js +27 -0
  25. package/build/main/is-test-team.js.map +1 -0
  26. package/build/main/is-test-user.d.ts +4 -0
  27. package/build/main/is-test-user.js +31 -0
  28. package/build/main/is-test-user.js.map +1 -0
  29. package/build/main/is-vrp-member.d.ts +4 -0
  30. package/build/main/is-vrp-member.js +33 -0
  31. package/build/main/is-vrp-member.js.map +1 -0
  32. package/build/main/retarget-request.d.ts +7 -0
  33. package/build/main/retarget-request.js +21 -0
  34. package/build/main/retarget-request.js.map +1 -0
  35. package/build/main/routing.d.ts +24 -0
  36. package/build/main/routing.js +62 -0
  37. package/build/main/routing.js.map +1 -0
  38. package/build/main/types.d.ts +2 -0
  39. package/build/main/types.js.map +1 -1
  40. package/build/main/vrt-mcp.d.ts +214 -0
  41. package/build/main/vrt-mcp.js +194 -0
  42. package/build/main/vrt-mcp.js.map +1 -0
  43. package/build/module/cache.js +10 -7
  44. package/build/module/cache.js.map +1 -1
  45. package/build/module/client.d.ts +6 -2
  46. package/build/module/client.js +18 -15
  47. package/build/module/client.js.map +1 -1
  48. package/build/module/control-plane-routing.d.ts +6 -0
  49. package/build/module/control-plane-routing.js +30 -0
  50. package/build/module/control-plane-routing.js.map +1 -0
  51. package/build/module/embed-lifecycle.d.ts +140 -0
  52. package/build/module/embed-lifecycle.js +90 -0
  53. package/build/module/embed-lifecycle.js.map +1 -0
  54. package/build/module/error.d.ts +31 -17
  55. package/build/module/error.js +57 -31
  56. package/build/module/error.js.map +1 -1
  57. package/build/module/generated/routing.d.ts +11 -0
  58. package/build/module/generated/routing.js +281 -0
  59. package/build/module/generated/routing.js.map +1 -0
  60. package/build/module/generated/v1.d.ts +4 -62610
  61. package/build/module/generated/v1.js.map +4 -1
  62. package/build/module/index.d.ts +8 -0
  63. package/build/module/index.js +8 -0
  64. package/build/module/index.js.map +1 -1
  65. package/build/module/is-test-team.d.ts +18 -0
  66. package/build/module/is-test-team.js +22 -0
  67. package/build/module/is-test-team.js.map +1 -0
  68. package/build/module/is-test-user.d.ts +4 -0
  69. package/build/module/is-test-user.js +27 -0
  70. package/build/module/is-test-user.js.map +1 -0
  71. package/build/module/is-vrp-member.d.ts +4 -0
  72. package/build/module/is-vrp-member.js +29 -0
  73. package/build/module/is-vrp-member.js.map +1 -0
  74. package/build/module/retarget-request.d.ts +7 -0
  75. package/build/module/retarget-request.js +18 -0
  76. package/build/module/retarget-request.js.map +1 -0
  77. package/build/module/routing.d.ts +24 -0
  78. package/build/module/routing.js +58 -0
  79. package/build/module/routing.js.map +1 -0
  80. package/build/module/types.d.ts +2 -0
  81. package/build/module/types.js.map +1 -1
  82. package/build/module/vrt-mcp.d.ts +214 -0
  83. package/build/module/vrt-mcp.js +158 -0
  84. package/build/module/vrt-mcp.js.map +1 -0
  85. package/package.json +8 -7
  86. package/src/cache.ts +11 -8
  87. package/src/client.ts +20 -17
  88. package/src/control-plane-routing.ts +46 -0
  89. package/src/embed-lifecycle.ts +96 -0
  90. package/src/error.ts +103 -56
  91. package/src/generated/routing.ts +284 -0
  92. package/src/generated/v1.ts +4 -62611
  93. package/src/index.ts +8 -0
  94. package/src/is-test-team.ts +50 -0
  95. package/src/is-test-user.ts +39 -0
  96. package/src/is-vrp-member.ts +38 -0
  97. package/src/retarget-request.ts +17 -0
  98. package/src/routing.ts +89 -0
  99. package/src/types.ts +8 -0
  100. package/src/vrt-mcp.ts +185 -0
  101. package/build/main/generated/openapi-fetch.d.ts +0 -224
  102. package/build/main/generated/openapi-fetch.js +0 -14
  103. package/build/main/generated/openapi-fetch.js.map +0 -1
  104. package/build/module/generated/openapi-fetch.d.ts +0 -224
  105. package/build/module/generated/openapi-fetch.js +0 -2
  106. package/build/module/generated/openapi-fetch.js.map +0 -1
  107. package/src/generated/openapi-fetch.ts +0 -433
@@ -0,0 +1,158 @@
1
+ import * as z from 'zod';
2
+ const vrtLookupLimitSchema = z.number().int().min(1).max(25).default(10);
3
+ const vrtLookupPageSchema = z.number().int().min(1).default(1);
4
+ const vrtDateRangeSchema = z.string().trim().min(1).optional();
5
+ const vrtCsvSchema = z.string().trim().min(1).optional();
6
+ const vrtTeamIdSchema = z.string().uuid().optional();
7
+ export const vrtPaginatedLookupPayloadSchema = z.object({
8
+ data: z.array(z.unknown()),
9
+ pagination: z.object({
10
+ limit: z.number().int(),
11
+ nextPage: z.number().int().optional(),
12
+ page: z.number().int(),
13
+ total: z.number().int(),
14
+ totalPage: z.number().int(),
15
+ }),
16
+ });
17
+ export const vrtPaginatedLookupOutputSchema = vrtPaginatedLookupPayloadSchema.extend({
18
+ schemaVersion: z.literal(1),
19
+ });
20
+ export const vrtListingsLookupSchema = z.object({
21
+ activeOwnership: z.boolean().optional(),
22
+ includeChildren: z.boolean().optional(),
23
+ issue: z
24
+ .enum([
25
+ 'all',
26
+ 'any',
27
+ 'missingOwnershipOrDeactivation',
28
+ 'missingFeesAndCommission',
29
+ 'missingOpeningBalance',
30
+ ])
31
+ .optional(),
32
+ limit: vrtLookupLimitSchema,
33
+ page: vrtLookupPageSchema,
34
+ parent: z.union([z.string().uuid(), z.literal('null')]).optional(),
35
+ search: z.string().trim().min(1).optional(),
36
+ status: z.enum(['active', 'inactive']).optional(),
37
+ teamId: vrtTeamIdSchema,
38
+ });
39
+ export const vrtReservationsLookupSchema = z.object({
40
+ bookingChannel: z.string().trim().min(1).optional(),
41
+ date: vrtDateRangeSchema,
42
+ dateField: z
43
+ .enum([
44
+ 'bookedAt',
45
+ 'cancelledAt',
46
+ 'checkIn',
47
+ 'checkOut',
48
+ 'payment',
49
+ 'intersection',
50
+ ])
51
+ .optional(),
52
+ generalLedgerStatus: z.enum(['active', 'inactive']).optional(),
53
+ ids: vrtCsvSchema,
54
+ includeLines: z.boolean().optional(),
55
+ limit: vrtLookupLimitSchema,
56
+ listingId: z.string().trim().min(1).optional(),
57
+ page: vrtLookupPageSchema,
58
+ paidStatus: z
59
+ .enum([
60
+ 'unpaid',
61
+ 'underpaid',
62
+ 'overpaid',
63
+ 'paid',
64
+ '!unpaid',
65
+ '!underpaid',
66
+ '!overpaid',
67
+ '!paid',
68
+ ])
69
+ .optional(),
70
+ search: z.string().trim().min(1).optional(),
71
+ shortRefs: vrtCsvSchema,
72
+ status: z.enum(['booked', 'canceled', 'inactive']).optional(),
73
+ teamId: vrtTeamIdSchema,
74
+ });
75
+ export const vrtTransactionsLookupSchema = z.object({
76
+ accountId: z.string().trim().min(1).optional(),
77
+ amount: z.string().trim().min(1).optional(),
78
+ contactId: z.string().uuid().optional(),
79
+ dateRange: vrtDateRangeSchema,
80
+ ids: vrtCsvSchema,
81
+ includeLines: z.boolean().optional(),
82
+ limit: vrtLookupLimitSchema,
83
+ listingIds: vrtCsvSchema,
84
+ page: vrtLookupPageSchema,
85
+ paidAtRange: vrtDateRangeSchema,
86
+ paidStatus: z.enum(['unpaid', 'underpaid', 'overpaid', 'paid']).optional(),
87
+ reconciled: z.union([z.boolean(), z.literal('candidate')]).optional(),
88
+ search: z.string().trim().min(1).optional(),
89
+ shortRefs: vrtCsvSchema,
90
+ status: z.enum(['active', 'inactive']).optional(),
91
+ teamId: vrtTeamIdSchema,
92
+ type: z.enum(['deposit', 'expense', 'transfer', 'payout']).optional(),
93
+ uniqueRefs: vrtCsvSchema,
94
+ });
95
+ export const vrtAccountsLookupSchema = z.object({
96
+ bankingCategory: z.enum(['trust', 'operating', 'external']).optional(),
97
+ classification: z
98
+ .enum(['asset', 'liability', 'revenue', 'expense'])
99
+ .optional(),
100
+ limit: vrtLookupLimitSchema,
101
+ page: vrtLookupPageSchema,
102
+ reconciled: z.boolean().optional(),
103
+ search: z.string().trim().min(1).optional(),
104
+ status: z.enum(['active', 'inactive']).optional(),
105
+ teamId: vrtTeamIdSchema,
106
+ type: z.enum(['ledger', 'bank', 'recurringFee', 'nonPosting']).optional(),
107
+ });
108
+ export const vrtStatementsLookupSchema = z.object({
109
+ dateRange: vrtDateRangeSchema,
110
+ isDateRangeEndInclusive: z.boolean().optional(),
111
+ limit: vrtLookupLimitSchema,
112
+ listingIds: vrtCsvSchema,
113
+ month: z
114
+ .string()
115
+ .regex(/^\d{4}-\d{2}$/)
116
+ .optional(),
117
+ ownerIds: vrtCsvSchema,
118
+ page: vrtLookupPageSchema,
119
+ periodIds: vrtCsvSchema,
120
+ recurringFeeIds: vrtCsvSchema,
121
+ search: z.string().trim().min(1).optional(),
122
+ statementIds: vrtCsvSchema,
123
+ status: z.enum(['draft', 'inReview', 'published', 'all']).optional(),
124
+ teamId: vrtTeamIdSchema,
125
+ year: z.number().int().min(1900).max(2100).optional(),
126
+ });
127
+ export const vrtJournalEntriesLookupSchema = z.object({
128
+ accountAssignmentTypes: vrtCsvSchema,
129
+ accountIds: vrtCsvSchema,
130
+ accountType: z
131
+ .enum(['ledger', 'bank', 'recurringFee', 'nonPosting'])
132
+ .optional(),
133
+ amount: z.string().trim().min(1).optional(),
134
+ classifications: vrtCsvSchema,
135
+ date: vrtDateRangeSchema,
136
+ endAt: z.string().trim().min(1).optional(),
137
+ entityTypes: vrtCsvSchema,
138
+ excludeTriggerTypes: vrtCsvSchema,
139
+ excludeTypes: vrtCsvSchema,
140
+ ids: vrtCsvSchema,
141
+ includeDetails: z.boolean().optional(),
142
+ ledger: z.enum(['historical', 'trust', 'operating']).optional(),
143
+ limit: vrtLookupLimitSchema,
144
+ listingIds: vrtCsvSchema,
145
+ ownerStatementIds: vrtCsvSchema,
146
+ page: vrtLookupPageSchema,
147
+ party: z.enum(['owners', 'manager']).optional(),
148
+ published: z.boolean().optional(),
149
+ reservationIds: vrtCsvSchema,
150
+ search: z.string().trim().min(1).optional(),
151
+ startAt: z.string().trim().min(1).optional(),
152
+ status: z.enum(['active', 'inactive']).optional(),
153
+ teamId: vrtTeamIdSchema,
154
+ transactionIds: vrtCsvSchema,
155
+ triggerTypes: vrtCsvSchema,
156
+ types: vrtCsvSchema,
157
+ });
158
+ //# sourceMappingURL=vrt-mcp.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"vrt-mcp.js","sourceRoot":"src/","sources":["vrt-mcp.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAEzB,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AACzE,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC/D,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;AAC/D,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;AACzD,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,CAAC;AAErD,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC,MAAM,CAAC;IACtD,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IAC1B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC;QACnB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACvB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACrC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACtB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACvB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;KAC5B,CAAC;CACH,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,8BAA8B,GACzC,+BAA+B,CAAC,MAAM,CAAC;IACrC,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;CAC5B,CAAC,CAAC;AAEL,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACvC,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACvC,KAAK,EAAE,CAAC;SACL,IAAI,CAAC;QACJ,KAAK;QACL,KAAK;QACL,gCAAgC;QAChC,0BAA0B;QAC1B,uBAAuB;KACxB,CAAC;SACD,QAAQ,EAAE;IACb,KAAK,EAAE,oBAAoB;IAC3B,IAAI,EAAE,mBAAmB;IACzB,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAClE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;IACjD,MAAM,EAAE,eAAe;CACxB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACnD,IAAI,EAAE,kBAAkB;IACxB,SAAS,EAAE,CAAC;SACT,IAAI,CAAC;QACJ,UAAU;QACV,aAAa;QACb,SAAS;QACT,UAAU;QACV,SAAS;QACT,cAAc;KACf,CAAC;SACD,QAAQ,EAAE;IACb,mBAAmB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC9D,GAAG,EAAE,YAAY;IACjB,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,KAAK,EAAE,oBAAoB;IAC3B,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC9C,IAAI,EAAE,mBAAmB;IACzB,UAAU,EAAE,CAAC;SACV,IAAI,CAAC;QACJ,QAAQ;QACR,WAAW;QACX,UAAU;QACV,MAAM;QACN,SAAS;QACT,YAAY;QACZ,WAAW;QACX,OAAO;KACR,CAAC;SACD,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,SAAS,EAAE,YAAY;IACvB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC7D,MAAM,EAAE,eAAe;CACxB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;IACvC,SAAS,EAAE,kBAAkB;IAC7B,GAAG,EAAE,YAAY;IACjB,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACpC,KAAK,EAAE,oBAAoB;IAC3B,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE,kBAAkB;IAC/B,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1E,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,SAAS,EAAE,YAAY;IACvB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;IACjD,MAAM,EAAE,eAAe;IACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE;IACrE,UAAU,EAAE,YAAY;CACzB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;IACtE,cAAc,EAAE,CAAC;SACd,IAAI,CAAC,CAAC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;SAClD,QAAQ,EAAE;IACb,KAAK,EAAE,oBAAoB;IAC3B,IAAI,EAAE,mBAAmB;IACzB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAClC,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;IACjD,MAAM,EAAE,eAAe;IACvB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,EAAE;CAC1E,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,SAAS,EAAE,kBAAkB;IAC7B,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAC/C,KAAK,EAAE,oBAAoB;IAC3B,UAAU,EAAE,YAAY;IACxB,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,KAAK,CAAC,eAAe,CAAC;SACtB,QAAQ,EAAE;IACb,QAAQ,EAAE,YAAY;IACtB,IAAI,EAAE,mBAAmB;IACzB,SAAS,EAAE,YAAY;IACvB,eAAe,EAAE,YAAY;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,YAAY,EAAE,YAAY;IAC1B,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE;IACpE,MAAM,EAAE,eAAe;IACvB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;CACtD,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,sBAAsB,EAAE,YAAY;IACpC,UAAU,EAAE,YAAY;IACxB,WAAW,EAAE,CAAC;SACX,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,YAAY,CAAC,CAAC;SACtD,QAAQ,EAAE;IACb,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,eAAe,EAAE,YAAY;IAC7B,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC1C,WAAW,EAAE,YAAY;IACzB,mBAAmB,EAAE,YAAY;IACjC,YAAY,EAAE,YAAY;IAC1B,GAAG,EAAE,YAAY;IACjB,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACtC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC/D,KAAK,EAAE,oBAAoB;IAC3B,UAAU,EAAE,YAAY;IACxB,iBAAiB,EAAE,YAAY;IAC/B,IAAI,EAAE,mBAAmB;IACzB,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC/C,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACjC,cAAc,EAAE,YAAY;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC3C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAC5C,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;IACjD,MAAM,EAAE,eAAe;IACvB,cAAc,EAAE,YAAY;IAC5B,YAAY,EAAE,YAAY;IAC1B,KAAK,EAAE,YAAY;CACpB,CAAC,CAAC","sourcesContent":["import * as z from 'zod';\n\nconst vrtLookupLimitSchema = z.number().int().min(1).max(25).default(10);\nconst vrtLookupPageSchema = z.number().int().min(1).default(1);\nconst vrtDateRangeSchema = z.string().trim().min(1).optional();\nconst vrtCsvSchema = z.string().trim().min(1).optional();\nconst vrtTeamIdSchema = z.string().uuid().optional();\n\nexport const vrtPaginatedLookupPayloadSchema = z.object({\n data: z.array(z.unknown()),\n pagination: z.object({\n limit: z.number().int(),\n nextPage: z.number().int().optional(),\n page: z.number().int(),\n total: z.number().int(),\n totalPage: z.number().int(),\n }),\n});\n\nexport const vrtPaginatedLookupOutputSchema =\n vrtPaginatedLookupPayloadSchema.extend({\n schemaVersion: z.literal(1),\n });\n\nexport const vrtListingsLookupSchema = z.object({\n activeOwnership: z.boolean().optional(),\n includeChildren: z.boolean().optional(),\n issue: z\n .enum([\n 'all',\n 'any',\n 'missingOwnershipOrDeactivation',\n 'missingFeesAndCommission',\n 'missingOpeningBalance',\n ])\n .optional(),\n limit: vrtLookupLimitSchema,\n page: vrtLookupPageSchema,\n parent: z.union([z.string().uuid(), z.literal('null')]).optional(),\n search: z.string().trim().min(1).optional(),\n status: z.enum(['active', 'inactive']).optional(),\n teamId: vrtTeamIdSchema,\n});\n\nexport const vrtReservationsLookupSchema = z.object({\n bookingChannel: z.string().trim().min(1).optional(),\n date: vrtDateRangeSchema,\n dateField: z\n .enum([\n 'bookedAt',\n 'cancelledAt',\n 'checkIn',\n 'checkOut',\n 'payment',\n 'intersection',\n ])\n .optional(),\n generalLedgerStatus: z.enum(['active', 'inactive']).optional(),\n ids: vrtCsvSchema,\n includeLines: z.boolean().optional(),\n limit: vrtLookupLimitSchema,\n listingId: z.string().trim().min(1).optional(),\n page: vrtLookupPageSchema,\n paidStatus: z\n .enum([\n 'unpaid',\n 'underpaid',\n 'overpaid',\n 'paid',\n '!unpaid',\n '!underpaid',\n '!overpaid',\n '!paid',\n ])\n .optional(),\n search: z.string().trim().min(1).optional(),\n shortRefs: vrtCsvSchema,\n status: z.enum(['booked', 'canceled', 'inactive']).optional(),\n teamId: vrtTeamIdSchema,\n});\n\nexport const vrtTransactionsLookupSchema = z.object({\n accountId: z.string().trim().min(1).optional(),\n amount: z.string().trim().min(1).optional(),\n contactId: z.string().uuid().optional(),\n dateRange: vrtDateRangeSchema,\n ids: vrtCsvSchema,\n includeLines: z.boolean().optional(),\n limit: vrtLookupLimitSchema,\n listingIds: vrtCsvSchema,\n page: vrtLookupPageSchema,\n paidAtRange: vrtDateRangeSchema,\n paidStatus: z.enum(['unpaid', 'underpaid', 'overpaid', 'paid']).optional(),\n reconciled: z.union([z.boolean(), z.literal('candidate')]).optional(),\n search: z.string().trim().min(1).optional(),\n shortRefs: vrtCsvSchema,\n status: z.enum(['active', 'inactive']).optional(),\n teamId: vrtTeamIdSchema,\n type: z.enum(['deposit', 'expense', 'transfer', 'payout']).optional(),\n uniqueRefs: vrtCsvSchema,\n});\n\nexport const vrtAccountsLookupSchema = z.object({\n bankingCategory: z.enum(['trust', 'operating', 'external']).optional(),\n classification: z\n .enum(['asset', 'liability', 'revenue', 'expense'])\n .optional(),\n limit: vrtLookupLimitSchema,\n page: vrtLookupPageSchema,\n reconciled: z.boolean().optional(),\n search: z.string().trim().min(1).optional(),\n status: z.enum(['active', 'inactive']).optional(),\n teamId: vrtTeamIdSchema,\n type: z.enum(['ledger', 'bank', 'recurringFee', 'nonPosting']).optional(),\n});\n\nexport const vrtStatementsLookupSchema = z.object({\n dateRange: vrtDateRangeSchema,\n isDateRangeEndInclusive: z.boolean().optional(),\n limit: vrtLookupLimitSchema,\n listingIds: vrtCsvSchema,\n month: z\n .string()\n .regex(/^\\d{4}-\\d{2}$/)\n .optional(),\n ownerIds: vrtCsvSchema,\n page: vrtLookupPageSchema,\n periodIds: vrtCsvSchema,\n recurringFeeIds: vrtCsvSchema,\n search: z.string().trim().min(1).optional(),\n statementIds: vrtCsvSchema,\n status: z.enum(['draft', 'inReview', 'published', 'all']).optional(),\n teamId: vrtTeamIdSchema,\n year: z.number().int().min(1900).max(2100).optional(),\n});\n\nexport const vrtJournalEntriesLookupSchema = z.object({\n accountAssignmentTypes: vrtCsvSchema,\n accountIds: vrtCsvSchema,\n accountType: z\n .enum(['ledger', 'bank', 'recurringFee', 'nonPosting'])\n .optional(),\n amount: z.string().trim().min(1).optional(),\n classifications: vrtCsvSchema,\n date: vrtDateRangeSchema,\n endAt: z.string().trim().min(1).optional(),\n entityTypes: vrtCsvSchema,\n excludeTriggerTypes: vrtCsvSchema,\n excludeTypes: vrtCsvSchema,\n ids: vrtCsvSchema,\n includeDetails: z.boolean().optional(),\n ledger: z.enum(['historical', 'trust', 'operating']).optional(),\n limit: vrtLookupLimitSchema,\n listingIds: vrtCsvSchema,\n ownerStatementIds: vrtCsvSchema,\n page: vrtLookupPageSchema,\n party: z.enum(['owners', 'manager']).optional(),\n published: z.boolean().optional(),\n reservationIds: vrtCsvSchema,\n search: z.string().trim().min(1).optional(),\n startAt: z.string().trim().min(1).optional(),\n status: z.enum(['active', 'inactive']).optional(),\n teamId: vrtTeamIdSchema,\n transactionIds: vrtCsvSchema,\n triggerTypes: vrtCsvSchema,\n types: vrtCsvSchema,\n});\n\nexport type VrtListingsLookupInput = z.infer<typeof vrtListingsLookupSchema>;\nexport type VrtReservationsLookupInput = z.infer<\n typeof vrtReservationsLookupSchema\n>;\nexport type VrtTransactionsLookupInput = z.infer<\n typeof vrtTransactionsLookupSchema\n>;\nexport type VrtAccountsLookupInput = z.infer<typeof vrtAccountsLookupSchema>;\nexport type VrtStatementsLookupInput = z.infer<\n typeof vrtStatementsLookupSchema\n>;\nexport type VrtJournalEntriesLookupInput = z.infer<\n typeof vrtJournalEntriesLookupSchema\n>;\nexport type VrtPaginatedLookupOutput = z.infer<\n typeof vrtPaginatedLookupOutputSchema\n>;\n"]}
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "1.3.1-stage.4038",
6
+ "version": "1.3.1-stage.40382932747",
7
7
  "description": "",
8
8
  "main": "build/main/index.js",
9
9
  "module": "build/module/index.js",
@@ -12,28 +12,29 @@
12
12
  "npmpub": "bun run build && bunx vrp-publish && bunx vrp-deploy --prefix npmpub",
13
13
  "npmpub:staging": "npm publish package.tgz --tag staging",
14
14
  "npmpub:production": "npm publish package.tgz --tag latest",
15
+ "npmpub:preview": "npm publish package.tgz --tag preview",
15
16
  "build": "bun run generate-client && bun build:main && bun build:module",
16
17
  "build:main": "tsc -b tsconfig.main.json",
17
18
  "build:module": "tsc -b tsconfig.esm.json",
18
- "dev": "NODE_ENV=generator bun --watch ./generate.ts",
19
19
  "generate-client": "bun generate:schema && bun generate:client",
20
20
  "generate:schema": "NODE_ENV=generator bun ./openapi.ts",
21
21
  "generate:client": "bunx --bun openapi-typescript ./openapi.json -o ./src/generated/v1.ts",
22
- "tsgo": "tsc --noEmit"
22
+ "tsgo": "tsc -b tsconfig.src.json tsconfig.test.json"
23
23
  },
24
24
  "author": "",
25
25
  "license": "ISC",
26
26
  "dependencies": {
27
27
  "openapi-fetch": "0.15.0",
28
- "openapi-typescript": "^7.10.1",
29
- "openapi-typescript-helpers": "^0.0.15"
28
+ "openapi-typescript": "^7.13.0",
29
+ "zod": "^4.6.6"
30
30
  },
31
31
  "peerDependencies": {
32
- "@vrplatform/utils": "*",
32
+ "@vrplatform/utils": "1.0.21",
33
33
  "@sentry/core": "*"
34
34
  },
35
35
  "devDependencies": {
36
- "@vrplatform/bin": "*"
36
+ "@vrplatform/bin": "*",
37
+ "jsonc-parser": "3.3.1"
37
38
  },
38
39
  "files": [
39
40
  "build/main",
package/src/cache.ts CHANGED
@@ -30,19 +30,22 @@ export function useCache<T, A>(
30
30
  if (existingPromise) return existingPromise;
31
31
 
32
32
  // Start new fetch
33
- try {
34
- const promise = fetchFn(arg);
35
- fetchPromises.set(cacheKey, promise);
33
+ const promise = fetchFn(arg);
34
+ fetchPromises.set(cacheKey, promise);
36
35
 
36
+ try {
37
37
  const freshValue = await promise;
38
- cacheMap.set(cacheKey, {
39
- value: freshValue,
40
- expiresAt: Date.now() + expiryTimeMs,
41
- });
38
+ if (fetchPromises.get(cacheKey) === promise) {
39
+ cacheMap.set(cacheKey, {
40
+ value: freshValue,
41
+ expiresAt: Date.now() + expiryTimeMs,
42
+ });
43
+ }
42
44
 
43
45
  return freshValue;
44
46
  } finally {
45
- fetchPromises.delete(cacheKey);
47
+ if (fetchPromises.get(cacheKey) === promise)
48
+ fetchPromises.delete(cacheKey);
46
49
  }
47
50
  };
48
51
 
package/src/client.ts CHANGED
@@ -5,12 +5,12 @@ import {
5
5
  } from '@vrplatform/utils';
6
6
  import createClient from 'openapi-fetch';
7
7
  import { useCache } from './cache';
8
+ import { getControlPlaneRequestUrl } from './control-plane-routing';
8
9
  import type { paths } from './generated/v1';
10
+ import { retargetRequest } from './retarget-request';
9
11
  import { generateApiKeySec } from './sec';
10
12
  import type { ApiClient, ApiClientAuth } from './types';
11
13
 
12
- const DEFAULT_API_CLIENT_ATTEMPTS = 5;
13
-
14
14
  export function useApiClient({
15
15
  baseUrl: base,
16
16
  local,
@@ -21,6 +21,7 @@ export function useApiClient({
21
21
  headers: h,
22
22
  ...retryableFetchParams
23
23
  }: {
24
+ /** Maximum attempts for GET, HEAD, and OPTIONS. Writes are attempted once. */
24
25
  attempts?: number;
25
26
  auth?: ApiClientAuth | (() => ApiClientAuth);
26
27
  baseUrl?: string;
@@ -45,15 +46,6 @@ export function useApiClient({
45
46
  60_000
46
47
  );
47
48
 
48
- const retryableFetch = useRetryableFetch({
49
- ...retryableFetchParams,
50
- attempts: retryableFetchParams.attempts ?? DEFAULT_API_CLIENT_ATTEMPTS,
51
- onRetry(arg) {
52
- cache.invalidate();
53
- if (retryableFetchParams.onRetry) retryableFetchParams.onRetry(arg);
54
- },
55
- });
56
-
57
49
  const trace = Sentry.getTraceData();
58
50
  const client = createClient<paths>({
59
51
  baseUrl,
@@ -64,10 +56,23 @@ export function useApiClient({
64
56
  },
65
57
  },
66
58
  fetch(req) {
67
- return retryableFetch(async () => {
68
- let clone: any = req.clone() as any;
59
+ const isRead = ['GET', 'HEAD', 'OPTIONS'].includes(req.method);
60
+ return useRetryableFetch({
61
+ ...retryableFetchParams,
62
+ attempts: isRead ? (retryableFetchParams.attempts ?? 5) : 1,
63
+ assertOnLastAttempt:
64
+ retryableFetchParams.assertOnLastAttempt ??
65
+ (!isRead && retryableFetchParams.assertResponse !== undefined),
66
+ onRetry(arg) {
67
+ cache.invalidate();
68
+ return retryableFetchParams.onRetry?.(arg);
69
+ },
70
+ })(async () => {
71
+ let clone = req.clone() as Request;
72
+ const url = getControlPlaneRequestUrl(req.method, new URL(req.url));
73
+ if (url.href !== req.url) clone = await retargetRequest(clone, url);
69
74
  if (testing?.overwriteUri)
70
- clone = new Request(testing.overwriteUri, clone);
75
+ clone = await retargetRequest(clone, testing.overwriteUri);
71
76
 
72
77
  const a = (typeof auth === 'function' ? auth() : auth) || {};
73
78
  if (sessionId) clone.headers.set('X-Session-Id', sessionId);
@@ -96,7 +101,5 @@ export function useApiClient({
96
101
  },
97
102
  });
98
103
 
99
- const sessionClient: ApiClient = client as any;
100
- sessionClient.sessionId = sessionId;
101
- return sessionClient;
104
+ return Object.assign(client, { sessionId }) satisfies ApiClient;
102
105
  }
@@ -0,0 +1,46 @@
1
+ import { controlPlaneRouting, requestRegionRoutes } from './generated/routing';
2
+
3
+ const toMatchers = (
4
+ routeList: readonly { method: string; endpoint: string }[]
5
+ ) =>
6
+ routeList.map(({ method, endpoint }) => ({
7
+ method,
8
+ pattern: new RegExp(
9
+ `^${endpoint
10
+ .split('/')
11
+ .map((segment) =>
12
+ segment.startsWith('{') && segment.endsWith('}')
13
+ ? '[^/]+'
14
+ : segment.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
15
+ )
16
+ .join('/')}$`
17
+ ),
18
+ }));
19
+
20
+ const routes = toMatchers(controlPlaneRouting.routes);
21
+ const regionRoutes = toMatchers(requestRegionRoutes);
22
+
23
+ export function getControlPlaneRequestUrl(method: string, url: URL): URL {
24
+ const origin = controlPlaneRouting.origins[url.origin];
25
+ if (
26
+ !origin ||
27
+ !routes.some(
28
+ (route) => route.method === method && route.pattern.test(url.pathname)
29
+ )
30
+ ) {
31
+ return url;
32
+ }
33
+ const target = new URL(url);
34
+ target.host = new URL(origin).host;
35
+ return target;
36
+ }
37
+
38
+ /**
39
+ * Whether the API places this request by its `x-data-region` header or its
40
+ * path instead of the `x-team-id` team's own region.
41
+ */
42
+ export function isRequestRegionRoute(method: string, url: URL) {
43
+ return regionRoutes.some(
44
+ (route) => route.method === method && route.pattern.test(url.pathname)
45
+ );
46
+ }
@@ -0,0 +1,96 @@
1
+ import * as z from 'zod';
2
+
3
+ const protocol = 'vrplatform.embed.lifecycle';
4
+ const version = 1;
5
+ const envelope = {
6
+ channelId: z.uuid(),
7
+ protocol: z.literal(protocol),
8
+ version: z.literal(version),
9
+ };
10
+ const channelRequestSchema = z
11
+ .object({
12
+ ...envelope,
13
+ requestId: z.uuid(),
14
+ type: z.literal('channel.request'),
15
+ })
16
+ .strict();
17
+ const channelConnectSchema = z
18
+ .object({
19
+ ...envelope,
20
+ replyTo: z.uuid(),
21
+ type: z.literal('channel.connect'),
22
+ })
23
+ .strict();
24
+ const iframeMessageSchema = z.discriminatedUnion('type', [
25
+ z
26
+ .object({
27
+ ...envelope,
28
+ type: z.literal('ready'),
29
+ })
30
+ .strict(),
31
+ z
32
+ .object({
33
+ ...envelope,
34
+ code: z.enum([
35
+ 'authentication_failed',
36
+ 'access_denied',
37
+ 'session_expired',
38
+ 'renewal_failed',
39
+ 'unsupported_version',
40
+ 'internal_error',
41
+ ]),
42
+ correlationId: z.string().min(1).max(128),
43
+ recoverable: z.boolean(),
44
+ replyTo: z.uuid().optional(),
45
+ type: z.literal('error'),
46
+ })
47
+ .strict(),
48
+ z
49
+ .object({
50
+ ...envelope,
51
+ expiresAt: z.iso.datetime({ offset: true }),
52
+ requestId: z.uuid(),
53
+ type: z.literal('session.expiring'),
54
+ })
55
+ .strict(),
56
+ z
57
+ .object({
58
+ ...envelope,
59
+ expiresAt: z.iso.datetime({ offset: true }),
60
+ replyTo: z.uuid(),
61
+ type: z.literal('session.renewed'),
62
+ })
63
+ .strict(),
64
+ z
65
+ .object({
66
+ ...envelope,
67
+ height: z.number().int().positive(),
68
+ type: z.literal('resize'),
69
+ })
70
+ .strict(),
71
+ ]);
72
+ const parentMessageSchema = z.discriminatedUnion('type', [
73
+ z
74
+ .object({
75
+ ...envelope,
76
+ embedUrl: z.url(),
77
+ replyTo: z.uuid(),
78
+ requestId: z.uuid(),
79
+ type: z.literal('session.renew'),
80
+ })
81
+ .strict(),
82
+ ]);
83
+
84
+ export const embedLifecycle = {
85
+ channelConnectSchema,
86
+ channelRequestSchema,
87
+ iframeMessageSchema,
88
+ parentMessageSchema,
89
+ protocol,
90
+ version,
91
+ } as const;
92
+
93
+ export type EmbedLifecycleChannelConnect = z.infer<typeof channelConnectSchema>;
94
+ export type EmbedLifecycleChannelRequest = z.infer<typeof channelRequestSchema>;
95
+ export type EmbedLifecycleIframeMessage = z.infer<typeof iframeMessageSchema>;
96
+ export type EmbedLifecycleParentMessage = z.infer<typeof parentMessageSchema>;
package/src/error.ts CHANGED
@@ -1,71 +1,118 @@
1
- import { hasValue } from '@vrplatform/utils';
2
- import type { FetchResponse } from './generated/openapi-fetch';
1
+ import type { paths } from './generated/v1';
3
2
 
4
- type E = {
3
+ // The shared default envelope is emitted on every route. Preserve unfamiliar
4
+ // server codes so an older client can still expose a newer API failure.
5
+ type PublicError =
6
+ paths['/account-connections']['get']['responses'][400]['content']['application/json'];
7
+ type ErrorEnvelope = Omit<PublicError, 'code' | 'issues'> & {
5
8
  code: string;
6
- message: string;
7
- issues?: {
8
- message: string;
9
- }[];
10
- context?: any;
11
- stack?: any;
9
+ issues?: PublicError['issues'];
10
+ stack?: string;
12
11
  };
12
+
13
+ type ApiResponse<T> = {
14
+ response: Response;
15
+ data?: T;
16
+ error?: unknown;
17
+ };
18
+
13
19
  export class ApiClientError extends Error {
14
- code: string;
15
- issues: {
16
- message: string;
17
- }[];
18
- context: any;
19
- constructor(public error: E) {
20
- const message =
21
- error.message ||
22
- [
23
- error.code,
24
- error.issues
25
- ?.map((x) =>
26
- [x.message, (x as any).path?.join('->')]
27
- .filter(hasValue)
28
- .join(' on ')
29
- )
30
- .join(', '),
31
- ]
32
- .filter(hasValue)
33
- .join(': ');
34
- super(message);
20
+ code: ErrorEnvelope['code'];
21
+ issues: PublicError['issues'];
22
+ context: PublicError['context'];
23
+ links: PublicError['links'];
24
+ retryable: PublicError['retryable'];
35
25
 
26
+ constructor(public error: ErrorEnvelope) {
27
+ super(error.message);
36
28
  this.code = error.code;
37
- this.issues = error.issues || [];
38
- this.context = error.context || {};
29
+ this.issues = error.issues ?? [];
30
+ this.context = error.context;
31
+ this.links = error.links;
32
+ this.retryable = error.retryable;
39
33
  if (error.stack) this.stack = error.stack;
40
34
  }
41
35
  }
42
- export function throwIfError<T extends FetchResponse<any, any, any>>(
43
- response: T
44
- ): NonNullable<T['data']>;
45
- export function throwIfError<T extends FetchResponse<any, any, any>>(
46
- response: Promise<T>
47
- ): Promise<NonNullable<T['data']>>;
48
- export function throwIfError<T extends FetchResponse<any, any, any>>(
49
- response: Promise<T> | T
50
- ): Promise<NonNullable<T['data']>> | NonNullable<T['data']> {
51
- if (response instanceof Promise) {
52
- return response.then((response) => {
53
- if (response.response.status === 503) {
54
- throw new ApiClientError({
55
- code: 'SERVICE_UNAVAILABLE',
56
- message: 'Worker resources exceeded.',
57
- });
58
- }
59
36
 
60
- const error: E = response.error;
37
+ export class ApiClientResponseError extends Error {
38
+ constructor(
39
+ message: string,
40
+ public status: number,
41
+ public readonly details: {
42
+ contentType: string | null;
43
+ requestId: string | null;
44
+ cfRay: string | null;
45
+ } = { contentType: null, requestId: null, cfRay: null }
46
+ ) {
47
+ super(message);
48
+ this.name = 'ApiClientResponseError';
49
+ }
50
+ }
61
51
 
62
- if (error) throw new ApiClientError(error);
63
- return response.data;
64
- });
52
+ export function throwIfError<
53
+ T extends ApiResponse<unknown> | Promise<ApiResponse<unknown>>,
54
+ >(
55
+ response: T
56
+ ): T extends Promise<ApiResponse<unknown>>
57
+ ? Promise<NonNullable<Awaited<T>['data']>>
58
+ : NonNullable<Awaited<T>['data']>;
59
+ export function throwIfError(
60
+ response: Promise<ApiResponse<unknown>> | ApiResponse<unknown>
61
+ ): unknown {
62
+ if (response instanceof Promise)
63
+ return response.then((value) => throwIfError(value));
64
+ if (response.response.ok && response.error === undefined) {
65
+ return response.data;
65
66
  }
66
67
 
67
- const error: E = response.error;
68
+ const error = response.error;
69
+ if (
70
+ typeof error !== 'object' ||
71
+ error === null ||
72
+ !('code' in error) ||
73
+ typeof error.code !== 'string' ||
74
+ !('message' in error) ||
75
+ typeof error.message !== 'string' ||
76
+ !('issues' in error) ||
77
+ !Array.isArray(error.issues) ||
78
+ !error.issues.every(
79
+ (issue: unknown) =>
80
+ typeof issue === 'object' &&
81
+ issue !== null &&
82
+ 'message' in issue &&
83
+ typeof issue.message === 'string' &&
84
+ (!('path' in issue) ||
85
+ issue.path === undefined ||
86
+ (Array.isArray(issue.path) &&
87
+ issue.path.every(
88
+ (part: unknown) =>
89
+ typeof part === 'string' || typeof part === 'number'
90
+ ))) &&
91
+ (!('schema' in issue) ||
92
+ issue.schema === undefined ||
93
+ typeof issue.schema === 'string')
94
+ ) ||
95
+ ('retryable' in error &&
96
+ error.retryable !== undefined &&
97
+ typeof error.retryable !== 'boolean') ||
98
+ ('links' in error &&
99
+ error.links !== undefined &&
100
+ (typeof error.links !== 'object' ||
101
+ error.links === null ||
102
+ !('docs' in error.links) ||
103
+ typeof error.links.docs !== 'string' ||
104
+ !('schema' in error.links) ||
105
+ typeof error.links.schema !== 'string'))
106
+ )
107
+ throw new ApiClientResponseError(
108
+ 'API response did not contain a valid error envelope',
109
+ response.response.status,
110
+ {
111
+ contentType: response.response.headers.get('content-type'),
112
+ requestId: response.response.headers.get('x-request-id'),
113
+ cfRay: response.response.headers.get('cf-ray'),
114
+ }
115
+ );
68
116
 
69
- if (error) throw new ApiClientError(error);
70
- return response.data;
117
+ throw new ApiClientError(error as ErrorEnvelope);
71
118
  }